mockaton 12.4.0 → 12.5.1

package/index.d.ts

@@ -61,6 +61,8 @@ export const jsToJsonPlugin: Plugin
 export function jwtCookie(cookieName: string, payload: any, path?: string): string
 
 export function parseJSON(request: IncomingMessage): Promise<any>
+export function parseSplats(reqUrl: string, filename: string): Record<string, string>
+export function parseQueryParams(reqUrl: string): URLSearchParams
 
 export type JsonPromise<T> = Promise<Response & { json(): Promise<T> }>
 

package/index.js

@@ -4,5 +4,6 @@ export { Mockaton } from './src/server/Mockaton.js'
 export { jwtCookie } from './src/server/utils/jwt.js'
 export { jsToJsonPlugin } from './src/server/MockDispatcher.js'
 export { parseJSON, BodyReaderError } from './src/server/utils/HttpIncomingMessage.js'
+export { parseSplats, parseQueryParams } from './src/server/utils/UrlParsers.js'
 
 export const defineConfig = opts => opts

package/package.json

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

package/src/client/Filename.js

@@ -44,13 +44,17 @@ export function parseFilename(file) {
 	}
 }
 
-function removeTrailingSlash(url = '') {
+export function removeTrailingSlash(url = '') {
 	return url
 		.replace(/\/$/, '')
 		.replace('/?', '?')
 		.replace('/#', '#')
 }
 
+export function removeQueryStringAndFragment(url = '') {
+	return new URL(url, 'http://_').pathname
+}
+
 function responseStatusIsValid(status) {
 	return Number.isInteger(status)
 		&& status >= 100

package/src/server/MockBroker.js

@@ -1,5 +1,5 @@
 import { DEFAULT_MOCK_COMMENT } from '../client/ApiConstants.js'
-import { parseFilename, includesComment, extractComments } from '../client/Filename.js'
+import { parseFilename, includesComment, extractComments, removeQueryStringAndFragment } from '../client/Filename.js'
 
 
 /**
@@ -105,15 +105,11 @@ class UrlMatcher {
 
 	#buildUrlRegex(file) {
 		let { urlMask } = parseFilename(file)
-		urlMask = this.#removeQueryStringAndFragment(urlMask)
+		urlMask = removeQueryStringAndFragment(urlMask)
 		urlMask = this.#disregardVariables(urlMask)
 		return new RegExp('^' + urlMask + '/*$')
 	}
 
-	#removeQueryStringAndFragment(str) {
-		return str.replace(/[?#].*/, '')
-	}
-
 	#disregardVariables(str) { // Stars out all parts that are in square brackets
 		return str.replace(/\[.*?]/g, '[^/]+')
 	}
@@ -127,7 +123,7 @@ class UrlMatcher {
 	// slashes. For instance, for routing api/foo/[id]?qs…
 	urlMaskMatches = (url) => {
 		let u = decodeURIComponent(url)
-		u = this.#removeQueryStringAndFragment(u)
+		u = removeQueryStringAndFragment(u)
 		u += '/'
 		return this.#urlRegex.test(u)
 	}

package/src/server/ProxyRelay.js

@@ -6,7 +6,7 @@ import { write, isFile } from './utils/fs.js'
 import { readBody, BodyReaderError } from './utils/HttpIncomingMessage.js'
 
 import { config } from './config.js'
-
+import { logger } from './utils/logger.js'
 import { makeMockFilename } from '../client/Filename.js'
 
 
@@ -47,6 +47,11 @@ export async function proxy(req, response, delay) {
 				data = JSON.stringify(JSON.parse(body), null, '  ')
 			}
 			catch {}
-		write(join(config.mocksDir, filename), data)
+		try {
+			write(join(config.mocksDir, filename), data)
+		}
+		catch (err) {
+			logger.warn('Write access denied', err)
+		}
 	}
 }

package/src/server/cacheBustResolver.js

@@ -1,9 +1,12 @@
+import { resolve as r } from 'node:path'
+
+const mockatonSrcRoot = `file://${r(import.meta.dirname, '..')}`
+
 // We register this hook at runtime so it doesn’t interfere with non-dynamic imports. 
+// Excluding src/ is only needed for DEV.
 export async function resolve(specifier, context, nextResolve) {
 	const result = await nextResolve(specifier, context)
-	if (specifier === 'debug')
-		return result
-	if (result.url?.startsWith('file:')) {
+	if (result.url?.startsWith('file://') && !result.url.startsWith(mockatonSrcRoot)) {
 		const url = new URL(result.url)
 		url.searchParams.set('t', performance.now())
 		return {

package/src/server/config.js

@@ -1,10 +1,10 @@
 import { resolve } from 'node:path'
+import { METHODS } from 'node:http'
 
 import { logger } from './utils/logger.js'
 import { isDirectory } from './utils/fs.js'
 import { openInBrowser } from './utils/openInBrowser.js'
 import { optional, is, validate } from './utils/validate.js'
-import { SUPPORTED_METHODS } from './utils/HttpIncomingMessage.js'
 import { validateCorsAllowedMethods, validateCorsAllowedOrigins } from './utils/http-cors.js'
 
 import { jsToJsonPlugin } from './MockDispatcher.js'
@@ -41,7 +41,7 @@ const schema = {
 
 	corsAllowed: [true, is(Boolean)],
 	corsOrigins: [['*'], validateCorsAllowedOrigins],
-	corsMethods: [SUPPORTED_METHODS, validateCorsAllowedMethods],
+	corsMethods: [METHODS, validateCorsAllowedMethods],
 	corsHeaders: [['content-type', 'authorization'], Array.isArray],
 	corsExposedHeaders: [[], Array.isArray],
 	corsCredentials: [true, is(Boolean)],

package/src/server/utils/HttpIncomingMessage.js

@@ -1,8 +1,7 @@
 import http, { METHODS } from 'node:http'
 
 
-export const SUPPORTED_METHODS = METHODS
-export const methodIsSupported = method => SUPPORTED_METHODS.includes(method)
+export const methodIsSupported = method => METHODS.includes(method)
 
 export class BodyReaderError extends Error {
 	name = 'BodyReaderError'
@@ -73,3 +72,4 @@ export function decode(url) {
 		? candidate
 		: '' // reject multiple encodings
 }
+

package/src/server/utils/UrlParsers.js

@@ -0,0 +1,32 @@
+import { relative } from 'node:path'
+import { config } from '../config.js'
+import { decode } from './HttpIncomingMessage.js'
+import { parseFilename, removeTrailingSlash, removeQueryStringAndFragment } from '../../client/Filename.js'
+
+
+export function parseQueryParams(url) {
+	return new URL(url, 'http://_').searchParams
+}
+
+export function parseSplats(url, filename) {
+	const { urlMask } = parseFilename(relative(config.mocksDir, filename))
+
+	const splats = []
+	const pattern = removeQueryStringAndFragment(decode(urlMask))
+		.replace(/\[(.+?)]/g, (_, name) => {
+			splats.push(name)
+			return '([^/]+)'
+		})
+
+	let u = removeQueryStringAndFragment(url)
+	u = removeTrailingSlash(u)
+
+	const match = u.match(new RegExp(`^${pattern}$`))
+	if (!match)
+		return {}
+
+	return splats.reduce((acc, name, i) => {
+		acc[name] = match[i + 1]
+		return acc
+	}, {})
+}

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

@@ -0,0 +1,55 @@
+import { test, describe } from 'node:test'
+import { deepEqual, equal } from 'node:assert/strict'
+import { parseSplats, parseQueryParams } from './UrlParsers.js'
+import { config } from '../config.js'
+
+test('parseQueryParams', () => {
+	const searchParams = parseQueryParams('/api/foo?limit=123')
+	equal(searchParams.get('limit'), '123')
+})
+
+
+describe('parseSplats', () => {
+	test('one splat', () => {
+		const splats = parseSplats(
+			'/api/company/123',
+			`${config.mocksDir}/api/company/[companyId].GET.200.js`
+		)
+		deepEqual(splats, {
+			companyId: '123'
+		})
+	})
+
+	test('one splat with trailing slash', () => {
+		const splats = parseSplats(
+			'/api/company/123/',
+			`${config.mocksDir}/api/company/[companyId].GET.200.js`
+		)
+		deepEqual(splats, {
+			companyId: '123'
+		})
+	})
+
+	test('two splats and comment', () => {
+		const splats = parseSplats(
+			'/api/company/123/user/456',
+			`${config.mocksDir}/api/company/[companyId]/user/[userId](comments).GET.200.js`
+		)
+		deepEqual(splats, {
+			companyId: '123',
+			userId: '456',
+		})
+	})
+
+	test('ignores query string', () => {
+		const splats = parseSplats(
+			'/api/company/123?foo=456',
+			`${config.mocksDir}/api/company/[companyId]?foo=[fooId].GET.200.js`
+		)
+		deepEqual(splats, {
+			companyId: '123'
+		})
+	})
+})
+
+

package/src/server/utils/fs.js

@@ -1,14 +1,13 @@
 import { join, dirname, sep, posix } from 'node:path'
 import { lstatSync, readdirSync, writeFileSync, mkdirSync } from 'node:fs'
 
-import { logger } from './logger.js'
-
 
 export const isFile = path => lstatSync(path, { throwIfNoEntry: false })?.isFile()
 export const isDirectory = path => lstatSync(path, { throwIfNoEntry: false })?.isDirectory()
 
+
 /** @returns {Array<string>} paths relative to `dir` */
-export const listFilesRecursively = dir => {
+export function listFilesRecursively(dir) {
 	try {
 		const files = readdirSync(dir, { recursive: true }).filter(f => isFile(join(dir, f)))
 		return process.platform === 'win32'
@@ -20,12 +19,7 @@ export const listFilesRecursively = dir => {
 	}
 }
 
-export const write = (path, body) => {
-	try {
-		mkdirSync(dirname(path), { recursive: true })
-		writeFileSync(path, body)
-	}
-	catch (err) {
-		logger.warn('Write access denied', err)
-	}
+export function write(path, body) {
+	mkdirSync(dirname(path), { recursive: true })
+	writeFileSync(path, body)
 }