mockaton 13.14.0 → 13.15.0

package/README.md

@@ -8,20 +8,22 @@
 
 *No API state should be too difficult to test*
 
-## [Docs ↗](https://mockaton.com) | [Changelog ↗](https://mockaton.com/changelog) | [Skills](skills/mockaton/SKILL.md)
+### [Docs](https://mockaton.com) | [Changelog](https://mockaton.com/changelog) | [Skills](skills/mockaton/SKILL.md) | [Use Cases](https://mockaton.com/use-cases)
 
+## Overview
+
+Mockaton is a local HTTP mock server. With it, you can test API states 
+that are difficult to reproduce from an actual backend.
+
+For example, to quickly trigger an error on an endpoint, click the 500 button. 
+Then, unclick it to test your retry logic.
 
-Simulate API states that are normally ignored. For example, quickly trigger an error on 
-an endpoint by clicking the 500 button. Then, unclick it to test your retry logic.
 Similarly, pick a mock variant from the dropdown, say to respond with a 423 (locked account).
-As another example, click the clock button 🕓 to delay a response so you can test 
-spinners — you’ve seen them in production at the top left, or restart
-their animation midway. 
+
+Or click the clock button 🕓 to delay a response so you can test spinners.
 
 
 ## Dashboard
-Besides the dashboard UI, there’s a [programmatic API](https://mockaton.com/api), 
-which is handy for setting up tests.
 
 <picture>
   <source media="(prefers-color-scheme: light)" srcset="https://raw.githubusercontent.com/ericfortis/mockaton/refs/heads/main/pixaton-tests/tests/macos/pic-for-readme.vp762x762.light.gold.png">
@@ -29,6 +31,9 @@ which is handy for setting up tests.
   <img alt="Mockaton Dashboard" src="https://raw.githubusercontent.com/ericfortis/mockaton/refs/heads/main/pixaton-tests/tests/macos/pic-for-readme.vp762x762.dark.gold.png">
 </picture>
 
+Besides the dashboard, there’s a [programmatic API](https://mockaton.com/api),
+which is handy for setting up tests.
+
 
 ## Demo (Docker)
 This will spin up Mockaton with the [sample directory](./mockaton-mocks)

package/index.d.ts

@@ -46,7 +46,6 @@ export declare interface Config {
 	onReady?: (address: string) => void
 
 	hotReload?: boolean // For UI dev purposes only
-	bypassImportCache?: boolean
 }
 
 
@@ -102,4 +101,4 @@ declare global {
 	}
 }
 
-export type { JsonPromise, ClientMockBroker, ClientBrokersByMethod, State }
+export type { JsonPromise, ClientMockBroker, ClientBrokersByMethod, State }

package/package.json

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

package/src/server/Mockaton.js

@@ -8,6 +8,8 @@ import { ServerResponse } from './utils/HttpServerResponse.js'
 import { setCorsHeaders, isPreflight } from './utils/http-cors.js'
 import { IncomingMessage } from './utils/HttpIncomingMessage.js'
 import { watchDevSPA } from './utils/WatcherDevClient.js'
+import { resolveExtensionless } from './utils/resolveExtensionless.js'
+import { bypassImportCache } from './utils/resolveBypassImportCache.js'
 
 import { API } from '../client/ApiConstants.js'
 import { dispatchMock } from './MockDispatcher.js'
@@ -18,9 +20,6 @@ import { cookie } from './stores/cookies.js'
 import { config, initConfig } from './stores/config.js'
 import { watchMocksDir } from './stores/Watcher.js'
 
-import { resolveExtensionless } from './resolveExtensionless.js'
-import { resolveBypassImportCache } from './resolveBypassImportCache.js'
-
 
 export function Mockaton(options) {
 	return new Promise((resolve, reject) => {
@@ -29,9 +28,7 @@ export function Mockaton(options) {
 		brokers.init()
 
 		registerHooks({ resolve: resolveExtensionless })
-
-		if (config.bypassImportCache)
-			registerHooks({ resolve: resolveBypassImportCache })
+		registerHooks({ resolve: bypassImportCache(config.mocksDir) })
 
 		if (config.watcherEnabled)
 			watchMocksDir()

package/src/server/Mockaton.test.js

@@ -1218,10 +1218,7 @@ describe('Registering Mocks', () => {
 })
 
 
-/** Uses the native `EventSource` to listen for real-time sync-version updates.
- * It resolves when a new version is pushed that differs from `currSyncVer`;
- * when `currSyncVer` is omitted, the first push after the initial connection is
- * used. */
+/** Resolves when a new mock is added, deleted, or renamed. */
 function resolveOnNextSyncVersion(currSyncVer = undefined) {
 	let skipFirst = currSyncVer === undefined
 	return new Promise((resolve, reject) => {

package/src/server/stores/config.js

@@ -48,7 +48,6 @@ const schema = {
 	corsMaxAge: [0, is(Number)],
 
 	hotReload: [false, is(Boolean)],
-	bypassImportCache: [true, is(Boolean)],
 
 	// Non-serializable
 	plugins: [[[/\.(js|ts)$/, jsToJsonPlugin]], is(Array)],

package/src/server/utils/resolveBypassImportCache.js

@@ -0,0 +1,21 @@
+import { realpathSync } from 'node:fs'
+import { pathToFileURL } from 'node:url'
+
+export function bypassImportCache(srcPath) {
+	const resolvedSrcPath = pathToFileURL(realpathSync(srcPath)).href
+
+	// We register this `resolve` hook at runtime so it doesn't interfere with non-dynamic imports.
+	return function resolve(specifier, context, nextResolve) {
+		const result = nextResolve(specifier, context)
+		if (result.url.startsWith(resolvedSrcPath)) {
+			const url = new URL(result.url)
+			url.searchParams.set('t', performance.now())
+			return {
+				...result,
+				url: url.href,
+				shortCircuit: true
+			}
+		}
+		return result
+	}
+}

package/src/server/resolveBypassImportCache.js

@@ -1,19 +0,0 @@
-import { resolve as _resolve } from 'node:path'
-
-const mockatonSrcRoot = `file://${_resolve(import.meta.dirname, '..')}`
-
-// We register this hook at runtime so it doesn’t interfere with non-dynamic imports. 
-// It cache-busts by appending timestamp query param
-export function resolveBypassImportCache(specifier, context, nextResolve) {
-	const result = nextResolve(specifier, context)
-	if (result.url?.startsWith('file://') && !result.url.startsWith(mockatonSrcRoot)) {
-		const url = new URL(result.url)
-		url.searchParams.set('t', performance.now())
-		return {
-			...result,
-			url: url.href,
-			shortCircuit: true
-		}
-	}
-	return result
-}