mockaton 6.3.12 → 6.4.0

package/.editorconfig

@@ -6,3 +6,6 @@ end_of_line = lf
 indent_size = 2
 indent_style = tab
 insert_final_newline = true
+
+[*.md]
+indent_style = space

package/README.md

@@ -32,8 +32,8 @@ import { Mockaton } from 'mockaton'
 
 
 Mockaton({
-	mocksDir: resolve('my-mocks-dir'),
-	port: 2345
+  mocksDir: resolve('my-mocks-dir'),
+  port: 2345
 })
 ```
 
@@ -44,21 +44,21 @@ node my-mockaton.js
 ## Config Options
 ```ts
 interface Config {
-	mocksDir: string
-	ignore?: RegExp // defaults to /(\.DS_Store|~)$/
+  mocksDir: string
+  ignore?: RegExp // defaults to /(\.DS_Store|~)$/
 
-	staticDir?: string
+  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
+  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?: []
+  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
+  onReady?: (dashboardUrl: string) => void // defaults to trying to open macOS default browser. pass a noop to prevent opening the dashboard
 }
 ```
 
@@ -68,12 +68,21 @@ interface Config {
 Each route can have many mocks, which could either be:
 - 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.
 
-The first file in **alphabetical order** becomes the default mock.
+### Default Mock for a Route
+You can add the comment: `(default)` to a filename.
+Otherwise, the first file in **alphabetical order** wins.
+
+```
+api/user(some comment).GET.200.json
+api/user(default).GET.200.json
+```
+
+---
 
 ## You can write JSON mocks in JavaScript
 An Object, Array, or String is sent as JSON.
@@ -81,7 +90,7 @@ An Object, Array, or String is sent as JSON.
 `api/foo.GET.200.js`
 ```js
 export default [
-	{ id: 0 }
+  { id: 0 }
 ]
 ```
 
@@ -95,10 +104,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++
+  globalThis.myDatabase ??= { count: 0 }
+  globalThis.myDatabase.count++
 
-	return JSON.stringify({ a: 1 })
+  return JSON.stringify({ a: 1 })
 }
 ```
 
@@ -150,7 +159,7 @@ permitted](https://learn.microsoft.com/en-us/windows/win32/fileio/naming-a-file)
 but since that’s part of the query string, it’s ignored anyway.
 
 
-### Default (index-like) route
+### Index-like route
 For instance, let's say you have `api/foo/bar`, and
 `api/foo`. For the latter you have two options:
 
@@ -181,12 +190,12 @@ 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'
+  })
 }
 ```
 
@@ -197,16 +206,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'
 }
 ```
 
@@ -217,19 +226,19 @@ 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)')
 })
 ```
 
@@ -243,16 +252,16 @@ fetch(addr + '/mockaton/cookies')
 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')
 })
 ```
 
 ### Update Fallback Proxy
 ```js
 fetch(addr + '/mockaton/fallback', {
-	method: 'PATCH',
-	body: JSON.stringify('http://example.com')
+  method: 'PATCH',
+  body: JSON.stringify('http://example.com')
 })
 ```
 
@@ -262,6 +271,6 @@ will be considered. The selected mocks, cookies, and delays are
 back to default. But the `Config.proxyFalllback` is not affected.
 ```js
 fetch(addr + '/mockaton/reset', {
-	method: 'PATCH'
+  method: 'PATCH'
 })
 ```

package/Tests.js

@@ -12,7 +12,7 @@ import { Config } from './src/Config.js'
 import { mimeFor } from './src/utils/mime.js'
 import { Mockaton } from './src/Mockaton.js'
 import { parseFilename } from './src/Filename.js'
-import { API, DF, DEFAULT_500_COMMENT } from './src/ApiConstants.js'
+import { API, DF, DEFAULT_500_COMMENT, DEFAULT_MOCK_COMMENT } from './src/ApiConstants.js'
 
 
 const tmpDir = mkdtempSync(tmpdir()) + '/'
@@ -25,6 +25,17 @@ const fixtureCustomMime = [
 	'Custom Extension and MIME'
 ]
 
+const fixtureNonDefaultInName = [
+	'/api/the-route',
+	'api/the-route(default).GET.200.json',
+	'default my route body content'
+]
+const fixtureDefaultInName = [
+	'/api/the-route',
+	'api/the-route(default).GET.200.json',
+	'default my route body content'
+]
+
 const fixtures = [
 	[
 		'/api',
@@ -33,11 +44,13 @@ const fixtures = [
 	],
 
 	// Exact route paths
+	fixtureDefaultInName,
 	[
 		'/api/the-route',
-		'api/the-route(comment-1).GET.200.json',
-		'my route body content'
-	], [
+		'api/the-route(default).GET.200.json',
+		'default my route body content'
+	],
+	[
 		'/api/the-mime',
 		'api/the-mime.GET.200.txt',
 		'determines the content type'
@@ -107,7 +120,7 @@ const fixtures = [
 	],
 	fixtureCustomMime
 ]
-for (const [, file, body] of fixtures)
+for (const [, file, body] of [fixtureNonDefaultInName, ...fixtures])
 	write(file, file.endsWith('.json') ? JSON.stringify(body) : body)
 
 write('api/.GET.500.txt', 'keeps non-autogenerated 500')
@@ -145,6 +158,8 @@ async function runTests() {
 	for (const [url, file, body] of fixtures)
 		await testMockDispatching(url, file, body)
 
+	await testDefaultMock()
+
 	await testItUpdatesDelayAndFile(
 		'/api/alternative',
 		'api/alternative(comment-2).GET.200.json',
@@ -174,7 +189,8 @@ async function runTests() {
 		'(comment-2)',
 		DEFAULT_500_COMMENT,
 		'(this is the actual comment)',
-		'(another comment)'
+		'(another comment)',
+		DEFAULT_MOCK_COMMENT
 	])
 	await testItBulkSelectsByComment('(comment-2)', [
 		['/api/alternative', 'api/alternative(comment-2).GET.200.json', { comment: 2 }],
@@ -238,6 +254,10 @@ async function testMockDispatching(url, file, expectedBody, forcedMime = undefin
 	})
 }
 
+async function testDefaultMock() {
+	await testMockDispatching(...fixtureDefaultInName)
+}
+
 async function testItUpdatesTheCurrentSelectedMock(url, file, expectedStatus, expectedBody) {
 	await request(API.edit, {
 		method: 'PATCH',

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.12",
+	"version": "6.4.0",
 	"main": "index.js",
 	"types": "index.d.ts",
 	"license": "MIT",

package/src/Api.js

@@ -1,6 +1,6 @@
 /**
- * API for controlling the mock server. For example,
- * setting a specific mock-file for a particular route.
+ * API for controlling Mockaton. For example, for
+ * selecting a specific mock-file for a particular route.
  */
 
 import { join } from 'node:path'
@@ -60,7 +60,7 @@ async function updateBroker(req, response) {
 		const file = body[DF.file]
 		const broker = mockBrokersCollection.getBrokerByFilename(file)
 		if (!broker || !broker.mockExists(file)) {
-			sendUnprocessableContent(response, `Missing Mock: "${file}`)
+			sendUnprocessableContent(response, `Missing Mock: ${file}`)
 			return
 		}
 		if (DF.delayed in body)

package/src/ApiConstants.js

@@ -16,3 +16,4 @@ export const DF = { // Dashboard Fields (XHR)
 }
 
 export const DEFAULT_500_COMMENT = '(Mockaton Temp 500)'
+export const DEFAULT_MOCK_COMMENT = '(default)'

package/src/MockBroker.js

@@ -1,5 +1,5 @@
 import { Config } from './Config.js'
-import { DEFAULT_500_COMMENT } from './ApiConstants.js'
+import { DEFAULT_500_COMMENT, DEFAULT_MOCK_COMMENT } from './ApiConstants.js'
 import { includesComment, extractComments, parseFilename } from './Filename.js'
 
 
@@ -22,8 +22,6 @@ export class MockBroker {
 	}
 
 	register(file) {
-		if (!this.mocks.length)
-			this.currentMock.file = file // The first mock file option for a particular route becomes the default
 		this.mocks.push(file)
 	}
 
@@ -42,6 +40,15 @@ export class MockBroker {
 	get delay() { return this.currentMock.delay }
 	get status() { return parseFilename(this.file).status }
 
+	selectDefaultFile() {
+		this.updateFile(this.#findMockWithDefaultComment() || this.mocks[0])
+	}
+	#findMockWithDefaultComment() {
+		for (const f of this.mocks)
+			if (includesComment(f, DEFAULT_MOCK_COMMENT))
+				return f
+	}
+
 	mockExists(file) {
 		return this.mocks.includes(file)
 	}

package/src/mockBrokersCollection.js

@@ -34,7 +34,10 @@ export function init() {
 			collection[method][urlMask].register(file)
 	}
 
-	forEachBroker(broker => broker.ensureItHas500())
+	forEachBroker(broker => {
+		broker.selectDefaultFile()
+		broker.ensureItHas500()
+	})
 }