mockaton 2.3.0 → 3.0.0

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,7 +13,54 @@ 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
+## 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:820px"/>
+
+
+## Basic Usage
+```
+npm install mockaton
+```
+Create a `my-mockaton.js` file
+```js
+import { resolve } from 'node:path'
+import { Mockaton } from 'mockaton'
+
+Mockaton({
+  mocksDir: resolve('my-mocks-dir'), 
+  port: 2345
+})
+```
+
+```sh
+node my-mockaton.js
+```
+
+## Config Options
+```ts
+interface Config {
+	mocksDir: string
+	staticDir?: string
+	host?: string, // defaults to 'localhost'
+	port?: number // defaults to 0, which means auto-assigned
+	delay?: number // defaults to 1200 (ms)
+  open?: (dashboardUrl: string) => void // pass a noop to prevent opening the dashboard
+	cookies?: object
+	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?: []
+}
+```
+
+---
+
+## Mock Variants
 Each route can have many mocks, which could either be:
 - Different response __status code__. 
   - e.g. for testing error responses. 
@@ -25,7 +72,7 @@ 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
+## You can write JSON mocks in JavaScript
 An Object, Array, or String is sent as JSON.
 
 `api/foo.GET.200.js`
@@ -45,18 +92,11 @@ export default function (req, response) {
 ```
 
 
-### Proxying Routes
+## 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
@@ -64,44 +104,6 @@ particular response. They are handy for testing spinners.
 
 The delay is globally configurable via `Config.delay = 1200` (milliseconds).
 
----
-
-## Basic Usage (see [_usage_example.js](./_usage_example.js))
-```
-npm install mockaton
-```
-Create a `my-mockaton.js` file
-```js
-import { resolve } from 'node:path'
-import { Mockaton } from 'mockaton'
-
-Mockaton({
-  mocksDir: resolve('my-mocks-dir'), 
-  port: 2345
-})
-```
-
-```sh
-node my-mockaton.js
-```
-
-## Config Options
-```ts
-interface Config {
-  mocksDir: string
-  staticDir?: string 
-  host?: string, // defaults to 'localhost'
-  port?: number // defaults to 0, which means auto-assigned
-  delay?: number // defaults to 1200 (ms)
-  cookies?: object 
-  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?: []
-}
-```
----
 
 ## File Name Convention
 

package/Tests.js

@@ -106,7 +106,7 @@ writeStatic('another-entry/index.html', '<h1>Another</h1>')
 const server = Mockaton({
 	mocksDir: tmpDir,
 	staticDir: staticTmpDir,
-	skipOpen: true,
+	open: () => {},
 	cookies: {
 		userA: 'CookieA',
 		userB: 'CookieB'

package/index.d.ts

@@ -6,8 +6,8 @@ interface Config {
 	host?: string,
 	port?: number
 	delay?: number
+	open?: (address: string) => void
 	cookies?: object
-	skipOpen?: boolean
 	proxyFallback?: string
 	allowedExt?: RegExp
 	generate500?: boolean,

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": "3.0.0",
 	"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

@@ -1,5 +1,5 @@
-import { existsSync as exists, lstatSync } from 'node:fs'
-import { validate, is, optional } from './utils/validate.js'
+import { openInBrowser } from './utils/openInBrowser.js'
+import { validate, is, optional, isDirectory } from './utils/validate.js'
 
 
 export const Config = {
@@ -8,8 +8,8 @@ export const Config = {
 	host: '127.0.0.1',
 	port: 0, // auto-assigned
 	delay: 1200, // milliseconds
+	open: openInBrowser,
 	cookies: {}, // defaults to the first kv
-	skipOpen: false,
 	proxyFallback: '', // e.g. http://localhost:9999
 	allowedExt: /\.(json|txt|md|js)$/, // Just for excluding temporary editor files (e.g. JetBrains appends a ~)
 	generate500: false,
@@ -24,17 +24,13 @@ export function setup(options) {
 		host: is(String),
 		port: port => Number.isInteger(port) && port >= 0 && port < 2 ** 16,
 		delay: ms => Number.isInteger(ms) && ms > 0,
+		open: is(Function),
 		cookies: is(Object),
-		skipOpen: is(Boolean),
-		proxyFallback: is(String),
+		proxyFallback: optional(URL.canParse),
 		allowedExt: is(RegExp),
 		generate500: is(Boolean),
 		extraHeaders: Array.isArray
 	})
 }
 
-function isDirectory(dir) {
-	return exists(dir) && lstatSync(dir).isDirectory()
-}
-
 

package/src/Mockaton.js

@@ -36,7 +36,7 @@ export function Mockaton(options) {
 			console.log('Dashboard', url + API.dashboard)
 			if (error)
 				console.error(error)
-			else if (!Config.skipOpen)
-				exec(`open ${url + API.dashboard}`)
+			else
+				Config.open(url + API.dashboard)
 		})
 }

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()

package/src/utils/openInBrowser.js

@@ -0,0 +1,8 @@
+import { exec } from 'node:child_process'
+
+
+export function openInBrowser(address) {
+	if (process.platform === 'darwin')
+		exec(`open ${address}`)
+}
+

package/src/utils/validate.js

@@ -1,3 +1,6 @@
+import { existsSync as exists, lstatSync } from 'node:fs'
+
+
 export function validate(obj, shape) {
 	for (const [field, value] of Object.entries(obj))
 		if (!shape[field](value))
@@ -6,3 +9,4 @@ export function validate(obj, shape) {
 
 export const is = ctor => val => val.constructor === ctor
 export const optional = tester => val => !val || tester(val)
+export const isDirectory = dir => exists(dir) && lstatSync(dir).isDirectory()