foundation simulator handles json serving (#283)

thefrontside · Aug 12, 2024 · f20a3a6 · f20a3a6
1 parent 74f4cd3
commit f20a3a6
Show file tree

Hide file tree

Showing 8 changed files with 82 additions and 0 deletions.
diff --git a/.changes/serve-json-files.md b/.changes/serve-json-files.md
@@ -0,0 +1,5 @@
+---
+"@simulacrum/foundation-simulator": minor:feat
+---
+
+We now support serving a directly of JSON files through file path routing. Use `serveJsonFiles` to specify the folder which contains the files to serve.
diff --git a/package-lock.json b/package-lock.json
diff --git a/packages/foundation/example/extensiveServer/index.ts b/packages/foundation/example/extensiveServer/index.ts
@@ -5,6 +5,7 @@ import { extendRouter } from "./extend-api";
 
 export const simulation = createFoundationSimulationServer({
   port: 9999,
+  serveJsonFiles: `${__dirname}/jsonFiles`,
   openapi,
   extendStore,
   extendRouter,

diff --git a/packages/foundation/example/extensiveServer/jsonFiles/route-to-test.json b/packages/foundation/example/extensiveServer/jsonFiles/route-to-test.json
@@ -0,0 +1,3 @@
+{
+  "status": "quite ok"
+}
diff --git a/packages/foundation/example/singleFileServer/index.ts b/packages/foundation/example/singleFileServer/index.ts
@@ -68,6 +68,7 @@ const openapiSchemaWithModificationsForSimulation = {
 
 export const simulation = createFoundationSimulationServer({
   port: 9999,
+  serveJsonFiles: `${__dirname}/jsonFiles`,
   openapi: [
     {
       document: [

diff --git a/packages/foundation/example/singleFileServer/jsonFiles/route-to-test.json b/packages/foundation/example/singleFileServer/jsonFiles/route-to-test.json
@@ -0,0 +1,3 @@
+{
+  "status": "quite ok"
+}
diff --git a/packages/foundation/package.json b/packages/foundation/package.json
@@ -40,6 +40,7 @@
   "dependencies": {
     "ajv-formats": "^3.0.1",
     "express": "^4.19.2",
+    "fdir": "^6.2.0",
     "openapi-backend": "^5.10.6",
     "openapi-merge": "^1.3.2",
     "starfx": "^0.12.0"

diff --git a/packages/foundation/src/index.ts b/packages/foundation/src/index.ts
@@ -3,6 +3,9 @@ import type {
   Request as ExpressRequest,
   Response as ExpressResponse,
 } from "express";
+import { fdir } from "fdir";
+import fs from "node:fs";
+import path from "node:path";
 import { merge } from "lodash";
 import OpenAPIBackend from "openapi-backend";
 import type {
@@ -47,11 +50,13 @@ export function createFoundationSimulationServer<
   ExtendedSimulationSelectors
 >({
   port = 9000,
+  serveJsonFiles,
   openapi,
   extendStore,
   extendRouter,
 }: {
   port: number;
+  serveJsonFiles?: string;
   openapi?: {
     document: Document | (Document | RecursivePartial<Document>)[];
     handlers: (
@@ -89,6 +94,26 @@ export function createFoundationSimulationServer<
     app.use(express.json());
     let simulationStore = createSimulationStore(extendStore);
 
+    if (serveJsonFiles) {
+      const jsonFiles = new fdir()
+        .filter((path, _isDirectory) => path.endsWith(".json"))
+        .withDirs()
+        .withRelativePaths()
+        .crawl(serveJsonFiles)
+        .sync();
+
+      if (jsonFiles.length > 0) {
+        for (let jsonFile of jsonFiles) {
+          const route = jsonFile.slice(0, jsonFile.length - 5);
+          const filename = path.join(serveJsonFiles, jsonFile);
+          app.get(`/${route}`, (_req, res) => {
+            res.setHeader("content-type", "application/json");
+            fs.createReadStream(filename).pipe(res);
+          });
+        }
+      }
+    }
+
     if (extendRouter) {
       extendRouter(app, simulationStore);
     }