@labdigital/commercetools-mock 2.18.0 → 2.18.2

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@labdigital/commercetools-mock",
-  "version": "2.18.0",
+  "version": "2.18.2",
   "license": "MIT",
   "author": "Michael van Tellingen",
   "type": "module",
@@ -27,7 +27,9 @@
     "lodash.isequal": "^4.5.0",
     "morgan": "^1.10.0",
     "msw": "^2.2.1",
-    "uuid": "^9.0.1"
+    "uuid": "^9.0.1",
+    "zod": "^3.22.4",
+    "zod-validation-error": "^3.0.2"
   },
   "devDependencies": {
     "@changesets/changelog-github": "^0.5.0",

package/src/ctMock.ts

@@ -2,7 +2,7 @@ import express, { NextFunction, Request, Response } from "express";
 import inject from "light-my-request";
 import morgan from "morgan";
 import { http, HttpResponse } from "msw";
-import { setupServer, SetupServer } from "msw/node";
+import { setupServer, SetupServer, SetupServerApi } from "msw/node";
 import { DEFAULT_API_HOSTNAME, DEFAULT_AUTH_HOSTNAME } from "./constants";
 import { CommercetoolsError } from "./exceptions";
 import { copyHeaders } from "./lib/proxy";
@@ -185,7 +185,7 @@ export class CommercetoolsMock {
 	// registerHandlers is an alternative way to work with commercetools-mock, it
 	// allows you to manage msw server yourself and register the handlers needed
 	// for commercetools-mock to work.
-	public registerHandlers(server: SetupServer) {
+	public registerHandlers(server: SetupServerApi) {
 		const app = this.app;
 		server.use(
 			http.post(`${this.options.authHost}/oauth/*`, async ({ request }) => {

package/src/repositories/project.ts

@@ -26,7 +26,7 @@ import {
 export class ProjectRepository extends AbstractRepository<Project> {
 	constructor(storage: AbstractStorage) {
 		super(storage);
-		this.actions = new ProjectUpdateHandler(this._storage);
+		this.actions = new ProjectUpdateHandler(storage);
 	}
 
 	get(context: RepositoryContext): Project | null {

package/src/schemas/update-request.ts

@@ -0,0 +1,12 @@
+import { z } from "zod";
+
+const UpdateActionSchema = z
+	.object({
+		action: z.string(),
+	})
+	.passthrough();
+
+export const updateRequestSchema = z.object({
+	version: z.number(),
+	actions: z.array(UpdateActionSchema),
+});

package/src/services/abstract.ts

@@ -1,6 +1,8 @@
 import type { Update } from "@commercetools/platform-sdk";
 import { Router, type Request, type Response } from "express";
 import { ParsedQs } from "qs";
+import { updateRequestSchema } from "~src/schemas/update-request";
+import { validateData } from "~src/validate";
 import { queryParamsArray } from "../helpers";
 import { AbstractResourceRepository } from "../repositories/abstract";
 import { getRepositoryContext } from "../repositories/helpers";
@@ -119,7 +121,10 @@ export default abstract class AbstractService {
 	}
 
 	postWithId(request: Request, response: Response) {
-		const updateRequest: Update = request.body;
+		const updateRequest = validateData<Update>(
+			request.body,
+			updateRequestSchema,
+		);
 		const resource = this.repository.get(
 			getRepositoryContext(request),
 			request.params["id"],
@@ -140,7 +145,11 @@ export default abstract class AbstractService {
 	}
 
 	postWithKey(request: Request, response: Response) {
-		const updateRequest: Update = request.body;
+		const updateRequest = validateData<Update>(
+			request.body,
+			updateRequestSchema,
+		);
+
 		const resource = this.repository.getByKey(
 			getRepositoryContext(request),
 			request.params["key"],
@@ -148,6 +157,7 @@ export default abstract class AbstractService {
 		if (!resource) {
 			return response.status(404).send("Not found");
 		}
+
 		const updatedResource = this.repository.processUpdateActions(
 			getRepositoryContext(request),
 			resource,

package/src/services/my-customer.ts

@@ -1,5 +1,7 @@
 import { Update } from "@commercetools/platform-sdk";
 import { Request, Response, Router } from "express";
+import { updateRequestSchema } from "~src/schemas/update-request";
+import { validateData } from "~src/validate";
 import { hashPassword } from "../lib/password";
 import { getRepositoryContext } from "../repositories/helpers";
 import { MyCustomerRepository } from "../repositories/my-customer";
@@ -51,7 +53,10 @@ export class MyCustomerService extends AbstractService {
 		if (!resource) {
 			return response.status(404).send("Not found");
 		}
-		const updateRequest: Update = request.body;
+		const updateRequest = validateData<Update>(
+			request.body,
+			updateRequestSchema,
+		);
 		const updatedResource = this.repository.processUpdateActions(
 			getRepositoryContext(request),
 			resource,

package/src/services/project.test.ts

@@ -49,4 +49,9 @@ describe("Project", () => {
 			trialUntil: "2018-12",
 		} as Project);
 	});
+
+	test("Post empty update ", async () => {
+		const response = await supertest(ctMock.app).post("/dummy/");
+		expect(response.statusCode).toBe(400);
+	});
 });

package/src/services/project.ts

@@ -1,5 +1,7 @@
-import type { Update } from "@commercetools/platform-sdk";
+import { Update } from "@commercetools/platform-sdk";
 import { Request, Response, Router } from "express";
+import { updateRequestSchema } from "~src/schemas/update-request";
+import { validateData } from "~src/validate";
 import { getRepositoryContext } from "../repositories/helpers";
 import { ProjectRepository } from "../repositories/project";
 
@@ -22,7 +24,10 @@ export class ProjectService {
 	}
 
 	post(request: Request, response: Response) {
-		const updateRequest: Update = request.body;
+		const updateRequest = validateData<Update>(
+			request.body,
+			updateRequestSchema,
+		);
 		const project = this.repository.get(getRepositoryContext(request));
 
 		if (!project) {

package/src/validate.ts

@@ -0,0 +1,18 @@
+import { InvalidJsonInputError } from "@commercetools/platform-sdk";
+import { z } from "zod";
+import { fromZodError } from "zod-validation-error";
+import { CommercetoolsError } from "./exceptions";
+
+export const validateData = <T>(data: any, schema: z.AnyZodObject) => {
+	try {
+		schema.parse(data);
+		return data as T;
+	} catch (err: any) {
+		const validationError = fromZodError(err);
+		throw new CommercetoolsError<InvalidJsonInputError>({
+			code: "InvalidJsonInput",
+			message: "Request body does not contain valid JSON.",
+			detailedErrorMessage: validationError.toString(),
+		});
+	}
+};