test(v9/cloudflare): Add integration test infrastructure (#17209)

- A backport to v9 of #16848

Co-authored-by: Abhijeet Prasad <[email protected]>

Author: timfish

.github/workflows/build.yml

@@ -747,6 +747,29 @@ jobs:
           directory: dev-packages/node-integration-tests
           token: ${{ secrets.CODECOV_TOKEN }}
 
+  job_cloudflare_integration_tests:
+    name: Cloudflare Integration Tests
+    needs: [job_get_metadata, job_build]
+    runs-on: ubuntu-24.04
+    timeout-minutes: 15
+    steps:
+      - name: Check out current commit (${{ needs.job_get_metadata.outputs.commit_label }})
+        uses: actions/checkout@v4
+        with:
+          ref: ${{ env.HEAD_COMMIT }}
+      - name: Set up Node
+        uses: actions/setup-node@v4
+        with:
+          node-version-file: 'package.json'
+      - name: Restore caches
+        uses: ./.github/actions/restore-cache
+        with:
+          dependency_cache_key: ${{ needs.job_build.outputs.dependency_cache_key }}
+
+      - name: Run integration tests
+        working-directory: dev-packages/cloudflare-integration-tests
+        run: yarn test
+
   job_remix_integration_tests:
     name: Remix (Node ${{ matrix.node }}) Tests
     needs: [job_get_metadata, job_build]
@@ -1095,6 +1118,7 @@ jobs:
         job_deno_unit_tests,
         job_node_unit_tests,
         job_node_integration_tests,
+        job_cloudflare_integration_tests,
         job_browser_playwright_tests,
         job_browser_loader_tests,
         job_remix_integration_tests,

.gitignore

@@ -60,3 +60,4 @@ packages/gatsby/gatsby-node.d.ts
 
 # intellij
 *.iml
+/**/.wrangler/*

dev-packages/cloudflare-integration-tests/.eslintrc.js

@@ -0,0 +1,35 @@
+module.exports = {
+  env: {
+    node: true,
+  },
+  extends: ['../../.eslintrc.js'],
+  overrides: [
+    {
+      files: ['*.ts'],
+      parserOptions: {
+        project: ['tsconfig.json'],
+        sourceType: 'module',
+      },
+    },
+    {
+      files: ['suites/**/*.ts', 'suites/**/*.mjs'],
+      globals: {
+        fetch: 'readonly',
+      },
+      rules: {
+        '@typescript-eslint/typedef': 'off',
+        // Explicitly allow ts-ignore with description for Node integration tests
+        // Reason: We run these tests on TS3.8 which doesn't support `@ts-expect-error`
+        '@typescript-eslint/ban-ts-comment': [
+          'error',
+          {
+            'ts-ignore': 'allow-with-description',
+            'ts-expect-error': true,
+          },
+        ],
+        // We rely on having imports after init() is called for OTEL
+        'import/first': 'off',
+      },
+    },
+  ],
+};

dev-packages/cloudflare-integration-tests/expect.ts

@@ -0,0 +1,78 @@
+import type { Contexts, Envelope, Event, SdkInfo } from '@sentry/core';
+import { SDK_VERSION } from '@sentry/core';
+import { expect } from 'vitest';
+
+export const UUID_MATCHER = expect.stringMatching(/^[0-9a-f]{32}$/);
+export const UUID_V4_MATCHER = expect.stringMatching(
+  /^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$/,
+);
+export const SHORT_UUID_MATCHER = expect.stringMatching(/^[0-9a-f]{16}$/);
+export const ISO_DATE_MATCHER = expect.stringMatching(/^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}\.\d{3}Z$/);
+
+function dropUndefinedKeys<T extends Record<string, unknown>>(obj: T): T {
+  for (const [key, value] of Object.entries(obj)) {
+    if (value === undefined) {
+      // eslint-disable-next-line @typescript-eslint/no-dynamic-delete
+      delete obj[key];
+    }
+  }
+  return obj;
+}
+
+function getSdk(): SdkInfo {
+  return {
+    integrations: expect.any(Array),
+    name: 'sentry.javascript.cloudflare',
+    packages: [
+      {
+        name: 'npm:@sentry/cloudflare',
+        version: SDK_VERSION,
+      },
+    ],
+    version: SDK_VERSION,
+  };
+}
+
+function defaultContexts(eventContexts: Contexts = {}): Contexts {
+  return dropUndefinedKeys({
+    trace: {
+      trace_id: UUID_MATCHER,
+      span_id: SHORT_UUID_MATCHER,
+    },
+    cloud_resource: { 'cloud.provider': 'cloudflare' },
+    culture: { timezone: expect.any(String) },
+    runtime: { name: 'cloudflare' },
+    ...eventContexts,
+  });
+}
+
+export function expectedEvent(event: Event): Event {
+  return dropUndefinedKeys({
+    event_id: UUID_MATCHER,
+    timestamp: expect.any(Number),
+    environment: 'production',
+    platform: 'javascript',
+    sdk: getSdk(),
+    ...event,
+    contexts: defaultContexts(event.contexts),
+  });
+}
+
+export function eventEnvelope(event: Event): Envelope {
+  return [
+    {
+      event_id: UUID_MATCHER,
+      sent_at: ISO_DATE_MATCHER,
+      sdk: { name: 'sentry.javascript.cloudflare', version: SDK_VERSION },
+      trace: {
+        environment: event.environment || 'production',
+        public_key: 'public',
+        trace_id: UUID_MATCHER,
+        sample_rate: expect.any(String),
+        sampled: expect.any(String),
+        transaction: expect.any(String),
+      },
+    },
+    [[{ type: 'event' }, expectedEvent(event)]],
+  ];
+}

dev-packages/cloudflare-integration-tests/package.json

@@ -0,0 +1,27 @@
+{
+  "name": "@sentry-internal/cloudflare-integration-tests",
+  "version": "9.42.1",
+  "license": "MIT",
+  "engines": {
+    "node": ">=18"
+  },
+  "private": true,
+  "scripts": {
+    "lint": "eslint . --format stylish",
+    "fix": "eslint . --format stylish --fix",
+    "test": "vitest run",
+    "test:watch": "yarn test --watch"
+  },
+  "dependencies": {
+    "@sentry/cloudflare": "9.42.1"
+  },
+  "devDependencies": {
+    "@sentry-internal/test-utils": "link:../test-utils",
+    "@cloudflare/workers-types": "^4.20250708.0",
+    "vitest": "^3.2.4",
+    "wrangler": "4.22.0"
+  },
+  "volta": {
+    "extends": "../../package.json"
+  }
+}