chore(e2e-tests): Use tarball symlinks for E2E tests instead of verdaccio

.agents/skills/e2e/SKILL.md

@@ -116,7 +116,7 @@ All tests completed successfully. Your SDK changes work correctly with this test
 
 - **No tarballs found**: Run `yarn build && yarn build:tarball` at repository root
 - **Test app not found**: List available apps and ask user to clarify
-- **Verdaccio not running**: Tests should start Verdaccio automatically, but if issues occur, check Docker
+- **Packed tarballs missing**: Run `yarn build:tarball` at the repo root, then `yarn test:prepare` in `dev-packages/e2e-tests`
 - **Build failures**: Fix build errors before running tests
 
 ## Common Test Applications

.github/workflows/build.yml

@@ -961,18 +961,24 @@ jobs:
  if: steps.restore-tarball-cache.outputs.cache-hit != 'true'
  run: yarn build:tarball
 
- - name: Validate Verdaccio
- run: yarn test:validate
+ - name: Prepare e2e tests
+ run: yarn test:prepare
  working-directory: dev-packages/e2e-tests
 
- - name: Prepare Verdaccio
- run: yarn test:prepare
+ - name: Validate e2e tests setup
+ run: yarn test:validate
  working-directory: dev-packages/e2e-tests
 
  - 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: Add pnpm overrides
+ run:
+ yarn ci:pnpm-overrides ${{ runner.temp }}/test-application ${{ github.workspace
+ }}/dev-packages/e2e-tests/packed
+ working-directory: dev-packages/e2e-tests
+
  - name: Build E2E app
  working-directory: ${{ runner.temp }}/test-application
  timeout-minutes: 7
@@ -1071,18 +1077,24 @@ jobs:
  if: steps.restore-tarball-cache.outputs.cache-hit != 'true'
  run: yarn build:tarball
 
- - name: Validate Verdaccio
- run: yarn test:validate
+ - name: Prepare E2E tests
+ run: yarn test:prepare
  working-directory: dev-packages/e2e-tests
 
- - name: Prepare Verdaccio
- run: yarn test:prepare
+ - name: Validate test setup
+ run: yarn test:validate
  working-directory: dev-packages/e2e-tests
 
  - 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: Add pnpm overrides
+ run:
+ yarn ci:pnpm-overrides ${{ runner.temp }}/test-application ${{ github.workspace
+ }}/dev-packages/e2e-tests/packed
+ working-directory: dev-packages/e2e-tests
+
  - name: Build E2E app
  working-directory: ${{ runner.temp }}/test-application
  timeout-minutes: 7

.github/workflows/canary.yml

@@ -140,18 +140,24 @@ jobs:
  path: ${{ env.CACHED_BUILD_PATHS }}
  key: canary-${{ env.HEAD_COMMIT }}
 
- - name: Validate Verdaccio
- run: yarn test:validate
+ - name: Prepare e2e tests
+ run: yarn test:prepare
  working-directory: dev-packages/e2e-tests
 
- - name: Prepare Verdaccio
- run: yarn test:prepare
+ - name: Validate test setup
+ run: yarn test:validate
  working-directory: dev-packages/e2e-tests
 
  - 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: Add pnpm overrides
+ run:
+ yarn ci:pnpm-overrides ${{ runner.temp }}/test-application ${{ github.workspace
+ }}/dev-packages/e2e-tests/packed
+ working-directory: dev-packages/e2e-tests
+
  - name: Build E2E app
  working-directory: ${{ runner.temp }}/test-application
  timeout-minutes: 7

.gitignore

@@ -39,9 +39,6 @@ local.log
 
 .rpt2_cache
 
-# verdaccio local registry (e2e tests)
-dev-packages/e2e-tests/verdaccio-config/storage/
-
 lint-results.json
 trace.zip
 

dev-packages/e2e-tests/.gitignore

@@ -4,3 +4,4 @@ tmp
 .tmp_build_stderr
 pnpm-lock.yaml
 .last-run.json
+packed

dev-packages/e2e-tests/ciCopyToTemp.ts

@@ -15,5 +15,7 @@ async function run(): Promise<void> {
  await copyToTemp(originalPath, tmpDirPath);
 }
 
-// eslint-disable-next-line @typescript-eslint/no-floating-promises
-run();
+run().catch(error => {
+ console.error(error);
+ process.exit(1);
+});

dev-packages/e2e-tests/ciPnpmOverrides.ts

@@ -0,0 +1,20 @@
+/* eslint-disable no-console */
+
+import { addPnpmOverrides } from './lib/pnpmOverrides';
+import * as path from 'path';
+
+async function run(): Promise<void> {
+ const tmpDirPath = process.argv[2];
+ const packedDirPath = process.argv[3];
+
+ if (!tmpDirPath || !packedDirPath) {
+ throw new Error('Tmp dir path and packed dir path are required');
+ }
+
+ await addPnpmOverrides(path.resolve(tmpDirPath), path.resolve(packedDirPath));
+}
+
+run().catch(error => {
+ console.error(error);
+ process.exit(1);
+});

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

@@ -1,7 +1,7 @@
 /* eslint-disable no-console */
 import { readFileSync, writeFileSync } from 'fs';
 import { cp } from 'fs/promises';
-import { join } from 'path';
+import { isAbsolute, join, resolve } from 'path';
 
 export async function copyToTemp(originalPath: string, tmpDirPath: string): Promise<void> {
  // copy files to tmp dir
@@ -35,7 +35,7 @@ function fixPackageJson(cwd: string): void {
  const extendsPath = packageJson.volta.extends;
  // We add a virtual dir to ensure that the relative depth is consistent
  // dirPath is relative to ./../test-applications/xxx
- const newPath = join(__dirname, 'virtual-dir/', extendsPath);
+ const newPath = resolve(__dirname, 'virtual-dir/', extendsPath);
  packageJson.volta.extends = newPath;
  console.log(`Fixed volta.extends to ${newPath}`);
  } else {
@@ -45,17 +45,24 @@ function fixPackageJson(cwd: string): void {
  writeFileSync(packageJsonPath, JSON.stringify(packageJson, null, 2));
 }
 
-function fixFileLinkDependencies(dependencyObj: Record<string, string>): void {
+// Exported for pnpmOverrides as well
+export function fixFileLinkDependencies(dependencyObj: Record<string, string>): void {
  for (const [key, value] of Object.entries(dependencyObj)) {
- if (value.startsWith('link:')) {
- const dirPath = value.replace('link:', '');
-
- // We add a virtual dir to ensure that the relative depth is consistent
- // dirPath is relative to ./../test-applications/xxx
- const newPath = join(__dirname, 'virtual-dir/', dirPath);
+ const prefix = value.startsWith('link:') ? 'link:' : value.startsWith('file:') ? 'file:' : null;
+ if (!prefix) {
+ continue;
+ }
 
- dependencyObj[key] = `link:${newPath}`;
- console.log(`Fixed ${key} dependency to ${newPath}`);
+ const dirPath = value.slice(prefix.length);
+ if (isAbsolute(dirPath)) {
+ continue;
  }
+
+ // We add a virtual dir to ensure that the relative depth is consistent
+ // dirPath is relative to ./../test-applications/xxx
+ const absPath = resolve(__dirname, 'virtual-dir', dirPath);
+
+ dependencyObj[key] = `${prefix}${absPath}`;
+ console.log(`Fixed ${key} dependency to ${absPath}`);
  }
 }

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

@@ -0,0 +1,60 @@
+import * as path from 'path';
+import * as fs from 'fs';
+import { sync as globSync } from 'glob';
+
+const E2E_TESTS_ROOT = path.resolve(__dirname, '..');
+const REPOSITORY_ROOT = path.resolve(E2E_TESTS_ROOT, '../..');
+
+/**
+ * Workspace @sentry and @sentry-internal packages that have a built tarball for the E2E version.
+ * @returns The names of the published Sentry tarball packages.
+ */
+export function getPublishedSentryTarballPackageNames(): string[] {
+ const version = getE2eTestsPackageVersion();
+ const names: string[] = [];
+
+ for (const packageJsonPath of globSync('packages/*/package.json', {
+ cwd: REPOSITORY_ROOT,
+ absolute: true,
+ })) {
+ const pkg = readJson<{ name?: string }>(packageJsonPath);
+ const name = pkg.name;
+ if (!name || (!name.startsWith('@sentry/') && !name.startsWith('@sentry-internal/'))) {
+ continue;
+ }
+ const packageDir = path.dirname(packageJsonPath);
+ const tarball = path.join(packageDir, versionedTarballFilename(name, version));
+ if (fs.existsSync(tarball)) {
+ names.push(name);
+ }
+ }
+
+ return names.sort();
+}
+
+/** Stable symlink name in `packed/` (no version segment). */
+export function packedSymlinkFilename(packageName: string): string {
+ return `${npmPackBasename(packageName)}-packed.tgz`;
+}
+
+/**
+ * Versioned tarball filename produced by `npm pack` in a package directory.
+ */
+export function versionedTarballFilename(packageName: string, version: string): string {
+ return `${npmPackBasename(packageName)}-${version}.tgz`;
+}
+
+/**
+ * npm pack tarball basename (without version and .tgz), e.g. `@sentry/core` -> `sentry-core`.
+ */
+function npmPackBasename(packageName: string): string {
+ return packageName.replace(/^@/, '').replace(/\//g, '-');
+}
+
+function readJson<T>(filePath: string): T {
+ return JSON.parse(fs.readFileSync(filePath, 'utf8')) as T;
+}
+
+function getE2eTestsPackageVersion(): string {
+ return readJson<{ version: string }>(path.join(E2E_TESTS_ROOT, 'package.json')).version;
+}

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

@@ -0,0 +1,43 @@
+import { readFile, writeFile } from 'fs/promises';
+import * as path from 'path';
+import { getPublishedSentryTarballPackageNames, packedSymlinkFilename } from './packedTarballUtils';
+import { fixFileLinkDependencies } from './copyToTemp';
+
+/**
+ * For a given temp test application directory, add pnpm.overrides to pin the internal Sentry packages to the packed tarballs.
+ * This is used to ensure that the test application uses the correct version of the internal Sentry packages.
+ * @param tmpDirPath - The temporary directory path of the test application.
+ * @param packedDirPath - The path to the packed tarballs.
+ * @param packageNames - The names of the internal Sentry packages to pin to the packed tarballs.
+ * @returns
+ */
+export async function addPnpmOverrides(tmpDirPath: string, packedDirPath: string): Promise<void> {
+ const packageJsonPath = path.join(tmpDirPath, 'package.json');
+ const packageJson = JSON.parse(await readFile(packageJsonPath, 'utf8')) as {
+ pnpm?: { overrides?: Record<string, string> };
+ };
+
+ const overrides: Record<string, string> = {};
+
+ const packageNames = getPublishedSentryTarballPackageNames();
+
+ for (const packageName of packageNames) {
+ overrides[packageName] = `file:${packedDirPath}/${packedSymlinkFilename(packageName)}`;
+ }
+
+ const fixedOverrides = packageJson.pnpm?.overrides ?? {};
+ fixFileLinkDependencies(fixedOverrides);
+
+ packageJson.pnpm = {
+ ...packageJson.pnpm,
+ overrides: {
+ ...overrides,
+ ...fixedOverrides,
+ },
+ };
+
+ // oxlint-disable-next-line no-console
+ console.log(`Added ${packageNames.length} internal Sentry packages to pnpm.overrides`);
+
+ await writeFile(packageJsonPath, JSON.stringify(packageJson, null, 2));
+}