mockaton 8.11.6 → 8.11.7

package/README.md

@@ -3,6 +3,9 @@
 ![NPM Version](https://img.shields.io/npm/v/mockaton)
 ![NPM Version](https://img.shields.io/npm/l/mockaton)
 
+Mockaton is an HTTP mock server for enhancing the development and testing experience.
+
+## Convention over Code
 
 With Mockaton you don’t need to write code for wiring mocks. Instead, it scans a
 given directory for filenames following a convention similar to the URLs.
@@ -13,8 +16,10 @@ For example, for <code>/<b>api/user</b>/1234</code> the filename would be:
 </pre>
 
 
+## Dashboard
+
 On the dashboard you can select a mock variant for a particular route, delaying responses,
-and triggering an autogenerated `500` (Internal Server Error), among other features.
+or triggering an autogenerated `500` (Internal Server Error), among other features.
 
 Nonetheless, there’s a programmatic API, which is handy
 for setting up tests. See **Commander&nbsp;API** section.
@@ -148,7 +153,10 @@ filename, such as `(demo-part1)`, `(demo-part2)`.
 ## Alternatives
 - Chrome DevTools allows for [overriding responses](https://developer.chrome.com/docs/devtools/overrides)
 - Reverse Proxies such as [Burp](https://portswigger.net/burp) are also handy for overriding responses.
-- [Mock Server Worker](https://mswjs.io)
+- [MSW (Mock Server Worker)](https://mswjs.io)
+- [Nock](https://github.com/nock/nock)
+- [Fetch Mock](https://github.com/wheresrhys/fetch-mock)
+- [Mentoss](https://github.com/humanwhocodes/mentoss)
 
 ---
 
@@ -364,8 +372,8 @@ Mockaton’s predefined list. For that, you can add it to <code>config.extraMime
 - Use Case 2: For a standalone demo server. For example,
   build your frontend bundle, and serve it from Mockaton.
 
-Files under `config.staticDir` don’t use the filename convention.
-They take precedence over the `GET` mocks in `config.mocksDir`.
+Files under `config.staticDir` don’t use the filename convention, and
+they take precedence over `GET` mocks in `config.mocksDir`.
 For example, if you have two files for `GET /foo/bar.jpg`
 
 <pre>

package/TODO.md

@@ -1,6 +1,11 @@
 # TODO
 
 - Refactor tests
+- Group By Route/Method localstorage
+- openapi
+  - parsing it for examples?
+  - displaying documentation (.openapi)
+    - perhaps instead using .js functions `export const doc`
 - Preserve focus when refreshing dashboard `init()`
 - More real-time updates. Currently, it's only for add/remove mock but not for
   static files and changes from another client (Browser, or Commander). 

package/package.json

@@ -2,7 +2,7 @@
 	"name": "mockaton",
 	"description": "A deterministic server-side for developing and testing frontend clients",
 	"type": "module",
-	"version": "8.11.6",
+	"version": "8.11.7",
 	"main": "index.js",
 	"types": "index.d.ts",
 	"license": "MIT",

package/src/Api.js

@@ -6,11 +6,11 @@
 import { join } from 'node:path'
 import { cookie } from './cookie.js'
 import { config } from './config.js'
+import { arEvents } from './Watcher.js'
 import { parseJSON } from './utils/http-request.js'
 import { listFilesRecursively } from './utils/fs.js'
 import * as mockBrokersCollection from './mockBrokersCollection.js'
 import { DF, API, LONG_POLL_SERVER_TIMEOUT } from './ApiConstants.js'
-import { countAR_Events, subscribeAR_EventListener, unsubscribeAR_EventListener } from './Watcher.js'
 import { sendOK, sendJSON, sendUnprocessableContent, sendDashboardFile, sendForbidden } from './utils/http-response.js'
 
 
@@ -82,22 +82,22 @@ function listStaticFiles(req, response) {
 
 function longPollAR_Events(req, response) {
 	// e.g. tab was hidden while new mocks were added or removed
-	const clientIsOutOfSync = parseInt(req.headers[DF.lastReceived_nAR], 10) !== countAR_Events()
+	const clientIsOutOfSync = parseInt(req.headers[DF.lastReceived_nAR], 10) !== arEvents.count
 	if (clientIsOutOfSync) {
-		sendJSON(response, countAR_Events())
+		sendJSON(response, arEvents.count)
 		return
 	}
 
 	function onAddOrRemoveMock() {
-		unsubscribeAR_EventListener(onAddOrRemoveMock)
-		sendJSON(response, countAR_Events())
+		arEvents.unsubscribe(onAddOrRemoveMock)
+		sendJSON(response, arEvents.count)
 	}
 	response.setTimeout(LONG_POLL_SERVER_TIMEOUT, onAddOrRemoveMock)
 	req.on('error', () => {
-		unsubscribeAR_EventListener(onAddOrRemoveMock)
+		arEvents.unsubscribe(onAddOrRemoveMock)
 		response.destroy()
 	})
-	subscribeAR_EventListener(onAddOrRemoveMock)
+	arEvents.subscribe(onAddOrRemoveMock)
 }
 
 
@@ -123,7 +123,7 @@ async function selectMock(req, response) {
 	if (!broker || !broker.hasMock(file))
 		sendUnprocessableContent(response, `Missing Mock: ${file}`)
 	else {
-		broker.updateFile(file)
+		broker.selectFile(file)
 		sendOK(response)
 	}
 }

package/src/MockBroker.js

@@ -26,16 +26,20 @@ export class MockBroker {
 	register(file) {
 		if (parseFilename(file).status === 500) {
 			if (this.temp500IsSelected)
-				this.updateFile(file)
+				this.selectFile(file)
 			this.#deleteTemp500()
 		}
 		this.mocks.push(file)
 		this.#sortMocks()
 	}
 
-	#deleteTemp500() { this.mocks = this.mocks.filter(file => !this.#isTemp500(file)) }
+	#deleteTemp500() {
+		this.mocks = this.mocks.filter(file => !this.#isTemp500(file))
+	}
 
-	#isTemp500(file) { return includesComment(file, DEFAULT_500_COMMENT) }
+	#isTemp500(file) {
+		return includesComment(file, DEFAULT_500_COMMENT)
+	}
 
 	#sortMocks() {
 		this.mocks.sort()
@@ -69,10 +73,10 @@ export class MockBroker {
 	}
 
 	selectDefaultFile() {
-		this.updateFile(this.mocks[0])
+		this.selectFile(this.mocks[0])
 	}
 
-	updateFile(filename) {
+	selectFile(filename) {
 		this.currentMock.file = filename
 	}
 
@@ -82,7 +86,7 @@ export class MockBroker {
 
 	updateProxied(proxied) {
 		if (proxied)
-			this.updateFile('')
+			this.selectFile('')
 		else
 			this.selectDefaultFile()
 	}
@@ -90,7 +94,7 @@ export class MockBroker {
 	setByMatchingComment(comment) {
 		for (const file of this.mocks)
 			if (includesComment(file, comment)) {
-				this.updateFile(file)
+				this.selectFile(file)
 				break
 			}
 	}

package/src/Mockaton.test.js

@@ -607,12 +607,12 @@ async function testCorsAllowed() {
 			method: 'OPTIONS',
 			headers: {
 				[CorsHeader.Origin]: 'http://example.com',
-				[CorsHeader.AccessControlRequestMethod]: 'GET'
+				[CorsHeader.AcRequestMethod]: 'GET'
 			}
 		})
 		equal(res.status, 204)
-		equal(res.headers.get(CorsHeader.AccessControlAllowOrigin), 'http://example.com')
-		equal(res.headers.get(CorsHeader.AccessControlAllowMethods), 'GET')
+		equal(res.headers.get(CorsHeader.AcAllowOrigin), 'http://example.com')
+		equal(res.headers.get(CorsHeader.AcAllowMethods), 'GET')
 	})
 	await it('cors actual response', async () => {
 		const res = await request(fixtureDefaultInName[0], {
@@ -621,8 +621,8 @@ async function testCorsAllowed() {
 			}
 		})
 		equal(res.status, 200)
-		equal(res.headers.get(CorsHeader.AccessControlAllowOrigin), 'http://example.com')
-		equal(res.headers.get(CorsHeader.AccessControlExposeHeaders), 'Content-Encoding')
+		equal(res.headers.get(CorsHeader.AcAllowOrigin), 'http://example.com')
+		equal(res.headers.get(CorsHeader.AcExposeHeaders), 'Content-Encoding')
 	})
 }
 

package/src/Watcher.js

@@ -7,25 +7,20 @@ import { isFile } from './utils/fs.js'
 import * as mockBrokerCollection from './mockBrokersCollection.js'
 
 
-let nAR_Events = 0 // AR = Add or Remove Mock
-
-export function countAR_Events() {
-	return nAR_Events
-}
-
-
-const emitter = new EventEmitter()
-
-export function subscribeAR_EventListener(callback) {
-	emitter.on('AR', callback)
-}
-export function unsubscribeAR_EventListener(callback) {
-	emitter.removeListener('AR', callback)
-}
-
-function emitAddOrRemoveMock() {
-	nAR_Events++
-	emitter.emit('AR')
+// AR = Add or Remove Mock
+export const arEvents = new class extends EventEmitter {
+	count = 0
+
+	emit() {
+		this.count++
+		super.emit('AR')
+	}
+	subscribe(listener) {
+		this.on('AR', listener)
+	}
+	unsubscribe(listener) {
+		this.removeListener('AR', listener)
+	}
 }
 
 export function watchMocksDir() {
@@ -35,11 +30,11 @@ export function watchMocksDir() {
 			return
 		if (isFile(join(dir, file))) {
 			if (mockBrokerCollection.registerMock(file, 'isFromWatcher'))
-				emitAddOrRemoveMock()
+				arEvents.emit()
 		}
 		else {
 			mockBrokerCollection.unregisterMock(file)
-			emitAddOrRemoveMock()
+			arEvents.emit()
 		}
 	})
 }

package/src/config.js

@@ -69,7 +69,8 @@ export function setup(options) {
 	})
 
 	config.mocksDir = realpathSync(config.mocksDir)
-	config.staticDir = realpathSync(config.staticDir)
+	if (config.staticDir)
+		config.staticDir = realpathSync(config.staticDir)
 }
 
 

package/src/utils/http-cors.js

@@ -18,16 +18,16 @@ export function validateCorsAllowedMethods(arr) {
 export const CorsHeader = {
 	// Request
 	Origin: 'origin',
-	AccessControlRequestMethod: 'access-control-request-method',
-	AccessControlRequestHeaders: 'access-control-request-headers', // Comma separated
+	AcRequestMethod: 'access-control-request-method',
+	AcRequestHeaders: 'access-control-request-headers', // Comma separated
 
 	// Response
-	AccessControlMaxAge: 'Access-Control-Max-Age',
-	AccessControlAllowOrigin: 'Access-Control-Allow-Origin', // '*' | Space delimited | null
-	AccessControlAllowMethods: 'Access-Control-Allow-Methods', // '*' | Comma delimited
-	AccessControlAllowHeaders: 'Access-Control-Allow-Headers', // '*' | Comma delimited 
-	AccessControlExposeHeaders: 'Access-Control-Expose-Headers', // '*' | Comma delimited (headers client-side JS can read)
-	AccessControlAllowCredentials: 'Access-Control-Allow-Credentials' // 'true'
+	AcMaxAge: 'Access-Control-Max-Age',
+	AcAllowOrigin: 'Access-Control-Allow-Origin', // '*' | Space delimited | null
+	AcAllowMethods: 'Access-Control-Allow-Methods', // '*' | Comma delimited
+	AcAllowHeaders: 'Access-Control-Allow-Headers', // '*' | Comma delimited 
+	AcExposeHeaders: 'Access-Control-Expose-Headers', // '*' | Comma delimited (headers client-side JS can read)
+	AcAllowCredentials: 'Access-Control-Allow-Credentials' // 'true'
 }
 const CH = CorsHeader
 
@@ -35,7 +35,7 @@ const CH = CorsHeader
 export function isPreflight(req) {
 	return req.method === 'OPTIONS'
 		&& URL.canParse(req.headers[CH.Origin])
-		&& methodIsSupported(req.headers[CH.AccessControlRequestMethod])
+		&& methodIsSupported(req.headers[CH.AcRequestMethod])
 }
 
 
@@ -51,23 +51,23 @@ export function setCorsHeaders(req, response, {
 	const hasWildcard = corsOrigins.some(ao => ao === '*')
 	if (!reqOrigin || (!hasWildcard && !corsOrigins.includes(reqOrigin)))
 		return
-	response.setHeader(CH.AccessControlAllowOrigin, reqOrigin) // Never '*', so no need to `Vary` it
+	response.setHeader(CH.AcAllowOrigin, reqOrigin) // Never '*', so no need to `Vary` it
 
 	if (corsCredentials)
-		response.setHeader(CH.AccessControlAllowCredentials, 'true')
+		response.setHeader(CH.AcAllowCredentials, 'true')
 
-	if (req.headers[CH.AccessControlRequestMethod])
+	if (req.headers[CH.AcRequestMethod])
 		setPreflightSpecificHeaders(req, response, corsMethods, corsHeaders, corsMaxAge)
 	else if (corsExposedHeaders.length)
-		response.setHeader(CH.AccessControlExposeHeaders, corsExposedHeaders.join(','))
+		response.setHeader(CH.AcExposeHeaders, corsExposedHeaders.join(','))
 }
 
 function setPreflightSpecificHeaders(req, response, methods, headers, maxAge) {
-	const methodAskingFor = req.headers[CH.AccessControlRequestMethod]
+	const methodAskingFor = req.headers[CH.AcRequestMethod]
 	if (!methods.includes(methodAskingFor))
 		return
-	response.setHeader(CH.AccessControlMaxAge, maxAge)
-	response.setHeader(CH.AccessControlAllowMethods, methodAskingFor)
+	response.setHeader(CH.AcMaxAge, maxAge)
+	response.setHeader(CH.AcAllowMethods, methodAskingFor)
 	if (headers.length)
-		response.setHeader(CH.AccessControlAllowHeaders, headers.join(','))
+		response.setHeader(CH.AcAllowHeaders, headers.join(','))
 }

package/src/utils/http-cors.test.js

@@ -41,7 +41,7 @@ await describe('CORS', async () => {
 	await describe('Identifies Preflight Requests', async () => {
 		const requiredRequestHeaders = {
 			[CH.Origin]: 'http://localhost:9999',
-			[CH.AccessControlRequestMethod]: 'POST'
+			[CH.AcRequestMethod]: 'POST'
 		}
 
 		await it('Ignores non-OPTIONS requests', async () => {
@@ -58,17 +58,17 @@ await describe('CORS', async () => {
 			equal(await res.text(), 'NON_PREFLIGHT')
 		})
 
-		await it(`Ignores missing method in ${CH.AccessControlRequestMethod} header`, async () => {
+		await it(`Ignores missing method in ${CH.AcRequestMethod} header`, async () => {
 			const headers = { ...requiredRequestHeaders }
-			delete headers[CH.AccessControlRequestMethod]
+			delete headers[CH.AcRequestMethod]
 			const res = await preflight(headers)
 			equal(await res.text(), 'NON_PREFLIGHT')
 		})
 
-		await it(`Ignores non-standard method in ${CH.AccessControlRequestMethod} header`, async () => {
+		await it(`Ignores non-standard method in ${CH.AcRequestMethod} header`, async () => {
 			const headers = {
 				...requiredRequestHeaders,
-				[CH.AccessControlRequestMethod]: 'NON_STANDARD'
+				[CH.AcRequestMethod]: 'NON_STANDARD'
 			}
 			const res = await preflight(headers)
 			equal(await res.text(), 'NON_PREFLIGHT')
@@ -88,13 +88,13 @@ await describe('CORS', async () => {
 			}
 			const p = await preflight({
 				[CH.Origin]: FooDotCom,
-				[CH.AccessControlRequestMethod]: 'GET'
+				[CH.AcRequestMethod]: 'GET'
 			})
-			headerIs(p, CH.AccessControlAllowOrigin, null)
-			headerIs(p, CH.AccessControlAllowMethods, null)
-			headerIs(p, CH.AccessControlAllowCredentials, null)
-			headerIs(p, CH.AccessControlAllowHeaders, null)
-			headerIs(p, CH.AccessControlMaxAge, null)
+			headerIs(p, CH.AcAllowOrigin, null)
+			headerIs(p, CH.AcAllowMethods, null)
+			headerIs(p, CH.AcAllowCredentials, null)
+			headerIs(p, CH.AcAllowHeaders, null)
+			headerIs(p, CH.AcMaxAge, null)
 		})
 
 		await it('not in allowed origins', async () => {
@@ -104,12 +104,12 @@ await describe('CORS', async () => {
 			}
 			const p = await preflight({
 				[CH.Origin]: NotAllowedDotCom,
-				[CH.AccessControlRequestMethod]: 'GET'
+				[CH.AcRequestMethod]: 'GET'
 			})
-			headerIs(p, CH.AccessControlAllowOrigin, null)
-			headerIs(p, CH.AccessControlAllowMethods, null)
-			headerIs(p, CH.AccessControlAllowCredentials, null)
-			headerIs(p, CH.AccessControlAllowHeaders, null)
+			headerIs(p, CH.AcAllowOrigin, null)
+			headerIs(p, CH.AcAllowMethods, null)
+			headerIs(p, CH.AcAllowCredentials, null)
+			headerIs(p, CH.AcAllowHeaders, null)
 		})
 
 		await it('origin and method match', async () => {
@@ -119,12 +119,12 @@ await describe('CORS', async () => {
 			}
 			const p = await preflight({
 				[CH.Origin]: AllowedDotCom,
-				[CH.AccessControlRequestMethod]: 'GET'
+				[CH.AcRequestMethod]: 'GET'
 			})
-			headerIs(p, CH.AccessControlAllowOrigin, AllowedDotCom)
-			headerIs(p, CH.AccessControlAllowMethods, 'GET')
-			headerIs(p, CH.AccessControlAllowCredentials, null)
-			headerIs(p, CH.AccessControlAllowHeaders, null)
+			headerIs(p, CH.AcAllowOrigin, AllowedDotCom)
+			headerIs(p, CH.AcAllowMethods, 'GET')
+			headerIs(p, CH.AcAllowCredentials, null)
+			headerIs(p, CH.AcAllowHeaders, null)
 		})
 
 		await it('origin matches from multiple', async () => {
@@ -134,12 +134,12 @@ await describe('CORS', async () => {
 			}
 			const p = await preflight({
 				[CH.Origin]: AllowedDotCom,
-				[CH.AccessControlRequestMethod]: 'GET'
+				[CH.AcRequestMethod]: 'GET'
 			})
-			headerIs(p, CH.AccessControlAllowOrigin, AllowedDotCom)
-			headerIs(p, CH.AccessControlAllowMethods, 'GET')
-			headerIs(p, CH.AccessControlAllowCredentials, null)
-			headerIs(p, CH.AccessControlAllowHeaders, null)
+			headerIs(p, CH.AcAllowOrigin, AllowedDotCom)
+			headerIs(p, CH.AcAllowMethods, 'GET')
+			headerIs(p, CH.AcAllowCredentials, null)
+			headerIs(p, CH.AcAllowHeaders, null)
 		})
 
 		await it('wildcard origin', async () => {
@@ -149,12 +149,12 @@ await describe('CORS', async () => {
 			}
 			const p = await preflight({
 				[CH.Origin]: FooDotCom,
-				[CH.AccessControlRequestMethod]: 'GET'
+				[CH.AcRequestMethod]: 'GET'
 			})
-			headerIs(p, CH.AccessControlAllowOrigin, FooDotCom)
-			headerIs(p, CH.AccessControlAllowMethods, 'GET')
-			headerIs(p, CH.AccessControlAllowCredentials, null)
-			headerIs(p, CH.AccessControlAllowHeaders, null)
+			headerIs(p, CH.AcAllowOrigin, FooDotCom)
+			headerIs(p, CH.AcAllowMethods, 'GET')
+			headerIs(p, CH.AcAllowCredentials, null)
+			headerIs(p, CH.AcAllowHeaders, null)
 		})
 
 		await it(`wildcard and credentials`, async () => {
@@ -165,12 +165,12 @@ await describe('CORS', async () => {
 			}
 			const p = await preflight({
 				[CH.Origin]: FooDotCom,
-				[CH.AccessControlRequestMethod]: 'GET'
+				[CH.AcRequestMethod]: 'GET'
 			})
-			headerIs(p, CH.AccessControlAllowOrigin, FooDotCom)
-			headerIs(p, CH.AccessControlAllowMethods, 'GET')
-			headerIs(p, CH.AccessControlAllowCredentials, 'true')
-			headerIs(p, CH.AccessControlAllowHeaders, null)
+			headerIs(p, CH.AcAllowOrigin, FooDotCom)
+			headerIs(p, CH.AcAllowMethods, 'GET')
+			headerIs(p, CH.AcAllowCredentials, 'true')
+			headerIs(p, CH.AcAllowHeaders, null)
 		})
 
 		await it(`wildcard, credentials, and headers`, async () => {
@@ -182,12 +182,12 @@ await describe('CORS', async () => {
 			}
 			const p = await preflight({
 				[CH.Origin]: FooDotCom,
-				[CH.AccessControlRequestMethod]: 'GET'
+				[CH.AcRequestMethod]: 'GET'
 			})
-			headerIs(p, CH.AccessControlAllowOrigin, FooDotCom)
-			headerIs(p, CH.AccessControlAllowMethods, 'GET')
-			headerIs(p, CH.AccessControlAllowCredentials, 'true')
-			headerIs(p, CH.AccessControlAllowHeaders, 'content-type,my-header')
+			headerIs(p, CH.AcAllowOrigin, FooDotCom)
+			headerIs(p, CH.AcAllowMethods, 'GET')
+			headerIs(p, CH.AcAllowCredentials, 'true')
+			headerIs(p, CH.AcAllowHeaders, 'content-type,my-header')
 		})
 	})
 
@@ -201,9 +201,9 @@ await describe('CORS', async () => {
 				[CH.Origin]: NotAllowedDotCom
 			})
 			equal(p.status, 200)
-			headerIs(p, CH.AccessControlAllowOrigin, null)
-			headerIs(p, CH.AccessControlAllowCredentials, null)
-			headerIs(p, CH.AccessControlExposeHeaders, null)
+			headerIs(p, CH.AcAllowOrigin, null)
+			headerIs(p, CH.AcAllowCredentials, null)
+			headerIs(p, CH.AcExposeHeaders, null)
 		})
 
 		await it('origin allowed', async () => {
@@ -217,9 +217,9 @@ await describe('CORS', async () => {
 				[CH.Origin]: AllowedDotCom
 			})
 			equal(p.status, 200)
-			headerIs(p, CH.AccessControlAllowOrigin, AllowedDotCom)
-			headerIs(p, CH.AccessControlAllowCredentials, 'true')
-			headerIs(p, CH.AccessControlExposeHeaders, 'x-h1,x-h2')
+			headerIs(p, CH.AcAllowOrigin, AllowedDotCom)
+			headerIs(p, CH.AcAllowCredentials, 'true')
+			headerIs(p, CH.AcExposeHeaders, 'x-h1,x-h2')
 		})
 	})
 })