@bifravst/http-api-mock 3.0.7 → 3.0.8

package/npm/cdk/resources/http-api-mock-lambda.ts

@@ -1,147 +0,0 @@
-import {
-	DeleteItemCommand,
-	DynamoDBClient,
-	PutItemCommand,
-	ScanCommand,
-} from '@aws-sdk/client-dynamodb'
-import { marshall, unmarshall } from '@aws-sdk/util-dynamodb'
-import type {
-	APIGatewayEvent,
-	APIGatewayProxyResult,
-	Context,
-} from 'aws-lambda'
-import { URLSearchParams } from 'url'
-import { sortQueryString } from '../../src/sortQueryString.ts'
-import { checkMatchingQueryParams } from './checkMatchingQueryParams.ts'
-import { splitMockResponse } from './splitMockResponse.ts'
-
-const db = new DynamoDBClient({})
-
-export const handler = async (
-	event: APIGatewayEvent,
-	context: Context,
-): Promise<APIGatewayProxyResult> => {
-	console.log(JSON.stringify({ event }))
-	const query =
-		event.queryStringParameters !== null &&
-		event.queryStringParameters !== undefined
-			? new URLSearchParams(
-					event.queryStringParameters as Record<string, string>,
-				)
-			: undefined
-	const path = event.path.replace(/^\//, '')
-	const pathWithQuery = sortQueryString(
-		`${path}${query !== undefined ? `?${query.toString()}` : ''}`,
-	)
-
-	const request = {
-		methodPathQuery: `${event.httpMethod} ${pathWithQuery}`,
-		timestamp: new Date().toISOString(),
-		requestId: context.awsRequestId,
-		method: event.httpMethod,
-		path,
-		query: query === undefined ? null : Object.fromEntries(query),
-		body: event.body ?? '{}',
-		headers: JSON.stringify(event.headers),
-	}
-
-	// Check if response exists
-	console.debug(
-		`Checking if response exists for ${event.httpMethod} ${pathWithQuery}...`,
-	)
-	// Scan using httpMethod and path only so query strings can be partially matched
-	const { Items } = await db.send(
-		new ScanCommand({
-			TableName: process.env.RESPONSES_TABLE_NAME,
-			FilterExpression: 'begins_with(methodPathQuery, :methodPath)',
-			ExpressionAttributeValues: {
-				[':methodPath']: {
-					S: `${event.httpMethod} ${path}`,
-				},
-			},
-		}),
-	)
-	console.debug(
-		`Found response items beginning with same path: ${Items?.length}`,
-	)
-	// use newest response first
-	const itemsByTimestampDesc = (Items ?? [])
-		.map((Item) => unmarshall(Item))
-		.sort((a, b) => b.timestamp.localeCompare(a.timestamp))
-
-	let res: APIGatewayProxyResult = {
-		statusCode: 404,
-		body: 'No responses found',
-	}
-	for (const objItem of itemsByTimestampDesc) {
-		const hasExpectedQueryParams =
-			'queryParams' in objItem || query !== undefined
-		const matchedQueryParams = hasExpectedQueryParams
-			? checkMatchingQueryParams(
-					event.queryStringParameters,
-					objItem.queryParams,
-				)
-			: true
-		if (matchedQueryParams === false) continue
-
-		console.debug(`Matched response`, JSON.stringify({ response: objItem }))
-
-		if (
-			objItem?.requestId !== undefined &&
-			objItem?.timestamp !== undefined &&
-			objItem?.keep !== true
-		) {
-			await db.send(
-				new DeleteItemCommand({
-					TableName: process.env.RESPONSES_TABLE_NAME,
-					Key: marshall({
-						requestId: objItem.requestId,
-						timestamp: objItem.timestamp,
-					}),
-				}),
-			)
-		}
-
-		const { body, headers } = splitMockResponse(objItem.body ?? '')
-
-		// Send as binary, if mock response is HEX encoded. See https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-payload-encodings.html
-		const isBinary = /^[0-9a-f]+$/.test(body)
-		res = {
-			statusCode: objItem.statusCode ?? 200,
-			headers: isBinary
-				? {
-						...headers,
-						'Content-Type': 'application/octet-stream',
-					}
-				: headers,
-			body: isBinary
-				? /* body is HEX encoded */ Buffer.from(body, 'hex').toString('base64')
-				: body,
-			isBase64Encoded: isBinary,
-		}
-
-		break
-	}
-
-	console.debug(`Return response`, JSON.stringify({ response: res }))
-
-	await db.send(
-		new PutItemCommand({
-			TableName: process.env.REQUESTS_TABLE_NAME,
-			Item: marshall(
-				{
-					...request,
-					responseStatusCode: res.statusCode,
-					responseHeaders: res.headers,
-					responseBody: res.body,
-					responseIsBase64Encoded: res.isBase64Encoded,
-				},
-				{
-					removeUndefinedValues: true,
-				},
-			),
-		}),
-	)
-
-	return res
-}

package/npm/cdk/resources/splitMockResponse.spec.ts

@@ -1,17 +0,0 @@
-import assert from 'node:assert'
-import { describe, it } from 'node:test'
-import { splitMockResponse } from './splitMockResponse.ts'
-void describe('split mock response', () => {
-	void it('should parse headers and body', () =>
-		assert.deepEqual(
-			splitMockResponse(`Content-Type: application/octet-stream
-
-(binary A-GNSS data) other types`),
-			{
-				headers: {
-					'Content-Type': 'application/octet-stream',
-				},
-				body: '(binary A-GNSS data) other types',
-			},
-		))
-})

package/npm/cdk/resources/splitMockResponse.ts

@@ -1,25 +0,0 @@
-export const splitMockResponse = (
-	r: string,
-): { headers: Record<string, string>; body: string } => {
-	const trimmedLines = r
-		.split('\n')
-		.map((s) => s.trim())
-		.join('\n')
-	const blankLineLocation = trimmedLines.indexOf('\n\n')
-	if (blankLineLocation === -1)
-		return {
-			headers: {},
-			body: trimmedLines,
-		}
-	return {
-		headers: trimmedLines
-			.slice(0, blankLineLocation)
-			.split('\n')
-			.map((s) => s.split(':', 2))
-			.reduce(
-				(headers, [k, v]) => ({ ...headers, [k as string]: v?.trim() }),
-				{},
-			),
-		body: trimmedLines.slice(blankLineLocation + 2),
-	}
-}

package/npm/package.json

@@ -1,105 +0,0 @@
-{
-  "name": "@bifravst/http-api-mock",
-  "version": "3.0.7",
-  "description": "Helper functions for AWS lambdas written in TypeScript.",
-  "exports": {
-    "./*": {
-      "import": {
-        "default": "./npm/src/*.js",
-        "types": "./npm/src/*.d.ts"
-      }
-    }
-  },
-  "type": "module",
-  "scripts": {
-    "prepare": "husky && case \"$npm_command\" in install|ci) check-node-version --package ;; esac",
-    "prepublishOnly": "npx tsc --noEmit false --outDir ./npm -d && cp -rv cdk/* npm/cdk && cp package.json npm/package.json",
-    "test": "node --no-warnings --experimental-transform-types --test \"!(node_modules|e2e-tests|integration-tests)/**/*.spec.ts\""
-  },
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/bifravst/http-api-mock.git"
-  },
-  "bugs": {
-    "url": "https://github.com/bifravst/http-api-mock/issues"
-  },
-  "homepage": "https://github.com/bifravst/http-api-mock",
-  "keywords": [
-    "aws",
-    "lambda",
-    "typescript"
-  ],
-  "author": "Nordic Semiconductor ASA | nordicsemi.no",
-  "license": "BSD-3-Clause",
-  "lint-staged": {
-    "*.ts": [
-      "prettier --write",
-      "eslint"
-    ],
-    "*.{md,json,yaml,yml}": [
-      "prettier --write"
-    ]
-  },
-  "engines": {
-    "node": ">=24.19.0 <25",
-    "npm": ">=12.0.2 <13"
-  },
-  "release": {
-    "branches": [
-      "saga"
-    ],
-    "remoteTags": true,
-    "plugins": [
-      "@semantic-release/commit-analyzer",
-      "@semantic-release/release-notes-generator",
-      "@semantic-release/npm",
-      [
-        "@semantic-release/github",
-        {
-          "successCommentCondition": false,
-          "failTitle": false
-        }
-      ]
-    ]
-  },
-  "publishConfig": {
-    "access": "public"
-  },
-  "files": [
-    "npm",
-    "cdk",
-    "src",
-    "LICENSE",
-    "README.md"
-  ],
-  "prettier": "@bifravst/prettier-config",
-  "dependencies": {
-    "@aws-sdk/client-cloudformation": "3.1111.0",
-    "@aws-sdk/client-dynamodb": "3.1111.0",
-    "@aws-sdk/client-sts": "3.1111.0",
-    "@aws-cdk/toolkit-lib": "1.38.2",
-    "@aws-sdk/util-dynamodb": "3.996.9",
-    "@bifravst/aws-cdk-lambda-helpers": "5.0.4",
-    "@bifravst/cloudformation-helpers": "10.0.1",
-    "@bifravst/from-env": "4.0.0",
-    "@bifravst/run": "2.0.1",
-    "aws-cdk-lib": "2.265.0",
-    "cdk": "2.1136.0",
-    "chalk": "6.0.0",
-    "command-line-args": "6.0.2"
-  },
-  "devDependencies": {
-    "@bifravst/eslint-config-typescript": "8.0.0",
-    "@bifravst/prettier-config": "2.0.0",
-    "@commitlint/config-conventional": "21.2.2",
-    "@types/aws-lambda": "8.10.162",
-    "@types/command-line-args": "5.2.3",
-    "@types/node": "26.2.0",
-    "@typescript/native": "npm:typescript@7.0.2",
-    "check-node-version": "4.2.1",
-    "commitlint": "21.2.2",
-    "husky": "9.1.7",
-    "lint-staged": "17.3.0",
-    "typescript": "npm:@typescript/typescript6@6.0.2"
-  }
-}

package/src/mock.spec.ts

@@ -1,52 +0,0 @@
-import type { AttributeValue, DynamoDBClient } from '@aws-sdk/client-dynamodb'
-import { unmarshall } from '@aws-sdk/util-dynamodb'
-import assert from 'node:assert/strict'
-import { describe, it, mock as testMock } from 'node:test'
-import { mock } from './mock.ts'
-
-void describe('mock()', () => {
-	void it('should register a response', async () => {
-		const db = {
-			send: testMock.fn(async () => Promise.resolve(undefined)),
-		}
-		const httpApiMock = mock({
-			db: db as unknown as DynamoDBClient,
-			responsesTable: 'response-table',
-		})
-
-		await httpApiMock.response(`GET foo/bar?k=v`, {
-			status: 200,
-			headers: new Headers({
-				'content-type': 'application/json; charset=utf-8',
-			}),
-			body: JSON.stringify({
-				result: 'some-value',
-			}),
-		})
-
-		assert.equal(db.send.mock.callCount(), 1)
-		const [{ input: args }] = db.send.mock.calls[0]?.arguments as unknown as [
-			{
-				input: {
-					TableName: string
-					Item: Record<string, AttributeValue>
-				}
-			},
-		]
-		assert.equal(args.TableName, 'response-table')
-		const { methodPathQuery, statusCode, body, queryParams } = unmarshall(
-			args.Item,
-		)
-		assert.equal(statusCode, 200)
-		assert.equal(methodPathQuery, 'GET foo/bar?k=v')
-		assert.equal(
-			body,
-			[
-				`content-type: application/json; charset=utf-8`,
-				``,
-				JSON.stringify({ result: 'some-value' }),
-			].join('\n'),
-		)
-		assert.deepEqual(queryParams, { k: 'v' })
-	})
-})

package/src/mock.ts

@@ -1,61 +0,0 @@
-import type { DynamoDBClient } from '@aws-sdk/client-dynamodb'
-import { registerResponse } from './responses.ts'
-
-type MockResponseFn = (
-	// The expected request in the form 'GET resource/subresource?query=value
-	methodPathQuery: string,
-	// The response
-	response: Partial<{
-		headers: Headers
-		status: number
-		body: string
-	}>,
-	keep?: boolean,
-) => Promise<void>
-
-export const mockResponse =
-	(db: DynamoDBClient, responsesTable: string): MockResponseFn =>
-	async (methodPathQuery, response, keep) => {
-		const [method, pathWithQuery] = methodPathQuery.split(' ', 2)
-		if (!/^[A-Z]+$/.test(method ?? ''))
-			throw new Error(`Invalid method ${method} in ${methodPathQuery}!`)
-		if (pathWithQuery === undefined)
-			throw new Error(`Missing path in ${methodPathQuery}!`)
-		const [path, query] = pathWithQuery.split('?', 2) as [
-			string,
-			string | undefined,
-		]
-		if (path.startsWith('/'))
-			throw new Error(`Path ${path} must not start with /!`)
-
-		const bodyParts = []
-		if (response.headers !== undefined) {
-			for (const [k, v] of response.headers.entries()) {
-				bodyParts.push(`${k}: ${v}`)
-			}
-			bodyParts.push('')
-		}
-		if (response.body !== undefined) bodyParts.push(response.body)
-		await registerResponse(db, responsesTable, {
-			path,
-			method: method ?? 'GET',
-			queryParams: new URLSearchParams(query),
-			body: bodyParts.length > 0 ? bodyParts.join('\n') : undefined,
-			statusCode: response.status,
-			keep,
-		})
-	}
-
-export type HttpAPIMock = {
-	response: MockResponseFn
-}
-
-export const mock = ({
-	db,
-	responsesTable,
-}: {
-	db: DynamoDBClient
-	responsesTable: string
-}): HttpAPIMock => ({
-	response: mockResponse(db, responsesTable),
-})

package/src/parseMockRequest.spec.ts

@@ -1,30 +0,0 @@
-import assert from 'node:assert/strict'
-import { describe, it } from 'node:test'
-import { parseMockRequest } from './parseMockRequest.ts'
-
-void describe('parseMockRequest()', () => {
-	void it('should parse method, resource, protocol, headers and body', () =>
-		assert.deepEqual(
-			parseMockRequest(
-				[
-					`PATCH /v1/devices/foo/state HTTP/1.1`,
-					`Content-Length: 36`,
-					`Content-Type: application/json`,
-					`If-Match: 8835`,
-					``,
-					`{"desired":{"config":{"nod":null}}}`,
-				].join('\n'),
-			),
-			{
-				method: 'PATCH',
-				resource: '/v1/devices/foo/state',
-				protocol: 'HTTP/1.1',
-				headers: {
-					'Content-Length': '36',
-					'Content-Type': 'application/json',
-					'If-Match': '8835',
-				},
-				body: '{"desired":{"config":{"nod":null}}}',
-			},
-		))
-})

package/src/parseMockRequest.ts

@@ -1,35 +0,0 @@
-export const parseMockRequest = (
-	r: string,
-): {
-	method: string
-	resource: string
-	protocol: string // 'HTTP/1.0' | 'HTTP/1.1'
-	headers: Record<string, string>
-	body: string
-} => {
-	const lines = r.split('\n')
-	const methodResourceProtol = lines.shift()
-	const blankLineLocation = lines.indexOf('')
-	const headerLines =
-		blankLineLocation === -1 ? lines : lines.slice(0, blankLineLocation)
-	const body =
-		blankLineLocation === -1
-			? ''
-			: lines.slice(blankLineLocation + 1).join('\n')
-
-	const requestInfo =
-		/^(?<method>[A-Z]+) (?<resource>[^ ]+) (?<protocol>HTTP\/[0-9.]+)/.exec(
-			methodResourceProtol ?? '',
-		)?.groups as { method: string; resource: string; protocol: string }
-
-	if (requestInfo === null)
-		throw new Error(`Invalid request info: ${methodResourceProtol}`)
-
-	return {
-		...requestInfo,
-		headers: headerLines
-			.map((s) => s.split(':', 2))
-			.reduce((headers, [k, v]) => ({ ...headers, [k ?? '']: v?.trim() }), {}),
-		body,
-	}
-}

package/src/parseMockResponse.spec.ts

@@ -1,27 +0,0 @@
-import assert from 'node:assert/strict'
-import { describe, it } from 'node:test'
-import { parseMockResponse } from './parseMockResponse.ts'
-
-void describe('parseMockResponse()', () => {
-	void it('should parse protocol, statusCode, headers and body', () =>
-		assert.deepEqual(
-			parseMockResponse(
-				[
-					`HTTP/1.1 202 Accepted`,
-					`Content-Length: 36`,
-					`Content-Type: application/json`,
-					``,
-					`{"desired":{"config":{"nod":null}}}`,
-				].join('\n'),
-			),
-			{
-				statusCode: 202,
-				protocol: 'HTTP/1.1',
-				headers: {
-					'Content-Length': '36',
-					'Content-Type': 'application/json',
-				},
-				body: '{"desired":{"config":{"nod":null}}}',
-			},
-		))
-})

package/src/parseMockResponse.ts

@@ -1,35 +0,0 @@
-export const parseMockResponse = (
-	r: string,
-): {
-	statusCode: number
-	protocol: string // 'HTTP/1.0' | 'HTTP/1.1'
-	headers: Record<string, string>
-	body: string
-} => {
-	const lines = r.split('\n')
-	const protocolStatusCode = lines.shift()
-	const blankLineLocation = lines.indexOf('')
-	const headerLines =
-		blankLineLocation === -1 ? lines : lines.slice(0, blankLineLocation)
-	const body =
-		blankLineLocation === -1
-			? ''
-			: lines.slice(blankLineLocation + 1).join('\n')
-
-	const responseInfo =
-		/^(?<protocol>HTTP\/[0-9.]+) (?<statusCode>[0-9]+) /.exec(
-			protocolStatusCode ?? '',
-		)?.groups as { statusCode: string; protocol: string }
-
-	if (responseInfo === null)
-		throw new Error(`Invalid request info: ${protocolStatusCode}`)
-
-	return {
-		statusCode: parseInt(responseInfo.statusCode, 10),
-		protocol: responseInfo.protocol,
-		headers: headerLines
-			.map((s) => s.split(':', 2))
-			.reduce((headers, [k, v]) => ({ ...headers, [k ?? '']: v?.trim() }), {}),
-		body,
-	}
-}

package/src/randomString.ts

@@ -1,7 +0,0 @@
-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

@@ -1,28 +0,0 @@
-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'
-	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

@@ -1,50 +0,0 @@
-import { PutItemCommand, type DynamoDBClient } from '@aws-sdk/client-dynamodb'
-import { marshall } from '@aws-sdk/util-dynamodb'
-import { randomUUID } from 'node:crypto'
-import { sortQuery } from './sortQueryString.ts'
-
-export type Response = {
-	// e.g. 'GET'
-	method: string
-	// without leading slash
-	path: string
-	queryParams?: URLSearchParams
-	statusCode?: number
-	/**
-	 * Header + Body
-	 *
-	 * @see splitMockResponse
-	 */
-	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(
-				{
-					responseId: randomUUID(),
-					methodPathQuery: `${response.method} ${response.path}${response.queryParams !== undefined ? `?${sortQuery(response.queryParams)}` : ``}`,
-					timestamp: new Date().toISOString(),
-					statusCode: response.statusCode,
-					body: response.body,
-					queryParams:
-						response.queryParams !== undefined
-							? Object.fromEntries(response.queryParams)
-							: undefined,
-					ttl: response.ttl,
-					keep: response.keep,
-				},
-				{ removeUndefinedValues: true },
-			),
-		}),
-	)
-}

package/src/sortQueryString.spec.ts

@@ -1,38 +0,0 @@
-import assert from 'node:assert'
-import { describe, test as it } from 'node:test'
-import { URLSearchParams } from 'node:url'
-import { sortQuery, sortQueryString } from './sortQueryString.ts'
-
-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',
-		))
-})
-
-void describe('sortQuery', () => {
-	void it('should sort URLSearchParams', () =>
-		assert.equal(
-			sortQuery(
-				new URLSearchParams(
-					'eci=73393515&tac=132&requestType=custom&mcc=397&mnc=73&customTypes=2',
-				),
-			),
-			'customTypes=2&eci=73393515&mcc=397&mnc=73&requestType=custom&tac=132',
-		))
-	void it('should sort a Record', () =>
-		assert.equal(
-			sortQuery({
-				eci: '73393515',
-				tac: '132',
-				requestType: 'custom',
-				mcc: '397',
-				mnc: '73',
-				customTypes: '2',
-			}),
-			'customTypes=2&eci=73393515&mcc=397&mnc=73&requestType=custom&tac=132',
-		))
-})