mockaton 11.0.2 → 11.1.0

package/README.md

@@ -298,13 +298,14 @@ export default defineConfig({
   ],
 
   onReady: await openInBrowser,
+  watcherEnabled: true
 })
 ```
 
 </details>
 
 <details>
-<summary>Config Documentation…</summary>
+<summary><b>Config Documentation…</b></summary>
 
 ### `mocksDir?: string`
 Defaults to `'mockaton-mocks'`. 
@@ -548,6 +549,13 @@ 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

@@ -5,7 +5,7 @@ type Plugin = (
 	request: IncomingMessage,
 	response: OutgoingMessage
 ) => Promise<{
-	mime: string,
+	mime: string
 	body: string | Uint8Array
 }>
 
@@ -30,7 +30,7 @@ interface Config {
 	extraHeaders?: string[]
 	extraMimes?: { [fileExt: string]: string }
 
-	corsAllowed?: boolean,
+	corsAllowed?: boolean
 	corsOrigins?: string[]
 	corsMethods?: string[]
 	corsHeaders?: string[]
@@ -42,10 +42,13 @@ interface Config {
 	plugins?: [filenameTester: RegExp, plugin: Plugin][]
 
 	onReady?: (address: string) => void
+
+	watcherEnabled?: boolean
 }
 
 
 export function Mockaton(options: Partial<Config>): Promise<Server | undefined>
+
 export function defineConfig(options: Partial<Config>): Partial<Config>
 
 export const jsToJsonPlugin: Plugin

package/package.json

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

package/src/Api.js

@@ -12,7 +12,7 @@ import * as staticCollection from './staticCollection.js'
 import * as mockBrokersCollection from './mockBrokersCollection.js'
 import { config, ConfigValidator } from './config.js'
 import { DashboardHtml, CSP } from './DashboardHtml.js'
-import { sendOK, sendJSON, sendUnprocessableContent, sendFile, sendHTML } from './utils/http-response.js'
+import { sendOK, sendJSON, sendUnprocessable, sendFile, sendHTML } from './utils/http-response.js'
 import { API, LONG_POLL_SERVER_TIMEOUT, HEADER_SYNC_VERSION } from './ApiConstants.js'
 
 
@@ -116,7 +116,7 @@ async function selectCookie(req, response) {
 
 	const error = cookie.setCurrent(cookieKey)
 	if (error)
-		sendUnprocessableContent(response, error?.message || error)
+		sendUnprocessable(response, error?.message || error)
 	else
 		sendJSON(response, cookie.list())
 }
@@ -127,7 +127,7 @@ async function selectMock(req, response) {
 
 	const broker = mockBrokersCollection.brokerByFilename(file)
 	if (!broker || !broker.hasMock(file))
-		sendUnprocessableContent(response, `Missing Mock: ${file}`)
+		sendUnprocessable(response, `Missing Mock: ${file}`)
 	else {
 		broker.selectFile(file)
 		sendJSON(response, broker)
@@ -140,7 +140,7 @@ async function toggle500(req, response) {
 
 	const broker = mockBrokersCollection.brokerByRoute(method, urlMask)
 	if (!broker)
-		sendUnprocessableContent(response, `Route does not exist: ${method} ${urlMask}`)
+		sendUnprocessable(response, `Route does not exist: ${method} ${urlMask}`)
 	else {
 		broker.toggle500()
 		sendJSON(response, broker)
@@ -153,9 +153,9 @@ async function setRouteIsDelayed(req, response) {
 
 	const broker = mockBrokersCollection.brokerByRoute(method, urlMask)
 	if (!broker)
-		sendUnprocessableContent(response, `Route does not exist: ${method} ${urlMask}`)
+		sendUnprocessable(response, `Route does not exist: ${method} ${urlMask}`)
 	else if (typeof delayed !== 'boolean')
-		sendUnprocessableContent(response, `Expected boolean for "delayed"`)
+		sendUnprocessable(response, `Expected boolean for "delayed"`)
 	else {
 		broker.setDelayed(delayed)
 		sendJSON(response, broker)
@@ -168,11 +168,11 @@ async function setRouteIsProxied(req, response) {
 
 	const broker = mockBrokersCollection.brokerByRoute(method, urlMask)
 	if (!broker)
-		sendUnprocessableContent(response, `Route does not exist: ${method} ${urlMask}`)
+		sendUnprocessable(response, `Route does not exist: ${method} ${urlMask}`)
 	else if (typeof proxied !== 'boolean')
-		sendUnprocessableContent(response, `Expected boolean for "proxied"`)
+		sendUnprocessable(response, `Expected boolean for "proxied"`)
 	else if (proxied && !config.proxyFallback)
-		sendUnprocessableContent(response, `There’s no proxy fallback`)
+		sendUnprocessable(response, `There’s no proxy fallback`)
 	else {
 		broker.setProxied(proxied)
 		sendJSON(response, broker)
@@ -184,7 +184,7 @@ async function updateProxyFallback(req, response) {
 	const fallback = await parseJSON(req)
 
 	if (!ConfigValidator.proxyFallback(fallback))
-		sendUnprocessableContent(response, `Invalid Proxy Fallback URL`)
+		sendUnprocessable(response, `Invalid Proxy Fallback URL`)
 	else {
 		config.proxyFallback = fallback
 		sendOK(response)
@@ -196,7 +196,7 @@ async function setCollectProxied(req, response) {
 	const collectProxied = await parseJSON(req)
 
 	if (!ConfigValidator.collectProxied(collectProxied))
-		sendUnprocessableContent(response, `Expected a boolean for "collectProxied"`)
+		sendUnprocessable(response, `Expected a boolean for "collectProxied"`)
 	else {
 		config.collectProxied = collectProxied
 		sendOK(response)
@@ -216,7 +216,7 @@ async function setCorsAllowed(req, response) {
 	const corsAllowed = await parseJSON(req)
 
 	if (!ConfigValidator.corsAllowed(corsAllowed))
-		sendUnprocessableContent(response, `Expected boolean for "corsAllowed"`)
+		sendUnprocessable(response, `Expected boolean for "corsAllowed"`)
 	else {
 		config.corsAllowed = corsAllowed
 		sendOK(response)
@@ -228,7 +228,7 @@ async function setGlobalDelay(req, response) {
 	const delay = await parseJSON(req)
 
 	if (!ConfigValidator.delay(delay))
-		sendUnprocessableContent(response, `Expected non-negative integer for "delay"`)
+		sendUnprocessable(response, `Expected non-negative integer for "delay"`)
 	else {
 		config.delay = delay
 		sendOK(response)
@@ -242,9 +242,9 @@ async function setStaticRouteStatusCode(req, response) {
 
 	const broker = staticCollection.brokerByRoute(urlMask)
 	if (!broker)
-		sendUnprocessableContent(response, `Static route does not exist: ${urlMask}`)
+		sendUnprocessable(response, `Static route does not exist: ${urlMask}`)
 	else if (!(status === 200 || status === 404))
-		sendUnprocessableContent(response, `Expected 200 or 404 status code`)
+		sendUnprocessable(response, `Expected 200 or 404 status code`)
 	else {
 		broker.setStatus(status)
 		sendOK(response)
@@ -257,9 +257,9 @@ async function setStaticRouteIsDelayed(req, response) {
 
 	const broker = staticCollection.brokerByRoute(urlMask)
 	if (!broker)
-		sendUnprocessableContent(response, `Static route does not exist: ${urlMask}`)
+		sendUnprocessable(response, `Static route does not exist: ${urlMask}`)
 	else if (typeof delayed !== 'boolean')
-		sendUnprocessableContent(response, `Expected boolean for "delayed"`)
+		sendUnprocessable(response, `Expected boolean for "delayed"`)
 	else {
 		broker.setDelayed(delayed)
 		sendOK(response)

package/src/Dashboard.js

@@ -734,7 +734,7 @@ function SettingsIcon() {
  * The version increments when a mock file is added, removed, or renamed.
  */
 function initRealTimeUpdates() {
-	let oldVersion = undefined
+	let oldVersion = undefined // undefined waits until next event or timeout 
 	let controller = new AbortController()
 
 	longPoll()

package/src/MockBroker.js

@@ -2,8 +2,8 @@ import { includesComment, extractComments, parseFilename } from './Filename.js'
 import { DEFAULT_MOCK_COMMENT } from './ApiConstants.js'
 
 
-/** 
- * MockBroker is a state for a particular route. It knows the available mock 
+/**
+ * MockBroker is a state for a particular route. It knows the available mock
  * files that can be served for the route, the currently selected file, etc.
  */
 export class MockBroker {
@@ -27,7 +27,7 @@ export class MockBroker {
 	}
 
 	register(file) {
-		if (this.auto500 && this.#is500(file)) // TESTME
+		if (this.auto500 && this.#is500(file))
 			this.selectFile(file)
 		this.mocks.push(file)
 		this.#sortMocks()

package/src/MockDispatcher.js

@@ -14,11 +14,11 @@ import { sendInternalServerError, sendMockNotFound } from './utils/http-response
 export async function dispatchMock(req, response) {
 	try {
 		const isHead = req.method === 'HEAD'
-		
+
 		let broker = mockBrokerCollection.brokerByRoute(req.method, req.url)
 		if (!broker && isHead)
 			broker = mockBrokerCollection.brokerByRoute('GET', req.url)
-		
+
 		if (config.proxyFallback && (!broker || broker.proxied)) {
 			await proxy(req, response, broker?.delayed ? calcDelay() : 0)
 			return
@@ -42,6 +42,7 @@ export async function dispatchMock(req, response) {
 		logger.accessMock(req.url, broker.file)
 		response.setHeader('Content-Type', mime)
 		response.setHeader('Content-Length', length(body))
+		
 		setTimeout(() => response.end(isHead ? null : body),
 			Number(broker.delayed && calcDelay()))
 	}

package/src/Mockaton.js

@@ -11,7 +11,7 @@ import { setCorsHeaders, isPreflight } from './utils/http-cors.js'
 import { watchMocksDir, watchStaticDir } from './Watcher.js'
 import { apiPatchRequests, apiGetRequests } from './Api.js'
 import { BodyReaderError, hasControlChars } from './utils/http-request.js'
-import { sendNoContent, sendInternalServerError, sendUnprocessableContent, sendTooLongURI, sendBadRequest } from './utils/http-response.js'
+import { sendNoContent, sendInternalServerError, sendUnprocessable, sendTooLongURI, sendBadRequest } from './utils/http-response.js'
 
 
 export function Mockaton(options) {
@@ -20,8 +20,11 @@ export function Mockaton(options) {
 
 		mockBrokerCollection.init()
 		staticCollection.init()
-		watchMocksDir()
-		watchStaticDir()
+
+		if (options.watcherEnabled) {
+			watchMocksDir()
+			watchStaticDir()
+		}
 
 		const server = createServer(onRequest)
 		server.on('error', reject)
@@ -75,7 +78,7 @@ async function onRequest(req, response) {
 	}
 	catch (error) {
 		if (error instanceof BodyReaderError)
-			sendUnprocessableContent(response, `${error.name}: ${error.message}`)
+			sendUnprocessable(response, `${error.name}: ${error.message}`)
 		else
 			sendInternalServerError(response, error)
 	}

package/src/ProxyRelay.js

@@ -6,7 +6,7 @@ import { extFor } from './utils/mime.js'
 import { write, isFile } from './utils/fs.js'
 import { makeMockFilename } from './Filename.js'
 import { readBody, BodyReaderError } from './utils/http-request.js'
-import { sendUnprocessableContent, sendBadGateway } from './utils/http-response.js'
+import { sendUnprocessable, sendBadGateway } from './utils/http-response.js'
 
 
 export async function proxy(req, response, delay) {
@@ -22,7 +22,7 @@ export async function proxy(req, response, delay) {
 	}
 	catch (error) { // TESTME
 		if (error instanceof BodyReaderError)
-			sendUnprocessableContent(response, error.name)
+			sendUnprocessable(response, error.name)
 		else
 			sendBadGateway(response, error)
 		return

package/src/StaticDispatcher.js

@@ -1,13 +1,12 @@
 import { join } from 'node:path'
 import { readFileSync } from 'node:fs'
 
+import { isFile } from './utils/fs.js'
 import { logger } from './utils/logger.js'
 import { mimeFor } from './utils/mime.js'
 import { brokerByRoute } from './staticCollection.js'
 import { config, calcDelay } from './config.js'
 import { sendMockNotFound, sendPartialContent } from './utils/http-response.js'
-import { execFileSync } from 'node:child_process'
-import { isFile } from './utils/fs.js'
 
 
 export async function dispatchStatic(req, response) {

package/src/Watcher.js

@@ -18,7 +18,7 @@ export const uiSyncVersion = new class extends EventEmitter {
 	delay = Number(process.env.MOCKATON_WATCHER_DEBOUNCE_MS ?? 80)
 	version = 0
 
-	increment = this.#debounce(() => {
+	increment = /** @type {function} */ this.#debounce(() => {
 		this.version++
 		super.emit('ARR')
 	})

package/src/config.js

@@ -49,7 +49,9 @@ const schema = {
 			[/\.(js|ts)$/, jsToJsonPlugin]
 		], Array.isArray],
 
-	onReady: [await openInBrowser, is(Function)]
+	onReady: [await openInBrowser, is(Function)],
+	
+	watcherEnabled: [true, is(Boolean)],
 }
 
 

package/src/mockBrokersCollection.js

@@ -41,20 +41,22 @@ export function init() {
 /** @returns {boolean} registered */
 export function registerMock(file, isFromWatcher = false) {
 	if (brokerByFilename(file)?.hasMock(file)
-		|| !isFileAllowed(basename(file)) // TESTME
+		|| !isFileAllowed(basename(file))
 		|| !filenameIsValid(file))
 		return false
 
 	const { method, urlMask } = parseFilename(file)
 	collection[method] ??= {}
 
-	if (!collection[method][urlMask])
-		collection[method][urlMask] = new MockBroker(file)
+	let broker = collection[method][urlMask]
+
+	if (!broker)
+		broker = collection[method][urlMask] = new MockBroker(file)
 	else
-		collection[method][urlMask].register(file)
+		broker.register(file)
 
-	if (isFromWatcher && !collection[method][urlMask].file) // TESTME e.g. auto500 is selected and adding a new one
-		collection[method][urlMask].selectDefaultFile()
+	if (isFromWatcher && !broker.file)
+		broker.selectDefaultFile()
 
 	return true
 }
@@ -83,8 +85,7 @@ export function unregisterMock(file) {
 /** @returns {MockBroker | undefined} */
 export function brokerByFilename(file) {
 	const { method, urlMask } = parseFilename(file)
-	if (collection[method])
-		return collection[method][urlMask]
+	return collection[method]?.[urlMask]
 }
 
 /**
@@ -113,7 +114,7 @@ export function extractAllComments() {
 }
 
 export function setMocksMatchingComment(comment) {
-	forEachBroker(b => 
+	forEachBroker(b =>
 		b.setByMatchingComment(comment))
 }
 

package/src/utils/http-response.js

@@ -53,7 +53,7 @@ export function sendTooLongURI(response) {
 	response.end()
 }
 
-export function sendUnprocessableContent(response, error) {
+export function sendUnprocessable(response, error) {
 	logger.access(response, error)
 	response.statusCode = 422
 	response.end(error)