@contrast/route-coverage 1.12.0 → 1.14.0

package/LICENSE

@@ -1,4 +1,4 @@
-Copyright: 2023 Contrast Security, Inc
+Copyright: 2024 Contrast Security, Inc
 Contact: support@contrastsecurity.com
 License: Commercial
 

package/lib/index.d.ts

@@ -1,5 +1,5 @@
 /*
- * Copyright: 2023 Contrast Security, Inc
+ * Copyright: 2024 Contrast Security, Inc
  * Contact: support@contrastsecurity.com
  * License: Commercial
 

package/lib/index.js

@@ -1,5 +1,5 @@
 /*
- * Copyright: 2023 Contrast Security, Inc
+ * Copyright: 2024 Contrast Security, Inc
  * Contact: support@contrastsecurity.com
  * License: Commercial
 
@@ -57,6 +57,7 @@ module.exports = function init(core) {
         return;
       }
 
+      route.url = info.url;
       const store = scopes.sources.getStore();
       if (store && !store.route) {
         store.route = route;
@@ -82,6 +83,7 @@ module.exports = function init(core) {
   require('./install/http')(core);
   require('./install/express')(core);
   require('./install/fastify')(core);
+  require('./install/hapi')(core);
   require('./install/koa')(core);
 
   return routeCoverage;

package/lib/install/express.js

@@ -1,5 +1,5 @@
 /*
- * Copyright: 2023 Contrast Security, Inc
+ * Copyright: 2024 Contrast Security, Inc
  * Contact: support@contrastsecurity.com
  * License: Commercial
 
@@ -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

@@ -1,5 +1,5 @@
 /*
- * Copyright: 2023 Contrast Security, Inc
+ * Copyright: 2024 Contrast Security, Inc
  * Contact: support@contrastsecurity.com
  * License: Commercial
 
@@ -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/hapi.js

@@ -0,0 +1,70 @@
+/*
+ * Copyright: 2024 Contrast Security, Inc
+ * Contact: support@contrastsecurity.com
+ * License: Commercial
+
+ * NOTICE: This Software and the patented inventions embodied within may only be
+ * used as part of Contrast Security’s commercial offerings. Even though it is
+ * made available through public repositories, use of this Software is subject to
+ * the applicable End User Licensing Agreement found at
+ * https://www.contrastsecurity.com/enduser-terms-0317a or as otherwise agreed
+ * between Contrast Security and the End User. The Software may not be reverse
+ * engineered, modified, repackaged, sold, redistributed or otherwise used in a
+ * way not consistent with the End User License Agreement.
+ */
+'use strict';
+
+const { toLowerCase } = require('@contrast/common');
+const { createSignature, patchType } = require('./../utils/route-info');
+
+module.exports = function init(core) {
+  const { patcher, depHooks, routeCoverage } = core;
+
+  function emitRouteCoverage(url, method) {
+    method = toLowerCase(method);
+    const event = { signature: createSignature(url, method), url, method, normalizedUrl: url };
+    routeCoverage.discover(event);
+  }
+
+  return core.routeCoverage.hapi = {
+    install() {
+      return depHooks.resolve({ name: '@hapi/hapi', version: '>=18 <22' }, (hapi) => {
+        ['server', 'Server'].forEach((server) => {
+          patcher.patch(hapi, server, {
+            name: `hapi.${server}`,
+            patchType,
+            post(data) {
+              patcher.patch(data.result._core.router, 'add', {
+                name: '_core.router.add',
+                patchType,
+                post(data) {
+                  if (!data.args[0] || !data.result) return;
+
+                  const [{ method, path }] = data.args;
+                  if (!method || !path) return;
+
+                  if (Array.isArray(method)) {
+                    method.forEach((verb) => {
+                      emitRouteCoverage(path, verb);
+                    });
+                  } else {
+                    emitRouteCoverage(path, method);
+                  }
+
+                  patcher.patch(data.result.route.settings, 'handler', {
+                    name: 'route.settings.handler',
+                    patchType,
+                    post({ args }) {
+                      const [{ method, path, route }] = args;
+                      routeCoverage.observe({ url: path, method: toLowerCase(method), normalizedUrl: route.path });
+                    }
+                  });
+                }
+              });
+            }
+          });
+        });
+      });
+    }
+  };
+};

package/lib/install/http.js

@@ -1,5 +1,5 @@
 /*
- * Copyright: 2023 Contrast Security, Inc
+ * Copyright: 2024 Contrast Security, Inc
  * Contact: support@contrastsecurity.com
  * License: Commercial
 

package/lib/install/koa.js

@@ -1,5 +1,5 @@
 /*
- * Copyright: 2023 Contrast Security, Inc
+ * Copyright: 2024 Contrast Security, Inc
  * Contact: support@contrastsecurity.com
  * License: Commercial
 
@@ -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

@@ -1,5 +1,5 @@
 /*
- * Copyright: 2023 Contrast Security, Inc
+ * Copyright: 2024 Contrast Security, Inc
  * Contact: support@contrastsecurity.com
  * License: Commercial
 
@@ -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.12.0",
+  "version": "1.14.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,7 @@
     "test": "../scripts/test.sh"
   },
   "dependencies": {
-    "@contrast/common": "1.15.1"
+    "@contrast/common": "1.16.0",
+    "@contrast/fn-inspect": "^4.0.0"
   }
 }