@labdigital/commercetools-mock 2.11.0 → 2.12.1

package/package.json

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

package/src/ctMock.test.ts

@@ -0,0 +1,18 @@
+import { CommercetoolsMock } from './index.js'
+import { test } from 'vitest'
+
+test('ctMock.authServer', async () => {
+	const ctMock = new CommercetoolsMock({
+		enableAuthentication: false,
+		validateCredentials: false,
+		apiHost: 'http://api.localhost',
+	})
+
+	ctMock.authStore().addToken({
+		token_type: 'Bearer',
+		access_token: 'foobar',
+		expires_in: 172800,
+		scope: 'my-project',
+		refresh_token: 'foobar',
+	})
+})

package/src/ctMock.ts

@@ -97,6 +97,10 @@ export class CommercetoolsMock {
 		)
 	}
 
+	authStore() {
+		return this._oauth2.store
+	}
+
 	runServer(port = 3000, options?: AppOptions) {
 		const server = this.app.listen(port, () => {
 			console.info(`Mock server listening at http://localhost:${port}`)

package/src/exceptions.ts

@@ -21,3 +21,10 @@ export interface InvalidRequestError {
 	readonly code: 'invalid_request'
 	readonly message: string
 }
+
+export interface AuthError {
+	readonly statusCode: number
+	readonly message: string
+	readonly error: string
+	readonly error_description: string
+}

package/src/oauth/server.test.ts

@@ -26,6 +26,40 @@ describe('OAuth2Server', () => {
 			expect(response.status, JSON.stringify(body)).toBe(200)
 			expect(body).toHaveProperty('access_token')
 		})
+
+		it('should failed on invalid refresh token', async () => {
+			const response = await supertest(app)
+				.post('/token')
+				.auth('validClientId', 'validClientSecret')
+				.query({ grant_type: 'refresh_token', refresh_token: 'invalid' })
+				.send()
+
+			const body = await response.body
+
+			expect(response.status, JSON.stringify(body)).toBe(400)
+		})
+
+		it('should refresh a token', async () => {
+			const createResponse = await supertest(app)
+				.post(`/my-project/anonymous/token`)
+				.auth('validClientId', 'validClientSecret')
+				.query({ grant_type: 'client_credentials' })
+				.send()
+
+			const refreshToken = createResponse.body.refresh_token
+
+			const response = await supertest(app)
+				.post('/token')
+				.auth('validClientId', 'validClientSecret')
+				.query({ grant_type: 'refresh_token', refresh_token: refreshToken })
+				.send()
+
+			const body = await response.body
+
+			expect(response.status, JSON.stringify(body)).toBe(200)
+			expect(body.access_token).not.toBe(createResponse.body.access_token)
+			expect(body.refresh_token).toBeUndefined()
+		})
 	})
 
 	describe('POST /:projectKey/anonymous/token', () => {

package/src/oauth/server.ts

@@ -6,7 +6,11 @@ import express, {
 	type Response,
 } from 'express'
 import { InvalidTokenError } from '@commercetools/platform-sdk'
-import { CommercetoolsError, InvalidRequestError } from '../exceptions.js'
+import {
+	AuthError,
+	CommercetoolsError,
+	InvalidRequestError,
+} from '../exceptions.js'
 import { InvalidClientError, UnsupportedGrantType } from './errors.js'
 import { OAuth2Store } from './store.js'
 import { getBearerToken } from './helpers.js'
@@ -19,6 +23,13 @@ type AuthRequest = Request & {
 		clientSecret: string
 	}
 }
+export type Token = {
+	access_token: string
+	token_type: 'Bearer'
+	expires_in: number
+	scope: string
+	refresh_token?: string
+}
 
 export class OAuth2Server {
 	store: OAuth2Store
@@ -160,11 +171,37 @@ export class OAuth2Server {
 			)
 			return response.status(200).send(token)
 		} else if (grantType === 'refresh_token') {
-			const token = this.store.getClientToken(
+			const refreshToken = request.query.refresh_token?.toString()
+			if (!refreshToken) {
+				return next(
+					new CommercetoolsError<InvalidRequestError>(
+						{
+							code: 'invalid_request',
+							message: 'Missing required parameter: refresh_token.',
+						},
+						400
+					)
+				)
+			}
+			const token = this.store.refreshToken(
 				request.credentials.clientId,
 				request.credentials.clientSecret,
-				request.query.scope?.toString()
+				refreshToken
 			)
+			if (!token) {
+				return next(
+					new CommercetoolsError<AuthError>(
+						{
+							statusCode: 400,
+							message: 'The refresh token was not found. It may have expired.',
+							error: 'invalid_grant',
+							error_description:
+								'The refresh token was not found. It may have expired.',
+						},
+						400
+					)
+				)
+			}
 			return response.status(200).send(token)
 		} else {
 			return next(

package/src/oauth/store.ts

@@ -6,6 +6,7 @@ type Token = {
 	token_type: 'Bearer'
 	expires_in: number
 	scope: string
+	refresh_token?: string
 }
 
 export class OAuth2Store {
@@ -16,14 +17,19 @@ export class OAuth2Store {
 		this.validate = validate
 	}
 
+	addToken(token: Token) {
+		this.tokens.push(token)
+	}
+
 	getClientToken(clientId: string, clientSecret: string, scope?: string) {
 		const token: Token = {
 			access_token: randomBytes(16).toString('base64'),
 			token_type: 'Bearer',
 			expires_in: 172800,
 			scope: scope || 'todo',
+			refresh_token: `my-project-${randomBytes(16).toString('base64')}`,
 		}
-		this.tokens.push(token)
+		this.addToken(token)
 		return token
 	}
 
@@ -38,8 +44,9 @@ export class OAuth2Store {
 			scope: scope
 				? `${scope} anonymous_id:${anonymousId}`
 				: `anonymous_id:${anonymousId}`,
+			refresh_token: `my-project-${randomBytes(16).toString('base64')}`,
 		}
-		this.tokens.push(token)
+		this.addToken(token)
 		return token
 	}
 
@@ -51,11 +58,32 @@ export class OAuth2Store {
 			scope: scope
 				? `${scope} customer_id:${customerId}`
 				: `customer_id:${customerId}`,
+			refresh_token: `my-project-${randomBytes(16).toString('base64')}`,
 		}
-		this.tokens.push(token)
+		this.addToken(token)
 		return token
 	}
 
+	refreshToken(clientId: string, clientSecret: string, refreshToken: string) {
+		const existing = this.tokens.find((t) => t.refresh_token === refreshToken)
+		if (!existing) {
+			return undefined
+		}
+		const token: Token = {
+			...existing,
+			access_token: randomBytes(16).toString('base64'),
+		}
+		this.addToken(token)
+
+		// We don't want to return the refresh_token again
+		return {
+			access_token: token.access_token,
+			token_type: token.token_type,
+			expires_in: token.expires_in,
+			scope: token.scope,
+		}
+	}
+
 	validateToken(token: string) {
 		if (!this.validate) return true