mockaton 11.2.5 → 11.2.6

package/src/server/Watcher.js

@@ -2,19 +2,26 @@ import { join } from 'node:path'
 import { watch } from 'node:fs'
 import { EventEmitter } from 'node:events'
 
+import {
+	HEADER_SYNC_VERSION,
+	LONG_POLL_SERVER_TIMEOUT
+} from './ApiConstants.js'
+
 import { config } from './config.js'
+import { sendJSON } from './utils/http-response.js'
 import { isFile, isDirectory } from './utils/fs.js'
+
 import * as staticCollection from './staticCollection.js'
 import * as mockBrokerCollection from './mockBrokersCollection.js'
 
 
 /**
- * ARR = Add, Remove, or Rename Mock Event
+ * ARR Event = Add, Remove, or Rename Mock
  *
  * The emitter is debounced so it handles e.g. bulk deletes,
  * and also renames, which are two events (delete + add).
  */
-export const uiSyncVersion = new class extends EventEmitter {
+const uiSyncVersion = new class extends EventEmitter {
 	delay = Number(process.env.MOCKATON_WATCHER_DEBOUNCE_MS ?? 80)
 	version = 0
 
@@ -39,6 +46,7 @@ export const uiSyncVersion = new class extends EventEmitter {
 	}
 }
 
+
 export function watchMocksDir() {
 	const dir = config.mocksDir
 	watch(dir, { recursive: true, persistent: false }, (_, file) => {
@@ -61,6 +69,7 @@ export function watchMocksDir() {
 	})
 }
 
+
 export function watchStaticDir() {
 	const dir = config.staticDir
 	if (!dir)
@@ -86,4 +95,23 @@ export function watchStaticDir() {
 	})
 }
 
-// TODO ThinkAbout watching for config changes
+
+/** 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
+		sendJSON(response, uiSyncVersion.version)
+		return
+	}
+	function onARR() {
+		uiSyncVersion.unsubscribe(onARR)
+		sendJSON(response, uiSyncVersion.version)
+	}
+	response.setTimeout(LONG_POLL_SERVER_TIMEOUT, onARR)
+	req.on('error', () => {
+		uiSyncVersion.unsubscribe(onARR)
+		response.destroy()
+	})
+	uiSyncVersion.subscribe(onARR)
+}

package/src/server/WatcherDevClient.js

@@ -1,17 +1,50 @@
-import { watch } from 'node:fs'
+import { join } from 'node:path'
 import { EventEmitter } from 'node:events'
+import { watch, readdirSync } from 'node:fs'
+import { sendJSON, sendNotFound } from './utils/http-response.js'
+import { LONG_POLL_SERVER_TIMEOUT } from './ApiConstants.js'
 
 
-export const devClientWatcher = new class extends EventEmitter {
+const DEV = process.env.NODE_ENV === 'development'
+
+export const CLIENT_DIR = join(import.meta.dirname, '../client')
+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) }
 	unsubscribe(listener) { this.removeListener('RELOAD', listener) }
 }
 
-// DashboardHtml.js is not watched.
-// It would need dynamic import + cache busting
+
+// Although `client/indexHtml.js` is watched, it returns a stale version.
+// i.e., it would need to be a dynamic import + cache busting.
 export function watchDevSPA() {
-	watch('src/client', (_, file) => {
+	watch(CLIENT_DIR, (_, file) => {
 		devClientWatcher.emit(file)
 	})
 }
+
+
+/** Realtime notify Dev UI changes */
+export function longPollDevClientHotReload(req, response) {
+	if (!DEV) {
+		sendNotFound(response)
+		return
+	}
+	
+	function onDevChange(file) {
+		devClientWatcher.unsubscribe(onDevChange)
+		sendJSON(response, file)
+	}
+	response.setTimeout(LONG_POLL_SERVER_TIMEOUT, () => {
+		devClientWatcher.unsubscribe(onDevChange)
+		sendJSON(response, '')
+	})
+	req.on('error', () => {
+		devClientWatcher.unsubscribe(onDevChange)
+		response.destroy()
+	})
+	devClientWatcher.subscribe(onDevChange)
+}

package/src/server/cli.js

@@ -5,6 +5,7 @@ import { parseArgs } from 'node:util'
 
 import { isFile } from './utils/fs.js'
 import { Mockaton } from '../../index.js'
+
 import pkgJSON from '../../package.json' with { type: 'json' }
 
 

package/src/server/config.js

@@ -3,11 +3,12 @@ import { resolve } from 'node:path'
 import { logger } from './utils/logger.js'
 import { isDirectory } from './utils/fs.js'
 import { openInBrowser } from './utils/openInBrowser.js'
-import { jsToJsonPlugin } from './MockDispatcher.js'
 import { optional, is, validate } from './utils/validate.js'
 import { SUPPORTED_METHODS } from './utils/http-request.js'
 import { validateCorsAllowedMethods, validateCorsAllowedOrigins } from './utils/http-cors.js'
 
+import { jsToJsonPlugin } from './MockDispatcher.js'
+
 
 /** @type {{
  * 	[K in keyof Config]-?: [

package/src/server/mockBrokersCollection.js

@@ -1,9 +1,10 @@
 import { basename } from 'node:path'
 
 import { logger } from './utils/logger.js'
+import { listFilesRecursively } from './utils/fs.js'
+
 import { cookie } from './cookie.js'
 import { MockBroker } from './MockBroker.js'
-import { listFilesRecursively } from './utils/fs.js'
 import { config, isFileAllowed } from './config.js'
 import { parseFilename, validateFilename } from './Filename.js'
 

package/src/server/utils/fs.js

@@ -1,5 +1,6 @@
 import { join, dirname, sep, posix } from 'node:path'
 import { lstatSync, readdirSync, writeFileSync, mkdirSync } from 'node:fs'
+
 import { logger } from './logger.js'
 
 

package/src/server/utils/http-response.js

@@ -47,6 +47,12 @@ export function sendBadRequest(response) {
 	response.end()
 }
 
+export function sendNotFound(response) {
+	response.statusCode = 404
+	logger.access(response)
+	response.end()
+}
+
 export function sendMockNotFound(response) {
 	response.statusCode = 404
 	logger.accessMock(response.req.url, '404')