mockaton 12.7.0 → 12.7.1

package/src/server/Mockaton.test.js

@@ -53,6 +53,7 @@ const renameInStaticMocksDir = (src, target) => rename(join(staticDir, src), joi
 
 const api = new Commander(serverAddr)
 
+
 /** @returns {Promise<State>} */
 async function fetchState() {
 	return (await api.getState()).json()
@@ -78,14 +79,14 @@ class BaseFixture {
 	}
 
 	async register() {
-		const nextVerPromise = api.getSyncVersion()
+		const nextVerPromise = resolveOnNextSyncVersion()
 		await this.#nextMacroTask()
 		await this.write()
 		await nextVerPromise
 	}
 
 	async unregister() {
-		const nextVerPromise = api.getSyncVersion()
+		const nextVerPromise = resolveOnNextSyncVersion()
 		await this.#nextMacroTask()
 		await this.unlink()
 		await nextVerPromise
@@ -1109,38 +1110,30 @@ describe('Registering Mocks', () => {
 
 	describe('getSyncVersion', () => {
 		const fx0 = new Fixture('reg0/runtime0.GET.200.txt')
+		let version
 		before(async () => {
 			await makeDirInMocks('reg0')
 			await fx0.sync()
-		})
-
-		let version
-
-		test('getSyncVersion responds immediately when version mismatches', async () => {
-			const r = await api.getSyncVersion(-1)
-			version = await r.json()
+			version = await resolveOnNextSyncVersion(-1)
 		})
 
 		const fx = new Fixture('runtime1.GET.200.txt')
 		test('responds when a file is added', async () => {
-			const prom = api.getSyncVersion(version)
+			const prom = resolveOnNextSyncVersion(version)
 			await fx.write()
-			const r = await prom
-			equal(await r.json(), version + 1)
+			equal(await prom, version + 1)
 		})
 
 		test('responds when a file is deleted', async () => {
-			const prom = api.getSyncVersion(version + 1)
+			const prom = resolveOnNextSyncVersion(version + 1)
 			await fx.unlink()
-			const r = await prom
-			equal(await r.json(), version + 2)
+			equal(await prom, version + 2)
 		})
 
 		test('responds when dir is renamed', async () => {
-			const p0 = api.getSyncVersion(version + 2)
+			const p0 = resolveOnNextSyncVersion(version + 2)
 			await renameInMocksDir('reg0', 'reg1')
-			const r0 = await p0
-			equal(await r0.json(), version + 3)
+			equal(await p0, version + 3)
 
 			const s = await fetchState()
 			equal(s.brokersByMethod.GET['/reg1/runtime0'].file, 'reg1/runtime0.GET.200.txt')
@@ -1185,38 +1178,30 @@ describe('Registering Static Mocks', () => {
 
 	describe('getSyncVersion', () => {
 		const fx0 = new FixtureStatic('reg0/static0.txt')
+		let version
 		before(async () => {
 			await makeDirInStaticMocks('reg0')
 			await fx0.sync()
-		})
-
-		let version
-
-		test('getSyncVersion responds immediately when version mismatches', async () => {
-			const r = await api.getSyncVersion(-1)
-			version = await r.json()
+			version = await resolveOnNextSyncVersion(-1)
 		})
 
 		const fx = new FixtureStatic('static1.txt')
 		test('responds when a file is added', async () => {
-			const prom = api.getSyncVersion(version)
+			const prom = resolveOnNextSyncVersion(version)
 			await fx.write()
-			const r = await prom
-			equal(await r.json(), version + 1)
+			equal(await prom, version + 1)
 		})
 
 		test('responds when a file is deleted', async () => {
-			const prom = api.getSyncVersion(version + 1)
+			const prom = resolveOnNextSyncVersion(version + 1)
 			await fx.unlink()
-			const r = await prom
-			equal(await r.json(), version + 2)
+			equal(await prom, version + 2)
 		})
 
 		test('responds when dir is renamed', async () => {
-			const p0 = api.getSyncVersion(version + 2)
+			const p0 = resolveOnNextSyncVersion(version + 2)
 			await renameInStaticMocksDir('reg0', 'reg1')
-			const r0 = await p0
-			equal(await r0.json(), version + 3)
+			equal(await p0, version + 3)
 
 			const s = await fetchState()
 			equal(s.staticBrokers['/reg1/static0.txt'].route, '/reg1/static0.txt')
@@ -1228,3 +1213,29 @@ describe('Registering Static Mocks', () => {
 async function sleep(ms = 100) {
 	await new Promise(resolve => setTimeout(resolve, ms))
 }
+
+
+/** In Node, there's no EventSource, so we work around it like this.
+ * 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())
+	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
+				}
+	}
+}

package/src/server/Watcher.js

@@ -2,11 +2,6 @@ import { join } from 'node:path'
 import { watch } from 'node:fs'
 import { EventEmitter } from 'node:events'
 
-import {
-	HEADER_SYNC_VERSION,
-	LONG_POLL_SERVER_TIMEOUT
-} from '../client/ApiConstants.js'
-
 import { config } from './config.js'
 import { isFile, isDirectory } from './utils/fs.js'
 
@@ -33,7 +28,7 @@ const uiSyncVersion = new class extends EventEmitter {
 	})
 
 	subscribe(listener) {
-		this.once('ARR', listener)
+		this.on('ARR', listener)
 	}
 	unsubscribe(listener) {
 		this.removeListener('ARR', listener)
@@ -98,24 +93,33 @@ export function watchStaticDir() {
 }
 
 
+
 /** Realtime notify ARR Events */
-export function longPollClientSyncVersion(req, response) {
-	const clientVersion = req.headers[HEADER_SYNC_VERSION]
-	if (clientVersion !== undefined && uiSyncVersion.version !== Number(clientVersion)) {
-		// e.g., tab was hidden while new mocks were added or removed
-		response.json(uiSyncVersion.version)
-		return
+export function sseClientSyncVersion(req, response) {
+	response.writeHead(200, {
+		'Content-Type': 'text/event-stream',
+		'Cache-Control': 'no-cache',
+		'Connection': 'keep-alive',
+	})
+	response.flushHeaders()
+
+	function sendVersion() {
+		response.write(`data: ${uiSyncVersion.version}\n\n`)
 	}
-	function onARR() {
-		uiSyncVersion.unsubscribe(onARR)
-		response.json(uiSyncVersion.version)
+
+	sendVersion()
+	uiSyncVersion.subscribe(sendVersion)
+
+	const keepAlive = setInterval(() => {
+		response.write(': ping\n\n')
+	}, 10_000)
+	
+	req.on('close', cleanup)
+	req.on('error', cleanup)
+	function cleanup() {
+		clearInterval(keepAlive)
+		uiSyncVersion.unsubscribe(sendVersion)
 	}
-	response.setTimeout(LONG_POLL_SERVER_TIMEOUT, onARR)
-	req.on('error', () => {
-		uiSyncVersion.unsubscribe(onARR)
-		response.destroy()
-	})
-	uiSyncVersion.subscribe(onARR)
 }
 
 

package/src/server/WatcherDevClient.js

@@ -3,7 +3,6 @@ import { EventEmitter } from 'node:events'
 import { watch, readdirSync } from 'node:fs'
 
 import { config } from './config.js'
-import { LONG_POLL_SERVER_TIMEOUT } from '../client/ApiConstants.js'
 
 
 export const CLIENT_DIR = join(import.meta.dirname, '../client')
@@ -12,7 +11,7 @@ export const DASHBOARD_ASSETS = readdirSync(CLIENT_DIR)
 
 const devClientWatcher = new class extends EventEmitter {
 	emit(file) { super.emit('RELOAD', file) }
-	subscribe(listener) { this.once('RELOAD', listener) }
+	subscribe(listener) { this.on('RELOAD', listener) }
 	unsubscribe(listener) { this.removeListener('RELOAD', listener) }
 }
 
@@ -27,23 +26,33 @@ export function watchDevSPA() {
 
 
 /** Realtime notify Dev UI changes */
-export function longPollDevClientHotReload(req, response) {
+export function sseClientHotReload(req, response) {
 	if (!config.hotReload) {
 		response.notFound()
 		return
 	}
 
-	function onDevChange(file) {
-		devClientWatcher.unsubscribe(onDevChange)
-		response.json(file)
-	}
-	response.setTimeout(LONG_POLL_SERVER_TIMEOUT, () => {
-		devClientWatcher.unsubscribe(onDevChange)
-		response.json('')
-	})
-	req.on('error', () => {
-		devClientWatcher.unsubscribe(onDevChange)
-		response.destroy()
+	response.writeHead(200, {
+		'Content-Type': 'text/event-stream',
+		'Cache-Control': 'no-cache',
+		'Connection': 'keep-alive',
 	})
+	response.flushHeaders()
+
+	function onDevChange(file = '') {
+		response.write(`data: ${file}\n\n`)
+	}
+
 	devClientWatcher.subscribe(onDevChange)
+
+	const keepAlive = setInterval(() => {
+		response.write(': ping\n\n')
+	}, 10_000)
+
+	req.on('close', cleanup)
+	req.on('error', cleanup)
+	function cleanup() {
+		clearInterval(keepAlive)
+		devClientWatcher.unsubscribe(onDevChange)
+	}
 }

package/src/server/cli.js

@@ -78,7 +78,7 @@ else {
 		: {}
 
 	if (args.host) opts.host = args.host
-	if (args.port) opts.port = Number(args.port)
+	if (args.port) opts.port = Number.isNaN(Number(args.port)) ? args.port : Number(args.port)
 
 	if (args['mocks-dir']) opts.mocksDir = args['mocks-dir']
 	if (args['static-dir']) opts.staticDir = args['static-dir']

package/src/server/cli.test.js

@@ -5,12 +5,12 @@ import { describe, test } from 'node:test'
 
 import pkgJSON from '../../package.json' with { type: 'json' }
 
-const cli = (...args) => spawnSync(join(import.meta.dirname, 'cli.js'), args, {
-	encoding: 'utf8'
-})
+
+const rel = f => join(import.meta.dirname, f)
+const cli = (...args) => spawnSync(rel('cli.js'), args, { encoding: 'utf8' })
 
 describe('CLI', () => {
-	test('--invalid-flag', () => {
+	test('invalid flag', () => {
 		const { stderr, status } = cli('--invalid-flag')
 		equal(stderr.trim(), `Unknown option '--invalid-flag'`)
 		equal(status, 1)
@@ -22,6 +22,15 @@ describe('CLI', () => {
 		equal(status, 1)
 	})
 
+	test('invalid port', () => {
+		const { stderr, status } = cli(
+			'--mocks-dir', rel('../../mockaton-mocks'),
+			'--port', 'not-a-number',
+		)
+		equal(stderr.trim(), `port="not-a-number" is invalid`)
+		equal(status, 1)
+	})
+
 	test('-v outputs version from package.json', () => {
 		const { stdout, status } = cli('-v')
 		equal(stdout.trim(), pkgJSON.version)

package/src/server/utils/validate.test.js

@@ -7,41 +7,46 @@ describe('validate', () => {
 	describe('optional', () => {
 		test('accepts undefined', () =>
 			doesNotThrow(() =>
-				validate({}, { field: optional(Number.isInteger) })))
+				validate({}, { foo: optional(Number.isInteger) })))
 
 		test('accepts falsy value regardless of type', () =>
 			doesNotThrow(() =>
-				validate({ field: 0 }, { field: optional(Array.isArray) })))
+				validate({ foo: 0 }, { foo: optional(Array.isArray) })))
 
 		test('accepts when tester func returns truthy', () =>
 			doesNotThrow(() =>
-				validate({ field: [] }, { field: optional(Array.isArray) })))
+				validate({ foo: [] }, { foo: optional(Array.isArray) })))
 
 		test('rejects when tester func returns falsy', () =>
 			throws(() =>
-					validate({ field: 1 }, { field: optional(Array.isArray) }),
-				/field=1 is invalid/))
+					validate({ foo: 1 }, { foo: optional(Array.isArray) }),
+				/foo=1 is invalid/))
 	})
 
 	describe('is', () => {
 		test('rejects mismatched type', () =>
 			throws(() =>
-					validate({ field: 1 }, { field: is(String) }),
-				/field=1 is invalid/))
+					validate({ foo: 1 }, { foo: is(String) }),
+				/foo=1 is invalid/))
 
 		test('accepts matched type', () =>
 			doesNotThrow(() =>
-				validate({ field: '' }, { field: is(String) })))
+				validate({ foo: '' }, { foo: is(String) })))
 	})
 
 	describe('custom tester func', () => {
 		test('rejects mismatched type', () =>
 			throws(() =>
-					validate({ field: 0.1 }, { field: Number.isInteger }),
-				/field=0.1 is invalid/))
+					validate({ foo: 'not-a-number' }, { foo: n => n > 1 }),
+				/foo="not-a-number" is invalid/))
+
+		test('rejects mismatched type', () =>
+			throws(() =>
+					validate({ foo: 0 }, { foo: n => n > 1 }),
+				/foo=0 is invalid/))
 
 		test('accepts matched type', () =>
 			doesNotThrow(() =>
-				validate({ field: 1 }, { field: Number.isInteger })))
+				validate({ foo: 1 }, { foo: Number.isInteger })))
 	})
 })