feat: Handling to detect API Endpoints in next.js framework (#287)

Author: sumitsuthar

lib/instrumentation-security/hooks/nextjs/nr-next.js

@@ -6,16 +6,38 @@
 'use strict'
 const requestManager = require("../../core/request-manager");
 const API = require("../../../nr-security-api");
+const routeManager = require('../../core/route-manager');
 const logger = API.getLogger();
+const lodash = require('lodash');
+const { ATTHERATE, DOUBLE_DOLLAR, EMPTY_STR } = require('../../core/constants');
 
 const semver = require('semver')
+const fs = require('fs');
+const path = require('path');
 
 module.exports = function initialize(shim, nextjs) {
   const nextVersion = shim.require('./package.json').version
   logger.info("Instrumenting nextjs", nextVersion);
 
   const nextServer = nextjs.default;
   hookRunAPI(shim, nextServer.prototype, nextVersion);
+
+  //TODO need to update for API endpoints
+  try {
+    const appRoot = process.env.PWD;
+    const searchPath = appRoot + '/.next/server/pages/api';
+    const allAPIEndpoints = getAllAPIEndpoints(searchPath);
+    logger.debug("allAPIEndpoints:", allAPIEndpoints);
+    for (let index = 0; index < allAPIEndpoints.length; index++) {
+      const element = allAPIEndpoints[index];
+      let key = "*" + ATTHERATE + element;
+      routeManager.setRoute(key, EMPTY_STR);
+    }
+  } catch (error) {
+    logger.debug("Error while getting all API end points for next.js", error);
+  }
+
+
 }
 
 /**
@@ -91,3 +113,33 @@ function extractParams(shim, page, params) {
   }
 }
 
+
+/**
+ * Utility to scan pages directory to get all avaible routes
+ * @param {*} dir 
+ * @returns 
+ */
+const getAllAPIEndpoints = (dir) => {
+  logger.debug("dir is:", dir)
+  const apiEndpoints = [];
+
+  const scanDirectory = (currentDir) => {
+    logger.debug("currentDir is:", currentDir)
+    const files = fs.readdirSync(currentDir);
+
+    files.forEach((file) => {
+      const filePath = path.join(currentDir, file);
+      const isDirectory = fs.statSync(filePath).isDirectory();
+
+      if (isDirectory) {
+        scanDirectory(filePath);
+      } else {
+        const apiEndpoint = filePath.replace(`${dir}/`, '/api/').replace(/\.js*.*/, '');
+        apiEndpoints.push(apiEndpoint);
+      }
+    });
+  };
+
+  scanDirectory(dir);
+  return apiEndpoints;
+};