mockaton 13.9.2 → 13.9.4

package/README.md

@@ -2,7 +2,6 @@
 ![NPM Version](https://img.shields.io/npm/v/mockaton)
 [![Test](https://github.com/ericfortis/mockaton/actions/workflows/test.yml/badge.svg)](https://github.com/ericfortis/mockaton/actions/workflows/test.yml)
 [![codecov](https://codecov.io/github/ericfortis/mockaton/graph/badge.svg?token=90NYLMMG1J)](https://codecov.io/github/ericfortis/mockaton)
-[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
 
 ## [Docs ↗](https://mockaton.com) | [Changelog ↗](https://mockaton.com/changelog) | [Skills](skills/mockaton/SKILL.md)
 
@@ -38,9 +37,10 @@ Dashboard: [localhost:2020/mockaton](http://localhost:2020/mockaton)
 npx mockaton --port 2020 my-mocks-dir/
 ```
 
-Mockaton will serve the files on the given directory. It's a file-system
-based router, so filenames can have dynamic parameters and comments.
-Also, each route can have different mock file variants.
+Mockaton will serve the files on the given directory. It's a file-system based router, so filenames can have dynamic
+parameters.
+Also, filenames can have comments, which are anything within parentheses, this way each route can have different mock
+file variants.
 
 
 | Route | Filename | Description |

package/index.d.ts

@@ -46,6 +46,7 @@ export declare interface Config {
 	onReady?: (address: string) => void
 
 	hotReload?: boolean // For UI dev purposes only
+	bypassImportCache?: boolean 
 }
 
 

package/package.json

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

package/src/client/ApiCommander.js

@@ -17,15 +17,10 @@ export class Commander {
 	reset = () => this.#patch(API.reset)
 
 	setGlobalDelay = delay => this.#patch(API.globalDelay, delay)
-
 	setGlobalDelayJitter = jitterPct => this.#patch(API.globalDelayJitter, jitterPct)
-
 	setCorsAllowed = value => this.#patch(API.cors, value)
-
 	setWatchMocks = enabled => this.#patch(API.watchMocks, enabled)
-
 	setProxyFallback = proxyAddr => this.#patch(API.fallback, proxyAddr)
-
 	setCollectProxied = shouldCollect => this.#patch(API.collectProxied, shouldCollect)
 
 	/** @returns {JsonPromise<State.cookies>} */
@@ -50,7 +45,6 @@ export class Commander {
 
 
 	writeMock = (file, content) => this.#patch(API.writeMock, [file, content])
-
 	deleteMock = file => this.#patch(API.deleteMock, file)
 
 

package/src/client/ApiConstants.js

@@ -6,7 +6,6 @@ export const API = {
 	dashboard: MOUNT,
 
 	reset: MOUNT + '/reset',
-
 	select: MOUNT + '/select',
 	bulkSelect: MOUNT + '/bulk-select-by-comment',
 

package/src/client/app.css

@@ -27,7 +27,6 @@
 
 html,
 body {
-	overflow: hidden;
 	height: 100%;
 	font-size: 12px;
 }
@@ -45,7 +44,7 @@ body {
 	border: 0;
 	margin: 0;
 	letter-spacing: -0.374px;
-	line-height: 1.2;
+	line-height: 14px;
 	font-family: inherit;
 	font-size: 100%;
 	scrollbar-width: thin;
@@ -185,13 +184,13 @@ header {
 	}
 
 	.HelpLink {
-		opacity: 0.8;
 		width: 22px;
 		height: 22px;
 		flex-shrink: 0;
 		align-self: end;
 		margin-bottom: 3px;
 		margin-left: auto;
+		opacity: 0.8;
 		border-radius: 50%;
 		fill: var(--colorBgHeader);
 		background: var(--colorLabel);
@@ -342,6 +341,7 @@ main {
 	}
 
 	.leftSide {
+		overflow: hidden;
 		width: 50%;
 		border-top: 1px solid var(--colorBorder);
 		border-right: 1px solid var(--colorBorder);
@@ -349,6 +349,7 @@ main {
 
 	.rightSide {
 		position: relative;
+		overflow: hidden;
 		min-width: 100px;
 		min-height: 0;
 		flex: 1;
@@ -399,8 +400,7 @@ main {
 	background: var(--colorBgHeader);
 }
 
-.GroupByMethod,
-.ViewSourceCheckbox {
+.GroupByMethod {
 	display: flex;
 	align-items: center;
 	gap: 6px;
@@ -426,7 +426,7 @@ main {
 	height: 100%;
 	padding: 16px;
 	padding-bottom: 64px;
-	padding-left: 12px;
+	padding-left: 15px;
 	user-select: none;
 	overflow-y: auto;
 
@@ -482,7 +482,8 @@ main {
 				cursor: grabbing;
 			}
 
-			&::-webkit-details-marker {
+			&::-webkit-details-marker,
+			&::marker {
 				display: none;
 			}
 

package/src/server/Api.js

@@ -4,8 +4,7 @@
  */
 
 import { join } from 'node:path'
-import { readdirSync } from 'node:fs'
-import { write, rm, isFile, resolveIn } from './utils/fs.js'
+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' }
@@ -22,12 +21,11 @@ import * as mockBrokersCollection from './mockBrokersCollection.js'
 
 
 export const CLIENT_DIR = join(import.meta.dirname, '../client')
-const DASHBOARD_ASSETS = readdirSync(CLIENT_DIR, { recursive: true })
-
 
 export const apiGetReqs = new Map([
 	[API.dashboard, serveDashboard],
-	...DASHBOARD_ASSETS.map(f => [API.dashboard + '/' + f, serveStatic(f)]),
+	...listFilesRecursively(CLIENT_DIR).map(f =>
+		[`${API.dashboard}/${f}`, serveStatic(f)]),
 
 	[API.state, getState],
 	[API.syncVersion, sseClientSyncVersion],
@@ -38,7 +36,6 @@ export const apiGetReqs = new Map([
 ])
 
 
-
 export const apiPatchReqs = new Map([
 	[API.cors, setCorsAllowed],
 	[API.reset, reset],
@@ -69,9 +66,7 @@ function serveDashboard(_, response) {
 }
 
 function serveStatic(f) {
-	return (_, response) => {
-		response.file(join(CLIENT_DIR, f))
-	}
+	return (_, response) => { response.file(join(CLIENT_DIR, f)) }
 }
 
 function getState(_, response) {

package/src/server/Mockaton.js

@@ -25,9 +25,12 @@ export function Mockaton(options) {
 		setup(options)
 		cookie.init(config.cookies)
 		mockBrokerCollection.init()
-		register('./importResolver.js', import.meta.url)
 
-		if (config.watcherEnabled) 
+		register('./resolverResolveExtensionless.js', import.meta.url)
+		if (config.bypassImportCache)
+			register('./resolverBypassImportCache.js', import.meta.url)
+
+		if (config.watcherEnabled)
 			watchMocksDir()
 
 		if (config.hotReload)

package/src/server/Mockaton.test.js

@@ -1047,7 +1047,7 @@ describe('Write and Delete Mock', () => {
 })
 
 
-describe('import resolver', () => {
+describe('import resolvers', () => {
 	test('resolves extensionless ts', async () => {
 		await api.writeMock('_scores.ts', 'export default [1,2,3]')
 		await api.writeMock('user-scores.GET.200.ts',

package/src/server/config.js

@@ -54,7 +54,8 @@ const schema = {
 
 	onReady: [await openInBrowser, is(Function)],
 
-	hotReload: [false, is(Boolean)]
+	hotReload: [false, is(Boolean)],
+	bypassImportCache: [true, is(Boolean)]
 }
 
 

package/src/server/resolverBypassImportCache.js

@@ -0,0 +1,19 @@
+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. 
+// Cache bust by appending timestamp query param
+export async function resolve(specifier, context, nextResolve) {
+	const result = await 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
+}

package/src/server/{importResolver.js → resolverResolveExtensionless.js}

@@ -1,14 +1,11 @@
 import { existsSync } from 'node:fs'
-import { resolve as _resolve, join, dirname } from 'node:path'
+import { join, dirname } from 'node:path'
 import { fileURLToPath, pathToFileURL } from 'node:url'
 
-const mockatonSrcRoot = `file://${_resolve(import.meta.dirname, '..')}`
 
-// We register this hook at runtime so it doesn’t interfere with non-dynamic imports. 
 export async function resolve(specifier, context, nextResolve) {
-	let result
 	try {
-		result = await nextResolve(specifier, context)
+		return await nextResolve(specifier, context)
 	}
 	catch (error) {
 		// Attempt to resolve imports as .ts and .js
@@ -20,16 +17,4 @@ export async function resolve(specifier, context, nextResolve) {
 		}
 		throw error
 	}
-
-	// Cache bust by appending timestamp query param
-	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
 }

package/src/server/utils/HttpServerResponse.js

@@ -27,7 +27,7 @@ export class ServerResponse extends http.ServerResponse {
 
 	async file(file) {
 		this.setHeader('Content-Type', mimeFor(file))
-		this.end(await fs.promises.readFile(file, 'utf8'))
+		this.end(await fs.promises.readFile(file))
 	}
 
 	noContent() {

package/src/server/utils/fs.js

@@ -34,8 +34,8 @@ export async function rm(path) {
 export async function resolveIn(baseDir, file) {
 	try {
 		const parent = await realpath(baseDir)
-		const child = resolve(parent, file)
-		return child.startsWith(parent + sep)
+		const child = resolve(join(parent, file))
+		return child.startsWith(join(parent, sep))
 			? child
 			: null
 	}

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

@@ -0,0 +1,31 @@
+import { join } from 'node:path'
+import { equal } from 'node:assert/strict'
+import { tmpdir } from 'node:os'
+import { after, describe, test } from 'node:test'
+import { mkdtempSync, rmSync, realpathSync } from 'node:fs'
+
+import { resolveIn } from './fs.js'
+
+const isNull = v => equal(v, null)
+
+describe('resolveIn', () => {
+	const baseDir = mkdtempSync(join(tmpdir(), '_resolveIn'))
+	const baseParentDir = join(baseDir, '..')
+	after(() => rmSync(baseDir, { recursive: true, force: true }))
+
+	test('null when baseDir does not exist', async () =>
+		isNull(await resolveIn(join(baseParentDir, 'missing'), 'file.json')))
+
+	test('null when relative path escapes baseDir', async () =>
+		isNull(await resolveIn(baseDir, '../outside.json')))
+
+
+	const realBaseDir = realpathSync(baseDir)
+	const onReal = f => join(realBaseDir, f)
+
+	test('resolves a relative file within baseDir', async () =>
+		equal(await resolveIn(baseDir, 'file.json'), onReal('file.json')))
+
+	test('resolves file starting with /', async () =>
+		equal(await resolveIn(baseDir, '/file.json'), onReal('file.json')))
+})