@contrast/route-coverage 1.19.0 → 1.20.0

package/lib/index.js

@@ -85,6 +85,7 @@ module.exports = function init(core) {
   require('./install/fastify')(core);
   require('./install/hapi')(core);
   require('./install/koa')(core);
+  require('./install/restify')(core);
 
   return routeCoverage;
 };

package/lib/install/express.js

@@ -36,7 +36,7 @@ module.exports = function init(core) {
   const observe = (route) => routeCoverage.observe(route);
 
   const isRoute = (layer) => !!layer.route;
-  const isRouter = (layer) => toLowerCase(layer.name) === 'router';
+  const isRouter = (layer) => layer.name && toLowerCase(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;

package/lib/install/restify.js

@@ -0,0 +1,69 @@
+/*
+ * 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, isString } = require('@contrast/common');
+const { createSignature, patchType } = require('../utils/route-info');
+
+module.exports = function init(core) {
+  const { patcher, depHooks, routeCoverage } = core;
+  const discover = (route) => routeCoverage.discover(route);
+  const observe = (route) => routeCoverage.observe(route);
+
+  function createRoute(url, method) {
+    method = toLowerCase(method);
+    return {
+      signature: createSignature(url, method, 'Server'),
+      method,
+      url,
+      normalizedUrl: url
+    };
+  }
+
+  return core.routeCoverage.restify = {
+    install() {
+      depHooks.resolve({ name: 'restify', version: '>= 8.0.0' }, (restify) => {
+        patcher.patch(restify, 'createServer', {
+          name: 'restify.createServer',
+          patchType,
+          post({ result: server }) {
+            patcher.patch(server.router, 'mount', {
+              name: 'restify.router.mount',
+              patchType,
+              post({ result: route }) {
+                const { path, method } = route;
+                if (!path || !method || !isString(path)) return;
+                const routeInfo = createRoute(path, method);
+                discover(routeInfo);
+
+                const [handler] = route.chain._stack;
+                route.chain._stack[0] = patcher.patch(handler, {
+                  name: 'route.chain._stack[0].handler',
+                  patchType,
+                  post({ args }) {
+                    const [req] = args;
+                    const { url: reqUrl, method } = req;
+                    const [url] = reqUrl.split('?');
+                    observe({ ...routeInfo, method: toLowerCase(method), url });
+                  }
+                });
+              }
+            });
+          }
+        });
+      });
+    }
+  };
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@contrast/route-coverage",
-  "version": "1.19.0",
+  "version": "1.20.0",
   "description": "Handles route discovery and observation",
   "license": "SEE LICENSE IN LICENSE",
   "author": "Contrast Security <nodejs@contrastsecurity.com> (https://www.contrastsecurity.com)",
@@ -17,7 +17,7 @@
     "test": "../scripts/test.sh"
   },
   "dependencies": {
-    "@contrast/common": "1.20.1",
+    "@contrast/common": "1.21.0",
     "@contrast/fn-inspect": "^4.0.0"
   }
 }