refactor: Moved relevant nextjs instrumentation and rely on agent commons

Author: bizob2828

.eslintrc.js

@@ -34,7 +34,11 @@ module.exports = {
   parserOptions: {
     ecmaVersion: 2022
   },
-  ignorePatterns: ['test/versioned-external'],
+  ignorePatterns: [
+    'test/versioned-external',
+    'test/versioned/nextjs/app',
+    'test/versioned/nextjs/app-dir'
+  ],
   overrides: [
     {
       files: ['**/*.mjs'],

README.md

@@ -61,6 +61,37 @@ If you cannot control how your program is run, you can load the `newrelic` modul
     /* ... the rest of your program ... */
 ```
 
+## Next.js instrumentation
+**Note**: The minimum supported Next.js version is [12.0.9](https://github.com/vercel/next.js/releases/tag/v12.0.9).  If you are using Next.js middleware the minimum supported version is [12.2.0](https://github.com/vercel/next.js/releases/tag/v12.2.0).
+
+The New Relic Node.js agent provides instrumentation for Next.js  The instrumentation provides telemetry for server-side rendering via [getServerSideProps](https://nextjs.org/docs/basic-features/data-fetching/get-server-side-props), [middleware](https://nextjs.org/docs/middleware), and New Relic transaction naming for both page and server requests. It does not provide any instrumentation for actions occurring during build or in client-side code.  If you want telemetry data on actions occurring on the client (browser), you can [inject the browser agent](./documentation/nextjs/faqs/browser-agent.md).
+
+Here are documents for more in-depth explanations about [transaction naming](./documentation/nextjs/transactions.md), and [segments/spans](./documentation/nextjs/segments-and-spans.md).
+
+
+### Setup
+Typically you are running a Next.js app with the `next` cli and you must load the agent via `NODE_OPTIONS`:
+
+```sh
+NODE_OPTIONS='-r newrelic' next start
+```
+
+If you are having trouble getting the `newrelic` package to instrument Next.js, take a look at our [FAQs](./documentation/nextjs/faqs/README.md).
+
+### Next.js example projects
+The following example applications show how to load the `newrelic` instrumentation, inject browser agent, and handle errors:
+
+ * [Pages Router example](https://github.com/newrelic/newrelic-node-examples/tree/58f760e828c45d90391bda3f66764d4420ba4990/nextjs-legacy)
+ * [App Router example](https://github.com/newrelic/newrelic-node-examples/tree/58f760e828c45d90391bda3f66764d4420ba4990/nextjs-app-router)
+
+### Custom Next.js servers
+
+If you are using next as a [custom server](https://nextjs.org/docs/advanced-features/custom-server), you're probably not running your application with the `next` CLI.  In that scenario we recommend running the Next.js instrumentation as follows.
+
+```sh
+node -r newrelic your-program.js
+```
+
 ## ECMAScript Modules
 
 If your application is written with `import` and `export` statements in javascript, you are using [ES Modules](https://nodejs.org/api/esm.html#modules-ecmascript-modules) and must bootstrap the agent in a different way.

THIRD_PARTY_NOTICES.md

@@ -1284,7 +1284,7 @@ This product includes source derived from [@aws-sdk/client-s3](https://github.co
 
 ### @aws-sdk/s3-request-presigner
 
-This product includes source derived from [@aws-sdk/s3-request-presigner](https://github.com/aws/aws-sdk-js-v3) ([v3.616.0](https://github.com/aws/aws-sdk-js-v3/tree/v3.616.0)), distributed under the [Apache-2.0 License](https://github.com/aws/aws-sdk-js-v3/blob/v3.616.0/LICENSE):
+This product includes source derived from [@aws-sdk/s3-request-presigner](https://github.com/aws/aws-sdk-js-v3) ([v3.614.0](https://github.com/aws/aws-sdk-js-v3/tree/v3.614.0)), distributed under the [Apache-2.0 License](https://github.com/aws/aws-sdk-js-v3/blob/v3.614.0/LICENSE):
 
 ```
                                 Apache License
@@ -3110,7 +3110,7 @@ THE SOFTWARE.
 
 ### eslint-plugin-jsdoc
 
-This product includes source derived from [eslint-plugin-jsdoc](https://github.com/gajus/eslint-plugin-jsdoc) ([v48.8.3](https://github.com/gajus/eslint-plugin-jsdoc/tree/v48.8.3)), distributed under the [BSD-3-Clause License](https://github.com/gajus/eslint-plugin-jsdoc/blob/v48.8.3/LICENSE):
+This product includes source derived from [eslint-plugin-jsdoc](https://github.com/gajus/eslint-plugin-jsdoc) ([v48.7.0](https://github.com/gajus/eslint-plugin-jsdoc/tree/v48.7.0)), distributed under the [BSD-3-Clause License](https://github.com/gajus/eslint-plugin-jsdoc/blob/v48.7.0/LICENSE):
 
 ```
 Copyright (c) 2018, Gajus Kuizinas (http://gajus.com/)

merged/nextjs/docs/faqs/README.md documentation/nextjs/faqs/README.md

@@ -1,8 +1,8 @@
 # Deploy Next.js to Cloud Provider
 
-Q: Can `@newrelic/next` work when deploying to [Vercel](https://vercel.com/frameworks/nextjs), [AWS Amplify](https://aws.amazon.com/amplify/), [Netlify](https://www.netlify.com/with/nextjs/), [Azure Static Sites](https://azure.microsoft.com/en-us/products/app-service/static), etc?
+Q: Can Next.js instrumentation work when deploying to [Vercel](https://vercel.com/frameworks/nextjs), [AWS Amplify](https://aws.amazon.com/amplify/), [Netlify](https://www.netlify.com/with/nextjs/), [Azure Static Sites](https://azure.microsoft.com/en-us/products/app-service/static), etc?
 
-A: The short answer is no. Most of these cloud providers lack the ability to control run options to load `@newrelic/next`.  Also, most of these cloud providers execute code in a Function as a Service(FaaS) environment.  Our agent requires a different setup and then additional processes to load the telemetry.  Our recommendation is to rely on OpenTelemetry and load the telemetry via our OTLP endpoint.
+A: The short answer is no. Most of these cloud providers lack the ability to control run options to load the New Relic Node.js agent.  Also, most of these cloud providers execute code in a Function as a Service(FaaS) environment.  Our agent requires a different setup and then additional processes to load the telemetry.  Our recommendation is to rely on OpenTelemetry and load the telemetry via our OTLP endpoint.
 
 ## OpenTelemetry setup with New Relic
 

merged/nextjs/docs/faqs/browser-agent.md documentation/nextjs/faqs/browser-agent.md

@@ -1,6 +1,6 @@
 # Injecting Browser Agent
 
-Q: How can I get `@newrelic/next` to log errors to [New Relic Errors Inbox](https://docs.newrelic.com/docs/errors-inbox/errors-inbox/)?
+Q: How can I get the Next.js instrumentation to log errors to [New Relic Errors Inbox](https://docs.newrelic.com/docs/errors-inbox/errors-inbox/)?
 
 A: The Node.js agent has an API to log errors `newrelic.noticeError`. Next.js has an error page that can be used to add the API call. 
 

merged/nextjs/docs/faqs/cloud-providers.md documentation/nextjs/faqs/cloud-providers.md

@@ -9,7 +9,7 @@ A: Typically the New Relic Node.js agent auto-instruments all supported [3rd par
 To externalize all supported 3rd party libraries, add the following to `next.config.js`:
 
 ```js
-const nrExternals = require('@newrelic/next/load-externals')
+const nrExternals = require('newrelic/load-externals')
 
 module.exports = {
   // In order for newrelic to effectively instrument a Next.js application,

merged/nextjs/docs/faqs/error-handling.md documentation/nextjs/faqs/error-handling.md

@@ -11,6 +11,7 @@ const {
   MIN_MW_SUPPORTED_VERSION,
   MAX_MW_SUPPORTED_VERSION
 } = require('./utils')
+const { RecorderSpec } = require('../../shim/specs')
 const SPAN_PREFIX = 'Nodejs/Nextjs'
 const GET_SERVER_SIDE_PROP_VERSION = '13.4.5'
 
@@ -35,8 +36,8 @@ module.exports = function initialize(shim, nextServer) {
           semver.gte(nextVersion, GET_SERVER_SIDE_PROP_VERSION) &&
           components.getServerSideProps
         ) {
-          shim.record(components, 'getServerSideProps', function recordGetServerSideProps(shim) {
-            return new shim.specs.RecorderSpec({
+          shim.record(components, 'getServerSideProps', function recordGetServerSideProps() {
+            return new RecorderSpec({
               inContext(segment) {
                 segment.addSpanAttributes({ 'next.page': pathname })
                 assignCLMAttrs(config, segment, {
@@ -81,7 +82,7 @@ module.exports = function initialize(shim, nextServer) {
       Server.prototype,
       'renderHTML',
       function renderHTMLRecorder(shim, renderToHTML, name, [, , page]) {
-        return new shim.specs.RecorderSpec({
+        return new RecorderSpec({
           inContext(segment) {
             segment.addSpanAttributes({ 'next.page': page })
             assignCLMAttrs(config, segment, {
@@ -106,7 +107,7 @@ module.exports = function initialize(shim, nextServer) {
 
   shim.record(Server.prototype, 'runMiddleware', function runMiddlewareRecorder(shim) {
     const middlewareName = 'middleware'
-    return new shim.specs.RecorderSpec({
+    return new RecorderSpec({
       type: shim.MIDDLEWARE,
       name: `${shim._metrics.MIDDLEWARE}${shim._metrics.PREFIX}/${middlewareName}`,
       inContext(segment) {

merged/nextjs/docs/faqs/instrument-third-party-libraries.md documentation/nextjs/faqs/instrument-third-party-libraries.md

@@ -0,0 +1,22 @@
+/*
+ * Copyright 2022 New Relic Corporation. All rights reserved.
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+'use strict'
+const InstrumentationDescriptor = require('../../instrumentation-descriptor')
+
+// TODO: Remove once we update agent instrumentation to not rely on full required path within Node.js
+// When running Next.js app as a standalone server this is how the next-server is getting loaded
+module.exports = [
+  {
+    type: InstrumentationDescriptor.TYPE_WEB_FRAMEWORK,
+    moduleName: 'next/dist/server/next-server',
+    onRequire: require('./next-server')
+  },
+  {
+    type: InstrumentationDescriptor.TYPE_WEB_FRAMEWORK,
+    moduleName: './next-server',
+    onRequire: require('./next-server')
+  }
+]

merged/nextjs/docs/segments-and-spans.md documentation/nextjs/segments-and-spans.md

@@ -34,6 +34,7 @@ module.exports = function instrumentations() {
     'memcached': { type: InstrumentationDescriptor.TYPE_DATASTORE },
     'mongodb': { type: InstrumentationDescriptor.TYPE_DATASTORE },
     'mysql': { module: './instrumentation/mysql' },
+    'next': { module: './instrumentation/nextjs' },
     'openai': { type: InstrumentationDescriptor.TYPE_GENERIC },
     'pg': { type: InstrumentationDescriptor.TYPE_DATASTORE },
     'pino': { module: './instrumentation/pino' },

merged/nextjs/docs/transactions.md documentation/nextjs/transactions.md

@@ -4,7 +4,7 @@
  */
 
 'use strict'
-const instrumentedLibraries = require('newrelic/lib/instrumentations')() || {}
+const instrumentedLibraries = require('./lib/instrumentations')() || {}
 const libNames = Object.keys(instrumentedLibraries)
 module.exports = function loadExternals(config) {
   if (config.target.includes('node')) {