@contrast/route-coverage 1.11.2 → 1.13.0

package/lib/index.js

@@ -32,8 +32,9 @@ module.exports = function init(core) {
 
   /** @type {Map<string, import('@contrast/common').RouteInfo>} */
   const routeInfo = new Map();
+  const recentlyObserved = new Set();
 
-  core.routeCoverage = {
+  const routeCoverage = core.routeCoverage = {
     discover(info) {
       routeInfo.set(routeIdentifier(info), info);
       messages.emit(Event.ROUTE_COVERAGE_DISCOVERY, info);
@@ -56,11 +57,16 @@ module.exports = function init(core) {
         return;
       }
 
+      route.url = info.url;
       const store = scopes.sources.getStore();
       if (store && !store.route) {
         store.route = route;
       }
 
+      if (recentlyObserved.has(route.signature)) return;
+
+      recentlyObserved.add(route.signature);
+
       // these events need source correlation
       messages.emit(Event.ROUTE_COVERAGE_OBSERVATION, {
         ...route,
@@ -70,6 +76,7 @@ module.exports = function init(core) {
 
     install() {
       callChildComponentMethodsSync(this, 'install');
+      setInterval(() => recentlyObserved.clear(), 10000).unref();
     },
   };
 
@@ -78,5 +85,5 @@ module.exports = function init(core) {
   require('./install/fastify')(core);
   require('./install/koa')(core);
 
-  return core.routeCoverage;
+  return routeCoverage;
 };

package/lib/install/express.js

@@ -78,8 +78,9 @@ module.exports = function init(core) {
         const [req] = data.args;
         const method = req?.method && toLowerCase(req.method);
         const url = `${req.baseUrl}${req._parsedUrl.pathname}`;
+        const normalizedUrl = req.route.path;
         const { signature } = signatureMap.get(route.signature);
-        if (method) routeCoverage.observe({ signature, url, method });
+        if (method) routeCoverage.observe({ signature, url, method, normalizedUrl });
       }
     });
   }
@@ -92,7 +93,7 @@ module.exports = function init(core) {
   }
 
   function discoverRoute({ signature, url, method }) {
-    routeCoverage.discover({ signature, url, method });
+    routeCoverage.discover({ signature, url, method, normalizedUrl: url });
   }
 
   function instrumentRoute(router, route) {

package/lib/install/fastify.js

@@ -58,7 +58,8 @@ module.exports = function init(core) {
       pre(data) {
         const [request] = data.args;
         const { method } = request.raw;
-        emitObservation(url, method);
+        const [parsedUrl] = request.url.split(/\?/);
+        emitObservation(parsedUrl, url, method);
       },
     });
   }
@@ -69,17 +70,18 @@ module.exports = function init(core) {
    */
   function emitRouteCoverage(url, method) {
     method = toLowerCase(method);
-    const event = { signature: createSignature(url, method), url, method };
+    const event = { signature: createSignature(url, method), url, method, normalizedUrl: url };
     routeCoverage.discover(event);
   }
 
   /**
    * @param {string} url
+   * @param {string} normalizedUrl
    * @param {string=} method
    */
-  function emitObservation(url, method) {
+  function emitObservation(url, normalizedUrl, method) {
     method = method && toLowerCase(method);
-    routeCoverage.observe({ method, url });
+    routeCoverage.observe({ method, url, normalizedUrl });
   }
 
   return core.routeCoverage.fastify = {

package/lib/install/koa.js

@@ -21,7 +21,7 @@ module.exports = function init(core) {
   const { patcher, depHooks, routeCoverage } = core;
 
   function emitRouteCoverage(url, method) {
-    const event = { signature: createSignature(url, method), url, method };
+    const event = { signature: createSignature(url, method), url, method, normalizedUrl: url };
     routeCoverage.discover(event);
   }
 
@@ -30,8 +30,9 @@ module.exports = function init(core) {
       const req = ctx.request;
 
       if (req) {
-        const { method } = req;
-        routeCoverage.observe({ url: path, method: toLowerCase(method || '') });
+        const { url: reqUrl, method } = req;
+        const [url] = reqUrl.split(/\?/);
+        routeCoverage.observe({ url, method: toLowerCase(method || ''), normalizedUrl: path });
       }
 
       await next();

package/lib/utils/route-info.js

@@ -31,6 +31,6 @@ function createSignature(path, method = '') {
  * @param {Pick<import('../index').RouteInfo, 'method' | 'url'>} info
  * @return {string}
  */
-const routeIdentifier = (info) => `${info.method}.${info.url}`;
+const routeIdentifier = (info) => `${info.method}.${info.normalizedUrl}`;
 
 module.exports = { createSignature, routeIdentifier, patchType };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@contrast/route-coverage",
-  "version": "1.11.2",
+  "version": "1.13.0",
   "description": "Handles route discovery and observation",
   "license": "SEE LICENSE IN LICENSE",
   "author": "Contrast Security <nodejs@contrastsecurity.com> (https://www.contrastsecurity.com)",
@@ -17,6 +17,6 @@
     "test": "../scripts/test.sh"
   },
   "dependencies": {
-    "@contrast/common": "1.15.1"
+    "@contrast/common": "1.16.0"
   }
 }