test(test-utils): Extract Cloudflare Worker deploys into test-utils/cloudflare

.github/workflows/cleanup-e2e-workers.yml

@@ -16,7 +16,7 @@ jobs:
       CLOUDFLARE_ACCOUNT_ID: ${{ secrets.CLOUDFLARE_ACCOUNT_ID }}
     strategy:
       matrix:
-        # Name prefix of every E2E app that deploys a real worker, see the app's global-setup.mjs
+        # Name prefix of every E2E app that deploys a real worker, see the app's global-setup.ts
         worker-prefix:
           - e2e-send-to-sentry
     steps:

dev-packages/e2e-tests/test-applications/cloudflare-workers-send-to-sentry/global-setup.ts

@@ -1,61 +1,3 @@
-import { randomBytes } from 'node:crypto';
-import { existsSync } from 'node:fs';
-import { deleteWorker, deployWorker, keepsWorker, waitForWorker } from './deployed-worker';
+import { createWorkerGlobalSetup } from '@sentry-internal/test-utils/cloudflare';
 
-const WORKER_PREFIX = 'e2e-send-to-sentry';
-
-/**
- * In CI the name follows the ref, so `develop`, `master` and every PR get a stable Worker that the
- * next run of the same ref overwrites. Pull request refs look like `123/merge` and merge queue refs
- * like `gh-readonly-queue/<base>/pr-123-<sha>`; both map to the PR's Worker.
- */
-export function getWorkerName(): string {
-  if (!process.env.GITHUB_ACTIONS) {
-    return `${WORKER_PREFIX}-local-${randomBytes(3).toString('hex')}`;
-  }
-
-  const { GITHUB_EVENT_NAME, GITHUB_REF_NAME = '' } = process.env;
-  const prNumber =
-    GITHUB_EVENT_NAME === 'pull_request' ? GITHUB_REF_NAME.split('/')[0] : /\/pr-(\d+)-/.exec(GITHUB_REF_NAME)?.[1];
-  const ref = prNumber ? `pr-${prNumber}` : GITHUB_REF_NAME;
-  // Worker names allow lowercase alphanumerics and dashes only, up to 63 characters.
-  const slug = ref.toLowerCase().replace(/[^a-z0-9]+/g, '-');
-
-  return `${WORKER_PREFIX}-${slug}`.slice(0, 63).replace(/-+$/, '');
-}
-
-export default async function globalSetup(): Promise<void> {
-  if (!existsSync(new URL('.wrangler/deploy/config.json', import.meta.url))) {
-    throw new Error('Run `pnpm build` first: wrangler would deploy the uninstrumented source.');
-  }
-  const { CLOUDFLARE_ACCOUNT_ID, E2E_TEST_DSN } = process.env;
-  if (!E2E_TEST_DSN) {
-    throw new Error('E2E_TEST_DSN must be set to deploy the test worker.');
-  }
-
-  // Wrangler authenticates with `CLOUDFLARE_API_TOKEN` (CI) or a `wrangler login` session (local),
-  // but it cannot pick an account on its own outside of a terminal.
-  if (!CLOUDFLARE_ACCOUNT_ID) {
-    throw new Error('CLOUDFLARE_ACCOUNT_ID must be set to deploy the test worker.');
-  }
-
-  const workerName = getWorkerName();
-  const workerUrl = deployWorker(workerName, E2E_TEST_DSN);
-  process.env.E2E_TEST_WORKER_NAME = workerName;
-
-  try {
-    await waitForWorker(workerUrl);
-  } catch (error) {
-    if (!keepsWorker()) {
-      try {
-        deleteWorker(workerName);
-      } catch (deleteError) {
-        // The unreachable worker is the failure to report, not the cleanup.
-        console.error(`Failed to delete worker ${workerName}:`, deleteError);
-      }
-    }
-    throw error;
-  }
-
-  process.env.E2E_TEST_WORKER_URL = workerUrl;
-}
+export default createWorkerGlobalSetup({ workerPrefix: 'e2e-send-to-sentry' });

dev-packages/e2e-tests/test-applications/cloudflare-workers-send-to-sentry/global-teardown.ts

@@ -1,24 +1 @@
-import { deleteWorker, keepsWorker } from './deployed-worker';
-
-export default function globalTeardown(): void {
-  const workerName = process.env.E2E_TEST_WORKER_NAME;
-
-  if (!workerName) {
-    return;
-  }
-
-  if (keepsWorker()) {
-    console.log(`Keeping worker ${workerName} at ${process.env.E2E_TEST_WORKER_URL}`);
-    return;
-  }
-
-  try {
-    deleteWorker(workerName);
-  } catch (error) {
-    // A leaked worker is not an SDK failure, so it must not fail a run whose tests passed.
-    console.error(
-      `Failed to delete worker ${workerName}, delete it with \`wrangler delete --name ${workerName}\`:`,
-      error,
-    );
-  }
-}
+export { workerGlobalTeardown as default } from '@sentry-internal/test-utils/cloudflare';

dev-packages/e2e-tests/test-applications/cloudflare-workers-send-to-sentry/playwright.config.ts

@@ -1,16 +1,16 @@
-import { defineConfig } from '@playwright/test';
+import { getPlaywrightConfig } from '@sentry-internal/test-utils';
 
-export default defineConfig({
-  testDir: './tests',
+const config = getPlaywrightConfig(undefined, {
+  // The tests read what arrived in Sentry through the sentry CLI, so there is no event proxy to start.
+  webServer: undefined,
   // The worker is deployed once for the whole run and deleted again afterwards.
   globalSetup: './global-setup.ts',
   globalTeardown: './global-teardown.ts',
   /* Spans take ~2min to become queryable via the trace endpoint. */
   timeout: 210_000,
-  fullyParallel: true,
-  forbidOnly: !!process.env.CI,
-  retries: 0,
   // Every test spends most of its time polling Sentry, so run them all at once.
+  fullyParallel: true,
   workers: '100%',
-  reporter: process.env.CI ? [['list'], ['junit', { outputFile: 'results.junit.xml' }]] : 'list',
 });
+
+export default config;

dev-packages/e2e-tests/test-applications/cloudflare-workers-send-to-sentry/tests/send-to-sentry.test.ts

@@ -9,7 +9,7 @@ import {
   flattenTrace,
   traceTarget,
 } from '@sentry-internal/test-utils/cli';
-import { fetchFromWorker } from '../deployed-worker';
+import { fetchFromWorker } from '@sentry-internal/test-utils/cloudflare';
 
 // Set by global-setup.ts once the worker for this run is deployed.
 const workerUrl = process.env.E2E_TEST_WORKER_URL;

dev-packages/e2e-tests/test-applications/cloudflare-workers-send-to-sentry/tsconfig.node.json

@@ -3,5 +3,5 @@
   "compilerOptions": {
     "types": ["node"]
   },
-  "include": ["tests/**/*", "deployed-worker.ts", "global-setup.ts", "global-teardown.ts", "playwright.config.ts"]
+  "include": ["tests/**/*", "global-setup.ts", "global-teardown.ts", "playwright.config.ts"]
 }

dev-packages/test-utils/package.json

@@ -33,6 +33,16 @@
         "types": "./build/types/cli.d.ts",
         "default": "./build/cjs/cli.js"
       }
+    },
+    "./cloudflare": {
+      "import": {
+        "types": "./build/types/cloudflare.d.ts",
+        "default": "./build/esm/cloudflare.js"
+      },
+      "require": {
+        "types": "./build/types/cloudflare.d.ts",
+        "default": "./build/cjs/cloudflare.js"
+      }
     }
   },
   "sideEffects": false,

dev-packages/test-utils/rollup.npm.config.mjs

@@ -2,7 +2,7 @@ import { makeBaseNPMConfig, makeNPMConfigVariants } from '@sentry-internal/rollu
 
 export default makeNPMConfigVariants(
   makeBaseNPMConfig({
-    entrypoints: ['src/index.ts', 'src/cli.ts'],
+    entrypoints: ['src/index.ts', 'src/cli.ts', 'src/cloudflare.ts'],
     packageSpecificConfig: {
       output: {
         // set exports to 'named' or 'auto' so that rollup doesn't warn