[Breaking] Enable experimental.isolatedDevBuild by default (#84561)

### Why?

This PR cleans up the incremental rollout of enabling `isolatedDevBuild`
throughout the CI, as it required many test changes (x-ref:
#84043).

- #84556
- #84558
- #84559
- #84562

This PR enables `experimental.isolatedDevBuild` by default so that users
can run `next dev` and `next build` in the same directory, and they
would not conflict. This occasionally happens when developing with AI
tools, where you have a running dev server, but the Agent runs `next
build`.

### How?

- Removed `__NEXT_EXPERIMENTAL_ISOLATED_DEV_BUILD` flag and its usage
from CI and tests
- Updated tests that were not caught via rollout (e.g., missed out on
test-*-windows)
- Moved `isolatedDevBuild` option out of experimental
- Added Telemetry

Will follow up with docs.

Author: devjiwonchoi

.github/workflows/build_and_test.yml

@@ -542,9 +542,7 @@ jobs:
     uses: ./.github/workflows/build_reusable.yml
     with:
       nodeVersion: ${{ matrix.node }}
-      afterBuild: |
-        export __NEXT_EXPERIMENTAL_ISOLATED_DEV_BUILD=true
-        node run-tests.js --type unit
+      afterBuild: node run-tests.js --type unit
       stepName: 'test-unit-${{ matrix.node }}'
 
     secrets: inherit
@@ -735,7 +733,6 @@ jobs:
         export IS_WEBPACK_TEST=1
         export NEXT_TEST_MODE=dev
         export NEXT_TEST_REACT_VERSION="${{ matrix.react }}"
-        export __NEXT_EXPERIMENTAL_ISOLATED_DEV_BUILD=true
 
         node run-tests.js \
           --timings \
@@ -849,7 +846,6 @@ jobs:
         export IS_WEBPACK_TEST=1
         export NEXT_TEST_MODE=start
         export NEXT_TEST_REACT_VERSION="${{ matrix.react }}"
-        export __NEXT_EXPERIMENTAL_ISOLATED_DEV_BUILD=true
 
         node run-tests.js --timings -g ${{ matrix.group }} --type production
       stepName: 'test-prod-react-${{ matrix.react }}-${{ matrix.group }}'
@@ -889,7 +885,6 @@ jobs:
       afterBuild: |
         export IS_WEBPACK_TEST=1
         export NEXT_TEST_REACT_VERSION="${{ matrix.react }}"
-        export __NEXT_EXPERIMENTAL_ISOLATED_DEV_BUILD=true
 
         node run-tests.js \
           --timings \

packages/next/src/build/index.ts

@@ -2730,6 +2730,10 @@ export default async function build(
           featureName: 'experimental/ppr',
           invocationCount: config.experimental.ppr ? 1 : 0,
         },
+        {
+          featureName: 'experimental/isolatedDevBuild',
+          invocationCount: config.experimental.isolatedDevBuild ? 1 : 0,
+        },
         {
           featureName: 'turbopackFileSystemCache',
           invocationCount: isFileSystemCacheEnabledForBuild(config) ? 1 : 0,

packages/next/src/server/config-shared.ts

@@ -1506,9 +1506,8 @@ export const defaultConfig = Object.freeze({
     slowModuleDetection: undefined,
     globalNotFound: false,
     browserDebugInfoInTerminal: false,
-    isolatedDevBuild:
-      process.env.__NEXT_EXPERIMENTAL_ISOLATED_DEV_BUILD === 'true',
     lockDistDir: true,
+    isolatedDevBuild: true,
   },
   htmlLimitedBots: undefined,
   bundlePagesRouterDependencies: false,

packages/next/src/telemetry/events/build.ts

@@ -175,6 +175,7 @@ export type EventBuildFeatureUsage = {
     | 'experimental/cacheComponents'
     | 'experimental/optimizeCss'
     | 'experimental/ppr'
+    | 'experimental/isolatedDevBuild'
     | 'swcLoader'
     | 'swcRelay'
     | 'swcStyledComponents'

scripts/devlow-bench.mjs

@@ -482,6 +482,7 @@ const nextDevWorkflow =
         const cacheLocation = join(
           benchmarkDir,
           '.next',
+          'dev',
           'cache',
           'webpack',
           'client-development'

test/development/app-dir/isolated-dev-build/next.config.js

@@ -1,10 +1,6 @@
 /**
  * @type {import('next').NextConfig}
  */
-const nextConfig = {
-  experimental: {
-    isolatedDevBuild: true,
-  },
-}
+const nextConfig = {}
 
 module.exports = nextConfig

test/integration/dist-dir/test/index.test.js

@@ -68,15 +68,9 @@ describe('distDir', () => {
 
       it('should build the app within the given `dist` directory', async () => {
         // In isolated dev build, the distDir for development is `distDir/dev`
-        if (process.env.__NEXT_EXPERIMENTAL_ISOLATED_DEV_BUILD === 'true') {
-          expect(
-            await fs.exists(join(__dirname, `/../dist/dev/${BUILD_MANIFEST}`))
-          ).toBeTruthy()
-        } else {
-          expect(
-            await fs.exists(join(__dirname, `/../dist/${BUILD_MANIFEST}`))
-          ).toBeTruthy()
-        }
+        expect(
+          await fs.exists(join(__dirname, `/../dist/dev/${BUILD_MANIFEST}`))
+        ).toBeTruthy()
       })
       it('should not build the app within the default `.next` directory', async () => {
         expect(

test/integration/module-ids/test/index.test.js

@@ -8,10 +8,11 @@ import {
   launchApp,
   nextBuild,
   renderViaHTTP,
+  getDistDir,
 } from 'next-test-utils'
 
 const appDir = join(__dirname, '../')
-
+const originalIsNextDev = global.isNextDev
 let appPort
 let app
 
@@ -23,9 +24,11 @@ describe('minified module ids', () => {
     let staticBundles = ''
 
     beforeAll(async () => {
+      // getDistDir depends on global.isNextDev
+      global.isNextDev = false
       await nextBuild(appDir, [])
 
-      const ssrPath = join(appDir, '.next/server/chunks/ssr/')
+      const ssrPath = join(appDir, `${getDistDir()}/server/chunks/ssr/`)
       const ssrBundleBasenames = (await fs.readdir(ssrPath)).filter((p) =>
         p.match(/\.js$/)
       )
@@ -34,7 +37,7 @@ describe('minified module ids', () => {
         ssrBundles += output
       }
 
-      const staticPath = join(appDir, '.next/static/chunks/')
+      const staticPath = join(appDir, `${getDistDir()}/static/chunks/`)
       const staticBundleBasenames = (await fs.readdir(staticPath)).filter((p) =>
         p.match(/\.js$/)
       )
@@ -43,6 +46,9 @@ describe('minified module ids', () => {
         staticBundles += output
       }
     })
+    afterAll(() => {
+      global.isNextDev = originalIsNextDev
+    })
 
     it('should have no long module ids for basic modules', async () => {
       expect(ssrBundles).not.toContain('module-with-long-name')
@@ -72,12 +78,14 @@ describe('minified module ids', () => {
     let staticBundles = ''
 
     beforeAll(async () => {
+      // getDistDir depends on global.isNextDev
+      global.isNextDev = true
       appPort = await findPort()
       app = await launchApp(appDir, appPort)
 
       await renderViaHTTP(appPort, '/')
 
-      const ssrPath = join(appDir, '.next/server/chunks/ssr/')
+      const ssrPath = join(appDir, `${getDistDir()}/server/chunks/ssr/`)
       const ssrBundleBasenames = (await fs.readdir(ssrPath)).filter((p) =>
         p.match(/\.js$/)
       )
@@ -86,7 +94,7 @@ describe('minified module ids', () => {
         ssrBundles += output
       }
 
-      const staticPath = join(appDir, '.next/static/chunks/')
+      const staticPath = join(appDir, `${getDistDir()}/static/chunks/`)
       const staticBundleBasenames = (await fs.readdir(staticPath)).filter((p) =>
         p.match(/\.js$/)
       )
@@ -95,7 +103,10 @@ describe('minified module ids', () => {
         staticBundles += output
       }
     })
-    afterAll(() => killApp(app))
+    afterAll(() => {
+      global.isNextDev = originalIsNextDev
+      killApp(app)
+    })
 
     it('should have long module ids for basic modules', async () => {
       expect(ssrBundles).toContain('module-with-long-name')

test/integration/telemetry/test/config.test.js

@@ -836,6 +836,59 @@ describe('config telemetry', () => {
           )
         }
       })
+
+      it('emits telemetry for isolatedDevBuild enabled by default', async () => {
+        let stderr
+        try {
+          const app = await nextBuild(appDir, [], {
+            stderr: true,
+            env: { NEXT_TELEMETRY_DEBUG: 1 },
+          })
+          stderr = app.stderr
+
+          const featureUsageEvents = findAllTelemetryEvents(
+            stderr,
+            'NEXT_BUILD_FEATURE_USAGE'
+          )
+          expect(featureUsageEvents).toContainEqual({
+            featureName: 'experimental/isolatedDevBuild',
+            invocationCount: 1,
+          })
+        } catch (err) {
+          require('console').error('failing stderr', stderr, err)
+          throw err
+        }
+      })
+
+      it('emits telemetry for isolatedDevBuild disabled', async () => {
+        await fs.writeFile(
+          path.join(appDir, 'next.config.js'),
+          `module.exports = { experimental: { isolatedDevBuild: false } }`
+        )
+
+        let stderr
+        try {
+          const app = await nextBuild(appDir, [], {
+            stderr: true,
+            env: { NEXT_TELEMETRY_DEBUG: 1 },
+          })
+          stderr = app.stderr
+
+          const featureUsageEvents = findAllTelemetryEvents(
+            stderr,
+            'NEXT_BUILD_FEATURE_USAGE'
+          )
+          expect(featureUsageEvents).toContainEqual({
+            featureName: 'experimental/isolatedDevBuild',
+            invocationCount: 0,
+          })
+        } catch (err) {
+          require('console').error('failing stderr', stderr, err)
+          throw err
+        } finally {
+          await fs.remove(path.join(appDir, 'next.config.js'))
+        }
+      })
     }
   )
 })

test/integration/typescript-app-type-declarations/next-env.d.ts

@@ -1,6 +1,6 @@
 /// <reference types="next" />
 /// <reference types="next/image-types/global" />
-import "./.next/types/routes.d.ts";
+import "./.next/dev/types/routes.d.ts";
 
 // NOTE: This file should not be edited
 // see https://nextjs.org/docs/pages/api-reference/config/typescript for more information.