mockaton 12.7.1 → 12.7.2

package/package.json

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

package/src/client/ApiCommander.js

@@ -57,11 +57,11 @@ export class Commander {
 
 	/** @returns {JsonPromise<State>} */
 	getState = () => fetch(this.addr + API.state)
-	
-	
-	/** 
+
+
+	/**
 	 * SSE - Streams an incremental version when a mock is added, deleted, or renamed
-	 * @returns {Promise<Response>} 
+	 * @returns {Promise<Response>}
 	 */
 	getSyncVersion = () => fetch(this.addr + API.syncVersion)
 }

package/src/client/Filename.js

@@ -61,9 +61,9 @@ function responseStatusIsValid(status) {
 		&& status <= 599
 }
 
-export function makeMockFilename(url, method, status, ext) {
+export function makeMockFilename(url, method, status, ext, comment = '') {
 	const urlMask = replaceIds(removeTrailingSlash(url))
-	return [urlMask, method, status, ext].join('.')
+	return [urlMask + comment, method, status, ext].join('.')
 }
 
 const reUuidV4 = /([0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12})/gi

package/src/client/app-header.js

@@ -1,6 +1,6 @@
 import { createElement as r, t, defineClassNames } from './dom-utils.js'
-import { store } from './app-store.js'
 import { Logo, HelpIcon } from './app-icons.js'
+import { store } from './app-store.js'
 
 import CSS from './app.css' with { type: 'css' }
 defineClassNames(CSS)

package/src/client/app-payload-viewer.js

@@ -7,19 +7,19 @@ import CSS from './app.css' with { type: 'css' }
 defineClassNames(CSS)
 
 
-const payloadViewerTitleRef = {}
-const payloadViewerCodeRef = {}
+const titleRef = {}
+const codeRef = {}
 
 export function PayloadViewer() {
 	return (
 		r('div', { className: CSS.PayloadViewer },
 
 			r('div', { className: CSS.SubToolbar },
-				r('h2', { ref: payloadViewerTitleRef },
+				r('h2', { ref: titleRef },
 					!store.hasChosenLink && t`Preview`)),
 
 			r('pre', null,
-				r('code', { ref: payloadViewerCodeRef },
+				r('code', { ref: codeRef },
 					!store.hasChosenLink && t`Click a link to preview it`))))
 }
 
@@ -66,8 +66,8 @@ export async function previewMock() {
 	previewMock.controller = new AbortController
 
 	const spinnerTimer = setTimeout(() => {
-		payloadViewerTitleRef.elem.replaceChildren(t`Fetching…`)
-		payloadViewerCodeRef.elem.replaceChildren(PayloadViewerProgressBar())
+		titleRef.elem.replaceChildren(t`Fetching…`)
+		codeRef.elem.replaceChildren(PayloadViewerProgressBar())
 	}, SPINNER_DELAY)
 
 	try {
@@ -83,7 +83,7 @@ export async function previewMock() {
 	catch (error) {
 		clearTimeout(spinnerTimer)
 		store.onError(error)
-		payloadViewerCodeRef.elem.replaceChildren()
+		codeRef.elem.replaceChildren()
 	}
 }
 
@@ -91,22 +91,22 @@ export async function previewMock() {
 async function updatePayloadViewer(proxied, file, response) {
 	const mime = response.headers.get('content-type') || ''
 
-	payloadViewerTitleRef.elem.replaceChildren(proxied
+	titleRef.elem.replaceChildren(proxied
 		? PayloadViewerTitleWhenProxied(response)
 		: PayloadViewerTitle(file, response.statusText))
 
 	if (mime.startsWith('image/')) // Naively assumes GET 200
-		payloadViewerCodeRef.elem.replaceChildren(r('img', {
+		codeRef.elem.replaceChildren(r('img', {
 			src: URL.createObjectURL(await response.blob())
 		}))
 	else {
 		const body = await response.text() || t`/* Empty Response Body */`
 		if (mime === 'application/json')
-			payloadViewerCodeRef.elem.replaceChildren(SyntaxJSON(body))
+			codeRef.elem.replaceChildren(SyntaxJSON(body))
 		else if (isXML(mime))
-			payloadViewerCodeRef.elem.replaceChildren(SyntaxXML(body))
+			codeRef.elem.replaceChildren(SyntaxXML(body))
 		else
-			payloadViewerCodeRef.elem.textContent = body
+			codeRef.elem.textContent = body
 	}
 }
 

package/src/client/app.css

@@ -46,7 +46,7 @@ body {
 	font-family: inherit;
 	font-size: 100%;
 	scrollbar-width: thin;
-	corner-shape: squircle
+	corner-shape: squircle;
 }
 
 a:focus-visible,
@@ -306,9 +306,6 @@ header {
 }
 
 
-
-
-
 main {
 	display: flex;
 	min-width: 0;
@@ -423,7 +420,7 @@ main {
 		text-align: left;
 
 		&:first-of-type {
-			border-top: 0
+			border-top: 0;
 		}
 
 		&.canProxy {
@@ -536,7 +533,7 @@ main {
 		&:focus-visible {
 			outline: 0;
 			& + .checkboxBody {
-				outline: 2px solid var(--colorAccent)
+				outline: 2px solid var(--colorAccent);
 			}
 		}
 

package/src/server/Mockaton.test.js

@@ -7,7 +7,7 @@ import { mkdtempSync } from 'node:fs'
 import { randomUUID } from 'node:crypto'
 import { equal, deepEqual, match } from 'node:assert/strict'
 import { describe, test, before, beforeEach, after } from 'node:test'
-import { writeFile, unlink, mkdir, readFile, rename } from 'node:fs/promises'
+import { writeFile, unlink, mkdir, readFile, rename, readdir } from 'node:fs/promises'
 
 import { mimeFor } from './utils/mime.js'
 import { parseFilename } from '../client/Filename.js'
@@ -42,6 +42,8 @@ const serverAddr = await new Promise((resolve, reject) => {
 after(() => proc.kill('SIGUSR2'))
 
 
+const rmFromMocksDir = f => unlink(join(mocksDir, f))
+const listFromMocksDir = d => readdir(join(mocksDir, d))
 const readFromMocksDir = f => readFile(join(mocksDir, f), 'utf8')
 
 const makeDirInMocks = dir => mkdir(join(mocksDir, dir), { recursive: true })
@@ -369,15 +371,17 @@ describe('Proxy Fallback', () => {
 	describe('Fallback', () => {
 		let fallbackServer
 		const CUSTOM_COOKIES = ['cookieX=x', 'cookieY=y']
-		const BODY_PAYLOAD = 'text_req_body'
+		const BODY_PAYLOAD = { a: 'b' }
+		const expectedBody = JSON.stringify(BODY_PAYLOAD, null, '  ') // config.formatCollectedJSON=true
+		
 		before(async () => {
 			fallbackServer = createServer(async (req, response) => {
 				response.writeHead(423, {
 					'custom_header': 'my_custom_header',
-					'content-type': mimeFor('.txt'),
+					'content-type': mimeFor('.json'),
 					'set-cookie': CUSTOM_COOKIES
 				})
-				response.end(BODY_PAYLOAD)
+				response.end(JSON.stringify(BODY_PAYLOAD))
 			})
 			await promisify(fallbackServer.listen).bind(fallbackServer, 0, '127.0.0.1')()
 			await api.setProxyFallback(`http://localhost:${fallbackServer.address().port}`)
@@ -386,15 +390,31 @@ describe('Proxy Fallback', () => {
 
 		after(() => fallbackServer.close())
 
-		test('Relays to fallback server and saves the mock', async () => {
-			const r = await request(`/non-existing-mock/${randomUUID()}`, { method: 'POST' })
-			equal(r.status, 423)
-			equal(r.headers.get('custom_header'), 'my_custom_header')
-			equal(r.headers.get('set-cookie'), CUSTOM_COOKIES.join(', '))
-			equal(await r.text(), BODY_PAYLOAD)
+		test('Relays to fallback server and saves the mock (we req twice, so the second one gets a unique comment)', async () => {
+			const r1 = await request(`/non-existing-mock/${randomUUID()}`, { method: 'POST' })
+			const r2 = await request(`/non-existing-mock/${randomUUID()}`, { method: 'POST' })
 
-			const savedBody = await readFromMocksDir('non-existing-mock/[id].POST.423.txt')
-			equal(savedBody, BODY_PAYLOAD)
+			equal(r1.status, 423)
+			equal(r2.status, 423)
+
+			equal(r1.headers.get('custom_header'), 'my_custom_header')
+			equal(r2.headers.get('custom_header'), 'my_custom_header')
+
+			equal(r1.headers.get('set-cookie'), CUSTOM_COOKIES.join(', '))
+			equal(r2.headers.get('set-cookie'), CUSTOM_COOKIES.join(', '))
+
+			deepEqual(await r2.json(), BODY_PAYLOAD)
+			deepEqual(await r1.json(), BODY_PAYLOAD)
+
+			const savedMocks = await listFromMocksDir('non-existing-mock')
+			equal(savedMocks.length, 2)
+
+			equal(await readFromMocksDir('non-existing-mock/[id].POST.423.json'), expectedBody)
+			for (const m of savedMocks) {
+				const f = join('non-existing-mock', m)
+				equal(await readFromMocksDir(f), expectedBody)
+				await rmFromMocksDir(f)
+			}
 		})
 	})
 
@@ -1210,8 +1230,8 @@ describe('Registering Static Mocks', () => {
 })
 
 
-async function sleep(ms = 100) {
-	await new Promise(resolve => setTimeout(resolve, ms))
+function sleep(ms = 100) {
+	return new Promise(resolve => setTimeout(resolve, ms))
 }
 
 

package/src/server/ProxyRelay.js

@@ -29,29 +29,40 @@ export async function proxy(req, response, delay) {
 		return
 	}
 
-	const headers = Object.fromEntries(proxyResponse.headers)
-	headers['set-cookie'] = proxyResponse.headers.getSetCookie() // parses multiple into an array
-	response.writeHead(proxyResponse.status, headers)
+	response.writeHead(proxyResponse.status, {
+		...Object.fromEntries(proxyResponse.headers),
+		'Set-Cookie': proxyResponse.headers.getSetCookie() // parses multiple into an array
+	})
 	const body = await proxyResponse.text()
 	setTimeout(() => response.end(body), delay) // TESTME
 
 	if (config.collectProxied) {
 		const ext = extFor(proxyResponse.headers.get('content-type'))
-		let filename = makeMockFilename(req.url, req.method, proxyResponse.status, ext)
-		if (isFile(join(config.mocksDir, filename))) // TESTME
-			filename = makeMockFilename(req.url + `(${randomUUID()})`, req.method, proxyResponse.status, ext)
-
-		let data = body
-		if (config.formatCollectedJSON && ext === 'json') // TESTME
-			try {
-				data = JSON.stringify(JSON.parse(body), null, '  ')
-			}
-			catch {}
+		saveMockToDisk(req.url, req.method, proxyResponse.status, ext, body)
+	}
+}
+
+function saveMockToDisk(url, method, status, ext, body) {
+	if (config.formatCollectedJSON && ext === 'json')
 		try {
-			write(join(config.mocksDir, filename), data)
+			body = JSON.stringify(JSON.parse(body), null, '  ')
 		}
 		catch (err) {
-			logger.warn('Write access denied', err)
+			logger.warn('Invalid JSON response', err)
 		}
+
+	try {
+		write(makeUniqueMockFilename(url, method, status, ext), body)
 	}
+	catch (err) {
+		logger.warn('Write access denied', err)
+	}
+}
+
+function makeUniqueMockFilename(url, method, status, ext) {
+	let file = makeMockFilename(url, method, status, ext)
+	if (isFile(join(config.mocksDir, file)))
+		file = makeMockFilename(url, method, status, ext, `(${randomUUID()})`)
+	return join(config.mocksDir, file)
 }
+

package/src/server/Watcher.js

@@ -113,7 +113,7 @@ export function sseClientSyncVersion(req, response) {
 	const keepAlive = setInterval(() => {
 		response.write(': ping\n\n')
 	}, 10_000)
-	
+
 	req.on('close', cleanup)
 	req.on('error', cleanup)
 	function cleanup() {

package/src/server/utils/mime.js

@@ -61,7 +61,6 @@ const extToMime = {
 	jsonld: 'application/ld+json',
 	lz: 'application/x-lzip',
 	m4a: 'audio/mp4',
-	map: 'application/json',
 	md: 'text/markdown',
 	mid: 'audio/midi',
 	midi: 'audio/midi',