@contrast/route-coverage 1.0.0

package/lib/index.d.ts

@@ -0,0 +1,23 @@
+/*
+ * Copyright: 2022 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.
+ */
+
+export interface RouteCoverage {
+  discover: (infos: { signature: string, url: string, method: string }) => void
+  observe: (data: { url: string, verb: string }) => void
+}
+
+declare function init(core: any): RouteCoverage;
+
+export = init;

package/lib/index.js

@@ -0,0 +1,53 @@
+/*
+ * Copyright: 2022 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 { callChildComponentMethodsSync, Event } = require('@contrast/common');
+const { routeIdentifier } = require('./utils/route-info');
+
+module.exports = function(core) {
+  const { logger, messages } = core;
+
+  const routeCoverage = core.routeCoverage = {};
+  const routeInfo = new Map();
+
+  const discover = (info) => {
+    routeInfo.set(routeIdentifier(info), info);
+    messages.emit(Event.ROUTE_COVERAGE_DISCOVERY, info);
+  };
+
+  const observe = ({ url, verb }) => {
+    const info = { url, verb };
+
+    const route = routeInfo.get(routeIdentifier({ url, method: verb }));
+    if (!route) {
+      logger.debug('Unable to observe routes not discovered %j', info);
+      return null;
+    }
+
+    messages.emit(Event.ROUTE_COVERAGE_OBSERVATION, route);
+  };
+
+  routeCoverage.discover = discover;
+  routeCoverage.observe = observe;
+
+  require('./install/fastify')(core);
+
+  routeCoverage.install = function () {
+    callChildComponentMethodsSync(routeCoverage, 'install');
+  };
+
+  return routeCoverage;
+};

package/lib/install/fastify.js

@@ -0,0 +1,78 @@
+/*
+ * Copyright: 2022 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 { createSignature } = require('./../utils/route-info');
+
+module.exports = function (core) {
+  const { patcher, depHooks, routeCoverage } = core;
+
+  const routeCoverageFastify = core.routeCoverage.fastify = {};
+
+  function registerRouteHandler(routeOptions) {
+    if (!routeOptions || !routeOptions.method || !routeOptions.url) return;
+
+    const url = `${routeOptions.prefix || ''}${routeOptions.url}`;
+    if (Array.isArray(routeOptions.method)) {
+      routeOptions.method.forEach((method) => {
+        emitRouteCoverage(url, method);
+      });
+    } else {
+      emitRouteCoverage(url, routeOptions.method);
+    }
+
+    // TODO
+    observationListener(routeOptions, url);
+  }
+
+  function observationListener(routeOptions, url) {
+    patcher.patch(routeOptions, 'handler', {
+      name: 'fastify.routeOptions.handler',
+      patchType: 'route-coverage',
+      pre(data) {
+        const [request] = data.args;
+        const { method } = request.raw;
+        emitObservation(method, url);
+      },
+    });
+  }
+
+  function emitRouteCoverage(url, method) {
+    method = method.toLowerCase();
+    const event = { signature: createSignature(url, method), url, method };
+    routeCoverage.discover(event);
+  }
+
+  function emitObservation(verb, url) {
+    verb = verb.toLowerCase();
+    routeCoverage.observe({ verb, url });
+  }
+
+  routeCoverageFastify.install = function() {
+    depHooks.resolve({ name: 'fastify', version: '>=3.0.0' }, (fastify) =>
+      patcher.patch(fastify, {
+        name: 'fastify.build',
+        patchType: 'route-coverage',
+        post({ orig, hooked, result: server }) {
+          server.addHook('onRoute', function (routeOptions) {
+            registerRouteHandler(routeOptions);
+          });
+        },
+      })
+    );
+  };
+
+  return routeCoverageFastify;
+};

package/lib/utils/route-info.js

@@ -0,0 +1,34 @@
+/*
+ * Copyright: 2022 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';
+
+/**
+ * Creates a formatted "signature" for a route
+ * @param {string} path
+ * @param {Array} [methods=['get']]
+ * @return {string} formatted signature
+ */
+function createSignature(path, method) {
+  return `Router.${method}('${path}', [Function])`;
+}
+
+/**
+ * Creates a route identifier based on the method name and the url
+ * @param {Object} Route Information
+ * @return {string}
+ */
+const routeIdentifier = (info) => `${info.method}.${info.url}`;
+
+module.exports = { createSignature, routeIdentifier };

package/package.json

@@ -0,0 +1,19 @@
+{
+  "name": "@contrast/route-coverage",
+  "version": "1.0.0",
+  "description": "",
+  "license": "SEE LICENSE IN LICENSE",
+  "author": "Contrast Security <nodejs@contrastsecurity.com> (https://www.contrastsecurity.com)",
+  "main": "lib/index.js",
+  "types": "lib/index.d.ts",
+  "engines": {
+    "npm": ">=6.13.7 <7 || >= 8.3.1",
+    "node": ">= 14.15.0"
+  },
+  "scripts": {
+    "test": "../scripts/test.sh"
+  },
+  "dependencies": {
+    "@contrast/common": "1.4.0"
+  }
+}