diff --git a/.ci/.jenkins_tav.yml b/.ci/.jenkins_tav.yml index e4f4f1ae69..db86aff93b 100644 --- a/.ci/.jenkins_tav.yml +++ b/.ci/.jenkins_tav.yml @@ -26,6 +26,7 @@ TAV: - mongodb-core - mysql - mysql2 + - next - pg - pug - redis diff --git a/.eslintrc.json b/.eslintrc.json index 4e5b73bf7f..05895a6912 100644 --- a/.eslintrc.json +++ b/.eslintrc.json @@ -16,9 +16,12 @@ "node_modules", "/examples/esbuild/dist", "/examples/typescript/dist", + "/examples/nextjs", "/lib/opentelemetry-bridge/opentelemetry-core-mini", "/test/babel/out.js", "/test/lambda/fixtures/esbuild-bundled-handler/hello.js", + "/test/instrumentation/modules/next/a-nextjs-app/pages", + "/test/instrumentation/modules/next/a-nextjs-app/components", "/test/sourcemaps/fixtures/lib", "/test/sourcemaps/fixtures/src", "/test/stacktraces/fixtures/dist", diff --git a/.github/dependabot.yml b/.github/dependabot.yml index c9b2ebe308..aaaa0476a4 100644 --- a/.github/dependabot.yml +++ b/.github/dependabot.yml @@ -7,3 +7,11 @@ updates: open-pull-requests-limit: 10 reviewers: - "elastic/apm-agent-node-js" + + - package-ecosystem: "npm" + directory: "/test/instrumentation/modules/next/a-nextjs-app" + schedule: + interval: "weekly" + open-pull-requests-limit: 5 + reviewers: + - "elastic/apm-agent-node-js" diff --git a/.gitignore b/.gitignore index 88194e1551..e58f59c9e4 100644 --- a/.gitignore +++ b/.gitignore @@ -14,3 +14,4 @@ node_modules /test/benchmarks/.tmp /tmp /examples/*/dist +.next diff --git a/CHANGELOG.asciidoc b/CHANGELOG.asciidoc index 893c89b74a..56c4b642e7 100644 --- a/CHANGELOG.asciidoc +++ b/CHANGELOG.asciidoc @@ -31,6 +31,7 @@ Notes: [[release-notes-3.x]] === Node.js Agent version 3.x + ==== Unreleased [float] @@ -41,12 +42,31 @@ Notes: * Enable support for redis v4 ({pull}2945[#2945]) +* preview:[] Next.js server-side instrumentation. See the <> document. ++ +This adds instrumentation of the Next.js dev server (`next dev`) and prod +server (`next start`). The APM transactions for incoming HTTP requests to the +server will be named appropriately based on Next.js's routing -- both for +user page routes (e.g. `GET /a-dynamic-page/[id]`) and for internal Next.js +routes (e.g. `Next.js _next/data route my-page`, +`Next.js Rewrite route /foo -> /bar`). As well, exceptions in server-side code +(e.g. `getServerSideProps`, server-side run page handlers, API handlers) will +be reported. ({pull}2959[#2959]) ++ +This is a technical preview to get feedback from Next.js users. The details on +how exactly the instrumentation works may change in future versions. + * Improve container-info gathering to support AWS ECS/Fargate environments. ({issues}2914[#2914]) [float] ===== Bug fixes +* Source lines of context in stacktraces is *no longer reported* for "*.min.js" + files that do not have source-map information. These files are assumed to + be minimized files, for which source line context won't be useful. This + change is to guard against excessively large stacktrace data. + [float] ===== Chores @@ -55,6 +75,7 @@ Notes: central config. The re-fetch delay is clamped to `[5 seconds, 1 day]`. ({issues}2941[#2941]) + [[release-notes-3.39.0]] ==== 3.39.0 2022/10/17 diff --git a/docs/images/nextjs-my-app-screenshot.png b/docs/images/nextjs-my-app-screenshot.png new file mode 100644 index 0000000000..f2bdc6eb18 Binary files /dev/null and b/docs/images/nextjs-my-app-screenshot.png differ diff --git a/docs/nextjs.asciidoc b/docs/nextjs.asciidoc new file mode 100644 index 0000000000..3b8c83cdc6 --- /dev/null +++ b/docs/nextjs.asciidoc @@ -0,0 +1,208 @@ +:framework: Next.js + +[[nextjs]] + +ifdef::env-github[] +NOTE: For the best reading experience, +please view this documentation at https://www.elastic.co/guide/en/apm/agent/nodejs/current/nextjs.html[elastic.co] +endif::[] + +=== Get started with Next.js + +The Elastic APM Node.js agent can be used to trace the Next.js server (`next +start` or `next dev`) that runs your application without the need for code +changes to your app. The APM transactions for incoming HTTP requests to the +server will be named for the https://nextjs.org/docs/routing/introduction[pages] +and https://nextjs.org/docs/api-routes/introduction[API endpoints] in your +application, as well as for internal routes used by Next.js. Errors in code run +on the server will be reported for viewing in the Kibana APM app. + +Note that the Node.js APM agent can only instrument _server-side_ code. To +monitor the client-side parts of a Next.js application, see the +{apm-rum-ref}/intro.html[Elastic RUM agent]. + +NOTE: preview:[] This Next.js instrumentation is a _technical preview_ while we +solicit feedback from Next.js users. If you are a Next.js user, please help us +provide a better Next.js observability experience with your feedback on our +https://discuss.elastic.co/tags/c/apm/nodejs[Discuss forum]. + + +[float] +[[nextjs-prerequisites]] +==== Prerequisites + +You need an APM Server to send APM data to. Follow the +{apm-guide-ref}/apm-quick-start.html[APM Quick start] if you have not set one up +yet. You will need your *APM server URL* and an APM server *secret token* (or +*API key*) for configuring the APM agent below. + +You will also need a Next.js application to monitor. If you do not have an +existing one to use, you can use the following to create a starter app (see +https://nextjs.org/docs/getting-started[Next.js Getting Started docs] for more): + +[source,bash] +---- +npx create-next-app@latest # use the defaults +cd my-app +---- + +You can also take a look at and use this https://github.com/elastic/apm-agent-nodejs/tree/main/examples/nextjs/[Next.js + Elastic APM example app]. + +[float] +[[nextjs-setup]] +==== Step 1: Add the APM agent dependency + +Add the `elastic-apm-node` module as a dependency to your application: + +[source,bash] +---- +npm install elastic-apm-node --save # or 'yarn add elastic-apm-node' +---- + + +[float] +==== Step 2: Start the APM agent + +For the APM agent to instrument the Next.js server, it needs to be started +before the Next.js server code is loaded. The best way to do so is by using +Node's https://nodejs.org/api/cli.html#-r---require-module[`--require`] option +to load the "elastic-apm-node/start-next.js" module -- this will start the agent +(plus a little more for Next.js integration). + +Edit the "dev" and "start" scripts in your "package.json" as follows: + +[source,json] +---- +{ + // ... + "scripts": { + "dev": "NODE_OPTIONS=--require=elastic-apm-node/start-next.js next dev", + "build": "next build", + "start": "NODE_OPTIONS=--require=elastic-apm-node/start-next.js next start", + "lint": "next lint" + }, + // ... +} +---- + + +[float] +==== Step 3: Configure the APM agent + +The APM agent can be +<> +with environment variables or with an "elastic-apm-node.js" module in the +current working directory. Note that because the APM agent is being loaded +before the Next.js server, the +https://nextjs.org/docs/basic-features/environment-variables[Next.js-supported +".env" files] *cannot* be used to configure the APM agent. We will use an +"elastic-apm-node.js" file here. + +Create an "elastic-apm-node.js" file in the application root with the APM server +URL and secret token values from the <> section above: + +[source,javascript] +---- +// elastic-apm-node.js +module.exports = { + serverUrl: 'https://...', // E.g. https://my-deployment-name.apm.us-west2.gcp.elastic-cloud.com + secretToken: '...' +} +---- + +The equivalent using environment variables is: + +[source,bash] +---- +export ELASTIC_APM_SERVER_URL='https://...' +export ELASTIC_APM_SECRET_TOKEN='...' +---- + +See the <> for full details on supported configuration variables. + + +[float] +==== Step 4: Start your Next.js app + +[source,bash] +---- +npm run dev # or 'npm run build && npm start' for the production server +---- + +Open in your browser to load your Next.js app. If you +used the `create-next-app` tool above, it defines an +http://localhost:3000/api/hello[/api/hello] API endpoint. You can provide some +artificial load by running the following in a separate terminal: + +[source,bash] +---- +while true; do sleep 1; curl -i http://localhost:3000/api/hello; done +---- + +Visit your Kibana APM app and, after a few seconds, you should see a service +entry for your Next.js app. The service name will be pulled from the "name" +field in "package.json". It can be overriden with +<>. Here is an example: + +image::./images/nextjs-my-app-screenshot.png[Kibana APM app showing Next.js my-app] + + +[float] +[[nextjs-limitations]] +==== Limitations and future work + +This Next.js instrumentation has some limitations to be aware of. + +Next.js build tooling bundles dependencies (using Webpack) for both client _and_ +server-side code execution. The Node.js APM agent does not work when bundled. +See <> for details. The implication for Next.js instrumentation +is that you cannot directly import and use the APM agent in your code. That +means that using the <> for manual instrumentation is not currently +possible. + +This instrumentation supports naming APM transactions for many internal Next.js +routes. For example, for +https://nextjs.org/docs/basic-features/data-fetching/get-server-side-props[server-side +rendering (SSR)] Next.js client code will make requests of the form `GET +/next/_data/$buildId/$page.json`, for which the APM agent names the transaction +`Next.js _next/data route $page`. However, there is a limitation with the +Next.js "public folder catchall" route. HTTP requests that resolve to files in +your "public/" directory, for example `GET /favicon.ico`, will result in a +transaction named `GET unknown route`. See <> below. + +If you notice other limitations or have any suggestions, please give us feedback +on our https://discuss.elastic.co/tags/c/apm/nodejs[Discuss forum]. + + +[float] +[[nextjs-performance-monitoring]] +==== Performance monitoring + +Elastic APM automatically measures the performance of your Next.js application. +It records spans for database queries, external HTTP requests, and other slow +operations that happen during requests to your Next.js app. Spans are grouped in +transactions -- by default one for each incoming HTTP request. + +[float] +[[nextjs-unknown-routes]] +==== Unknown routes + +include::./shared-set-up.asciidoc[tag=unknown-roots] + +[float] +[[nextjs-filter-sensitive-information]] +==== Filter sensitive information + +include::./shared-set-up.asciidoc[tag=filter-sensitive-info] + +[float] +[[nextjs-compatibility]] +==== Compatibility + +include::./shared-set-up.asciidoc[tag=compatibility-link] + +[float] +[[nextjs-troubleshooting]] +==== Troubleshooting + +include::./shared-set-up.asciidoc[tag=troubleshooting-link] diff --git a/docs/set-up.asciidoc b/docs/set-up.asciidoc index 992f928866..4f3a377cff 100644 --- a/docs/set-up.asciidoc +++ b/docs/set-up.asciidoc @@ -6,13 +6,15 @@ To get you off the ground, we've prepared guides for setting up the Agent with a // This tagged region is used throughout the documentation to link to the framework guides // Updates made here will be applied elsewhere as well. // tag::web-frameworks-list[] +* <> * <> +* <> * <> * <> +* <> * <> -* <> * <> -* <> +* <> // end::web-frameworks-list[] Alternatively, you can <>. @@ -26,21 +28,24 @@ Other useful documentation includes: * <> * <> +include::./lambda.asciidoc[] + include::./express.asciidoc[] +include::./fastify.asciidoc[] + include::./hapi.asciidoc[] include::./koa.asciidoc[] -include::./restify.asciidoc[] +include::./nextjs.asciidoc[] -include::./fastify.asciidoc[] +include::./restify.asciidoc[] include::./typescript.asciidoc[] include::./custom-stack.asciidoc[] -include::./lambda.asciidoc[] [[starting-the-agent]] === Starting the agent @@ -97,7 +102,7 @@ A limitation of this approach is that you cannot configure the agent with an opt [[start-option-node-require-opt]] ===== `node -r elastic-apm-node/start ...` -Another way to start the agent is with the `-r elastic-apm-node/start` https://nodejs.org/api/cli.html#-r---require-module[command line option to `node`]. This will import and start the APM agent before your application code starts. This method allows you to enable the agent _without touching any code_. This is the recommended start method for <>. +Another way to start the agent is with the `-r elastic-apm-node/start` https://nodejs.org/api/cli.html#-r---require-module[command line option to `node`]. This will import and start the APM agent before your application code starts. This method allows you to enable the agent _without touching any code_. This is the recommended start method for <> and for tracing <>. [source,bash] ---- diff --git a/docs/supported-technologies.asciidoc b/docs/supported-technologies.asciidoc index 322c528193..9dedaa8df6 100644 --- a/docs/supported-technologies.asciidoc +++ b/docs/supported-technologies.asciidoc @@ -82,7 +82,6 @@ This agent is compatible with {apm-guide-ref}[APM Server] v6.6 and above. Though you can use Elastic APM <>, we automate a few things for the most popular Node.js modules. - These are the frameworks that we officially support: [options="header"] @@ -94,6 +93,7 @@ These are the frameworks that we officially support: | <> | >=17.9.0 <21.0.0 | | <> | >=9.0.0 <19.0.0 | Deprecated. No longer tested. | <> via koa-router or @koa/router | >=5.2.0 <13.0.0 | Koa doesn't have a built in router, so we can't support Koa directly since we rely on router information for full support. We currently support the most popular Koa router called https://github.com/koajs/koa-router[koa-router]. +| <> | >=11.1.0 <14.0.0 | (Technical Preview) This instruments Next.js routing to name transactions for incoming HTTP transactions; and reports errors in user pages. It supports the Next.js production server (`next start`) and development server (`next dev`). See the <>. | <> | >=5.2.0 | |======================================================================= diff --git a/examples/nextjs/.eslintrc.json b/examples/nextjs/.eslintrc.json new file mode 100644 index 0000000000..bffb357a71 --- /dev/null +++ b/examples/nextjs/.eslintrc.json @@ -0,0 +1,3 @@ +{ + "extends": "next/core-web-vitals" +} diff --git a/examples/nextjs/.gitignore b/examples/nextjs/.gitignore new file mode 100644 index 0000000000..a248576abd --- /dev/null +++ b/examples/nextjs/.gitignore @@ -0,0 +1,38 @@ +# See https://help.github.com/articles/ignoring-files/ for more about ignoring files. + +/elastic-apm-node.js + +# dependencies +/node_modules +/.pnp +.pnp.js + +# testing +/coverage + +# next.js +/.next/ +/out/ + +# production +/build + +# misc +.DS_Store +*.pem + +# debug +npm-debug.log* +yarn-debug.log* +yarn-error.log* +.pnpm-debug.log* + +# local env files +.env*.local + +# vercel +.vercel + +# typescript +*.tsbuildinfo +next-env.d.ts diff --git a/examples/nextjs/.npmrc b/examples/nextjs/.npmrc new file mode 100644 index 0000000000..43c97e719a --- /dev/null +++ b/examples/nextjs/.npmrc @@ -0,0 +1 @@ +package-lock=false diff --git a/examples/nextjs/README.md b/examples/nextjs/README.md new file mode 100644 index 0000000000..b58c18bee6 --- /dev/null +++ b/examples/nextjs/README.md @@ -0,0 +1,30 @@ +This is a [Next.js](https://nextjs.org/) application +1. bootstrapped with [`create-next-app`](https://github.com/vercel/next.js/tree/canary/packages/create-next-app), and then +2. modified to use the Elastic APM Node.js agent to monitor the Next server. + +## Getting Started + +1. `npm install` + +2. Configure an APM server URL and token for the APM agent. See the [APM Quick start](https://www.elastic.co/guide/en/apm/guide/current/apm-quick-start.html) for help setting up the Elastic Stack. + + ```bash + cp elastic-apm-node.js.template elastic-apm-node.js + vi elastic-apm-node.js + ``` + +3. Run the Next.js server: + + ```bash + npm run dev # the development server + npm run build && npm start # or the production server + ``` + +Open [http://localhost:3000](http://localhost:3000) in your browser to see the result. +An [API route](https://nextjs.org/docs/api-routes/introduction) can be accessed at . + +## Learn More + +- [Get started with Next.js and Elastic APM](https://www.elastic.co/guide/en/apm/agent/nodejs/master/nextjs.html) - official Elastic documentation. +- [Next.js Documentation](https://nextjs.org/docs) - learn about Next.js features and API. +- [Learn Next.js](https://nextjs.org/learn) - an interactive Next.js tutorial. diff --git a/examples/nextjs/elastic-apm-node.js.template b/examples/nextjs/elastic-apm-node.js.template new file mode 100644 index 0000000000..c973ab37dc --- /dev/null +++ b/examples/nextjs/elastic-apm-node.js.template @@ -0,0 +1,5 @@ +module.exports = { + // Configure the APM server URL and token that the APM agent should use. + // serverUrl: 'https://...', // e.g.: http://my-deployment-name.apm.us-west2.gcp.elastic-cloud.com', + // secretToken: '...' +} diff --git a/examples/nextjs/next.config.js b/examples/nextjs/next.config.js new file mode 100644 index 0000000000..ae887958d3 --- /dev/null +++ b/examples/nextjs/next.config.js @@ -0,0 +1,7 @@ +/** @type {import('next').NextConfig} */ +const nextConfig = { + reactStrictMode: true, + swcMinify: true, +} + +module.exports = nextConfig diff --git a/examples/nextjs/package.json b/examples/nextjs/package.json new file mode 100644 index 0000000000..45168c859e --- /dev/null +++ b/examples/nextjs/package.json @@ -0,0 +1,21 @@ +{ + "name": "my-app", + "version": "0.1.0", + "private": true, + "scripts": { + "dev": "NODE_OPTIONS=--require=elastic-apm-node/start-next.js next dev", + "build": "next build", + "start": "NODE_OPTIONS=--require=elastic-apm-node/start-next.js next start", + "lint": "next lint" + }, + "dependencies": { + "elastic-apm-node": "elastic/apm-agent-nodejs#main", + "next": "12.3.1", + "react": "18.2.0", + "react-dom": "18.2.0" + }, + "devDependencies": { + "eslint": "8.25.0", + "eslint-config-next": "12.3.1" + } +} diff --git a/examples/nextjs/pages/_app.js b/examples/nextjs/pages/_app.js new file mode 100644 index 0000000000..1e1cec9242 --- /dev/null +++ b/examples/nextjs/pages/_app.js @@ -0,0 +1,7 @@ +import '../styles/globals.css' + +function MyApp({ Component, pageProps }) { + return +} + +export default MyApp diff --git a/examples/nextjs/pages/api/hello.js b/examples/nextjs/pages/api/hello.js new file mode 100644 index 0000000000..df63de88fa --- /dev/null +++ b/examples/nextjs/pages/api/hello.js @@ -0,0 +1,5 @@ +// Next.js API route support: https://nextjs.org/docs/api-routes/introduction + +export default function handler(req, res) { + res.status(200).json({ name: 'John Doe' }) +} diff --git a/examples/nextjs/pages/index.js b/examples/nextjs/pages/index.js new file mode 100644 index 0000000000..dc4b640352 --- /dev/null +++ b/examples/nextjs/pages/index.js @@ -0,0 +1,69 @@ +import Head from 'next/head' +import Image from 'next/image' +import styles from '../styles/Home.module.css' + +export default function Home() { + return ( + + ) +} diff --git a/examples/nextjs/public/favicon.ico b/examples/nextjs/public/favicon.ico new file mode 100644 index 0000000000..718d6fea48 Binary files /dev/null and b/examples/nextjs/public/favicon.ico differ diff --git a/examples/nextjs/public/vercel.svg b/examples/nextjs/public/vercel.svg new file mode 100644 index 0000000000..fbf0e25a65 --- /dev/null +++ b/examples/nextjs/public/vercel.svg @@ -0,0 +1,4 @@ + + + \ No newline at end of file diff --git a/examples/nextjs/styles/Home.module.css b/examples/nextjs/styles/Home.module.css new file mode 100644 index 0000000000..bd50f42ffe --- /dev/null +++ b/examples/nextjs/styles/Home.module.css @@ -0,0 +1,129 @@ +.container { + padding: 0 2rem; +} + +.main { + min-height: 100vh; + padding: 4rem 0; + flex: 1; + display: flex; + flex-direction: column; + justify-content: center; + align-items: center; +} + +.footer { + display: flex; + flex: 1; + padding: 2rem 0; + border-top: 1px solid #eaeaea; + justify-content: center; + align-items: center; +} + +.footer a { + display: flex; + justify-content: center; + align-items: center; + flex-grow: 1; +} + +.title a { + color: #0070f3; + text-decoration: none; +} + +.title a:hover, +.title a:focus, +.title a:active { + text-decoration: underline; +} + +.title { + margin: 0; + line-height: 1.15; + font-size: 4rem; +} + +.title, +.description { + text-align: center; +} + +.description { + margin: 4rem 0; + line-height: 1.5; + font-size: 1.5rem; +} + +.code { + background: #fafafa; + border-radius: 5px; + padding: 0.75rem; + font-size: 1.1rem; + font-family: Menlo, Monaco, Lucida Console, Liberation Mono, DejaVu Sans Mono, + Bitstream Vera Sans Mono, Courier New, monospace; +} + +.grid { + display: flex; + align-items: center; + justify-content: center; + flex-wrap: wrap; + max-width: 800px; +} + +.card { + margin: 1rem; + padding: 1.5rem; + text-align: left; + color: inherit; + text-decoration: none; + border: 1px solid #eaeaea; + border-radius: 10px; + transition: color 0.15s ease, border-color 0.15s ease; + max-width: 300px; +} + +.card:hover, +.card:focus, +.card:active { + color: #0070f3; + border-color: #0070f3; +} + +.card h2 { + margin: 0 0 1rem 0; + font-size: 1.5rem; +} + +.card p { + margin: 0; + font-size: 1.25rem; + line-height: 1.5; +} + +.logo { + height: 1em; + margin-left: 0.5rem; +} + +@media (max-width: 600px) { + .grid { + width: 100%; + flex-direction: column; + } +} + +@media (prefers-color-scheme: dark) { + .card, + .footer { + border-color: #222; + } + .code { + background: #111; + } + .logo img { + filter: invert(1); + } +} diff --git a/examples/nextjs/styles/globals.css b/examples/nextjs/styles/globals.css new file mode 100644 index 0000000000..4f1842163d --- /dev/null +++ b/examples/nextjs/styles/globals.css @@ -0,0 +1,26 @@ +html, +body { + padding: 0; + margin: 0; + font-family: -apple-system, BlinkMacSystemFont, Segoe UI, Roboto, Oxygen, + Ubuntu, Cantarell, Fira Sans, Droid Sans, Helvetica Neue, sans-serif; +} + +a { + color: inherit; + text-decoration: none; +} + +* { + box-sizing: border-box; +} + +@media (prefers-color-scheme: dark) { + html { + color-scheme: dark; + } + body { + color: white; + background: black; + } +} diff --git a/lib/instrumentation/index.js b/lib/instrumentation/index.js index 1d6a1f4a1b..18e2d92a6e 100644 --- a/lib/instrumentation/index.js +++ b/lib/instrumentation/index.js @@ -63,6 +63,10 @@ var MODULES = [ 'mongodb', 'mysql', 'mysql2', + 'next/dist/server/api-utils/node', + 'next/dist/server/dev/next-dev-server', + 'next/dist/server/next', + 'next/dist/server/next-server', 'pg', 'pug', 'redis', diff --git a/lib/instrumentation/modules/next/README.md b/lib/instrumentation/modules/next/README.md new file mode 100644 index 0000000000..165ba13702 --- /dev/null +++ b/lib/instrumentation/modules/next/README.md @@ -0,0 +1,84 @@ +# Next.js instrumentation dev notes + +Instrumenting the Next.js servers (the dev and prod servers) involves shimming +a number of files. An overview of the instrumentation is provided here. +Some of the complexity here is that I found the Next.js server internals not +always ammenable to instrumentation. There isn't a clean separation between +"determine the route", "run the handler for that route", "expose an error +or the result". + +There are a number of ways to deploy (https://nextjs.org/docs/deployment) a +Next.js app. This instrumentation works with "Self-Hosting", and using Next.js's +built-in server. + +Here is the Next.js "server" class hierarchy: + + class Server (in base-server.ts) + class NextNodeServer (in next-server.ts, used for `next start`) + class DevServer (in dev/next-dev-server.js, used for `next dev`) + + +## dist/server/next.js + +This is the first module imported for `require('next')`. It is used solely +to `agent.setFramework(...)`. Doing so in "next-server.js" can be too late +because it is lazily imported when creating the Next server -- by which point +metadata may have already been sent on the first APM agent intake request. + + +## dist/server/next-server.js + +This file in the "next" package implements the `NextNodeServer`, the Next.js +"production" server used by `next start`. Most instrumentation is on this class. + +The Next.js server is a vanilla Node.js `http.createServer` (http-only, https +termination isn't supported) using `NextNodeServer.handleRequest` as the request +handler, so every request to the server is a call to that method. + +User routes are defined by files under "pages/". Generally, an incoming request path: + GET /a-page +is resolved to one of those pages: + ./pages/a-page.js +The user files under "./pages/" are loaded by `NextNodeServer.findPageComponents`. +**We instrument `findPageComponents` to capture the resolved page name to use +for the transaction name.** + +There are also other built-in routes to handle redirects, rewrites, static-file +serving (e.g. `GET /favicon.ico -> ./public/favicon.ico`), and various internal +`/_next/...` routes used by the Next.js client code for bundle loading, +server-side generated page data, etc. At server start, a call to +`.generateRoutes()` is called which returns a somewhat regular data structure +with routing data. **We instrument *most* of these routes to set +`transaction.name` appropriately for most of these internal routes.** A notable +limitation is the `public folder catchall` route that could not be cleanly +instrumented. + +An error in rendering a page results in `renderErrorToResponse(err)` being +called to handle that error. **We instrument `renderErrorToResponse` to +`apm.captureError()` those errors.** (Limitation: There are some edge cases +where this method is not used to handle an exception. This instrumentation isn't +capturing those.) + +*API* routes ("pages/api/...") are handled differently from other pages. +The `catchAllRoute` route handler calls `handleApiRequest`, which resolves +the URL path to a possibly dynamic route name (e.g. `/api/widgets/[id]`, +**we instrument `ensureApiPage` to get that resolve route name**), loads the +webpack-compiled user module for that route, and calls `apiResolver` in +"api-utils/node.ts" to execute. **We instrument that `apiResolve()` function +to capture any errors in the user's handler.** + + +## dist/server/dev/next-dev-server.js + +This file defines the `DevServer` used by `next dev`. It subclasses +`NextNodeServer`. The instrumentation in this file is **very** similar to that +in "next-server.js". However, some of it needs to be repeated on the `DevServer` +class to capture results specific to the dev-server. For example +`DevServer.generateRoutes()` includes some additional routes. + + +## dist/server/api-utils/node.js + +See the `apiResolve()` mention above. + + diff --git a/lib/instrumentation/modules/next/dist/server/api-utils/node.js b/lib/instrumentation/modules/next/dist/server/api-utils/node.js new file mode 100644 index 0000000000..59a4b00710 --- /dev/null +++ b/lib/instrumentation/modules/next/dist/server/api-utils/node.js @@ -0,0 +1,88 @@ +/* + * Copyright Elasticsearch B.V. and other contributors where applicable. + * Licensed under the BSD 2-Clause License; you may not use this file except in + * compliance with the BSD 2-Clause License. + */ + +'use strict' + +// See "lib/instrumentation/modules/next/README.md". + +const semver = require('semver') + +const shimmer = require('../../../../../shimmer') + +const kErrIsCaptured = Symbol.for('ElasticAPMNextJsErrIsCaptured') + +module.exports = function (mod, agent, { version, enabled }) { + if (!enabled) { + return mod + } + if (!semver.satisfies(version, '>=11.1.0 <14.0.0', { includePrerelease: true })) { + agent.logger.debug('next/dist/server/api-utils/node.js version %s not supported, skipping', version) + return mod + } + + const wrappedModFromMod = new WeakMap() + + shimmer.wrap(mod, 'apiResolver', wrapApiResolver) + + return mod + + function wrapApiResolver (orig) { + return function wrappedApiResolver (_req, _res, _query, resolverModule, _apiContext, _propagateError, _dev, _page) { + // The user module that we are wrapping is a webpack-wrapped build that + // exposes fields only as getters. We therefore need to fully replace + // the module to be able to wrap the single `.default` field. + // + // Cache `wrappedMod` so we only need to create it once per API endpoint, + // rather than every time each API endpoint is called. + let wrappedMod = wrappedModFromMod.get(resolverModule) + if (!wrappedMod) { + wrappedMod = {} + const names = Object.getOwnPropertyNames(resolverModule) + for (let i = 0; i < names.length; i++) { + const name = names[i] + if (name !== 'default') { + // Proxy other module fields. + Object.defineProperty(wrappedMod, name, { enumerable: true, get: function () { return resolverModule[name] } }) + } + } + wrappedMod.default = wrapApiHandler(resolverModule.default || resolverModule) + wrappedModFromMod.set(resolverModule, wrappedMod) + } + arguments[3] = wrappedMod + + return orig.apply(this, arguments) + } + } + + function wrapApiHandler (orig) { + // This wraps a user's API handler in order to capture an error if there + // is one. For example: + // // pages/api/some-endpoint-path.js + // export default function handler(req, res) { + // // ... + // throw new Error('boom') + // } + // That handler might also be async, in which case it returns a promise + // that we want to watch for a possible rejection. + return function wrappedApiHandler () { + let promise + try { + promise = orig.apply(this, arguments) + } catch (syncErr) { + agent.captureError(syncErr) + syncErr[kErrIsCaptured] = true + throw syncErr + } + if (promise) { + promise.catch(rejectErr => { + agent.captureError(rejectErr) + rejectErr[kErrIsCaptured] = true + }) + } + return promise + } + } +} diff --git a/lib/instrumentation/modules/next/dist/server/dev/next-dev-server.js b/lib/instrumentation/modules/next/dist/server/dev/next-dev-server.js new file mode 100644 index 0000000000..ab1e70523c --- /dev/null +++ b/lib/instrumentation/modules/next/dist/server/dev/next-dev-server.js @@ -0,0 +1,199 @@ +/* + * Copyright Elasticsearch B.V. and other contributors where applicable. + * Licensed under the BSD 2-Clause License; you may not use this file except in + * compliance with the BSD 2-Clause License. + */ + +'use strict' + +// See "lib/instrumentation/modules/next/README.md". + +const semver = require('semver') + +const shimmer = require('../../../../../shimmer') + +const kSetTransNameFn = Symbol.for('ElasticAPMNextJsSetTransNameFn') + +const noopFn = () => {} + +module.exports = function (mod, agent, { version, enabled }) { + if (!enabled) { + return mod + } + if (!semver.satisfies(version, '>=11.1.0 <14.0.0', { includePrerelease: true })) { + agent.logger.debug('next version %s not supported, skipping', version) + return mod + } + + const ins = agent._instrumentation + const log = agent.logger + + const DevServer = mod.default + shimmer.wrap(DevServer.prototype, 'generateRoutes', wrapGenerateRoutes) + shimmer.wrap(DevServer.prototype, 'ensureApiPage', wrapEnsureApiPage) + shimmer.wrap(DevServer.prototype, 'findPageComponents', wrapFindPageComponents) + // Instrumenting the DevServer also uses the wrapping of + // 'NextNodeServer.renderErrorToResponse' in "next-server.js". + + return mod + + // The `route` objects being wrapped here have this type: + // https://github.com/vercel/next.js/blob/v12.3.0/packages/next/server/router.ts#L26-L45 + function wrapGenerateRoutes (orig) { + return function wrappedGenerateRoutes () { + if (this.constructor !== DevServer) { + return orig.apply(this, arguments) + } + const routes = orig.apply(this, arguments) + log.debug('wrap Next.js DevServer routes') + routes.redirects.forEach(wrapRedirectRoute) + routes.rewrites.beforeFiles.forEach(wrapRewriteRoute) + routes.rewrites.afterFiles.forEach(wrapRewriteRoute) + routes.rewrites.fallback.forEach(wrapRewriteRoute) + routes.fsRoutes.forEach(wrapFsRoute) + wrapCatchAllRoute(routes.catchAllRoute) + return routes + } + } + + function wrapRedirectRoute (route) { + if (typeof route.fn !== 'function') { + return + } + const origRouteFn = route.fn + route.fn = function () { + const trans = ins.currTransaction() + if (trans) { + trans.setDefaultName('Next.js ' + route.name) + trans[kSetTransNameFn] = noopFn + } + return origRouteFn.apply(this, arguments) + } + } + + function wrapRewriteRoute (route) { + if (typeof route.fn !== 'function') { + return + } + const origRouteFn = route.fn + route.fn = function () { + const trans = ins.currTransaction() + if (trans) { + trans.setDefaultName(`Next.js ${route.name} -> ${route.destination}`) + trans[kSetTransNameFn] = noopFn + } + return origRouteFn.apply(this, arguments) + } + } + + // "FS" routes are those that go looking for matching paths on the filesystem + // to fulfill the request. + function wrapFsRoute (route) { + if (typeof route.fn !== 'function') { + return + } + const origRouteFn = route.fn + // We explicitly handle only the `fsRoute`s that we know by name in the + // Next.js code. We cannot set `trans.name` for all of them because of the + // true catch-all-routes that match any path and only sometimes handle them + // (e.g. 'public folder catchall'). + switch (route.name) { + case '_next/data catchall': + // This handles "/_next/data/..." paths that are used by Next.js + // client-side code to call `getServerSideProps()` for user pages. + route.fn = function () { + const trans = ins.currTransaction() + if (trans) { + trans.setDefaultName(`Next.js ${route.name}`) + if (!trans[kSetTransNameFn]) { + trans[kSetTransNameFn] = (_req, pathname) => { + trans.setDefaultName(`Next.js _next/data route ${pathname}`) + trans[kSetTransNameFn] = noopFn + } + } + } + return origRouteFn.apply(this, arguments) + } + break + case '_next/static/development/_devMiddlewareManifest.json': + case '_next/static/development/_devPagesManifest.json': + case '_next/development catchall': + case '_next/static catchall': + case '_next/image catchall': + case '_next catchall': + route.fn = function () { + const trans = ins.currTransaction() + if (trans) { + trans.setDefaultName(`Next.js ${route.name}`) + } + return origRouteFn.apply(this, arguments) + } + break + } + } + + function wrapCatchAllRoute (route) { + if (typeof route.fn !== 'function') { + return + } + const origRouteFn = route.fn + route.fn = function () { + const trans = ins.currTransaction() + // This is a catchall route, so only set a kSetTransNameFn if a more + // specific route wrapper hasn't already done so. + if (trans && !trans[kSetTransNameFn]) { + trans[kSetTransNameFn] = (req, pathname) => { + trans.setDefaultName(`${req.method} ${pathname}`) + // Ensure only the first `findPageComponents` result sets the trans + // name, otherwise a loaded `/_error` for page error handling could + // incorrectly override. + trans[kSetTransNameFn] = noopFn + } + } + return origRouteFn.apply(this, arguments) + } + } + + function wrapEnsureApiPage (orig) { + return function wrappedEnsureApiPage (pathname) { + if (this.constructor !== DevServer) { + return orig.apply(this, arguments) + } + const trans = ins.currTransaction() + if (trans && trans.req) { + log.trace({ pathname }, 'set transaction name from ensureApiPage') + trans.setDefaultName(`${trans.req.method} ${pathname}`) + trans[kSetTransNameFn] = noopFn + } + return orig.apply(this, arguments) + } + } + + // `findPageComponents` is used to load any "./pages/..." files. It provides + // the resolved path appropriate for the transaction name. + function wrapFindPageComponents (orig) { + return function wrappedFindPageComponents (pathnameOrArgs) { + if (this.constructor !== DevServer) { + return orig.apply(this, arguments) + } + + // In next <=12.2.6-canary.10 the function signature is: + // async findPageComponents(pathname, query, params, isAppPath) + // after that version it is: + // async findPageComponents({ pathname, query, params, isAppPath }) + const pathname = typeof pathnameOrArgs === 'string' ? pathnameOrArgs : pathnameOrArgs.pathname + + const promise = orig.apply(this, arguments) + promise.then(findComponentsResult => { + if (findComponentsResult) { + const trans = ins.currTransaction() + if (trans && trans.req && trans[kSetTransNameFn]) { + log.trace({ pathname }, 'set transaction name from findPageComponents') + trans[kSetTransNameFn](trans.req, pathname) + } + } + }) + return promise + } + } +} diff --git a/lib/instrumentation/modules/next/dist/server/next-server.js b/lib/instrumentation/modules/next/dist/server/next-server.js new file mode 100644 index 0000000000..0431e260d0 --- /dev/null +++ b/lib/instrumentation/modules/next/dist/server/next-server.js @@ -0,0 +1,224 @@ +/* + * Copyright Elasticsearch B.V. and other contributors where applicable. + * Licensed under the BSD 2-Clause License; you may not use this file except in + * compliance with the BSD 2-Clause License. + */ + +'use strict' + +// See "lib/instrumentation/modules/next/README.md". + +const semver = require('semver') + +const shimmer = require('../../../../shimmer') + +const kSetTransNameFn = Symbol.for('ElasticAPMNextJsSetTransNameFn') +const kErrIsCaptured = Symbol.for('ElasticAPMNextJsErrIsCaptured') + +const noopFn = () => {} + +module.exports = function (mod, agent, { version, enabled }) { + if (!enabled) { + return mod + } + if (!semver.satisfies(version, '>=11.1.0 <14.0.0', { includePrerelease: true })) { + agent.logger.debug('next version %s not supported, skipping', version) + return mod + } + + const ins = agent._instrumentation + const log = agent.logger + + const NextNodeServer = mod.default + shimmer.wrap(NextNodeServer.prototype, 'generateRoutes', wrapGenerateRoutes) + shimmer.wrap(NextNodeServer.prototype, 'ensureApiPage', wrapEnsureApiPage) + shimmer.wrap(NextNodeServer.prototype, 'findPageComponents', wrapFindPageComponents) + shimmer.wrap(NextNodeServer.prototype, 'renderErrorToResponse', wrapRenderErrorToResponse) + + return mod + + // The `route` objects being wrapped here have this type: + // https://github.com/vercel/next.js/blob/v12.3.0/packages/next/server/router.ts#L26-L45 + function wrapGenerateRoutes (orig) { + return function wrappedGenerateRoutes () { + if (this.constructor !== NextNodeServer) { + return orig.apply(this, arguments) + } + const routes = orig.apply(this, arguments) + log.debug('wrap Next.js NodeNextServer routes') + routes.redirects.forEach(wrapRedirectRoute) + routes.rewrites.beforeFiles.forEach(wrapRewriteRoute) + routes.rewrites.afterFiles.forEach(wrapRewriteRoute) + routes.rewrites.fallback.forEach(wrapRewriteRoute) + routes.fsRoutes.forEach(wrapFsRoute) + wrapCatchAllRoute(routes.catchAllRoute) + return routes + } + } + + function wrapRedirectRoute (route) { + if (typeof route.fn !== 'function') { + return + } + const origRouteFn = route.fn + route.fn = function () { + const trans = ins.currTransaction() + if (trans) { + trans.setDefaultName('Next.js ' + route.name) + trans[kSetTransNameFn] = noopFn + } + return origRouteFn.apply(this, arguments) + } + } + + function wrapRewriteRoute (route) { + if (typeof route.fn !== 'function') { + return + } + const origRouteFn = route.fn + route.fn = function () { + const trans = ins.currTransaction() + if (trans) { + trans.setDefaultName(`Next.js ${route.name} -> ${route.destination}`) + trans[kSetTransNameFn] = noopFn + } + return origRouteFn.apply(this, arguments) + } + } + + // "FS" routes are those that go looking for matching paths on the filesystem + // to fulfill the request. + function wrapFsRoute (route) { + if (typeof route.fn !== 'function') { + return + } + const origRouteFn = route.fn + // We explicitly handle only the `fsRoute`s that we know by name in the + // Next.js code. We cannot set `trans.name` for all of them because of the + // true catch-all-routes that match any path and only sometimes handle them + // (e.g. 'public folder catchall'). + switch (route.name) { + case '_next/data catchall': + // This handles "/_next/data/..." paths that are used by Next.js + // client-side code to call `getServerSideProps()` for user pages. + route.fn = function () { + const trans = ins.currTransaction() + if (trans) { + trans.setDefaultName(`Next.js ${route.name}`) + if (!trans[kSetTransNameFn]) { + trans[kSetTransNameFn] = (_req, pathname) => { + trans.setDefaultName(`Next.js _next/data route ${pathname}`) + trans[kSetTransNameFn] = noopFn + } + } + } + return origRouteFn.apply(this, arguments) + } + break + case '_next/static catchall': + case '_next/image catchall': + case '_next catchall': + route.fn = function () { + const trans = ins.currTransaction() + if (trans) { + trans.setDefaultName(`Next.js ${route.name}`) + } + return origRouteFn.apply(this, arguments) + } + break + } + } + + function wrapCatchAllRoute (route) { + if (typeof route.fn !== 'function') { + return + } + const origRouteFn = route.fn + route.fn = function () { + const trans = ins.currTransaction() + // This is a catchall route, so only set a kSetTransNameFn if a more + // specific route wrapper hasn't already done so. + if (trans && !trans[kSetTransNameFn]) { + trans[kSetTransNameFn] = (req, pathname) => { + trans.setDefaultName(`${req.method} ${pathname}`) + // Ensure only the first `findPageComponents` result sets the trans + // name, otherwise a loaded `/_error` for page error handling could + // incorrectly override. + trans[kSetTransNameFn] = noopFn + } + } + return origRouteFn.apply(this, arguments) + } + } + + function wrapEnsureApiPage (orig) { + return function wrappedEnsureApiPage (pathname) { + if (this.constructor !== NextNodeServer) { + return orig.apply(this, arguments) + } + const trans = ins.currTransaction() + if (trans && trans.req) { + log.trace({ pathname }, 'set transaction name from ensureApiPage') + trans.setDefaultName(`${trans.req.method} ${pathname}`) + trans[kSetTransNameFn] = noopFn + } + return orig.apply(this, arguments) + } + } + + // `findPageComponents` is used to load any "./pages/..." files. It provides + // the resolved path appropriate for the transaction name. + function wrapFindPageComponents (orig) { + return function wrappedFindPageComponents (pathnameOrArgs) { + if (this.constructor !== NextNodeServer) { + return orig.apply(this, arguments) + } + + // In next <=12.2.6-canary.10 the function signature is: + // async findPageComponents(pathname, query, params, isAppPath) + // after that version it is: + // async findPageComponents({ pathname, query, params, isAppPath }) + const pathname = typeof pathnameOrArgs === 'string' ? pathnameOrArgs : pathnameOrArgs.pathname + + const promise = orig.apply(this, arguments) + promise.then(findComponentsResult => { + if (findComponentsResult) { + const trans = ins.currTransaction() + if (trans && trans.req && trans[kSetTransNameFn]) { + log.trace({ pathname }, 'set transaction name from findPageComponents') + trans[kSetTransNameFn](trans.req, pathname) + } + } + }) + return promise + } + } + + function wrapRenderErrorToResponse (orig) { + return function wrappedRenderErrorToResponse (ctx, err) { + // The wrapped `NodeNextServer.renderErrorToResponse` is used for both + // this and the "next-dev-sever.js" instrumentation, so it doesn't have + // the `this.constructor !== ...` guard that the above wrappers do. + + const trans = ins.currTransaction() + if (trans) { + // Next.js is now doing error handling for this request, which typically + // means loading the "_error.js" page component. We don't want + // that `findPageComponents` call to set the transaction name. + trans[kSetTransNameFn] = noopFn + } + + // - Next.js uses `err=null` to handle a 404. + // - To capture errors in API handlers we have shimmed `apiResolver` (see + // "api-utils/node.js"). In the dev server only, `renderErrorToResponse` + // is *also* called for the error -- and in v12.2.6 and below it is + // called *twice*. The `kErrIsCaptured` guard prevents capturing + // the same error twice. + if (err && !err[kErrIsCaptured]) { + agent.captureError(err) + err[kErrIsCaptured] = true + } + return orig.apply(this, arguments) + } + } +} diff --git a/lib/instrumentation/modules/next/dist/server/next.js b/lib/instrumentation/modules/next/dist/server/next.js new file mode 100644 index 0000000000..ff930a2554 --- /dev/null +++ b/lib/instrumentation/modules/next/dist/server/next.js @@ -0,0 +1,29 @@ +/* + * Copyright Elasticsearch B.V. and other contributors where applicable. + * Licensed under the BSD 2-Clause License; you may not use this file except in + * compliance with the BSD 2-Clause License. + */ + +'use strict' + +// See "lib/instrumentation/modules/next/README.md". + +const semver = require('semver') + +module.exports = function (mod, agent, { version, enabled }) { + if (!enabled) { + return mod + } + if (!semver.satisfies(version, '>=11.1.0 <14.0.0', { includePrerelease: true })) { + agent.logger.debug('next version %s not supported, skipping', version) + return mod + } + + // This isn't perfect. Which framework the agent will report with a + // custom Next.js server using another framework, e.g. + // https://github.com/vercel/next.js/blob/canary/examples/custom-server-fastify/server.js + // depends on which is *imported* first. + agent.setFramework({ name: 'Next.js', version, overwrite: false }) + + return mod +} diff --git a/lib/propwrap.js b/lib/propwrap.js index 94c74fb1a4..194edc7bb5 100644 --- a/lib/propwrap.js +++ b/lib/propwrap.js @@ -67,7 +67,7 @@ var __copyProps = (to, from, except, desc) => { * console.log(os.platform()) // => DARWIN * * The subpath can indicate a nested property. Each property in that subpath, - * except the last, much identify an *Object*. + * except the last, must identify an *Object*. * * Limitations: * - This doesn't handle possible Symbol properties on the copied object(s). diff --git a/lib/stacktraces.js b/lib/stacktraces.js index c42cee4af6..b3ed19935e 100644 --- a/lib/stacktraces.js +++ b/lib/stacktraces.js @@ -380,6 +380,15 @@ function frameFromCallSite (log, callsite, cwd, sourceLinesAppFrames, sourceLine } } + // If the file looks like it minimized (as we didn't have a source-map in + // the processing above), then skip adding source context because it + // is mostly useless and the typically 500-char lines result in over-large + // APM error objects. + if (filename.endsWith('.min.js')) { + cacheAndCb(frame) + return + } + // Otherwise load the file from disk, if available. fileCache.get(frame.abs_path, function onFileCacheGet (fileErr, lines) { if (fileErr) { diff --git a/package.json b/package.json index f066d1cd34..51d702f2b0 100644 --- a/package.json +++ b/package.json @@ -15,8 +15,8 @@ "lint:yaml-files": "./dev-utils/lint-yaml-files.sh # requires node >=10", "coverage": "COVERAGE=true ./test/script/run_tests.sh", "test": "./test/script/run_tests.sh", - "test:deps": "dependency-check start.js index.js 'lib/**/*.js' 'test/**/*.js' --no-dev -i async_hooks -i perf_hooks -i parseurl -i node:http", - "test:tav": "tav --quiet", + "test:deps": "dependency-check index.js start.js start-next.js 'lib/**/*.js' 'test/**/*.js' '!test/instrumentation/modules/next/a-nextjs-app' --no-dev -i async_hooks -i perf_hooks -i parseurl -i node:http", + "test:tav": "tav --quiet && (cd test/instrumentation/modules/next/a-nextjs-app && tav --quiet)", "test:docs": "./test/script/docker/run_docs.sh", "test:types": "tsc --project test/types/tsconfig.json && tsc --project test/types/transpile/tsconfig.json && node test/types/transpile/index.js && tsc --project test/types/transpile-default/tsconfig.json && node test/types/transpile-default/index.js", "test:babel": "babel test/babel/src.js --out-file test/babel/out.js && cd test/babel && node out.js", @@ -38,8 +38,10 @@ "lib", "types", "start.js", + "start-next.js", "index.d.ts", - "start.d.ts" + "start.d.ts", + "start-next.d.ts" ], "repository": { "type": "git", diff --git a/start-next.d.ts b/start-next.d.ts new file mode 100644 index 0000000000..b5ac73aa55 --- /dev/null +++ b/start-next.d.ts @@ -0,0 +1,8 @@ +/* + * Copyright Elasticsearch B.V. and other contributors where applicable. + * Licensed under the BSD 2-Clause License; you may not use this file except in + * compliance with the BSD 2-Clause License. + */ + +import * as agent from './'; +export = agent; diff --git a/start-next.js b/start-next.js new file mode 100644 index 0000000000..89b6faa3d4 --- /dev/null +++ b/start-next.js @@ -0,0 +1,27 @@ +/* + * Copyright Elasticsearch B.V. and other contributors where applicable. + * Licensed under the BSD 2-Clause License; you may not use this file except in + * compliance with the BSD 2-Clause License. + */ + +'use strict' + +// Use this module via `node --require=elastic-apm-node/start-next.js ...` +// to monitor a Next.js app with Elastic APM. + +const apm = require('./').start() + +// Flush APM data on server process termination. +// https://nextjs.org/docs/deployment#manual-graceful-shutdowns +// Note: Support for NEXT_MANUAL_SIG_HANDLE was added in next@12.1.7-canary.7, +// so this `apm.flush()` will only happen in that and later versions. +process.env.NEXT_MANUAL_SIG_HANDLE = 1 +function flushApmAndExit () { + apm.flush(() => { + process.exit(0) + }) +} +process.on('SIGTERM', flushApmAndExit) +process.on('SIGINT', flushApmAndExit) + +module.exports = apm diff --git a/test/config.test.js b/test/config.test.js index 93f869f8b8..4b585d405a 100644 --- a/test/config.test.js +++ b/test/config.test.js @@ -1030,6 +1030,10 @@ test('disableInstrumentations', function (t) { modules.delete('koa-router') // koa-router@11 supports node >=12 modules.delete('@koa/router') // koa-router@11 supports node >=12 } + modules.delete('next/dist/server/api-utils/node') + modules.delete('next/dist/server/dev/next-dev-server') + modules.delete('next/dist/server/next') + modules.delete('next/dist/server/next-server') if (semver.lt(process.version, '14.0.0')) { modules.delete('redis') // redis@4 supports node >=14 modules.delete('@redis/client/dist/lib/client') // redis@4 supports node >=14 diff --git a/test/instrumentation/modules/next/a-nextjs-app/.tav.yml b/test/instrumentation/modules/next/a-nextjs-app/.tav.yml new file mode 100644 index 0000000000..71ec36ef43 --- /dev/null +++ b/test/instrumentation/modules/next/a-nextjs-app/.tav.yml @@ -0,0 +1,32 @@ +# Test Next.js versions. +# +# - We instrument Next.js ">=11.1.0 <14.0.0". I don't see much value in testing +# every patch-level release. Instead we will test the latest patch release +# for each minor. (It would be nice if tav supported this natively.) +# - Next.js 11 supports back to node v12.22.0 and v14.5.0. However, when this +# instrumentation was added, Node v12 was already EOL, so there is less value +# in testing it. +next-11: + name: next + versions: '11.1.0 || 11.1.4' + node: '>=14.5.0' + commands: node ../next.test.js + peerDependencies: + - "react@^17.0.2" + - "react-dom@^17.0.2" +next-12: + name: next + versions: '12.0.10 || 12.1.6 || 12.2.6 || 12.3.1 || >12.3.1 <13' + node: '>=14.5.0' + commands: node ../next.test.js + peerDependencies: + - "react@^18.2.0" + - "react-dom@^18.2.0" +next: + name: next + versions: '>=13.0.0 <14' + node: '>=14.6.0' + commands: node ../next.test.js + peerDependencies: + - "react@^18.2.0" + - "react-dom@^18.2.0" diff --git a/test/instrumentation/modules/next/a-nextjs-app/components/Header.js b/test/instrumentation/modules/next/a-nextjs-app/components/Header.js new file mode 100644 index 0000000000..5236d49961 --- /dev/null +++ b/test/instrumentation/modules/next/a-nextjs-app/components/Header.js @@ -0,0 +1,31 @@ +/* + * Copyright Elasticsearch B.V. and other contributors where applicable. + * Licensed under the BSD 2-Clause License; you may not use this file except in + * compliance with the BSD 2-Clause License. + */ + +import Head from 'next/head' +import Link from 'next/link' + +function Header () { + return ( + <> + + A Next.js App + +
+
+ Home +  |  + APage +  |  + AnSSRPage +  |  + ADynamicPage/42 +
+
+ + ) +} + +export default Header diff --git a/test/instrumentation/modules/next/a-nextjs-app/next.config.js b/test/instrumentation/modules/next/a-nextjs-app/next.config.js new file mode 100644 index 0000000000..de686f23cb --- /dev/null +++ b/test/instrumentation/modules/next/a-nextjs-app/next.config.js @@ -0,0 +1,57 @@ +/* + * Copyright Elasticsearch B.V. and other contributors where applicable. + * Licensed under the BSD 2-Clause License; you may not use this file except in + * compliance with the BSD 2-Clause License. + */ + +/** + * @type {import('next').NextConfig} + */ +const nextConfig = { + async redirects () { + return [ + { + source: '/redirect-to-a-page', + destination: '/a-page', + permanent: false + } + ] + }, + async rewrites () { + return { + beforeFiles: [ + { + source: '/rewrite-with-a-has-condition', + destination: '/a-page', + has: [{ type: 'query', key: 'overrideMe' }] + } + ], + afterFiles: [ + { + source: '/rewrite-to-a-page', + destination: '/a-page' + }, + { + source: '/rewrite-to-a-dynamic-page/:num', + destination: '/a-dynamic-page/:num' + }, + { + source: '/rewrite-to-a-public-file', + destination: '/favicon.ico' + }, + { + source: '/rewrite-to-a-404', + destination: '/no-such-page' + } + ], + fallback: [ + { + source: '/rewrite-external/:path*', + destination: 'https://old.example.com/:path*' + } + ] + } + } +} + +module.exports = nextConfig diff --git a/test/instrumentation/modules/next/a-nextjs-app/package-lock.json b/test/instrumentation/modules/next/a-nextjs-app/package-lock.json new file mode 100644 index 0000000000..2cfe676a7e --- /dev/null +++ b/test/instrumentation/modules/next/a-nextjs-app/package-lock.json @@ -0,0 +1,638 @@ +{ + "name": "a-nextjs-app", + "version": "1.0.0", + "lockfileVersion": 2, + "requires": true, + "packages": { + "": { + "name": "a-nextjs-app", + "version": "1.0.0", + "license": "BSD-2-Clause", + "dependencies": { + "next": "^13.0.0", + "react": "^18.2.0", + "react-dom": "^18.2.0" + } + }, + "node_modules/@next/env": { + "version": "13.0.0", + "resolved": "https://registry.npmjs.org/@next/env/-/env-13.0.0.tgz", + "integrity": "sha512-65v9BVuah2Mplohm4+efsKEnoEuhmlGm8B2w6vD1geeEP2wXtlSJCvR/cCRJ3fD8wzCQBV41VcMBQeYET6MRkg==" + }, + "node_modules/@next/swc-android-arm-eabi": { + "version": "13.0.0", + "resolved": "https://registry.npmjs.org/@next/swc-android-arm-eabi/-/swc-android-arm-eabi-13.0.0.tgz", + "integrity": "sha512-+DUQkYF93gxFjWY+CYWE1QDX6gTgnUiWf+W4UqZjM1Jcef8U97fS6xYh+i+8rH4MM0AXHm7OSakvfOMzmjU6VA==", + "cpu": [ + "arm" + ], + "optional": true, + "os": [ + "android" + ], + "engines": { + "node": ">= 10" + } + }, + "node_modules/@next/swc-android-arm64": { + "version": "13.0.0", + "resolved": "https://registry.npmjs.org/@next/swc-android-arm64/-/swc-android-arm64-13.0.0.tgz", + "integrity": "sha512-RW9Uy3bMSc0zVGCa11klFuwfP/jdcdkhdruqnrJ7v+7XHm6OFKkSRzX6ee7yGR1rdDZvTnP4GZSRSpzjLv/N0g==", + "cpu": [ + "arm64" + ], + "optional": true, + "os": [ + "android" + ], + "engines": { + "node": ">= 10" + } + }, + "node_modules/@next/swc-darwin-arm64": { + "version": "13.0.0", + "resolved": "https://registry.npmjs.org/@next/swc-darwin-arm64/-/swc-darwin-arm64-13.0.0.tgz", + "integrity": "sha512-APA26nps1j4qyhOIzkclW/OmgotVHj1jBxebSpMCPw2rXfiNvKNY9FA0TcuwPmUCNqaTnm703h6oW4dvp73A4Q==", + "cpu": [ + "arm64" + ], + "optional": true, + "os": [ + "darwin" + ], + "engines": { + "node": ">= 10" + } + }, + "node_modules/@next/swc-darwin-x64": { + "version": "13.0.0", + "resolved": "https://registry.npmjs.org/@next/swc-darwin-x64/-/swc-darwin-x64-13.0.0.tgz", + "integrity": "sha512-qsUhUdoFuRJiaJ7LnvTQ6GZv1QnMDcRXCIjxaN0FNVXwrjkq++U7KjBUaxXkRzLV4C7u0NHLNOp0iZwNNE7ypw==", + "cpu": [ + "x64" + ], + "optional": true, + "os": [ + "darwin" + ], + "engines": { + "node": ">= 10" + } + }, + "node_modules/@next/swc-freebsd-x64": { + "version": "13.0.0", + "resolved": "https://registry.npmjs.org/@next/swc-freebsd-x64/-/swc-freebsd-x64-13.0.0.tgz", + "integrity": "sha512-sCdyCbboS7CwdnevKH9J6hkJI76LUw1jVWt4eV7kISuLiPba3JmehZSWm80oa4ADChRVAwzhLAo2zJaYRrInbg==", + "cpu": [ + "x64" + ], + "optional": true, + "os": [ + "freebsd" + ], + "engines": { + "node": ">= 10" + } + }, + "node_modules/@next/swc-linux-arm-gnueabihf": { + "version": "13.0.0", + "resolved": "https://registry.npmjs.org/@next/swc-linux-arm-gnueabihf/-/swc-linux-arm-gnueabihf-13.0.0.tgz", + "integrity": "sha512-/X/VxfFA41C9jrEv+sUsPLQ5vbDPVIgG0CJrzKvrcc+b+4zIgPgtfsaWq9ockjHFQi3ycvlZK4TALOXO8ovQ6Q==", + "cpu": [ + "arm" + ], + "optional": true, + "os": [ + "linux" + ], + "engines": { + "node": ">= 10" + } + }, + "node_modules/@next/swc-linux-arm64-gnu": { + "version": "13.0.0", + "resolved": "https://registry.npmjs.org/@next/swc-linux-arm64-gnu/-/swc-linux-arm64-gnu-13.0.0.tgz", + "integrity": "sha512-x6Oxr1GIi0ZtNiT6jbw+JVcbEi3UQgF7mMmkrgfL4mfchOwXtWSHKTSSPnwoJWJfXYa0Vy1n8NElWNTGAqoWFw==", + "cpu": [ + "arm64" + ], + "optional": true, + "os": [ + "linux" + ], + "engines": { + "node": ">= 10" + } + }, + "node_modules/@next/swc-linux-arm64-musl": { + "version": "13.0.0", + "resolved": "https://registry.npmjs.org/@next/swc-linux-arm64-musl/-/swc-linux-arm64-musl-13.0.0.tgz", + "integrity": "sha512-SnMH9ngI+ipGh3kqQ8+mDtWunirwmhQnQeZkEq9e/9Xsgjf04OetqrqRHKM1HmJtG2qMUJbyXFJ0F81TPuT+3g==", + "cpu": [ + "arm64" + ], + "optional": true, + "os": [ + "linux" + ], + "engines": { + "node": ">= 10" + } + }, + "node_modules/@next/swc-linux-x64-gnu": { + "version": "13.0.0", + "resolved": "https://registry.npmjs.org/@next/swc-linux-x64-gnu/-/swc-linux-x64-gnu-13.0.0.tgz", + "integrity": "sha512-VSQwTX9EmdbotArtA1J67X8964oQfe0xHb32x4tu+JqTR+wOHyG6wGzPMdXH2oKAp6rdd7BzqxUXXf0J+ypHlw==", + "cpu": [ + "x64" + ], + "optional": true, + "os": [ + "linux" + ], + "engines": { + "node": ">= 10" + } + }, + "node_modules/@next/swc-linux-x64-musl": { + "version": "13.0.0", + "resolved": "https://registry.npmjs.org/@next/swc-linux-x64-musl/-/swc-linux-x64-musl-13.0.0.tgz", + "integrity": "sha512-xBCP0nnpO0q4tsytXkvIwWFINtbFRyVY5gxa1zB0vlFtqYR9lNhrOwH3CBrks3kkeaePOXd611+8sjdUtrLnXA==", + "cpu": [ + "x64" + ], + "optional": true, + "os": [ + "linux" + ], + "engines": { + "node": ">= 10" + } + }, + "node_modules/@next/swc-win32-arm64-msvc": { + "version": "13.0.0", + "resolved": "https://registry.npmjs.org/@next/swc-win32-arm64-msvc/-/swc-win32-arm64-msvc-13.0.0.tgz", + "integrity": "sha512-NutwDafqhGxqPj/eiUixJq9ImS/0sgx6gqlD7jRndCvQ2Q8AvDdu1+xKcGWGNnhcDsNM/n1avf1e62OG1GaqJg==", + "cpu": [ + "arm64" + ], + "optional": true, + "os": [ + "win32" + ], + "engines": { + "node": ">= 10" + } + }, + "node_modules/@next/swc-win32-ia32-msvc": { + "version": "13.0.0", + "resolved": "https://registry.npmjs.org/@next/swc-win32-ia32-msvc/-/swc-win32-ia32-msvc-13.0.0.tgz", + "integrity": "sha512-zNaxaO+Kl/xNz02E9QlcVz0pT4MjkXGDLb25qxtAzyJL15aU0+VjjbIZAYWctG59dvggNIUNDWgoBeVTKB9xLg==", + "cpu": [ + "ia32" + ], + "optional": true, + "os": [ + "win32" + ], + "engines": { + "node": ">= 10" + } + }, + "node_modules/@next/swc-win32-x64-msvc": { + "version": "13.0.0", + "resolved": "https://registry.npmjs.org/@next/swc-win32-x64-msvc/-/swc-win32-x64-msvc-13.0.0.tgz", + "integrity": "sha512-FFOGGWwTCRMu9W7MF496Urefxtuo2lttxF1vwS+1rIRsKvuLrWhVaVTj3T8sf2EBL6gtJbmh4TYlizS+obnGKA==", + "cpu": [ + "x64" + ], + "optional": true, + "os": [ + "win32" + ], + "engines": { + "node": ">= 10" + } + }, + "node_modules/@swc/helpers": { + "version": "0.4.11", + "resolved": "https://registry.npmjs.org/@swc/helpers/-/helpers-0.4.11.tgz", + "integrity": "sha512-rEUrBSGIoSFuYxwBYtlUFMlE2CwGhmW+w9355/5oduSw8e5h2+Tj4UrAGNNgP9915++wj5vkQo0UuOBqOAq4nw==", + "dependencies": { + "tslib": "^2.4.0" + } + }, + "node_modules/caniuse-lite": { + "version": "1.0.30001426", + "resolved": "https://registry.npmjs.org/caniuse-lite/-/caniuse-lite-1.0.30001426.tgz", + "integrity": "sha512-n7cosrHLl8AWt0wwZw/PJZgUg3lV0gk9LMI7ikGJwhyhgsd2Nb65vKvmSexCqq/J7rbH3mFG6yZZiPR5dLPW5A==", + "funding": [ + { + "type": "opencollective", + "url": "https://opencollective.com/browserslist" + }, + { + "type": "tidelift", + "url": "https://tidelift.com/funding/github/npm/caniuse-lite" + } + ] + }, + "node_modules/client-only": { + "version": "0.0.1", + "resolved": "https://registry.npmjs.org/client-only/-/client-only-0.0.1.tgz", + "integrity": "sha512-IV3Ou0jSMzZrd3pZ48nLkT9DA7Ag1pnPzaiQhpW7c3RbcqqzvzzVu+L8gfqMp/8IM2MQtSiqaCxrrcfu8I8rMA==" + }, + "node_modules/js-tokens": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/js-tokens/-/js-tokens-4.0.0.tgz", + "integrity": "sha512-RdJUflcE3cUzKiMqQgsCu06FPu9UdIJO0beYbPhHN4k6apgJtifcoCtT9bcxOpYBtpD2kCM6Sbzg4CausW/PKQ==" + }, + "node_modules/loose-envify": { + "version": "1.4.0", + "resolved": "https://registry.npmjs.org/loose-envify/-/loose-envify-1.4.0.tgz", + "integrity": "sha512-lyuxPGr/Wfhrlem2CL/UcnUc1zcqKAImBDzukY7Y5F/yQiNdko6+fRLevlw1HgMySw7f611UIY408EtxRSoK3Q==", + "dependencies": { + "js-tokens": "^3.0.0 || ^4.0.0" + }, + "bin": { + "loose-envify": "cli.js" + } + }, + "node_modules/nanoid": { + "version": "3.3.4", + "resolved": "https://registry.npmjs.org/nanoid/-/nanoid-3.3.4.tgz", + "integrity": "sha512-MqBkQh/OHTS2egovRtLk45wEyNXwF+cokD+1YPf9u5VfJiRdAiRwB2froX5Co9Rh20xs4siNPm8naNotSD6RBw==", + "bin": { + "nanoid": "bin/nanoid.cjs" + }, + "engines": { + "node": "^10 || ^12 || ^13.7 || ^14 || >=15.0.1" + } + }, + "node_modules/next": { + "version": "13.0.0", + "resolved": "https://registry.npmjs.org/next/-/next-13.0.0.tgz", + "integrity": "sha512-puH1WGM6rGeFOoFdXXYfUxN9Sgi4LMytCV5HkQJvVUOhHfC1DoVqOfvzaEteyp6P04IW+gbtK2Q9pInVSrltPA==", + "dependencies": { + "@next/env": "13.0.0", + "@swc/helpers": "0.4.11", + "caniuse-lite": "^1.0.30001406", + "postcss": "8.4.14", + "styled-jsx": "5.1.0", + "use-sync-external-store": "1.2.0" + }, + "bin": { + "next": "dist/bin/next" + }, + "engines": { + "node": ">=14.6.0" + }, + "optionalDependencies": { + "@next/swc-android-arm-eabi": "13.0.0", + "@next/swc-android-arm64": "13.0.0", + "@next/swc-darwin-arm64": "13.0.0", + "@next/swc-darwin-x64": "13.0.0", + "@next/swc-freebsd-x64": "13.0.0", + "@next/swc-linux-arm-gnueabihf": "13.0.0", + "@next/swc-linux-arm64-gnu": "13.0.0", + "@next/swc-linux-arm64-musl": "13.0.0", + "@next/swc-linux-x64-gnu": "13.0.0", + "@next/swc-linux-x64-musl": "13.0.0", + "@next/swc-win32-arm64-msvc": "13.0.0", + "@next/swc-win32-ia32-msvc": "13.0.0", + "@next/swc-win32-x64-msvc": "13.0.0" + }, + "peerDependencies": { + "fibers": ">= 3.1.0", + "node-sass": "^6.0.0 || ^7.0.0", + "react": "^18.0.0-0", + "react-dom": "^18.0.0-0", + "sass": "^1.3.0" + }, + "peerDependenciesMeta": { + "fibers": { + "optional": true + }, + "node-sass": { + "optional": true + }, + "sass": { + "optional": true + } + } + }, + "node_modules/picocolors": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/picocolors/-/picocolors-1.0.0.tgz", + "integrity": "sha512-1fygroTLlHu66zi26VoTDv8yRgm0Fccecssto+MhsZ0D/DGW2sm8E8AjW7NU5VVTRt5GxbeZ5qBuJr+HyLYkjQ==" + }, + "node_modules/postcss": { + "version": "8.4.14", + "resolved": "https://registry.npmjs.org/postcss/-/postcss-8.4.14.tgz", + "integrity": "sha512-E398TUmfAYFPBSdzgeieK2Y1+1cpdxJx8yXbK/m57nRhKSmk1GB2tO4lbLBtlkfPQTDKfe4Xqv1ASWPpayPEig==", + "funding": [ + { + "type": "opencollective", + "url": "https://opencollective.com/postcss/" + }, + { + "type": "tidelift", + "url": "https://tidelift.com/funding/github/npm/postcss" + } + ], + "dependencies": { + "nanoid": "^3.3.4", + "picocolors": "^1.0.0", + "source-map-js": "^1.0.2" + }, + "engines": { + "node": "^10 || ^12 || >=14" + } + }, + "node_modules/react": { + "version": "18.2.0", + "resolved": "https://registry.npmjs.org/react/-/react-18.2.0.tgz", + "integrity": "sha512-/3IjMdb2L9QbBdWiW5e3P2/npwMBaU9mHCSCUzNln0ZCYbcfTsGbTJrU/kGemdH2IWmB2ioZ+zkxtmq6g09fGQ==", + "dependencies": { + "loose-envify": "^1.1.0" + }, + "engines": { + "node": ">=0.10.0" + } + }, + "node_modules/react-dom": { + "version": "18.2.0", + "resolved": "https://registry.npmjs.org/react-dom/-/react-dom-18.2.0.tgz", + "integrity": "sha512-6IMTriUmvsjHUjNtEDudZfuDQUoWXVxKHhlEGSk81n4YFS+r/Kl99wXiwlVXtPBtJenozv2P+hxDsw9eA7Xo6g==", + "dependencies": { + "loose-envify": "^1.1.0", + "scheduler": "^0.23.0" + }, + "peerDependencies": { + "react": "^18.2.0" + } + }, + "node_modules/scheduler": { + "version": "0.23.0", + "resolved": "https://registry.npmjs.org/scheduler/-/scheduler-0.23.0.tgz", + "integrity": "sha512-CtuThmgHNg7zIZWAXi3AsyIzA3n4xx7aNyjwC2VJldO2LMVDhFK+63xGqq6CsJH4rTAt6/M+N4GhZiDYPx9eUw==", + "dependencies": { + "loose-envify": "^1.1.0" + } + }, + "node_modules/source-map-js": { + "version": "1.0.2", + "resolved": "https://registry.npmjs.org/source-map-js/-/source-map-js-1.0.2.tgz", + "integrity": "sha512-R0XvVJ9WusLiqTCEiGCmICCMplcCkIwwR11mOSD9CR5u+IXYdiseeEuXCVAjS54zqwkLcPNnmU4OeJ6tUrWhDw==", + "engines": { + "node": ">=0.10.0" + } + }, + "node_modules/styled-jsx": { + "version": "5.1.0", + "resolved": "https://registry.npmjs.org/styled-jsx/-/styled-jsx-5.1.0.tgz", + "integrity": "sha512-/iHaRJt9U7T+5tp6TRelLnqBqiaIT0HsO0+vgyj8hK2KUk7aejFqRrumqPUlAqDwAj8IbS/1hk3IhBAAK/FCUQ==", + "dependencies": { + "client-only": "0.0.1" + }, + "engines": { + "node": ">= 12.0.0" + }, + "peerDependencies": { + "react": ">= 16.8.0 || 17.x.x || ^18.0.0-0" + }, + "peerDependenciesMeta": { + "@babel/core": { + "optional": true + }, + "babel-plugin-macros": { + "optional": true + } + } + }, + "node_modules/tslib": { + "version": "2.4.0", + "resolved": "https://registry.npmjs.org/tslib/-/tslib-2.4.0.tgz", + "integrity": "sha512-d6xOpEDfsi2CZVlPQzGeux8XMwLT9hssAsaPYExaQMuYskwb+x1x7J371tWlbBdWHroy99KnVB6qIkUbs5X3UQ==" + }, + "node_modules/use-sync-external-store": { + "version": "1.2.0", + "resolved": "https://registry.npmjs.org/use-sync-external-store/-/use-sync-external-store-1.2.0.tgz", + "integrity": "sha512-eEgnFxGQ1Ife9bzYs6VLi8/4X6CObHMw9Qr9tPY43iKwsPw8xE8+EFsf/2cFZ5S3esXgpWgtSCtLNS41F+sKPA==", + "peerDependencies": { + "react": "^16.8.0 || ^17.0.0 || ^18.0.0" + } + } + }, + "dependencies": { + "@next/env": { + "version": "13.0.0", + "resolved": "https://registry.npmjs.org/@next/env/-/env-13.0.0.tgz", + "integrity": "sha512-65v9BVuah2Mplohm4+efsKEnoEuhmlGm8B2w6vD1geeEP2wXtlSJCvR/cCRJ3fD8wzCQBV41VcMBQeYET6MRkg==" + }, + "@next/swc-android-arm-eabi": { + "version": "13.0.0", + "resolved": "https://registry.npmjs.org/@next/swc-android-arm-eabi/-/swc-android-arm-eabi-13.0.0.tgz", + "integrity": "sha512-+DUQkYF93gxFjWY+CYWE1QDX6gTgnUiWf+W4UqZjM1Jcef8U97fS6xYh+i+8rH4MM0AXHm7OSakvfOMzmjU6VA==", + "optional": true + }, + "@next/swc-android-arm64": { + "version": "13.0.0", + "resolved": "https://registry.npmjs.org/@next/swc-android-arm64/-/swc-android-arm64-13.0.0.tgz", + "integrity": "sha512-RW9Uy3bMSc0zVGCa11klFuwfP/jdcdkhdruqnrJ7v+7XHm6OFKkSRzX6ee7yGR1rdDZvTnP4GZSRSpzjLv/N0g==", + "optional": true + }, + "@next/swc-darwin-arm64": { + "version": "13.0.0", + "resolved": "https://registry.npmjs.org/@next/swc-darwin-arm64/-/swc-darwin-arm64-13.0.0.tgz", + "integrity": "sha512-APA26nps1j4qyhOIzkclW/OmgotVHj1jBxebSpMCPw2rXfiNvKNY9FA0TcuwPmUCNqaTnm703h6oW4dvp73A4Q==", + "optional": true + }, + "@next/swc-darwin-x64": { + "version": "13.0.0", + "resolved": "https://registry.npmjs.org/@next/swc-darwin-x64/-/swc-darwin-x64-13.0.0.tgz", + "integrity": "sha512-qsUhUdoFuRJiaJ7LnvTQ6GZv1QnMDcRXCIjxaN0FNVXwrjkq++U7KjBUaxXkRzLV4C7u0NHLNOp0iZwNNE7ypw==", + "optional": true + }, + "@next/swc-freebsd-x64": { + "version": "13.0.0", + "resolved": "https://registry.npmjs.org/@next/swc-freebsd-x64/-/swc-freebsd-x64-13.0.0.tgz", + "integrity": "sha512-sCdyCbboS7CwdnevKH9J6hkJI76LUw1jVWt4eV7kISuLiPba3JmehZSWm80oa4ADChRVAwzhLAo2zJaYRrInbg==", + "optional": true + }, + "@next/swc-linux-arm-gnueabihf": { + "version": "13.0.0", + "resolved": "https://registry.npmjs.org/@next/swc-linux-arm-gnueabihf/-/swc-linux-arm-gnueabihf-13.0.0.tgz", + "integrity": "sha512-/X/VxfFA41C9jrEv+sUsPLQ5vbDPVIgG0CJrzKvrcc+b+4zIgPgtfsaWq9ockjHFQi3ycvlZK4TALOXO8ovQ6Q==", + "optional": true + }, + "@next/swc-linux-arm64-gnu": { + "version": "13.0.0", + "resolved": "https://registry.npmjs.org/@next/swc-linux-arm64-gnu/-/swc-linux-arm64-gnu-13.0.0.tgz", + "integrity": "sha512-x6Oxr1GIi0ZtNiT6jbw+JVcbEi3UQgF7mMmkrgfL4mfchOwXtWSHKTSSPnwoJWJfXYa0Vy1n8NElWNTGAqoWFw==", + "optional": true + }, + "@next/swc-linux-arm64-musl": { + "version": "13.0.0", + "resolved": "https://registry.npmjs.org/@next/swc-linux-arm64-musl/-/swc-linux-arm64-musl-13.0.0.tgz", + "integrity": "sha512-SnMH9ngI+ipGh3kqQ8+mDtWunirwmhQnQeZkEq9e/9Xsgjf04OetqrqRHKM1HmJtG2qMUJbyXFJ0F81TPuT+3g==", + "optional": true + }, + "@next/swc-linux-x64-gnu": { + "version": "13.0.0", + "resolved": "https://registry.npmjs.org/@next/swc-linux-x64-gnu/-/swc-linux-x64-gnu-13.0.0.tgz", + "integrity": "sha512-VSQwTX9EmdbotArtA1J67X8964oQfe0xHb32x4tu+JqTR+wOHyG6wGzPMdXH2oKAp6rdd7BzqxUXXf0J+ypHlw==", + "optional": true + }, + "@next/swc-linux-x64-musl": { + "version": "13.0.0", + "resolved": "https://registry.npmjs.org/@next/swc-linux-x64-musl/-/swc-linux-x64-musl-13.0.0.tgz", + "integrity": "sha512-xBCP0nnpO0q4tsytXkvIwWFINtbFRyVY5gxa1zB0vlFtqYR9lNhrOwH3CBrks3kkeaePOXd611+8sjdUtrLnXA==", + "optional": true + }, + "@next/swc-win32-arm64-msvc": { + "version": "13.0.0", + "resolved": "https://registry.npmjs.org/@next/swc-win32-arm64-msvc/-/swc-win32-arm64-msvc-13.0.0.tgz", + "integrity": "sha512-NutwDafqhGxqPj/eiUixJq9ImS/0sgx6gqlD7jRndCvQ2Q8AvDdu1+xKcGWGNnhcDsNM/n1avf1e62OG1GaqJg==", + "optional": true + }, + "@next/swc-win32-ia32-msvc": { + "version": "13.0.0", + "resolved": "https://registry.npmjs.org/@next/swc-win32-ia32-msvc/-/swc-win32-ia32-msvc-13.0.0.tgz", + "integrity": "sha512-zNaxaO+Kl/xNz02E9QlcVz0pT4MjkXGDLb25qxtAzyJL15aU0+VjjbIZAYWctG59dvggNIUNDWgoBeVTKB9xLg==", + "optional": true + }, + "@next/swc-win32-x64-msvc": { + "version": "13.0.0", + "resolved": "https://registry.npmjs.org/@next/swc-win32-x64-msvc/-/swc-win32-x64-msvc-13.0.0.tgz", + "integrity": "sha512-FFOGGWwTCRMu9W7MF496Urefxtuo2lttxF1vwS+1rIRsKvuLrWhVaVTj3T8sf2EBL6gtJbmh4TYlizS+obnGKA==", + "optional": true + }, + "@swc/helpers": { + "version": "0.4.11", + "resolved": "https://registry.npmjs.org/@swc/helpers/-/helpers-0.4.11.tgz", + "integrity": "sha512-rEUrBSGIoSFuYxwBYtlUFMlE2CwGhmW+w9355/5oduSw8e5h2+Tj4UrAGNNgP9915++wj5vkQo0UuOBqOAq4nw==", + "requires": { + "tslib": "^2.4.0" + } + }, + "caniuse-lite": { + "version": "1.0.30001426", + "resolved": "https://registry.npmjs.org/caniuse-lite/-/caniuse-lite-1.0.30001426.tgz", + "integrity": "sha512-n7cosrHLl8AWt0wwZw/PJZgUg3lV0gk9LMI7ikGJwhyhgsd2Nb65vKvmSexCqq/J7rbH3mFG6yZZiPR5dLPW5A==" + }, + "client-only": { + "version": "0.0.1", + "resolved": "https://registry.npmjs.org/client-only/-/client-only-0.0.1.tgz", + "integrity": "sha512-IV3Ou0jSMzZrd3pZ48nLkT9DA7Ag1pnPzaiQhpW7c3RbcqqzvzzVu+L8gfqMp/8IM2MQtSiqaCxrrcfu8I8rMA==" + }, + "js-tokens": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/js-tokens/-/js-tokens-4.0.0.tgz", + "integrity": "sha512-RdJUflcE3cUzKiMqQgsCu06FPu9UdIJO0beYbPhHN4k6apgJtifcoCtT9bcxOpYBtpD2kCM6Sbzg4CausW/PKQ==" + }, + "loose-envify": { + "version": "1.4.0", + "resolved": "https://registry.npmjs.org/loose-envify/-/loose-envify-1.4.0.tgz", + "integrity": "sha512-lyuxPGr/Wfhrlem2CL/UcnUc1zcqKAImBDzukY7Y5F/yQiNdko6+fRLevlw1HgMySw7f611UIY408EtxRSoK3Q==", + "requires": { + "js-tokens": "^3.0.0 || ^4.0.0" + } + }, + "nanoid": { + "version": "3.3.4", + "resolved": "https://registry.npmjs.org/nanoid/-/nanoid-3.3.4.tgz", + "integrity": "sha512-MqBkQh/OHTS2egovRtLk45wEyNXwF+cokD+1YPf9u5VfJiRdAiRwB2froX5Co9Rh20xs4siNPm8naNotSD6RBw==" + }, + "next": { + "version": "13.0.0", + "resolved": "https://registry.npmjs.org/next/-/next-13.0.0.tgz", + "integrity": "sha512-puH1WGM6rGeFOoFdXXYfUxN9Sgi4LMytCV5HkQJvVUOhHfC1DoVqOfvzaEteyp6P04IW+gbtK2Q9pInVSrltPA==", + "requires": { + "@next/env": "13.0.0", + "@next/swc-android-arm-eabi": "13.0.0", + "@next/swc-android-arm64": "13.0.0", + "@next/swc-darwin-arm64": "13.0.0", + "@next/swc-darwin-x64": "13.0.0", + "@next/swc-freebsd-x64": "13.0.0", + "@next/swc-linux-arm-gnueabihf": "13.0.0", + "@next/swc-linux-arm64-gnu": "13.0.0", + "@next/swc-linux-arm64-musl": "13.0.0", + "@next/swc-linux-x64-gnu": "13.0.0", + "@next/swc-linux-x64-musl": "13.0.0", + "@next/swc-win32-arm64-msvc": "13.0.0", + "@next/swc-win32-ia32-msvc": "13.0.0", + "@next/swc-win32-x64-msvc": "13.0.0", + "@swc/helpers": "0.4.11", + "caniuse-lite": "^1.0.30001406", + "postcss": "8.4.14", + "styled-jsx": "5.1.0", + "use-sync-external-store": "1.2.0" + } + }, + "picocolors": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/picocolors/-/picocolors-1.0.0.tgz", + "integrity": "sha512-1fygroTLlHu66zi26VoTDv8yRgm0Fccecssto+MhsZ0D/DGW2sm8E8AjW7NU5VVTRt5GxbeZ5qBuJr+HyLYkjQ==" + }, + "postcss": { + "version": "8.4.14", + "resolved": "https://registry.npmjs.org/postcss/-/postcss-8.4.14.tgz", + "integrity": "sha512-E398TUmfAYFPBSdzgeieK2Y1+1cpdxJx8yXbK/m57nRhKSmk1GB2tO4lbLBtlkfPQTDKfe4Xqv1ASWPpayPEig==", + "requires": { + "nanoid": "^3.3.4", + "picocolors": "^1.0.0", + "source-map-js": "^1.0.2" + } + }, + "react": { + "version": "18.2.0", + "resolved": "https://registry.npmjs.org/react/-/react-18.2.0.tgz", + "integrity": "sha512-/3IjMdb2L9QbBdWiW5e3P2/npwMBaU9mHCSCUzNln0ZCYbcfTsGbTJrU/kGemdH2IWmB2ioZ+zkxtmq6g09fGQ==", + "requires": { + "loose-envify": "^1.1.0" + } + }, + "react-dom": { + "version": "18.2.0", + "resolved": "https://registry.npmjs.org/react-dom/-/react-dom-18.2.0.tgz", + "integrity": "sha512-6IMTriUmvsjHUjNtEDudZfuDQUoWXVxKHhlEGSk81n4YFS+r/Kl99wXiwlVXtPBtJenozv2P+hxDsw9eA7Xo6g==", + "requires": { + "loose-envify": "^1.1.0", + "scheduler": "^0.23.0" + } + }, + "scheduler": { + "version": "0.23.0", + "resolved": "https://registry.npmjs.org/scheduler/-/scheduler-0.23.0.tgz", + "integrity": "sha512-CtuThmgHNg7zIZWAXi3AsyIzA3n4xx7aNyjwC2VJldO2LMVDhFK+63xGqq6CsJH4rTAt6/M+N4GhZiDYPx9eUw==", + "requires": { + "loose-envify": "^1.1.0" + } + }, + "source-map-js": { + "version": "1.0.2", + "resolved": "https://registry.npmjs.org/source-map-js/-/source-map-js-1.0.2.tgz", + "integrity": "sha512-R0XvVJ9WusLiqTCEiGCmICCMplcCkIwwR11mOSD9CR5u+IXYdiseeEuXCVAjS54zqwkLcPNnmU4OeJ6tUrWhDw==" + }, + "styled-jsx": { + "version": "5.1.0", + "resolved": "https://registry.npmjs.org/styled-jsx/-/styled-jsx-5.1.0.tgz", + "integrity": "sha512-/iHaRJt9U7T+5tp6TRelLnqBqiaIT0HsO0+vgyj8hK2KUk7aejFqRrumqPUlAqDwAj8IbS/1hk3IhBAAK/FCUQ==", + "requires": { + "client-only": "0.0.1" + } + }, + "tslib": { + "version": "2.4.0", + "resolved": "https://registry.npmjs.org/tslib/-/tslib-2.4.0.tgz", + "integrity": "sha512-d6xOpEDfsi2CZVlPQzGeux8XMwLT9hssAsaPYExaQMuYskwb+x1x7J371tWlbBdWHroy99KnVB6qIkUbs5X3UQ==" + }, + "use-sync-external-store": { + "version": "1.2.0", + "resolved": "https://registry.npmjs.org/use-sync-external-store/-/use-sync-external-store-1.2.0.tgz", + "integrity": "sha512-eEgnFxGQ1Ife9bzYs6VLi8/4X6CObHMw9Qr9tPY43iKwsPw8xE8+EFsf/2cFZ5S3esXgpWgtSCtLNS41F+sKPA==", + "requires": {} + } + } +} diff --git a/test/instrumentation/modules/next/a-nextjs-app/package.json b/test/instrumentation/modules/next/a-nextjs-app/package.json new file mode 100644 index 0000000000..df3fe501e9 --- /dev/null +++ b/test/instrumentation/modules/next/a-nextjs-app/package.json @@ -0,0 +1,18 @@ +{ + "name": "a-nextjs-app", + "version": "1.0.0", + "description": "a Next.js app to test elastic-apm-node instrumentation", + "private": true, + "scripts": { + "dev": "NODE_OPTIONS='-r ../../../../../start-next.js' next dev", + "build": "next build", + "start": "NODE_OPTIONS='-r ../../../../../start-next.js' next start" + }, + "keywords": [], + "license": "BSD-2-Clause", + "dependencies": { + "next": "^13.0.0", + "react": "^18.2.0", + "react-dom": "^18.2.0" + } +} diff --git a/test/instrumentation/modules/next/a-nextjs-app/pages/a-dynamic-page/[num].js b/test/instrumentation/modules/next/a-nextjs-app/pages/a-dynamic-page/[num].js new file mode 100644 index 0000000000..f6a6bb7f32 --- /dev/null +++ b/test/instrumentation/modules/next/a-nextjs-app/pages/a-dynamic-page/[num].js @@ -0,0 +1,45 @@ +/* + * Copyright Elasticsearch B.V. and other contributors where applicable. + * Licensed under the BSD 2-Clause License; you may not use this file except in + * compliance with the BSD 2-Clause License. + */ + +import { useRouter } from 'next/router' +import Header from '../../components/Header' + +// Run at build time to determine a set of dynamic paths to prerender at build time. +// https://nextjs.org/docs/basic-features/data-fetching/get-static-paths +export async function getStaticPaths () { + return { + paths: [ + { params: { num: '41' } }, + { params: { num: '42' } }, + { params: { num: '43' } } + ], + fallback: true // false, true, or 'blocking' + } +} + +export async function getStaticProps ({ params }) { + return { + props: { + doubleThat: Number(params.num) * 2 + } + } +} + +const ADynamicPage = ({ doubleThat }) => { + const router = useRouter() + const { num } = router.query + + return ( + <> +
+
+
This is ADynamicPage {num} - doubleThat is {doubleThat}
+
+ + ) +} + +export default ADynamicPage diff --git a/test/instrumentation/modules/next/a-nextjs-app/pages/a-page.js b/test/instrumentation/modules/next/a-nextjs-app/pages/a-page.js new file mode 100644 index 0000000000..b7999ac53a --- /dev/null +++ b/test/instrumentation/modules/next/a-nextjs-app/pages/a-page.js @@ -0,0 +1,35 @@ +/* + * Copyright Elasticsearch B.V. and other contributors where applicable. + * Licensed under the BSD 2-Clause License; you may not use this file except in + * compliance with the BSD 2-Clause License. + */ + +// A static page. + +import Image from 'next/image' +import Header from '../components/Header' + +import img from '../public/elastic-logo.png' + +// Runs at build time. +export async function getStaticProps () { + return { + props: { + buildTime: Date.now() + } + } +} + +function APage ({ buildTime }) { + return ( + <> +
+
+
This is APage (built at {new Date(buildTime).toISOString()})
+ Elastic logo +
+ + ) +} + +export default APage diff --git a/test/instrumentation/modules/next/a-nextjs-app/pages/a-throw-in-getServerSideProps.js b/test/instrumentation/modules/next/a-nextjs-app/pages/a-throw-in-getServerSideProps.js new file mode 100644 index 0000000000..bc360406d3 --- /dev/null +++ b/test/instrumentation/modules/next/a-nextjs-app/pages/a-throw-in-getServerSideProps.js @@ -0,0 +1,28 @@ +/* + * Copyright Elasticsearch B.V. and other contributors where applicable. + * Licensed under the BSD 2-Clause License; you may not use this file except in + * compliance with the BSD 2-Clause License. + */ + +// A page that throws in `getServerSideProps`. +// https://nextjs.org/docs/basic-features/data-fetching/get-server-side-props#does-getserversideprops-render-an-error-page + +import Header from '../components/Header' + +// Gets called on every request. +export async function getServerSideProps () { + throw new Error('thrown error in getServerSideProps') +} + +function AThrowInGetServerSideProps () { + return ( + <> +
+
+
This is AThrowInGetServerSideProps.
+
+ + ) +} + +export default AThrowInGetServerSideProps diff --git a/test/instrumentation/modules/next/a-nextjs-app/pages/a-throw-in-page-handler.js b/test/instrumentation/modules/next/a-nextjs-app/pages/a-throw-in-page-handler.js new file mode 100644 index 0000000000..cf51456cf7 --- /dev/null +++ b/test/instrumentation/modules/next/a-nextjs-app/pages/a-throw-in-page-handler.js @@ -0,0 +1,25 @@ +/* + * Copyright Elasticsearch B.V. and other contributors where applicable. + * Licensed under the BSD 2-Clause License; you may not use this file except in + * compliance with the BSD 2-Clause License. + */ + +// Gets called on every request. +export async function getServerSideProps () { + return { + props: { + currTime: Date.now() + } + } +} + +function AThrowInPageHandler ({ currTime }) { + // If this is called from a browser-side click of a , e.g. as on the + // index.js page, then this function is executed client-side. If called + // via separately visiting http://localhost:3000/a-throw-in-page-handler + // or via `curl -i ...`, then this is executed server-side. Only in the + // latter case will the Node.js APM agent capture an error, of course. + throw new Error('throw in page handler') +} + +export default AThrowInPageHandler diff --git a/test/instrumentation/modules/next/a-nextjs-app/pages/an-ssr-page.js b/test/instrumentation/modules/next/a-nextjs-app/pages/an-ssr-page.js new file mode 100644 index 0000000000..ffdf2ed410 --- /dev/null +++ b/test/instrumentation/modules/next/a-nextjs-app/pages/an-ssr-page.js @@ -0,0 +1,31 @@ +/* + * Copyright Elasticsearch B.V. and other contributors where applicable. + * Licensed under the BSD 2-Clause License; you may not use this file except in + * compliance with the BSD 2-Clause License. + */ + +// A server-side rendered page. + +import Header from '../components/Header' + +// Gets called on every request. +export async function getServerSideProps () { + return { + props: { + currTime: Date.now() + } + } +} + +function AnSSRPage ({ currTime }) { + return ( + <> +
+
+
This is AnSSRPage (currTime is {new Date(currTime).toISOString()})
+
+ + ) +} + +export default AnSSRPage diff --git a/test/instrumentation/modules/next/a-nextjs-app/pages/api/a-dynamic-api-endpoint/[num].js b/test/instrumentation/modules/next/a-nextjs-app/pages/api/a-dynamic-api-endpoint/[num].js new file mode 100644 index 0000000000..2884ae9104 --- /dev/null +++ b/test/instrumentation/modules/next/a-nextjs-app/pages/api/a-dynamic-api-endpoint/[num].js @@ -0,0 +1,26 @@ +/* + * Copyright Elasticsearch B.V. and other contributors where applicable. + * Licensed under the BSD 2-Clause License; you may not use this file except in + * compliance with the BSD 2-Clause License. + */ + +// A dynamic API endpoint. + +// Always executed server-side. +export default function aDynamicApiEndpoint (req, res) { + const { num } = req.query + const n = Number(num) + if (isNaN(n)) { + res.status(400).json({ + num, + error: 'num is not a Number' + }) + } else { + res.status(200).json({ + num, + n, + double: n * 2, + floor: Math.floor(n) + }) + } +} diff --git a/test/instrumentation/modules/next/a-nextjs-app/pages/api/an-api-endpoint-that-throws.js b/test/instrumentation/modules/next/a-nextjs-app/pages/api/an-api-endpoint-that-throws.js new file mode 100644 index 0000000000..96403cc64f --- /dev/null +++ b/test/instrumentation/modules/next/a-nextjs-app/pages/api/an-api-endpoint-that-throws.js @@ -0,0 +1,12 @@ +/* + * Copyright Elasticsearch B.V. and other contributors where applicable. + * Licensed under the BSD 2-Clause License; you may not use this file except in + * compliance with the BSD 2-Clause License. + */ + +// An API endpoint whose handler throws, to test error handling. + +// Always executed server-side. +export default function anApiEndpointThatThrows (req, res) { + throw new Error('An error thrown in anApiEndpointThatThrows handler') +} diff --git a/test/instrumentation/modules/next/a-nextjs-app/pages/api/an-api-endpoint.js b/test/instrumentation/modules/next/a-nextjs-app/pages/api/an-api-endpoint.js new file mode 100644 index 0000000000..1d655ed59a --- /dev/null +++ b/test/instrumentation/modules/next/a-nextjs-app/pages/api/an-api-endpoint.js @@ -0,0 +1,12 @@ +/* + * Copyright Elasticsearch B.V. and other contributors where applicable. + * Licensed under the BSD 2-Clause License; you may not use this file except in + * compliance with the BSD 2-Clause License. + */ + +// An API endpoint. + +// Always executed server-side. +export default function anApiEndpoint (req, res) { + res.status(200).json({ ping: 'pong' }) +} diff --git a/test/instrumentation/modules/next/a-nextjs-app/pages/index.js b/test/instrumentation/modules/next/a-nextjs-app/pages/index.js new file mode 100644 index 0000000000..3db50aaf52 --- /dev/null +++ b/test/instrumentation/modules/next/a-nextjs-app/pages/index.js @@ -0,0 +1,76 @@ +/* + * Copyright Elasticsearch B.V. and other contributors where applicable. + * Licensed under the BSD 2-Clause License; you may not use this file except in + * compliance with the BSD 2-Clause License. + */ + +import Link from 'next/link' +import Header from '../components/Header' + +function IndexPage () { + return ( + <> +
+
+
Welcome to A-Next.js-App! This is IndexPage.
+
    +
  • + + Go to APage (it is static in a prod build because it only implements getStaticProps) + +
    • +
  • + + Go to AnSSRPage (its getServerSideProps is called on the server every time) + +
    • +
  • + + Go to ADynamicPage/42 (it supports other numbers; 41, 42, and 43 are pre-generated) + +
    • + +
  • + + Go to a page that redirects to APage + +
    • +
  • + + Go to a page that rewrites to APage + +
    • + +
  • + + Go to AnApiEndpoint + +
    • +
  • + + Go to ADynamicApiEndpoint/3.14159 + +
    • + +
  • + + Go to AThrowInPageHandler + +
    • +
  • + + Go to AThrowInGetServerSideProps + +
    • +
  • + + Go to AnApiEndpointThatThrows + +
    • +
+
+ + ) +} + +export default IndexPage diff --git a/test/instrumentation/modules/next/a-nextjs-app/public/elastic-logo.png b/test/instrumentation/modules/next/a-nextjs-app/public/elastic-logo.png new file mode 100644 index 0000000000..a3a10778d3 Binary files /dev/null and b/test/instrumentation/modules/next/a-nextjs-app/public/elastic-logo.png differ diff --git a/test/instrumentation/modules/next/a-nextjs-app/public/favicon.ico b/test/instrumentation/modules/next/a-nextjs-app/public/favicon.ico new file mode 100644 index 0000000000..9aa824a103 Binary files /dev/null and b/test/instrumentation/modules/next/a-nextjs-app/public/favicon.ico differ diff --git a/test/instrumentation/modules/next/next.test.js b/test/instrumentation/modules/next/next.test.js new file mode 100644 index 0000000000..c693463a45 --- /dev/null +++ b/test/instrumentation/modules/next/next.test.js @@ -0,0 +1,838 @@ +/* + * Copyright Elasticsearch B.V. and other contributors where applicable. + * Licensed under the BSD 2-Clause License; you may not use this file except in + * compliance with the BSD 2-Clause License. + */ + +'use strict' + +// Test Next.js instrumentation. +// +// This test roughly does the following: +// - Start a MockAPMServer to capture intake requests. +// - `npm ci` to build the "a-nextjs-app" project, if necessary. +// - Test instrumentation when using the Next.js production server. +// - `next build && next start` configured to send to our MockAPMServer. +// - Make every request in `TEST_REQUESTS` to the Next.js app. +// - Stop the Next.js app ("apmsetup.js" will flush the APM agent on SIGTERM). +// - Check all the received APM trace data matches the expected values in +// `TEST_REQUESTS`. +// - Test instrumentation when using the Next.js dev server. +// - `next dev` +// - (Same as above.) + +const assert = require('assert') +const { exec, spawn } = require('child_process') +const fs = require('fs') +const http = require('http') +const os = require('os') +const path = require('path') +const semver = require('semver') +const tape = require('tape') + +const { MockAPMServer } = require('../../../_mock_apm_server') + +if (os.platform() === 'win32') { + // Limitation: currently don't support testing on Windows. + // The current mechanism using shell=true to spawn on Windows *and* attempting + // to use SIGTERM to terminal the Next.js server doesn't work because cmd.exe + // does an interactive prompt. Lovely. + // Terminate batch job (Y/N)? + console.log('# SKIP Next.js testing currently is not supported on windows') + process.exit() +} +if (semver.lt(process.version, '14.6.0')) { + // While some earlier supported versions of Next.js work with node v12, + // next@13 cannot even be imported with node v12 (newer JS syntax is used). + // To simplify, and because node v12 is EOL, we skip any testing with + // node <=14.6.0 (next@13's min supported node version). + console.log(`# SKIP test next with node <14.6.0 (node ${process.version})`) + process.exit() +} +if (process.env.ELASTIC_APM_CONTEXT_MANAGER === 'patch') { + console.log('# SKIP Next.js instrumentation does not work with contextManager="patch"') + process.exit() +} + +const testAppDir = path.join(__dirname, 'a-nextjs-app') + +// Match ANSI escapes (from https://stackoverflow.com/a/29497680/14444044). +const ANSI_RE = /[\u001b\u009b][[()#;?]*(?:[0-9]{1,4}(?:;[0-9]{0,4})*)?[0-9A-ORZcf-nqry=><]/g /* eslint-disable-line no-control-regex */ + +let apmServer +let nextJsVersion // Determined after `npm ci` is run. +let serverUrl + +// TEST_REQUESTS is an array of requests to test against both a prod-server and +// dev-server run of the 'a-nextjs-app' test app. Each entry is: +// +// { +// testName: '', +// // An object with request options, or a `(buildId) => { ... }` that +// // returns request options. +// reqOpts: Object | Function, +// // An object with expectations of the server response. +// expectedRes: { ... }, +// // Make test assertions of the APM events received for the request. +// checkApmEvents: (t, apmEventsForReq) => { ... }, +// } +// +let TEST_REQUESTS = [ + // Redirects. + { + testName: 'trailing slash redirect', + reqOpts: { method: 'GET', path: '/a-page/' }, + expectedRes: { + statusCode: 308, + headers: { location: '/a-page' } + }, + checkApmEvents: (t, apmEventsForReq) => { + t.equal(apmEventsForReq.length, 1) + const trans = apmEventsForReq[0].transaction + t.equal(trans.name, 'Next.js Redirect route /:path+/', 'transaction.name') + t.equal(trans.context.response.status_code, 308, 'transaction.context.response.status_code') + } + }, + { + testName: 'configured (in next.config.js) redirect', + reqOpts: { method: 'GET', path: '/redirect-to-a-page' }, + expectedRes: { + statusCode: 307, + headers: { location: '/a-page' } + }, + checkApmEvents: (t, apmEventsForReq) => { + t.equal(apmEventsForReq.length, 1) + const trans = apmEventsForReq[0].transaction + t.equal(trans.name, 'Next.js Redirect route /redirect-to-a-page', 'transaction.name') + t.equal(trans.context.response.status_code, 307, 'transaction.context.response.status_code') + } + }, + + // Rewrites are configured in "next.config.js". + { + testName: 'rewrite to a page', + reqOpts: { method: 'GET', path: '/rewrite-to-a-page' }, + expectedRes: { + statusCode: 200, + headers: { 'content-type': /text\/html/ }, + // This shows that we got the content from "pages/a-page.js". + body: /This is APage/ + }, + checkApmEvents: (t, apmEventsForReq) => { + t.equal(apmEventsForReq.length, 1) + const trans = apmEventsForReq[0].transaction + t.equal(trans.name, 'Next.js Rewrite route /rewrite-to-a-page -> /a-page', 'transaction.name') + t.equal(trans.context.response.status_code, 200, 'transaction.context.response.status_code') + } + }, + { + testName: 'rewrite to a dynamic page', + reqOpts: { method: 'GET', path: '/rewrite-to-a-dynamic-page/3.14159' }, + expectedRes: { + statusCode: 200, + headers: { 'content-type': /text\/html/ }, + body: /This is ADynamicPage/ + }, + checkApmEvents: (t, apmEventsForReq) => { + t.equal(apmEventsForReq.length, 1) + const trans = apmEventsForReq[0].transaction + t.equal(trans.name, 'Next.js Rewrite route /rewrite-to-a-dynamic-page/:num -> /a-dynamic-page/:num', 'transaction.name') + t.equal(trans.context.response.status_code, 200, 'transaction.context.response.status_code') + } + }, + { + testName: 'rewrite to a /public/... folder file', + reqOpts: { method: 'GET', path: '/rewrite-to-a-public-file' }, + expectedRes: { + statusCode: 200, + headers: { 'content-type': 'image/x-icon' } + }, + checkApmEvents: (t, apmEventsForReq) => { + t.equal(apmEventsForReq.length, 1) + const trans = apmEventsForReq[0].transaction + t.equal(trans.name, 'Next.js Rewrite route /rewrite-to-a-public-file -> /favicon.ico', 'transaction.name') + t.equal(trans.context.response.status_code, 200, 'transaction.context.response.status_code') + } + }, + { + testName: 'rewrite to a 404', + reqOpts: { method: 'GET', path: '/rewrite-to-a-404' }, + expectedRes: { + statusCode: 404 + }, + checkApmEvents: (t, apmEventsForReq) => { + t.equal(apmEventsForReq.length, 1) + const trans = apmEventsForReq[0].transaction + t.equal(trans.name, 'Next.js Rewrite route /rewrite-to-a-404 -> /no-such-page', 'transaction.name') + t.equal(trans.context.response.status_code, 404, 'transaction.context.response.status_code') + } + }, + { + testName: 'rewrite to a external site', + reqOpts: { method: 'GET', path: '/rewrite-external/foo' }, + expectedRes: { + // This is a 500 because the configured `old.example.com` doesn't resolve. + statusCode: 500 + }, + checkApmEvents: (t, apmEventsForReq) => { + t.ok(apmEventsForReq.length === 1 || apmEventsForReq.length === 2, 'expected number of APM events') + const trans = apmEventsForReq[0].transaction + t.equal(trans.name, 'Next.js Rewrite route /rewrite-external/:path* -> https://old.example.com/:path*', 'transaction.name') + t.equal(trans.context.response.status_code, 500, 'transaction.context.response.status_code') + // Limitation: Currently the instrumentation only captures an error with + // the DevServer, because Next.js special cases dev-mode and calls + // `renderErrorToResponse`. To capture the error with NextNodeServer we + // would need to shim `Server.run()` in base-server.js. + if (apmEventsForReq.length === 2) { + const error = apmEventsForReq[1].error + t.equal(trans.trace_id, error.trace_id, 'transaction and error are in same trace') + t.equal(error.parent_id, trans.id, 'error is a child of the transaction') + t.equal(error.transaction.type, 'request', 'error.transaction.type') + t.equal(error.transaction.name, trans.name, 'error.transaction.name') + t.equal(error.exception.message, 'getaddrinfo ENOTFOUND old.example.com', 'error.exception.message') + } + } + }, + + // The different kinds of pages. + { + testName: 'index page', + reqOpts: { method: 'GET', path: '/' }, + expectedRes: { + statusCode: 200, + headers: { 'content-type': /text\/html/ }, + body: /This is IndexPage/ + }, + checkApmEvents: (t, apmEventsForReq) => { + t.equal(apmEventsForReq.length, 1) + const trans = apmEventsForReq[0].transaction + t.equal(trans.name, 'GET /', 'transaction.name') + t.equal(trans.context.response.status_code, 200, 'transaction.context.response.status_code') + } + }, + { + testName: 'a page (Server-Side Generated, SSG)', + reqOpts: { method: 'GET', path: '/a-page' }, + expectedRes: { + statusCode: 200, + headers: { 'content-type': /text\/html/ }, + body: /This is APage/ + }, + checkApmEvents: (t, apmEventsForReq) => { + t.equal(apmEventsForReq.length, 1) + const trans = apmEventsForReq[0].transaction + t.equal(trans.name, 'GET /a-page', 'transaction.name') + t.equal(trans.context.response.status_code, 200, 'transaction.context.response.status_code') + } + }, + { + testName: 'a dynamic page', + reqOpts: { method: 'GET', path: '/a-dynamic-page/42' }, + expectedRes: { + statusCode: 200, + headers: { 'content-type': /text\/html/ }, + body: /This is ADynamicPage/ + }, + checkApmEvents: (t, apmEventsForReq) => { + t.equal(apmEventsForReq.length, 1) + const trans = apmEventsForReq[0].transaction + t.equal(trans.name, 'GET /a-dynamic-page/[num]', 'transaction.name') + t.equal(trans.context.response.status_code, 200, 'transaction.context.response.status_code') + } + }, + { + testName: 'a server-side rendered (SSR) page', + reqOpts: { method: 'GET', path: '/an-ssr-page' }, + expectedRes: { + statusCode: 200, + headers: { 'content-type': /text\/html/ }, + body: /This is AnSSRPage/ + }, + checkApmEvents: (t, apmEventsForReq) => { + t.equal(apmEventsForReq.length, 1) + const trans = apmEventsForReq[0].transaction + t.equal(trans.name, 'GET /an-ssr-page', 'transaction.name') + t.equal(trans.context.response.status_code, 200, 'transaction.context.response.status_code') + } + }, + + // API endpoint pages + { + testName: 'an API endpoint page', + reqOpts: { method: 'GET', path: '/api/an-api-endpoint' }, + expectedRes: { + statusCode: 200, + headers: { 'content-type': /application\/json/ }, + body: '{"ping":"pong"}' + }, + checkApmEvents: (t, apmEventsForReq) => { + t.equal(apmEventsForReq.length, 1) + const trans = apmEventsForReq[0].transaction + t.equal(trans.name, 'GET /api/an-api-endpoint', 'transaction.name') + t.equal(trans.context.response.status_code, 200, 'transaction.context.response.status_code') + } + }, + { + testName: 'a dynamic API endpoint page', + reqOpts: { method: 'GET', path: '/api/a-dynamic-api-endpoint/123' }, + expectedRes: { + statusCode: 200, + headers: { 'content-type': /application\/json/ }, + body: '{"num":"123","n":123,"double":246,"floor":123}' + }, + checkApmEvents: (t, apmEventsForReq) => { + t.equal(apmEventsForReq.length, 1) + const trans = apmEventsForReq[0].transaction + t.equal(trans.name, 'GET /api/a-dynamic-api-endpoint/[num]', 'transaction.name') + t.equal(trans.context.response.status_code, 200, 'transaction.context.response.status_code') + } + }, + + // Various internal Next.js routes. + // The other routes that our instrumentation covers are listed in + // `wrapFsRoute` in "next-server.js" and "next-dev-server.js". + { + testName: '"_next/data catchall" route', + reqOpts: buildId => { + return { method: 'GET', path: `/_next/data/${buildId}/a-page.json` } + }, + expectedRes: { + statusCode: 200, + headers: { 'content-type': /application\/json/ } + }, + checkApmEvents: (t, apmEventsForReq) => { + t.equal(apmEventsForReq.length, 1) + const trans = apmEventsForReq[0].transaction + t.equal(trans.name, 'Next.js _next/data route /a-page', 'transaction.name') + t.equal(trans.context.response.status_code, 200, 'transaction.context.response.status_code') + } + }, + + // Error capture cases + { + testName: 'an API endpoint that throws', + // Limitation: In Next.js commit 6bc7c4d9c (included in 12.0.11-canary.14), + // the `apiResolver()` method that we instrument was moved from + // next/dist/server/api-utils.js to next/dist/server/api-utils/node.js. + // We instrument the latter. To support error capture in API endpoint + // handlers in early versions we'd need to instrument the former path as well. + nextVersionRange: '>=12.0.11-canary.14', + reqOpts: { method: 'GET', path: '/api/an-api-endpoint-that-throws' }, + expectedRes: { + statusCode: 500 + }, + checkApmEvents: (t, apmEventsForReq) => { + t.equal(apmEventsForReq.length, 2) + const trans = apmEventsForReq[0].transaction + const error = apmEventsForReq[1].error + t.equal(trans.name, 'GET /api/an-api-endpoint-that-throws', 'transaction.name') + t.equal(trans.context.response.status_code, 500, 'transaction.context.response.status_code') + t.ok(error, 'captured an APM error') + t.equal(trans.trace_id, error.trace_id, 'transaction and error are in same trace') + t.equal(error.parent_id, trans.id, 'error is a child of the transaction') + t.equal(error.transaction.type, 'request', 'error.transaction.type') + t.equal(error.transaction.name, trans.name, 'error.transaction.name') + t.equal(error.exception.message, 'An error thrown in anApiEndpointThatThrows handler', 'error.exception.message') + } + }, + { + testName: 'a throw in a page handler', + reqOpts: { method: 'GET', path: '/a-throw-in-page-handler' }, + expectedRes: { + statusCode: 500 + }, + checkApmEvents: (t, apmEventsForReq) => { + t.equal(apmEventsForReq.length, 2) + const trans = apmEventsForReq[0].transaction + const error = apmEventsForReq[1].error + t.equal(trans.name, 'GET /a-throw-in-page-handler', 'transaction.name') + t.equal(trans.context.response.status_code, 500, 'transaction.context.response.status_code') + t.ok(error, 'captured an APM error') + t.equal(trans.trace_id, error.trace_id, 'transaction and error are in same trace') + t.equal(error.parent_id, trans.id, 'error is a child of the transaction') + t.equal(error.transaction.type, 'request', 'error.transaction.type') + t.equal(error.transaction.name, trans.name, 'error.transaction.name') + t.equal(error.exception.message, 'throw in page handler', 'error.exception.message') + } + }, + { + testName: 'a throw in getServerSideProps', + // Limitation: There was a bug in v11.1.0 where the error handling flow in + // the *dev* server was incomplete. This was fixed in + // https://github.com/vercel/next.js/pull/28520, included in version + // 11.1.1-canary.18. + nextVersionRange: '>=11.1.1-canary.18', + reqOpts: { method: 'GET', path: '/a-throw-in-getServerSideProps' }, + expectedRes: { + statusCode: 500 + }, + checkApmEvents: (t, apmEventsForReq) => { + t.equal(apmEventsForReq.length, 2) + const trans = apmEventsForReq[0].transaction + const error = apmEventsForReq[1].error + t.equal(trans.name, 'GET /a-throw-in-getServerSideProps', 'transaction.name') + t.equal(trans.context.response.status_code, 500, 'transaction.context.response.status_code') + t.ok(error, 'captured an APM error') + t.equal(trans.trace_id, error.trace_id, 'transaction and error are in same trace') + t.equal(error.parent_id, trans.id, 'error is a child of the transaction') + t.equal(error.transaction.type, 'request', 'error.transaction.type') + t.equal(error.transaction.name, trans.name, 'error.transaction.name') + t.equal(error.exception.message, 'thrown error in getServerSideProps', 'error.exception.message') + } + } +] +// Dev Note: To limit a test run to a particular test request, provide a +// string value to DEV_TEST_FILTER that matches `testName`. +var DEV_TEST_FILTER = null +if (DEV_TEST_FILTER) { + TEST_REQUESTS = TEST_REQUESTS.filter(testReq => ~testReq.testName.indexOf(DEV_TEST_FILTER)) + assert(TEST_REQUESTS.length > 0, 'DEV_TEST_FILTER should not result in an *empty* TEST_REQUESTS') +} + +// ---- utility functions + +/** + * Format the given data for passing to `t.comment()`. + * + * - t.comment() wipes leading whitespace. Prefix lines with '|' to avoid + * that, and to visually group a multi-line write. + * - Drop ANSI escape characters, because those include control chars that + * are illegal in XML. When we convert TAP output to JUnit XML for + * Jenkins, then Jenkins complains about invalid XML. `FORCE_COLOR=0` + * can be used to disable ANSI escapes in `next dev`'s usage of chalk, + * but not in its coloured exception output. + */ +function formatForTComment (data) { + return data.toString('utf8') + .replace(ANSI_RE, '') + .trimRight().replace(/\n/g, '\n|') + '\n' +} + +/** + * Wait for the test a-nextjs-app server to be ready. + * + * This polls `GET /api/an-api-endpoint` until the expected 200 response is + * received. It times out after ~10s. + * + * @param {Test} t - This is only used to `t.comment(...)` with progress. + * @param {Function} cb - Calls `cb(err)` if there was a timeout, `cb()` on + * success. + */ +function waitForServerReady (t, cb) { + let sentinel = 10 + + const pollForServerReady = () => { + const req = http.get( + 'http://localhost:3000/api/an-api-endpoint', + { + agent: false, + timeout: 500 + }, + res => { + if (res.statusCode !== 200) { + res.resume() + scheduleNextPoll(`statusCode=${res.statusCode}`) + } + const chunks = [] + res.on('data', chunk => { chunks.push(chunk) }) + res.on('end', () => { + try { + const body = Buffer.concat(chunks).toString() + if (body && JSON.parse(body).ping === 'pong') { + cb() + } else { + scheduleNextPoll(`unexpected body: ${body}`) + } + } catch (bodyErr) { + scheduleNextPoll(bodyErr.message) + } + }) + } + ) + req.on('error', err => { + scheduleNextPoll(err.message) + }) + } + + const scheduleNextPoll = (msg) => { + t.comment(`[sentinel=${sentinel} ${new Date().toISOString()}] wait another 1s for server ready: ${msg}`) + sentinel-- + if (sentinel <= 0) { + cb(new Error('timed out')) + } else { + setTimeout(pollForServerReady, 1000) + } + } + + pollForServerReady() +} + +async function makeTestRequest (t, testReq, buildId) { + return new Promise((resolve, reject) => { + let reqOpts = testReq.reqOpts + if (typeof reqOpts === 'function') { + reqOpts = reqOpts(buildId) + } + const url = `http://localhost:3000${reqOpts.path}` + t.comment(`makeTestRequest: ${testReq.testName} (${reqOpts.method} ${url})`) + const req = http.request( + url, + { + method: reqOpts.method + }, + res => { + const chunks = [] + res.on('data', chunk => { chunks.push(chunk) }) + res.on('end', () => { + const body = Buffer.concat(chunks) + if (testReq.expectedRes.statusCode) { + t.equal(res.statusCode, testReq.expectedRes.statusCode, `res.statusCode === ${testReq.expectedRes.statusCode}`) + } + if (testReq.expectedRes.headers) { + for (const [k, v] of Object.entries(testReq.expectedRes.headers)) { + if (v instanceof RegExp) { + t.ok(v.test(res.headers[k]), `res.headers[${JSON.stringify(k)}] =~ ${v}`) + } else { + t.equal(res.headers[k], v, `res.headers[${JSON.stringify(k)}] === ${JSON.stringify(v)}`) + } + } + } + if (testReq.expectedRes.body) { + if (testReq.expectedRes.body instanceof RegExp) { + t.ok(testReq.expectedRes.body.test(body), `body =~ ${testReq.expectedRes.body}`) + } else if (typeof testReq.expectedRes.body === 'string') { + t.equal(body.toString(), testReq.expectedRes.body, 'body') + } else { + t.fail(`unsupported type for TEST_REQUESTS[].expectedRes.body: ${typeof testReq.expectedRes.body}`) + } + } + resolve() + }) + } + ) + req.on('error', reject) + req.end() + }) +} + +function getEventField (e, fieldName) { + return (e.transaction || e.error || e.span)[fieldName] +} + +/** + * Return the buildId for this Next.js prod server. The buildId is stored + * in ".next/BUILD_ID" by `next build`. + */ +function getNextProdServerBuildId () { + const buildIdPath = path.join(testAppDir, '.next', 'BUILD_ID') + return fs.readFileSync(buildIdPath, 'utf8').trim() +} + +/** + * Assert that the given `apmEvents` (events that the mock APM server received) + * match all the expected APM events in `TEST_REQUESTS`. + */ +function checkExpectedApmEvents (t, apmEvents) { + // metadata + let evt = apmEvents.shift() + t.ok(evt.metadata, 'metadata is first event') + t.equal(evt.metadata.service.name, 'a-nextjs-app', 'metadata.service.name') + t.equal(evt.metadata.service.framework.name, 'Next.js', 'metadata.service.framework.name') + t.equal(evt.metadata.service.framework.version, nextJsVersion, 'metadata.service.framework.version') + + // Filter out any metadata from separate requests, and metricsets which we + // aren't testing. + apmEvents = apmEvents + .filter(e => !e.metadata) + .filter(e => !e.metricset) + + // One `GET /api/an-api-endpoint` from waitForServerReady. + evt = apmEvents.shift() + t.equal(evt.transaction.name, 'GET /api/an-api-endpoint', 'waitForServerReady request') + t.equal(evt.transaction.outcome, 'success', 'transaction.outcome') + + // Sort all the remaining APM events and check expectations from TEST_REQUESTS. + apmEvents = apmEvents + .sort((a, b) => { + return getEventField(a, 'timestamp') < getEventField(b, 'timestamp') ? -1 : 1 + }) + TEST_REQUESTS.forEach(testReq => { + t.comment(`check APM events for "${testReq.testName}"`) + // Collect all events for this transaction's trace_id, and pass that to + // the `checkApmEvents` function for this request. + assert(apmEvents.length > 0 && apmEvents[0].transaction, `next APM event is a transaction: ${JSON.stringify(apmEvents[0])}`) + const traceId = apmEvents[0].transaction.trace_id + const apmEventsForReq = apmEvents.filter(e => getEventField(e, 'trace_id') === traceId) + apmEvents = apmEvents.filter(e => getEventField(e, 'trace_id') !== traceId) + testReq.checkApmEvents(t, apmEventsForReq) + }) + + t.equal(apmEvents.length, 0, 'no additional unexpected APM server events: ' + JSON.stringify(apmEvents)) +} + +// ---- tests + +// We need to `npm ci` for a first test run. However, *only* for a first test +// run, otherwise this will override any possible `npm install --no-save ...` +// changes made by a TAV runner. +const haveNodeModules = fs.existsSync(path.join(testAppDir, 'node_modules')) +tape.test(`setup: npm ci (in ${testAppDir})`, { skip: haveNodeModules }, t => { + const startTime = Date.now() + exec( + 'npm ci', + { + cwd: testAppDir + }, + function (err, stdout, stderr) { + t.error(err, `"npm ci" succeeded (took ${(Date.now() - startTime) / 1000}s)`) + if (err) { + t.comment(`$ npm ci\n-- stdout --\n${stdout}\n-- stderr --\n${stderr}\n--`) + } + t.end() + } + ) +}) + +tape.test('setup: filter TEST_REQUESTS', t => { + // This version can only be fetched after the above `npm ci`. + nextJsVersion = require(path.join(testAppDir, 'node_modules/next/package.json')).version + + // Some entries in TEST_REQUESTS are only run for newer versions of Next.js. + TEST_REQUESTS = TEST_REQUESTS.filter(testReq => { + if (testReq.nextVersionRange && !semver.satisfies(nextJsVersion, testReq.nextVersionRange, { includePrerelease: true })) { + t.comment(`skip "${testReq.testName}" because next@${nextJsVersion} does not satisfy "${testReq.nextVersionRange}"`) + return false + } else { + return true + } + }) + + t.end() +}) + +tape.test('setup: mock APM server', t => { + apmServer = new MockAPMServer({ apmServerVersion: '7.15.0' }) + apmServer.start(function (serverUrl_) { + serverUrl = serverUrl_ + t.comment('mock APM serverUrl: ' + serverUrl) + t.end() + }) +}) + +// Test the Next "prod" server. I.e. `next build && next start`. +tape.test('-- prod server tests --', suite => { + let nextServerProc + + suite.test('setup: npm run build', t => { + const startTime = Date.now() + exec( + 'npm run build', + { + cwd: testAppDir + }, + function (err, stdout, stderr) { + t.error(err, `"npm run build" succeeded (took ${(Date.now() - startTime) / 1000}s)`) + if (err) { + t.comment(`$ npm run build\n-- stdout --\n${stdout}\n-- stderr --\n${stderr}\n--`) + } + t.end() + } + ) + }) + + suite.test('setup: start Next.js prod server (next start)', t => { + // Ideally we would simply spawn `npm run start` -- which handles setting + // NODE_OPTIONS. However, that results in a process tree: + // + // `- npm + // `- /tmp/.../tmp-$hash.sh + // `- node ./node_modules/.bin/next start + // that, in Docker, will reduce to: + // + // `- node ./node_modules/.bin/next start + // And our attempts to signal, `nextServerProc.kill()`, will fail to signal + // the actual server because the `npm` process is gone. + nextServerProc = spawn( + path.normalize('./node_modules/.bin/next'), + // Be explicit about "localhost" here, otherwise with node v18 we can + // get the server listening on IPv6 and the client connecting on IPv4. + ['start', '-H', 'localhost'], + { + shell: os.platform() === 'win32', + cwd: testAppDir, + env: Object.assign({}, process.env, { + NODE_OPTIONS: '-r ../../../../../start-next.js', + ELASTIC_APM_SERVER_URL: serverUrl, + ELASTIC_APM_API_REQUEST_TIME: '2s' + }) + } + ) + nextServerProc.on('error', err => { + t.error(err, 'no error from "next start"') + }) + nextServerProc.stdout.on('data', data => { + t.comment(`[Next.js server stdout] ${formatForTComment(data)}`) + }) + nextServerProc.stderr.on('data', data => { + t.comment(`[Next.js server stderr] ${formatForTComment(data)}`) + }) + + // Allow some time for an early fail of `next start`, e.g. if there is + // already a user of port 3000... + const onEarlyClose = code => { + t.fail(`"next start" failed early: code=${code}`) + nextServerProc = null + clearTimeout(earlyCloseTimer) + t.end() + } + nextServerProc.on('close', onEarlyClose) + const earlyCloseTimer = setTimeout(() => { + nextServerProc.removeListener('close', onEarlyClose) + + // ... then wait for the server to be ready. + waitForServerReady(t, waitErr => { + if (waitErr) { + t.fail(`error waiting for Next.js server to be ready: ${waitErr.message}`) + nextServerProc.kill('SIGKILL') + nextServerProc = null + } else { + t.comment('Next.js server is ready') + } + t.end() + }) + }, 1000) + }) + + suite.test('make requests', async t => { + if (!nextServerProc) { + t.skip('there is no nextServerProc') + t.end() + return + } + + const buildId = getNextProdServerBuildId() + apmServer.clear() + for (let i = 0; i < TEST_REQUESTS.length; i++) { + await makeTestRequest(t, TEST_REQUESTS[i], buildId) + } + t.end() + }) + + suite.test('check all APM events', t => { + if (!nextServerProc) { + t.skip('there is no nextServerProc') + t.end() + return + } + + // To ensure we get all the trace data from the instrumented Next.js + // server, we wait 2x the `apiRequestTime` (set above) before stopping it. + nextServerProc.on('close', code => { + t.equal(code, 0, 'Next.js server exit status was 0') + checkExpectedApmEvents(t, apmServer.events) + t.end() + }) + setTimeout(() => { + nextServerProc.kill('SIGTERM') + }, 4000) // 2x ELASTIC_APM_API_REQUEST_SIZE set above + }) + + suite.end() +}) + +// Test the Next "dev" server. I.e. `next dev`. +tape.test('-- dev server tests --', suite => { + let nextServerProc + + suite.test('setup: start Next.js dev server (next dev)', t => { + // See the warning notes for `spawn()` above. The same apply here. + nextServerProc = spawn( + path.normalize('./node_modules/.bin/next'), + ['dev', '-H', 'localhost'], + { + shell: os.platform() === 'win32', + cwd: testAppDir, + env: Object.assign({}, process.env, { + NODE_OPTIONS: '-r ../../../../../start-next.js', + ELASTIC_APM_SERVER_URL: serverUrl, + ELASTIC_APM_API_REQUEST_TIME: '2s' + }) + } + ) + nextServerProc.on('error', err => { + t.error(err, 'no error from "next dev"') + }) + nextServerProc.stdout.on('data', data => { + t.comment(`[Next.js server stdout] ${formatForTComment(data)}`) + }) + nextServerProc.stderr.on('data', data => { + t.comment(`[Next.js server stderr] ${formatForTComment(data)}`) + }) + + // Allow some time for an early fail of `next dev`, e.g. if there is + // already a user of port 3000... + const onEarlyClose = code => { + t.fail(`"next dev" failed early: code=${code}`) + nextServerProc = null + clearTimeout(earlyCloseTimer) + t.end() + } + nextServerProc.on('close', onEarlyClose) + const earlyCloseTimer = setTimeout(() => { + nextServerProc.removeListener('close', onEarlyClose) + + // ... then wait for the server to be ready. + waitForServerReady(t, waitErr => { + if (waitErr) { + t.fail(`error waiting for Next.js server to be ready: ${waitErr.message}`) + nextServerProc.kill('SIGKILL') + nextServerProc = null + } else { + t.comment('Next.js server is ready') + } + t.end() + }) + }, 1000) + }) + + suite.test('make requests', async t => { + if (!nextServerProc) { + t.skip('there is no nextServerProc') + t.end() + return + } + apmServer.clear() + + for (let i = 0; i < TEST_REQUESTS.length; i++) { + await makeTestRequest(t, TEST_REQUESTS[i], 'development') + } + + t.end() + }) + + suite.test('check all APM events', t => { + if (!nextServerProc) { + t.skip('there is no nextServerProc') + t.end() + return + } + + // To ensure we get all the trace data from the instrumented Next.js + // server, we wait 2x the `apiRequestTime` (set above) before stopping it. + nextServerProc.on('close', code => { + t.equal(code, 0, 'Next.js server exit status was 0') + checkExpectedApmEvents(t, apmServer.events) + t.end() + }) + setTimeout(() => { + nextServerProc.kill('SIGTERM') + }, 4000) // 2x ELASTIC_APM_API_REQUEST_SIZE set above + }) + + suite.end() +}) + +tape.test('teardown: mock APM server', t => { + apmServer.close() + t.end() +}) diff --git a/test/instrumentation/modules/pg/knex.test.js b/test/instrumentation/modules/pg/knex.test.js index 37db7104a1..0612c4864a 100644 --- a/test/instrumentation/modules/pg/knex.test.js +++ b/test/instrumentation/modules/pg/knex.test.js @@ -30,7 +30,7 @@ if ((semver.gte(knexVersion, '0.18.0') && semver.lt(process.version, '8.6.0')) | // Instrumentation does not work with Knex >=0.95.0 and `contextManager=patch`. // The "patch" context manager is deprecated. if (semver.gte(knexVersion, '0.95.0') && agent._conf.contextManager === 'patch') { - console.log(`# SKIP knex@${knexVersion} and contextManager='patch' is not support`) + console.log(`# SKIP knex@${knexVersion} and contextManager='patch' is not supported`) process.exit() }