mockaton 12.7.1 → 13.0.0

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

@@ -5,12 +5,10 @@ import { EventEmitter } from 'node:events'
 import { config } from './config.js'
 import { isFile, isDirectory } from './utils/fs.js'
 
-import * as staticCollection from './staticCollection.js'
 import * as mockBrokerCollection from './mockBrokersCollection.js'
 
 
 let mocksWatcher = null
-let staticWatcher = null
 
 
 /**
@@ -67,33 +65,6 @@ export function watchMocksDir() {
 }
 
 
-export function watchStaticDir() {
-	const dir = config.staticDir
-	if (!dir)
-		return
-
-	staticWatcher = staticWatcher || watch(dir, { recursive: true, persistent: false }, (_, file) => {
-		if (!file)
-			return
-
-		if (isDirectory(join(dir, file))) {
-			staticCollection.init()
-			uiSyncVersion.increment()
-		}
-		else if (!isFile(join(dir, file))) { // file deleted
-			staticCollection.unregisterMock(file)
-			uiSyncVersion.increment()
-		}
-		else if (staticCollection.registerMock(file))
-			uiSyncVersion.increment()
-		else {
-			// ignore file edits
-		}
-	})
-}
-
-
-
 /** Realtime notify ARR Events */
 export function sseClientSyncVersion(req, response) {
 	response.writeHead(200, {
@@ -113,7 +84,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() {
@@ -125,12 +96,9 @@ export function sseClientSyncVersion(req, response) {
 
 export function startWatchers() {
 	watchMocksDir()
-	watchStaticDir()
 }
 
 export function stopWatchers() {
 	mocksWatcher?.close()
-	staticWatcher?.close()
 	mocksWatcher = null
-	staticWatcher = null
 }

package/src/server/cli.js

@@ -11,25 +11,25 @@ import pkgJSON from '../../package.json' with { type: 'json' }
 
 process.on('unhandledRejection', error => { throw error })
 
-let args
+let args, positionals
 try {
-	args = parseArgs({
+	const result = parseArgs({
 		options: {
 			config: { short: 'c', type: 'string' },
 
 			port: { short: 'p', type: 'string' },
 			host: { short: 'H', type: 'string' },
 
-			'mocks-dir': { short: 'm', type: 'string' },
-			'static-dir': { short: 's', type: 'string' },
-
 			quiet: { short: 'q', type: 'boolean' },
 			'no-open': { short: 'n', type: 'boolean' },
 
 			help: { short: 'h', type: 'boolean' },
 			version: { short: 'v', type: 'boolean' }
-		}
-	}).values
+		},
+		allowPositionals: true
+	})
+	args = result.values
+	positionals = result.positionals
 }
 catch (error) {
 	console.error(error.message)
@@ -45,14 +45,11 @@ if (args.version)
 
 else if (args.help)
 	console.log(`
-Usage: mockaton [options]
+Usage: mockaton [mocks-dir] [options]
 
 Options:
   -c, --config <file>    (default: ./mockaton.config.js)
   
-  -m, --mocks-dir <dir>  (default: ./mockaton-mocks/)
-  -s, --static-dir <dir> (default: ./mockaton-static-mocks/)
-  
   -H, --host <host>      (default: 127.0.0.1)
   -p, --port <port>      (default: 0) which means auto-assigned
   
@@ -80,8 +77,7 @@ else {
 	if (args.host) opts.host = args.host
 	if (args.port) opts.port = Number.isNaN(Number(args.port)) ? args.port : Number(args.port)
 
-	if (args['mocks-dir']) opts.mocksDir = args['mocks-dir']
-	if (args['static-dir']) opts.staticDir = args['static-dir']
+	if (positionals[0]) opts.mocksDir = positionals[0]
 
 	if (args.quiet) opts.logLevel = 'quiet'
 	if (args['no-open']) opts.onReady = () => {}

package/src/server/cli.test.js

@@ -12,7 +12,7 @@ const cli = (...args) => spawnSync(rel('cli.js'), args, { encoding: 'utf8' })
 describe('CLI', () => {
 	test('invalid flag', () => {
 		const { stderr, status } = cli('--invalid-flag')
-		equal(stderr.trim(), `Unknown option '--invalid-flag'`)
+		equal(stderr.startsWith(`Unknown option '--invalid-flag'`), true)
 		equal(status, 1)
 	})
 
@@ -24,9 +24,8 @@ describe('CLI', () => {
 
 	test('invalid port', () => {
 		const { stderr, status } = cli(
-			'--mocks-dir', rel('../../mockaton-mocks'),
-			'--port', 'not-a-number',
-		)
+			rel('../../mockaton-mocks'),
+			'--port', 'not-a-number')
 		equal(stderr.trim(), `port="not-a-number" is invalid`)
 		equal(status, 1)
 	})
@@ -39,7 +38,7 @@ describe('CLI', () => {
 
 	test('-h outputs usage message', () => {
 		const { stdout, status } = cli('-h')
-		equal(stdout.split('\n')[0], 'Usage: mockaton [options]')
+		equal(stdout.split('\n')[0], 'Usage: mockaton [mocks-dir] [options]')
 		equal(status, 0)
 	})
 

package/src/server/config.js

@@ -7,7 +7,6 @@ import { openInBrowser } from './utils/openInBrowser.js'
 import { optional, is, validate } from './utils/validate.js'
 import { validateCorsAllowedMethods, validateCorsAllowedOrigins } from './utils/http-cors.js'
 
-
 import { jsToJsonPlugin } from './MockDispatcherPlugins.js'
 
 
@@ -19,7 +18,6 @@ import { jsToJsonPlugin } from './MockDispatcherPlugins.js'
  * }} */
 const schema = {
 	mocksDir: [resolve('mockaton-mocks'), isDirectory],
-	staticDir: [resolve('mockaton-static-mocks'), optional(isDirectory)],
 	ignore: [/(\.DS_Store|~)$/, is(RegExp)],
 	watcherEnabled: [true, is(Boolean)],
 	watcherDebounceMs: [80, ms => Number.isInteger(ms) && ms >= 0],
@@ -78,11 +76,6 @@ export function setup(opts) {
 	if (opts.mocksDir)
 		opts.mocksDir = resolve(opts.mocksDir)
 
-	if (opts.staticDir)
-		opts.staticDir = resolve(opts.staticDir)
-	else if (!isDirectory(defaults.staticDir))
-		opts.staticDir = ''
-
 	Object.assign(config, opts)
 	validate(config, ConfigValidator)
 	logger.setLevel(config.logLevel)

package/src/server/mockBrokersCollection.js

@@ -1,12 +1,10 @@
 import { basename } from 'node:path'
 
-import { logger } from './utils/logger.js'
-import { listFilesRecursively } from './utils/fs.js'
-
 import { cookie } from './cookie.js'
 import { MockBroker } from './MockBroker.js'
+import { parseFilename } from '../client/Filename.js'
+import { listFilesRecursively } from './utils/fs.js'
 import { config, isFileAllowed } from './config.js'
-import { parseFilename, validateFilename } from '../client/Filename.js'
 
 
 /**
@@ -42,8 +40,7 @@ export function init() {
 /** @returns {boolean} registered */
 export function registerMock(file, isFromWatcher = false) {
 	if (brokerByFilename(file)?.hasMock(file)
-		|| !isFileAllowed(basename(file))
-		|| !filenameIsValid(file))
+		|| !isFileAllowed(basename(file)))
 		return false
 
 	const { method, urlMask } = parseFilename(file)
@@ -62,13 +59,6 @@ export function registerMock(file, isFromWatcher = false) {
 	return true
 }
 
-function filenameIsValid(file) {
-	const error = validateFilename(file)
-	if (error)
-		logger.warn(error, file)
-	return !error
-}
-
 export function unregisterMock(file) {
 	const broker = brokerByFilename(file)
 	const hasNoMoreMocks = broker?.unregister(file)
@@ -99,6 +89,14 @@ export function brokerByRoute(method, url) {
 	for (let i = brokers.length - 1; i >= 0; i--)
 		if (brokers[i].urlMaskMatches(url))
 			return brokers[i]
+
+	// TODO Verify
+	if (method === 'GET') {
+		const indexUrl = url.endsWith('/') ? url + 'index.html' : url + '/index.html'
+		for (let i = brokers.length - 1; i >= 0; i--)
+			if (brokers[i].urlMaskMatches(indexUrl))
+				return brokers[i]
+	}
 }
 
 export function extractAllComments() {

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',

package/src/server/StaticDispatcher.js

@@ -1,36 +0,0 @@
-import { join } from 'node:path'
-import { readFileSync } from 'node:fs'
-
-import { isFile } from './utils/fs.js'
-import { logger } from './utils/logger.js'
-import { mimeFor } from './utils/mime.js'
-
-import { brokerByRoute } from './staticCollection.js'
-import { config, calcDelay } from './config.js'
-
-
-// TODO HEAD
-export async function dispatchStatic(req, response) {
-	const broker = brokerByRoute(req.url)
-
-	setTimeout(async () => {
-		if (!broker || broker.status === 404) {
-			response.mockNotFound()
-			return
-		}
-
-		const file = join(config.staticDir, broker.route)
-		if (!isFile(file)) {
-			response.mockNotFound()
-			return
-		}
-
-		logger.accessMock(req.url, 'static200')
-		if (req.headers.range)
-			await response.partialContent(req.headers.range, file)
-		else {
-			response.setHeader('Content-Type', mimeFor(file))
-			response.end(readFileSync(file))
-		}
-	}, Number(broker.delayed && calcDelay()))
-}

package/src/server/staticCollection.js

@@ -1,56 +0,0 @@
-import { join, basename } from 'node:path'
-import { listFilesRecursively } from './utils/fs.js'
-import { config, isFileAllowed } from './config.js'
-
-
-class StaticBroker {
-	constructor(route) {
-		this.route = route
-		this.delayed = false
-		this.status = 200 // 200 or 404
-	}
-
-	setDelayed(value) { this.delayed = value }
-	setStatus(value) { this.status = value }
-}
-
-/** @type {{ [route:string]: StaticBroker }} */
-let collection = {}
-
-export const all = () => collection
-
-export function init() {
-	collection = {}
-	listFilesRecursively(config.staticDir)
-		.sort()
-		.forEach(registerMock)
-}
-
-
-/** @returns {boolean} registered */
-export function registerMock(relativeFile) {
-	if (!isFileAllowed(basename(relativeFile)))
-		return false
-
-	const route = '/' + relativeFile
-	if (brokerByRoute(route))
-		return false
-
-	collection[route] = new StaticBroker(route)
-	return true
-}
-
-
-export function unregisterMock(relativeFile) {
-	delete collection['/' + relativeFile]
-}
-
-
-/** @returns {StaticBroker | undefined} */
-export function brokerByRoute(route) {
-	return collection[route] || collection[join(route, 'index.html')]
-}
-
-
-
-