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

Author: mydea

.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

@@ -959,18 +959,22 @@ jobs:
         if: steps.restore-tarball-cache.outputs.cache-hit != 'true'
         run: yarn build:tarball
 
-      - name: Validate Verdaccio
+      - name: Validate packed tarball setup
         run: yarn test:validate
         working-directory: dev-packages/e2e-tests
 
-      - name: Prepare Verdaccio
+      - name: Prepare e2e tests
         run: yarn test:prepare
         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
@@ -1069,12 +1073,12 @@ 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

.github/workflows/canary.yml

@@ -140,18 +140,22 @@ 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/ciPnpmOverrides.ts

@@ -0,0 +1,19 @@
+/* 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));
+}
+
+// eslint-disable-next-line @typescript-eslint/no-floating-promises
+run();

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

@@ -0,0 +1,69 @@
+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`;
+}
+
+/**
+ * Relative POSIX path from `dev-packages/e2e-tests/packed/<symlink>` to
+ * `packages/<pkgDir>/<versionedTarball>`.
+ */
+export function relativeTarballPathFromPackedDir(packageDirName: string, packageName: string, version: string): string {
+  const file = versionedTarballFilename(packageName, version);
+  return path.posix.join('..', '..', '..', 'packages', packageDirName, file);
+}
+
+/**
+ * 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,38 @@
+import { readFile, writeFile } from 'fs/promises';
+import * as path from 'path';
+import { getPublishedSentryTarballPackageNames, packedSymlinkFilename } from './packedTarballUtils';
+
+/**
+ * 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)}`;
+  }
+
+  packageJson.pnpm = {
+    overrides: {
+      ...packageJson.pnpm?.overrides,
+      ...overrides,
+    },
+  };
+
+  // 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));
+}

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

@@ -0,0 +1,71 @@
+/* eslint-disable no-console */
+import * as fs from 'fs';
+import * as path from 'path';
+import { sync as globSync } from 'glob';
+import {
+  packedSymlinkFilename,
+  relativeTarballPathFromPackedDir,
+  versionedTarballFilename,
+} from './packedTarballUtils';
+
+const e2eTestsRoot = path.resolve(__dirname, '..');
+const repositoryRoot = path.resolve(e2eTestsRoot, '../..');
+const packedDir = path.join(e2eTestsRoot, 'packed');
+
+function readJson<T>(filePath: string): T {
+  return JSON.parse(fs.readFileSync(filePath, 'utf8')) as T;
+}
+
+/**
+ * Ensures `packed/<name>-packed.tgz` symlinks point at the current versioned tarballs under `packages/*`.
+ * Run after `yarn build:tarball` at the repo root (or from CI after restoring the tarball cache).
+ */
+export function syncPackedTarballSymlinks(): void {
+  const { version } = readJson<{ version: string }>(path.join(e2eTestsRoot, 'package.json'));
+
+  fs.mkdirSync(packedDir, { recursive: true });
+
+  for (const entry of fs.readdirSync(packedDir, { withFileTypes: true })) {
+    if (!entry.name.endsWith('-packed.tgz')) {
+      continue;
+    }
+    fs.rmSync(path.join(packedDir, entry.name), { recursive: true, force: true });
+  }
+
+  const packageJsonPaths = globSync('packages/*/package.json', {
+    cwd: repositoryRoot,
+    absolute: true,
+  });
+
+  let linked = 0;
+  for (const packageJsonPath of packageJsonPaths) {
+    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 packageDirName = path.basename(packageDir);
+    const expectedTarball = path.join(packageDir, versionedTarballFilename(name, version));
+
+    if (!fs.existsSync(expectedTarball)) {
+      continue;
+    }
+
+    const linkName = packedSymlinkFilename(name);
+    const linkPath = path.join(packedDir, linkName);
+    const target = relativeTarballPathFromPackedDir(packageDirName, name, version);
+
+    fs.symlinkSync(target, linkPath);
+    linked++;
+  }
+
+  if (linked === 0) {
+    throw new Error(
+      `No packed tarballs found for version ${version} under packages/*/. Run "yarn build:tarball" at the repository root.`,
+    );
+  }
+
+  console.log(`Linked ${linked} tarball symlinks in ${path.relative(repositoryRoot, packedDir) || 'packed'}.`);
+}