mockaton 0.10.10 → 1.1.0

package/README.md

@@ -26,6 +26,17 @@ UI, or programmatically, for instance, for setting up tests.
 
 The first file in **alphabetical order** becomes the default mock.
 
+### Optionally, you can write mocks in JavaScript
+An Object, Array, or String is sent as JSON.
+
+`api/user/likes.GET.200.js`
+```js
+export default [
+  { id: 0 }
+]
+```
+
+
 ### Proxying Routes
 `Config.proxyFallback` lets you specify a target
 server for serving routes you don’t have mocks for.
@@ -78,7 +89,7 @@ interface Config {
   database?: object // for "Transforms"
   skipOpen?: boolean // Prevents opening the dashboard in a browser
   proxyFallback?: string // e.g. http://localhost:9999 Target for relaying routes without mocks
-  allowedExt?: RegExp // /\.(json|txt|md|mjs)$/ Just for excluding temporary editor files (e.g. JetBrains appends a ~)
+  allowedExt?: RegExp // /\.(json|txt|md|js|mjs)$/ Just for excluding temporary editor files (e.g. JetBrains appends a ~)
 }
 ```
 
@@ -177,60 +188,64 @@ export default function capitalizeAllText(mockAsText, requestBody, config) {
 }
 ```
 
----
 
 ## API
 
-### `/mockaton/edit` Select a mock for a route
-```
-PATCH /mockaton/edit
-{ 
-  "file": "api/foo.200.GET.json"
-  "delayed": true // optional
-}
+### Select a mock for a route
+```js
+fetch(addr + '/mockaton/edit', {
+  method: 'PATCH',
+  body: JSON.stringify({
+    file: 'api/foo.200.GET.json',
+    delayed: true // optional
+  })
+})
 ```
----
-
-### `/mockaton/bulk-select` Select all mocks that have a particular comment
 
+### Select all mocks that have a particular comment
+```js
+fetch(addr + '/mockaton/bulk-select-by-comment', {
+  method: 'PATCH',
+  body: JSON.stringify('(demo-a)')
+})
 ```
-PATCH /mockaton/bulk-select
-{
-  "comment": "(demo-a)"
-}
-```
----
 
-### `/mockaton/reset` Reset
+### Reset
 Re-Initialize the collection and its states (selected mocks and cookies, delays, etc.).
+```js
+fetch(add + '/mockaton/reset', {
+  method: 'PATCH'
+})
 ```
-PATCH /mockaton/reset
-```
----
 
-### `/mockaton/cookies` Select a cookie
+### Select a cookie
 In `Config.cookies`, each key is the label used
 for changing it. Only one cookie can be set.
-```
-PATCH /mockaton/cookies
-{
-  "current_cookie_key": "My Normal User"
-}
+```js
+fetch(addr + '/mockaton/cookies', {
+  method: 'PATCH',
+  body: JSON.stringify('My Normal User')
+})
 ```
 
-### `/mockaton/cookies` List Cookies
+### List Cookies
 Sends a list of the available cookies along with a flag indicated if it’s the selected.
-```
-GET /mockaton/cookies
+```js
+fetch(addr + '/mockaton/cookies')
 ```
 
----
-
-### `/mockaton/transform` Select a Transform
+### Select a Transform
+```js
+fetch(addr + '/mockaton/transform', {
+  method: 'PATCH',
+  body: JSON.stringify('api/video/list(concat newly uploaded).GET.200.mjs')
+})
 ```
-PATCH /mockaton/transform
-{
-  "file": "api/video/list(concat newly uploaded).GET.200.mjs"
-}
+
+### Update Fallback Proxy
+```js
+fetch(addr + '/mockaton/fallback', {
+  method: 'PATCH',
+  body: JSON.stringify('http://example.com')
+})
 ```
----

package/Tests.js

@@ -96,6 +96,9 @@ 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 }))
 
+// JavaScript to JSON
+write('/api/object.GET.200.js', 'export default { JSON_FROM_JS: true }')
+
 writeStatic('index.html', '<h1>Static</h1>')
 writeStatic('assets/app.js', 'const app = 1')
 writeStatic('another-entry/index.html', '<h1>Another</h1>')
@@ -118,6 +121,8 @@ async function runTests() {
 	for (const [url, file, body] of fixtures)
 		await testMockDispatching(url, file, body)
 
+	await testMockDispatching('/api/object', 'api/object.GET.200.js', { JSON_FROM_JS: true }, undefined, mimeFor('.json'))
+
 	await testItUpdatesDelayAndFile(
 		'/api/alternative',
 		'api/alternative(comment-2).GET.200.json',
@@ -185,9 +190,9 @@ async function test404() {
 	})
 }
 
-async function testMockDispatching(url, file, expectedBody, reqBody = void 0) {
+async function testMockDispatching(url, file, expectedBody, reqBody = void 0, forcedMime = void 0) {
 	const { urlMask, method, status } = Route.parseFilename(file)
-	const mime = mimeFor(file)
+	const mime = forcedMime || mimeFor(file)
 	const now = new Date()
 	const res = await request(url, { method, body: reqBody })
 	const body = mime === 'application/json'
@@ -269,7 +274,7 @@ async function testExtractsAllComments(expected) {
 async function testItBulkSelectsByComment(comment, tests) {
 	await request(API.bulkSelect, {
 		method: 'PATCH',
-		body: JSON.stringify({ [DF.comment]: comment })
+		body: JSON.stringify(comment)
 	})
 	for (const [url, file, body] of tests)
 		await testMockDispatching(url, file, body)
@@ -289,7 +294,7 @@ async function testItUpdatesUserRole() {
 		it('Update the selected cookie', async () => {
 			await request(API.cookies, {
 				method: 'PATCH',
-				body: JSON.stringify({ [DF.currentCookieKey]: 'userB' })
+				body: JSON.stringify('userB')
 			})
 			const res = await request(API.cookies)
 			deepEqual(await res.json(), [
@@ -313,7 +318,7 @@ export default function (mock, reqBody, config) {
 		await reset() // for registering the files
 		await request(API.transform, {
 			method: 'PATCH',
-			body: JSON.stringify({ [DF.file]: 'api/transform.POST.200.mjs' })
+			body: JSON.stringify('api/transform.POST.200.mjs')
 		})
 		await testMockDispatching('/api/transform',
 			'api/transform.POST.200.json',
@@ -367,6 +372,7 @@ async function testInvalidFilenamesAreIgnored() {
 async function testEnableFallbackSoRoutesWithoutMocksGetRelayed() {
 	await describe('Fallback', async () => {
 		const fallbackServer = createServer((_, response) => {
+			response.setHeader('custom_header', 'my_custom_header')
 			response.statusCode = 423
 			response.end('From_Fallback_Server')
 		})
@@ -378,6 +384,7 @@ async function testEnableFallbackSoRoutesWithoutMocksGetRelayed() {
 		})
 		await it('Relays to fallback server', async () => {
 			const res = await request('/non-existing-mock')
+			equal(res.headers.get('custom_header'), 'my_custom_header')
 			equal(res.status, 423)
 			equal(await res.text(), 'From_Fallback_Server')
 			fallbackServer.close()

package/package.json

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

package/sample-mocks/api/user/likes.GET.200.js

@@ -0,0 +1,7 @@
+// You can write JSON responses in JavaScript.
+
+export default [
+	{ id: 0 },
+	{ id: 1 },
+	{ id: 2 },
+]

package/src/Api.js

@@ -51,8 +51,7 @@ function listMockBrokers(_, response) {
 
 async function selectCookie(req, response) {
 	try {
-		const body = await parseJSON(req)
-		cookie.setCurrent(body[DF.currentCookieKey])
+		cookie.setCurrent(await parseJSON(req))
 		sendOK(response)
 	}
 	catch (error) {
@@ -84,8 +83,7 @@ async function updateBroker(req, response) {
 
 async function bulkUpdateBrokersByCommentTag(req, response) {
 	try {
-		const body = await parseJSON(req)
-		mockBrokersCollection.setMocksMatchingComment(body[DF.comment])
+		mockBrokersCollection.setMocksMatchingComment(await parseJSON(req))
 		sendOK(response)
 	}
 	catch (error) {
@@ -96,9 +94,9 @@ async function bulkUpdateBrokersByCommentTag(req, response) {
 
 async function updateBrokerTransform(req, response) {
 	try {
-		const body = await parseJSON(req)
-		const broker = mockBrokersCollection.getBrokerByFilename(body[DF.file])
-		broker.updateTransform(body[DF.file])
+		const file = await parseJSON(req)
+		const broker = mockBrokersCollection.getBrokerByFilename(file)
+		broker.updateTransform(file)
 		sendOK(response)
 	}
 	catch (error) {

package/src/ApiConstants.js

@@ -1,7 +1,7 @@
 const MOUNT = '/mockaton'
 export const API = {
 	dashboard: MOUNT,
-	bulkSelect: MOUNT + '/bulk-select',
+	bulkSelect: MOUNT + '/bulk-select-by-comment',
 	comments: MOUNT + '/comments',
 	edit: MOUNT + '/edit',
 	mocks: MOUNT + '/mocks',
@@ -12,9 +12,7 @@ export const API = {
 }
 
 export const DF = { // Dashboard Fields (XHR)
-	comment: 'comment',
 	delayed: 'delayed',
 	file: 'file',
-	currentCookieKey: 'current_cookie_key',
 	isForDashboard: 'mock_request_payload'
 }

package/src/Config.js

@@ -1,4 +1,4 @@
-import { existsSync, lstatSync } from 'node:fs'
+import { existsSync as exists, lstatSync } from 'node:fs'
 import { validate, is, optional } from './utils/validate.js'
 
 
@@ -12,7 +12,7 @@ export const Config = {
 	database: {},
 	skipOpen: false,
 	proxyFallback: '', // e.g. http://localhost:9999
-	allowedExt: /\.(json|txt|md|mjs)$/ // Just for excluding temporary editor files (e.g. JetBrains appends a ~)
+	allowedExt: /\.(json|txt|md|js|mjs)$/ // Just for excluding temporary editor files (e.g. JetBrains appends a ~)
 }
 
 export function setup(options) {
@@ -32,7 +32,7 @@ export function setup(options) {
 }
 
 function isDirectory(dir) {
-	return existsSync(dir) && lstatSync(dir).isDirectory()
+	return exists(dir) && lstatSync(dir).isDirectory()
 }
 
 

package/src/Dashboard.js

@@ -103,7 +103,7 @@ function CookieSelector({ list }) {
 				onChange() {
 					fetch(API.cookies, {
 						method: 'PATCH',
-						body: JSON.stringify({ [DF.currentCookieKey]: this.value })
+						body: JSON.stringify(this.value)
 					})
 						.then(init)
 						.catch(console.error)
@@ -124,7 +124,7 @@ function BulkSelector({ comments }) {
 			onChange() {
 				fetch(API.bulkSelect, {
 					method: 'PATCH',
-					body: JSON.stringify({ [DF.comment]: this.value })
+					body: JSON.stringify(this.value)
 				})
 					.then(init)
 					.catch(console.error)
@@ -274,7 +274,7 @@ function TransformSelector({ items, selected }) {
 			onChange() {
 				fetch(API.transform, {
 					method: 'PATCH',
-					body: JSON.stringify({ [DF.file]: this.value })
+					body: JSON.stringify(this.value)
 				}).then(() => {
 					this.closest('tr').querySelector('a').click()
 					this.className = className(this.value === this.options[0].value)

package/src/MockDispatcher.js

@@ -31,15 +31,19 @@ export async function dispatchMock(req, response) {
 		const { file, status, delay, currentTransform } = broker
 		console.log('\n', req.url, '→\n ', file)
 
+		const shouldJavaScriptToJSON = file.endsWith('.js')
 		response.statusCode = status
-		response.setHeader('content-type', mimeFor(file))
+		response.setHeader('content-type', mimeFor(shouldJavaScriptToJSON ? '.json' : file))
 		if (cookie.getCurrent())
 			response.setHeader('set-cookie', cookie.getCurrent())
 
-		let mockAsText = readMock(file)
+		let mockAsText = shouldJavaScriptToJSON
+			? JSON.stringify(await importDefault(file))
+			: readMock(file)
+
 		if (broker.currentTransform) {
 			const body = await requestBodyForTransform(req, mockAsText)
-			const transformFunc = await importTransformFunc(currentTransform)
+			const transformFunc = await importDefault(currentTransform)
 			mockAsText = transformFunc(mockAsText, body, Config)
 		}
 		setTimeout(() => response.end(mockAsText), delay)
@@ -69,7 +73,7 @@ function readMock(file) {
 	return readFileSync(join(Config.mocksDir, file), 'utf8')
 }
 
-async function importTransformFunc(file) {
+async function importDefault(file) {
 	// The date param is just for cache busting
 	return (await import(join(Config.mocksDir, file) + '?' + Date.now())).default
 }

package/src/ProxyRelay.js

@@ -6,6 +6,6 @@ export async function proxy(req, response) {
 		method: req.method,
 		headers: req.headers
 	})
-	response.writeHead(proxyResponse.status, proxyResponse.headers)
+	response.writeHead(proxyResponse.status, Object.fromEntries(proxyResponse.headers))
 	response.end(await proxyResponse.text())
 }

package/src/mockBrokersCollection.js

@@ -34,7 +34,7 @@ export function init() {
 			continue
 		}
 		collection[method] ??= {}
-		if (!(urlMask in collection[method]))
+		if (!collection[method][urlMask])
 			collection[method][urlMask] = new MockBroker(file)
 		else
 			collection[method][urlMask].register(file)