mockaton 12.2.2 → 12.3.0

package/README.md

@@ -8,8 +8,7 @@ for testing difficult to reproduce backend states.
 [![codecov](https://codecov.io/github/ericfortis/mockaton/graph/badge.svg?token=90NYLMMG1J)](https://codecov.io/github/ericfortis/mockaton)
 
 
-## [Documentation ↗](https://mockaton.com) 
-## [Changelog ↗](https://mockaton.com/changelog)
+## [Documentation ↗](https://mockaton.com) | [Changelog ↗](https://mockaton.com/changelog)
 
 ## Overview
 With Mockaton, you don’t need to write code for wiring up your
@@ -22,7 +21,6 @@ For example, for [/api/company/123](#), the filename could be:
 <code>my-mocks-dir/<b>api/company</b>/[id].GET.200.json</code>
 </pre>
 
-<br/>
 
 ## Dashboard
 
@@ -32,16 +30,13 @@ For example, for [/api/company/123](#), the filename could be:
   <img alt="Mockaton Dashboard" src="https://raw.githubusercontent.com/ericfortis/mockaton/refs/heads/main/pixaton-tests/tests/macos/pic-for-readme.vp762x762.dark.gold.png">
 </picture>
 
-On the dashboard you can: select a mock variant for a particular route; 🕓 delay responses;
-and cycle an autogenerated `500` error (e.g., for testing retries). Nonetheless,
-there’s a [Control API ↗](https://mockaton.com/api), which is handy for setting up tests.
-
 <br/>
 
 
 ## Quick Start (Docker)
 This will spin up Mockaton with the sample directories
-included in this repo mounted on the container ([mockaton-mocks/](./mockaton-mocks) and [mockaton-static-mocks/](./mockaton-static-mocks))
+included in this repo mounted on the container ([mockaton-mocks/](./mockaton-mocks)
+and [mockaton-static-mocks/](./mockaton-static-mocks))
 
 ```sh
 git clone https://github.com/ericfortis/mockaton.git --depth 1
@@ -50,13 +45,7 @@ make docker
 ```
 Dashboard: http://localhost:2020/mockaton
 
-
 Test it:
 ```shell
 curl localhost:2020/api/user
 ```
-
-
-
-## License
-MIT

package/index.d.ts

@@ -44,7 +44,7 @@ export interface Config {
 	plugins?: [filenameTester: RegExp, plugin: Plugin][]
 
 	onReady?: (address: string) => void
-	
+
 	hotReload?: boolean // For UI dev purposes only
 }
 

package/package.json

@@ -2,7 +2,7 @@
 	"name": "mockaton",
 	"description": "HTTP Mock Server",
 	"type": "module",
-	"version": "12.2.2",
+	"version": "12.3.0",
 	"exports": {
 		".": {
 			"import": "./index.js",

package/src/client/ApiCommander.js

@@ -23,7 +23,7 @@ export class Commander {
 
 	/** @returns {Promise<Response>} */
 	setGlobalDelay = delay => this.#patch(API.globalDelay, delay)
-	
+
 	/** @returns {Promise<Response>} */
 	setGlobalDelayJitter = jitterPct => this.#patch(API.globalDelayJitter, jitterPct)
 

package/src/client/ApiConstants.js

@@ -1,9 +1,10 @@
-/** @KeepSync src/server/ApiConstants.js */
+/** # @SharedWithServer */
 
 const MOUNT = '/mockaton'
+
 export const API = {
 	dashboard: MOUNT,
-	
+
 	bulkSelect: MOUNT + '/bulk-select-by-comment',
 	collectProxied: MOUNT + '/collect-proxied',
 	cookies: MOUNT + '/cookies',

package/src/client/Filename.js

@@ -1,4 +1,13 @@
-// @KeepSync src/server/Filename.js
+/** # @SharedWithServer */
+
+const METHODS = [ // @KeepSync node:http.METHODS
+	'ACL', 'BIND', 'CHECKOUT', 'CONNECT', 'COPY', 'DELETE',
+	'GET', 'HEAD', 'LINK', 'LOCK', 'M-SEARCH', 'MERGE',
+	'MKACTIVITY', 'MKCALENDAR', 'MKCOL', 'MOVE', 'NOTIFY', 'OPTIONS',
+	'PATCH', 'POST', 'PROPFIND', 'PROPPATCH', 'PURGE', 'PUT',
+	'QUERY', 'REBIND', 'REPORT', 'SEARCH', 'SOURCE', 'SUBSCRIBE',
+	'TRACE', 'UNBIND', 'UNLINK', 'UNLOCK', 'UNSUBSCRIBE'
+]
 
 const reComments = /\(.*?\)/g // Anything within parentheses
 
@@ -6,6 +15,25 @@ export function extractComments(file) {
 	return Array.from(file.matchAll(reComments), ([c]) => c)
 }
 
+export function includesComment(file, search) {
+	return extractComments(file).some(c => c.includes(search))
+}
+
+
+export function validateFilename(file) {
+	const tokens = file.replace(reComments, '').split('.')
+	if (tokens.length < 4)
+		return 'Invalid Filename Convention'
+
+	const { status, method } = parseFilename(file)
+	if (!responseStatusIsValid(status))
+		return `Invalid HTTP Response Status: "${status}"`
+
+	if (!METHODS.includes(method))
+		return `Unrecognized HTTP Method: "${method}"`
+}
+
+
 export function parseFilename(file) {
 	const tokens = file.replace(reComments, '').split('.')
 	return {
@@ -22,3 +50,19 @@ function removeTrailingSlash(url = '') {
 		.replace('/?', '?')
 		.replace('/#', '#')
 }
+
+function responseStatusIsValid(status) {
+	return Number.isInteger(status)
+		&& status >= 100
+		&& status <= 599
+}
+
+export function makeMockFilename(url, method, status, ext) {
+	const urlMask = replaceIds(removeTrailingSlash(url))
+	return [urlMask, method, status, ext].join('.')
+}
+
+const reUuidV4 = /([0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12})/gi
+function replaceIds(filename) {
+	return filename.replaceAll(reUuidV4, '[id]')
+}

package/src/client/app-store.js

@@ -82,7 +82,7 @@ export const store = {
 		}
 		catch (error) { store.onError(error) }
 	},
-	
+
 	async setGlobalDelayJitter(value) {
 		try {
 			const response = await api.setGlobalDelayJitter(value)
@@ -160,7 +160,7 @@ export const store = {
 		r.setUrlMaskDittoed(store._dittoCache.get(r.key))
 		return r
 	},
-	
+
 	staticBrokersAsRows() {
 		const rows = Object.values(store.staticBrokers)
 			.map(b => new StaticBrokerRowModel(b))
@@ -196,7 +196,6 @@ export const store = {
 			const response = await api.toggle500(method, urlMask)
 			if (!response.ok) throw response
 			store.setBroker(await response.json())
-			store.setChosenLink(method, urlMask)
 			store.renderRow(method, urlMask)
 		}
 		catch (error) { store.onError(error) }
@@ -207,7 +206,6 @@ export const store = {
 			const response = await api.setRouteIsProxied(method, urlMask, checked)
 			if (!response.ok) throw response
 			store.setBroker(await response.json())
-			store.setChosenLink(method, urlMask)
 			store.renderRow(method, urlMask)
 		}
 		catch (error) { store.onError(error) }