mockaton 6.1.0 → 6.3.2

package/README.md

@@ -48,9 +48,11 @@ interface Config {
   host?: string, // defaults to 'localhost'
   port?: number // defaults to 0, which means auto-assigned
   delay?: number // defaults to 1200 (ms)
+  ignore?: RegExp // defaults to /(.DS_Store|~)$/
   onReady?: (dashboardUrl: string) => void // defaults to trying to open macOS default browser. pass a noop to prevent opening the dashboard
   cookies?: object
   proxyFallback?: string // e.g. http://localhost:9999 Target for relaying routes without mocks
+  extraMimes?: object
   extraHeaders?: []
 }
 ```
@@ -115,8 +117,6 @@ The delay is globally configurable via `Config.delay = 1200` (milliseconds).
 ### Extension
 `.Method.ResponseStatusCode.FileExt`
 
-The **file extension** can be anything, but `.md` is reserved for documentation.
-
 
 ### Dynamic Parameters
 Anything within square brackets. For example:
@@ -129,7 +129,7 @@ Comments are anything within parentheses, including them.
 They are ignored for URL purposes, so they have no effect
 on the URL mask. For example, these two are for `/api/foo`
 <pre>
-api/foo<b>(my comment)</b>.GET.200.json<b>(bar)</b>
+api/foo<b>(my comment)</b>.GET.200.json
 api/foo.GET.200.json
 </pre>
 
@@ -147,6 +147,9 @@ but since that’s part of the query string, it’s ignored anyway.
 
 
 ### Default (index-like) route
+For instance, let's say you have `api/foo/bar`, and
+`api/foo`. For the latter you have two options:
+
 **Option A.** Place it outside the directory:
 ```
 api/foo/
@@ -196,6 +199,13 @@ Config.extraHeaders = [
 ]
 ```
 
+## `Config.extraMimes`
+```js
+Config.extraMimes = {
+  jpg: 'application/jpeg'
+}
+```
+
 ---
 
 ## API

package/Tests.js

@@ -1,4 +1,4 @@
-#!/usr/bin/env node
+#!/usr/bin/env -S node --experimental-default-type=module
 
 import { tmpdir } from 'node:os'
 import { dirname } from 'node:path'
@@ -9,13 +9,20 @@ 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/utils/mime.js'
+import { mimeFor } from './src/mime.js'
 import { Mockaton } from './src/Mockaton.js'
 import { API, DF, DEFAULT_500_COMMENT } from './src/ApiConstants.js'
 
 
 const tmpDir = mkdtempSync(tmpdir()) + '/'
 const staticTmpDir = mkdtempSync(tmpdir()) + '/'
+
+const fixtureCustomMime = [
+	'/api/custom-mime',
+	'api/custom-mime.GET.200.my_custom_extension',
+	'Custom Extension and MIME'
+]
+
 const fixtures = [
 	[
 		'/api',
@@ -87,7 +94,8 @@ const fixtures = [
 		'/api/company-e/1234/?limit=4',
 		'api/company-e/[id]?limit=[limit].GET.200.json',
 		'with pretty-param and query-params'
-	]
+	],
+	fixtureCustomMime
 ]
 for (const [, file, body] of fixtures)
 	write(file, file.endsWith('.json') ? JSON.stringify(body) : body)
@@ -95,6 +103,7 @@ for (const [, file, body] of fixtures)
 write('api/.GET.500.txt', 'keeps non-autogenerated 500')
 write('api/alternative(comment-2).GET.200.json', JSON.stringify({ comment: 2 }))
 write('api/my-route(comment-2).GET.200.json', JSON.stringify({ comment: 2 }))
+write('api/ignored.GET.200.json~', '')
 
 // JavaScript to JSON
 write('/api/object.GET.200.js', 'export default { JSON_FROM_JS: true }')
@@ -111,7 +120,10 @@ const server = Mockaton({
 		userA: 'CookieA',
 		userB: 'CookieB'
 	},
-	extraHeaders: ['Server', 'MockatonTester']
+	extraHeaders: ['Server', 'MockatonTester'],
+	extraMimes: {
+		my_custom_extension: 'my_custom_mime'
+	}
 })
 server.on('listening', runTests)
 
@@ -161,6 +173,7 @@ async function runTests() {
 		await testMockDispatching(url, file, body)
 
 	await testMockDispatching('/api/object', 'api/object.GET.200.js', { JSON_FROM_JS: true }, mimeFor('.json'))
+	await testMockDispatching(...fixtureCustomMime, 'my_custom_mime')
 	await testJsFunctionMocks()
 
 	await testItUpdatesUserRole()
@@ -190,6 +203,10 @@ async function test404() {
 		const res = await request('/api/non-existing-too', { method: 'DELETE' })
 		equal(res.status, 404)
 	})
+	await it('Ignores files ending in ~ by default, e.g. JetBrains temp files', async () => {
+		const res = await request('/api/ignored')
+		equal(res.status, 404)
+	})
 }
 
 async function testMockDispatching(url, file, expectedBody, forcedMime = void 0) {

package/index.d.ts

@@ -5,11 +5,13 @@ interface Config {
 	staticDir?: string
 	host?: string,
 	port?: number
+	ignore?: RegExp
 	delay?: number
 	onReady?: (address: string) => void
 	cookies?: object
 	proxyFallback?: string
-	extraHeaders?: [string, string][] 
+	extraHeaders?: [string, string][]
+	extraMimes?: object
 }
 
 export function Mockaton(options: Config): Server

package/package.json

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

package/src/Config.js

@@ -8,11 +8,13 @@ export const Config = {
 	staticDir: '',
 	host: '127.0.0.1',
 	port: 0, // auto-assigned
+	ignore: /(\.DS_Store|~)$/,
 	delay: 1200, // milliseconds
 	cookies: {}, // defaults to the first kv
 	onReady: openInBrowser,
 	proxyFallback: '', // e.g. http://localhost:9999
-	extraHeaders: []
+	extraHeaders: [],
+	extraMimes: {}
 }
 
 export function setup(options) {
@@ -22,11 +24,13 @@ export function setup(options) {
 		staticDir: optional(isDirectory),
 		host: is(String),
 		port: port => Number.isInteger(port) && port >= 0 && port < 2 ** 16,
+		ignore: is(RegExp),
 		delay: ms => Number.isInteger(ms) && ms > 0,
 		cookies: is(Object),
 		onReady: is(Function),
 		proxyFallback: optional(URL.canParse),
-		extraHeaders: Array.isArray
+		extraHeaders: Array.isArray,
+		extraMimes: is(Object)
 	})
 }
 

package/src/MockBroker.js

@@ -1,7 +1,5 @@
-import { join } from 'node:path'
 import { Route } from './Route.js'
 import { Config } from './Config.js'
-import { isDirectory } from './utils/fs.js'
 import { DEFAULT_500_COMMENT } from './ApiConstants.js'
 
 
@@ -12,13 +10,11 @@ export class MockBroker {
 
 	constructor(file) {
 		this.#route = new Route(file)
-		this.method = this.#route.method
 		this.mocks = []
 		this.currentMock = {
 			file: '',
 			delay: 0
 		}
-
 		this.register(file)
 	}
 
@@ -62,19 +58,11 @@ export class MockBroker {
 		if (!this.#has500())
 			this.#registerTemp500()
 	}
-
 	#has500() {
-		return this.mocks.some(mock =>
-			Route.parseFilename(mock).status === 500)
+		return this.mocks.some(mock => Route.parseFilename(mock).status === 500)
 	}
-
 	#registerTemp500() {
 		const { urlMask, method } = Route.parseFilename(this.mocks[0])
-		let mask = urlMask
-		if (isDirectory(join(Config.mocksDir, urlMask)))
-			mask = urlMask + '/'
-		mask = mask.replace(/^\//, '') // remove initial slash
-		const file = `${mask}${DEFAULT_500_COMMENT}.${method}.500.txt`
-		this.register(file)
+		this.register(`${urlMask}${DEFAULT_500_COMMENT}.${method}.500.txt`)
 	}
 }

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 './utils/mime.js'
+import { mimeFor } from './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('\n', req.url, '→\n ', file)
+		console.log(req.url, ' → ', file)
 
 		let mockText
 		if (file.endsWith('.js')) {
@@ -59,7 +59,7 @@ async function jsMockText(file, req, response) {
 }
 
 function readMock(file) {
-	return readFileSync(join(Config.mocksDir, file), 'utf8')
+	return readFileSync(join(Config.mocksDir, file))
 }
 
 async function importDefault(file) {

package/src/Route.js

@@ -14,8 +14,7 @@ export class Route {
 	#urlRegex
 
 	constructor(file) {
-		const { urlMask, method } = Route.parseFilename(file)
-		this.method = method
+		const { urlMask } = Route.parseFilename(file)
 		this.#urlRegex = new RegExp('^' + disregardVariables(removeQueryStringAndFragment(urlMask)) + '/*$')
 	}
 

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

@@ -1,8 +1,9 @@
+import { Config } from './Config.js'
+
 // https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types/Common_types
 // m = {}; 
 // for (const row of tbody.children)
 //   m[row.children[0].querySelector('code').innerText] = row.children[2].querySelector('code').innerText
-
 const mimes = {
 	'3g2': 'video/3gpp2',
 	'3gp': 'video/3gpp',
@@ -40,6 +41,7 @@ const mimes = {
 	json: 'application/json',
 	jsonld: 'application/ld+json',
 	mid: 'audio/midi',
+	midi: 'audio/midi',
 	mjs: 'text/javascript',
 	mp3: 'audio/mpeg',
 	mp4: 'video/mp4',
@@ -84,7 +86,7 @@ const mimes = {
 
 export function mimeFor(filename) {
 	const ext = filename.replace(/.*\./, '').toLowerCase()
-	const mime = mimes[ext] || ''
+	const mime = Config.extraMimes[ext] || mimes[ext] || ''
 	if (!mime)
 		console.info(`Missing MIME for ${filename}`)
 	return mime

package/src/mockBrokersCollection.js

@@ -5,7 +5,6 @@ import { Route } from './Route.js'
 import { Config } from './Config.js'
 import { cookie } from './cookie.js'
 import { isFile } from './utils/fs.js'
-import { mimeFor } from './utils/mime.js'
 import { MockBroker } from './MockBroker.js'
 
 
@@ -26,7 +25,7 @@ export function init() {
 	cookie.init(Config.cookies)
 
 	const files = readDir(Config.mocksDir, { recursive: true })
-		.filter(f => isFile(join(Config.mocksDir, f)) && mimeFor(f))
+		.filter(f => !Config.ignore.test(f) && isFile(join(Config.mocksDir, f)))
 		.sort()
 
 	for (const file of files) {

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'