mockaton 2.0.0 → 2.1.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`
 
@@ -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,6 +97,7 @@ 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
 }
 ```
 
@@ -127,10 +127,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

package/Tests.js

@@ -110,7 +110,8 @@ const server = Mockaton({
 	cookies: {
 		userA: 'CookieA',
 		userB: 'CookieB'
-	}
+	},
+	generate500: true
 })
 server.on('listening', runTests)
 

package/index.d.ts

@@ -7,10 +7,10 @@ interface Config {
 	port?: number
 	delay?: number
 	cookies?: object
-	database?: object
 	skipOpen?: boolean
 	proxyFallback?: string
 	allowedExt?: RegExp
+	generate500?: boolean
 }
 
 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.1.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/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,10 @@ 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
 }
 
 export function setup(options) {
@@ -24,10 +24,10 @@ 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)
 	})
 }
 

package/src/MockDispatcher.js

@@ -32,7 +32,6 @@ export async function dispatchMock(req, response) {
 		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())
 
@@ -44,8 +43,10 @@ export async function dispatchMock(req, response) {
 				? jsExport(req, response)
 				: JSON.stringify(jsExport)
 		}
-		else
+		else {
+			response.setHeader('content-type', mimeFor(file))
 			mockText = readMock(file)
+		}
 		setTimeout(() => response.end(mockText), delay)
 	}
 	catch (error) {

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.