@contrast/route-coverage 1.20.4 → 1.20.6

package/lib/install/express.js

@@ -28,7 +28,7 @@ const METHODS = [
 
 const fnInspect = require('@contrast/fn-inspect');
 const { createSignature, patchType } = require('../utils/route-info');
-const { join, toLowerCase, isString } = require('@contrast/common');
+const { ArrayPrototypeJoin, StringPrototypeToLowerCase, isString } = require('@contrast/common');
 
 module.exports = function init(core) {
   const { patcher, depHooks, routeCoverage } = core;
@@ -36,10 +36,10 @@ module.exports = function init(core) {
   const observe = (route) => routeCoverage.observe(route);
 
   const isRoute = (layer) => !!layer.route;
-  const isRouter = (layer) => layer.name && toLowerCase(layer.name) === 'router';
+  const isRouter = (layer) => layer.name && StringPrototypeToLowerCase.call(layer.name) === 'router';
   const isValidPath = (path) => isString(path) || Array.isArray(path) || path instanceof RegExp;
-  const regExpToPath = (regex) => regex?.source?.split('/?')[0].replace(/\\/g, '').replace('^', ''); //TODO: replaceAll when v14 deprecated
-  const format = (url) => Array.isArray(url) ? `/[${join(url)}]` : url instanceof RegExp ? `/{${url.toString().slice(1, -1)}}` : url;
+  const regExpToPath = (regex) => regex?.source?.split('/?')[0].replaceAll('\\', '').replace('^', '');
+  const format = (url) => Array.isArray(url) ? `/[${ArrayPrototypeJoin.call(url)}]` : url instanceof RegExp ? `/{${url.toString().slice(1, -1)}}` : url;
   const getHandleMethod = (layer) => fnInspect.funcInfo(layer.__handle)?.file.includes('express-async-errors') ? '__handle' : 'handle';
   const getLastLayer = (router) => router?.stack[router.stack.length - 1];
 
@@ -54,7 +54,8 @@ module.exports = function init(core) {
       signature: createSignature(url, method, obj),
       url,
       normalizedUrl: url,
-      method
+      method,
+      framework: 'express'
     };
   }
 
@@ -68,13 +69,13 @@ module.exports = function init(core) {
         const [url] = req.originalUrl.split('?');
         const { method } = req;
         if (url && method) {
-          observe({ ...routeInfo, url, method: toLowerCase(method) });
+          observe({ ...routeInfo, url, method: StringPrototypeToLowerCase.call(method) });
         }
       }
     });
   }
 
-  function traverse(path = '', stack, depth = 0) {
+  function traverse(stack, path = '', depth = 0) {
     path = format(path);
     stack.forEach((layer) => {
       if (isRoute(layer)) {
@@ -84,7 +85,7 @@ module.exports = function init(core) {
         patchHandle(layer, routeInfo);
       } else if (isRouter(layer)) {
         const regexPath = regExpToPath(layer.regexp);
-        if (depth < 3) traverse(path + regexPath, layer.handle.stack, depth += 1);
+        if (depth < 3) traverse(layer.handle.stack, path + regexPath, depth += 1);
       } else {
         const regexPath = regExpToPath(layer.regexp);
         const routeInfo = createRouteInfo(path + regexPath, 'use');
@@ -107,7 +108,7 @@ module.exports = function init(core) {
             const handlers = Array.isArray(fn) ? fn : [fn];
             handlers.forEach((layer) => {
               if (isRouter(layer)) {
-                traverse(path, layer.stack);
+                traverse(layer.stack, path);
               } else if (path) {
                 const routeInfo = createRouteInfo(format(path), 'use', 'App');
                 discover(routeInfo);

package/lib/install/fastify.js

@@ -16,7 +16,7 @@
 'use strict';
 
 const { createSignature } = require('./../utils/route-info');
-const { toLowerCase } = require('@contrast/common');
+const { StringPrototypeToLowerCase } = require('@contrast/common');
 
 /** @typedef {Parameters<import('fastify-3.0.0').onRouteHookHandler>[0]} RouteOptions */
 
@@ -69,8 +69,8 @@ module.exports = function init(core) {
    * @param {string} method
    */
   function emitRouteCoverage(url, method) {
-    method = toLowerCase(method);
-    const event = { signature: createSignature(url, method), url, method, normalizedUrl: url };
+    method = StringPrototypeToLowerCase.call(method);
+    const event = { signature: createSignature(url, method), url, method, normalizedUrl: url, framework: 'fastify' };
     routeCoverage.discover(event);
   }
 
@@ -80,7 +80,7 @@ module.exports = function init(core) {
    * @param {string=} method
    */
   function emitObservation(url, normalizedUrl, method) {
-    method = method && toLowerCase(method);
+    method = method && StringPrototypeToLowerCase.call(method);
     routeCoverage.observe({ method, url, normalizedUrl });
   }
 

package/lib/install/hapi.js

@@ -14,15 +14,15 @@
  */
 'use strict';
 
-const { toLowerCase } = require('@contrast/common');
+const { StringPrototypeToLowerCase } = 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 };
+    method = StringPrototypeToLowerCase.call(method);
+    const event = { signature: createSignature(url, method), url, method, normalizedUrl: url, framework: 'hapi' };
     routeCoverage.discover(event);
   }
 
@@ -56,7 +56,7 @@ module.exports = function init(core) {
                     patchType,
                     post({ args }) {
                       const [{ method, path, route }] = args;
-                      routeCoverage.observe({ url: path, method: toLowerCase(method), normalizedUrl: route.path });
+                      routeCoverage.observe({ url: path, method: StringPrototypeToLowerCase.call(method), normalizedUrl: route.path });
                     }
                   });
                 }

package/lib/install/koa.js

@@ -14,14 +14,14 @@
  */
 'use strict';
 
-const { toLowerCase } = require('@contrast/common');
+const { StringPrototypeToLowerCase } = require('@contrast/common');
 const { createSignature, patchType } = require('./../utils/route-info');
 
 module.exports = function init(core) {
   const { patcher, depHooks, routeCoverage } = core;
 
   function emitRouteCoverage(url, method) {
-    const event = { signature: createSignature(url, method), url, method, normalizedUrl: url };
+    const event = { signature: createSignature(url, method), url, method, normalizedUrl: url, framework: 'koa' };
     routeCoverage.discover(event);
   }
 
@@ -32,7 +32,7 @@ module.exports = function init(core) {
       if (req) {
         const { url: reqUrl, method } = req;
         const [url] = reqUrl.split(/\?/);
-        routeCoverage.observe({ url, method: toLowerCase(method || ''), normalizedUrl: path });
+        routeCoverage.observe({ url, method: StringPrototypeToLowerCase.call(method || ''), normalizedUrl: path });
       }
 
       await next();
@@ -57,7 +57,7 @@ module.exports = function init(core) {
                 emitRouteCoverage(path, 'use');
               } else {
                 methods.forEach((method) => {
-                  emitRouteCoverage(path, toLowerCase(method || ''));
+                  emitRouteCoverage(path, StringPrototypeToLowerCase.call(method || ''));
                 });
               }
 

package/lib/install/restify.js

@@ -14,7 +14,7 @@
  */
 'use strict';
 
-const { toLowerCase, isString } = require('@contrast/common');
+const { StringPrototypeToLowerCase, isString } = require('@contrast/common');
 const { createSignature, patchType } = require('../utils/route-info');
 
 module.exports = function init(core) {
@@ -23,12 +23,13 @@ module.exports = function init(core) {
   const observe = (route) => routeCoverage.observe(route);
 
   function createRoute(url, method) {
-    method = toLowerCase(method);
+    method = StringPrototypeToLowerCase.call(method);
     return {
       signature: createSignature(url, method, 'Server'),
       method,
       url,
-      normalizedUrl: url
+      normalizedUrl: url,
+      framework: 'restify'
     };
   }
 
@@ -56,7 +57,7 @@ module.exports = function init(core) {
                     const [req] = args;
                     const { url: reqUrl, method } = req;
                     const [url] = reqUrl.split('?');
-                    observe({ ...routeInfo, method: toLowerCase(method), url });
+                    observe({ ...routeInfo, method: StringPrototypeToLowerCase.call(method), url });
                   }
                 });
               }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@contrast/route-coverage",
-  "version": "1.20.4",
+  "version": "1.20.6",
   "description": "Handles route discovery and observation",
   "license": "SEE LICENSE IN LICENSE",
   "author": "Contrast Security <nodejs@contrastsecurity.com> (https://www.contrastsecurity.com)",
@@ -11,13 +11,13 @@
   "types": "lib/index.d.ts",
   "engines": {
     "npm": ">=6.13.7 <7 || >= 8.3.1",
-    "node": ">= 14.18.0"
+    "node": ">= 16.9.1"
   },
   "scripts": {
     "test": "../scripts/test.sh"
   },
   "dependencies": {
-    "@contrast/common": "1.21.0",
+    "@contrast/common": "1.21.2",
     "@contrast/fn-inspect": "^4.0.0"
   }
 }