mockaton 2.3.0 → 2.3.1

package/README.md

@@ -1,7 +1,7 @@
 # Mockaton 
 _Mockaton_ is a mock server for developing and testing frontends.
 
-It scans `Config.mocksDir` for files following a specific
+It scans a given directory for files following a specific
 file name convention, which is similar to the URL paths. For
 example, the following file will be served for `/api/user/1234`
 ```
@@ -13,60 +13,16 @@ extension](https://github.com/ericfortis/devtools-ext-tar-http-requests) can
 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. 
-- __Comment__ on the filename, which is anything within parentheses.
-  - 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.
-
-### Optionally, you can write mocks in JavaScript
-An Object, Array, or String is sent as JSON.
-
-`api/foo.GET.200.js`
-```js
-export default [
-  { id: 0 }
-]
-```
-
-Or, export default a function. There, you
-can override the response status and the default JSON content
-type. But don’t call `response.end()`, just return a string.
-```js
-export default function (req, response) {
-  return JSON.stringify({ a: 1 })
-}
-```
-
-
-### Proxying Routes
-`Config.proxyFallback` lets you specify a target
-server for serving routes you don’t have mocks for.
-
-
 ## Getting Started
 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:
 
-<img src="./README-dashboard.png" style="max-width:890px"/>
-
-
-## Delay 🕓
-The clock icon next to the mock selector is a checkbox for delaying a
-particular response. They are handy for testing spinners.
 
-The delay is globally configurable via `Config.delay = 1200` (milliseconds).
+<img src="./README-dashboard.png" style="max-width:820px"/>
 
----
 
-## Basic Usage (see [_usage_example.js](./_usage_example.js))
+## Basic Usage
 ```
 npm install mockaton
 ```
@@ -101,8 +57,54 @@ interface Config {
   extraHeaders?: []
 }
 ```
+
 ---
 
+## Mock Variants
+Each route can have many mocks, which could either be:
+- Different response __status code__. 
+  - e.g. for testing error responses. 
+- __Comment__ on the filename, which is anything within parentheses.
+  - 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.
+
+## You can write JSON mocks in JavaScript
+An Object, Array, or String is sent as JSON.
+
+`api/foo.GET.200.js`
+```js
+export default [
+  { id: 0 }
+]
+```
+
+Or, export default a function. There, you
+can override the response status and the default JSON content
+type. But don’t call `response.end()`, just return a string.
+```js
+export default function (req, response) {
+  return JSON.stringify({ a: 1 })
+}
+```
+
+
+## Proxying Routes
+`Config.proxyFallback` lets you specify a target
+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.
+
+The delay is globally configurable via `Config.delay = 1200` (milliseconds).
+
+
 ## File Name Convention
 
 

package/package.json

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

package/src/Api.js

@@ -9,7 +9,7 @@ import { Config } from './Config.js'
 import { DF, API } from './ApiConstants.js'
 import { parseJSON } from './utils/http-request.js'
 import * as mockBrokersCollection from './mockBrokersCollection.js'
-import { sendOK, sendBadRequest, sendJSON, sendFile } from './utils/http-response.js'
+import { sendOK, sendBadRequest, sendJSON, sendFile, sendUnprocessableContent } from './utils/http-response.js'
 
 
 export const apiGetRequests = new Map([
@@ -24,11 +24,11 @@ export const apiGetRequests = new Map([
 ])
 
 export const apiPatchRequests = new Map([
-	[API.bulkSelect, bulkUpdateBrokersByCommentTag],
 	[API.edit, updateBroker],
 	[API.reset, reinitialize],
 	[API.cookies, selectCookie],
-	[API.fallback, updateProxyFallback]
+	[API.fallback, updateProxyFallback],
+	[API.bulkSelect, bulkUpdateBrokersByCommentTag]
 ])
 
 function serveDashboard(_, response) {
@@ -48,6 +48,11 @@ function listMockBrokers(_, response) {
 }
 
 
+function reinitialize(_, response) {
+	mockBrokersCollection.init()
+	sendOK(response)
+}
+
 async function selectCookie(req, response) {
 	try {
 		cookie.setCurrent(await parseJSON(req))
@@ -59,15 +64,14 @@ async function selectCookie(req, response) {
 	}
 }
 
-function reinitialize(_, response) {
-	mockBrokersCollection.init()
-	sendOK(response)
-}
-
 async function updateBroker(req, response) {
 	try {
 		const body = await parseJSON(req)
 		const broker = mockBrokersCollection.getBrokerByFilename(body[DF.file])
+		if (!broker) {
+			sendUnprocessableContent(response)
+			return
+		}
 		if (DF.delayed in body)
 			broker.updateDelay(body[DF.delayed])
 		broker.updateFile(body[DF.file])
@@ -79,9 +83,9 @@ async function updateBroker(req, response) {
 	}
 }
 
-async function bulkUpdateBrokersByCommentTag(req, response) {
+async function updateProxyFallback(req, response) {
 	try {
-		mockBrokersCollection.setMocksMatchingComment(await parseJSON(req))
+		Config.proxyFallback = await parseJSON(req)
 		sendOK(response)
 	}
 	catch (error) {
@@ -90,9 +94,9 @@ async function bulkUpdateBrokersByCommentTag(req, response) {
 	}
 }
 
-async function updateProxyFallback(req, response) {
+async function bulkUpdateBrokersByCommentTag(req, response) {
 	try {
-		Config.proxyFallback = await parseJSON(req)
+		mockBrokersCollection.setMocksMatchingComment(await parseJSON(req))
 		sendOK(response)
 	}
 	catch (error) {

package/src/Config.js

@@ -26,7 +26,7 @@ export function setup(options) {
 		delay: ms => Number.isInteger(ms) && ms > 0,
 		cookies: is(Object),
 		skipOpen: is(Boolean),
-		proxyFallback: is(String),
+		proxyFallback: optional(URL.canParse),
 		allowedExt: is(RegExp),
 		generate500: is(Boolean),
 		extraHeaders: Array.isArray

package/src/mockBrokersCollection.js

@@ -54,7 +54,8 @@ export const getAll = () => collection
 
 export const getBrokerByFilename = file => {
 	const { method, urlMask } = Route.parseFilename(file)
-	return collection[method][urlMask]
+	if (collection[method])
+		return collection[method][urlMask]
 }
 
 // Searching the routes in reverse order so dynamic params (e.g.

package/src/utils/http-response.js

@@ -54,6 +54,11 @@ export function sendNotFound(response) {
 	response.end()
 }
 
+export function sendUnprocessableContent(response) {
+	response.statusCode = 422
+	response.end()
+}
+
 export function sendInternalServerError(response) {
 	response.statusCode = 500
 	response.end()