@labdigital/commercetools-mock 2.4.0 → 2.6.0

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@labdigital/commercetools-mock",
   "author": "Michael van Tellingen",
-  "version": "2.4.0",
+  "version": "2.6.0",
   "license": "MIT",
   "main": "dist/index.cjs",
   "module": "dist/index.js",

package/src/ctMock.ts

@@ -165,25 +165,18 @@ export class CommercetoolsMock {
 		return app
 	}
 
-	private startServer() {
-		// Check if there are any other servers running
-		if (_globalListeners.length > 0) {
-			if (this._mswServer !== undefined) {
-				throw new Error('Server already started')
-			} else {
-				console.warn("Server wasn't stopped properly, clearing")
-				_globalListeners.forEach((listener) => listener.close())
-			}
-		}
-
-		const server = this.app
-		this._mswServer = setupServer(
+	// 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) {
+		const app = this.app
+		server.use(
 			http.post(`${this.options.authHost}/oauth/*`, async ({ request }) => {
 				const body = await request.text()
 				const url = new URL(request.url)
 				const headers = copyHeaders(request.headers)
 
-				const res = await inject(server)
+				const res = await inject(app)
 					.post(url.pathname + '?' + url.searchParams.toString())
 					.body(body)
 					.headers(headers)
@@ -193,12 +186,43 @@ export class CommercetoolsMock {
 					headers: mapHeaderType(res.headers),
 				})
 			}),
+			http.head(`${this.options.apiHost}/*`, async ({ request }) => {
+				const body = await request.text()
+				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()
+
+				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
+							: Object.keys(parsedBody).length
+
+					return new HttpResponse(null, {
+						status: resultCount > 0 ? 200 : 404,
+						headers: mapHeaderType(res.headers),
+					})
+				}
+
+				return new HttpResponse(null, {
+					status: res.statusCode,
+					headers: mapHeaderType(res.headers),
+				})
+			}),
 			http.get(`${this.options.apiHost}/*`, async ({ request }) => {
 				const body = await request.text()
 				const url = new URL(request.url)
 				const headers = copyHeaders(request.headers)
 
-				const res = await inject(server)
+				const res = await inject(app)
 					.get(url.pathname + '?' + url.searchParams.toString())
 					.body(body)
 					.headers(headers)
@@ -213,7 +237,7 @@ export class CommercetoolsMock {
 				const url = new URL(request.url)
 				const headers = copyHeaders(request.headers)
 
-				const res = await inject(server)
+				const res = await inject(app)
 					.post(url.pathname + '?' + url.searchParams.toString())
 					.body(body)
 					.headers(headers)
@@ -228,7 +252,7 @@ export class CommercetoolsMock {
 				const url = new URL(request.url)
 				const headers = copyHeaders(request.headers)
 
-				const res = await inject(server)
+				const res = await inject(app)
 					.delete(url.pathname + '?' + url.searchParams.toString())
 					.body(body)
 					.headers(headers)
@@ -239,7 +263,22 @@ export class CommercetoolsMock {
 				})
 			})
 		)
-		this._mswServer.listen({
+	}
+
+	private startServer() {
+		// Check if there are any other servers running
+		if (_globalListeners.length > 0) {
+			if (this._mswServer !== undefined) {
+				throw new Error('Server already started')
+			} else {
+				console.warn("Server wasn't stopped properly, clearing")
+				_globalListeners.forEach((listener) => listener.close())
+			}
+		}
+
+		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)
@@ -249,7 +288,7 @@ export class CommercetoolsMock {
 				print.error()
 			},
 		})
-
-		_globalListeners.push(this._mswServer)
+		_globalListeners.push(server)
+		this._mswServer = server
 	}
 }

package/src/services/custom-object.test.ts

@@ -47,7 +47,23 @@ describe('CustomObject retrieve', () => {
 		ctMock.clear()
 	})
 
-	test('createget', async () => {
+	test('exists', async () => {
+		const response = await supertest(ctMock.app)
+			.head('/dummy/custom-objects/my-container/my-key')
+			.send()
+
+		expect(response.status).toBe(200)
+	})
+
+	test('non-existent', async () => {
+		const response = await supertest(ctMock.app)
+			.head('/dummy/custom-objects/invalid-container/invalid')
+			.send()
+
+		expect(response.status).toBe(404)
+	})
+
+	test('get', async () => {
 		const response = await supertest(ctMock.app)
 			.get('/dummy/custom-objects/my-container/my-key')
 			.send()

package/src/services/customer.test.ts

@@ -26,6 +26,26 @@ describe('Customer Update Actions', () => {
 		ctMock.clear()
 	})
 
+	test('exists', async () => {
+		assert(customer, 'customer not created')
+
+		const response = await supertest(ctMock.app)
+			.head(`/dummy/customers/${customer.id}`)
+			.send()
+
+		expect(response.status).toBe(200)
+	})
+
+	test('non-existent', async () => {
+		assert(customer, 'customer not created')
+
+		const response = await supertest(ctMock.app)
+			.head(`/dummy/customers/invalid-id`)
+			.send()
+
+		expect(response.status).toBe(404)
+	})
+
 	test('changeEmail', async () => {
 		assert(customer, 'customer not created')