@contrast/route-coverage 1.52.0 → 1.53.0

package/lib/index.js

@@ -122,12 +122,12 @@ module.exports = function init(core) {
     },
   };
 
-  require('./install/express')(core);
+  core.initComponentSync(require('./install/express'));
   require('./install/fastify')(core);
   require('./install/graphql')(core);
-  require('./install/hapi')(core);
+  core.initComponentSync(require('./install/hapi'));
   require('./install/koa')(core);
-  require('./install/restify')(core);
+  core.initComponentSync(require('./install/restify'));
   core.initComponentSync(require('./install/socket.io'));
 
   messages.on(Event.SERVER_LISTENING, () => {

package/lib/install/hapi.js

@@ -12,76 +12,139 @@
  * engineered, modified, repackaged, sold, redistributed or otherwise used in a
  * way not consistent with the End User License Agreement.
  */
+// @ts-check
 'use strict';
 
-const { primordials: { StringPrototypeToLowerCase } } = require('@contrast/common');
-const { patchType } = require('./../utils/route-info');
+const { AsyncLocalStorage } = require('node:async_hooks');
+const { RouteType, set } = require('@contrast/common');
+const { Core } = require('@contrast/core/lib/ioc/core');
+const { formatHandler, patchType } = require('../utils/route-info');
 
-// Spec: https://contrast.atlassian.net/wiki/spaces/NOD/pages/3454861621/Node.js+Agent+Route+Signatures#Hapi
-module.exports = function init(core) {
-  const { patcher, depHooks, routeCoverage } = core;
+/**
+ * The hapi `Route` class from lib/route.js is not defined or exported.
+ * @typedef {Object} Route
+ * @property {boolean} _special internal hapi property for special routes
+ * @property {string} method
+ * @property {string} path
+ * @property {Object} settings
+ * @property {(request: { method: string, path: string}) => any} settings.handler set by the Route constructor
+ */
+
+class HapiRouteCoverage {
+  /**
+   * @param {import('..').Core & {
+   *  routeCoverage: import('..').RouteCoverage;
+   * }} core
+   */
+  constructor(core) {
+    set(core, 'routeCoverage.hapi', this);
+    this.core = core;
+    this.depHooks = core.depHooks;
+    this.patcher = core.patcher;
+    this.routeCoverage = core.routeCoverage;
+    this.registerScope = new AsyncLocalStorage();
+  }
 
-  const createSignature = (method, url) => `server.route({ method: '${method}', path: '${url}', handler: [Function] })`;
-  function emitRouteCoverage(url, method) {
-    method = StringPrototypeToLowerCase.call(method);
-    const event = {
-      signature: createSignature(method, url),
-      url,
-      method,
-      normalizedUrl: url,
-      framework: 'hapi'
-    };
-    routeCoverage.discover(event);
+  install() {
+    this.depHooks.resolve(
+      { name: '@hapi/hapi', version: '>=18 <22', file: 'lib/server.js' },
+      /** @param {typeof import('@hapi/hapi').Server} Server */
+      (Server) => this.patchServer(Server),
+    );
+    this.depHooks.resolve(
+      { name: '@hapi/hapi', version: '>=18 <22', file: 'lib/route.js' },
+      /** @param {abstract new () => Route} Route */
+      (Route) => this.patchRoute(Route),
+    );
   }
 
-  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;
+  /**
+   * Spec: https://contrast.atlassian.net/wiki/spaces/NOD/pages/3454861621/Node.js+Agent+Route+Signatures#Hapi
+   * @param {Route} route
+   */
+  createSignature(route) {
+    const handler = formatHandler(this.patcher.unwrap(route.settings.handler));
+    return `server.route({ method: '${route.method}', path: '${route.path}', handler: ${handler} })`;
+  }
+
+  /** @param {typeof import('@hapi/hapi').Server} Server */
+  patchServer(Server) {
+    const self = this;
+    return this.patcher.patch(Server, {
+      name: 'hapi.Server',
+      patchType,
+      post({ result: server }) {
+        self.patcher.patch(server, 'register', {
+          name: 'server.register',
+          patchType,
+          around(next) {
+            if (self.registerScope.getStore()) return next();
+            return self.registerScope.run({ isMiddleware: true }, next);
+          },
+        });
+      },
+    });
+  }
 
-                  const [{ method, path }] = data.args;
-                  if (!method || !path) return;
+  /**
+   * @param {Route} route
+   * @param {string} signature
+   * @param {RouteType} type
+   */
+  patchRouteHandler(route, signature, type) {
+    const self = this;
+    this.patcher.patch(route.settings, 'handler', {
+      name: 'route.settings.handler',
+      patchType,
+      // this needs to be in a pre-hook so that the route
+      // data is in the store before our dataflow hooks run
+      pre({ args: [request] }) {
+        self.routeCoverage.observe({
+          signature,
+          method: request.method,
+          url: request.path,
+          normalizedUrl: route.path, // should also be defined at `request.route.path`
+          framework: 'hapi',
+          type,
+        });
+      },
+    });
+  }
 
-                  if (Array.isArray(method)) {
-                    method.forEach((verb) => {
-                      emitRouteCoverage(path, verb);
-                    });
-                  } else {
-                    emitRouteCoverage(path, method);
-                  }
+  /**
+   * @param {abstract new () => Route} Route
+   */
+  patchRoute(Route) {
+    const self = this;
+    return this.patcher.patch(Route, {
+      name: 'hapi.Route',
+      patchType,
+      post({ result: route }) {
+        if (route._special) return; // skip special internal routes
+        const signature = self.createSignature(route);
+        const type = self.registerScope.getStore()?.isMiddleware ? RouteType.MIDDLEWARE : RouteType.HTTP;
 
-                  patcher.patch(data.result.route.settings, 'handler', {
-                    name: 'route.settings.handler',
-                    patchType,
-                    // this needs to be in a pre-hook so that the route
-                    // data is in the store before our dataflow hooks run
-                    pre({ args }) {
-                      const [{ method, path: url, route }] = args;
-                      //TODO: Will this signature always be associated with an existing route?
-                      const signature = createSignature(method, path);
-                      routeCoverage.observe({
-                        signature,
-                        url,
-                        method: StringPrototypeToLowerCase.call(method),
-                        normalizedUrl: route.path,
-                      });
-                    }
-                  });
-                }
-              });
-            }
-          });
+        self.routeCoverage.discover({
+          signature,
+          method: route.method,
+          url: route.path,
+          normalizedUrl: route.path,
+          framework: 'hapi',
+          type,
         });
-      });
-    }
-  };
-};
+
+        self.patchRouteHandler(route, signature, type);
+      },
+    });
+  }
+}
+
+module.exports = Core.makeComponent({
+  name: 'routeCoverage.hapi',
+  /**
+   * @param {import('..').Core & {
+   *  routeCoverage: import('..').RouteCoverage;
+   * }} core
+   */
+  factory: (core) => new HapiRouteCoverage(core),
+});

package/lib/install/restify.js

@@ -14,58 +14,240 @@
  */
 'use strict';
 
-const { isString, primordials: { StringPrototypeToLowerCase, StringPrototypeSplit } } = require('@contrast/common');
-const { createSignature, patchType } = require('../utils/route-info');
-
-// Spec: https://contrast.atlassian.net/wiki/spaces/NOD/pages/3454861621/Node.js+Agent+Route+Signatures#Restify
-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 = StringPrototypeToLowerCase.call(method);
-    return {
-      signature: createSignature(url, method, 'server'),
-      method,
-      url,
-      normalizedUrl: url,
-      framework: 'restify'
-    };
+const { AsyncLocalStorage } = require('async_hooks');
+const {
+  isString,
+  primordials: {
+    StringPrototypeToLowerCase,
+    StringPrototypeSplit,
+    StringPrototypeSubstring,
+  },
+  set,
+  RouteType,
+} = require('@contrast/common');
+const { Core } = require('@contrast/core/lib/ioc/core');
+const { formatHandler, patchType } = require('../utils/route-info');
+
+const COMPONENT_NAME = 'routeCoverage.restify';
+const FRAMEWORK = 'restify';
+
+module.exports = Core.makeComponent({
+  name: COMPONENT_NAME,
+  factory: (core) => new RestifyInstrumentation(core),
+});
+
+class RestifyInstrumentation {
+  constructor(core) {
+    set(core, COMPONENT_NAME, this);
+    Object.defineProperty(this, 'core', { value: core });
+    this.routeScope = new AsyncLocalStorage();
+    this.conditionalHandlers = new WeakMap();
   }
 
-  return core.routeCoverage.restify = {
-    install() {
-      depHooks.resolve({ name: 'restify', version: '>=10 <12' }, (restify) => {
-        patcher.patch(restify, 'createServer', {
-          name: 'restify.createServer',
-          patchType,
-          post({ result: server }) {
-            patcher.patch(server.router, 'mount', {
-              name: 'restify.router.mount',
+  formatHandler(fn) {
+    return formatHandler(this.core.patcher.unwrap(fn));
+  }
+
+  install() {
+    const self = this;
+    const { depHooks } = this.core;
+
+    depHooks.resolve({ name: 'restify', version: '>=10 <12' }, (restify, pkgMeta) => {
+      self.patchPlugins(restify, pkgMeta);
+      self.patchServer(restify, pkgMeta);
+    });
+  }
+
+  patchPlugins(restify) {
+    const self = this;
+    const { patcher, routeCoverage } = this.core;
+    if (!restify.plugins?.conditionalHandler) return;
+
+    const name = 'restify.plugins.conditionalHandler';
+    patcher.patch(restify.plugins, 'conditionalHandler', {
+      name,
+      patchType,
+      around(next, data) {
+        const { args } = data;
+        const conditionals = Array.isArray(args[0]) ? args[0] : [args[0]];
+        const formattedHandlers = [];
+
+        // we have to do this before calling next() to get return value
+        // since restify potentially alters conditional.handlers
+        for (const conditional of conditionals) {
+          const isHandlerArr = Array.isArray(conditional.handler);
+          const target = isHandlerArr ? conditional.handler : conditional;
+          const propsIter = isHandlerArr ? Object.keys(conditional.handler) : ['handler'];
+
+          for (const propName of propsIter) {
+            if (typeof target[propName] !== 'function') continue;
+
+            const formattedHandler = self.formatHandler(target[propName]);
+            formattedHandlers.push(formattedHandler);
+
+            patcher.patch(target, propName, {
+              name: 'restify.plugins.conditionalHandler',
               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',
+              pre(data) {
+                const { args: [req] } = data;
+                const store = self.routeScope.getStore();
+                if (!store) return;
+
+                for (const routeInfo of store.observables) {
+                  if (routeInfo.signature.indexOf(formattedHandler) >= 0) {
+                    routeCoverage.observe({
+                      ...routeInfo,
+                      method: StringPrototypeToLowerCase.call(req.method),
+                      url: StringPrototypeSplit.call(req.url, '?')[0],
+                    });
+                    break;
+                  }
+                }
+              },
+            });
+          }
+        }
+
+        const result = next();
+
+        // save list of handlers that have been registered under the returned
+        // consolidated one. when this return value gets mounted at an actual
+        // path(s), we can lookup the handlers and discover each individually
+        // with that additional route info.
+        self.conditionalHandlers.set(result, formattedHandlers);
+
+        return result;
+      },
+    });
+  }
+
+  patchServer(restify, pkgMeta) {
+    const self = this;
+    const { logger, patcher, routeCoverage } = this.core;
+
+    patcher.patch(restify, 'createServer', {
+      name: 'restify.createServer',
+      patchType,
+      post({ result: server }) {
+        patcher.patch(server.router, 'mount', {
+          name: 'restify.router.mount',
+          patchType,
+          post({ result: route }) {
+            if (!route.path || !route.method || !isString(route.path)) {
+              logger.error({ route }, 'unable to process restify route');
+              return;
+            }
+
+            const { path } = route;
+            const method = StringPrototypeToLowerCase.call(route.method);
+            const baseInfo = {
+              method,
+              url: path,
+              normalizedUrl: path,
+              framework: FRAMEWORK,
+              type: RouteType.HTTP,
+            };
+
+            for (let idx = 0; idx < route.chain._stack.length; idx++) {
+              const handler = route.chain._stack[idx];
+              const routeInfo = {
+                ...baseInfo,
+                signature: `server.${method}(${path}, ${self.formatHandler(handler)})`,
+              };
+
+              if (!self.conditionalHandlers.has(handler)) {
+                // "regular" handlers
+                routeCoverage.discover(routeInfo);
+                route.chain._stack[idx] = patcher.patch(route.chain._stack[idx], {
+                  name: 'restify.route.chain._stack',
                   patchType,
-                  post({ args }) {
-                    const [req] = args;
-                    const { url: reqUrl, method } = req;
-                    const [url] = StringPrototypeSplit.call(reqUrl, '?');
-                    observe({ ...routeInfo, method: StringPrototypeToLowerCase.call(method), url });
+                  pre({ args: [req] }) {
+                    routeCoverage.observe({
+                      ...routeInfo,
+                      method: StringPrototypeToLowerCase.call(req.method),
+                      url: StringPrototypeSplit.call(req.url, '?')[0],
+                    });
+                  }
+                });
+              } else {
+                // "conditional" handlers dispatch to their registered handlers
+                const formattedHandlers = self.conditionalHandlers.get(handler);
+                const store = { observables: [] };
+
+                for (const formattedHandler of formattedHandlers) {
+                  const routeInfo = {
+                    ...baseInfo,
+                    signature: `server.${method}(${path}, ${formattedHandler})`,
+                  };
+                  routeCoverage.discover(routeInfo);
+                  store.observables.push(routeInfo);
+                }
+
+                route.chain._stack[idx] = patcher.patch(route.chain._stack[idx], {
+                  name: 'restify.route.chain._stack',
+                  patchType,
+                  around(next) {
+                    return self.routeScope.run(store, next);
                   }
                 });
               }
-            });
+            }
           }
         });
+
+        self.patchMiddlewareChains(server, pkgMeta);
+      }
+    });
+  }
+
+  patchMiddlewareChains(server) {
+    const self = this;
+    const { config, routeCoverage, patcher } = this.core;
+
+    if (!config.getEffectiveValue('assess.report_middleware_routes')) return;
+
+    for (const propName of ['preChain', 'useChain']) {
+      patcher.patch(server[propName], 'add', {
+        name: `restify.server.${propName}.add`,
+        patchType,
+        around(next, data) {
+          const len = data.obj._stack.length;
+          const ret = next();
+
+          if (data.obj._stack.length > len) {
+            const method = StringPrototypeSubstring.call(propName, 0, 3);
+            const baseData = {
+              method,
+              url: '/',
+              normalizedUrl: '/',
+              type: RouteType.MIDDLEWARE,
+              framework: FRAMEWORK,
+            };
+
+            for (let idx = 0; idx < data.obj._stack.length; idx++) {
+              const routeData = {
+                ...baseData,
+                signature: `server.${method}(${self.formatHandler(data.obj._stack[idx])})`,
+              };
+
+              routeCoverage.discover(routeData);
+              patcher.patch(data.obj._stack, idx, {
+                name: `restify.server.${propName}`,
+                patchType,
+                pre({ args: [req] }) {
+                  routeCoverage.observe({
+                    ...routeData,
+                    method: StringPrototypeToLowerCase.call(req.method),
+                    url: StringPrototypeSplit.call(req.url, '?')[0],
+                  });
+                },
+              });
+            }
+          }
+          return ret;
+        }
       });
     }
-  };
-};
+  }
+}
+

package/lib/utils/route-info.js

@@ -33,7 +33,7 @@ function createSignature(path, method = '', obj = 'Router', handler = '[Function
 /**
  * Creates a formatted handler signature for a route
  * @param {function} handler
- * @param {string} appDir
+ * @param {string=} appDir
  * @return {string} formatted handler
  */
 function formatHandler(handler, appDir) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@contrast/route-coverage",
-  "version": "1.52.0",
+  "version": "1.53.0",
   "description": "Handles route discovery and observation",
   "license": "SEE LICENSE IN LICENSE",
   "author": "Contrast Security <nodejs@contrastsecurity.com> (https://www.contrastsecurity.com)",
@@ -20,14 +20,14 @@
     "test": "bash ../scripts/test.sh"
   },
   "dependencies": {
-    "@contrast/common": "1.38.0",
-    "@contrast/config": "1.54.1",
-    "@contrast/core": "1.59.1",
-    "@contrast/dep-hooks": "1.28.1",
+    "@contrast/common": "1.39.0",
+    "@contrast/config": "1.55.0",
+    "@contrast/core": "1.60.0",
+    "@contrast/dep-hooks": "1.29.0",
     "@contrast/fn-inspect": "^5.0.2",
-    "@contrast/logger": "1.32.1",
-    "@contrast/patcher": "1.31.1",
-    "@contrast/scopes": "1.29.1",
+    "@contrast/logger": "1.33.0",
+    "@contrast/patcher": "1.32.0",
+    "@contrast/scopes": "1.30.0",
     "semver": "^7.6.0"
   }
 }