mockaton 6.3.9 → 6.3.11

package/README.md

@@ -1,4 +1,4 @@
-# Mockaton 
+# Mockaton
 _Mockaton_ is a mock server for developing and testing frontends.
 
 It scans a given directory for files following a specific
@@ -30,9 +30,10 @@ Create a `my-mockaton.js` file
 import { resolve } from 'node:path'
 import { Mockaton } from 'mockaton'
 
+
 Mockaton({
-  mocksDir: resolve('my-mocks-dir'), 
-  port: 2345
+	mocksDir: resolve('my-mocks-dir'),
+	port: 2345
 })
 ```
 
@@ -43,21 +44,21 @@ node my-mockaton.js
 ## Config Options
 ```ts
 interface Config {
-  mocksDir: string
-  ignore?: RegExp // defaults to /(\.DS_Store|~)$/
-	
-  staticDir?: string
-	
-  host?: string, // defaults to 'localhost'
-  port?: number // defaults to 0, which means auto-assigned
-  proxyFallback?: string // e.g. http://localhost:9999 Target for relaying routes without mocks
-	
-  delay?: number // defaults to 1200 (ms)
-  cookies?: { [label: string]: string }
-  extraMimes?: { [fileExt: string]: string }
-  extraHeaders?: []
-	
-  onReady?: (dashboardUrl: string) => void // defaults to trying to open macOS default browser. pass a noop to prevent opening the dashboard
+	mocksDir: string
+	ignore?: RegExp // defaults to /(\.DS_Store|~)$/
+
+	staticDir?: string
+
+	host?: string, // defaults to 'localhost'
+	port?: number // defaults to 0, which means auto-assigned
+	proxyFallback?: string // e.g. http://localhost:9999 Target for relaying routes without mocks
+
+	delay?: number // defaults to 1200 (ms)
+	cookies?: { [label: string]: string }
+	extraMimes?: { [fileExt: string]: string }
+	extraHeaders?: []
+
+	onReady?: (dashboardUrl: string) => void // defaults to trying to open macOS default browser. pass a noop to prevent opening the dashboard
 }
 ```
 
@@ -65,9 +66,9 @@ interface Config {
 
 ## Mock Variants
 Each route can have many mocks, which could either be:
-- Different response __status code__. For example, for testing error responses. 
+- Different response __status code__. For example, for testing error responses.
 - __Comment__ on the filename, which is anything within parentheses.
-  - e.g. `api/user(my-comment).POST.201.json`
+	- e.g. `api/user(my-comment).POST.201.json`
 
 Those alternatives can be manually selected in the dashboard
 UI, or programmatically, for instance, for setting up tests.
@@ -80,7 +81,7 @@ An Object, Array, or String is sent as JSON.
 `api/foo.GET.200.js`
 ```js
 export default [
-  { id: 0 }
+	{ id: 0 }
 ]
 ```
 
@@ -94,10 +95,10 @@ database, or pull data from a backend. The `request` is of type
 `response` a [ServerResponse](https://nodejs.org/api/http.html#class-httpserverresponse).
 ```js
 export default function optionalName(request, response) {
-  globalThis.myDatabase ??= { count: 0 }
-  globalThis.myDatabase.count++
-	
-  return JSON.stringify({ a: 1 })
+	globalThis.myDatabase ??= { count: 0 }
+	globalThis.myDatabase.count++
+
+	return JSON.stringify({ a: 1 })
 }
 ```
 
@@ -107,7 +108,6 @@ export default function optionalName(request, response) {
 server for serving routes you don’t have mocks for.
 
 
-
 ## Delay 🕓
 The clock icon next to the mock selector is a checkbox for delaying a
 particular response. They are handy for testing spinners.
@@ -115,7 +115,6 @@ particular response. They are handy for testing spinners.
 The delay is globally configurable via `Config.delay = 1200` (milliseconds).
 
 
-
 ## File Name Convention
 
 
@@ -167,7 +166,6 @@ api/foo/.GET.200.json
 ```
 
 
-
 ## `Config.cookies`
 The selected cookie is sent in every response in the `Set-Cookie` header.
 
@@ -181,13 +179,14 @@ words, it’s useful if you only care about its payload.
 ```js
 import { jwtCookie } from 'mockaton'
 
+
 Config.cookies = {
-  'My Admin User':  'my-cookie=1;Path=/;SameSite=strict',
-  'My Normal User': 'my-cookie=0;Path=/;SameSite=strict',
-  'My JWT': jwtCookie('my-cookie', {
-    email: 'john.doe@example.com',
-    picture: 'https://cdn.auth0.com/avatars/jd.png'
-  })
+	'My Admin User': 'my-cookie=1;Path=/;SameSite=strict',
+	'My Normal User': 'my-cookie=0;Path=/;SameSite=strict',
+	'My JWT': jwtCookie('my-cookie', {
+		email: 'john.doe@example.com',
+		picture: 'https://cdn.auth0.com/avatars/jd.png'
+	})
 }
 ```
 
@@ -198,16 +197,16 @@ that it's an array and the header name goes in even indices.
 
 ```js
 Config.extraHeaders = [
-  'Server', 'Mockaton',
-  'Set-Cookie', 'foo=FOO;Path=/;SameSite=strict',
-  'Set-Cookie', 'bar=BAR;Path=/;SameSite=strict'
+	'Server', 'Mockaton',
+	'Set-Cookie', 'foo=FOO;Path=/;SameSite=strict',
+	'Set-Cookie', 'bar=BAR;Path=/;SameSite=strict'
 ]
 ```
 
 ## `Config.extraMimes`
 ```js
 Config.extraMimes = {
-  jpg: 'application/jpeg'
+	jpg: 'application/jpeg'
 }
 ```
 
@@ -218,49 +217,51 @@ Config.extraMimes = {
 ### Select a mock for a route
 ```js
 fetch(addr + '/mockaton/edit', {
-  method: 'PATCH',
-  body: JSON.stringify({
-    file: 'api/foo.200.GET.json',
-    delayed: true // optional
-  })
+	method: 'PATCH',
+	body: JSON.stringify({
+		file: 'api/foo.200.GET.json',
+		delayed: true // optional
+	})
 })
 ```
 
 ### Select all mocks that have a particular comment
 ```js
 fetch(addr + '/mockaton/bulk-select-by-comment', {
-  method: 'PATCH',
-  body: JSON.stringify('(demo-a)')
+	method: 'PATCH',
+	body: JSON.stringify('(demo-a)')
 })
 ```
 
-### Reset
-Re-Initialize the collection and its states (selected mocks and cookies, delays, etc.).
+### List Cookies
+Sends a list of the available cookies along with an "is selected" boolean flag.
 ```js
-fetch(addr + '/mockaton/reset', {
-  method: 'PATCH'
-})
+fetch(addr + '/mockaton/cookies')
 ```
 
 ### Select a cookie
 In `Config.cookies`, each key is the label used for changing it.
 ```js
 fetch(addr + '/mockaton/cookies', {
-  method: 'PATCH',
-  body: JSON.stringify('My Normal User')
+	method: 'PATCH',
+	body: JSON.stringify('My Normal User')
 })
 ```
 
-### List Cookies
-Sends a list of the available cookies along with a flag indicated if it’s the selected.
+### Update Fallback Proxy
 ```js
-fetch(addr + '/mockaton/cookies')
+fetch(addr + '/mockaton/fallback', {
+	method: 'PATCH',
+	body: JSON.stringify('http://example.com')
+})
 ```
 
-### Update Fallback Proxy
+### Reset
+Re-initialize the collection. So if you added or removed mocks they
+will be considered. The selected mocks, cookies, and delays are
+back to default. But the `Config.proxyFalllback` is not affected.
 ```js
-fetch(addr + '/mockaton/fallback', {
-  method: 'PATCH',
-  body: JSON.stringify('http://example.com')
+fetch(addr + '/mockaton/reset', {
+	method: 'PATCH'
 })
 ```

package/Tests.js

@@ -17,6 +17,7 @@ import { API, DF, DEFAULT_500_COMMENT } from './src/ApiConstants.js'
 
 const tmpDir = mkdtempSync(tmpdir()) + '/'
 const staticTmpDir = mkdtempSync(tmpdir()) + '/'
+console.log(tmpDir)
 
 const fixtureCustomMime = [
 	'/api/custom-mime',
@@ -28,7 +29,7 @@ const fixtures = [
 	[
 		'/api',
 		'api/.GET.200.json',
-		'index-like route is just the extension convention'
+		'index-like route for /api, which could just be the extension convention'
 	],
 
 	// Exact route paths
@@ -149,6 +150,8 @@ async function runTests() {
 		'api/alternative(comment-2).GET.200.json',
 		JSON.stringify({ comment: 2 }))
 
+	await test422WhenUpdatingNonExistingMockAlternative()
+
 	await testAutogenerates500(
 		'/api/alternative',
 		`api/alternative${DEFAULT_500_COMMENT}.GET.500.txt`)
@@ -265,6 +268,15 @@ async function testItUpdatesDelayAndFile(url, file, expectedBody) {
 	})
 }
 
+async function test422WhenUpdatingNonExistingMockAlternative() {
+	await it('There are mocks for /api/the-route but not this one', async () => {
+		const res = await request(API.edit, {
+			method: 'PATCH',
+			body: JSON.stringify({ [DF.file]: 'api/the-route(non-existing-variant).GET.200.json' })
+		})
+		equal(res.status, 422)
+	})
+}
 
 async function testAutogenerates500(url, file) {
 	await request(API.edit, {
@@ -380,12 +392,12 @@ async function testInvalidFilenamesAreIgnored() {
 		consoleErrorSpy.mock.mockImplementation(() => {}) // so they don’t render in the test report
 
 		write('api/_INVALID_FILENAME_CONVENTION_.json', '')
-		write('api/bad-filename.GET._INVALID_STATUS_.json', '')
-		write('api/bad-filename._INVALID_METHOD_.200.json', '')
+		write('api/bad-filename-method._INVALID_METHOD_.200.json', '')
+		write('api/bad-filename-status.GET._INVALID_STATUS_.json', '')
 		await reset()
 		equal(consoleErrorSpy.mock.calls[0].arguments[0], 'Invalid Filename Convention')
-		equal(consoleErrorSpy.mock.calls[1].arguments[0], 'Invalid HTTP Response Status: "NaN"')
-		equal(consoleErrorSpy.mock.calls[2].arguments[0], 'Unrecognized HTTP Method: "_INVALID_METHOD_"')
+		equal(consoleErrorSpy.mock.calls[1].arguments[0], 'Unrecognized HTTP Method: "_INVALID_METHOD_"')
+		equal(consoleErrorSpy.mock.calls[2].arguments[0], 'Invalid HTTP Response Status: "NaN"')
 	})
 }
 

package/package.json

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

package/src/Api.js

@@ -57,14 +57,15 @@ async function selectCookie(req, response) {
 async function updateBroker(req, response) {
 	try {
 		const body = await parseJSON(req)
-		const broker = mockBrokersCollection.getBrokerByFilename(body[DF.file])
-		if (!broker) {
+		const file = body[DF.file]
+		const broker = mockBrokersCollection.getBrokerByFilename(file)
+		if (!broker || !broker.mockExists(file)) {
 			sendUnprocessableContent(response)
 			return
 		}
 		if (DF.delayed in body)
 			broker.updateDelay(body[DF.delayed])
-		broker.updateFile(body[DF.file])
+		broker.updateFile(file)
 		sendOK(response)
 	}
 	catch (error) {

package/src/Filename.js

@@ -14,7 +14,14 @@ export const includesComment = (filename, search) =>
 	extractComments(filename).some(comment => comment.includes(search))
 
 
-export function validateFilename(file) {
+export function filenameIsValid(file) {
+	const error = validateFilename(file)
+	if (error)
+		console.error(error, file)
+	return !error
+}
+
+function validateFilename(file) {
 	const tokens = file.replace(reComments, '').split('.')
 	if (tokens.length < 4)
 		return 'Invalid Filename Convention'

package/src/MockBroker.js

@@ -41,7 +41,10 @@ export class MockBroker {
 	get file() { return this.currentMock.file }
 	get delay() { return this.currentMock.delay }
 	get status() { return parseFilename(this.file).status }
-	get isTemp500() { return includesComment(this.file, DEFAULT_500_COMMENT) }
+
+	mockExists(file) {
+		return this.mocks.includes(file)
+	}
 
 	updateFile(filename) {
 		this.currentMock.file = filename
@@ -78,6 +81,9 @@ export class MockBroker {
 		const file = urlMask.replace(/^\//, '') // Removes leading slash TESTME
 		this.register(`${file}${DEFAULT_500_COMMENT}.${method}.500.txt`)
 	}
+	get isTemp500() {
+		return includesComment(this.file, DEFAULT_500_COMMENT)
+	}
 }
 
 // Stars out (for regex) all the paths that are in square brackets

package/src/mockBrokersCollection.js

@@ -1,11 +1,8 @@
-import { join } from 'node:path'
-import { readdirSync as readDir } from 'node:fs'
-
 import { Config } from './Config.js'
 import { cookie } from './cookie.js'
-import { isFile } from './utils/fs.js'
 import { MockBroker } from './MockBroker.js'
-import { parseFilename, validateFilename } from './Filename.js'
+import { listFilesRecursively } from './utils/fs.js'
+import { parseFilename, filenameIsValid } from './Filename.js'
 
 
 /**
@@ -24,16 +21,11 @@ export function init() {
 	collection = {}
 	cookie.init(Config.cookies)
 
-	const files = readDir(Config.mocksDir, { recursive: true })
-		.filter(f => !Config.ignore.test(f) && isFile(join(Config.mocksDir, f)))
+	const files = listFilesRecursively(Config.mocksDir)
 		.sort()
+		.filter(f => !Config.ignore.test(f) && filenameIsValid(f))
 
 	for (const file of files) {
-		const error = validateFilename(file)
-		if (error) {
-			console.error(error, file)
-			continue
-		}
 		const { method, urlMask } = parseFilename(file)
 		collection[method] ??= {}
 		if (!collection[method][urlMask])
@@ -45,10 +37,6 @@ export function init() {
 	forEachBroker(broker => broker.ensureItHas500())
 }
 
-function forEachBroker(fn) {
-	for (const brokers of Object.values(collection))
-		Object.values(brokers).forEach(fn)
-}
 
 export const getAll = () => collection
 
@@ -75,8 +63,8 @@ export function getBrokerForUrl(method, url) {
 export function extractAllComments() {
 	const comments = new Set()
 	forEachBroker(broker => {
-		for (const comment of broker.extractComments())
-			comments.add(comment)
+		for (const c of broker.extractComments())
+			comments.add(c)
 	})
 	return Array.from(comments)
 }
@@ -86,3 +74,8 @@ export function setMocksMatchingComment(comment) {
 }
 
 
+function forEachBroker(fn) {
+	for (const brokers of Object.values(collection))
+		Object.values(brokers).forEach(fn)
+}
+

package/src/utils/fs.js

@@ -1,7 +1,12 @@
-import { lstatSync, readFileSync } from 'node:fs'
+import { join } from 'node:path'
+import { lstatSync, readFileSync, readdirSync } from 'node:fs'
 
 
 export const isFile = path => lstatSync(path, { throwIfNoEntry: false })?.isFile()
 export const isDirectory = path => lstatSync(path, { throwIfNoEntry: false })?.isDirectory()
 
 export const read = path => readFileSync(path)
+
+/** @returns {Array<string>} paths relative to `dir` */
+export const listFilesRecursively = dir => readdirSync(dir, { recursive: true })
+	.filter(f => isFile(join(dir, f)))