mockaton 13.11.1 → 13.11.3

package/src/server/Api.js

@@ -3,36 +3,36 @@
  * selecting a specific mock-file for a particular route.
  */
 
-import { join } from 'node:path'
-import { write, rm, isFile, resolveIn, listFilesRecursively } from './utils/fs.js'
-
-import openapi from '../../www/src/assets/openapi.json' with { type: 'json' }
-import pkgJSON from '../../package.json' with { type: 'json' }
+import { join, relative } from 'node:path'
 
+import { write, rm, isFile, resolveIn } from './utils/fs.js'
+import { removeQueryStringAndFragment } from './utils/HttpIncomingMessage.js'
 import { sseClientHotReload } from './utils/WatcherDevClient.js'
-import { stopMocksDirWatcher, sseClientSyncVersion, uiSyncVersion, watchMocksDir } from './Watcher.js'
+
+import pkgJSON from '../../package.json' with { type: 'json' }
+import openapi from '../../www/src/assets/openapi.json' with { type: 'json' }
 
 import { API } from '../client/ApiConstants.js'
 import { IndexHtml, CSP } from '../client/IndexHtml.js'
 
-import { cookie } from './cookie.js'
-import { config, ConfigValidator } from './config.js'
-import * as mockBrokersCollection from './mockBrokersCollection.js'
-import { removeQueryStringAndFragment } from './utils/HttpIncomingMessage.js'
+import { cookie } from './stores/cookies.js'
+import { config, ConfigValidator, reinitConfig } from './stores/config.js'
+import * as brokers from './stores/brokers.js'
+import * as Watcher  from './stores/Watcher.js'
 
 
 export const CLIENT_ASSETS = join(import.meta.dirname, '../client')
 
-const getReqs = new Map([
-	[API.dashboard, serveDashboard],
+const headReqs = new Map([
+	[API.health, (_, response) => response.ok()]
+])
 
-	...listFilesRecursively(CLIENT_ASSETS).map(f => [
-		API.dashboard + '/' + f,
-		serveDashboardAsset(f)
-	]),
+const getReqs = new Map([
+	...headReqs.entries(),
 
+	[API.root, serveDashboard],
 	[API.state, getState],
-	[API.syncVersion, sseClientSyncVersion],
+	[API.syncVersion, Watcher.sseClientSyncVersion],
 
 	[API.watchHotReload, onDevWatch],
 	[API.openAPI, (_, response) => response.json(openapi)],
@@ -62,20 +62,25 @@ const patchReqs = new Map([
 ])
 
 export async function handleApiRequest(req, response) {
-	const url = removeQueryStringAndFragment(req.url)
+	if (!req.url.startsWith(API.root))
+		return false
 
-	if ((req.method === 'GET' || req.method === 'HEAD') && url === API.health) {
-		response.ok()
-		return
-	}
+	const url = removeQueryStringAndFragment(req.url)
 
 	const handler = (
 		req.method === 'GET' && getReqs.get(url) ||
+		req.method === 'HEAD' && headReqs.get(url) ||
 		req.method === 'PATCH' && patchReqs.get(url))
 	if (handler) {
 		await handler(req, response)
 		return true
 	}
+
+	if (req.method === 'GET') { // serve static dashboard assets dir
+		const f = await resolveIn(CLIENT_ASSETS, relative(API.root, url))
+		await response.file(f)
+		return true
+	}
 }
 
 
@@ -85,18 +90,13 @@ function serveDashboard(_, response) {
 	response.html(IndexHtml(config.hotReload, pkgJSON.version), CSP)
 }
 
-function serveDashboardAsset(f) {
-	return async (_, response) => {
-		await response.file(join(CLIENT_ASSETS, f))
-	}
-}
 
 function getState(_, response) {
 	response.json({
 		cookies: cookie.list(),
-		comments: mockBrokersCollection.extractAllComments(),
+		comments: brokers.extractAllComments(),
 
-		brokersByMethod: mockBrokersCollection.all(),
+		brokersByMethod: brokers.all(),
 
 		delay: config.delay,
 		delayJitter: config.delayJitter,
@@ -118,10 +118,11 @@ function onDevWatch(req, response) {
 /** # PATCH */
 
 function reset(_, response) {
-	mockBrokersCollection.init()
+	reinitConfig()
+	brokers.init()
 	cookie.init(config.cookies)
 	response.ok()
-	uiSyncVersion.increment()
+	Watcher.emitChange()
 }
 
 
@@ -133,7 +134,7 @@ async function setCorsAllowed(req, response) {
 	else {
 		config.corsAllowed = corsAllowed
 		response.ok()
-		uiSyncVersion.increment()
+		Watcher.emitChange()
 	}
 }
 
@@ -146,7 +147,7 @@ async function setGlobalDelay(req, response) {
 	else {
 		config.delay = delay
 		response.ok()
-		uiSyncVersion.increment()
+		Watcher.emitChange()
 	}
 }
 
@@ -158,7 +159,7 @@ async function setGlobalDelayJitter(req, response) {
 	else {
 		config.delayJitter = jitter
 		response.ok()
-		uiSyncVersion.increment()
+		Watcher.emitChange()
 	}
 }
 
@@ -170,7 +171,7 @@ async function selectCookie(req, response) {
 		response.unprocessable(error?.message || error)
 	else {
 		response.json(cookie.list())
-		uiSyncVersion.increment()
+		Watcher.emitChange()
 	}
 }
 
@@ -183,7 +184,7 @@ async function setProxyFallback(req, response) {
 	else {
 		config.proxyFallback = fallback
 		response.ok()
-		uiSyncVersion.increment()
+		Watcher.emitChange()
 	}
 }
 
@@ -195,7 +196,7 @@ async function setCollectProxied(req, response) {
 	else {
 		config.collectProxied = collectProxied
 		response.ok()
-		uiSyncVersion.increment()
+		Watcher.emitChange()
 	}
 }
 
@@ -203,41 +204,41 @@ async function setCollectProxied(req, response) {
 
 async function bulkUpdateBrokersByCommentTag(req, response) {
 	const comment = await req.json()
-	mockBrokersCollection.setMocksMatchingComment(comment)
+	brokers.setMocksMatchingComment(comment)
 	response.ok()
-	uiSyncVersion.increment()
+	Watcher.emitChange()
 }
 
 
 async function selectMock(req, response) {
 	const file = await req.json()
-	const broker = mockBrokersCollection.brokerByFilename(file)
+	const broker = brokers.brokerByFilename(file)
 	if (!broker || !broker.hasMock(file))
 		response.unprocessable(`Missing Mock: ${file}`)
 	else {
 		broker.selectFile(file)
 		response.json(broker)
-		uiSyncVersion.increment()
+		Watcher.emitChange()
 	}
 }
 
 
 async function toggleRouteStatus(req, response) {
 	const [method, urlMask, status] = await req.json()
-	const broker = mockBrokersCollection.brokerByRoute(method, urlMask)
+	const broker = brokers.brokerByRoute(method, urlMask)
 	if (!broker)
 		response.unprocessable(`Route does not exist: ${method} ${urlMask}`)
 	else {
 		broker.toggleStatus(status)
 		response.json(broker)
-		uiSyncVersion.increment()
+		Watcher.emitChange()
 	}
 }
 
 
 async function setRouteIsDelayed(req, response) {
 	const [method, urlMask, delayed] = await req.json()
-	const broker = mockBrokersCollection.brokerByRoute(method, urlMask)
+	const broker = brokers.brokerByRoute(method, urlMask)
 	if (!broker)
 		response.unprocessable(`Route does not exist: ${method} ${urlMask}`)
 	else if (typeof delayed !== 'boolean')
@@ -245,14 +246,14 @@ async function setRouteIsDelayed(req, response) {
 	else {
 		broker.setDelayed(delayed)
 		response.json(broker)
-		uiSyncVersion.increment()
+		Watcher.emitChange()
 	}
 }
 
 
 async function setRouteIsProxied(req, response) {
 	const [method, urlMask, proxied] = await req.json()
-	const broker = mockBrokersCollection.brokerByRoute(method, urlMask)
+	const broker = brokers.brokerByRoute(method, urlMask)
 	if (!broker)
 		response.unprocessable(`Route does not exist: ${method} ${urlMask}`)
 	else if (typeof proxied !== 'boolean')
@@ -262,7 +263,7 @@ async function setRouteIsProxied(req, response) {
 	else {
 		broker.setProxied(proxied)
 		response.json(broker)
-		uiSyncVersion.increment()
+		Watcher.emitChange()
 	}
 }
 
@@ -282,8 +283,8 @@ async function writeMock(req, response) {
 	await write(path, content)
 
 	if (!config.watcherEnabled) {
-		mockBrokersCollection.registerMock(file, true)
-		uiSyncVersion.increment()
+		brokers.registerMock(file, true)
+		Watcher.emitChange()
 	}
 	response.ok()
 }
@@ -305,8 +306,8 @@ async function deleteMock(req, response) {
 	await rm(path)
 
 	if (!config.watcherEnabled) {
-		mockBrokersCollection.unregisterMock(file)
-		uiSyncVersion.increment()
+		brokers.unregisterMock(file)
+		Watcher.emitChange()
 	}
 	response.ok()
 }
@@ -319,9 +320,9 @@ async function setWatchMocks(req, response) {
 		response.unprocessable(`Expected boolean for "watchMocks"`)
 	else {
 		if (enabled)
-			watchMocksDir()
+			Watcher.watchMocksDir()
 		else
-			stopMocksDirWatcher()
+			Watcher.unwatchMocksDir()
 		response.ok()
 	}
 }

package/src/server/MockDispatcher.js

@@ -1,12 +1,13 @@
 import { join } from 'node:path'
 
-import { logger } from './utils/logger.js'
 import { proxy } from './ProxyRelay.js'
-import { cookie } from './cookie.js'
-import { parseFilename } from '../client/Filename.js'
+import { cookie } from './stores/cookies.js'
 import { echoFilePlugin } from './MockDispatcherPlugins.js'
-import { brokerByRoute } from './mockBrokersCollection.js'
-import { config, calcDelay } from './config.js'
+import { brokerByRoute } from './stores/brokers.js'
+import { config, calcDelay } from './stores/config.js'
+
+import { logger } from './utils/logger.js'
+import { parseFilename } from '../client/Filename.js'
 
 
 export async function dispatchMock(req, response) {

package/src/server/Mockaton.js

@@ -7,29 +7,28 @@ import { logger } from './utils/logger.js'
 import { ServerResponse } from './utils/HttpServerResponse.js'
 import { setCorsHeaders, isPreflight } from './utils/http-cors.js'
 import { IncomingMessage, BodyReaderError, hasControlChars } from './utils/HttpIncomingMessage.js'
+import { watchDevSPA } from './utils/WatcherDevClient.js'
 
 import { API } from '../client/ApiConstants.js'
-import { cookie } from './cookie.js'
-import { config, setup } from './config.js'
-import { CLIENT_ASSETS, handleApiRequest } from './Api.js'
 
+import { CLIENT_ASSETS, handleApiRequest } from './Api.js'
+import { cookie } from './stores/cookies.js'
+import { config, initConfig } from './stores/config.js'
+import * as brokers from './stores/brokers.js'
 import { dispatchMock } from './MockDispatcher.js'
-import * as mockBrokerCollection from './mockBrokersCollection.js'
-
-import { watchDevSPA } from './utils/WatcherDevClient.js'
-import { watchMocksDir } from './Watcher.js'
+import { watchMocksDir } from './stores/Watcher.js'
 
 
 export function Mockaton(options) {
 	return new Promise((resolve, reject) => {
-		setup(options)
+		initConfig(options)
 		cookie.init(config.cookies)
-		mockBrokerCollection.init()
+		brokers.init()
 
-		register('./resolverResolveExtensionless.js', import.meta.url)
+		register('./ResolverResolveExtensionless.js', import.meta.url)
 
 		if (config.bypassImportCache)
-			register('./resolverBypassImportCache.js', import.meta.url)
+			register('./ResolverBypassImportCache.js', import.meta.url)
 
 		if (config.watcherEnabled)
 			watchMocksDir()
@@ -41,7 +40,7 @@ export function Mockaton(options) {
 		server.on('error', reject)
 		server.listen(config.port, config.host, () => {
 			const url = `http://${server.address().address}:${server.address().port}`
-			const dashboardUrl = url + API.dashboard
+			const dashboardUrl = url + API.root
 			logger.info('Listening', url)
 			logger.info('Dashboard', dashboardUrl)
 			config.onReady(dashboardUrl)

package/src/server/Mockaton.test.js

@@ -1,3 +1,4 @@
+import fs from 'node:fs/promises'
 import { join } from 'node:path'
 import { spawn } from 'node:child_process'
 import { tmpdir } from 'node:os'
@@ -7,22 +8,32 @@ import { mkdtempSync } from 'node:fs'
 import { randomUUID } from 'node:crypto'
 import { equal, deepEqual, match } from 'node:assert/strict'
 import { describe, test, before, beforeEach, after } from 'node:test'
-import { unlink, mkdir, readFile, rename, readdir, writeFile, rm } from 'node:fs/promises'
 
+import CONFIG from './Mockaton.test.config.js'
+import { config } from './stores/config.js'
 import { mimeFor } from './utils/mime.js'
+import { API } from '../client/ApiConstants.js'
+import { Commander } from '../client/ApiCommander.js'
 import { parseFilename } from '../client/Filename.js'
-import { API, Commander } from '../../index.js'
 
-import CONFIG from './Mockaton.test.config.js'
-import { config } from './config.js'
 
+const mocksDir = new class {
+	value = mkdtempSync(join(tmpdir(), 'mocks'))
+
+	rm = f => fs.unlink(join(this.value, f))
+	read = f => fs.readFile(join(this.value, f), 'utf8')
+	write = (f, data) => fs.writeFile(join(this.value, f), data)
+	rename = (src, target) => fs.rename(join(this.value, src), join(this.value, target))
 
-const mocksDir = mkdtempSync(join(tmpdir(), 'mocks'))
+	list = d => fs.readdir(join(this.value, d))
+	rmdir = d => fs.rm(join(this.value, d), { recursive: true })
+	mkdir = d => fs.mkdir(join(this.value, d), { recursive: true })
+}
 
 const stdout = []
 const stderr = []
 const proc = spawn(join(import.meta.dirname, 'cli.js'), [
-	mocksDir,
+	mocksDir.value,
 	'--config', join(import.meta.dirname, 'Mockaton.test.config.js'),
 	'--no-open'
 ])
@@ -47,17 +58,6 @@ const serverAddr = await new Promise((resolve, reject) => {
 
 after(() => proc.kill('SIGUSR2'))
 
-
-const rmFromMocksDir = f => unlink(join(mocksDir, f))
-const readFromMocksDir = f => readFile(join(mocksDir, f), 'utf8')
-const writeInMocksDir = (f, data) => writeFile(join(mocksDir, f), data)
-const renameInMocksDir = (src, target) => rename(join(mocksDir, src), join(mocksDir, target))
-
-const listFromMocksDir = d => readdir(join(mocksDir, d))
-const rmDirFromMocks = d => rm(join(mocksDir, d), { recursive: true })
-const makeDirInMocks = dir => mkdir(join(mocksDir, dir), { recursive: true })
-
-
 const api = new Commander(serverAddr)
 
 
@@ -224,17 +224,17 @@ describe('CORS', () => {
 
 describe('Dashboard', () => {
 	test('renders', async () => {
-		const r = await request(API.dashboard)
+		const r = await request(API.root)
 		match(await r.text(), new RegExp('<!DOCTYPE html>'))
 	})
 
 	test('query string is accepted', async () => {
-		const r = await request(API.dashboard + '?foo=bar')
+		const r = await request(API.root + '?foo=bar')
 		match(await r.text(), new RegExp('<!DOCTYPE html>'))
 	})
 
 	test('serves assets', async () => {
-		const r = await request(API.dashboard + '/app.css')
+		const r = await request(API.root + '/app.css')
 		match(await r.text(), new RegExp(':root {'))
 	})
 })
@@ -303,6 +303,7 @@ describe('Delay', () => {
 			const r = await api.setGlobalDelayJitter(0.1)
 			equal(r.status, 200)
 			equal((await fetchState()).delayJitter, 0.1)
+			await api.setGlobalDelayJitter(0)
 		})
 	})
 
@@ -388,14 +389,14 @@ describe('Proxy Fallback', () => {
 			deepEqual(await r2.json(), BODY_PAYLOAD)
 			deepEqual(await r1.json(), BODY_PAYLOAD)
 
-			const savedMocks = await listFromMocksDir('non-existing-mock')
+			const savedMocks = await mocksDir.list('non-existing-mock')
 			equal(savedMocks.length, 2)
 
-			equal(await readFromMocksDir('non-existing-mock/[id].POST.423.json'), expectedBody)
+			equal(await mocksDir.read('non-existing-mock/[id].POST.423.json'), expectedBody)
 			for (const m of savedMocks) {
 				const f = join('non-existing-mock', m)
-				equal(await readFromMocksDir(f), expectedBody)
-				await rmFromMocksDir(f)
+				equal(await mocksDir.read(f), expectedBody)
+				await mocksDir.rm(f)
 			}
 		})
 	})
@@ -919,7 +920,7 @@ describe('Dynamic Params', () => {
 	const fx2 = new Fixture('dynamic-params/[id]/suffix/[id].GET.200.txt')
 	const fx3 = new Fixture('dynamic-params/exact-route.GET.200.txt')
 	before(async () => {
-		await makeDirInMocks('dynamic-params/[id]/suffix/[id]')
+		await mocksDir.mkdir('dynamic-params/[id]/suffix/[id]')
 		await fx0.write()
 		await fx1.write()
 		await fx2.write()
@@ -955,7 +956,7 @@ describe('Dynamic Params', () => {
 
 test('Dynamic Params on partial segments', async () => {
 	const fx = new Fixture('dynamic-params-partial-[id]/foo.GET.200.txt')
-	await makeDirInMocks('dynamic-params-partial-[id]')
+	await mocksDir.mkdir('dynamic-params-partial-[id]')
 	await fx.write()
 	const r = await request('/dynamic-params-partial-999/foo')
 	equal(await r.text(), fx.body)
@@ -967,7 +968,7 @@ describe('Query String', () => {
 	const fx0 = new Fixture('query-string?foo=[foo]&bar=[bar].GET.200.json')
 	const fx1 = new Fixture('query-string/[id]?limit=[limit].GET.200.json')
 	before(async () => {
-		await makeDirInMocks('query-string')
+		await mocksDir.mkdir('query-string')
 		await fx0.write()
 		await fx1.write()
 		await api.reset()
@@ -1126,10 +1127,10 @@ describe('Registering Mocks', () => {
 	test('when watcher is off, newly added mocks do not get registered', async () => {
 		await api.setWatchMocks(false)
 		const fx = new FixtureExternal('non-auto-registered-file.GET.200.json')
-		await writeInMocksDir(fx.file, fx.body)
+		await mocksDir.write(fx.file, fx.body)
 		await sleep(100)
 		equal(await fx.fetchBroker(), undefined)
-		await rmFromMocksDir(fx.file)
+		await mocksDir.rm(fx.file)
 	})
 
 	test('register', async () => {
@@ -1175,27 +1176,27 @@ describe('Registering Mocks', () => {
 		const fx0 = new FixtureExternal('reg0/runtime0.GET.200.txt')
 		let version
 		before(async () => {
-			await makeDirInMocks('reg0')
-			await writeInMocksDir(fx0.file, fx0.body)
+			await mocksDir.mkdir('reg0')
+			await mocksDir.write(fx0.file, fx0.body)
 			version = await resolveOnNextSyncVersion(-1)
 		})
 
 		const fx = new FixtureExternal('runtime1.GET.200.txt')
 		test('responds when a file is added', async () => {
 			const prom = resolveOnNextSyncVersion(version)
-			await writeInMocksDir(fx.file, fx.body)
+			await mocksDir.write(fx.file, fx.body)
 			equal(await prom, version + 1)
 		})
 
 		test('responds when a file is deleted', async () => {
 			const prom = resolveOnNextSyncVersion(version + 1)
-			await rmFromMocksDir(fx.file)
+			await mocksDir.rm(fx.file)
 			equal(await prom, version + 2)
 		})
 
 		test('responds when dir is renamed', async () => {
 			const prom = resolveOnNextSyncVersion(version + 2)
-			await renameInMocksDir('reg0', 'reg1')
+			await mocksDir.rename('reg0', 'reg1')
 			equal(await prom, version + 3)
 
 			const s = await fetchState()
@@ -1208,7 +1209,7 @@ describe('Registering Mocks', () => {
 		await fx.writeExternally()
 		config.watcherDebounceMs = 100 // Because on macOS rmdir triggers a few events
 		const nextVerPromise = resolveOnNextSyncVersion()
-		await rmDirFromMocks('api/bulk-delete')
+		await mocksDir.rmdir('api/bulk-delete')
 		await nextVerPromise
 		equal(await fx.fetchBroker(), undefined)
 		await sleep(50) // Only for Docker, not sure why we need to delay the server teardown 
@@ -1220,24 +1221,37 @@ describe('Registering Mocks', () => {
  * This is for listening to real-time updates. It responds when a new mock is added, deleted, or renamed. */
 async function resolveOnNextSyncVersion(currSyncVer = undefined) {
 	let skipFirst = currSyncVer === undefined
-	const response = await api.getSyncVersion()
-	const stream = response.body.pipeThrough(new TextDecoderStream())
+	const reader = (await api.getSyncVersion())
+		.body.pipeThrough(new TextDecoderStream())
+		.getReader()
 	let buffer = ''
 
-	for await (const chunk of stream) {
-		buffer += chunk
-		const parts = buffer.split('\n\n')
-		buffer = parts.pop() || ''
-
-		for (const event of parts)
-			for (const line of event.split(/\r?\n/))
-				if (line.startsWith('data:')) {
-					const v = Number(line.slice(5).trim())
-					if (skipFirst || v === currSyncVer)
-						skipFirst = false
-					else
-						return v
-				}
+	try {
+		while (true) {
+			try {
+				const { done, value } = await reader.read()
+				if (done) break
+				buffer += value
+			}
+			catch {
+				break
+			}
+			const parts = buffer.split('\n\n')
+			buffer = parts.pop() || ''
+
+			for (const event of parts)
+				for (const line of event.split(/\r?\n/))
+					if (line.startsWith('data:')) {
+						const v = Number(line.slice(5).trim())
+						if (skipFirst || v === currSyncVer)
+							skipFirst = false
+						else
+							return v
+					}
+		}
+	}
+	finally {
+		reader.cancel().catch(() => {})
 	}
 }
 

package/src/server/ProxyRelay.js

@@ -4,12 +4,13 @@ import { randomUUID } from 'node:crypto'
 import { extFor } from './utils/mime.js'
 import { write, isFile, resolveIn } from './utils/fs.js'
 import { BodyReaderError } from './utils/HttpIncomingMessage.js'
-
-import { config } from './config.js'
 import { logger } from './utils/logger.js'
+
 import { makeMockFilename } from '../client/Filename.js'
 import { EXT_EMPTY, EXT_UNKNOWN_MIME } from '../client/ApiConstants.js'
 
+import { config } from './stores/config.js'
+
 
 export async function proxy(req, response, delay) {
 	let proxyResponse

package/src/server/UrlParsers.js

@@ -1,5 +1,5 @@
 import { relative } from 'node:path'
-import { config } from './config.js'
+import { config } from './stores/config.js'
 import { decode, removeQueryStringAndFragment } from './utils/HttpIncomingMessage.js'
 import { parseFilename, removeTrailingSlash } from '../client/Filename.js'
 

package/src/server/UrlParsers.test.js

@@ -1,7 +1,7 @@
 import { test, describe } from 'node:test'
 import { deepEqual, equal } from 'node:assert/strict'
 import { parseSegments, parseQueryParams } from './UrlParsers.js'
-import { config } from './config.js'
+import { config } from './stores/config.js'
 
 test('parseQueryParams', () => {
 	const searchParams = parseQueryParams('/api/foo?limit=123')