@contrast/agent-bundle 5.47.0 → 5.48.0

package/node_modules/@contrast/route-coverage/lib/install/express/express4.js

@@ -1,157 +0,0 @@
-/*
- * Copyright: 2025 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 METHODS = [
-  'all',
-  'get',
-  'post',
-  'put',
-  'delete',
-  'patch',
-  'options',
-  'head',
-];
-
-const fnInspect = require('@contrast/fn-inspect');
-const { createSignature, patchType } = require('../../utils/route-info');
-const { isString, primordials: { ArrayPrototypeJoin, StringPrototypeToLowerCase, StringPrototypeReplace, StringPrototypeReplaceAll, StringPrototypeSplit, StringPrototypeSlice } } = require('@contrast/common');
-
-// Spec: https://contrast.atlassian.net/wiki/spaces/NOD/pages/3454861621/Node.js+Agent+Route+Signatures#Express
-module.exports = function init(core) {
-  const { patcher, depHooks, routeCoverage } = core;
-  const discover = (route) => routeCoverage.discover(route);
-  const observe = (route) => routeCoverage.observe(route);
-
-  const isRoute = (layer) => !!layer.route;
-  const isRouter = (layer) => layer.name && StringPrototypeToLowerCase.call(layer.name) === 'router';
-  const isValidPath = (path) => isString(path) || Array.isArray(path) || path instanceof RegExp;
-  const getHandleMethod = (layer) => fnInspect.funcInfo(layer.__handle)?.file.includes('express-async-errors') ? '__handle' : 'handle';
-  const getLastLayer = (router) => router?.stack[router.stack.length - 1];
-
-  function regExpToPath(regex) {
-    if (regex.source) {
-      let [path] = StringPrototypeSplit.call(regex?.source, '/?');
-      path = StringPrototypeReplaceAll.call(path, '\\', '');
-      path = StringPrototypeReplace.call(path, '^', '');
-      return path;
-    }
-  }
-
-  function format(url) {
-    if (Array.isArray(url)) {
-      return `/[${ArrayPrototypeJoin.call(url)}]`;
-    } else if (url instanceof RegExp) {
-      return `/{${StringPrototypeSlice.call(url.toString(), 1, -1)}}`;
-    } else {
-      return url;
-    }
-  }
-
-  function parseRoute(route) {
-    const { path } = route;
-    const method = route.methods._all ? 'all' : route.stack[0].method;
-    return { url: format(path), method };
-  }
-
-
-  function createRouteInfo(url, method, obj) {
-    return {
-      signature: createSignature(url, method, obj),
-      url,
-      normalizedUrl: url,
-      method,
-      framework: 'express'
-    };
-  }
-
-  function patchHandle(layer, routeInfo) {
-    const handle = getHandleMethod(layer);
-    patcher.patch(layer, handle, {
-      name: 'express.Route.handle',
-      patchType,
-      post({ args }) {
-        const [req] = args;
-        const [url] = StringPrototypeSplit.call(req.originalUrl, '?');
-        const { method } = req;
-        if (url && method) {
-          observe({ ...routeInfo, url, method: StringPrototypeToLowerCase.call(method) });
-        }
-      }
-    });
-  }
-
-  function traverse(stack, path = '', depth = 0) {
-    path = format(path);
-    stack.forEach((layer) => {
-      if (isRoute(layer)) {
-        const { url, method } = parseRoute(layer.route);
-        const routeInfo = createRouteInfo(path + url, method);
-        discover(routeInfo);
-        patchHandle(layer, routeInfo);
-      } else if (isRouter(layer)) {
-        const regexPath = regExpToPath(layer.regexp);
-        if (depth < 3) traverse(layer.handle.stack, path + regexPath, depth += 1);
-      } else {
-        const regexPath = regExpToPath(layer.regexp);
-        const routeInfo = createRouteInfo(path + regexPath, 'use');
-        discover(routeInfo);
-        patchHandle(layer, routeInfo);
-      }
-    });
-  }
-  return core.routeCoverage.express4 = {
-    install() {
-      depHooks.resolve({ name: 'express', version: '>=4 <5' }, (express) => {
-        patcher.patch(express.application, 'use', {
-          name: 'express.application.use',
-          patchType,
-          post({ args, result }) {
-            const len = args.length;
-            const fn = args[len - 1];
-            const path = len > 1 ? args[0] : undefined;
-            if (path && !isValidPath(path)) return;
-            const handlers = Array.isArray(fn) ? fn : [fn];
-            handlers.forEach((layer) => {
-              if (isRouter(layer)) {
-                traverse(layer.stack, path);
-              } else if (path) {
-                const routeInfo = createRouteInfo(format(path), 'use', 'App');
-                discover(routeInfo);
-                const lastLayer = getLastLayer(result._router);
-                if (lastLayer) patchHandle(lastLayer, routeInfo);
-              }
-            });
-          }
-        });
-
-        METHODS.forEach((method) => {
-          patcher.patch(express.application, method, {
-            name: `express.application.${method}`,
-            patchType,
-            post({ args, result }) {
-              const [url, fn] = args;
-              if (!url || !fn || !isValidPath(url)) return;
-              const routeInfo = createRouteInfo(format(url), method, 'App');
-              discover(routeInfo);
-              const lastLayer = getLastLayer(result._router);
-              if (lastLayer) patchHandle(lastLayer, routeInfo);
-            }
-          });
-        });
-      });
-    }
-  };
-};