Update yarn PnP tests and disable swc file reading for PnP (#33236)

* Update yarn PnP tests and disable swc file reading for PnP

* update job

* Update test

* add env variable

* update destory

* test one

* bump timeout

* update pnp install command

* only run pnp test

* add more logs

* handle exit signal

* dont inherit stdio for install

* update server start

* re-add test type

* add build log

* additional logging

* update build command

* remove separate timeout

* update install command

* install separate for better time info

* add cache pre-warming

* update yarn config

* enable other pnp tests

* Separate out tests

* fix-lint

* update path

* update test concurrency for isolated tests

* update retries

* Revert "update test concurrency for isolated tests"

This reverts commit 3a6e924.

* re-enable production tests

* apply suggestions

.github/workflows/build_test_deploy.yml

@@ -347,35 +347,6 @@ jobs:
       - run: xvfb-run node run-tests.js test/integration/with-electron/test/index.test.js
         if: ${{needs.build.outputs.docsChange != 'docs only change'}}
 
-  testYarnPnP:
-    runs-on: ubuntu-latest
-    needs: [build, build-native-dev]
-    env:
-      NODE_OPTIONS: '--unhandled-rejections=strict'
-      YARN_COMPRESSION_LEVEL: '0'
-    steps:
-      - name: Setup node
-        uses: actions/setup-node@v2
-        if: ${{ steps.docs-change.outputs.docsChange != 'docs only change' }}
-        with:
-          node-version: 14
-
-      - uses: actions/cache@v2
-        if: ${{needs.build.outputs.docsChange != 'docs only change'}}
-        id: restore-build
-        with:
-          path: ./*
-          key: ${{ github.sha }}-${{ github.run_number }}-${{ github.run_attempt }}
-
-      - uses: actions/download-artifact@v2
-        if: ${{needs.build.outputs.docsChange != 'docs only change'}}
-        with:
-          name: next-swc-dev-binary
-          path: packages/next-swc/native
-
-      - run: bash ./scripts/test-pnp.sh
-        if: ${{needs.build.outputs.docsChange != 'docs only change'}}
-
   testsPass:
     name: thank you, next
     runs-on: ubuntu-latest
@@ -387,7 +358,6 @@ jobs:
         checkPrecompiled,
         testIntegration,
         testUnit,
-        testYarnPnP,
         testDev,
         testProd,
       ]

packages/next/build/webpack/loaders/next-swc-loader.js

@@ -101,6 +101,8 @@ export function pitch() {
   ;(async () => {
     let loaderOptions = this.getOptions() || {}
     if (
+      // TODO: investigate swc file reading in PnP mode?
+      !process.versions.pnp &&
       loaderOptions.fileReading &&
       !EXCLUDED_PATHS.test(this.resourcePath) &&
       this.loaders.length - 1 === this.loaderIndex &&

run-tests.js

@@ -36,6 +36,7 @@ const cleanUpAndExit = async (code) => {
   if (process.env.NEXT_TEST_STARTER) {
     await fs.remove(process.env.NEXT_TEST_STARTER)
   }
+  console.log(`exiting with code ${code}`)
   process.exit(code)
 }
 

test/e2e/yarn-pnp/test/pwa-example.test.ts

@@ -0,0 +1,5 @@
+import { runTests } from './utils'
+
+describe('yarn PnP', () => {
+  runTests('progressive-web-app')
+})

test/e2e/yarn-pnp/test/utils.ts

@@ -0,0 +1,49 @@
+import fs from 'fs-extra'
+import { join } from 'path'
+import { fetchViaHTTP } from 'next-test-utils'
+import { createNext, FileRef } from 'e2e-utils'
+import { NextInstance } from 'test/lib/next-modes/base'
+
+jest.setTimeout(2 * 60 * 1000)
+
+export function runTests(example = '') {
+  let next: NextInstance
+
+  beforeAll(async () => {
+    const srcDir = join(__dirname, '../../../../examples', example)
+    const srcFiles = await fs.readdir(srcDir)
+
+    const packageJson = await fs.readJson(join(srcDir, 'package.json'))
+
+    next = await createNext({
+      files: srcFiles.reduce((prev, file) => {
+        if (file !== 'package.json') {
+          prev[file] = new FileRef(join(srcDir, file))
+        }
+        return prev
+      }, {} as { [key: string]: FileRef }),
+      dependencies: {
+        ...packageJson.dependencies,
+        ...packageJson.devDependencies,
+      },
+      installCommand: ({ dependencies }) => {
+        const pkgs = Object.keys(dependencies).reduce((prev, cur) => {
+          prev.push(`${cur}@${dependencies[cur]}`)
+          return prev
+        }, [] as string[])
+        return `yarn set version berry && yarn config set enableGlobalCache true && yarn config set compressionLevel 0 && yarn add ${pkgs.join(
+          ' '
+        )}`
+      },
+      buildCommand: `yarn next build --no-lint`,
+      startCommand: (global as any).isNextDev ? `yarn next` : `yarn next start`,
+    })
+  })
+  afterAll(() => next?.destroy())
+
+  it(`should compile and serve the index page correctly ${example}`, async () => {
+    const res = await fetchViaHTTP(next.url, '/')
+    expect(res.status).toBe(200)
+    expect(await res.text()).toContain('<html')
+  })
+}

test/e2e/yarn-pnp/test/with-eslint.test.ts

@@ -0,0 +1,5 @@
+import { runTests } from './utils'
+
+describe('yarn PnP', () => {
+  runTests('with-eslint')
+})

test/e2e/yarn-pnp/test/with-mdx.test.ts

@@ -0,0 +1,5 @@
+import { runTests } from './utils'
+
+describe('yarn PnP', () => {
+  runTests('with-mdx')
+})

test/e2e/yarn-pnp/test/with-next-sass.test.ts

@@ -0,0 +1,5 @@
+import { runTests } from './utils'
+
+describe('yarn PnP', () => {
+  runTests('with-next-sass')
+})

test/e2e/yarn-pnp/test/with-styled-components.test.ts

@@ -0,0 +1,5 @@
+import { runTests } from './utils'
+
+describe('yarn PnP', () => {
+  runTests('with-styled-components')
+})

test/e2e/yarn-pnp/test/with-typescript.test.ts

@@ -0,0 +1,5 @@
+import { runTests } from './utils'
+
+describe('yarn PnP', () => {
+  runTests('with-typescript')
+})

test/lib/create-next-install.js

@@ -2,10 +2,11 @@ const os = require('os')
 const path = require('path')
 const execa = require('execa')
 const fs = require('fs-extra')
+const childProcess = require('child_process')
 const { linkPackages } =
   require('../../.github/actions/next-stats-action/src/prepare/repo-setup')()
 
-async function createNextInstall(dependencies) {
+async function createNextInstall(dependencies, installCommand) {
   const tmpDir = await fs.realpath(process.env.NEXT_TEST_DIR || os.tmpdir())
   const origRepoDir = path.join(__dirname, '../../')
   const installDir = path.join(tmpDir, `next-install-${Date.now()}`)
@@ -45,30 +46,46 @@ async function createNextInstall(dependencies) {
   }
 
   const pkgPaths = await linkPackages(tmpRepoDir)
+  const combinedDependencies = {
+    ...dependencies,
+    next: pkgPaths.get('next'),
+  }
 
   await fs.ensureDir(installDir)
   await fs.writeFile(
     path.join(installDir, 'package.json'),
     JSON.stringify(
       {
-        dependencies: {
-          ...dependencies,
-          next: pkgPaths.get('next'),
-        },
+        dependencies: combinedDependencies,
         private: true,
       },
       null,
       2
     )
   )
-  await execa('yarn', ['install'], {
-    cwd: installDir,
-    stdio: ['ignore', 'inherit', 'inherit'],
-    env: {
-      ...process.env,
-      YARN_CACHE_FOLDER: path.join(installDir, '.yarn-cache'),
-    },
-  })
+
+  if (installCommand) {
+    const installString =
+      typeof installCommand === 'function'
+        ? installCommand({ dependencies: combinedDependencies })
+        : installCommand
+
+    console.log('running install command', installString)
+
+    childProcess.execSync(installString, {
+      cwd: installDir,
+      stdio: ['ignore', 'inherit', 'inherit'],
+    })
+  } else {
+    await execa('yarn', ['install'], {
+      cwd: installDir,
+      stdio: ['ignore', 'inherit', 'inherit'],
+      env: {
+        ...process.env,
+        YARN_CACHE_FOLDER: path.join(installDir, '.yarn-cache'),
+      },
+    })
+  }
 
   await fs.remove(tmpRepoDir)
   return installDir

test/lib/e2e-utils.ts

@@ -1,20 +1,34 @@
 import path from 'path'
 import assert from 'assert'
 import { NextConfig } from 'next'
-import { NextInstance } from './next-modes/base'
+import { InstallCommand, NextInstance } from './next-modes/base'
 import { NextDevInstance } from './next-modes/next-dev'
 import { NextStartInstance } from './next-modes/next-start'
 
-const testFile = module.parent.filename
 const testsFolder = path.join(__dirname, '..')
 
+let testFile
+const testFileRegex = /\.test\.(js|tsx?)/
+
+const visitedModules = new Set()
+const checkParent = (mod) => {
+  if (!mod?.parent || visitedModules.has(mod)) return
+  testFile = mod.parent.filename || ''
+  visitedModules.add(mod)
+
+  if (!testFileRegex.test(testFile)) {
+    checkParent(mod.parent)
+  }
+}
+checkParent(module)
+
 process.env.TEST_FILE_PATH = testFile
 
 let testMode = process.env.NEXT_TEST_MODE
 
-if (!testFile.match(/\.test\.(js|tsx?)/)) {
+if (!testFileRegex.test(testFile)) {
   throw new Error(
-    'e2e-utils imported from non-test file (must end with .test.(js,ts,tsx)'
+    `e2e-utils imported from non-test file ${testFile} (must end with .test.(js,ts,tsx)`
   )
 }
 
@@ -97,6 +111,9 @@ export async function createNext(opts: {
   }
   nextConfig?: NextConfig
   skipStart?: boolean
+  installCommand?: InstallCommand
+  buildCommand?: string
+  startCommand?: string
 }): Promise<NextInstance> {
   try {
     if (nextInstance) {

test/lib/next-modes/base.ts

@@ -8,12 +8,18 @@ import { ChildProcess } from 'child_process'
 import { createNextInstall } from '../create-next-install'
 
 type Event = 'stdout' | 'stderr' | 'error' | 'destroy'
+export type InstallCommand =
+  | string
+  | ((ctx: { dependencies: { [key: string]: string } }) => string)
 
 export class NextInstance {
   protected files: {
     [filename: string]: string | FileRef
   }
   protected nextConfig?: NextConfig
+  protected installCommand?: InstallCommand
+  protected buildCommand?: string
+  protected startCommand?: string
   protected dependencies?: { [name: string]: string }
   protected events: { [eventName: string]: Set<any> }
   public testDir: string
@@ -27,6 +33,9 @@ export class NextInstance {
     files,
     dependencies,
     nextConfig,
+    installCommand,
+    buildCommand,
+    startCommand,
   }: {
     files: {
       [filename: string]: string | FileRef
@@ -35,10 +44,16 @@ export class NextInstance {
       [name: string]: string
     }
     nextConfig?: NextConfig
+    installCommand?: InstallCommand
+    buildCommand?: string
+    startCommand?: string
   }) {
     this.files = files
     this.dependencies = dependencies
     this.nextConfig = nextConfig
+    this.installCommand = installCommand
+    this.buildCommand = buildCommand
+    this.startCommand = startCommand
     this.events = {}
     this.isDestroyed = false
     this.isStopping = false
@@ -59,15 +74,23 @@ export class NextInstance {
       `next-test-${Date.now()}-${(Math.random() * 1000) | 0}`
     )
 
-    if (process.env.NEXT_TEST_STARTER && !this.dependencies) {
+    if (
+      process.env.NEXT_TEST_STARTER &&
+      !this.dependencies &&
+      !this.installCommand
+    ) {
       await fs.copy(process.env.NEXT_TEST_STARTER, this.testDir)
     } else if (!skipIsolatedNext) {
-      this.testDir = await createNextInstall({
-        react: 'latest',
-        'react-dom': 'latest',
-        ...this.dependencies,
-      })
+      this.testDir = await createNextInstall(
+        {
+          react: 'latest',
+          'react-dom': 'latest',
+          ...this.dependencies,
+        },
+        this.installCommand
+      )
     }
+    console.log('created next.js install, writing test files')
 
     for (const filename of Object.keys(this.files)) {
       const item = this.files[filename]
@@ -182,6 +205,7 @@ export class NextInstance {
     if (!process.env.NEXT_TEST_SKIP_CLEANUP) {
       await fs.remove(this.testDir)
     }
+    console.log(`destroyed next instance`)
   }
 
   public get url() {