mockaton 11.1.0 → 11.1.2

package/README.md

@@ -267,6 +267,7 @@ export default defineConfig({
   mocksDir: 'mockaton-mocks',
   staticDir: 'mockaton-static-mocks',
   ignore: /(\.DS_Store|~)$/,
+  watcherEnabled: true,
 
   host: '127.0.0.1',
   port: 0,
@@ -297,8 +298,7 @@ export default defineConfig({
     [/\.(js|ts)$/, jsToJsonPlugin]
   ],
 
-  onReady: await openInBrowser,
-  watcherEnabled: true
+  onReady: await openInBrowser
 })
 ```
 
@@ -329,13 +329,26 @@ my-static-dir<b>/foo/bar.jpg</b> <span style="color:green"> // Wins</span>
 <br/>
 
 ### `ignore?: RegExp`
-Defaults to `/(\.DS_Store|~)$/`. The regex rule is
-tested against the basename (filename without directory path).
+Defaults to `/(\.DS_Store|~)$/`
+
+The regex rule is tested against the basename (filename without directory path).
 
 
 <br/>
 
 
+### `watcherEnabled?: boolean`
+Defaults to `true` 
+
+When `false`, if you **add**, **delete**, or **rename** you’ll need to click **"Reset"**
+on the Dashboard, or call `commander.reset()` in order to re-initialize the collection.
+
+On the other hand, **edits are not affected by this
+flag**; mocks are always read from disk on every request.
+
+<br/>
+
+
 ### `host?: string`
 Defaults to `'127.0.0.1'`
 
@@ -549,13 +562,6 @@ Defaults to `'normal'`.
 - `normal`: info, mock access, warnings, and errors
 - `verbose`: normal + API access
 
-<br/>
-
-
-### `watcherEnabled?: boolean`
-Defaults to `true`. When `true`, newly added mocks get registered,
-or unregistered when deleting them.
-
 </details>
 
 

package/index.d.ts

@@ -1,6 +1,6 @@
 import { Server, IncomingMessage, OutgoingMessage } from 'node:http'
 
-type Plugin = (
+export type Plugin = (
 	filePath: string,
 	request: IncomingMessage,
 	response: OutgoingMessage
@@ -9,10 +9,11 @@ type Plugin = (
 	body: string | Uint8Array
 }>
 
-interface Config {
+export interface Config {
 	mocksDir?: string
 	staticDir?: string
 	ignore?: RegExp
+	watcherEnabled?: boolean
 
 	host?: string,
 	port?: number
@@ -42,8 +43,6 @@ interface Config {
 	plugins?: [filenameTester: RegExp, plugin: Plugin][]
 
 	onReady?: (address: string) => void
-
-	watcherEnabled?: boolean
 }
 
 

package/package.json

@@ -2,7 +2,7 @@
 	"name": "mockaton",
 	"description": "HTTP Mock Server",
 	"type": "module",
-	"version": "11.1.0",
+	"version": "11.1.2",
 	"main": "index.js",
 	"types": "index.d.ts",
 	"license": "MIT",

package/src/ApiCommander.js

@@ -13,7 +13,7 @@ export class Commander {
 	getState = () =>
 		fetch(this.#addr + API.state)
 
-	/** 
+	/**
 	 * @param {number?} currSyncVer - On mismatch, it responds immediately. Otherwise, long polls.
 	 * @param {AbortSignal} abortSignal
 	 * @returns {JsonPromise<number>}
@@ -24,8 +24,8 @@ export class Commander {
 				abortSignal,
 				AbortSignal.timeout(LONG_POLL_SERVER_TIMEOUT + 1000)
 			].filter(Boolean)),
-			headers: currSyncVer !== undefined 
-				? { [HEADER_SYNC_VERSION]: currSyncVer } 
+			headers: currSyncVer !== undefined
+				? { [HEADER_SYNC_VERSION]: currSyncVer }
 				: {}
 		})
 
@@ -45,12 +45,24 @@ export class Commander {
 	setProxyFallback = proxyAddr => this.#patch(API.fallback, proxyAddr)
 	setCollectProxied = shouldCollect => this.#patch(API.collectProxied, shouldCollect)
 
-	select = file => this.#patch(API.select, file)
-	bulkSelectByComment = comment => this.#patch(API.bulkSelect, comment)
+	/** @returns {JsonPromise<ClientMockBroker>} */
+	select = file => 
+		this.#patch(API.select, file)
 
-	toggle500 = (method, urlMask) => this.#patch(API.toggle500, [method, urlMask])
-	setRouteIsProxied = (method, urlMask, proxied) => this.#patch(API.proxied, [method, urlMask, proxied])
-	setRouteIsDelayed = (method, urlMask, delayed) => this.#patch(API.delay, [method, urlMask, delayed])
+	bulkSelectByComment = comment => 
+		this.#patch(API.bulkSelect, comment)
+
+	/** @returns {JsonPromise<ClientMockBroker>} */
+	toggle500 = (method, urlMask) =>
+		this.#patch(API.toggle500, [method, urlMask])
+
+	/** @returns {JsonPromise<ClientMockBroker>} */
+	setRouteIsProxied = (method, urlMask, proxied) =>
+		this.#patch(API.proxied, [method, urlMask, proxied])
+
+	/** @returns {JsonPromise<ClientMockBroker>} */
+	setRouteIsDelayed = (method, urlMask, delayed) =>
+		this.#patch(API.delay, [method, urlMask, delayed])
 
 	setStaticRouteStatus = (urlMask, status) => this.#patch(API.staticStatus, [urlMask, status])
 	setStaticRouteIsDelayed = (urlMask, delayed) => this.#patch(API.delayStatic, [urlMask, delayed])

package/src/Dashboard.css

@@ -15,7 +15,7 @@
 		--colorSecondaryActionBorder: #ddd;
 		--colorSecondaryAction: #666;
 		--colorDisabledMockSelector: #444;
-		--colorHover: #dfefff;
+		--colorHover: rgba(119, 193, 255, 0.5);
 		--colorLabel: #555;
 		--colorLightRed: #ffe4ee;
 		--colorRed: #da0f00;
@@ -37,7 +37,7 @@
 		--colorSecondaryAction: #aaa;
 		--colorComboBoxHeaderBackground: #222;
 		--colorDisabledMockSelector: #b9b9b9;
-		--colorHover: #023661;
+		--colorHover: rgba(0, 63, 115, 0.5);
 		--colorLabel: #aaa;
 		--colorLightRed: #ffe4ee;
 		--colorRed: #f41606;
@@ -76,29 +76,35 @@ body {
 	scrollbar-width: thin;
 }
 
-select, a, input, button {
-	cursor: pointer;
-
+a,
+input,
+select,
+button {
 	&:focus-visible {
+		outline-offset: -1px;
 		outline: 2px solid var(--colorAccent);
 	}
 }
 
-a {
-	text-decoration: none;
+a,
+select,
+button,
+input[type=checkbox] {
+	cursor: pointer;
+
+	&:active {
+		cursor: grabbing;
+	}
 }
 
-a:active,
-button:active,
-input[type=checkbox]:active {
-	cursor: grabbing;
+a {
+	text-decoration: none;
 }
 
 select {
 	border: 1px solid transparent;
 	font-size: 100%;
 	color: var(--colorText);
-	cursor: pointer;
 	border-radius: var(--radius);
 	appearance: none;
 	background: url("data:image/svg+xml;utf8,<svg xmlns='http://www.w3.org/2000/svg' viewBox='0 0 24 24' fill='%23888888'><path d='M16.59 8.59 12 13.17 7.41 8.59 6 10l6 6 6-6z'/></svg>") no-repeat;
@@ -110,7 +116,6 @@ select {
 		background-color: var(--colorSecondaryButtonBackground);
 		&:hover {
 			border-color: var(--colorHover);
-			cursor: pointer;
 			background-color: var(--colorHover);
 		}
 	}
@@ -247,7 +252,6 @@ header {
 		border: 1px solid var(--colorRed);
 		margin-right: 8px;
 		margin-left: 4px;
-		outline-offset: 1px;
 		background: transparent;
 		border-radius: 50px;
 		color: var(--colorRed);

package/src/Dashboard.js

@@ -139,12 +139,11 @@ function GlobalDelayField() {
 }
 
 function BulkSelector() {
-	// TODO For a11y, this should be a `menu` instead of this `select`
 	const { comments } = store
 	const firstOption = t`Pick Comment…`
 	function onChange() {
 		const value = this.value
-		this.value = firstOption // Hack
+		this.value = firstOption // hack so it’s always selected
 		store.bulkSelectByComment(value)
 	}
 	const disabled = !comments.length
@@ -161,6 +160,7 @@ function BulkSelector() {
 				r('option', { value: firstOption }, firstOption),
 				r('hr'),
 				comments.map(value => r('option', { value }, value)))))
+	// TODO For a11y, use `menu` instead of `select`
 }
 
 function CookieSelector() {

package/src/MockBroker.js

@@ -55,7 +55,7 @@ export class MockBroker {
 	}
 
 	toggle500() {
-		this.proxied = false // TESTME
+		this.proxied = false
 		if (this.auto500 || this.status === 500)
 			this.selectDefaultFile()
 		else {
@@ -74,7 +74,7 @@ export class MockBroker {
 	}
 
 	setProxied(proxied) {
-		this.auto500 = false // TESTME
+		this.auto500 = false
 		this.proxied = proxied
 	}
 

package/src/MockDispatcher.js

@@ -46,7 +46,7 @@ export async function dispatchMock(req, response) {
 		setTimeout(() => response.end(isHead ? null : body),
 			Number(broker.delayed && calcDelay()))
 	}
-	catch (error) {
+	catch (error) { // TESTME
 		if (error?.code === 'ENOENT') // mock-file has been deleted
 			sendMockNotFound(response)
 		else

package/src/Mockaton.js

@@ -21,7 +21,7 @@ export function Mockaton(options) {
 		mockBrokerCollection.init()
 		staticCollection.init()
 
-		if (options.watcherEnabled) {
+		if (config.watcherEnabled) {
 			watchMocksDir()
 			watchStaticDir()
 		}

package/src/Watcher.js

@@ -45,7 +45,7 @@ export function watchMocksDir() {
 		if (!file)
 			return
 
-		if (isDirectory(join(dir, file))) {
+		if (isDirectory(join(dir, file))) { // TESTME
 			mockBrokerCollection.init()
 			uiSyncVersion.increment()
 		}
@@ -61,7 +61,7 @@ export function watchMocksDir() {
 	})
 }
 
-export function watchStaticDir() {
+export function watchStaticDir() { // TESTME
 	const dir = config.staticDir
 	if (!dir)
 		return

package/src/config.js

@@ -19,6 +19,7 @@ const schema = {
 	mocksDir: [resolve('mockaton-mocks'), isDirectory],
 	staticDir: [resolve('mockaton-static-mocks'), optional(isDirectory)],
 	ignore: [/(\.DS_Store|~)$/, is(RegExp)], // TODO think about .well-known/appspecific/com.chrome.devtools
+	watcherEnabled: [true, is(Boolean)],
 
 	host: ['127.0.0.1', is(String)],
 	port: [0, port => Number.isInteger(port) && port >= 0 && port < 2 ** 16], // 0 means auto-assigned
@@ -49,9 +50,7 @@ const schema = {
 			[/\.(js|ts)$/, jsToJsonPlugin]
 		], Array.isArray],
 
-	onReady: [await openInBrowser, is(Function)],
-	
-	watcherEnabled: [true, is(Boolean)],
+	onReady: [await openInBrowser, is(Function)]
 }
 
 

package/src/staticCollection.js

@@ -29,7 +29,7 @@ export function init() {
 
 /** @returns {boolean} registered */
 export function registerMock(relativeFile) {
-	if (!isFileAllowed(basename(relativeFile)))
+	if (!isFileAllowed(basename(relativeFile))) // TESTME
 		return false
 
 	const route = '/' + relativeFile