mockaton 8.16.1 → 8.16.2

package/package.json

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

package/src/Api.js

@@ -25,7 +25,9 @@ const dashboardAssets = [
 
 export const apiGetRequests = new Map([
 	[API.dashboard, serveDashboard],
-	...dashboardAssets.map(f => [API.dashboard + f, serveDashboardAsset(f)]),
+	...dashboardAssets.map(f => [
+		API.dashboard + f, serveDashboardAsset(f)
+	]),
 	[API.cors, getIsCorsAllowed],
 	[API.static, listStaticFiles],
 	[API.mocks, listMockBrokers],
@@ -49,7 +51,7 @@ export const apiPatchRequests = new Map([
 	[API.globalDelay, setGlobalDelay],
 	[API.collectProxied, setCollectProxied],
 	[API.delayStatic, setStaticRouteIsDelayed],
-	[API.notFoundStatic, setStaticRouteIsNotFound]
+	[API.staticStatus, setStaticRouteStatusCode]
 ])
 
 
@@ -66,7 +68,7 @@ function serveDashboardAsset(f) {
 
 function listCookies(_, response) { sendJSON(response, cookie.list()) }
 function listComments(_, response) { sendJSON(response, mockBrokersCollection.extractAllComments()) }
-function listStaticFiles(req, response) { sendJSON(response, getStaticFilesCollection()) }
+function listStaticFiles(_, response) { sendJSON(response, getStaticFilesCollection()) }
 function getGlobalDelay(_, response) { sendJSON(response, config.delay) }
 function listMockBrokers(_, response) { sendJSON(response, mockBrokersCollection.getAll()) }
 function getProxyFallback(_, response) { sendJSON(response, config.proxyFallback) }
@@ -86,12 +88,10 @@ function longPollClientSyncVersion(req, response) {
 	}
 
 	response.setTimeout(LONG_POLL_SERVER_TIMEOUT, onAddOrRemoveMock)
-
 	req.on('error', () => {
 		uiSyncVersion.unsubscribe(onAddOrRemoveMock)
 		response.destroy()
 	})
-
 	uiSyncVersion.subscribe(onAddOrRemoveMock)
 }
 
@@ -136,7 +136,7 @@ async function setRouteIsDelayed(req, response) {
 	else if (typeof delayed !== 'boolean')
 		sendUnprocessableContent(response, `Expected a boolean for "delayed"`) // TESTME
 	else {
-		broker.updateDelayed(body[DF.delayed])
+		broker.setDelayed(delayed)
 		sendOK(response)
 	}
 }
@@ -155,7 +155,7 @@ async function setRouteIsProxied(req, response) { // TESTME
 	else if (proxied && !config.proxyFallback)
 		sendUnprocessableContent(response, `There’s no proxy fallback`)
 	else {
-		broker.updateProxied(proxied)
+		broker.setProxied(proxied)
 		sendOK(response)
 	}
 }
@@ -198,17 +198,17 @@ async function setGlobalDelay(req, response) { // TESTME
 }
 
 
-async function setStaticRouteIsNotFound(req, response) {
+async function setStaticRouteStatusCode(req, response) {
 	const body = await parseJSON(req)
-	const shouldBeNotFound = body[DF.shouldBeNotFound]
+	const status = Number(body[DF.statusCode])
 	const broker = findStaticBrokerByRoute(body[DF.routeUrlMask])
 
 	if (!broker) // TESTME
 		sendUnprocessableContent(response, `Route does not exist: ${body[DF.routeUrlMask]}`)
-	else if (typeof shouldBeNotFound !== 'boolean')
-		sendUnprocessableContent(response, `Expected a boolean for "not found"`) // TESTME
+	else if (!(status === 200 || status === 404))
+		sendUnprocessableContent(response, `Expected a 200 or 404 status code. Received ${status}`) // TESTME
 	else {
-		broker.updateNotFound(body[DF.shouldBeNotFound])
+		broker.setStatus(status)
 		sendOK(response)
 	}
 }
@@ -216,15 +216,15 @@ async function setStaticRouteIsNotFound(req, response) {
 
 async function setStaticRouteIsDelayed(req, response) {
 	const body = await parseJSON(req)
-	const shouldBeNotFound = body[DF.delayed]
+	const delayed = body[DF.delayed]
 	const broker = findStaticBrokerByRoute(body[DF.routeUrlMask])
 
 	if (!broker) // TESTME
 		sendUnprocessableContent(response, `Route does not exist: ${body[DF.routeUrlMask]}`)
-	else if (typeof shouldBeNotFound !== 'boolean')
-		sendUnprocessableContent(response, `Expected a boolean for "delayed"`) // TESTME
+	else if (typeof delayed !== 'boolean')
+		sendUnprocessableContent(response, `Expected a boolean for "delayed". Received ${delayed}`) // TESTME
 	else {
-		broker.updateDelayed(body[DF.delayed])
+		broker.setDelayed(delayed)
 		sendOK(response)
 	}
 }

package/src/ApiConstants.js

@@ -11,11 +11,11 @@ export const API = {
 	fallback: MOUNT + '/fallback',
 	globalDelay: MOUNT + '/global-delay',
 	mocks: MOUNT + '/mocks',
-	notFoundStatic: MOUNT + '/not-found-static',
 	proxied: MOUNT + '/proxied',
 	reset: MOUNT + '/reset',
 	select: MOUNT + '/select',
 	static: MOUNT + '/static',
+	staticStatus: MOUNT + '/static-status',
 	syncVersion: MOUNT + '/sync_version'
 }
 
@@ -24,7 +24,7 @@ export const DF = { // Dashboard Fields (XHR)
 	routeUrlMask: 'route_url_mask',
 	delayed: 'delayed',
 	proxied: 'proxied',
-	shouldBeNotFound: 'should_be_not_found',
+	statusCode: 'status_code',
 	syncVersion: 'last_received_sync_version'
 }
 

package/src/Commander.js

@@ -44,10 +44,10 @@ export class Commander {
 		})
 	}
 
-	setStaticRouteIs404(routeUrlMask, shouldBeNotFound) {
-		return this.#patch(API.notFoundStatic, {
+	setStaticRouteStatus(routeUrlMask, status) {
+		return this.#patch(API.staticStatus, {
 			[DF.routeUrlMask]: routeUrlMask,
-			[DF.shouldBeNotFound]: shouldBeNotFound
+			[DF.statusCode]: status
 		})
 	}
 

package/src/Dashboard.js

@@ -66,12 +66,10 @@ const CSS = {
 
 const r = createElement
 const s = createSvgElement
-const mockaton = new Commander(window.location.origin)
 
-const SPINNER_DELAY = 180
+const mockaton = new Commander(window.location.origin)
 let globalDelay = 1200
 
-
 init()
 initLongPoll()
 
@@ -89,7 +87,7 @@ function init() {
 		.catch(onError)
 }
 
-function App([brokersByMethod, cookies, comments, delay, collectProxied, fallbackAddress, staticFiles]) {
+function App([brokersByMethod, cookies, comments, delay, collectProxied, fallbackAddress, staticBrokers]) {
 	globalDelay = delay
 	return (
 		r('div', null,
@@ -97,7 +95,7 @@ function App([brokersByMethod, cookies, comments, delay, collectProxied, fallbac
 			r('main', { className: CSS.Main },
 				r('div', null,
 					r(MockList, { brokersByMethod, canProxy: Boolean(fallbackAddress) }),
-					r(StaticFilesList, { staticFiles })),
+					r(StaticFilesList, { brokers: staticBrokers })),
 				r(PayloadViewer))))
 }
 
@@ -302,6 +300,7 @@ function PreviewLink({ method, urlMask, urlMaskDittoed }) {
 			: tail))
 }
 
+/** @param {{ broker: MockBroker }} props */
 function MockSelector({ broker }) {
 	function onChange() {
 		const { urlMask, method } = parseFilename(this.value)
@@ -338,6 +337,7 @@ function MockSelector({ broker }) {
 			}, file))))
 }
 
+/** @param {{ broker: MockBroker }} props */
 function DelayRouteToggler({ broker }) {
 	function onChange() {
 		const { method, urlMask } = parseFilename(broker.mocks[0])
@@ -356,6 +356,7 @@ function DelayRouteToggler({ broker }) {
 			TimerIcon()))
 }
 
+/** @param {{ broker: MockBroker }} props */
 function InternalServerErrorToggler({ broker }) {
 	function onChange() {
 		const { urlMask, method } = parseFilename(broker.mocks[0])
@@ -381,6 +382,7 @@ function InternalServerErrorToggler({ broker }) {
 			r('span', null, '500')))
 }
 
+/** @param {{ broker: MockBroker, disabled: boolean }} props */
 function ProxyToggler({ broker, disabled }) {
 	function onChange() {
 		const { urlMask, method } = parseFilename(broker.mocks[0])
@@ -404,32 +406,34 @@ function ProxyToggler({ broker, disabled }) {
 }
 
 
-
-/** # StaticFilesList */
-
-function StaticFilesList({ staticFiles }) {
-	if (!Object.keys(staticFiles).length)
+/**
+ * # StaticFilesList
+ * @param {{ brokers: StaticBroker[] }} props
+ */
+function StaticFilesList({ brokers }) {
+	if (!Object.keys(brokers).length)
 		return null
-	const paths = dittoSplitPaths(Object.keys(staticFiles)).map(([ditto, tail]) => ditto
+	const dp = dittoSplitPaths(Object.keys(brokers)).map(([ditto, tail]) => ditto
 		? [r('span', null, ditto), tail]
 		: tail)
 	return (
 		r('table', { className: CSS.StaticFilesList },
 			r('tbody', null,
 				r('th', { colspan: 4 }, Strings.static_get),
-				Object.values(staticFiles).map((broker, i) =>
+				Object.values(brokers).map((broker, i) =>
 					r('tr', null,
 						r('td', null, r(ProxyStaticToggler, {})),
 						r('td', null, r(DelayStaticRouteToggler, { broker })),
 						r('td', null, r(NotFoundToggler, { broker })),
-						r('td', null, r('a', { href: broker.file, target: '_blank' }, paths[i]))
+						r('td', null, r('a', { href: broker.route, target: '_blank' }, dp[i]))
 					)))))
 }
 
 
+/** @param {{ broker: StaticBroker }} props */
 function DelayStaticRouteToggler({ broker }) {
 	function onChange() {
-		mockaton.setStaticRouteIsDelayed(broker.file, this.checked)
+		mockaton.setStaticRouteIsDelayed(broker.route, this.checked)
 			.catch(onError)
 	}
 	return (
@@ -445,9 +449,10 @@ function DelayStaticRouteToggler({ broker }) {
 			TimerIcon()))
 }
 
+/** @param {{ broker: StaticBroker }} props */
 function NotFoundToggler({ broker }) {
 	function onChange() {
-		mockaton.setStaticRouteIs404(broker.file, this.checked)
+		mockaton.setStaticRouteStatus(broker.route, this.checked ? 404 : 200)
 			.catch(onError)
 	}
 	return (
@@ -457,15 +462,13 @@ function NotFoundToggler({ broker }) {
 			},
 			r('input', {
 				type: 'checkbox',
-				checked: broker.should404,
+				checked: broker.status === 404,
 				onChange
 			}),
 			r('span', null, '404')))
 }
 
-
-// TODO
-function ProxyStaticToggler({}) {
+function ProxyStaticToggler({}) { // TODO
 	function onChange() {
 	}
 	return (
@@ -523,7 +526,7 @@ function PayloadViewerTitleWhenProxied({ mime, status, statusText, gatewayIsBad
 }
 
 async function previewMock(method, urlMask, href) {
-	const timer = setTimeout(renderSpinner, SPINNER_DELAY)
+	const timer = setTimeout(renderSpinner, 180)
 	const response = await fetch(href, { method })
 	clearTimeout(timer)
 	await updatePayloadViewer(method, urlMask, response)

package/src/MockBroker.js

@@ -83,11 +83,11 @@ export class MockBroker {
 		this.currentMock.file = filename
 	}
 
-	updateDelayed(delayed) {
+	setDelayed(delayed) {
 		this.currentMock.delayed = delayed
 	}
 
-	updateProxied(proxied) {
+	setProxied(proxied) {
 		if (proxied)
 			this.selectFile('')
 		else

package/src/Mockaton.js

@@ -54,7 +54,7 @@ async function onRequest(req, response) {
 		else if (method === 'GET' && apiGetRequests.has(url))
 			apiGetRequests.get(url)(req, response)
 
-		else if (method === 'GET' && findStaticBrokerByRoute(req.url))
+		else if (method === 'GET' && findStaticBrokerByRoute(url))
 			await dispatchStatic(req, response)
 
 		else

package/src/StaticDispatcher.js

@@ -1,37 +1,24 @@
-import { join, basename } from 'node:path'
 import { readFileSync } from 'node:fs'
+import { join, basename } from 'node:path'
 
 import { mimeFor } from './utils/mime.js'
+import { listFilesRecursively } from './utils/fs.js'
 import { config, isFileAllowed, calcDelay } from './config.js'
 import { sendPartialContent, sendNotFound } from './utils/http-response.js'
-import { isDirectory, isFile, listFilesRecursively } from './utils/fs.js'
 
 
 class StaticBroker {
-	constructor(file) {
-		this.file = file
+	constructor(route) {
+		this.route = route
 		this.delayed = false
-		this.should404 = false
-		this.resolvedPath = this.#staticFilePath()
-	}
-
-	#staticFilePath() { // url is absolute e.g. /home/../.. => /
-		let candidate = join(config.staticDir, this.file)
-		if (isDirectory(candidate))
-			candidate = join(candidate, 'index.html')
-		if (isFile(candidate))
-			return candidate
-	}
-
-	updateDelayed(value) {
-		this.delayed = value
+		this.status = 200 // 200 or 404
 	}
 
-	updateNotFound(value) {
-		this.should404 = value
-	}
+	setDelayed(value) { this.delayed = value }
+	setStatus(value) { this.status = value }
 }
 
+/** @type {{ [route: string]: StaticBroker }} */
 let collection = {}
 
 export function initStaticCollection() {
@@ -41,23 +28,27 @@ export function initStaticCollection() {
 		.forEach(registerStaticMock)
 }
 
+
 /** @returns {boolean} registered */
-export function registerStaticMock(file) {
-	if (!isFileAllowed(basename(file)))
+export function registerStaticMock(relativeFile) {
+	if (!isFileAllowed(basename(relativeFile)))
 		return false
 
-	file = '/' + file
-	if (findStaticBrokerByRoute(file))
+	const route = '/' + relativeFile
+	if (findStaticBrokerByRoute(route))
 		return false
 
-	collection[file] = new StaticBroker(file)
+	collection[route] = new StaticBroker(route)
 	return true
 }
 
-export function unregisterStaticMock(file) {
-	delete collection['/' + file]
+
+export function unregisterStaticMock(relativeFile) {
+	delete collection['/' + relativeFile]
 }
 
+
+/** @returns {StaticBroker | undefined} */
 export function findStaticBrokerByRoute(route) {
 	return collection[route] || collection[join(route, 'index.html')]
 }
@@ -66,15 +57,16 @@ export function getStaticFilesCollection() {
 	return collection
 }
 
+
 export async function dispatchStatic(req, response) {
 	const broker = findStaticBrokerByRoute(req.url)
 
 	setTimeout(async () => {
-		if (!broker || broker.should404) { // TESTME
+		if (!broker || broker.status === 404) { // TESTME
 			sendNotFound(response)
 			return
 		}
-		const file = broker.resolvedPath
+		const file = join(config.staticDir, broker.route)
 		if (req.headers.range)
 			await sendPartialContent(response, req.headers.range, file)
 		else {

package/src/mockBrokersCollection.js

@@ -1,3 +1,5 @@
+import { basename } from 'node:path'
+
 import { cookie } from './cookie.js'
 import { MockBroker } from './MockBroker.js'
 import { listFilesRecursively } from './utils/fs.js'
@@ -38,7 +40,7 @@ export function init() {
 /** @returns {boolean} registered */
 export function registerMock(file, isFromWatcher = false) {
 	if (findBrokerByFilename(file)?.hasMock(file)
-		|| !isFileAllowed(file)
+		|| !isFileAllowed(basename(file)) // TESTME
 		|| !filenameIsValid(file))
 		return false