mockaton 8.2.23 → 8.3.0

package/README.md

@@ -13,13 +13,10 @@ URL paths. For example, the following file will be served on `/api/user/1234`
 my-mocks-dir/api/user/[user-id].GET.200.json
 ```
 
-By the way, [this browser
-extension](https://github.com/ericfortis/devtools-ext-tar-http-requests)
-can create a TAR of your requests following that convention.
-
-Nonetheless, you don’t need to mock all your APIs. Mockaton
-can request from your backend the routes you don’t have mocks for.
-That’s done with `config.proxyFallback = 'http://mybackend'`
+By the way, you don’t need to mock all your APIs. Mockaton can request
+from your backend the routes you don’t have mocks for. That’s done
+with `config.proxyFallback = 'http://mybackend'`. For convenience, you
+can save mocks for those responses with `config.collectProxied = true`
 
 ## Multiple Mock Variants
 Each route can have many mocks, which could either be:
@@ -280,6 +277,31 @@ the amount is globally configurable. It defaults to `config.delay=1200` millisec
 Lets you specify a target server for serving routes you don’t have mocks for.
 For example, `config.proxyFallback = 'http://example.com'`
 
+### `collectProxied?: boolean`
+Defaults to `false`. With this flag you can save mocks that hit
+your proxy fallback to `config.mocksDir`. If there are UUIDv4 in the
+URL the filename will have `[id]` in their place. For example,
+
+```
+/api/user/d14e09c8-d970-4b07-be42-b2f4ee22f0a6/likes =>
+my-mocks-dir/api/user/[id]/likes.GET.200.json
+```
+
+Note that newly saved mocks won’t be served until you
+**register them** by reinitializing Mockaton or clicking "Reset".
+
+Registered mocks won’t be overwritten (they don’t hit the fallback server).
+On the other hand, newly saved mocks get overwritten while they are unregistered.
+
+<details>
+  <summary>Extension Details</summary>
+<p>
+If you see an <code>.unknown</code> extension, that’s because the
+<code>Content-Type</code> sent by your backend is either missing or not present
+in the predefined list. For the latter, add it to <code>config.extraMimes</code>
+</p>
+</details>
+
 
 ### `staticDir?: string`
 - Use Case 1: If you have a bunch of static assets you don’t want to add `.GET.200.ext`

package/index.d.ts

@@ -18,6 +18,7 @@ interface Config {
 	host?: string,
 	port?: number
 	proxyFallback?: string
+	collectProxied?: boolean
 
 	delay?: number
 	cookies?: { [label: string]: string }

package/package.json

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

package/src/ApiConstants.js

@@ -21,3 +21,5 @@ export const DF = { // Dashboard Fields (XHR)
 
 export const DEFAULT_500_COMMENT = '(Mockaton 500)'
 export const DEFAULT_MOCK_COMMENT = '(default)'
+
+export const EXT_FOR_UNKNOWN_MIME = 'unknown'

package/src/Config.js

@@ -14,6 +14,7 @@ export const Config = Object.seal({
 	host: '127.0.0.1',
 	port: 0, // auto-assigned
 	proxyFallback: '', // e.g. http://localhost:9999
+	collectProxied: false,
 
 	delay: 1200, // milliseconds
 	cookies: {}, // defaults to the first kv
@@ -47,6 +48,7 @@ export function setup(options) {
 		host: is(String),
 		port: port => Number.isInteger(port) && port >= 0 && port < 2 ** 16,
 		proxyFallback: optional(URL.canParse),
+		collectProxied: is(Boolean),
 
 		delay: ms => Number.isInteger(ms) && ms > 0,
 		cookies: is(Object),

package/src/Filename.js

@@ -44,7 +44,6 @@ export function parseFilename(file) {
 	}
 }
 
-
 function removeTrailingSlash(url = '') {
 	return url
 		.replace(/\/$/, '')
@@ -59,5 +58,14 @@ function responseStatusIsValid(status) {
 }
 
 
+export function makeMockFilename(url, method, status, ext) {
+	const urlMask = replaceIds(removeTrailingSlash(url))
+	return [urlMask, 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
+function replaceIds(filename) {
+	return filename.replaceAll(reUuidV4, '[id]')
+}
 
 

package/src/ProxyRelay.js

@@ -1,4 +1,8 @@
+import { join } from 'node:path'
+import { write } from './utils/fs.js'
 import { Config } from './Config.js'
+import { extFor } from './utils/mime.js'
+import { makeMockFilename } from './Filename.js'
 
 
 export async function proxy(req, response) {
@@ -6,6 +10,14 @@ export async function proxy(req, response) {
 		method: req.method,
 		headers: req.headers
 	})
+	// TODO investigate how to include many repeated headers such as set-cookie
 	response.writeHead(proxyResponse.status, Object.fromEntries(proxyResponse.headers))
-	response.end(await proxyResponse.text())
+	const body = await proxyResponse.text()
+	response.end(body)
+
+	if (Config.collectProxied) { // TESTME
+		const ext = extFor(proxyResponse.headers.get('content-type'))
+		const filename = makeMockFilename(req.url, req.method, proxyResponse.status, ext)
+		write(join(Config.mocksDir, filename), body)
+	}
 }

package/src/utils/fs.js

@@ -1,5 +1,5 @@
 import path, { join } from 'node:path'
-import { lstatSync, readFileSync, readdirSync } from 'node:fs'
+import { lstatSync, readFileSync, readdirSync, writeFileSync, mkdirSync } from 'node:fs'
 
 
 export const isFile = path => lstatSync(path, { throwIfNoEntry: false })?.isFile()
@@ -14,3 +14,8 @@ export const listFilesRecursively = dir => {
 		? files.map(f => f.replaceAll(path.sep, path.posix.sep)) // TESTME
 		: files
 }
+
+export const write = (fPath, body) => {
+	mkdirSync(path.dirname(fPath), { recursive: true })
+	writeFileSync(fPath, body)
+}

package/src/utils/mime.js

@@ -1,4 +1,5 @@
 import { Config } from '../Config.js'
+import { EXT_FOR_UNKNOWN_MIME } from '../ApiConstants.js'
 
 // https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types/Common_types
 // m = {}; 
@@ -93,3 +94,22 @@ export function mimeFor(filename) {
 		console.info(`Missing MIME for ${filename}`)
 	return mime
 }
+
+export function extFor(mime) {
+	const ext = findExt(mime)
+	if (!ext) {
+		console.info(`Missing extension for ${mime}`)
+		return EXT_FOR_UNKNOWN_MIME
+	}
+	return ext
+}
+
+function findExt(targetMime) {
+	for (const [ext, mime] of Object.entries(Config.extraMimes))
+		if (targetMime === mime)
+			return ext
+	for (const [ext, mime] of Object.entries(mimes))
+		if (targetMime === mime)
+			return ext
+	return ''
+}