test(turbopack): support new env to set --experimental-turbo

jest.config.js

@@ -39,9 +39,10 @@ if (shouldEnableTestTrace) {
     customJestConfig.reporters = ['default']
   }
 
-  const outputDirectory = process.env.TURBOPACK
-    ? '<rootDir>/turbopack-test-junit-report'
-    : '<rootDir>/test-junit-report'
+  const outputDirectory =
+    process.env.TURBOPACK || process.env.__EXPERIMENTAL_TURBO
+      ? '<rootDir>/turbopack-test-junit-report'
+      : '<rootDir>/test-junit-report'
   customJestConfig.reporters.push([
     'jest-junit',
     {

packages/next/src/cli/next-dev.ts

@@ -211,7 +211,14 @@ const nextDev: CliCommand = async (argv) => {
   // We do not set a default host value here to prevent breaking
   // some set-ups that rely on listening on other interfaces
   const host = args['--hostname']
-  const experimentalTurbo = args['--experimental-turbo']
+
+  if (args['--turbo']) {
+    process.env.TURBOPACK = '1'
+  } else if (args['--experimental-turbo']) {
+    process.env.__EXPERIMENTAL_TURBO = '1'
+  }
+
+  const experimentalTurbo = !!process.env.__EXPERIMENTAL_TURBO
 
   const devServerOptions: StartServerOptions = {
     dir,
@@ -224,10 +231,6 @@ const nextDev: CliCommand = async (argv) => {
     isExperimentalTurbo: experimentalTurbo,
   }
 
-  if (args['--turbo']) {
-    process.env.TURBOPACK = '1'
-  }
-
   if (process.env.TURBOPACK) {
     isTurboSession = true
 

test/development/basic/emotion-swc.test.ts

@@ -8,7 +8,9 @@ describe('emotion SWC option', () => {
   let next: NextInstance
 
   beforeAll(async () => {
-    const useTurbo = !!process.env.TEST_WASM ? false : shouldRunTurboDevTest()
+    const useTurbo = !!process.env.TEST_WASM
+      ? false
+      : shouldRunTurboDevTest().turbo
     next = await createNext({
       files: {
         'jsconfig.json': new FileRef(

test/e2e/next-font/index.test.ts

@@ -11,7 +11,7 @@ const mockedGoogleFontResponses = require.resolve(
 
 function getClassNameRegex(className: string): RegExp {
   // Turbopack uses a different format for its css modules than webpack-based Next.js
-  return shouldRunTurboDevTest()
+  return shouldRunTurboDevTest().turbo
     ? new RegExp(`^${className}__.*__.{8}$`) // e.g. `className__inter_c6e282f1__a8cc5613`
     : new RegExp(`^__${className}_.{6}$`) // e.g. `__className_a8cc56`
 }

test/lib/e2e-utils.ts

@@ -14,7 +14,8 @@ export type { NextInstance }
 // if either test runs for the --turbo or have a custom timeout, set reduced timeout instead.
 // this is due to current --turbo test have a lot of tests fails with timeouts, ends up the whole
 // test job exceeds the 6 hours limit.
-let testTimeout = shouldRunTurboDevTest() ? (240 * 1000) / 4 : 240 * 1000
+const { turbo, experimental } = shouldRunTurboDevTest()
+let testTimeout = turbo || experimental ? (240 * 1000) / 4 : 240 * 1000
 if (process.env.NEXT_E2E_TEST_TIMEOUT) {
   try {
     testTimeout = parseInt(process.env.NEXT_E2E_TEST_TIMEOUT, 10)
@@ -147,14 +148,23 @@ export async function createNext(
     return await trace('createNext').traceAsyncFn(async (rootSpan) => {
       const useTurbo = !!process.env.TEST_WASM
         ? false
-        : opts?.turbo ?? shouldRunTurboDevTest()
+        : opts?.turbo ?? shouldRunTurboDevTest().turbo
+
+      const useTurboExperimental = !!process.env.TEST_WASM
+        ? false
+        : shouldRunTurboDevTest().experimental
+
+      if (useTurbo && useTurboExperimental) {
+        throw new Error('Cannot enable both turbo and turboExperimental')
+      }
 
       if (testMode === 'dev') {
         // next dev
         rootSpan.traceChild('init next dev instance').traceFn(() => {
           nextInstance = new NextDevInstance({
             ...opts,
             turbo: useTurbo,
+            turboExperimental: experimental,
           })
         })
       } else if (testMode === 'deploy') {
@@ -252,7 +262,7 @@ export function nextTestSetup(
       return Boolean(
         (global as any).isNextDev &&
           !process.env.TEST_WASM &&
-          (options.turbo ?? shouldRunTurboDevTest())
+          (options.turbo ?? shouldRunTurboDevTest().turbo)
       )
     },
 

test/lib/next-modes/base.ts

@@ -33,6 +33,7 @@ export interface NextInstanceOpts {
   env?: Record<string, string>
   dirSuffix?: string
   turbo?: boolean
+  turboExperimental?: boolean
   forcedPort?: string
 }
 

test/lib/next-modes/next-dev.ts

@@ -24,10 +24,16 @@ export class NextDevInstance extends NextInstance {
 
     const useTurbo = !process.env.TEST_WASM && (this as any).turbo
 
+    const turboArgs = useTurbo
+      ? '--turbo'
+      : (this as any).turboExperimental
+      ? '--experimental-turbo'
+      : undefined
+
     let startArgs = [
       'yarn',
       'next',
-      useTurbo ? '--turbo' : undefined,
+      turboArgs,
       useDirArg && this.testDir,
     ].filter(Boolean) as string[]
 

test/lib/next-test-utils.ts

@@ -433,12 +433,15 @@ export function launchApp(
   opts?: NextDevOptions
 ) {
   const options = opts ?? {}
-  const useTurbo = shouldRunTurboDevTest()
+  const { turbo: useTurbo, experimental } = shouldRunTurboDevTest()
+  const turboArgs = useTurbo
+    ? '--turbo'
+    : experimental
+    ? '--experimental-turbo'
+    : undefined
 
   return runNextCommandDev(
-    [useTurbo ? '--turbo' : undefined, dir, '-p', port as string].filter(
-      Boolean
-    ),
+    [turboArgs, dir, '-p', port as string].filter(Boolean),
     undefined,
     {
       ...options,
@@ -763,7 +766,7 @@ export async function hasRedbox(browser: BrowserInterface, expected = true) {
 export async function getRedboxHeader(browser: BrowserInterface) {
   return retry(
     () => {
-      if (shouldRunTurboDevTest()) {
+      if (shouldRunTurboDevTest().turbo) {
         return evaluate(browser, () => {
           const portal = [].slice
             .call(document.querySelectorAll('nextjs-portal'))
@@ -1021,7 +1024,8 @@ export function getSnapshotTestDescribe(variant: TestVariants) {
     )
   }
 
-  const shouldRunTurboDev = shouldRunTurboDevTest()
+  const { turbo, experimental } = shouldRunTurboDevTest()
+  const shouldRunTurboDev = turbo || experimental
   const shouldSkip =
     (runningEnv === 'turbo' && !shouldRunTurboDev) ||
     (runningEnv === 'default' && shouldRunTurboDev)

test/lib/turbo.ts

@@ -9,9 +9,15 @@ let loggedTurbopack = false
  * it makes hard to conform with existing lint rules. Instead, starting off from manual fixture setup and
  * update test cases accordingly as turbopack changes enable more test cases.
  */
-export function shouldRunTurboDevTest(): boolean {
+export function shouldRunTurboDevTest(): {
+  turbo: boolean
+  experimental: boolean
+} {
   if (!!process.env.TEST_WASM) {
-    return false
+    return {
+      turbo: false,
+      experimental: false,
+    }
   }
 
   const shouldRunTurboDev = !!process.env.TURBOPACK
@@ -21,6 +27,17 @@ export function shouldRunTurboDevTest(): boolean {
     )
     loggedTurbopack = true
   }
+  const shouldRunExperimental = !!process.env.__EXPERIMENTAL_TURBO
 
-  return shouldRunTurboDev
+  if (shouldRunExperimental && !loggedTurbopack) {
+    require('console').log(
+      `Running tests with experimental turbopack because environment variable is set`
+    )
+    loggedTurbopack = true
+  }
+
+  return {
+    turbo: shouldRunTurboDev,
+    experimental: shouldRunExperimental,
+  }
 }