Fix paths for complex Express apps (#50)

Author: itssimon

src/express/middleware.ts

@@ -138,7 +138,7 @@ const getRoutePath = (req: Request) => {
   }
   if (req.baseUrl) {
     const routerPath = getRouterPath(req.app._router.stack, req.baseUrl);
-    return routerPath + req.route.path;
+    return req.route.path === "/" ? routerPath : routerPath + req.route.path;
   }
   return req.route.path;
 };
@@ -147,7 +147,8 @@ const getRouterPath = (stack: any[], baseUrl: string) => {
   const routerPaths: string[] = [];
   while (stack && stack.length > 0) {
     const routerLayer = stack.find(
-      (layer) => layer.name === "router" && layer.regexp?.test(baseUrl),
+      (layer) =>
+        layer.name === "router" && layer.path && layer.regexp?.test(baseUrl),
     );
     if (routerLayer) {
       if (routerLayer.keys.length > 0) {
@@ -165,7 +166,7 @@ const getRouterPath = (stack: any[], baseUrl: string) => {
       break;
     }
   }
-  return routerPaths.join("");
+  return routerPaths.filter((path) => path !== "/").join("");
 };
 
 const getConsumer = (req: Request) => {

src/express/utils.js

@@ -234,7 +234,7 @@ export const getEndpoints = function (app, basePath) {
       .filter((method) => !["HEAD", "OPTIONS"].includes(method.toUpperCase()))
       .map((method) => ({
         method,
-        path: basePath + route.path,
+        path: (basePath + route.path).replace(/\/\//g, "/"),
       })),
   );
 };

tests/express/app.test.ts

@@ -193,11 +193,19 @@ describe("Middleware for Express with nested routers", () => {
   });
 
   it("Request logger", async () => {
+    await appTest.get("/health").expect(200);
     await appTest.get("/api/v1/hello/bob").expect(200);
     await appTest.get("/api/v2/goodbye/world").expect(200);
+    await appTest.get("/test").expect(200);
 
     const requests = client.requestCounter.getAndResetRequests();
-    expect(requests.length).toBe(2);
+    expect(requests.length).toBe(4);
+    expect(
+      requests.some(
+        (r) =>
+          r.method === "GET" && r.path === "/health" && r.status_code === 200,
+      ),
+    ).toBe(true);
     expect(
       requests.some(
         (r) =>
@@ -214,10 +222,20 @@ describe("Middleware for Express with nested routers", () => {
           r.status_code === 200,
       ),
     ).toBe(true);
+    expect(
+      requests.some(
+        (r) =>
+          r.method === "GET" && r.path === "/test" && r.status_code === 200,
+      ),
+    ).toBe(true);
   });
 
   it("List endpoints", async () => {
     expect(client.startupData?.paths).toEqual([
+      {
+        method: "GET",
+        path: "/health",
+      },
       {
         method: "GET",
         path: "/api/:version/hello/:name",
@@ -226,6 +244,10 @@ describe("Middleware for Express with nested routers", () => {
         method: "GET",
         path: "/api/:version/goodbye/world",
       },
+      {
+        method: "GET",
+        path: "/test",
+      },
     ]);
   });
 

tests/express/app.ts

@@ -104,7 +104,6 @@ export const getAppWithValidator = () => {
     throw new Error("test");
   });
 
-  app.use(errors());
   return app;
 };
 
@@ -124,31 +123,41 @@ export const getAppWithMiddlewareOnRouter = () => {
   });
 
   app.use("/api", router);
-  app.use(errors());
   return app;
 };
 
 export const getAppWithNestedRouters = () => {
   const app = express();
-  const router1 = express.Router({ mergeParams: true });
-  const router2 = express.Router();
+  const router1 = express.Router();
+  const router2 = express.Router({ mergeParams: true });
+  const router3 = express.Router();
+  const router4 = express.Router();
 
   useApitally(app, {
     clientId: CLIENT_ID,
     env: ENV,
     appVersion: "1.2.3",
   });
 
-  router1.get("/hello/:name", (req, res) => {
+  router1.get("/health", (req, res) => {
+    res.send("OK");
+  });
+
+  router2.get("/hello/:name", (req, res) => {
     res.send(`Hello ${req.params.name}!`);
   });
 
-  router2.get("/world", (req, res) => {
+  router3.get("/world", (req, res) => {
     res.send("World!");
   });
 
-  router1.use("/goodbye", router2);
-  app.use("/api/:version", router1);
-  app.use(errors());
+  router4.get("/", (req, res) => {
+    res.send("Success!");
+  });
+
+  router2.use("/goodbye", router3);
+  app.use("/", router1);
+  app.use("/api/:version", router2);
+  app.use("/test", router4);
   return app;
 };