add simulation logger

thefrontside · Aug 13, 2024 · ab1c616 · ab1c616
1 parent 5e0c9cc
commit ab1c616
Show file tree

Hide file tree

Showing 9 changed files with 72 additions and 4 deletions.
diff --git a/.changes/foundation-sim-logger.md b/.changes/foundation-sim-logger.md
@@ -0,0 +1,5 @@
+---
+"@simulacrum/foundation-simulator": minor:feat
+---
+
+All routes now add a log to the simulation state on every visit. This assists in tracking hits on each simulation route.
diff --git a/package-lock.json b/package-lock.json
diff --git a/packages/foundation/example/extensiveServer/store.ts b/packages/foundation/example/extensiveServer/store.ts
@@ -54,6 +54,7 @@ const inputSelectors = ({
 };
 
 export const extendStore = {
+  logs: false,
   actions: inputActions,
   selectors: inputSelectors,
   schema: inputSchema,

diff --git a/packages/foundation/example/singleFileServer/index.ts b/packages/foundation/example/singleFileServer/index.ts
@@ -93,6 +93,7 @@ export const simulation = createFoundationSimulationServer({
     },
   ],
   extendStore: {
+    logs: false,
     actions: ({ thunks, schema }) => {
       // TODO attempt to remove this type as a requirement
       let upsertTest = thunks.create<AnyState>(

diff --git a/packages/foundation/package.json b/packages/foundation/package.json
@@ -39,6 +39,7 @@
   },
   "dependencies": {
     "ajv-formats": "^3.0.1",
+    "cors": "^2.8.5",
     "express": "^4.19.2",
     "fdir": "^6.2.0",
     "openapi-backend": "^5.10.6",

diff --git a/packages/foundation/src/index.ts b/packages/foundation/src/index.ts
@@ -1,4 +1,5 @@
 import express from "express";
+import cors from "cors";
 import type {
   Request as ExpressRequest,
   Response as ExpressResponse,
@@ -96,10 +97,23 @@ export function createFoundationSimulationServer<
 }) {
   return () => {
     let app = express();
+    app.use(cors());
     app.use(express.json());
     app.use(express.urlencoded({ extended: false }));
     let simulationStore = createSimulationStore(extendStore);
 
+    app.use((req, res, next) => {
+      simulationStore.store.dispatch(
+        simulationStore.actions.simulationLog({
+          method: req.method,
+          url: req.url,
+          query: req.query,
+          body: req.body,
+        })
+      );
+      next();
+    });
+
     if (serveJsonFiles) {
       const jsonFiles = new fdir()
         .filter((path, _isDirectory) => path.endsWith(".json"))
@@ -237,10 +251,13 @@ export function createFoundationSimulationServer<
       let routes = simulationStore.schema.simulationRoutes.selectTableAsList(
         simulationStore.store.getState()
       );
+      let logs = simulationStore.schema.simulationLogs.selectTableAsList(
+        simulationStore.store.getState()
+      );
       if (routes.length === 0) {
         res.sendStatus(404);
       } else {
-        res.status(200).send(generateRoutesHTML(routes));
+        res.status(200).send(generateRoutesHTML(routes, logs));
       }
     });
     app.post("/", (req, res) => {
@@ -272,6 +289,7 @@ export function createFoundationSimulationServer<
 
         return {
           server,
+          simulationStore,
           ensureClose: async () => {
             await new Promise<void>((resolve) => {
               server.once("close", resolve);

diff --git a/packages/foundation/src/routeTemplate.ts b/packages/foundation/src/routeTemplate.ts
@@ -1,4 +1,4 @@
-import type { SimulationRoute } from "./store/schema";
+import type { SimulationLog, SimulationRoute } from "./store/schema";
 
 const responseSubmit = (routeId: string, response: number) => /* HTML */ `<form
   action=""
@@ -8,7 +8,10 @@ const responseSubmit = (routeId: string, response: number) => /* HTML */ `<form
 </form>`;
 const routeToId = (route: SimulationRoute) => `${route.method}:${route.url}`;
 
-export const generateRoutesHTML = (routes: SimulationRoute[]) => {
+export const generateRoutesHTML = (
+  routes: SimulationRoute[],
+  logs: SimulationLog[]
+) => {
   return /* HTML */ `<!DOCTYPE html>
     <html>
       <head>
@@ -61,7 +64,8 @@ export const generateRoutesHTML = (routes: SimulationRoute[]) => {
       </head>
       <body>
         <main class="my-12">
-          <h1>Simulation Routes</h1>
+          <h1>Simulation</h1>
+          <h2>Routes</h2>
           <div class="routes">
             <span>Method</span>
             <span>URL</span>
@@ -85,6 +89,10 @@ export const generateRoutesHTML = (routes: SimulationRoute[]) => {
               )
               .join("\n")}
           </div>
+          <h2>Logs</h2>
+          <div class="simulation-logs">
+            ${logs.map((log) => `<div>${log.message}</div>`).join("")}
+          </div>
         </main>
       </body>
     </html>`;

diff --git a/packages/foundation/src/store/index.ts b/packages/foundation/src/store/index.ts
@@ -74,6 +74,26 @@ export function createSimulationStore<
       yield* next();
     }
   );
+  let simulationLog = thunks.create<{
+    method: string;
+    url: string;
+    query: Record<string, any>;
+    body: any;
+  }>("simulationLog", function* (ctx, next) {
+    const { method, url, query, body } = ctx.payload;
+    const timestamp = Date.now();
+    yield* schema.update(
+      schema.simulationLogs.add({
+        [timestamp]: {
+          timestamp,
+          level: "info",
+          message: `${method} ${url}`,
+          meta: { method, url, query, body },
+        },
+      })
+    );
+    yield* next();
+  });
 
   let additionalTasks = [thunks.bootup];
 
@@ -86,6 +106,7 @@ export function createSimulationStore<
 
   let inputedActions = inputActions({ thunks, store, schema });
   let actions = {
+    simulationLog,
     batchUpdater,
     ...inputedActions,
   };

diff --git a/packages/foundation/src/store/schema.ts b/packages/foundation/src/store/schema.ts
@@ -8,6 +8,13 @@ export type ExtendSimulationSchemaInput<T> = ({
   slice,
 }: ExtendSimulationSchema) => T;
 
+export interface SimulationLog {
+  timestamp: number;
+  level: "debug" | "info" | "error";
+  message: string;
+  meta?: Record<string, any>;
+}
+
 export interface SimulationRoute {
   type: "JSON" | "OpenAPI" | "Explicit";
   url: string;
@@ -25,6 +32,7 @@ export function generateSchemaWithInputSlices<ExtendedSimulationSchema>(
   let schemaAndInitialState = createSchema({
     cache: immerSlice.table({ empty: {} }),
     loaders: immerSlice.loaders(),
+    simulationLogs: immerSlice.table<SimulationLog>(),
     simulationRoutes: immerSlice.table<SimulationRoute>({
       empty: {
         type: "Explicit",