test: organize react 18 tests (vercel#36003)

* Organize react 18 test cases, group invalid cases to speed up the regular test cases * Add `runDevSuite` and `runProdSuite` for group next dev/prod test cases ```js runDevSuite(name, appDir, { runTests: (context, env) => { ... }, beforeAll, afterAll, }) runProdvSuite(name, appDir, { runTests: (context, env) => { ... }, beforeAll, afterAll, }) ```
colinhacks · Apr 14, 2022 · 2dea887 · 2dea887
1 parent 02a81a2
commit 2dea887
Show file tree

Hide file tree

Showing 10 changed files with 181 additions and 210 deletions.
diff --git a/test/integration/import-assertion/test/index.test.js b/test/integration/import-assertion/test/index.test.js
@@ -1,37 +1,8 @@
 import { join } from 'path'
-import {
-  nextBuild,
-  nextStart,
-  launchApp,
-  killApp,
-  findPort,
-  renderViaHTTP,
-} from 'next-test-utils'
+import { renderViaHTTP, runDevSuite, runProdSuite } from 'next-test-utils'
 
 const appDir = join(__dirname, '../')
 
-function runSuite(suiteName, env, runTests) {
-  const context = { appDir }
-  describe(`${suiteName} ${env}`, () => {
-    if (env === 'prod') {
-      beforeAll(async () => {
-        context.appPort = await findPort()
-        await nextBuild(context.appDir)
-        context.server = await nextStart(context.appDir, context.appPort)
-      })
-    }
-    if (env === 'dev') {
-      beforeAll(async () => {
-        context.appPort = await findPort()
-        context.server = await launchApp(context.appDir, context.appPort)
-      })
-    }
-    afterAll(async () => await killApp(context.server))
-
-    runTests(context, env)
-  })
-}
-
 function basic(context) {
   it('should handle json assertions', async () => {
     const esHtml = await renderViaHTTP(context.appPort, '/es')
@@ -41,5 +12,5 @@ function basic(context) {
   })
 }
 
-runSuite('import-assertion', 'dev', basic)
-runSuite('import-assertion', 'prod', basic)
+runDevSuite('import-assertion', appDir, { runTests: basic })
+runProdSuite('import-assertion', appDir, { runTests: basic })
diff --git a/test/integration/react-18-invalid-config/index.test.js b/test/integration/react-18-invalid-config/index.test.js
@@ -2,19 +2,47 @@
 
 import fs from 'fs-extra'
 import { join } from 'path'
-import { File, nextBuild } from 'next-test-utils'
+import {
+  File,
+  nextBuild,
+  runDevSuite,
+  runProdSuite,
+  fetchViaHTTP,
+} from 'next-test-utils'
 
 const appDir = __dirname
 const nodeArgs = ['-r', join(appDir, '../../lib/react-17-require-hook.js')]
-const nextConfig = new File(join(appDir, 'next.config.js'))
 const reactDomPackagePah = join(appDir, 'node_modules/react-dom')
+const nextConfig = new File(join(appDir, 'next.config.js'))
+const documentPage = new File(join(appDir, 'pages/_document.js'))
+const indexPage = join(appDir, 'pages/index.js')
+const indexServerPage = join(appDir, 'pages/index.server.js')
+
+const documentWithGip = `
+import { Html, Head, Main, NextScript } from 'next/document'
+
+export default function Document() {
+  return (
+    <Html>
+      <Head />
+      <body>
+        <Main />
+        <NextScript />
+      </body>
+    </Html>
+  )
+}
+
+Document.getInitialProps = (ctx) => {
+  return ctx.defaultGetInitialProps(ctx)
+}
+`
 
-function writeNextConfig(config) {
+function writeNextConfig(config, reactVersion = 17) {
   const content = `
     const path = require('path')
-    module.exports = require(path.join(__dirname, '../../lib/with-react-17.js'))({ experimental: ${JSON.stringify(
-      config
-    )} })
+    const withReact = ${reactVersion} === 18 ? v => v : require(path.join(__dirname, '../../lib/with-react-17.js'))
+    module.exports = withReact({ experimental: ${JSON.stringify(config)} })
   `
   nextConfig.write(content)
 }
@@ -65,3 +93,36 @@ describe('React 17 with React 18 config', () => {
     expect(code).toBe(1)
   })
 })
+
+const documentSuite = {
+  runTests: (context, env) => {
+    if (env === 'dev') {
+      it('should error when custom _document has getInitialProps method', async () => {
+        const res = await fetchViaHTTP(context.appPort, '/')
+        expect(res.status).toBe(500)
+      })
+    } else {
+      it('should failed building', async () => {
+        expect(context.code).toBe(1)
+      })
+    }
+  },
+  beforeAll: async () => {
+    writeNextConfig(
+      {
+        serverComponents: true,
+      },
+      18
+    )
+    documentPage.write(documentWithGip)
+    await fs.rename(indexPage, indexServerPage)
+  },
+  afterAll: async () => {
+    documentPage.delete()
+    nextConfig.restore()
+    await fs.rename(indexServerPage, indexPage)
+  },
+}
+
+runDevSuite('Invalid custom document with gip', appDir, documentSuite)
+runProdSuite('Invalid custom document with gip', appDir, documentSuite)
diff --git a/test/integration/react-18/test/index.test.js b/test/integration/react-18/test/index.test.js
@@ -7,27 +7,23 @@ import {
   findPort,
   killApp,
   launchApp,
-  nextBuild,
-  nextStart,
   renderViaHTTP,
   hasRedbox,
   getRedboxHeader,
+  runDevSuite,
+  runProdSuite,
 } from 'next-test-utils'
 import concurrent from './concurrent'
 import basics from './basics'
 import strictMode from './strict-mode'
 import webdriver from 'next-webdriver'
 
-// overrides react and react-dom to v18
-const nodeArgs = []
 const appDir = join(__dirname, '../app')
 const nextConfig = new File(join(appDir, 'next.config.js'))
 const invalidPage = new File(join(appDir, 'pages/invalid.js'))
 
 describe('Basics', () => {
-  runTests('default setting with react 18', (context, env) =>
-    basics(context, env)
-  )
+  runTests('default setting with react 18', basics)
 })
 
 // React 18 with Strict Mode enabled might cause double invocation of lifecycle methods.
@@ -37,9 +33,7 @@ describe('Strict mode - dev', () => {
   beforeAll(async () => {
     nextConfig.replace('// reactStrictMode: true,', 'reactStrictMode: true,')
     context.appPort = await findPort()
-    context.server = await launchApp(context.appDir, context.appPort, {
-      nodeArgs,
-    })
+    context.server = await launchApp(context.appDir, context.appPort)
   })
 
   afterAll(() => {
@@ -84,42 +78,11 @@ function runTestsAgainstRuntime(runtime) {
   )
 }
 
-function runTest(env, name, fn, options) {
-  const context = { appDir }
-  describe(`${name} (${env})`, () => {
-    beforeAll(async () => {
-      context.appPort = await findPort()
-      context.stderr = ''
-      options?.beforeAll(env)
-      if (env === 'dev') {
-        context.server = await launchApp(context.appDir, context.appPort, {
-          nodeArgs,
-          onStderr(msg) {
-            context.stderr += msg
-          },
-        })
-      } else {
-        await nextBuild(context.appDir, [], { nodeArgs })
-        context.server = await nextStart(context.appDir, context.appPort, {
-          nodeArgs,
-          onStderr(msg) {
-            context.stderr += msg
-          },
-        })
-      }
-    })
-    afterAll(async () => {
-      options?.afterAll(env)
-      await killApp(context.server)
-    })
-    fn(context, env)
-  })
-}
-
 runTestsAgainstRuntime('edge')
 runTestsAgainstRuntime('nodejs')
 
-function runTests(name, fn, options) {
-  runTest('dev', name, fn, options)
-  runTest('prod', name, fn, options)
+function runTests(name, fn, opts) {
+  const suiteOptions = { ...opts, runTests: fn }
+  runDevSuite(name, appDir, suiteOptions)
+  runProdSuite(name, appDir, suiteOptions)
 }
diff --git a/test/integration/react-streaming-and-server-components/test/functions.js b/test/integration/react-streaming-and-server-components/test/functions.js
@@ -10,20 +10,23 @@ import { nextBuild } from './utils'
 export default function (context) {
   it('should not generate functions manifest when filesystem API is not enabled', async () => {
     // Make sure there is no existing functions manifest (caused by failed tests etc).
-    await fs.remove(join(context.appDir, '.next'))
+    const distDir = join(context.appDir, '.next')
+    await fs.remove(distDir)
     await nextBuild(context.appDir)
     const functionsManifestPath = join(
-      context.distDir,
+      distDir,
       'server',
       'functions-manifest.json'
     )
     expect(fs.existsSync(functionsManifestPath)).toBe(false)
     await fs.remove(join(context.appDir, '.next'))
   })
+
   it('should contain rsc paths in functions manifest', async () => {
+    const distDir = join(context.appDir, '.next')
     await nextBuild(context.appDir, { env: { ENABLE_FILE_SYSTEM_API: '1' } })
     const functionsManifestPath = join(
-      context.distDir,
+      distDir,
       'server',
       'functions-manifest.json'
     )