mockaton 13.1.0 → 13.2.0

package/package.json

@@ -2,7 +2,7 @@
 	"name": "mockaton",
 	"description": "HTTP Mock Server",
 	"type": "module",
-	"version": "13.1.0",
+	"version": "13.2.0",
 	"exports": {
 		".": {
 			"import": "./index.js",

package/src/client/ApiCommander.js

@@ -61,7 +61,8 @@ export class Commander {
 
 
 	/**
-	 * SSE - Streams an incremental version when a mock is added, deleted, or renamed
+	 * SSE - Streams an incremental version when a mock is added, deleted, or renamed.
+	 *  Also, when the internal state changes.
 	 * @returns {Promise<Response>}
 	 */
 	getSyncVersion = () => fetch(this.addr + API.syncVersion)

package/src/client/app-store.js

@@ -10,6 +10,7 @@ export const store = {
 	onError(err) {},
 	render() {},
 	renderRow(method, urlMask) {},
+	skipNextRender: false,
 
 	brokersByMethod: /** @type ClientBrokersByMethod */ {},
 
@@ -58,49 +59,53 @@ export const store = {
 			if (store.showProxyField === null) // isFirstCall
 				store.showProxyField = Boolean(store.proxyFallback)
 
-			store.render()
+			if (store.skipNextRender)
+				store.skipNextRender = false
+			else
+				store.render()
 		})
 	},
 
 	reset() {
 		store._request(api.reset, () => {
 			store.setChosenLink('', '')
-			store.fetchState()
 		})
 	},
 
 	bulkSelectByComment(value) {
-		store._request(() => api.bulkSelectByComment(value), () => {
-			store.fetchState()
-		})
+		store._request(() => api.bulkSelectByComment(value))
 	},
 
 	setGlobalDelay(value) {
+		store.skipNextRender = true
 		store._request(() => api.setGlobalDelay(value), () => {
 			store.delay = value
 		})
 	},
 
 	setGlobalDelayJitter(value) {
+		store.skipNextRender = true
 		store._request(() => api.setGlobalDelayJitter(value), () => {
 			store.delayJitter = value
 		})
 	},
 
 	selectCookie(name) {
+		store.skipNextRender = true
 		store._request(() => api.selectCookie(name), async response => {
 			store.cookies = await response.json()
 		})
 	},
 
 	setProxyFallback(value) {
+		store.skipNextRender = true
 		store._request(() => api.setProxyFallback(value), () => {
 			store.proxyFallback = value
-			store.render()
 		})
 	},
 
 	setCollectProxied(checked) {
+		store.skipNextRender = true
 		store._request(() => api.setCollectProxied(checked), () => {
 			store.collectProxied = checked
 		})
@@ -111,7 +116,7 @@ export const store = {
 		return store.brokersByMethod[method]?.[urlMask]
 	},
 
-	setBroker(broker) {
+	_setBroker(broker) {
 		const { method, urlMask } = parseFilename(broker.file)
 		store.brokersByMethod[method] ??= {}
 		store.brokersByMethod[method][urlMask] = broker
@@ -153,33 +158,37 @@ export const store = {
 	},
 
 	selectFile(file) {
+		store.skipNextRender = true
 		store._request(() => api.select(file), async response => {
 			const { method, urlMask } = parseFilename(file)
-			store.setBroker(await response.json())
+			store._setBroker(await response.json())
 			store.setChosenLink(method, urlMask)
 			store.renderRow(method, urlMask)
 		})
 	},
 
 	toggleStatus(method, urlMask, status) {
+		store.skipNextRender = true
 		store._request(() => api.toggleStatus(method, urlMask, status), async response => {
-			store.setBroker(await response.json())
+			store._setBroker(await response.json())
 			store.setChosenLink(method, urlMask)
 			store.renderRow(method, urlMask)
 		})
 	},
 
 	setProxied(method, urlMask, checked) {
+		store.skipNextRender = true
 		store._request(() => api.setRouteIsProxied(method, urlMask, checked), async response => {
-			store.setBroker(await response.json())
+			store._setBroker(await response.json())
 			store.setChosenLink(method, urlMask)
 			store.renderRow(method, urlMask)
 		})
 	},
 
 	setDelayed(method, urlMask, checked) {
+		store.skipNextRender = true
 		store._request(() => api.setRouteIsDelayed(method, urlMask, checked), async response => {
-			store.setBroker(await response.json())
+			store._setBroker(await response.json())
 		})
 	}
 }

package/src/server/Api.js

@@ -5,24 +5,18 @@
 
 import { join } from 'node:path'
 
-import {
-	sseClientHotReload,
-	DASHBOARD_ASSETS,
-	CLIENT_DIR
-} from './WatcherDevClient.js'
-import { startWatchers, stopWatchers, sseClientSyncVersion, notifyARR } from './Watcher.js'
-
 import pkgJSON from '../../package.json' with { type: 'json' }
 
+import { sseClientHotReload, DASHBOARD_ASSETS, CLIENT_DIR } from './WatcherDevClient.js'
+import { stopMocksDirWatcher, sseClientSyncVersion, uiSyncVersion, watchMocksDir } from './Watcher.js'
+
 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 { write, rm, isFile, resolveIn } from './utils/fs.js'
-
 import * as mockBrokersCollection from './mockBrokersCollection.js'
+import { write, rm, isFile, resolveIn } from './utils/fs.js'
 
 
 export const apiGetReqs = new Map([
@@ -95,6 +89,7 @@ function getState(_, response) {
 function reset(_, response) {
 	mockBrokersCollection.init()
 	response.ok()
+	uiSyncVersion.increment()
 }
 
 
@@ -106,21 +101,7 @@ async function setCorsAllowed(req, response) {
 	else {
 		config.corsAllowed = corsAllowed
 		response.ok()
-	}
-}
-
-
-async function setWatchMocks(req, response) {
-	const enabled = await req.json()
-
-	if (typeof enabled !== 'boolean')
-		response.unprocessable(`Expected boolean for "watchMocks"`)
-	else {
-		if (enabled)
-			startWatchers()
-		else
-			stopWatchers()
-		response.ok()
+		uiSyncVersion.increment()
 	}
 }
 
@@ -132,7 +113,9 @@ async function setGlobalDelay(req, response) {
 		response.unprocessable(`Expected non-negative integer for "delay"`)
 	else {
 		config.delay = delay
+		uiSyncVersion.increment()
 		response.ok()
+		uiSyncVersion.increment()
 	}
 }
 
@@ -144,6 +127,7 @@ async function setGlobalDelayJitter(req, response) {
 	else {
 		config.delayJitter = jitter
 		response.ok()
+		uiSyncVersion.increment()
 	}
 }
 
@@ -154,8 +138,10 @@ async function selectCookie(req, response) {
 	const error = cookie.setCurrent(cookieKey)
 	if (error)
 		response.unprocessable(error?.message || error)
-	else
+	else {
 		response.json(cookie.list())
+		uiSyncVersion.increment()
+	}
 }
 
 
@@ -167,6 +153,7 @@ async function setProxyFallback(req, response) {
 	else {
 		config.proxyFallback = fallback
 		response.ok()
+		uiSyncVersion.increment()
 	}
 }
 
@@ -178,6 +165,7 @@ async function setCollectProxied(req, response) {
 	else {
 		config.collectProxied = collectProxied
 		response.ok()
+		uiSyncVersion.increment()
 	}
 }
 
@@ -188,6 +176,7 @@ async function bulkUpdateBrokersByCommentTag(req, response) {
 
 	mockBrokersCollection.setMocksMatchingComment(comment)
 	response.ok()
+	uiSyncVersion.increment()
 }
 
 
@@ -200,6 +189,7 @@ async function selectMock(req, response) {
 	else {
 		broker.selectFile(file)
 		response.json(broker)
+		uiSyncVersion.increment()
 	}
 }
 
@@ -213,6 +203,7 @@ async function toggleRouteStatus(req, response) {
 	else {
 		broker.toggleStatus(status)
 		response.json(broker)
+		uiSyncVersion.increment()
 	}
 }
 
@@ -228,6 +219,7 @@ async function setRouteIsDelayed(req, response) {
 	else {
 		broker.setDelayed(delayed)
 		response.json(broker)
+		uiSyncVersion.increment()	
 	}
 }
 
@@ -245,6 +237,7 @@ async function setRouteIsProxied(req, response) {
 	else {
 		broker.setProxied(proxied)
 		response.json(broker)
+		uiSyncVersion.increment()
 	}
 }
 
@@ -263,7 +256,7 @@ async function writeMock(req, response) {
 
 	if (!config.watcherEnabled) {
 		mockBrokersCollection.registerMock(file, true)
-		notifyARR()
+		uiSyncVersion.increment()
 	}
 	response.ok()
 }
@@ -286,10 +279,24 @@ async function deleteMock(req, response) {
 
 	if (!config.watcherEnabled) {
 		mockBrokersCollection.unregisterMock(file)
-		notifyARR()
+		uiSyncVersion.increment()
 	}
 	response.ok()
 }
 
 
 
+async function setWatchMocks(req, response) {
+	const enabled = await req.json()
+
+	if (typeof enabled !== 'boolean')
+		response.unprocessable(`Expected boolean for "watchMocks"`)
+	else {
+		if (enabled)
+			watchMocksDir()
+		else
+			stopMocksDirWatcher()
+		response.ok()
+	}
+}
+

package/src/server/Watcher.js

@@ -12,24 +12,22 @@ let mocksWatcher = null
 
 
 /**
- * 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).
  */
-const uiSyncVersion = new class extends EventEmitter {
+export const uiSyncVersion = new class extends EventEmitter {
 	version = 0
 
 	increment = /** @type {function} */ this.#debounce(() => {
 		this.version++
-		super.emit('ARR')
+		super.emit('INC')
 	})
 
 	subscribe(listener) {
-		this.on('ARR', listener)
+		this.on('INC', listener)
 	}
 	unsubscribe(listener) {
-		this.removeListener('ARR', listener)
+		this.removeListener('INC', listener)
 	}
 
 	#debounce(fn) { // TESTME 
@@ -42,11 +40,6 @@ const uiSyncVersion = new class extends EventEmitter {
 }
 
 
-export function notifyARR() {
-	uiSyncVersion.increment()
-}
-
-
 export function watchMocksDir() {
 	const dir = config.mocksDir
 	mocksWatcher = mocksWatcher || watch(dir, { recursive: true, persistent: false }, (_, file) => {
@@ -69,8 +62,12 @@ export function watchMocksDir() {
 	})
 }
 
+export function stopMocksDirWatcher() {
+	mocksWatcher?.close()
+	mocksWatcher = null
+}
+
 
-/** Realtime notify ARR Events */
 export function sseClientSyncVersion(req, response) {
 	response.writeHead(200, {
 		'Content-Type': 'text/event-stream',
@@ -99,11 +96,3 @@ export function sseClientSyncVersion(req, response) {
 }
 
 
-export function startWatchers() {
-	watchMocksDir()
-}
-
-export function stopWatchers() {
-	mocksWatcher?.close()
-	mocksWatcher = null
-}