@labdigital/commercetools-mock 1.11.0 → 2.0.0

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@labdigital/commercetools-mock",
   "author": "Michael van Tellingen",
-  "version": "1.11.0",
+  "version": "2.0.0",
   "license": "MIT",
   "main": "dist/index.cjs",
   "module": "dist/index.js",
@@ -19,7 +19,7 @@
     }
   },
   "engines": {
-    "node": ">=16",
+    "node": ">=18",
     "pnpm": ">=8.6.5"
   },
   "packageManager": "pnpm@8.6.5",
@@ -39,7 +39,7 @@
     "express": "^4.18.2",
     "lodash.isequal": "^4.5.0",
     "morgan": "^1.10.0",
-    "nock": "^13.3.2",
+    "msw": "^2.0.0",
     "supertest": "^6.3.3",
     "uuid": "^9.0.0"
   },

package/src/constants.ts

@@ -1,4 +1,2 @@
-export const DEFAULT_API_HOSTNAME =
-	/^https:\/\/api\..*?\.commercetools.com:443$/
-export const DEFAULT_AUTH_HOSTNAME =
-	/^https:\/\/auth\..*?\.commercetools.com:443$/
+export const DEFAULT_API_HOSTNAME = 'https://api.*.commercetools.com'
+export const DEFAULT_AUTH_HOSTNAME = 'https://auth.*.commercetools.com'

package/src/ctMock.ts

@@ -1,7 +1,8 @@
-import nock from 'nock'
 import express, { NextFunction, Request, Response } from 'express'
 import supertest from 'supertest'
 import morgan from 'morgan'
+import { setupServer, SetupServer } from 'msw/node'
+import { http, HttpResponse } from 'msw'
 import { AbstractStorage, InMemoryStorage } from './storage/index.js'
 import { Services } from './types.js'
 import { CommercetoolsError } from './exceptions.js'
@@ -36,16 +37,15 @@ const DEFAULT_OPTIONS: CommercetoolsMockOptions = {
 	silent: false,
 }
 
+const _globalListeners: SetupServer[] = []
+
 export class CommercetoolsMock {
 	public app: express.Express
 	public options: CommercetoolsMockOptions
 
 	private _storage: AbstractStorage
 	private _oauth2: OAuth2Server
-	private _nockScopes: {
-		auth: nock.Scope | undefined
-		api: nock.Scope | undefined
-	} = { auth: undefined, api: undefined }
+	private _mswServer: SetupServer | undefined = undefined
 	private _services: Services | null
 	private _repositories: RepositoryMap | null
 	private _projectService?: ProjectService
@@ -67,19 +67,17 @@ export class CommercetoolsMock {
 
 	start() {
 		// Order is important here when the hostnames match
-		this.mockAuthHost()
-		this.mockApiHost()
+		this.clear()
+		this.startServer()
 	}
 
 	stop() {
-		this._nockScopes.auth?.persist(false)
-		this._nockScopes.auth = undefined
-
-		this._nockScopes.api?.persist(false)
-		this._nockScopes.api = undefined
+		this._mswServer?.close()
+		this._mswServer = undefined
 	}
 
 	clear() {
+		this._mswServer?.resetHandlers()
 		this._storage.clear()
 	}
 
@@ -157,48 +155,81 @@ export class CommercetoolsMock {
 		return app
 	}
 
-	private mockApiHost() {
-		const app = this.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())
+			}
+		}
 
-		this._nockScopes.api = nock(this.options.apiHost)
-			.persist()
-			.get(/.*/)
-			.reply(async function (uri) {
-				const response = await supertest(app)
-					.get(uri)
-					.set(copyHeaders(this.req.headers))
-				return [response.status, response.body]
-			})
-			.post(/.*/)
-			.reply(async function (uri, body) {
-				const response = await supertest(app)
-					.post(uri)
-					.set(copyHeaders(this.req.headers))
+		const app = this.app
+		this._mswServer = setupServer(
+			http.post(`${this.options.authHost}/oauth/*`, async ({ request }) => {
+				const text = await request.text()
+				const url = new URL(request.url)
+				const res = await supertest(app)
+					.post(url.pathname + '?' + url.searchParams.toString())
+					.set(copyHeaders(request.headers))
+					.send(text)
+
+				return new HttpResponse(res.text, {
+					status: res.status,
+					headers: res.headers,
+				})
+			}),
+			http.get(`${this.options.apiHost}/*`, async ({ request }) => {
+				const body = await request.text()
+				const url = new URL(request.url)
+				const res = await supertest(app)
+					.get(url.pathname + '?' + url.searchParams.toString())
+					.set(copyHeaders(request.headers))
 					.send(body)
-				return [response.status, response.body]
-			})
-			.delete(/.*/)
-			.reply(async function (uri, body) {
-				const response = await supertest(app)
-					.delete(uri)
-					.set(copyHeaders(this.req.headers))
+				return new HttpResponse(res.text, {
+					status: res.status,
+					headers: res.headers,
+				})
+			}),
+			http.post(`${this.options.apiHost}/*`, async ({ request }) => {
+				const body = await request.text()
+				const url = new URL(request.url)
+				const res = await supertest(app)
+					.post(url.pathname + '?' + url.searchParams.toString())
+					.set(copyHeaders(request.headers))
+					.send(body)
+				return new HttpResponse(res.text, {
+					status: res.status,
+					headers: res.headers,
+				})
+			}),
+			http.delete(`${this.options.apiHost}/*`, async ({ request }) => {
+				const body = await request.text()
+				const url = new URL(request.url)
+				const res = await supertest(app)
+					.delete(url.pathname + '?' + url.searchParams.toString())
+					.set(copyHeaders(request.headers))
 					.send(body)
-				return [response.status, response.body]
-			})
-	}
-
-	private mockAuthHost() {
-		const app = this.app
 
-		this._nockScopes.auth = nock(this.options.authHost)
-			.persist()
-			.post(/^\/oauth\/.*/)
-			.reply(async function (uri, body) {
-				const response = await supertest(app)
-					.post(uri + '?' + body)
-					.set(copyHeaders(this.req.headers))
-					.send()
-				return [response.status, response.body]
+				return new HttpResponse(res.text, {
+					status: res.status,
+					headers: res.headers,
+				})
 			})
+		)
+		this._mswServer.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(this._mswServer)
 	}
 }

package/src/index.test.ts

@@ -1,27 +1,63 @@
 import { type InvalidTokenError } from '@commercetools/platform-sdk'
 import { CommercetoolsMock } from './index.js'
-import { afterEach, beforeEach, expect, test } from 'vitest'
-import nock from 'nock'
+import { expect, test } from 'vitest'
 import got from 'got'
 
-beforeEach(() => {
-	nock.disableNetConnect()
-	nock.enableNetConnect('127.0.0.1') // supertest
-})
-afterEach(() => {
-	nock.enableNetConnect()
-	nock.cleanAll()
+test('node:fetch client', async () => {
+	const ctMock = new CommercetoolsMock({
+		enableAuthentication: true,
+		validateCredentials: true,
+		apiHost: 'https://localhost',
+		authHost: 'https://localhost:8080',
+	})
+	ctMock.start()
+
+	const authHeader = 'Basic ' + Buffer.from('foo:bar').toString('base64')
+	let response = await fetch('https://localhost:8080/oauth/token', {
+		method: 'POST',
+		headers: {
+			'Content-Type': 'application/x-www-form-urlencoded',
+			Authorization: authHeader,
+		},
+		body: new URLSearchParams({
+			grant_type: 'client_credentials',
+			scope: 'manage_project:commercetools-node-mock',
+		}),
+	})
+
+	const authBody = await response.json()
+	expect(response.status).toBe(200)
+
+	const token = authBody.access_token
+	response = await fetch('https://localhost/my-project/orders', {
+		headers: {
+			Authorization: `Bearer ${token}`,
+		},
+	})
+
+	const body = await response.json()
+	expect(response.status).toBe(200)
+	expect(body).toStrictEqual({
+		count: 0,
+		total: 0,
+		offset: 0,
+		limit: 20,
+		results: [],
+	})
+	ctMock.stop()
 })
 
-test('Default mock endpoints', async () => {
+test('got client', async () => {
 	const ctMock = new CommercetoolsMock({
 		enableAuthentication: true,
 		validateCredentials: true,
+		apiHost: 'https://localhost',
+		authHost: 'https://localhost:8080',
 	})
 	ctMock.start()
 
 	let response = await got.post<{ access_token: string }>(
-		'https://auth.europe-west1.gcp.commercetools.com/oauth/token',
+		'https://localhost:8080/oauth/token',
 		{
 			searchParams: {
 				grant_type: 'client_credentials',
@@ -36,15 +72,12 @@ test('Default mock endpoints', async () => {
 
 	const token = response.body.access_token
 	expect(response.body.access_token).toBeDefined()
-	response = await got.get(
-		'https://api.europe-west1.gcp.commercetools.com/my-project/orders',
-		{
-			headers: {
-				Authorization: `Bearer ${token}`,
-			},
-			responseType: 'json',
-		}
-	)
+	response = await got.get('https://localhost/my-project/orders', {
+		headers: {
+			Authorization: `Bearer ${token}`,
+		},
+		responseType: 'json',
+	})
 	expect(response.statusCode).toBe(200)
 	expect(response.body).toStrictEqual({
 		count: 0,
@@ -192,6 +225,7 @@ test('apiHost mock proxy: querystring', async () => {
 			expand: 'custom.type',
 		},
 	})
+
 	expect(response.statusCode).toBe(200)
 	expect(response.body).toStrictEqual({
 		count: 0,

package/src/lib/proxy.ts

@@ -1,12 +1,12 @@
-export const copyHeaders = (headers: Record<string, string>) => {
-	const validHeaders = ['accept', 'host', 'authorization']
+export const copyHeaders = (headers: Headers) => {
+	const validHeaders = ['accept', 'host', 'authorization', 'content-type']
 	const result: Record<string, string> = {}
 
-	Object.entries(headers).forEach(([key, value]) => {
+	for (const [key, value] of headers.entries()) {
 		if (validHeaders.includes(key.toLowerCase())) {
 			result[key] = value
 		}
-	})
+	}
 
 	return result
 }