@labdigital/commercetools-mock 2.66.0 → 3.0.0-beta.0

package/src/ctMock.ts

@@ -1,10 +1,7 @@
-import type { NextFunction, Request, Response } from "express";
-import express from "express";
-import inject from "light-my-request";
-import morgan from "morgan";
+import Fastify, { type FastifyBaseLogger, type FastifyInstance } from "fastify";
 import { HttpResponse, http } from "msw";
 import type { SetupServer, SetupServerApi } from "msw/node";
-import { setupServer } from "msw/node";
+import qs from "qs";
 import type { Config } from "./config.ts";
 import { DEFAULT_API_HOSTNAME, DEFAULT_AUTH_HOSTNAME } from "./constants.ts";
 import { CommercetoolsError } from "./exceptions.ts";
@@ -28,10 +25,10 @@ export type CommercetoolsMockOptions = {
 	authHost: RegExp | string;
 	silent: boolean;
 	strict: boolean;
+	storage: AbstractStorage | undefined;
+	logger: FastifyBaseLogger | undefined;
 };
 
-type AppOptions = { silent?: boolean };
-
 const DEFAULT_OPTIONS: CommercetoolsMockOptions = {
 	enableAuthentication: false,
 	validateCredentials: false,
@@ -40,12 +37,14 @@ const DEFAULT_OPTIONS: CommercetoolsMockOptions = {
 	authHost: DEFAULT_AUTH_HOSTNAME,
 	silent: true,
 	strict: false,
+	storage: undefined,
+	logger: undefined,
 };
 
 const _globalListeners: SetupServer[] = [];
 
 export class CommercetoolsMock {
-	public app: express.Express;
+	public app: FastifyInstance;
 
 	public options: CommercetoolsMockOptions;
 
@@ -65,37 +64,21 @@ export class CommercetoolsMock {
 		this._repositories = null;
 		this._projectService = undefined;
 
-		this._storage = new InMemoryStorage();
+		this._storage = this.options.storage ?? new InMemoryStorage();
 		this._oauth2 = new OAuth2Server({
 			enabled: this.options.enableAuthentication,
 			validate: this.options.validateCredentials,
 		});
 
-		this.app = this.createApp({ silent: this.options.silent });
-	}
-
-	start() {
-		process.emitWarning(
-			"The start() method is deprecated, use .registerHandlers() to bind to an msw server instead",
-			"DeprecationWarning",
-		);
-
-		// Order is important here when the hostnames match
-		this.clear();
-		this.startServer();
+		this.app = this.createApp();
 	}
 
-	stop() {
-		process.emitWarning(
-			"The stop() method is deprecated, use .registerHandlers() to bind to an msw server instead",
-			"DeprecationWarning",
-		);
-		this._mswServer?.close();
-		this._mswServer = undefined;
+	get server() {
+		return this.app.server;
 	}
 
-	clear() {
-		this._storage.clear();
+	async clear() {
+		await this._storage.clear();
 	}
 
 	project(projectKey?: string) {
@@ -123,12 +106,11 @@ export class CommercetoolsMock {
 		return this._oauth2.store;
 	}
 
-	runServer(port = 3000, options?: AppOptions) {
-		const server = this.app.listen(port, () => {});
-		server.keepAliveTimeout = 60 * 1000;
+	async runServer(port = 3000) {
+		await this.app.listen({ port, host: "0.0.0.0" });
 	}
 
-	private createApp(options?: AppOptions): express.Express {
+	private createApp(): FastifyInstance {
 		const config: Config = {
 			strict: this.options.strict,
 			storage: this._storage,
@@ -136,59 +118,92 @@ export class CommercetoolsMock {
 		this._repositories = createRepositories(config);
 		this._oauth2.setCustomerRepository(this._repositories.customer);
 
-		const app = express();
-		// Set limit to 16mb, this is the maximum size allowed by the commercetools API: https://docs.commercetools.com/api/limits
-		app.use(express.json({ limit: "16mb" }));
+		const loggerConfig = this.options.logger
+			? { loggerInstance: this.options.logger }
+			: { logger: !this.options.silent ? { level: "info" as const } : false };
 
-		const projectRouter = express.Router({ mergeParams: true });
-
-		if (!options?.silent) {
-			app.use(morgan("tiny"));
-		}
-		app.use("/oauth", this._oauth2.createRouter());
-
-		// Only enable auth middleware if we have enabled this
-		if (this.options.enableAuthentication) {
-			app.use("/:projectKey", this._oauth2.createMiddleware(), projectRouter);
-			app.use(
-				"/:projectKey/in-store/key=:storeKey",
-				this._oauth2.createMiddleware(),
-				projectRouter,
-			);
-		} else {
-			app.use("/:projectKey", projectRouter);
-			app.use("/:projectKey/in-store/key=:storeKey", projectRouter);
-		}
-
-		// Register the rest api services in the router
-		createServices(projectRouter, this._repositories);
-		this._projectService = new ProjectService(
-			projectRouter,
-			this._repositories.project as ProjectRepository,
-		);
+		const app = Fastify({
+			// Set limit to 16mb, this is the maximum size allowed by the commercetools API: https://docs.commercetools.com/api/limits
+			bodyLimit: 16 * 1024 * 1024,
+			...loggerConfig,
+			routerOptions: {
+				querystringParser: (str) => qs.parse(str),
+			},
+		});
 
-		app.use((err: Error, req: Request, resp: Response, next: NextFunction) => {
-			if (err instanceof CommercetoolsError) {
-				if (err.errors?.length > 0) {
-					resp.status(err.statusCode).send({
-						statusCode: err.statusCode,
-						message: err.message,
-						errors: err.errors,
-					});
+		// Override the default JSON parser to accept empty bodies. This is
+		// needed because some HTTP clients (e.g. commercetools SDKs) send
+		// DELETE requests with a Content-Type: application/json header but
+		// without a body. Fastify 5 rejects these by default.
+		app.addContentTypeParser(
+			"application/json",
+			{ parseAs: "string" },
+			(_req, body, done) => {
+				if (!body || (typeof body === "string" && body.trim() === "")) {
+					done(null, undefined);
 					return;
 				}
+				try {
+					done(null, JSON.parse(body as string));
+				} catch (err) {
+					done(err as Error, undefined);
+				}
+			},
+		);
 
-				resp.status(err.statusCode).send({
-					statusCode: err.statusCode,
-					message: err.message,
-					errors: [err.info],
-				});
-				return;
+		// Register OAuth routes
+		app.register(this._oauth2.createPlugin(), { prefix: "/oauth" });
+
+		// Register project routes
+		const repositories = this._repositories;
+		const oauth2 = this._oauth2;
+		const enableAuth = this.options.enableAuthentication;
+
+		const projectPlugin = async (instance: FastifyInstance) => {
+			if (enableAuth) {
+				instance.addHook("preHandler", oauth2.createMiddleware());
 			}
-			resp.status(500).send({
-				error: err.message,
+			createServices(instance, repositories);
+			new ProjectService(instance, repositories.project as ProjectRepository);
+		};
+
+		app.register(projectPlugin, { prefix: "/:projectKey" });
+		app.register(projectPlugin, {
+			prefix: "/:projectKey/in-store/key=:storeKey",
+		});
+
+		// Error handler
+		app.setErrorHandler((error, request, reply) => {
+			if (error instanceof CommercetoolsError) {
+				const responseBody =
+					error.errors?.length > 0
+						? {
+								statusCode: error.statusCode,
+								message: error.message,
+								errors: error.errors,
+							}
+						: {
+								statusCode: error.statusCode,
+								message: error.message,
+								errors: [error.info],
+							};
+
+				request.log.error(
+					{ statusCode: error.statusCode, err: error },
+					`${request.method} ${request.url} - ${error.statusCode}: ${error.message}`,
+				);
+
+				return reply.status(error.statusCode).send(responseBody);
+			}
+
+			request.log.error(
+				{ statusCode: 500, err: error },
+				`${request.method} ${request.url} - 500: ${error instanceof Error ? error.message : String(error)}`,
+			);
+
+			return reply.status(500).send({
+				error: error instanceof Error ? error.message : String(error),
 			});
-			return;
 		});
 
 		return app;
@@ -210,11 +225,12 @@ export class CommercetoolsMock {
 				const url = new URL(request.url);
 				const headers = copyHeaders(request.headers);
 
-				const res = await inject(app)
-					.post(`${url.pathname}?${url.searchParams.toString()}`)
-					.body(body)
-					.headers(headers)
-					.end();
+				const res = await app.inject({
+					method: "POST",
+					url: `${url.pathname}?${url.searchParams.toString()}`,
+					body,
+					headers,
+				});
 				return new HttpResponse(res.body, {
 					status: res.statusCode,
 					headers: mapHeaderType(res.headers),
@@ -225,16 +241,15 @@ export class CommercetoolsMock {
 				const url = new URL(request.url);
 				const headers = copyHeaders(request.headers);
 
-				const res = await inject(app)
-					.get(`${url.pathname}?${url.searchParams.toString()}`)
-					.body(body)
-					.headers(headers)
-					.end();
+				const res = await app.inject({
+					method: "GET",
+					url: `${url.pathname}?${url.searchParams.toString()}`,
+					body,
+					headers,
+				});
 
 				if (res.statusCode === 200) {
 					const parsedBody = JSON.parse(res.body);
-					// Check if we have a count property (e.g. for query-lookups)
-					// or if we have a result object (e.g. for single lookups)
 					const resultCount =
 						"count" in parsedBody
 							? parsedBody.count
@@ -256,11 +271,12 @@ export class CommercetoolsMock {
 				const url = new URL(request.url);
 				const headers = copyHeaders(request.headers);
 
-				const res = await inject(app)
-					.get(`${url.pathname}?${url.searchParams.toString()}`)
-					.body(body)
-					.headers(headers)
-					.end();
+				const res = await app.inject({
+					method: "GET",
+					url: `${url.pathname}?${url.searchParams.toString()}`,
+					body,
+					headers,
+				});
 				return new HttpResponse(res.body, {
 					status: res.statusCode,
 					headers: mapHeaderType(res.headers),
@@ -271,11 +287,12 @@ export class CommercetoolsMock {
 				const url = new URL(request.url);
 				const headers = copyHeaders(request.headers);
 
-				const res = await inject(app)
-					.post(`${url.pathname}?${url.searchParams.toString()}`)
-					.body(body)
-					.headers(headers)
-					.end();
+				const res = await app.inject({
+					method: "POST",
+					url: `${url.pathname}?${url.searchParams.toString()}`,
+					body,
+					headers,
+				});
 				return new HttpResponse(res.body, {
 					status: res.statusCode,
 					headers: mapHeaderType(res.headers),
@@ -286,11 +303,12 @@ export class CommercetoolsMock {
 				const url = new URL(request.url);
 				const headers = copyHeaders(request.headers);
 
-				const res = await inject(app)
-					.delete(`${url.pathname}?${url.searchParams.toString()}`)
-					.body(body)
-					.headers(headers)
-					.end();
+				const res = await app.inject({
+					method: "DELETE",
+					url: `${url.pathname}?${url.searchParams.toString()}`,
+					body,
+					headers,
+				});
 				return new HttpResponse(res.body, {
 					status: res.statusCode,
 					headers: mapHeaderType(res.headers),
@@ -302,33 +320,4 @@ export class CommercetoolsMock {
 	public mswServer() {
 		return this._mswServer;
 	}
-
-	private startServer() {
-		// Check if there are any other servers running
-		if (_globalListeners.length > 0) {
-			if (this._mswServer !== undefined) {
-				throw new Error("Server already started");
-			}
-			process.emitWarning("Server wasn't stopped properly, clearing");
-			for (const listener of _globalListeners) {
-				listener.close();
-			}
-			_globalListeners.length = 0;
-		}
-
-		const server = setupServer();
-		this.registerHandlers(server);
-		server.listen({
-			// We need to allow requests done by supertest
-			onUnhandledRequest: (request, print) => {
-				const url = new URL(request.url);
-				if (url.hostname === "127.0.0.1") {
-					return;
-				}
-				print.error();
-			},
-		});
-		_globalListeners.push(server);
-		this._mswServer = server;
-	}
 }

package/src/helpers.ts

@@ -2,12 +2,20 @@ import type { OutgoingHttpHeaders } from "node:http";
 import type { ParsedQs } from "qs";
 import { v4 as uuidv4 } from "uuid";
 
-export const getBaseResourceProperties = () => ({
-	id: uuidv4(),
-	createdAt: new Date().toISOString(),
-	lastModifiedAt: new Date().toISOString(),
-	version: 0,
-});
+export const getBaseResourceProperties = (clientId?: string) => {
+	const clientInfo = {
+		clientId: clientId ?? "",
+		isPlatformClient: false,
+	};
+	return {
+		id: uuidv4(),
+		createdAt: new Date().toISOString(),
+		lastModifiedAt: new Date().toISOString(),
+		version: 0,
+		createdBy: clientInfo,
+		lastModifiedBy: clientInfo,
+	};
+};
 
 /**
  * Do a nested lookup by using a path. For example `foo.bar.value` will

package/src/index.ts

@@ -1,9 +1,14 @@
 import type { CommercetoolsMockOptions } from "./ctMock.ts";
 import { CommercetoolsMock } from "./ctMock.ts";
 import { getBaseResourceProperties } from "./helpers.ts";
+import { AbstractStorage, InMemoryStorage } from "./storage/index.ts";
+
+export type { FastifyBaseLogger } from "fastify";
 
 export {
+	AbstractStorage,
 	CommercetoolsMock,
+	InMemoryStorage,
 	getBaseResourceProperties,
 	type CommercetoolsMockOptions,
 };

package/src/lib/masking.ts

@@ -1,9 +1,8 @@
-import { cloneObject } from "../helpers.ts";
-
 export const maskSecretValue = <T>(resource: T, path: string): T => {
 	const parts = path.split(".");
-	const clone = cloneObject(resource) as any;
-	let val = clone;
+	// Callers are expected to pass objects that are safe to mutate
+	// (e.g. clones from storage retrieval).
+	let val = resource as any;
 
 	const target = parts.pop();
 	for (let i = 0; i < parts.length; i++) {
@@ -18,5 +17,5 @@ export const maskSecretValue = <T>(resource: T, path: string): T => {
 	if (val && target && val[target]) {
 		val[target] = "****";
 	}
-	return clone;
+	return resource;
 };