mockaton 2.0.0 → 2.2.0

package/README.md

@@ -16,8 +16,7 @@ be used for downloading a TAR of your XHR requests following that convention.
 ### Mock Variants
 Each route can have many mocks, which could either be:
 - Different response __status code__. 
-  - e.g. for testing error responses. As a side note, an _Internal Server
-    Error_ mock is autogenerated for routes that have no 500.
+  - e.g. for testing error responses. 
 - __Comment__ on the filename, which is anything within parentheses.
   - e.g. `api/user(my-comment).POST.201.json`
 
@@ -29,7 +28,7 @@ The first file in **alphabetical order** becomes the default mock.
 ### Optionally, you can write mocks in JavaScript
 An Object, Array, or String is sent as JSON.
 
-`api/user/likes.GET.200.js`
+`api/foo.GET.200.js`
 ```js
 export default [
   { id: 0 }
@@ -56,7 +55,7 @@ The best way to learn _Mockaton_ is by checking out this repo and
 exploring its [sample-mocks/](./sample-mocks) directory. Then, run
 [`./_usage_example.js`](./_usage_example.js) and you’ll see this dashboard:
 
-![](./README-dashboard.png)
+<img src="./README-dashboard.png" style="max-width:890px"/>
 
 
 ## Delay 🕓
@@ -98,27 +97,10 @@ interface Config {
   skipOpen?: boolean // Prevents opening the dashboard in a browser
   proxyFallback?: string // e.g. http://localhost:9999 Target for relaying routes without mocks
   allowedExt?: RegExp // /\.(json|txt|md|js)$/ Just for excluding temporary editor files (e.g. JetBrains appends a ~)
+  generate500?: boolean // autogenerates an Internal Server Error empty mock for routes that have no 500
+  extraHeaders?: []
 }
 ```
-
-## Cookies
-```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'
-  })
-}
-```
-The key is just a label used for selecting a particular cookie in the dashboard.
-
-`jwtCookie` has a hardcoded header and signature. In other
-words, it’s useful if you only care about its payload.
-
 ---
 
 ## File Name Convention
@@ -127,10 +109,9 @@ words, it’s useful if you only care about its payload.
 ### Extension
 `.Method.HttpResponseStatusCode.FileExt`
 
-The **file extension** can anything, but `.md` and `.mjs` are reserved
-for documentation, and mock processors (more on that later).
+The **file extension** can be anything, but `.md` is reserved for documentation.
 
-The `Config.allowedExt` regex defaults to: `/\.(json|txt|md|mjs)$/`
+The `Config.allowedExt` regex defaults to: `/\.(json|txt|md|js)$/`
 
 
 ### Dynamic Parameters
@@ -172,6 +153,40 @@ api/foo/?bar=[bar].GET.200.json
 api/foo/(my comment).GET.200.json
 ```
 
+
+## `Config.cookies`
+The selected cookie is sent in every response in the `Set-Cookie` header.
+```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'
+  })
+}
+```
+The key is just a label used for selecting a particular cookie in the dashboard.
+
+`jwtCookie` has a hardcoded header and signature. In other
+words, it’s useful if you only care about its payload.
+
+
+## `Config.extraHeaders`
+They are applied last, right before ending the response. In
+other words, they can overwrite the `Content-Type`. They are
+not tuples, the header name goes in even-numbered indices.
+
+```js
+Config.extraHeaders = [
+  'Server', 'Mockaton',
+  'Set-Cookie', 'another-cookie=FOO;Path=/;SameSite=strict',
+  'Set-Cookie', 'another-cookie=BAR;Path=/;SameSite=strict'
+]
+```
+
 ## Documenting Contracts (.md)
 This is handy for documenting request payload parameters. The dashboard will
 print the Markdown document (as plain text) above the actual payload content.

package/Tests.js

@@ -110,7 +110,9 @@ const server = Mockaton({
 	cookies: {
 		userA: 'CookieA',
 		userB: 'CookieB'
-	}
+	},
+	generate500: true,
+	extraHeaders: ['Server', 'MockatonTester']
 })
 server.on('listening', runTests)
 
@@ -157,7 +159,7 @@ async function runTests() {
 	await reset()
 	for (const [url, file, body] of fixtures)
 		await testMockDispatching(url, file, body)
-	
+
 	await testMockDispatching('/api/object', 'api/object.GET.200.js', { JSON_FROM_JS: true }, mimeFor('.json'))
 	await testJsFunctionMocks()
 
@@ -204,6 +206,7 @@ async function testMockDispatching(url, file, expectedBody, forcedMime = void 0)
 		it('status: ' + status, () => equal(res.status, status))
 		it('cookie: ' + mime, () => equal(res.headers.get('set-cookie'), 'CookieA'))
 		it('delay is under 1 sec', () => equal((new Date()).getTime() - now.getTime() < 1000, true))
+		it('extra header', () => equal(res.headers.get('server'), 'MockatonTester'))
 	})
 }
 

package/index.d.ts

@@ -7,10 +7,11 @@ interface Config {
 	port?: number
 	delay?: number
 	cookies?: object
-	database?: object
 	skipOpen?: boolean
 	proxyFallback?: string
 	allowedExt?: RegExp
+	generate500?: boolean,
+	extraHeaders?: [string, string][] 
 }
 
 export function Mockaton(options: Config): Server

package/package.json

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

package/sample-mocks/api/user/friends.GET.500.txt

@@ -0,0 +1,7 @@
+This is a plain text response for (/api/friends). 
+
+In this case, it’s for mocking up a 500 - Internal Server Error.
+
+This file could have been empty, or some JSON if it had a `.json` extension.
+
+By the way, on initialization an 500 is auto-generated for routes that don’t have a 500.

package/sample-mocks/api/user/likes.GET.200.js

@@ -1,7 +1,9 @@
-// You can write JSON responses in JavaScript.
+// You can write JSON responses in JavaScript. 
+// You can export an: Object, Array, or String
 
 export default [
 	{ id: 0 },
 	{ id: 1 },
 	{ id: 2 },
 ]
+

package/sample-mocks/api/user/links.GET.200.js

@@ -0,0 +1,8 @@
+// You can write JSON responses in JavaScript as a function.
+// Must return a String and they should NOT call `response.end()`
+
+export default function (req, response) {
+	return JSON.stringify([
+		{ id: 0 }
+	])
+}

package/src/Api.js

@@ -60,7 +60,6 @@ async function selectCookie(req, response) {
 }
 
 function reinitialize(_, response) {
-	Config.database = {}
 	mockBrokersCollection.init()
 	sendOK(response)
 }

package/src/Config.js

@@ -9,10 +9,11 @@ export const Config = {
 	port: 0, // auto-assigned
 	delay: 1200, // milliseconds
 	cookies: {}, // defaults to the first kv
-	database: {},
 	skipOpen: false,
 	proxyFallback: '', // e.g. http://localhost:9999
-	allowedExt: /\.(json|txt|md|js)$/ // Just for excluding temporary editor files (e.g. JetBrains appends a ~)
+	allowedExt: /\.(json|txt|md|js)$/, // Just for excluding temporary editor files (e.g. JetBrains appends a ~)
+	generate500: false,
+	extraHeaders: []
 }
 
 export function setup(options) {
@@ -24,10 +25,11 @@ export function setup(options) {
 		port: port => Number.isInteger(port) && port >= 0 && port < 2 ** 16,
 		delay: ms => Number.isInteger(ms) && ms > 0,
 		cookies: is(Object),
-		database: is(Object),
 		skipOpen: is(Boolean),
 		proxyFallback: is(String),
-		allowedExt: is(RegExp)
+		allowedExt: is(RegExp),
+		generate500: is(Boolean),
+		extraHeaders: Array.isArray
 	})
 }
 

package/src/MockDispatcher.js

@@ -31,11 +31,6 @@ export async function dispatchMock(req, response) {
 		const { file, status, delay } = broker
 		console.log('\n', req.url, '→\n ', file)
 
-		response.statusCode = status
-		response.setHeader('content-type', mimeFor(file))
-		if (cookie.getCurrent())
-			response.setHeader('set-cookie', cookie.getCurrent())
-
 		let mockText
 		if (file.endsWith('.js')) {
 			response.setHeader('content-type', mimeFor('.json'))
@@ -44,8 +39,15 @@ export async function dispatchMock(req, response) {
 				? jsExport(req, response)
 				: JSON.stringify(jsExport)
 		}
-		else
+		else {
+			response.setHeader('content-type', mimeFor(file))
 			mockText = readMock(file)
+		}
+		
+		if (cookie.getCurrent())
+			response.setHeader('set-cookie', cookie.getCurrent())
+		
+		response.writeHead(status, Config.extraHeaders)
 		setTimeout(() => response.end(mockText), delay)
 	}
 	catch (error) {

package/src/Mockaton.js

@@ -14,6 +14,8 @@ export function Mockaton(options) {
 	mockBrokerCollection.init()
 
 	return createServer(async (req, response) => {
+		response.setHeader('Server', 'Mockaton')
+
 		const { url, method } = req
 		if (method === 'GET' && apiGetRequests.has(url))
 			apiGetRequests.get(url)(req, response)

package/src/mockBrokersCollection.js

@@ -39,7 +39,9 @@ export function init() {
 		else
 			collection[method][urlMask].register(file)
 	}
-	forEachBroker(broker => broker.ensureItHas500())
+
+	if (Config.generate500)
+		forEachBroker(broker => broker.ensureItHas500())
 }
 
 function forEachBroker(fn) {

package/sample-mocks/api/user/.GET.500.txt

@@ -1,7 +0,0 @@
-This is a plain text response for (/api/user). 
-
-In this case, it’s for mocking up a 500 - Internal Server Error.
-
-This file could have been empty, or some JSON if it had a `.json` extension.
-
-By the way, on initialization an 500 is auto-generated for routes that don’t have a 500.

package/sample-mocks/api/user/loves.GET.200.js

@@ -1,7 +0,0 @@
-// You can write JSON responses in JavaScript.
-
-export default function (req, response) {
-	return JSON.stringify([
-		{ id: 0 }
-	])
-}