extendRouter in auth0 and GH sim (#341)

* extendRouter in auth0 and GH sim

* lint

Author: jbolda

.changes/extend-auth0-gh-router.md

@@ -0,0 +1,6 @@
+---
+"@simulacrum/auth0-simulator": patch:bug
+"@simulacrum/github-api-simulator": patch:bug
+---
+
+Use the `extend` options and properly pass the `extendRouter` that will allow the user to add or change route handling. Closes #317.

packages/auth0/example/index.mts

@@ -0,0 +1,16 @@
+import { simulation } from "../src/index.ts";
+
+let app = simulation({
+  extend: {
+    extendRouter: (router, _simulationStore) => {
+      router.get("/hello", (_req, res) => {
+        res.status(200).json({ message: "Hello from Auth0 simulator!" });
+      });
+    },
+  },
+});
+app.listen(undefined, () =>
+  console.log(
+    `auth0 simulation server started at https://localhost:4400\nusername: [email protected]\npassword: 12345\n`
+  )
+);

packages/auth0/example/index.ts

@@ -5,8 +5,8 @@
   "main": "./dist/index.cjs",
   "bin": "bin/start.cjs",
   "scripts": {
-    "start": "node --import=tsx ./example/index.ts",
-    "start:bin": "node ./bin/start.js",
+    "start": "node --import=tsx ./example/index.mts",
+    "start:bin": "node ./bin/start.cjs",
     "test": "NODE_EXTRA_CA_CERTS=\"$(mkcert -CAROOT)/rootCA.pem\" vitest run --fileParallelism=false",
     "test:watch": "NODE_EXTRA_CA_CERTS=\"$(mkcert -CAROOT)/rootCA.pem\" vitest watch --fileParallelism=false",
     "prepack": "npm run build",

packages/auth0/package.json

@@ -1,10 +1,10 @@
 import type { SignOptions } from "jsonwebtoken";
-import { sign } from "jsonwebtoken";
+import * as jwt from "jsonwebtoken";
 import { JWKS, PRIVATE_KEY } from "./constants.ts";
 
 export const parseKey = (key: string): string => key.split("~~").join("\n");
 
-type SignPayload = Parameters<typeof sign>[0];
+type SignPayload = Parameters<typeof jwt.sign>[0];
 
 export function createJsonWebToken<P extends SignPayload>(
   payload: P,
@@ -14,5 +14,5 @@ export function createJsonWebToken<P extends SignPayload>(
     keyid: JWKS.keys[0].kid,
   }
 ): string {
-  return sign(payload, privateKey, options);
+  return jwt.sign(payload, privateKey, options);
 }

packages/auth0/src/auth/jwt.ts

@@ -1,4 +1,4 @@
-import express, { type Request, type Express } from "express";
+import express, { type Request, type Express, Router } from "express";
 import type { ExtendedSimulationStore } from "../store/index.ts";
 import { createCors } from "../middleware/create-cors.ts";
 import { noCache } from "../middleware/no-cache.ts";
@@ -11,7 +11,13 @@ import { type Auth0Configuration } from "../types.ts";
 
 const publicDir = path.join(import.meta.dirname, "..", "views", "public");
 export const extendRouter =
-  (config: Auth0Configuration, debug = false) =>
+  (
+    config: Auth0Configuration,
+    extend:
+      | ((router: Router, simulationStore: ExtendedSimulationStore) => void)
+      | undefined,
+    debug = false
+  ) =>
   (router: Express, simulationStore: ExtendedSimulationStore) => {
     const serviceURL = (request: Request) =>
       `${request.protocol}://${request.get("Host")}/`;
@@ -27,7 +33,13 @@ export const extendRouter =
       .use(express.static(publicDir))
       .use(createSession())
       .use(createCors())
-      .use(noCache())
+      .use(noCache());
+
+    if (extend) {
+      extend(router, simulationStore);
+    }
+
+    router
       .get("/health", (_, response) => {
         response.send({ status: "ok" });
       })

packages/auth0/src/handlers/index.ts

@@ -37,10 +37,10 @@ export const simulation: Auth0Simulator = (args = {}) => {
     ? undefined
     : auth0InitialStoreSchema.parse(args?.initialState);
   return createFoundationSimulationServer({
-    port: 4400, // default port
+    port: config.port ?? 4400, // default port
     protocol: "https",
     extendStore: extendStore(parsedInitialState, args?.extend?.extendStore),
-    extendRouter: extendRouter(config, args.debug),
+    extendRouter: extendRouter(config, args.extend?.extendRouter, args.debug),
   })();
 };
 

packages/auth0/src/index.ts

@@ -40,14 +40,27 @@ describe("Auth0 simulator", () => {
   let frontendServer: FoundationSimulatorListening<unknown>;
   beforeAll(async () => {
     frontendServer = await frontendSimulation.listen();
-    const app = simulation();
+    const app = simulation({
+      extend: {
+        extendRouter: (router) => {
+          router.get("/hello-world", (_req, res) => {
+            res.send("Hello World");
+          });
+        },
+      },
+    });
     server = await app.listen(basePort);
   });
   afterAll(async () => {
     await server.ensureClose();
     await frontendServer.ensureClose();
   });
 
+  it("allows extending the router", async () => {
+    let res: Response = await fetch(`${auth0Url}/hello-world`);
+    expect(res.ok).toBe(true);
+  });
+
   describe("/authorize", () => {
     describe("response_mode=query", () => {
       it("has a heartbeat", async () => {

packages/auth0/test/auth0.test.ts

@@ -3,51 +3,58 @@ import { stringify } from "querystring";
 import { createHandler } from "./graphql/handler.ts";
 import type { ExtendedSimulationStore } from "./store/index.ts";
 
-export const extendRouter = (
-  router: Express,
-  simulationStore: ExtendedSimulationStore
-) => {
-  router.get("/health", (_, response) => {
-    response.send({ status: "ok" });
-  });
-
-  router.use("/graphql", createHandler(simulationStore));
+export const extendRouter =
+  (
+    extend:
+      | ((router: Express, simulationStore: ExtendedSimulationStore) => void)
+      | undefined
+  ) =>
+  (router: Express, simulationStore: ExtendedSimulationStore) => {
+    if (extend) {
+      extend(router, simulationStore);
+    }
 
-  router.get(["/login/oauth/authorize"], (request, response) => {
-    const { redirect_uri, state, env } = request.query as {
-      [k: string]: string;
-    };
-    const code = "dev_code";
-    const qs = stringify({
-      code,
-      env,
-      state,
+    router.get("/health", (_, response) => {
+      response.send({ status: "ok" });
     });
 
-    const routerUrl = `${redirect_uri}?${qs}`;
-    response.status(302).redirect(routerUrl);
-  });
+    router.use("/graphql", createHandler(simulationStore));
 
-  router.post(
-    [
-      "/login/oauth/access_token",
-      "/api/v3/app/installations/:id/access_tokens",
-    ],
-    (_request, response) => {
-      // for /login/oauth/access_token
-      const access_token = "dev_access_token";
-      // for /app/installations/:id/access_tokens
-      const token = "dev_token";
-      const refresh_token = "dev_refresh_token";
-      const repository_selection = "all";
-      response.json({
-        access_token,
-        refresh_token,
-        token,
-        repository_selection,
+    router.get(["/login/oauth/authorize"], (request, response) => {
+      const { redirect_uri, state, env } = request.query as {
+        [k: string]: string;
+      };
+      const code = "dev_code";
+      const qs = stringify({
+        code,
+        env,
+        state,
       });
-      response.status(200);
-      response.end();
-    }
-  );
-};
+
+      const routerUrl = `${redirect_uri}?${qs}`;
+      response.status(302).redirect(routerUrl);
+    });
+
+    router.post(
+      [
+        "/login/oauth/access_token",
+        "/api/v3/app/installations/:id/access_tokens",
+      ],
+      (_request, response) => {
+        // for /login/oauth/access_token
+        const access_token = "dev_access_token";
+        // for /app/installations/:id/access_tokens
+        const token = "dev_token";
+        const refresh_token = "dev_refresh_token";
+        const repository_selection = "all";
+        response.json({
+          access_token,
+          refresh_token,
+          token,
+          repository_selection,
+        });
+        response.status(200);
+        response.end();
+      }
+    );
+  };

packages/github-api/src/extend-api.ts

@@ -80,7 +80,7 @@ export const simulation = (
     port: 3300, // default port
     simulationContextPage: "/simulation",
     extendStore: extendStoreConfig,
-    extendRouter,
+    extendRouter: extendRouter(args?.extend?.extendRouter),
     openapi: openapi(
       parsedInitialState,
       args?.apiUrl ?? "/",