updated hooks for nextjs

Author: sumitsuthar

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

@@ -8,115 +8,86 @@ const requestManager = require("../../core/request-manager");
 const API = require("../../../nr-security-api");
 const logger = API.getLogger();
 
-const fs = require('fs');
-const path = require('path');
+const semver = require('semver')
 
 module.exports = function initialize(shim, nextjs) {
- const pkgVersion = shim.require('package.json').version;
- logger.info("Instrumenting nextjs", pkgVersion);
+ const nextVersion = shim.require('./package.json').version
+ logger.info("Instrumenting nextjs", nextVersion);
 
- const utils = shim.require('./dist/next-server/lib/router/utils');
+ const nextServer = nextjs.default;
+ hookRunAPI(shim, nextServer.prototype, nextVersion);
+}
 
- if (utils) {
- getRouteMatcherHook(utils);
- }
+/**
+ * Wrapper for Server.prototype.runApi
+ * @param {*} shim 
+ * @param {*} mod 
+ * @param {*} nextVersion 
+ */
+function hookRunAPI(shim, mod, nextVersion) {
+ shim.wrap(mod, 'runApi', function wrapRunApi(shim, originalFn) {
+ if (!shim.isFunction(originalFn)) {
+ return originalFn
+ }
+ logger.debug("Instrumenting Server.prototype.runApi");
+ return function wrappedRunApi() {
+ try {
+ const { page, params } = extractAttrs(arguments, nextVersion)
+ extractParams(shim, page, params);
+ } catch (error) {
+ logger.debug("Error while processing path paramters");
+ }
 
- const routeMatcher = shim.require('./dist/shared/lib/router/utils/route-matcher.js');
+ return originalFn.apply(this, arguments)
+ }
+ })
+}
 
- if (routeMatcher) {
- getRouteMatcherHook(routeMatcher);
+/**
+ * Extracts the page and params from an API request
+ *
+ * @param {object} args arguments to runApi
+ * @param {string} version next.js version
+ * @returns {object} { page, params }
+ */
+function extractAttrs(args, version) {
+ let params
+ let page
+ if (semver.gte(version, '13.4.13')) {
+ const [, , , match] = args
+ page = match?.definition?.pathname
+ params = { ...match?.params }
+ } else {
+ ;[, , , params, page] = args
  }
 
- /**
- * wrapper for route-matcher.getRouteMatcher
- * @param {*} mod 
- */
- function getRouteMatcherHook(mod) {
- shim.wrap(mod, 'getRouteMatcher', function wrapGetRouterMatcher(shim, fn) {
- if (!shim.isFunction(fn)) {
- return fn
- }
- logger.debug(`Instrumenting route-matcher.getRouteMatcher`)
- return function wrappedGetRouterMatcher() {
- let result = fn.apply(this, arguments)
- if (!shim.isFunction(result)) {
- return result;
- }
- let original = result;
- result = function () {
- const res = original.apply(this, arguments);
- extractParams(this, res);
- return res;
- }
- return result
- }
- })
- }
+ return { params, page }
+}
 
- /**
- * Utility to extract path params
- * @param {*} obj 
- * @param {*} params 
- */
- function extractParams(obj, params) {
- try {
- const transaction = shim.tracer.getTransaction();
- if (transaction) {
- let request = requestManager.getRequestFromId(transaction.id);
- Object.keys(params).forEach(function (key) {
- if (params[key]) {
- if (!request.parameterMap[key]) {
- request.parameterMap[key] = new Array(params[key].toString());
- requestManager.setRequest(transaction.id, request);
- }
+/**
+ * Utility to extract path params
+ * @param {*} page 
+ * @param {*} params 
+ */
+function extractParams(shim, page, params) {
+ try {
+ const transaction = shim.tracer.getTransaction();
+ if (transaction) {
+ let request = requestManager.getRequestFromId(transaction.id);
+ Object.keys(params).forEach(function (key) {
+ if (params[key]) {
+ if (!request.parameterMap[key]) {
+ request.parameterMap[key] = new Array(params[key].toString());
+ requestManager.setRequest(transaction.id, request);
  }
- });
- if (request && obj && obj.page) {
- request.uri = obj.page;
- requestManager.setRequest(transaction.id, request);
  }
+ });
+ if (request && page) {
+ request.uri = page;
+ requestManager.setRequest(transaction.id, request);
  }
- } catch (error) {
  }
+ } catch (error) {
  }
-
 }
 
-/**
- * Utility to scan pages directory to get all avaible routes
- * @param {*} dir 
- * @returns 
- */
-const getAllAPIEndpoints = (dir) => {
- const apiEndpoints = [];
-
- const scanDirectory = (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}/`, '/').replace(/\.js$/, '');
- apiEndpoints.push(apiEndpoint);
- }
- });
- };
-
- scanDirectory(dir);
- return apiEndpoints;
-};
-
-
-//TODO need to update for API endpoints
-// try {
-// const appRoot = API.getSecAgent().applicationInfo.serverInfo.deployedApplications[0].deployedPath;
-// const searchPath = appRoot + '/.next/server/pages';
-// const allAPIEndpoints = getAllAPIEndpoints(searchPath);
-// } catch (error) {
-// logger.debug("Error while getting all API end points for next.js", error);
-// }
-

lib/instrumentation-security/index.js

@@ -262,7 +262,7 @@ newrelic.instrument({
 })
 
 newrelic.instrumentWebframework({
- moduleName: 'next',
+ moduleName: 'next/dist/server/next-server',
  isEsm: true,
  onRequire: require('./hooks/nextjs/nr-next'),
  onError: function intrumentErrorHandler(err) {