feat: refactor type tests for appConfig middleware and update package.json scripts

Signed-off-by: Luca Del Puppo <[email protected]>

Author: Puppo

package-lock.json

@@ -23,7 +23,9 @@
 		"test:sast:sandworm": "sandworm-audit --skip-all --show-tips false",
 		"test:sast:semgrep": "semgrep scan --config auto",
 		"test:sast:trufflehog": "trufflehog filesystem --only-verified --log-level=-1 ./",
-		"test:types": "ls packages | xargs -I {} tsd packages/{}",
+		"test:types:tsd": "find packages -name \"*.test-d.ts\" -exec dirname {} \\; | sed 's|packages/||' | sort -u | xargs -I {} tsd packages/{}",
+		"test:types:tstyche": "find packages -name \"*.tst.ts\" -exec dirname {} \\; | sed 's|packages/||' | sort -u | xargs -I {} tstyche packages/{}",
+		"test:types": "npm run test:types:tsd && npm run test:types:tstyche",
 		"test:perf": "node --test ./**/*.perf.js",
 		"test:dast": "npm run test:dast:fuzz",
 		"test:dast:fuzz": "node --test ./**/*.fuzz.js",
@@ -70,6 +72,7 @@
 		"husky": "^9.0.0",
 		"tinybench": "^4.0.0",
 		"tsd": "^0.32.0",
+		"tstyche": "^4.1.0",
 		"typescript": "^5.0.0"
 	},
 	"workspaces": [

package.json

@@ -0,0 +1,164 @@
+import { AppConfigDataClient } from "@aws-sdk/client-appconfigdata";
+import middy from "@middy/core";
+import { getInternal } from "@middy/util";
+import type { Context as LambdaContext } from "aws-lambda";
+import { captureAWSv3Client } from "aws-xray-sdk";
+import { expect, test } from "tstyche";
+import appConfig, { appConfigReq } from ".";
+
+const options = {
+	AwsClient: AppConfigDataClient,
+	awsClientOptions: {
+		credentials: {
+			secretAccessKey: "secret",
+			sessionToken: "token",
+			accessKeyId: "key",
+		},
+	},
+	awsClientAssumeRole: "some-role",
+	awsClientCapture: captureAWSv3Client,
+	disablePrefetch: true,
+	cacheKey: "some-key",
+	cacheExpiry: 60 * 60 * 5,
+	setToContext: false,
+} as const;
+
+test("should use default options", () => {
+	expect(appConfig()).type.toBe<
+		middy.MiddlewareObj<unknown, any, Error, LambdaContext>
+	>();
+});
+
+test("should use with setToContext: false", () => {
+	expect(
+		appConfig({
+			...options,
+			fetchData: {
+				config: {
+					ApplicationIdentifier: "app",
+					ConfigurationProfileIdentifier: "configId",
+					EnvironmentIdentifier: "development",
+				},
+			},
+			setToContext: false,
+		}),
+	).type.toBe<
+		middy.MiddlewareObj<
+			unknown,
+			any,
+			Error,
+			LambdaContext,
+			Record<"config", unknown>
+		>
+	>();
+});
+
+test("should use with setToContext: true", () => {
+	expect(
+		appConfig({
+			...options,
+			fetchData: {
+				config: {
+					ApplicationIdentifier: "app",
+					ConfigurationProfileIdentifier: "configId",
+					EnvironmentIdentifier: "development",
+				},
+			},
+			setToContext: true,
+		}),
+	).type.toBe<
+		middy.MiddlewareObj<
+			unknown,
+			any,
+			Error,
+			LambdaContext & Record<"config", unknown>,
+			Record<"config", unknown>
+		>
+	>();
+});
+
+// @ts-expect-error - fetchData must be an object
+appConfig({ ...options, fetchData: "not-an-object" });
+
+appConfig({
+	...options,
+	fetchData: {
+		config: {
+			// @ts-expect-error - Application must be a string
+			ApplicationIdentifier: 123,
+			// @ts-expect-error - Configuration must be a string
+			ConfigurationProfileIdentifier: 123,
+			// @ts-expect-error - Environment must be a string
+			EnvironmentIdentifier: 123,
+		},
+	},
+});
+
+appConfig({
+	...options,
+	fetchData: {
+		// @ts-expect-error - config must contain Application, ClientId, Configuration and Environment
+		config: {},
+	},
+});
+
+const handler = middy(async (event: {}, context: LambdaContext) => {
+	return await Promise.resolve({});
+});
+
+test("should return the correct config", () => {
+	handler
+		.use(
+			appConfig({
+				fetchData: {
+					config: appConfigReq<{
+						config1: string;
+						config2: string;
+						config3: number;
+					}>({
+						ApplicationIdentifier: "app",
+						ConfigurationProfileIdentifier: "configId",
+						EnvironmentIdentifier: "development",
+					}),
+				},
+				setToContext: true,
+			}),
+		)
+		.before(async (request) => {
+			expect(request.context.config).type.toBe<{
+				config1: string;
+				config2: string;
+				config3: number;
+			}>();
+			const data = await getInternal("config", request);
+			expect(data.config.config1).type.toBe<string>();
+		});
+});
+
+test("should return the correct config using the getInternal method", () => {
+	handler
+		.use(
+			appConfig({
+				fetchData: {
+					config: appConfigReq<{
+						config1: string;
+						config2: string;
+						config3: number;
+					}>({
+						ApplicationIdentifier: "app",
+						ConfigurationProfileIdentifier: "configId",
+						EnvironmentIdentifier: "development",
+					}),
+				},
+				setToContext: false,
+			}),
+		)
+		.before(async (request) => {
+			const data = await getInternal("config", request);
+			expect(data.config).type.toBe<{
+				config1: string;
+				config2: string;
+				config3: number;
+			}>();
+		});
+});

packages/appconfig/index.test-d.ts

@@ -1,4 +1,5 @@
 import { expectType } from "tsd";
+import { transpileLocale, transpileSchema } from "./transpile";
 
 const schema = transpileSchema({ type: "object" }, {});
 expectType<any>(schema);