mockaton 7.5.2 → 7.6.0

package/README.md

@@ -150,6 +150,8 @@ export default function optionalName(request, response) {
 }
 ```
 
+If you need to serve a static `.js` file, put it in `Config.staticDir`.
+
 
 ## File Name Convention
 
@@ -203,6 +205,16 @@ api/foo/.GET.200.json
 
 ---
 
+## `Config.staticDir`
+Files under `Config.staticDir` don’t use the filename convention.
+Also, they take precedence over the `GET` mocks in `Config.mockDir`.
+
+For example, if you have two files for `GET /foo/bar.jpg`
+```
+my-static-dir/foo/bar.jpg
+ my-mocks-dir/foo/bar.jpg.GET.200.jpg // Unreacheable
+```
+
 
 ## `Config.proxyFallback`
 Lets you specify a target server for serving routes you don’t have mocks for.
@@ -359,4 +371,5 @@ await mockaton.reset()
 
 ## TODO
 - Refactor Tests
-- Dashboard. List `staticDir` and indicate if it’s overriding some mock.
+- Dashboard. Indicate if some static it’s overriding a mock.
+- jsonc, json5

package/package.json

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

package/src/Api.js

@@ -8,6 +8,7 @@ import { cookie } from './cookie.js'
 import { Config } from './Config.js'
 import { DF, API } from './ApiConstants.js'
 import { parseJSON } from './utils/http-request.js'
+import { listFilesRecursively } from './utils/fs.js'
 import * as mockBrokersCollection from './mockBrokersCollection.js'
 import { sendOK, sendBadRequest, sendJSON, sendFile } from './utils/http-response.js'
 
@@ -23,7 +24,8 @@ export const apiGetRequests = new Map([
 	[API.mocks, listMockBrokers],
 	[API.cookies, listCookies],
 	[API.comments, listComments],
-	[API.cors, getIsCorsAllowed]
+	[API.cors, getIsCorsAllowed],
+	[API.static, listStaticFiles]
 ])
 
 export const apiPatchRequests = new Map([
@@ -128,3 +130,17 @@ async function setCorsAllowed(req, response) {
 		sendBadRequest(response, error)
 	}
 }
+
+
+// TESTME
+async function listStaticFiles(req, response) {
+	try {
+		const files = Config.staticDir
+			? listFilesRecursively(Config.staticDir).filter(f => !Config.ignore.test(f))
+			: []
+		sendJSON(response, files)
+	}
+	catch (error) {
+		sendBadRequest(response, error)
+	}
+}

package/src/ApiConstants.js

@@ -9,7 +9,8 @@ export const API = {
 	reset: MOUNT + '/reset',
 	cookies: MOUNT + '/cookies',
 	fallback: MOUNT + '/fallback',
-	cors: MOUNT + '/cors'
+	cors: MOUNT + '/cors',
+	static: MOUNT + '/static'
 }
 
 export const DF = { // Dashboard Fields (XHR)

package/src/Commander.js

@@ -52,6 +52,10 @@ export class Commander {
 		return this.#patch(API.cors, value)
 	}
 
+	listStaticFiles() {
+		return this.#get(API.static)
+	}
+
 
 	#get(api) {
 		return fetch(this.#addr + api)

package/src/Dashboard.css

@@ -88,9 +88,9 @@ menu {
 	gap: 16px;
 
 	img {
-		width: 140px;
+		width: 130px;
 		align-self: center;
-		margin-right: 75px;
+		margin-right: 85px;
 	}
 
 	label {
@@ -311,6 +311,30 @@ main {
 	font-weight: bold;
 }
 
+.StaticFilesList {
+	margin-top: 40px;
+
+	summary {
+		margin-bottom: 8px;
+		cursor: pointer;
+	}
+
+	li {
+		list-style: none;
+	}
+
+	a {
+		color: var(--colorAccent);
+		text-decoration: none;
+		padding: 3px 0;
+		display: inline-block;
+
+		&:hover {
+			text-decoration: underline;
+		}
+	}
+}
+
 
 /* 
  * Prism 

package/src/Dashboard.js

@@ -14,6 +14,7 @@ const Strings = {
 	mock: 'Mock',
 	reset: 'Reset',
 	select_one: 'Select One',
+	static: 'Static',
 	title: 'Mockaton'
 }
 
@@ -25,6 +26,7 @@ const CSS = {
 	PayloadViewer: 'PayloadViewer',
 	PreviewLink: 'PreviewLink',
 	ProgressBar: 'ProgressBar',
+	StaticFilesList: 'StaticFilesList',
 
 	bold: 'bold',
 	chosen: 'chosen',
@@ -42,20 +44,21 @@ function init() {
 		mockaton.listMocks(),
 		mockaton.listCookies(),
 		mockaton.listComments(),
-		mockaton.getCorsAllowed()
+		mockaton.getCorsAllowed(),
+		mockaton.listStaticFiles()
 	].map(api => api.then(response => response.ok && response.json())))
 		.then(App)
 		.catch(console.error)
 }
 init()
 
-function App([brokersByMethod, cookies, comments, corsAllowed]) {
+function App([brokersByMethod, cookies, comments, corsAllowed, staticFiles]) {
 	empty(document.body)
 	createRoot(document.body).render(
-		DevPanel(brokersByMethod, cookies, comments, corsAllowed))
+		DevPanel(brokersByMethod, cookies, comments, corsAllowed, staticFiles))
 }
 
-function DevPanel(brokersByMethod, cookies, comments, corsAllowed) {
+function DevPanel(brokersByMethod, cookies, comments, corsAllowed, staticFiles) {
 	document.title = Strings.title
 	return (
 		r('div', null,
@@ -71,7 +74,8 @@ function DevPanel(brokersByMethod, cookies, comments, corsAllowed) {
 				r('div', { className: CSS.PayloadViewer },
 					r('h2', { ref: refPayloadFile }, Strings.mock),
 					r('pre', null,
-						r('code', { ref: refPayloadViewer }, Strings.click_link_to_preview))))))
+						r('code', { ref: refPayloadViewer }, Strings.click_link_to_preview)))),
+			r(StaticFilesList, { staticFiles })))
 }
 
 function CookieSelector({ list }) {
@@ -140,6 +144,24 @@ function ResetButton() {
 	)
 }
 
+function StaticFilesList({ staticFiles }) {
+	console.log(staticFiles)
+	if (!staticFiles.length)
+		return null
+	return (
+		r('details', {
+				open: true,
+				className: CSS.StaticFilesList
+			},
+			r('summary', null, Strings.static),
+			r('ul', null,
+				staticFiles.map(f =>
+					r('li', null,
+						r('a', {
+							href: f,
+							target: '_blank'
+						}, f))))))
+}
 
 
 function SectionByMethod({ method, brokers }) {

package/src/Mockaton.js

@@ -46,13 +46,13 @@ async function onRequest(req, response) {
 	if (isPreflight(req))
 		sendNoContent(response)
 
-	else if (method === 'GET' && apiGetRequests.has(url))
-		apiGetRequests.get(url)(req, response)
-
 	else if (method === 'PATCH' && apiPatchRequests.has(url))
 		await apiPatchRequests.get(url)(req, response)
 
-	else if (isStatic(req))
+	else if (method === 'GET' && apiGetRequests.has(url))
+		apiGetRequests.get(url)(req, response)
+
+	else if (method === 'GET' && isStatic(req))
 		await dispatchStatic(req, response)
 
 	else

package/src/StaticDispatcher.js

@@ -5,11 +5,16 @@ import { sendFile, sendPartialContent, sendNotFound } from './utils/http-respons
 
 
 export function isStatic(req) {
-	return Config.staticDir && resolvePath(req)
+	if (!Config.staticDir)
+		return false
+
+	const f = resolvePath(req.url)
+	return !Config.ignore.test(f) // TESTME
+		&& Boolean(f)
 }
 
 export async function dispatchStatic(req, response) {
-	const file = resolvePath(req)
+	const file = resolvePath(req.url)
 	if (!file)
 		sendNotFound(response)
 	else if (req.headers.range)
@@ -18,8 +23,8 @@ export async function dispatchStatic(req, response) {
 		sendFile(response, file)
 }
 
-function resolvePath(req) {
-	let candidate = join(Config.staticDir, req.url)
+function resolvePath(url) {
+	let candidate = join(Config.staticDir, url)
 	if (isDirectory(candidate))
 		candidate += '/index.html'
 	if (isFile(candidate))