@bifravst/http-api-mock 1.1.0 → 1.1.2

package/cdk/http-api-mock.ts

@@ -5,7 +5,9 @@ import { fromEnv } from '@nordicsemiconductor/from-env'
 import path, { dirname } from 'node:path'
 import { fileURLToPath } from 'node:url'
 
-const { stackName } = fromEnv({ stackName: 'STACK_NAME' })(process.env)
+const { stackName } = fromEnv({ stackName: 'HTTP_API_MOCK_STACK_NAME' })(
+	process.env,
+)
 
 new HTTPAPIMockApp(stackName, {
 	lambdaSources: {

package/dist/cdk/http-api-mock.js

@@ -4,7 +4,7 @@ import { HTTPAPIMockApp } from './App.js';
 import { fromEnv } from '@nordicsemiconductor/from-env';
 import path, { dirname } from 'node:path';
 import { fileURLToPath } from 'node:url';
-const { stackName } = fromEnv({ stackName: 'STACK_NAME' })(process.env);
+const { stackName } = fromEnv({ stackName: 'HTTP_API_MOCK_STACK_NAME' })(process.env);
 new HTTPAPIMockApp(stackName, {
     lambdaSources: {
         httpApiMock: await packLambdaFromPath('httpApiMock', 'cdk/resources/http-api-mock-lambda.ts', undefined, path.join(dirname(fileURLToPath(import.meta.url)), '..')),

package/dist/src/cli.js

@@ -35,8 +35,8 @@ export const cli = async () => {
         command: 'npx',
         args: ['cdk', ...cdkApp(), 'deploy', '--require-approval', 'never'],
         env: {
-            STACK_NAME: stackName,
             ...process.env,
+            HTTP_API_MOCK_STACK_NAME: stackName,
         },
         log: {
             debug: (msg) => console.error(chalk.blueBright('[CDK]'), chalk.blue(msg)),
@@ -64,8 +64,8 @@ const destroy = async (stackName) => {
         command: 'npx',
         args: ['cdk', ...cdkApp(), 'destroy', '-f'],
         env: {
-            STACK_NAME: stackName,
             ...process.env,
+            HTTP_API_MOCK_STACK_NAME: stackName,
         },
         log: {
             debug: (msg) => console.error(chalk.blueBright('[CDK]'), chalk.blue(msg)),

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@bifravst/http-api-mock",
-  "version": "1.1.0",
+  "version": "1.1.2",
   "description": "Helper functions for AWS lambdas written in TypeScript.",
   "exports": {
     "./*": {
@@ -83,6 +83,7 @@
     "package-lock.json",
     "dist",
     "cdk",
+    "src",
     "cli.js",
     "LICENSE",
     "README.md"

package/src/cli.ts

@@ -0,0 +1,109 @@
+import { randomString } from './randomString.js'
+import run from '@bifravst/run'
+import { GetCallerIdentityCommand, STSClient } from '@aws-sdk/client-sts'
+import chalk from 'chalk'
+import { stackOutput } from '@nordicsemiconductor/cloudformation-helpers'
+import type { StackOutputs } from '../cdk/Stack.js'
+import { CloudFormationClient } from '@aws-sdk/client-cloudformation'
+import path, { dirname } from 'node:path'
+import { fileURLToPath } from 'node:url'
+
+const die = (err: Error): void => {
+	console.error('')
+	console.error(chalk.yellow('⚠️'), chalk.red.bold(err.message))
+	console.error('')
+	console.error(err)
+	process.exit(1)
+}
+
+process.on('uncaughtException', die)
+process.on('unhandledRejection', die)
+
+const cdkApp = () => [
+	'--app',
+	`"npx tsx --no-warnings ${path.join(dirname(fileURLToPath(import.meta.url)), '..', '..', 'cdk', 'http-api-mock.ts')}"`,
+]
+
+export const cli = async (): Promise<void> => {
+	await whoAmI()
+	if (process.argv.includes('destroy')) {
+		await destroy(getStackNameFromArgs('destroy'))
+		return
+	}
+	if (process.argv.includes('describe')) {
+		await describe(getStackNameFromArgs('describe'))
+		return
+	}
+	const stackName = `http-api-mock-${randomString()}`
+	console.error(chalk.yellow(`Stack name`), chalk.green(stackName))
+
+	await run({
+		command: 'npx',
+		args: ['cdk', ...cdkApp(), 'deploy', '--require-approval', 'never'],
+		env: {
+			...process.env,
+			HTTP_API_MOCK_STACK_NAME: stackName,
+		},
+		log: {
+			debug: (msg) => console.error(chalk.blueBright('[CDK]'), chalk.blue(msg)),
+		},
+	})
+
+	await describe(stackName)
+}
+
+const whoAmI = async (): Promise<{ Account: string }> => {
+	try {
+		const me = await new STSClient({}).send(new GetCallerIdentityCommand({}))
+
+		if (me.Account === undefined) throw new Error(`Not authenticated!`)
+
+		console.error(chalk.yellow('Account'), chalk.green(me.Account))
+
+		return {
+			Account: me.Account,
+		}
+	} catch (err) {
+		throw new Error(`Not authenticated!`)
+	}
+}
+
+const destroy = async (stackName: string) => {
+	console.error(chalk.yellow(`Stack name`), chalk.green(stackName))
+	await run({
+		command: 'npx',
+		args: ['cdk', ...cdkApp(), 'destroy', '-f'],
+		env: {
+			...process.env,
+			HTTP_API_MOCK_STACK_NAME: stackName,
+		},
+		log: {
+			debug: (msg) => console.error(chalk.blueBright('[CDK]'), chalk.blue(msg)),
+		},
+	})
+
+	console.error(chalk.green(`Stack destroyed`))
+}
+
+const describe = async (stackName: string) => {
+	console.log(
+		JSON.stringify(
+			{
+				stackName,
+				...(await stackOutput(new CloudFormationClient({}))<StackOutputs>(
+					stackName,
+				)),
+			},
+			null,
+			2,
+		),
+	)
+}
+
+const getStackNameFromArgs = (command: string) => {
+	const stackName = process.argv[process.argv.indexOf(command) + 1]
+	if (stackName === undefined) {
+		throw new Error(`Must provide a stack name!`)
+	}
+	return stackName
+}

package/src/randomString.ts

@@ -0,0 +1,7 @@
+import crypto from 'node:crypto'
+
+export const randomString = (): string =>
+	crypto
+		.randomBytes(Math.ceil(8 * 0.5))
+		.toString('hex')
+		.slice(0, 8)

package/src/requests.ts

@@ -0,0 +1,29 @@
+import { ScanCommand, type DynamoDBClient } from '@aws-sdk/client-dynamodb'
+import { unmarshall } from '@aws-sdk/util-dynamodb'
+
+export type Request = {
+	path: string //e.g.'555c3960-2092-438b-b2b0-f28eebd1f5bb'
+	query: null
+	timestamp: string //e.g.'2024-04-05T13:01:14.434Z'
+	ttl: string //e.g. 1712322374
+	headers: Record<string, string> //e.g. '{"Accept":"*/*","Accept-Encoding":"br, gzip, deflate","Accept-Language":"*","CloudFront-Forwarded-Proto":"https","CloudFront-Is-Desktop-Viewer":"true","CloudFront-Is-Mobile-Viewer":"false","CloudFront-Is-SmartTV-Viewer":"false","CloudFront-Is-Tablet-Viewer":"false","CloudFront-Viewer-ASN":"2116","CloudFront-Viewer-Country":"NO","Host":"idj1fffo0k.execute-api.eu-west-1.amazonaws.com","sec-fetch-mode":"cors","User-Agent":"node","Via":"1.1 b053873243f91b1bb6dc406ce0c67db4.cloudfront.net (CloudFront)","X-Amz-Cf-Id":"_vJIGo6Z89QxDzoqOZL4G0PQqPFWGesVXVan4ND934_Urqn2ifSOsQ==","X-Amzn-Trace-Id":"Root=1-660ff61a-25e1219a7f153e1b0c768358","X-Forwarded-For":"194.19.86.146, 130.176.182.18","X-Forwarded-Port":"443","X-Forwarded-Proto":"https"}'
+	method: string //e.g.'GET'
+	resource: string //e.g. '555c3960-2092-438b-b2b0-f28eebd1f5bb'
+	requestId: string //e.g.'f34b042b-e9a2-4089-97a2-241516d40d64'
+	body: string //e.g.'{}'
+	methodPathQuery: string //e.g.'GET 555c3960-2092-438b-b2b0-f28eebd1f5bb'
+}
+
+export const listRequests = async (
+	db: DynamoDBClient,
+	requestsTable: string,
+): Promise<Array<Request>> =>
+	((await db.send(new ScanCommand({ TableName: requestsTable }))).Items ?? [])
+		.map((item) => {
+			const i = unmarshall(item)
+			return {
+				...i,
+				headers: JSON.parse(i.headers),
+			} as Request
+		})
+		.sort((i1, i2) => i1.timestamp.localeCompare(i2.timestamp))

package/src/responses.ts

@@ -0,0 +1,40 @@
+import { PutItemCommand, type DynamoDBClient } from '@aws-sdk/client-dynamodb'
+import { marshall } from '@aws-sdk/util-dynamodb'
+import { sortQueryString } from './sortQueryString.js'
+
+export type Response = {
+	// e.g. 'GET'
+	method: string
+	// without leading slash
+	path: string
+	queryParams?: Record<string, string>
+	statusCode?: number
+	body?: string
+	ttl?: number
+	// Whether to delete the message after sending it
+	keep?: boolean
+}
+
+export const registerResponse = async (
+	db: DynamoDBClient,
+	responsesTable: string,
+	response: Response,
+): Promise<void> => {
+	await db.send(
+		new PutItemCommand({
+			TableName: responsesTable,
+			Item: marshall(
+				{
+					methodPathQuery: `${response.method} ${sortQueryString(response.path)}`,
+					timestamp: new Date().toISOString(),
+					statusCode: response.statusCode,
+					body: response.body,
+					queryParams: response.queryParams,
+					ttl: response.ttl,
+					keep: response.ttl,
+				},
+				{ removeUndefinedValues: true },
+			),
+		}),
+	)
+}

package/src/sortQueryString.spec.ts

@@ -0,0 +1,13 @@
+import assert from 'node:assert'
+import { describe, test as it } from 'node:test'
+import { sortQueryString } from './sortQueryString.js'
+
+void describe('sortQueryString', () => {
+	void it('should sort the query part of a mock URL', () =>
+		assert.deepStrictEqual(
+			sortQueryString(
+				'api.nrfcloud.com/v1/location/agps?eci=73393515&tac=132&requestType=custom&mcc=397&mnc=73&customTypes=2',
+			),
+			'api.nrfcloud.com/v1/location/agps?customTypes=2&eci=73393515&mcc=397&mnc=73&requestType=custom&tac=132',
+		))
+})

package/src/sortQueryString.ts

@@ -0,0 +1,14 @@
+export const sortQueryString = (mockUrl: string): string => {
+	const [host, query] = mockUrl.split('?', 2) as [string, string | undefined]
+	if ((query?.length ?? 0) === 0) return host
+	const params: string[][] = []
+	new URLSearchParams(query).forEach((v, k) => {
+		params.push([k, v])
+	})
+	params.sort(([k1], [k2]) => (k1 ?? '').localeCompare(k2 ?? ''))
+	const sortedParams = new URLSearchParams()
+	for (const [k, v] of params) {
+		sortedParams.append(k as string, v as string)
+	}
+	return `${host}?${sortedParams.toString()}`
+}