test: copy playground per worker

Author: posva

e2e/hmr/.gitignore

@@ -1 +1 @@
-playground-tmp
+playground-tmp-*

e2e/hmr/fixtures/vite-server.ts

@@ -9,29 +9,32 @@ type ViteFixtures = {
   devServer: ViteDevServer
   baseURL: string
   projectRoot: string
-}
-
-export function applyEditFile(
-  sourceFilePath: string,
-  newContentFilePath: string
-) {
-  fs.writeFileSync(
-    path.join(projectRoot, sourceFilePath),
-    fs.readFileSync(path.join(projectRoot, newContentFilePath), 'utf8'),
-    'utf8'
-  )
+  applyEditFile: (sourceFilePath: string, newContentFilePath: string) => void
 }
 
 const sourceDir = fileURLToPath(new URL('../playground', import.meta.url))
-const fixtureDir = fileURLToPath(new URL('../playground-tmp', import.meta.url))
-const projectRoot = path.resolve(fixtureDir)
 
 export const test = base.extend<ViteFixtures>({
-  projectRoot,
+  // @ts-expect-error: we need to compute projectRoot per worker
+  projectRoot: [
+    async ({}, use, testInfo) => {
+      const fixtureDir = fileURLToPath(
+        new URL(
+          `../playground-tmp-worker-${testInfo.workerIndex}`,
+          import.meta.url
+        )
+      )
+      const projectRoot = path.resolve(fixtureDir)
+      await use(projectRoot)
+    },
+    { scope: 'worker' },
+  ],
 
   // @ts-expect-error: type matched what is passed to use(server)
   devServer: [
-    async ({}, use) => {
+    async ({ projectRoot }, use) => {
+      const fixtureDir = projectRoot
+
       fs.rmSync(fixtureDir, { force: true, recursive: true })
       fs.cpSync(sourceDir, fixtureDir, {
         recursive: true,
@@ -73,6 +76,19 @@ export const test = base.extend<ViteFixtures>({
     const addr = http.address() as AddressInfo
     await use(`http://127.0.0.1:${addr.port}`)
   },
+
+  applyEditFile: async ({ projectRoot }, use) => {
+    await use(function applyEdit(
+      sourceFilePath: string,
+      newContentFilePath: string
+    ) {
+      fs.writeFileSync(
+        path.join(projectRoot, sourceFilePath),
+        fs.readFileSync(path.join(projectRoot, newContentFilePath), 'utf8'),
+        'utf8'
+      )
+    })
+  },
 })
 
 export { expect }

e2e/hmr/hmr.spec.ts

@@ -1,5 +1,5 @@
 import { Page } from '@playwright/test'
-import { test, expect, applyEditFile } from './fixtures/vite-server'
+import { test, expect } from './fixtures/vite-server'
 
 test.describe('Pages HMR', () => {
   let hmrToken: number = -1
@@ -24,7 +24,11 @@ test.describe('Pages HMR', () => {
       .toBe(hmrToken)
   })
 
-  test('applies meta changes in <route> block', async ({ page, baseURL }) => {
+  test('applies meta changes in <route> block', async ({
+    page,
+    baseURL,
+    applyEditFile,
+  }) => {
     await page.goto(baseURL + '/')
 
     await expect(page.locator('[data-testid="meta-hello"]')).toHaveText('')
@@ -38,7 +42,11 @@ test.describe('Pages HMR', () => {
     await expect(page.locator('[data-testid="meta-hello"]')).toHaveText('world')
   })
 
-  test('applies name changes via definePage', async ({ page, baseURL }) => {
+  test('applies name changes via definePage', async ({
+    page,
+    baseURL,
+    applyEditFile,
+  }) => {
     await page.goto(baseURL + '/hmr-name')
 
     await expect(page.locator('[data-testid="route-name"]')).toHaveText(
@@ -59,6 +67,7 @@ test.describe('Pages HMR', () => {
   test.skip('applies path changes via definePage', async ({
     page,
     baseURL,
+    applyEditFile,
   }) => {
     await page.goto(baseURL + '/hmr-path')
 
@@ -83,6 +92,7 @@ test.describe('Pages HMR', () => {
   test.skip('applies params parsers via definePage', async ({
     page,
     baseURL,
+    applyEditFile,
   }) => {
     await page.goto(baseURL + '/hmr-params-123')
 
@@ -108,6 +118,7 @@ test.describe('Pages HMR', () => {
   test.skip('applies meta changes via definePage', async ({
     page,
     baseURL,
+    applyEditFile,
   }) => {
     await page.goto(baseURL + '/hmr-meta')
 
@@ -122,7 +133,11 @@ test.describe('Pages HMR', () => {
     await expect(page.locator('[data-testid="meta-hello"]')).toHaveText('world')
   })
 
-  test.skip('applies alias via definePage', async ({ page, baseURL }) => {
+  test.skip('applies alias via definePage', async ({
+    page,
+    baseURL,
+    applyEditFile,
+  }) => {
     await page.goto(baseURL + '/hmr-alias')
 
     await expect(page.locator('[data-testid="route-path"]')).toHaveText(
@@ -143,7 +158,11 @@ test.describe('Pages HMR', () => {
     )
   })
 
-  test.skip('updates definePage properties', async ({ page, baseURL }) => {
+  test.skip('updates definePage properties', async ({
+    page,
+    baseURL,
+    applyEditFile,
+  }) => {
     await page.goto(baseURL + '/hmr-update')
 
     await expect(page.locator('[data-testid="meta-foo"]')).toHaveText('bar')

playwright.config.ts

@@ -7,9 +7,8 @@ export default defineConfig({
   forbidOnly: !!process.env.CI,
   // no retries because we have a setup
   retries: 0,
-  // FIXME: handle concurrency for temp folders
-  workers: 1,
-  // workers: process.env.CI ? 1 : undefined,
+  // Each worker gets its own isolated temp folder
+  workers: process.env.CI ? 1 : undefined,
   reporter: [
     // for console logs
     ['list'],