test: Run E2E tests in isolated tmp directory

Author: mydea

.github/workflows/build.yml

@@ -920,19 +920,24 @@ jobs:
         env:
           E2E_TEST_PUBLISH_SCRIPT_NODE_VERSION: ${{ steps.versions.outputs.node }}
 
+      - name: Copy to temp
+        run:
+          yarn ci:copy-to-temp ./test-applications/${{ matrix.test-application }} ${{ runner.temp  }}/test-application
+        working-directory: dev-packages/e2e-tests
+
       - name: Build E2E app
-        working-directory: dev-packages/e2e-tests/test-applications/${{ matrix.test-application }}
+        working-directory: ${{ runner.temp  }}/test-application
         timeout-minutes: 7
         run: pnpm ${{ matrix.build-command || 'test:build' }}
 
       - name: Install Playwright
         uses: ./.github/actions/install-playwright
         with:
           browsers: chromium
-          cwd: dev-packages/e2e-tests/test-applications/${{ matrix.test-application }}
+          cwd: ${{ runner.temp  }}/test-application
 
       - name: Run E2E test
-        working-directory: dev-packages/e2e-tests/test-applications/${{ matrix.test-application }}
+        working-directory: ${{ runner.temp  }}/test-application
         timeout-minutes: 10
         run: pnpm test:assert
 
@@ -941,7 +946,7 @@ jobs:
         if: failure()
         with:
           name: playwright-traces-job_e2e_playwright_tests-${{ matrix.test-application}}
-          path: dev-packages/e2e-tests/test-applications/${{ matrix.test-application}}/test-results
+          path: ${{ runner.temp  }}/test-application/test-results
           overwrite: true
           retention-days: 7
 
@@ -955,7 +960,7 @@ jobs:
         if: always()
         with:
           name: E2E Test Dump (${{ matrix.label || matrix.test-application }})
-          path: dev-packages/e2e-tests/test-applications/${{ matrix.test-application }}/event-dumps
+          path: ${{ runner.temp  }}/test-application/event-dumps
           overwrite: true
           retention-days: 7
           if-no-files-found: ignore

dev-packages/e2e-tests/ciCopyToTemp.ts

@@ -0,0 +1,19 @@
+/* eslint-disable no-console */
+
+import { copyToTemp } from './lib/copyToTemp';
+
+async function run(): Promise<void> {
+  const originalPath = process.argv[2];
+  const tmpDirPath = process.argv[3];
+
+  if (!originalPath || !tmpDirPath) {
+    throw new Error('Original path and tmp dir path are required');
+  }
+
+  console.log(`Copying ${originalPath} to ${tmpDirPath}...`);
+
+  await copyToTemp(originalPath, tmpDirPath);
+}
+
+// eslint-disable-next-line @typescript-eslint/no-floating-promises
+run();

dev-packages/e2e-tests/lib/copyToTemp.ts

@@ -0,0 +1,32 @@
+import { readFileSync, writeFileSync } from 'fs';
+import { cp } from 'fs/promises';
+import { join, relative, resolve } from 'path';
+
+export async function copyToTemp(originalPath: string, tmpDirPath: string): Promise<void> {
+  // copy files to tmp dir
+  await cp(originalPath, tmpDirPath, { recursive: true });
+
+  fixPackageJson(tmpDirPath);
+}
+
+function fixPackageJson(cwd: string): void {
+  const packageJsonPath = join(cwd, 'package.json');
+  const packageJson = JSON.parse(readFileSync(packageJsonPath, 'utf8')) as {
+    devDependencies?: Record<string, string>;
+    volta?: Record<string, unknown>;
+  };
+
+  // 1. Fix file dependencies
+  if (packageJson.devDependencies?.['@sentry-internal/test-utils']) {
+    const relativePath = resolve(relative(cwd, join(__dirname, '../test-utils')));
+    packageJson.devDependencies['@sentry-internal/test-utils'] = `link:${relativePath}`;
+  }
+
+  // 2. Fix volta extends
+  if (packageJson.volta?.extends === '../../package.json') {
+    const voltaPath = resolve(relative(cwd, join(__dirname, './package.json')));
+    packageJson.volta.extends = voltaPath;
+  }
+
+  writeFileSync(packageJsonPath, JSON.stringify(packageJson, null, 2));
+}

dev-packages/e2e-tests/package.json

@@ -16,6 +16,7 @@
     "clean": "rimraf tmp node_modules && yarn clean:test-applications && yarn clean:pnpm",
     "ci:build-matrix": "ts-node ./lib/getTestMatrix.ts",
     "ci:build-matrix-optional": "ts-node ./lib/getTestMatrix.ts --optional=true",
+    "ci:copy-to-temp": "ts-node ./ciCopyToTemp.ts",
     "clean:test-applications": "rimraf --glob test-applications/**/{node_modules,dist,build,.next,.nuxt,.sveltekit,.react-router,.astro,.output,pnpm-lock.yaml,.last-run.json,test-results}",
     "clean:pnpm": "pnpm store prune"
   },

dev-packages/e2e-tests/run.ts

@@ -1,8 +1,11 @@
 /* eslint-disable no-console */
 import { spawn } from 'child_process';
 import * as dotenv from 'dotenv';
+import { mkdtemp, rm } from 'fs/promises';
 import { sync as globSync } from 'glob';
-import { resolve } from 'path';
+import { tmpdir } from 'os';
+import { join, resolve } from 'path';
+import { copyToTemp } from './lib/copyToTemp';
 import { registrySetup } from './registrySetup';
 
 const DEFAULT_DSN = 'https://username@domain/123';
@@ -39,7 +42,7 @@ async function run(): Promise<void> {
   dotenv.config();
 
   // Allow to run a single app only via `yarn test:run <app-name>`
-  const appName = process.argv[2];
+  const appName = process.argv[2] || '';
 
   const dsn = process.env.E2E_TEST_DSN || DEFAULT_DSN;
 
@@ -73,13 +76,20 @@ async function run(): Promise<void> {
     console.log('');
 
     for (const testAppPath of testAppPaths) {
-      const cwd = resolve('test-applications', testAppPath);
+      const originalPath = resolve('test-applications', testAppPath);
+      const tmpDirPath = await mkdtemp(join(tmpdir(), `sentry-e2e-tests-${appName}-`));
 
-      console.log(`Building ${testAppPath}...`);
+      await copyToTemp(originalPath, tmpDirPath);
+      const cwd = tmpDirPath;
+
+      console.log(`Building ${testAppPath} in ${tmpDirPath}...`);
       await asyncExec('pnpm test:build', { env, cwd });
 
       console.log(`Testing ${testAppPath}...`);
       await asyncExec('pnpm test:assert', { env, cwd });
+
+      // clean up (although this is tmp, still nice to do)
+      await rm(tmpDirPath, { recursive: true });
     }
   } catch (error) {
     console.error(error);

dev-packages/e2e-tests/test-applications/nuxt-3-dynamic-import/package.json

@@ -15,6 +15,7 @@
   },
   "dependencies": {
     "@sentry/nuxt": "latest || *",
+    "@sentry/core": "latest || *",
     "nuxt": "^3.14.0"
   },
   "devDependencies": {
@@ -26,5 +27,8 @@
       "nitropack": "~2.9.7",
       "ofetch": "^1.4.0"
     }
+  },
+  "volta": {
+    "extends": "../../package.json"
   }
 }

dev-packages/e2e-tests/test-applications/nuxt-3-min/package.json

@@ -17,6 +17,7 @@
   },
   "dependencies": {
     "@sentry/nuxt": "latest || *",
+    "@sentry/core": "latest || *",
     "nuxt": "3.7.0"
   },
   "devDependencies": {
@@ -26,5 +27,8 @@
   "overrides": {
     "nitropack": "2.10.0",
     "ofetch": "1.4.0"
+  },
+  "volta": {
+    "extends": "../../package.json"
   }
 }

dev-packages/e2e-tests/test-applications/nuxt-3-top-level-import/package.json

@@ -15,10 +15,14 @@
   },
   "dependencies": {
     "@sentry/nuxt": "latest || *",
+    "@sentry/core": "latest || *",
     "nuxt": "^3.14.0"
   },
   "devDependencies": {
     "@playwright/test": "~1.50.0",
     "@sentry-internal/test-utils": "link:../../../test-utils"
+  },
+  "volta": {
+    "extends": "../../package.json"
   }
 }

dev-packages/e2e-tests/test-applications/nuxt-3/package.json

@@ -17,6 +17,7 @@
   },
   "dependencies": {
     "@sentry/nuxt": "latest || *",
+    "@sentry/core": "latest || *",
     "nuxt": "^3.14.0"
   },
   "devDependencies": {
@@ -30,5 +31,8 @@
         "label": "nuxt-3 (canary)"
       }
     ]
+  },
+  "volta": {
+    "extends": "../../package.json"
   }
 }

dev-packages/e2e-tests/test-applications/nuxt-4/package.json

@@ -18,6 +18,7 @@
   "dependencies": {
     "@pinia/nuxt": "^0.5.5",
     "@sentry/nuxt": "latest || *",
+    "@sentry/core": "latest || *",
     "nuxt": "^4.0.0-alpha.4"
   },
   "devDependencies": {
@@ -27,6 +28,9 @@
   "overrides": {
     "@vercel/nft": "0.27.4"
   },
+  "volta": {
+    "extends": "../../package.json"
+  },
   "sentryTest": {
     "optionalVariants": [
       {