@contrast/route-coverage 1.6.0 → 1.8.0

package/lib/index.d.ts

@@ -25,7 +25,7 @@ export interface RouteCoverage extends Installable {
   discover(info: RouteInfo): void;
   delete(info: RouteInfo): void;
   discoveryFinished(): void;
-  observe(info: Pick<RouteInfo, 'method' | 'url'>): void;
+  observe(info: Pick<RouteInfo>): void;
 }
 
 export interface Core {

package/lib/index.js

@@ -46,7 +46,7 @@ module.exports = function init(core) {
     },
 
     observe(info) {
-      const route = routeInfo.get(routeIdentifier(info));
+      const route = info.signature ? info : routeInfo.get(routeIdentifier(info));
 
       if (!route) {
         logger.debug(info, 'unable to observe undiscovered route');

package/lib/install/express.js

@@ -25,8 +25,10 @@ const METHODS = [
   'options',
   'head',
 ];
-
-const { createSignature, patchType } = require('./../utils/route-info');
+// eslint-disable-next-line node/no-extraneous-require
+const fnInspect = require('@contrast/fn-inspect');
+const { createSignature, patchType } = require('../utils/route-info');
+const { join, replace, toLowerCase } = require('@contrast/common');
 
 /**
  * @param {import('..').Core & {
@@ -37,27 +39,81 @@ const { createSignature, patchType } = require('./../utils/route-info');
  */
 module.exports = function init(core) {
   const routers = new Map();
+  const signatureMap = new Map();
   const { patcher, depHooks, routeCoverage } = core;
 
-  function emitRouteCoverage(router, url, method) {
-    const event = { signature: createSignature(url, method), url, method };
-    const layers = routers.get(router) || [];
-    layers.push(event);
-    routers.set(router, layers);
-    routeCoverage.discover(event);
+  function formatUrl(url) {
+    if (Array.isArray(url)) {
+      return `/[${join(url, ', ')}]`;
+    } else if (url instanceof RegExp) {
+      return `/{${replace(url.toString(), /(^\/?)|(\/?$)/g, '')}}`;
+    } else {
+      return url;
+    }
   }
 
-  function handleRouteDiscovery(data, method) {
-    const [url, fn] = data.args;
-    if (!url || !fn) {
-      return;
+  function getLastLayer(router) {
+    if (router.stack) {
+      const len = router.stack.length;
+      return router.stack[len - 1];
     }
-    if (Array.isArray(url)) {
-      url.forEach((path) => {
-        emitRouteCoverage(data.result, path, method);
+  }
+
+  function getLayerHandleMethod(layer) {
+    let methodName = 'handle';
+    const __handleData = fnInspect.funcInfo(layer.__handle);
+    if (__handleData && __handleData.file.includes('express-async-errors')) {
+      methodName = '__handle';
+    }
+    return methodName;
+  }
+
+  function patchHandler(layer, route) {
+    if (!layer) return;
+    const handle = getLayerHandleMethod(layer);
+    patcher.patch(layer, handle, {
+      name: 'express.Router.handle',
+      patchType,
+      post(data) {
+        const [req] = data.args;
+        const method = req?.method && toLowerCase(req.method);
+        const url = `${req.baseUrl}${req._parsedUrl.pathname}`;
+        const { signature } = signatureMap.get(route.signature);
+        if (method) routeCoverage.observe({ signature, url, method });
+      }
+    });
+  }
+
+  function createRoute(url, method, id) {
+    const signature = createSignature(url, method);
+    const route = { signature, url, method, id: id || signature };
+    signatureMap.set(signature, route);
+    return route;
+  }
+
+  function discoverRoute({ signature, url, method }) {
+    routeCoverage.discover({ signature, url, method });
+  }
+
+  function instrumentRoute(router, route) {
+    if (!router) return;
+    const layer = getLastLayer(router);
+    patchHandler(layer, route);
+  }
+
+  function updateRoutes(prefix, router, updatedRouter) {
+    const routes = routers.get(router);
+    const updatedLayers = router === updatedRouter
+      ? [] : (routers.get(updatedRouter) || []);
+    if (routes) {
+      routes.forEach((route) => {
+        const { url, method, id } = route;
+        const newRoute = createRoute(`${prefix}${url}`, method, id);
+        updatedLayers.push(newRoute);
+        signatureMap.set(id, newRoute);
       });
-    } else {
-      emitRouteCoverage(data.result, url, method);
+      routers.set(router, updatedLayers);
+      routers.set(updatedRouter, updatedLayers);
     }
   }
 
@@ -66,36 +122,29 @@ module.exports = function init(core) {
       depHooks.resolve(
         { name: 'express' },
         (express) => {
-          patcher.patch(express.Router, 'handle', {
-            name: 'express.Router.handle',
-            patchType,
-            post(data) {
-              // TODO: Can this handle all route observation?
-              const [req] = data.args;
-              const method = req?.method?.toLowerCase();
-              const url = `${req.baseUrl}${req._parsedUrl.pathname}`;
-              if (method) routeCoverage.observe({ url, method });
-            }
-          });
 
           patcher.patch(express.Router, 'use', {
             name: 'express.Router.use',
             patchType,
             post({ args, result }) {
               const [prefix, router] = args;
-              const layers = routers.get(router);
-              const updatedLayers = [];
-              if (layers) {
-                layers.forEach((layer) => {
-                  const { url, method } = layer;
-                  const updatedUrl = `${prefix}${url}`;
-                  const event = { signature: createSignature(updatedUrl, method), url: updatedUrl, method };
-                  updatedLayers.push(event);
-                  routeCoverage.delete(layer);
-                  routeCoverage.discover(event);
+              if (typeof prefix === 'string' && prefix !== '/') {
+                updateRoutes(prefix, router, result);
+              }
+            }
+          });
+
+          patcher.patch(express.application, 'use', {
+            name: 'express.application.use',
+            patchType,
+            post({ args }) {
+              const idx = args.length;
+              const router = args[idx - 1];
+              const routes = routers.get(router);
+              if (routes) {
+                routes.forEach((route) => {
+                  discoverRoute(route);
                 });
-                routers.delete(router);
-                routers.set(result, updatedLayers);
               }
             }
           });
@@ -104,16 +153,27 @@ module.exports = function init(core) {
             patcher.patch(express.application, method, {
               name: `express.application.${method}`,
               patchType,
-              post(data) {
-                handleRouteDiscovery(data, method);
+              post({ args, result }) {
+                const [url, fn] = args;
+                if (!url || !fn) return;
+                const route = createRoute(formatUrl(url), method);
+                instrumentRoute(result?._router, route);
+                discoverRoute(route);
               }
             });
 
             patcher.patch(express.Router, method, {
               name: `express.Router.${method}`,
               patchType,
-              post(data) {
-                handleRouteDiscovery(data, method);
+              post({ args, obj: router }) {
+                const [url, fn] = args;
+                if (!url || !fn) return;
+                const route = createRoute(formatUrl(url), method);
+                const routes = routers.get(router) || [];
+
+                instrumentRoute(router, route);
+                routes.push(route);
+                routers.set(router, routes);
               }
             });
           });

package/lib/install/fastify.js

@@ -16,6 +16,7 @@
 'use strict';
 
 const { createSignature } = require('./../utils/route-info');
+const { toLowerCase } = require('@contrast/common');
 
 /** @typedef {Parameters<import('fastify3.0.0').onRouteHookHandler>[0]} RouteOptions */
 
@@ -67,7 +68,7 @@ module.exports = function init(core) {
    * @param {string} method
    */
   function emitRouteCoverage(url, method) {
-    method = method.toLowerCase();
+    method = toLowerCase(method);
     const event = { signature: createSignature(url, method), url, method };
     routeCoverage.discover(event);
   }
@@ -77,7 +78,7 @@ module.exports = function init(core) {
    * @param {string=} method
    */
   function emitObservation(url, method) {
-    method = method?.toLowerCase();
+    method = method && toLowerCase(method);
     routeCoverage.observe({ method, url });
   }
 

package/lib/install/koa.js

@@ -15,6 +15,7 @@
 'use strict';
 
 const { createSignature, patchType } = require('./../utils/route-info');
+const { toLowerCase } = require('@contrast/common');
 
 module.exports = function init(core) {
   const { patcher, depHooks, routeCoverage } = core;
@@ -30,7 +31,7 @@ module.exports = function init(core) {
 
       if (req) {
         const { method } = req;
-        routeCoverage.observe({ url: path, method: method.toLowerCase() });
+        routeCoverage.observe({ url: path, method: toLowerCase(method || '') });
       }
 
       await next();
@@ -50,7 +51,7 @@ module.exports = function init(core) {
           emitRouteCoverage(path, 'use');
         } else {
           methods.forEach((method) => {
-            emitRouteCoverage(path, method.toLowerCase());
+            emitRouteCoverage(path, toLowerCase(method || ''));
           });
         }
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@contrast/route-coverage",
-  "version": "1.6.0",
+  "version": "1.8.0",
   "description": "",
   "license": "SEE LICENSE IN LICENSE",
   "author": "Contrast Security <nodejs@contrastsecurity.com> (https://www.contrastsecurity.com)",
@@ -14,6 +14,6 @@
     "test": "../scripts/test.sh"
   },
   "dependencies": {
-    "@contrast/common": "1.10.0"
+    "@contrast/common": "1.12.0"
   }
 }