mockaton 11.0.0 → 11.0.1

package/Makefile

@@ -6,23 +6,23 @@ watch:
 
 
 test:
-	node --test 'src/**/*.test.js'
+	@node --test 'src/**/*.test.js'
 
 test-docker:
-	docker run --rm -it \
-		-v "$$PWD":/app \
-		-w /app \
+	@docker run --rm --interactive --tty \
+		--volume .:/app \
+		--workdir /app \
 		node:24 \
 		make test
 
 coverage:
-	node --test --experimental-test-coverage \
+	@node --test --experimental-test-coverage \
 		--test-reporter=spec --test-reporter-destination=stdout \
 		--test-reporter=lcov --test-reporter-destination=lcov.info \
 		'src/**/*.test.js'
 
 pixaton:
-	node --test --experimental-test-isolation=none \
+	@node --test --experimental-test-isolation=none \
 		--import=./pixaton-tests/_setup.js \
 		'pixaton-tests/**/*.test.js'
 

package/README.md

@@ -129,14 +129,15 @@ With Mockaton, developers can achieve correctness and speed.
 <br/>
 
 ## Basic Usage
-1. Install Node.js, which comes with `npm` and `npx`
+
+1. Install Node.js (v22.18+ support writing mocks in TypeScript)
 
 2. Create a sample mock in the default mocks directory (`./mockaton-mocks`)
 ```sh
 mkdir -p         mockaton-mocks/api
 echo "[1,2,3]" > mockaton-mocks/api/foo.GET.200.json
 ```
-3. Run Mockaton (`npx` installs it if needed)
+3. Run Mockaton (`npx` comes with Node, and installs Mockaton if needed)
 ```shell
 npx mockaton --port 2345
 ```

package/package.json

@@ -2,7 +2,7 @@
 	"name": "mockaton",
 	"description": "HTTP Mock Server",
 	"type": "module",
-	"version": "11.0.0",
+	"version": "11.0.1",
 	"main": "index.js",
 	"types": "index.d.ts",
 	"license": "MIT",
@@ -23,5 +23,8 @@
 	"devDependencies": {
 		"pixaton": "1.1.3",
 		"puppeteer": "24.24.1"
+	},
+	"engines": {
+		"node": ">=22.18 <23 || >=23.6"
 	}
 }

package/src/Api.js

@@ -13,7 +13,7 @@ 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 { API, LONG_POLL_SERVER_TIMEOUT, HEADER_FOR_SYNC_VERSION } from './ApiConstants.js'
+import { API, LONG_POLL_SERVER_TIMEOUT, HEADER_SYNC_VERSION } from './ApiConstants.js'
 
 
 export const apiGetRequests = new Map([
@@ -81,7 +81,7 @@ function getState(_, response) {
 
 
 function longPollClientSyncVersion(req, response) {
-	if (uiSyncVersion.version !== Number(req.headers[HEADER_FOR_SYNC_VERSION])) {
+	if (uiSyncVersion.version !== Number(req.headers[HEADER_SYNC_VERSION])) {
 		// e.g., tab was hidden while new mocks were added or removed
 		sendJSON(response, uiSyncVersion.version)
 		return
@@ -111,9 +111,9 @@ function reinitialize(_, response) {
 
 
 async function selectCookie(req, response) {
-	const label = await parseJSON(req)
+	const cookieKey = await parseJSON(req)
 
-	const error = cookie.setCurrent(label)
+	const error = cookie.setCurrent(cookieKey)
 	if (error)
 		sendUnprocessableContent(response, error?.message || error)
 	else

package/src/ApiCommander.js

@@ -1,4 +1,4 @@
-import { API, LONG_POLL_SERVER_TIMEOUT, HEADER_FOR_SYNC_VERSION } from './ApiConstants.js'
+import { API, LONG_POLL_SERVER_TIMEOUT, HEADER_SYNC_VERSION } from './ApiConstants.js'
 
 
 /** Client for controlling Mockaton via its HTTP API */
@@ -20,14 +20,14 @@ export class Commander {
 		fetch(this.#addr + API.state)
 
 	/** @returns {JsonPromise<number>} */
-	getSyncVersion = (currSyncVer, abortSignal) =>
+	getSyncVersion = (currSyncVer, abortSignal = undefined) =>
 		fetch(this.#addr + API.syncVersion, {
 			signal: AbortSignal.any([
 				abortSignal,
 				AbortSignal.timeout(LONG_POLL_SERVER_TIMEOUT + 1000)
-			]),
+			].filter(Boolean)),
 			headers: {
-				[HEADER_FOR_SYNC_VERSION]: currSyncVer
+				[HEADER_SYNC_VERSION]: currSyncVer
 			}
 		})
 
@@ -36,34 +36,14 @@ export class Commander {
 		return this.#patch(API.reset)
 	}
 
-	select(file) {
-		return this.#patch(API.select, file)
-	}
-
-	toggle500(method, urlMask) {
-		return this.#patch(API.toggle500, [method, urlMask])
+	setGlobalDelay(delay) {
+		return this.#patch(API.globalDelay, delay)
 	}
 
 	bulkSelectByComment(comment) {
 		return this.#patch(API.bulkSelect, comment)
 	}
 
-	setRouteIsDelayed(method, urlMask, delayed) {
-		return this.#patch(API.delay, [method, urlMask, delayed])
-	}
-
-	setStaticRouteIsDelayed(urlMask, delayed) {
-		return this.#patch(API.delayStatic, [urlMask, delayed])
-	}
-
-	setStaticRouteStatus(urlMask, status) {
-		return this.#patch(API.staticStatus, [urlMask, status])
-	}
-
-	setRouteIsProxied(method, urlMask, proxied) {
-		return this.#patch(API.proxied, [method, urlMask, proxied])
-	}
-
 	selectCookie(cookieKey) {
 		return this.#patch(API.cookies, cookieKey)
 	}
@@ -80,7 +60,29 @@ export class Commander {
 		return this.#patch(API.cors, value)
 	}
 
-	setGlobalDelay(delay) {
-		return this.#patch(API.globalDelay, delay)
+	
+	select(file) {
+		return this.#patch(API.select, file)
+	}
+
+	toggle500(method, urlMask) {
+		return this.#patch(API.toggle500, [method, urlMask])
+	}
+
+	setRouteIsDelayed(method, urlMask, delayed) {
+		return this.#patch(API.delay, [method, urlMask, delayed])
+	}
+
+	setRouteIsProxied(method, urlMask, proxied) {
+		return this.#patch(API.proxied, [method, urlMask, proxied])
+	}
+	
+
+	setStaticRouteIsDelayed(urlMask, delayed) {
+		return this.#patch(API.delayStatic, [urlMask, delayed])
+	}
+
+	setStaticRouteStatus(urlMask, status) {
+		return this.#patch(API.staticStatus, [urlMask, status])
 	}
 }

package/src/ApiConstants.js

@@ -1,6 +1,7 @@
 const MOUNT = '/mockaton'
 export const API = {
 	dashboard: MOUNT,
+	
 	bulkSelect: MOUNT + '/bulk-select-by-comment',
 	collectProxied: MOUNT + '/collect-proxied',
 	cookies: MOUNT + '/cookies',
@@ -19,9 +20,9 @@ export const API = {
 	toggle500: MOUNT + '/toggle500'
 }
 
-export const HEADER_FOR_502 = 'Mockaton502'
-export const HEADER_FOR_SYNC_VERSION = 'sync_version'
+export const HEADER_502 = 'Mockaton502'
+export const HEADER_SYNC_VERSION = 'sync_version'
 
 export const DEFAULT_MOCK_COMMENT = '(default)'
-export const EXT_FOR_UNKNOWN_MIME = 'unknown'
+export const UNKNOWN_MIME_EXT = 'unknown'
 export const LONG_POLL_SERVER_TIMEOUT = 8_000

package/src/Dashboard.js

@@ -1,5 +1,5 @@
 import { createElement as r, createSvgElement as s, className, restoreFocus, Defer, Fragment } from './DashboardDom.js'
-import { HEADER_FOR_502 } from './ApiConstants.js'
+import { HEADER_502 } from './ApiConstants.js'
 import { parseFilename } from './Filename.js'
 import { store } from './DashboardStore.js'
 
@@ -448,7 +448,7 @@ function StaticRow(row) {
 			!groupByMethod && r('td', className(CSS.Method),
 				'GET'),
 
-			r('td', null,
+			r('td', { colspan: 2 },
 				r('a', {
 					href: row.urlMask,
 					target: '_blank',
@@ -593,7 +593,7 @@ function PayloadViewerTitle(file, statusText) {
 
 function PayloadViewerTitleWhenProxied(response) {
 	const mime = response.headers.get('content-type') || ''
-	const badGateway = response.headers.get(HEADER_FOR_502)
+	const badGateway = response.headers.get(HEADER_502)
 	return (
 		r('span', null,
 			badGateway

package/src/Filename.js

@@ -1,16 +1,10 @@
 const httpMethods = [ // @KeepSync with 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'
+	'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

package/src/MockBroker.js

@@ -4,7 +4,7 @@ import { DEFAULT_MOCK_COMMENT } from './ApiConstants.js'
 
 /** 
  * MockBroker is a state for a particular route. It knows the available mock 
- * files that can be served for the route, and the currently selected file, etc.
+ * files that can be served for the route, the currently selected file, etc.
  */
 export class MockBroker {
 	constructor(file) {

package/src/Mockaton.js

@@ -1,7 +1,7 @@
 import { createServer } from 'node:http'
 
-import { logger } from './utils/logger.js'
 import { API } from './ApiConstants.js'
+import { logger } from './utils/logger.js'
 import { config, setup } from './config.js'
 import { dispatchMock } from './MockDispatcher.js'
 import { dispatchStatic } from './StaticDispatcher.js'

package/src/mockBrokersCollection.js

@@ -109,7 +109,7 @@ export function extractAllComments() {
 		for (const c of b.extractComments())
 			comments.add(c)
 	})
-	return Array.from(comments)
+	return Array.from(comments).sort()
 }
 
 export function setMocksMatchingComment(comment) {

package/src/utils/http-request.js

@@ -50,6 +50,7 @@ export function readBody(req, parser = a => a) {
 }
 
 export const reControlAndDelChars = /[\x00-\x1f\x7f]/
+
 export function hasControlChars(url) {
 	try {
 		const decoded = decode(url)

package/src/utils/http-response.js

@@ -1,7 +1,7 @@
 import fs, { readFileSync } from 'node:fs'
 import { logger } from './logger.js'
 import { mimeFor } from './mime.js'
-import { HEADER_FOR_502 } from '../ApiConstants.js'
+import { HEADER_502 } from '../ApiConstants.js'
 
 
 export function sendOK(response) {
@@ -69,7 +69,7 @@ export function sendInternalServerError(response, error) {
 export function sendBadGateway(response, error) {
 	logger.warn('Fallback Proxy Error:', error.cause.message)
 	response.statusCode = 502
-	response.setHeader(HEADER_FOR_502, 1)
+	response.setHeader(HEADER_502, 1)
 	response.end()
 }
 

package/src/utils/mime.js

@@ -1,5 +1,5 @@
 import { config } from '../config.js'
-import { EXT_FOR_UNKNOWN_MIME } from '../ApiConstants.js'
+import { UNKNOWN_MIME_EXT } from '../ApiConstants.js'
 
 
 // Generated with:
@@ -119,7 +119,7 @@ export function extFor(mime) {
 function findExt(rawMime) {
 	const m = parseMime(rawMime)
 	const extraMimeToExt = mapMimeToExt(config.extraMimes)
-	return extraMimeToExt[m] || mimeToExt[m] || EXT_FOR_UNKNOWN_MIME
+	return extraMimeToExt[m] || mimeToExt[m] || UNKNOWN_MIME_EXT
 }
 
 export function parseMime(mime) {