mockaton 8.24.0 → 8.25.0

package/README.md

@@ -132,13 +132,17 @@ npx mockaton --port 2345
 CLI options override their counterparts in `mockaton.config.js`
 
 ```txt
--c, --config <file>       (default: ./mockaton.config.js)
+-c, --config <file>    (default: ./mockaton.config.js)
 
--H, --host <host>         (default: 127.0.0.1)
--p, --port <port>         (default: 0) which means auto-assigned
+-m, --mocks-dir <dir>  (default: ./mockaton-mocks/)
+-s, --static-dir <dir> (default: ./mockaton-static-mocks/)
 
--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
+
+-q, --quiet            Errors only
+-h, --help             Show this help
+-v, --version          Show version
 ```
 
 
@@ -152,7 +156,6 @@ import {
   SUPPORTED_METHODS
 } from 'mockaton'
 
-
 export default defineConfig({
   mocksDir: 'mockaton-mocks',
   staticDir: 'mockaton-static-mocks',
@@ -186,7 +189,9 @@ export default defineConfig({
   corsCredentials: true,
   corsMaxAge: 0,
 
-  onReady: await openInBrowser
+  onReady: await openInBrowser,
+  
+  logLevel: 'normal'
 })
 ```
 
@@ -421,9 +426,29 @@ config.onReady = () => {}
 
 At any rate, you can trigger any command besides opening a browser.
 
+<br/>
+
+### `logLevel?: 'quiet' | 'normal'`
+Defaults to `'normal'`.
+
+- `quiet`: only errors (stderr)
+- `normal`: info, access, warnings, and errors
+
+</details>
+
 
+<details>
+<summary>Programmatic Launch (Optional)</summary>
 
+```js
+import { Mockaton } from 'mockaton'
+import mockatonConfig from './mockaton.config.js'
 
+Mockaton({
+  ...mockatonConfig, // Not required, but it’s not read by default.
+  port: 3333, // etc.
+})
+```
 </details>
 
 

package/index.d.ts

@@ -41,10 +41,12 @@ interface Config {
 	corsMaxAge?: number
 
 	onReady?: (address: string) => void
+	
+	logLevel?: 'normal' | 'quiet'
 }
 
 
-export function Mockaton(options: Partial<Config>): Server
+export function Mockaton(options: Partial<Config>): Server | undefined
 export function defineConfig(options: Partial<Config>): Config
 
 export const jsToJsonPlugin: Plugin

package/package.json

@@ -2,7 +2,7 @@
 	"name": "mockaton",
 	"description": "HTTP Mock Server",
 	"type": "module",
-	"version": "8.24.0",
+	"version": "8.25.0",
 	"main": "index.js",
 	"types": "index.d.ts",
 	"license": "MIT",

package/src/Filename.js

@@ -22,15 +22,8 @@ export const includesComment = (filename, search) =>
 	extractComments(filename).some(comment => comment.includes(search))
 
 
-export function filenameIsValid(file) {
-	const error = validateFilename(file)
-	if (error)
-		console.error(error, file)
-	return !error
-}
-
 // TODO ThinkAbout 206 (reject, handle, or send in full?)
-function validateFilename(file) {
+export function validateFilename(file) {
 	const tokens = file.replace(reComments, '').split('.')
 	if (tokens.length < 4)
 		return 'Invalid Filename Convention'

package/src/MockDispatcher.js

@@ -2,6 +2,7 @@ import { join } from 'node:path'
 import { readFileSync } from 'node:fs'
 import { pathToFileURL } from 'node:url'
 
+import { log } from './utils/log.js'
 import { proxy } from './ProxyRelay.js'
 import { cookie } from './cookie.js'
 import { mimeFor } from './utils/mime.js'
@@ -22,7 +23,7 @@ export async function dispatchMock(req, response) {
 			return
 		}
 
-		console.log('%s %s → %s', new Date().toISOString(), decodeURIComponent(req.url), broker.file)
+		log.access(req.url, broker.file)
 		response.statusCode = broker.status
 
 		if (cookie.getCurrent())
@@ -45,7 +46,7 @@ export async function dispatchMock(req, response) {
 			sendNotFound(response)
 		else if (error.code === 'ERR_UNKNOWN_FILE_EXTENSION') {
 			if (error.toString().includes('Unknown file extension ".ts'))
-				console.error('\nLooks like you need a TypeScript compiler\n')
+				log.warn('\nLooks like you need a TypeScript compiler\n')
 			sendInternalServerError(response, error)
 		}
 		else

package/src/Mockaton.js

@@ -1,5 +1,6 @@
 import { createServer } from 'node:http'
 
+import { log } from './utils/log.js'
 import { API } from './ApiConstants.js'
 import { config, setup } from './config.js'
 import { dispatchMock } from './MockDispatcher.js'
@@ -18,7 +19,7 @@ process.on('unhandledRejection', error => { throw error })
 export function Mockaton(options) {
 	const error = setup(options)
 	if (error) {
-		console.error(error)
+		log.error(error)
 		process.exitCode = 1
 		return
 	}
@@ -32,19 +33,19 @@ export function Mockaton(options) {
 
 	server.listen(config.port, config.host, function (error) {
 		if (error) {
-			console.error(error)
+			log.error(error)
 			process.exit(1)
 			return
 		}
 		const { address, port } = this.address()
 		const url = `http://${address}:${port}`
-		console.log('Listening', url)
-		console.log('Dashboard', url + API.dashboard)
+		log.info('Listening', url)
+		log.info('Dashboard', url + API.dashboard)
 		config.onReady(url + API.dashboard)
 	})
 
 	server.on('error', error => {
-		console.error(error.message)
+		log.error(error.message)
 		process.exit(1)
 	})
 
@@ -53,7 +54,7 @@ export function Mockaton(options) {
 
 
 async function onRequest(req, response) {
-	response.on('error', console.error)
+	response.on('error', log.warn)
 
 	try {
 		response.setHeader('Server', 'Mockaton')

package/src/StaticDispatcher.js

@@ -1,6 +1,7 @@
 import { join } from 'node:path'
 import { readFileSync } from 'node:fs'
 
+import { log } from './utils/log.js'
 import { mimeFor } from './utils/mime.js'
 import { brokerByRoute } from './staticCollection.js'
 import { config, calcDelay } from './config.js'
@@ -12,11 +13,12 @@ export async function dispatchStatic(req, response) {
 
 	setTimeout(async () => {
 		if (!broker || broker.status === 404) { // TESTME
+			log.access(req.url, 'static404')
 			sendNotFound(response)
 			return
 		}
 
-		console.log('%s %s (static)', new Date().toISOString(), decodeURIComponent(req.url))
+		log.access(req.url, 'static200')
 
 		const file = join(config.staticDir, broker.route)
 		if (req.headers.range)

package/src/cli.js

@@ -19,7 +19,10 @@ const args = parseArgs({
 		'static-dir': { short: 's', type: 'string' },
 
 		help: { short: 'h', type: 'boolean' },
-		version: { short: 'v', type: 'boolean' }
+		version: { short: 'v', type: 'boolean' },
+
+		quiet: { short: 'q', type: 'boolean' },
+		debug: { type: 'boolean' }
 	}
 }).values
 
@@ -32,16 +35,17 @@ else if (args.help)
 Usage: mockaton [options]
 
 Options:
-  -c, --config <file>       (default: ./mockaton.config.js)
+  -c, --config <file>    (default: ./mockaton.config.js)
   
-  -m, --mocks-dir <dir>     (default: ./mockaton-mocks/)
-  -s, --static-dir <dir>    (default: ./mockaton-static-mocks/)
+  -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
+  -H, --host <host>      (default: 127.0.0.1)
+  -p, --port <port>      (default: 0) which means auto-assigned
   
-  -h, --help                Show this help
-  -v, --version             Show version
+  -q, --quiet            Errors only
+  -h, --help             Show this help
+  -v, --version          Show version
 
 Notes:
   * mockaton.config.js supports more options, see:
@@ -64,5 +68,7 @@ else {
 	if (args['mocks-dir']) opts.mocksDir = args['mocks-dir']
 	if (args['static-dir']) opts.staticDir = args['static-dir']
 
+	if (args.quiet) opts.logLevel = 'quiet'
+
 	Mockaton(opts)
 }

package/src/config.js

@@ -1,5 +1,6 @@
 import { join, isAbsolute } from 'node:path'
 
+import { log } from './utils/log.js'
 import { isDirectory } from './utils/fs.js'
 import { openInBrowser } from './utils/openInBrowser.js'
 import { jsToJsonPlugin } from './MockDispatcher.js'
@@ -48,7 +49,9 @@ const schema = {
 	corsCredentials: [true, is(Boolean)],
 	corsMaxAge: [0, is(Number)],
 
-	onReady: [await openInBrowser, is(Function)]
+	onReady: [await openInBrowser, is(Function)],
+
+	logLevel: ['normal', val => ['normal', 'quiet'].includes(val)]
 }
 
 
@@ -68,18 +71,19 @@ export const ConfigValidator = Object.freeze(validators)
 
 /** @param {Partial<Config>} options */
 export function setup(options) {
-	if (options.mocksDir && !isAbsolute(options.mocksDir)) 
+	if (options.mocksDir && !isAbsolute(options.mocksDir))
 		options.mocksDir = join(process.cwd(), options.mocksDir)
-	
+
 	if (options.staticDir && !isAbsolute(options.staticDir))
 		options.staticDir = join(process.cwd(), options.staticDir)
-	
-	if (!options.staticDir && !isDirectory(defaults.staticDir)) 
+
+	if (!options.staticDir && !isDirectory(defaults.staticDir))
 		options.staticDir = ''
 
 	try {
 		Object.assign(config, options)
 		validate(config, ConfigValidator)
+		log.setLevel(config.logLevel)
 	}
 	catch (err) {
 		return err.message

package/src/mockBrokersCollection.js

@@ -1,10 +1,11 @@
 import { basename } from 'node:path'
 
+import { log } from './utils/log.js'
 import { cookie } from './cookie.js'
 import { MockBroker } from './MockBroker.js'
 import { listFilesRecursively } from './utils/fs.js'
 import { config, isFileAllowed } from './config.js'
-import { parseFilename, filenameIsValid } from './Filename.js'
+import { parseFilename, validateFilename } from './Filename.js'
 
 
 /**
@@ -64,6 +65,13 @@ export function registerMock(file, isFromWatcher = false) {
 	return true
 }
 
+function filenameIsValid(file) {
+	const error = validateFilename(file)
+	if (error)
+		log.warn(error, file)
+	return !error
+}
+
 export function unregisterMock(file) {
 	const broker = brokerByFilename(file)
 	if (!broker)

package/src/utils/fs.js

@@ -1,5 +1,6 @@
 import { join, dirname, sep, posix } from 'node:path'
 import { lstatSync, readdirSync, writeFileSync, mkdirSync } from 'node:fs'
+import { log } from './log.js'
 
 
 export const isFile = path => lstatSync(path, { throwIfNoEntry: false })?.isFile()
@@ -24,6 +25,6 @@ export const write = (path, body) => {
 		writeFileSync(path, body)
 	}
 	catch (err) {
-		console.error('Write access denied', err)
+		log.warn('Write access denied', err)
 	}
 }

package/src/utils/http-response.js

@@ -1,4 +1,5 @@
 import fs, { readFileSync } from 'node:fs'
+import { log } from './log.js'
 import { mimeFor } from './mime.js'
 import { HEADER_FOR_502 } from '../ApiConstants.js'
 
@@ -28,19 +29,19 @@ export function sendNotFound(response) {
 }
 
 export function sendUnprocessableContent(response, error) {
-	console.error(error)
+	log.warn(error)
 	response.statusCode = 422
 	response.end(error)
 }
 
 export function sendInternalServerError(response, error) {
-	console.error(error)
+	log.error(error)
 	response.statusCode = 500
 	response.end()
 }
 
 export function sendBadGateway(response, error) {
-	console.error('Fallback Proxy Error:', error.cause.message)
+	log.warn('Fallback Proxy Error:', error.cause.message)
 	response.statusCode = 502
 	response.setHeader(HEADER_FOR_502, 1)
 	response.end()

package/src/utils/log.js

@@ -0,0 +1,34 @@
+export const log = new class {
+	#level = 'normal'
+
+	setLevel(level) {
+		this.#level = level
+	}
+
+	info(...msg) {
+		if (this.#level !== 'quiet')
+			console.info([this.#date, 'INFO', ...msg].join('::'))
+	}
+
+	access(url, ...msg) {
+		if (this.#level !== 'quiet')
+			console.log([this.#date, 'ACCESS', this.#sanitizeURL(url), ...msg].join('::'))
+	}
+
+	warn(...msg) {
+		console.warn([this.#date, 'WARN', ...msg].join('::'))
+	}
+
+	error(...msg) {
+		console.error([this.#date, 'ERROR', ...msg].join('::'))
+	}
+
+
+	get #date() {
+		return new Date().toISOString()
+	}
+
+	#sanitizeURL(url) {
+		return decodeURIComponent(url).replace(/[\x00-\x1F\x7F\x9B]/g, '')
+	}
+}