mockaton 6.3.5 → 6.3.8

package/Tests.js

@@ -8,9 +8,10 @@ import { createServer } from 'node:http'
 import { equal, deepEqual, match } from 'node:assert/strict'
 import { writeFileSync, mkdtempSync, mkdirSync } from 'node:fs'
 
-import { Route } from './src/Route.js'
-import { mimeFor } from './src/mime.js'
+import { Config } from './src/Config.js'
+import { mimeFor } from './src/utils/mime.js'
 import { Mockaton } from './src/Mockaton.js'
+import { parseFilename } from './src/Filename.js'
 import { API, DF, DEFAULT_500_COMMENT } from './src/ApiConstants.js'
 
 
@@ -51,6 +52,14 @@ const fixtures = [
 		'/api/alternative',
 		'api/alternative(comment-1).GET.200.json',
 		'With_Comment_1'
+	], [
+		'/api/dot.in.path',
+		'api/dot.in.path.GET.200.json',
+		'Dot_in_Path'
+	], [
+		'/api/space & colon:',
+		'api/space & colon:.GET.200.json',
+		'Decodes URI'
 	],
 
 
@@ -115,6 +124,7 @@ writeStatic('another-entry/index.html', '<h1>Another</h1>')
 const server = Mockaton({
 	mocksDir: tmpDir,
 	staticDir: staticTmpDir,
+	delay: 40,
 	onReady: () => {},
 	cookies: {
 		userA: 'CookieA',
@@ -209,10 +219,9 @@ async function test404() {
 	})
 }
 
-async function testMockDispatching(url, file, expectedBody, forcedMime = void 0) {
-	const { urlMask, method, status } = Route.parseFilename(file)
+async function testMockDispatching(url, file, expectedBody, forcedMime = undefined) {
+	const { urlMask, method, status } = parseFilename(file)
 	const mime = forcedMime || mimeFor(file)
-	const now = new Date()
 	const res = await request(url, { method })
 	const body = mime === 'application/json'
 		? await res.json()
@@ -222,7 +231,6 @@ async function testMockDispatching(url, file, expectedBody, forcedMime = void 0)
 		it('mime: ' + mime, () => equal(res.headers.get('content-type'), mime))
 		it('status: ' + status, () => equal(res.status, status))
 		it('cookie: ' + mime, () => equal(res.headers.get('set-cookie'), 'CookieA'))
-		it('delay is under 1 sec', () => equal((new Date()).getTime() - now.getTime() < 1000, true))
 		it('extra header', () => equal(res.headers.get('server'), 'MockatonTester'))
 	})
 }
@@ -253,7 +261,7 @@ async function testItUpdatesDelayAndFile(url, file, expectedBody) {
 	const body = await res.text()
 	await describe('url: ' + url, () => {
 		it('body is: ' + expectedBody, () => equal(body, expectedBody))
-		it('delay is over 1 sec', () => equal((new Date()).getTime() - now.getTime() > 1000, true))
+		it('delay', () => equal((new Date()).getTime() - now.getTime() > Config.delay, true))
 	})
 }
 

package/package.json

@@ -2,7 +2,7 @@
 	"name": "mockaton",
 	"description": "A deterministic server-side for developing and testing frontend clients",
 	"type": "module",
-	"version": "6.3.5",
+	"version": "6.3.8",
 	"main": "index.js",
 	"types": "index.d.ts",
 	"license": "MIT",

package/src/Api.js

@@ -14,7 +14,7 @@ import { sendOK, sendBadRequest, sendJSON, sendFile, sendUnprocessableContent }
 
 export const apiGetRequests = new Map([
 	[API.dashboard, serveDashboard],
-	['/Route.js', serveDashboardAsset],
+	['/Filename.js', serveDashboardAsset],
 	['/Dashboard.js', serveDashboardAsset],
 	['/Dashboard.css', serveDashboardAsset],
 	['/ApiConstants.js', serveDashboardAsset],

package/src/Dashboard.js

@@ -1,4 +1,4 @@
-import { Route } from '../Route.js'
+import { parseFilename } from '../Filename.js'
 import { API, DF, DEFAULT_500_COMMENT } from '../ApiConstants.js'
 
 
@@ -173,7 +173,7 @@ function MockSelector({ broker }) {
 	const items = broker.mocks
 	const selected = broker.currentMock.file
 
-	const { status } = Route.parseFilename(selected)
+	const { status } = parseFilename(selected)
 	const files = items.filter(item =>
 		status === 500 ||
 		!item.includes(DEFAULT_500_COMMENT))
@@ -184,7 +184,7 @@ function MockSelector({ broker }) {
 			autocomplete: 'off',
 			disabled: files.length <= 1,
 			onChange() {
-				const { status } = Route.parseFilename(this.value)
+				const { status } = parseFilename(this.value)
 				this.style.fontWeight = this.value === this.options[0].value // default is selected
 					? 'normal'
 					: 'bold'
@@ -240,7 +240,7 @@ function TimerIcon() {
 function InternalServerErrorToggler({ broker }) {
 	const items = broker.mocks
 	const name = broker.currentMock.file
-	const checked = Route.parseFilename(broker.currentMock.file).status === 500
+	const checked = parseFilename(broker.currentMock.file).status === 500
 	return (
 		r('label', {
 				className: CSS.InternalServerErrorToggler,
@@ -256,7 +256,7 @@ function InternalServerErrorToggler({ broker }) {
 						method: 'PATCH',
 						body: JSON.stringify({
 							[DF.file]: event.currentTarget.checked
-								? items.find(f => Route.parseFilename(f).status === 500)
+								? items.find(f => parseFilename(f).status === 500)
 								: items[0]
 						})
 					})

package/src/Filename.js

@@ -0,0 +1,53 @@
+const httpMethods = [
+	'CONNECT', 'DELETE', 'GET',
+	'HEAD', 'OPTIONS', 'PATCH',
+	'POST', 'PUT', 'TRACE'
+]
+
+
+const reComments = /\(.*?\)/g // Anything within parentheses
+
+export const extractComments = filename =>
+	Array.from(filename.matchAll(reComments), ([comment]) => comment)
+
+export const includesComment = (filename, search) =>
+	extractComments(filename).some(comment => comment.includes(search))
+
+
+export function parseFilename(file) {
+	const tokens = file.replace(reComments, '').split('.')
+	if (tokens.length < 4)
+		return { error: 'Invalid Filename Convention' }
+
+	const method = tokens.at(-3)
+	const status = Number(tokens.at(-2))
+
+	if (!httpMethods.includes(method))
+		return { error: `Unrecognized HTTP Method: "${method}"` }
+
+	if (!responseStatusIsValid(status))
+		return { error: `Invalid HTTP Response Status: "${status}"` }
+
+	return {
+		urlMask: '/' + removeTrailingSlash(tokens.slice(0, -3).join('.')),
+		method,
+		status
+	}
+}
+
+function removeTrailingSlash(url = '') {
+	return url
+		.replace(/\/$/, '')
+		.replace('/?', '?')
+		.replace('/#', '#')
+}
+
+function responseStatusIsValid(status) {
+	return Number.isInteger(status)
+		&& status >= 100
+		&& status <= 599
+}
+
+
+
+

package/src/MockBroker.js

@@ -1,20 +1,23 @@
-import { Route } from './Route.js'
 import { Config } from './Config.js'
 import { DEFAULT_500_COMMENT } from './ApiConstants.js'
+import { includesComment, extractComments, parseFilename } from './Filename.js'
 
 
 // MockBroker is a state for a particular route. It knows the available mock files
 // that can be served for the route, the currently selected file, and its delay.
 export class MockBroker {
-	#route
+	#urlRegex
 
 	constructor(file) {
-		this.#route = new Route(file)
+		const { urlMask } = parseFilename(file)
+		this.#urlRegex = new RegExp('^' + disregardVariables(removeQueryStringAndFragment(urlMask)) + '/*$')
+
 		this.mocks = []
 		this.currentMock = {
 			file: '',
 			delay: 0
 		}
+
 		this.register(file)
 	}
 
@@ -24,12 +27,21 @@ export class MockBroker {
 		this.mocks.push(file)
 	}
 
-	urlMaskMatches(url) { return this.#route.urlMaskMatches(url) }
+	// Appending a '/' so URLs ending with variables don't match
+	// URLs that have a path after that variable. For example,
+	// without it, the following regex would match both of these URLs:
+	//   api/foo/[route_id] => api/foo/.*  (wrong match because it’s too greedy)
+	//   api/foo/[route_id]/suffix => api/foo/.*/suffix
+	// By the same token, the regex handles many trailing
+	// slashes. For instance, for routing api/foo/[id]?qs…
+	urlMaskMatches(url) {
+		return this.#urlRegex.test(removeQueryStringAndFragment(decodeURIComponent(url)) + '/')
+	}
 
 	get file() { return this.currentMock.file }
 	get delay() { return this.currentMock.delay }
-	get status() { return Route.parseFilename(this.file).status }
-	get isTemp500() { return Route.hasInParentheses(this.file, DEFAULT_500_COMMENT) }
+	get status() { return parseFilename(this.file).status }
+	get isTemp500() { return includesComment(this.file, DEFAULT_500_COMMENT) }
 
 	updateFile(filename) {
 		this.currentMock.file = filename
@@ -41,7 +53,7 @@ export class MockBroker {
 
 	setByMatchingComment(comment) {
 		for (const file of this.mocks)
-			if (Route.hasInParentheses(file, comment)) {
+			if (includesComment(file, comment)) {
 				this.updateFile(file)
 				break
 			}
@@ -50,7 +62,7 @@ export class MockBroker {
 	extractComments() {
 		let comments = []
 		for (const file of this.mocks)
-			comments = comments.concat(Route.extractComments(file))
+			comments = comments.concat(extractComments(file))
 		return comments
 	}
 
@@ -59,11 +71,21 @@ export class MockBroker {
 			this.#registerTemp500()
 	}
 	#has500() {
-		return this.mocks.some(mock => Route.parseFilename(mock).status === 500)
+		return this.mocks.some(mock => parseFilename(mock).status === 500)
 	}
 	#registerTemp500() {
-		const { urlMask, method } = Route.parseFilename(this.mocks[0])
+		const { urlMask, method } = parseFilename(this.mocks[0])
 		const file = urlMask.replace(/^\//, '') // Removes leading slash TESTME
 		this.register(`${file}${DEFAULT_500_COMMENT}.${method}.500.txt`)
 	}
 }
+
+// Stars out (for regex) all the paths that are in square brackets
+function disregardVariables(urlMask) {
+	return urlMask.replace(/\[.*?]/g, '[^/]*')
+}
+
+function removeQueryStringAndFragment(urlMask) {
+	return urlMask.replace(/[?#].*/, '')
+}
+

package/src/MockDispatcher.js

@@ -4,7 +4,7 @@ import { readFileSync } from 'node:fs'
 import { proxy } from './ProxyRelay.js'
 import { cookie } from './cookie.js'
 import { Config } from './Config.js'
-import { mimeFor } from './mime.js'
+import { mimeFor } from './utils/mime.js'
 import * as mockBrokerCollection from './mockBrokersCollection.js'
 import { JsonBodyParserError } from './utils/http-request.js'
 import { sendInternalServerError, sendNotFound, sendBadRequest } from './utils/http-response.js'
@@ -22,7 +22,7 @@ export async function dispatchMock(req, response) {
 
 	try {
 		const { file, status, delay } = broker
-		console.log(req.url, ' → ', file)
+		console.log(decodeURIComponent(req.url), ' → ', file)
 
 		let mockText
 		if (file.endsWith('.js')) {

package/src/mockBrokersCollection.js

@@ -1,11 +1,11 @@
 import { join } from 'node:path'
 import { readdirSync as readDir } from 'node:fs'
 
-import { Route } from './Route.js'
 import { Config } from './Config.js'
 import { cookie } from './cookie.js'
 import { isFile } from './utils/fs.js'
 import { MockBroker } from './MockBroker.js'
+import { parseFilename } from './Filename.js'
 
 
 /**
@@ -29,7 +29,7 @@ export function init() {
 		.sort()
 
 	for (const file of files) {
-		const { error, method, urlMask } = Route.parseFilename(file)
+		const { error, method, urlMask } = parseFilename(file)
 		if (error) {
 			console.error(error, file)
 			continue
@@ -52,7 +52,7 @@ function forEachBroker(fn) {
 export const getAll = () => collection
 
 export const getBrokerByFilename = file => {
-	const { method, urlMask } = Route.parseFilename(file)
+	const { method, urlMask } = parseFilename(file)
 	if (collection[method])
 		return collection[method][urlMask]
 }

package/src/utils/http-response.js

@@ -1,5 +1,5 @@
 import fs from 'node:fs'
-import { mimeFor } from '../mime.js'
+import { mimeFor } from './mime.js'
 import { isFile, read } from './fs.js'
 
 

package/src/{mime.js → utils/mime.js}

@@ -1,4 +1,4 @@
-import { Config } from './Config.js'
+import { Config } from '../Config.js'
 
 // https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types/Common_types
 // m = {}; 

package/src/Route.js

@@ -1,86 +0,0 @@
-const httpMethods = [
-	'CONNECT',
-	'DELETE',
-	'GET',
-	'HEAD',
-	'OPTIONS',
-	'PATCH',
-	'POST',
-	'PUT',
-	'TRACE'
-]
-
-export class Route {
-	#urlRegex
-
-	constructor(file) {
-		const { urlMask } = Route.parseFilename(file)
-		this.#urlRegex = new RegExp('^' + disregardVariables(removeQueryStringAndFragment(urlMask)) + '/*$')
-	}
-
-	urlMaskMatches(url) {
-		// Appending a '/' so URLs ending with variables don't match
-		// URLs that have a path after that variable. For example,
-		// without it, the following regex would match both of these URLs:
-		//   api/foo/[route_id] => api/foo/.*  (wrong match because it’s too greedy)
-		//   api/foo/[route_id]/suffix => api/foo/.*/suffix
-		// By the same token, the regex handles many trailing
-		// slashes. For instance, for routing api/foo/[id]?qs…
-		return this.#urlRegex.test(removeQueryStringAndFragment(url) + '/')
-	}
-
-	// Anything within parentheses in the filename is a comment, including the parentheses.
-	static reComments = /\(.*?\)/g
-
-	static extractComments(filename) {
-		return Array.from(filename.matchAll(Route.reComments), ([comment]) => comment)
-	}
-
-	static hasInParentheses(filename, search) {
-		return Route.extractComments(filename)
-			.some(comment => comment.includes(search))
-	}
-
-	static parseFilename(file) {
-		const tokens = file.replace(Route.reComments, '').split('.')
-		if (tokens.length < 4)
-			return { error: 'Invalid Filename Convention' }
-
-		const status = Number(tokens.at(-2))
-		if (!responseStatusIsValid(status))
-			return { error: `Invalid HTTP Response Status: "${status}"` }
-
-		const method = tokens.at(-3)
-		if (!httpMethods.includes(method))
-			return { error: `Unrecognized HTTP Method: "${method}"` }
-
-		return {
-			urlMask: '/' + removeTrailingSlash(tokens.at(-4)),
-			method,
-			status
-		}
-	}
-}
-
-
-// Stars out (for regex) all the paths that are in square brackets
-function disregardVariables(str) {
-	return str.replace(/\[.*?]/g, '[^/]*')
-}
-
-function removeQueryStringAndFragment(urlMask) {
-	return urlMask.replace(/[?#].*/, '')
-}
-
-function removeTrailingSlash(url = '') {
-	return decodeURIComponent(url
-		.replace(/\/$/, '')
-		.replace('/?', '?')
-		.replace('/#', '#'))
-}
-
-function responseStatusIsValid(status) {
-	return Number.isInteger(status)
-		&& status >= 100
-		&& status <= 599
-}