remove instrumentation exp flag

huozhi · huozhi · commit 5c761beb3bdb · 2024-08-19T19:46:24.000+02:00
diff --git a/packages/next/src/build/index.ts b/packages/next/src/build/index.ts
@@ -861,15 +861,9 @@ export default async function build(
       )
 
       const rootDir = path.join((pagesDir || appDir)!, '..')
-      const instrumentationHookEnabled = Boolean(
-        config.experimental.instrumentationHook
-      )
-
       const includes = [
         middlewareDetectionRegExp,
-        ...(instrumentationHookEnabled
-          ? [instrumentationHookDetectionRegExp]
-          : []),
+        instrumentationHookDetectionRegExp,
       ]
 
       const rootPaths = Array.from(await getFilesInDir(rootDir))
@@ -1350,7 +1344,6 @@ export default async function build(
           currentEntrypoints,
           currentEntryIssues,
           manifestLoader,
-          nextConfig: config,
           devRewrites: undefined,
           productionRewrites: customRoutes.rewrites,
           logErrors: false,
diff --git a/packages/next/src/server/config-schema.ts b/packages/next/src/server/config-schema.ts
@@ -394,7 +394,6 @@ export const configSchema: zod.ZodType<NextConfig> = z.lazy(() =>
           .optional(),
         optimizePackageImports: z.array(z.string()).optional(),
         optimizeServerReact: z.boolean().optional(),
-        instrumentationHook: z.boolean().optional(),
         clientTraceMetadata: z.array(z.string()).optional(),
         turbotrace: z
           .object({
diff --git a/packages/next/src/server/config-shared.ts b/packages/next/src/server/config-shared.ts
@@ -402,11 +402,6 @@ export interface ExperimentalConfig {
    */
   webpackMemoryOptimizations?: boolean
 
-  /**
-   *
-   */
-  instrumentationHook?: boolean
-
   /**
    * The array of the meta tags to the client injected by tracing propagation data.
    */
@@ -1031,7 +1026,6 @@ export const defaultConfig: NextConfig = {
     turbotrace: undefined,
     typedRoutes: false,
     typedEnv: false,
-    instrumentationHook: false,
     clientTraceMetadata: undefined,
     parallelServerCompiles: false,
     parallelServerBuildTraces: false,
diff --git a/packages/next/src/server/config.ts b/packages/next/src/server/config.ts
@@ -471,6 +471,13 @@ function assignDefaults(
     silent
   )
 
+  warnOptionHasBeenDeprecated(
+    result,
+    'experimental.instrumentationHook',
+    'instrumentation.js is stabilized and no longer needs to be enabled via experimental flag',
+    silent
+  )
+
   warnOptionHasBeenMovedOutOfExperimental(
     result,
     'bundlePagesExternals',
diff --git a/packages/next/src/server/dev/hot-reloader-turbopack.ts b/packages/next/src/server/dev/hot-reloader-turbopack.ts
@@ -475,7 +475,6 @@ export async function createHotReloaderTurbopack(
 
         currentEntryIssues,
         manifestLoader,
-        nextConfig: opts.nextConfig,
         devRewrites: opts.fsChecker.rewrites,
         productionRewrites: undefined,
         logErrors: true,
diff --git a/packages/next/src/server/dev/turbopack-utils.ts b/packages/next/src/server/dev/turbopack-utils.ts
@@ -709,7 +709,6 @@ export async function handleEntrypoints({
 
   currentEntryIssues,
   manifestLoader,
-  nextConfig,
   devRewrites,
   productionRewrites,
   logErrors,
@@ -721,7 +720,6 @@ export async function handleEntrypoints({
 
   currentEntryIssues: EntryIssuesMap
   manifestLoader: TurbopackManifestLoader
-  nextConfig: NextConfigComplete
   devRewrites: SetupOpts['fsChecker']['rewrites'] | undefined
   productionRewrites: CustomRoutes['rewrites'] | undefined
   logErrors: boolean
@@ -793,7 +791,7 @@ export async function handleEntrypoints({
 
   currentEntrypoints.global.middleware = middleware
 
-  if (nextConfig.experimental.instrumentationHook && instrumentation) {
+  if (instrumentation) {
     const processInstrumentation = async (
       name: string,
       prop: 'nodeJs' | 'edge'
diff --git a/packages/next/src/server/lib/router-utils/setup-dev-bundler.ts b/packages/next/src/server/lib/router-utils/setup-dev-bundler.ts
@@ -393,10 +393,7 @@ async function startWatcher(opts: SetupOpts) {
           ]
           continue
         }
-        if (
-          isInstrumentationHookFile(rootFile) &&
-          nextConfig.experimental.instrumentationHook
-        ) {
+        if (isInstrumentationHookFile(rootFile)) {
           serverFields.actualInstrumentationHookFile = rootFile
           await propagateServerField(
             opts,
diff --git a/packages/next/src/server/next-server.ts b/packages/next/src/server/next-server.ts
@@ -297,10 +297,7 @@ export default class NextNodeServer extends BaseServer<
   }
 
   protected async loadInstrumentationModule() {
-    if (
-      !this.serverOptions.dev &&
-      !!this.nextConfig.experimental.instrumentationHook
-    ) {
+    if (!this.serverOptions.dev) {
       try {
         this.instrumentation = await dynamicRequire(
           resolve(
diff --git a/test/e2e/app-dir/next-after-app/next.config.js b/test/e2e/app-dir/next-after-app/next.config.js
@@ -3,6 +3,5 @@ module.exports = {
   experimental: {
     after: true,
     testProxy: true,
-    instrumentationHook: true,
   },
 }
diff --git a/test/e2e/instrumentation-hook-src/instrumentation-hook-src.test.ts b/test/e2e/instrumentation-hook-src/instrumentation-hook-src.test.ts
@@ -4,11 +4,6 @@ describe('instrumentation-hook-rsc', () => {
   describe('instrumentation', () => {
     const { next, isNextDev, skipped } = nextTestSetup({
       files: __dirname,
-      nextConfig: {
-        experimental: {
-          instrumentationHook: true,
-        },
-      },
       skipDeployment: true,
     })
 
diff --git a/test/e2e/instrumentation-hook/flying-shuttle/next.config.js b/test/e2e/instrumentation-hook/flying-shuttle/next.config.js
@@ -6,6 +6,5 @@ module.exports = {
     flyingShuttle: {
       mode: 'full',
     },
-    instrumentationHook: true,
   },
 }
diff --git a/test/e2e/instrumentation-hook/general/next.config.js b/test/e2e/instrumentation-hook/general/next.config.js
@@ -1,5 +1 @@
-module.exports = {
-  experimental: {
-    instrumentationHook: true,
-  },
-}
+module.exports = {}
diff --git a/test/e2e/instrumentation-hook/instrumentation-hook.test.ts b/test/e2e/instrumentation-hook/instrumentation-hook.test.ts
@@ -17,33 +17,15 @@ const describeCase = (
   })
 }
 describe('Instrumentation Hook', () => {
-  // TODO: investigate the failure with esm import
-  // createNextDescribe(
-  //   'with-esm-import',
-  //   {
-  //     files: path.join(__dirname, 'with-esm-import'),
-  //     nextConfig: {
-  //       experimental: {
-  //         instrumentationHook: true,
-  //       },
-  //     },
-  //     dependencies: {
-  //       // This test is mostly for compatibility with this package
-  //       '@vercel/otel': 'latest',
-  //     },
-  //     skipDeployment: true,
-  //   },
-  //   ({ next }) => {
-  // eslint-disable-next-line jest/no-commented-out-tests
-  //     it('with-esm-import should run the instrumentation hook', async () => {
-  //       await next.render('/')
-  //       await check(
-  //         () => next.cliOutput,
-  //         /register in instrumentation\.js is running/
-  //       )
-  //     })
-  //   }
-  // )
+  describeCase('with-esm-import', ({ next }) => {
+    it('with-esm-import should run the instrumentation hook', async () => {
+      await next.render('/')
+      await check(
+        () => next.cliOutput,
+        /register in instrumentation\.js is running/
+      )
+    })
+  })
 
   describeCase('with-middleware', ({ next }) => {
     it('with-middleware should run the instrumentation hook', async () => {
diff --git a/test/e2e/instrumentation-hook/register-once/next.config.js b/test/e2e/instrumentation-hook/register-once/next.config.js
@@ -1,5 +1 @@
-module.exports = {
-  experimental: {
-    instrumentationHook: true,
-  },
-}
+module.exports = {}
diff --git a/test/e2e/instrumentation-hook/with-async-edge-page/next.config.js b/test/e2e/instrumentation-hook/with-async-edge-page/next.config.js
@@ -1,5 +1 @@
-module.exports = {
-  experimental: {
-    instrumentationHook: true,
-  },
-}
+module.exports = {}
diff --git a/test/e2e/instrumentation-hook/with-async-node-page/next.config.js b/test/e2e/instrumentation-hook/with-async-node-page/next.config.js
@@ -1,5 +1 @@
-module.exports = {
-  experimental: {
-    instrumentationHook: true,
-  },
-}
+module.exports = {}
diff --git a/test/e2e/instrumentation-hook/with-edge-api/next.config.js b/test/e2e/instrumentation-hook/with-edge-api/next.config.js
@@ -1,5 +1 @@
-module.exports = {
-  experimental: {
-    instrumentationHook: true,
-  },
-}
+module.exports = {}
diff --git a/test/e2e/instrumentation-hook/with-edge-page/next.config.js b/test/e2e/instrumentation-hook/with-edge-page/next.config.js
@@ -1,5 +1 @@
-module.exports = {
-  experimental: {
-    instrumentationHook: true,
-  },
-}
+module.exports = {}
diff --git a/test/e2e/instrumentation-hook/with-esm-import/.gitignore b/test/e2e/instrumentation-hook/with-esm-import/.gitignore
@@ -0,0 +1 @@
+!node_modules
diff --git a/test/e2e/instrumentation-hook/with-esm-import/instrumentation.js b/test/e2e/instrumentation-hook/with-esm-import/instrumentation.js
@@ -1,7 +1,7 @@
-import * as otel from '@vercel/otel'
+import * as mod from 'my-lib'
 
 export function register() {
   console.log('register in instrumentation.js is running')
   // make sure that this is not tree-shaken
-  if (process.env.DOESNT_EXIST_1234) otel()
+  if (process.env.DOESNT_EXIST_1234) mod.c()
 }
diff --git a/test/e2e/instrumentation-hook/with-esm-import/next.config.js b/test/e2e/instrumentation-hook/with-esm-import/next.config.js
@@ -1,5 +1 @@
-module.exports = {
-  experimental: {
-    instrumentationHook: true,
-  },
-}
+module.exports = {}
diff --git a/test/e2e/instrumentation-hook/with-esm-import/node_modules/my-lib/index.js b/test/e2e/instrumentation-hook/with-esm-import/node_modules/my-lib/index.js
diff --git a/test/e2e/instrumentation-hook/with-esm-import/node_modules/my-lib/package.json b/test/e2e/instrumentation-hook/with-esm-import/node_modules/my-lib/package.json
diff --git a/test/e2e/instrumentation-hook/with-middleware/next.config.js b/test/e2e/instrumentation-hook/with-middleware/next.config.js
@@ -1,5 +1 @@
-module.exports = {
-  experimental: {
-    instrumentationHook: true,
-  },
-}
+module.exports = {}
diff --git a/test/e2e/instrumentation-hook/with-node-api/next.config.js b/test/e2e/instrumentation-hook/with-node-api/next.config.js
@@ -1,5 +1 @@
-module.exports = {
-  experimental: {
-    instrumentationHook: true,
-  },
-}
+module.exports = {}
diff --git a/test/e2e/instrumentation-hook/with-node-page/next.config.js b/test/e2e/instrumentation-hook/with-node-page/next.config.js
@@ -1,5 +1 @@
-module.exports = {
-  experimental: {
-    instrumentationHook: true,
-  },
-}
+module.exports = {}
diff --git a/test/e2e/on-request-error/basic/next.config.js b/test/e2e/on-request-error/basic/next.config.js
@@ -1,5 +1 @@
-module.exports = {
-  experimental: {
-    instrumentationHook: true,
-  },
-}
+module.exports = {}
diff --git a/test/e2e/on-request-error/dynamic-routes/next.config.js b/test/e2e/on-request-error/dynamic-routes/next.config.js
@@ -1,5 +1 @@
-module.exports = {
-  experimental: {
-    instrumentationHook: true,
-  },
-}
+module.exports = {}
diff --git a/test/e2e/on-request-error/isr/next.config.js b/test/e2e/on-request-error/isr/next.config.js
@@ -1,5 +1 @@
-module.exports = {
-  experimental: {
-    instrumentationHook: true,
-  },
-}
+module.exports = {}
diff --git a/test/e2e/on-request-error/server-action-error/next.config.js b/test/e2e/on-request-error/server-action-error/next.config.js
@@ -1,5 +1 @@
-module.exports = {
-  experimental: {
-    instrumentationHook: true,
-  },
-}
+module.exports = {}
diff --git a/test/e2e/on-request-error/skip-next-internal-error/next.config.js b/test/e2e/on-request-error/skip-next-internal-error/next.config.js
@@ -1,5 +1 @@
-module.exports = {
-  experimental: {
-    instrumentationHook: true,
-  },
-}
+module.exports = {}
diff --git a/test/e2e/opentelemetry/client-trace-metadata/next.config.js b/test/e2e/opentelemetry/client-trace-metadata/next.config.js
@@ -1,6 +1,5 @@
 module.exports = {
   experimental: {
-    instrumentationHook: true,
     clientTraceMetadata: [
       'my-parent-span-id',
       'my-test-key-1',
diff --git a/test/e2e/opentelemetry/instrumentation/next.config.js b/test/e2e/opentelemetry/instrumentation/next.config.js
@@ -1,5 +1 @@
-module.exports = {
-  experimental: {
-    instrumentationHook: true,
-  },
-}
+module.exports = {}
diff --git a/test/e2e/opentelemetry/instrumentation/opentelemetry.test.ts b/test/e2e/opentelemetry/instrumentation/opentelemetry.test.ts
@@ -61,7 +61,7 @@ describe('opentelemetry', () => {
       },
     },
   ]) {
-    // turbopack does not support experimental.instrumentationHook
+    // turbopack does not support instrumentation.js
     ;(process.env.TURBOPACK || process.env.__NEXT_EXPERIMENTAL_PPR
       ? describe.skip
       : describe)(env.name, () => {
@@ -836,7 +836,7 @@ describe('opentelemetry with disabled fetch tracing', () => {
     await collector.shutdown()
   })
 
-  // turbopack does not support experimental.instrumentationHook
+  // turbopack does not support instrumentation.js
   ;(process.env.TURBOPACK || process.env.__NEXT_EXPERIMENTAL_PPR
     ? describe.skip
     : describe)('root context', () => {
diff --git a/test/e2e/rsc-layers-transform/next.config.js b/test/e2e/rsc-layers-transform/next.config.js
@@ -1,5 +1 @@
-module.exports = {
-  experimental: {
-    instrumentationHook: true,
-  },
-}
+module.exports = {}
diff --git a/test/integration/config-experimental-warning/test/index.test.js b/test/integration/config-experimental-warning/test/index.test.js
@@ -139,7 +139,7 @@ describe('Config Experimental Warning', () => {
           experimental: {
             workerThreads: true,
             scrollRestoration: true,
-            instrumentationHook: true,
+            parallelServerCompiles: true,
             cpus: 2,
           }
         }
@@ -162,7 +162,7 @@ describe('Config Experimental Warning', () => {
           experimental: {
             workerThreads: true,
             scrollRestoration: true,
-            instrumentationHook: true,
+            parallelServerCompiles: true,
             cpus: 2,
           }
         }
@@ -172,7 +172,7 @@ describe('Config Experimental Warning', () => {
         expect(stdout).toMatch(' · cpus')
         expect(stdout).toMatch(' · workerThreads')
         expect(stdout).toMatch(' · scrollRestoration')
-        expect(stdout).toMatch(' · instrumentationHook')
+        expect(stdout).toMatch(' · parallelServerCompiles')
       })
 
       it('should show unrecognized experimental features in warning but not in start log experiments section', async () => {
diff --git a/test/production/instrumentation/required-files-instrumentation-entry/next.config.js b/test/production/instrumentation/required-files-instrumentation-entry/next.config.js
@@ -1,6 +1,2 @@
 /** @type {import('next').NextConfig} */
-module.exports = {
-  experimental: {
-    instrumentationHook: true,
-  },
-}
+module.exports = {}

Original file line number	Diff line number	Diff line change
`@@ -393,10 +393,7 @@ async function startWatcher(opts: SetupOpts) {`
`393`	`393`	`]`
`394`	`394`	`continue`
`395`	`395`	`}`
`396`		`- if (`
`397`		`- isInstrumentationHookFile(rootFile) &&`
`398`		`- nextConfig.experimental.instrumentationHook`
`399`		`- ) {`
	`396`	`+ if (isInstrumentationHookFile(rootFile)) {`
`400`	`397`	`serverFields.actualInstrumentationHookFile = rootFile`
`401`	`398`	`await propagateServerField(`
`402`	`399`	`opts,`
Original file line number	Diff line number	Diff line change
`@@ -3,6 +3,5 @@ module.exports = {`
`3`	`3`	`experimental: {`
`4`	`4`	`after: true,`
`5`	`5`	`testProxy: true,`
`6`		`- instrumentationHook: true,`
`7`	`6`	`},`
`8`	`7`	`}`