Add Durable Object support and e2e tests for Cloudflare Workers

This commit introduces Durable Object support in the Cloudflare Workers example to enhance functionality and error tracking via Sentry. It removes outdated tests, updates dependencies, configures Playwright for e2e testing, and refines build/test scripts for CI/CD use cases.

Author: cod1k

dev-packages/e2e-tests/test-applications/cloudflare-workers/.gitignore

@@ -0,0 +1 @@
+.wrangler

dev-packages/e2e-tests/test-applications/cloudflare-workers/package.json

@@ -4,27 +4,37 @@
   "private": true,
   "scripts": {
     "deploy": "wrangler deploy",
-    "dev": "wrangler dev --var E2E_TEST_DSN=$E2E_TEST_DSN",
-    "build": "wrangler deploy --dry-run --var E2E_TEST_DSN=$E2E_TEST_DSN",
-    "test": "vitest",
+    "dev": "wrangler dev --var \"E2E_TEST_DSN:$E2E_TEST_DSN\" --log-level=$(test $CI && echo 'none' || echo 'log')",
+    "build": "wrangler deploy --dry-run",
+    "test": "vitest --run",
     "typecheck": "tsc --noEmit",
+    "clean:state": "rimraf .wrangler",
     "cf-typegen": "wrangler types",
     "test:build": "pnpm install && pnpm build",
-    "test:assert": "pnpm typecheck"
+    "test:assert": "pnpm test:dev && pnpm test:prod",
+    "test:prod": "pnpm clean:state && TEST_ENV=production playwright test",
+    "test:dev": "pnpm clean:state && TEST_ENV=development playwright test"
   },
   "dependencies": {
     "@sentry/cloudflare": "latest || *"
   },
   "devDependencies": {
-    "@cloudflare/vitest-pool-workers": "^0.4.5",
+    "@playwright/test": "~1.50.0",
+    "@cloudflare/vitest-pool-workers": "^0.8.19",
     "@cloudflare/workers-types": "^4.20240725.0",
+    "@sentry-internal/test-utils": "link:../../../test-utils",
     "typescript": "^5.5.2",
-    "vitest": "1.6.1",
-    "wrangler": "4.22.0"
+    "vitest": "~3.2.0",
+    "wrangler": "^4.23.0"
   },
   "volta": {
     "extends": "../../package.json"
   },
+  "pnpm": {
+    "overrides": {
+      "strip-literal": "~2.0.0"
+    }
+  },
   "sentryTest": {
     "optional": true
   }

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

@@ -0,0 +1,19 @@
+import { getPlaywrightConfig } from '@sentry-internal/test-utils';
+const testEnv = process.env.TEST_ENV;
+
+if (!testEnv) {
+  throw new Error('No test env defined');
+}
+
+const config = getPlaywrightConfig(
+  {
+    startCommand: 'pnpm dev',
+    port: 8787,
+  },
+  {
+    // This comes with the risk of tests leaking into each other but the tests run quite slow so we should parallelize
+    workers: '100%',
+  },
+);
+
+export default config;

dev-packages/e2e-tests/test-applications/cloudflare-workers/src/index.ts

@@ -11,15 +11,75 @@
  * Learn more at https://developers.cloudflare.com/workers/
  */
 import * as Sentry from '@sentry/cloudflare';
+import { DurableObject } from "cloudflare:workers";
+
+class MyDurableObjectBase extends DurableObject<Env> {
+  async throwException(): Promise<string> {
+    throw new Error("Should be recorded in Sentry.")
+  }
+
+  async fetch(request: Request){
+    const {pathname} = new URL(request.url)
+    if(pathname === '/throwException'){
+      await this.throwException()
+    }
+    return new Response('DO is fine')
+  }
+}
+
+export const MyDurableObject = Sentry.instrumentDurableObjectWithSentry(
+  (env: Env) => ({
+    dsn: env.E2E_TEST_DSN,
+    environment: 'qa', // dynamic sampling bias to keep transactions
+    tunnel: `http://localhost:3031/`, // proxy server
+    tracesSampleRate: 1.0,
+    sendDefaultPii: true,
+    transportOptions: {
+      // We are doing a lot of events at once in this test
+      bufferSize: 1000,
+    },
+  }),
+  MyDurableObjectBase,
+);
 
 export default Sentry.withSentry(
   (env: Env) => ({
     dsn: env.E2E_TEST_DSN,
-    // Set tracesSampleRate to 1.0 to capture 100% of spans for tracing.
+    environment: 'qa', // dynamic sampling bias to keep transactions
+    tunnel: `http://localhost:3031/`, // proxy server
     tracesSampleRate: 1.0,
+    sendDefaultPii: true,
+    transportOptions: {
+      // We are doing a lot of events at once in this test
+      bufferSize: 1000,
+    },
   }),
   {
-    async fetch(request, env, ctx) {
+    async fetch(request, env) {
+      const url = new URL(request.url);
+      switch (url.pathname) {
+				case '/rpc/throwException':
+					{
+						const id = env.MY_DURABLE_OBJECT.idFromName('foo');
+						const stub = env.MY_DURABLE_OBJECT.get(id) as DurableObjectStub<MyDurableObjectBase>;
+						try {
+							await stub.throwException();
+						} catch (e) {
+							//We will catch this to be sure not to log inside withSentry
+							return new Response(null, { status: 500 });
+						}
+					}
+					break;
+				case '/throwException':
+					throw new Error('To be recorded in Sentry.');
+				default:
+					if (url.pathname.startsWith('/pass-to-object/')) {
+						const id = env.MY_DURABLE_OBJECT.idFromName('foo');
+						const stub = env.MY_DURABLE_OBJECT.get(id) as DurableObjectStub<MyDurableObjectBase>;
+						url.pathname = url.pathname.replace('/pass-to-object/', '');
+						return stub.fetch(new Request(url, request));
+					}
+			}
       return new Response('Hello World!');
     },
   } satisfies ExportedHandler<Env>,

dev-packages/e2e-tests/test-applications/cloudflare-workers/start-event-proxy.mjs

@@ -0,0 +1,6 @@
+import {startEventProxyServer} from '@sentry-internal/test-utils'
+
+startEventProxyServer({
+  port: 3031,
+  proxyServerName: 'cloudflare-workers',
+})

dev-packages/e2e-tests/test-applications/cloudflare-workers/test/index.spec.ts

@@ -0,0 +1,37 @@
+import { expect, test } from '@playwright/test';
+import { waitForError } from '@sentry-internal/test-utils';
+
+test('Index page', async ({ page }) => {
+  const result = await page.goto('http://localhost:8787/');
+  expect(result?.status?.()).toBe(200);
+  await expect(page.textContent('body > pre')).resolves.toBe('Hello World!');
+})
+
+test('worker\'s withSentry', async () => {
+  const eventWaiter = waitForError('cloudflare-workers', (event) => {
+    return event.exception?.values?.[0]?.mechanism?.type === 'cloudflare';
+  });
+  const response = await fetch('http://localhost:8787/throwException');
+  expect(response.status).toBe(500);
+  const event = await eventWaiter;
+  expect(event.exception?.values?.[0]?.value).toBe('To be recorded in Sentry.');
+})
+
+test('RPC method which throws an exception to be logged to sentry', async () => {
+  const eventWaiter = waitForError('cloudflare-workers', (event) => {
+		return event.exception?.values?.[0]?.mechanism?.type === 'cloudflare_durableobject';
+	});
+	const response = await fetch('http://localhost:8787/rpc/throwException');
+	expect(response.status).toBe(500);
+	const event = await eventWaiter;
+  expect(event.exception?.values?.[0]?.value).toBe('Should be recorded in Sentry.');
+});
+test('Request processed by DurableObject\'s fetch is recorded', async () => {
+  const eventWaiter = waitForError('cloudflare-workers', (event) => {
+    return event.exception?.values?.[0]?.mechanism?.type === 'cloudflare_durableobject';
+  });
+  const response = await fetch('http://localhost:8787/pass-to-object/throwException');
+  expect(response.status).toBe(500);
+  const event = await eventWaiter;
+  expect(event.exception?.values?.[0]?.value).toBe('Should be recorded in Sentry.');
+});

dev-packages/e2e-tests/test-applications/cloudflare-workers/test/tsconfig.json

@@ -0,0 +1,8 @@
+{
+	"extends": "../tsconfig.json",
+	"compilerOptions": {
+		"types": ["@cloudflare/vitest-pool-workers"]
+	},
+	"include": ["./**/*.ts", "../worker-configuration.d.ts"],
+	"exclude": []
+}

dev-packages/e2e-tests/test-applications/cloudflare-workers/tests/index.test.ts

@@ -2,103 +2,43 @@
 	"compilerOptions": {
 		/* Visit https://aka.ms/tsconfig.json to read more about this file */
 
-		/* Projects */
-		// "incremental": true,                              /* Enable incremental compilation */
-		// "composite": true,                                /* Enable constraints that allow a TypeScript project to be used with project references. */
-		// "tsBuildInfoFile": "./",                          /* Specify the folder for .tsbuildinfo incremental compilation files. */
-		// "disableSourceOfProjectReferenceRedirect": true,  /* Disable preferring source files instead of declaration files when referencing composite projects */
-		// "disableSolutionSearching": true,                 /* Opt a project out of multi-project reference checking when editing. */
-		// "disableReferencedProjectLoad": true,             /* Reduce the number of projects loaded automatically by TypeScript. */
-
-		/* Language and Environment */
-		"target": "es2021" /* Set the JavaScript language version for emitted JavaScript and include compatible library declarations. */,
-		"lib": ["es2021"] /* Specify a set of bundled library declaration files that describe the target runtime environment. */,
-		"jsx": "react-jsx" /* Specify what JSX code is generated. */,
-		// "experimentalDecorators": true,                   /* Enable experimental support for TC39 stage 2 draft decorators. */
-		// "emitDecoratorMetadata": true,                    /* Emit design-type metadata for decorated declarations in source files. */
-		// "jsxFactory": "",                                 /* Specify the JSX factory function used when targeting React JSX emit, e.g. 'React.createElement' or 'h' */
-		// "jsxFragmentFactory": "",                         /* Specify the JSX Fragment reference used for fragments when targeting React JSX emit e.g. 'React.Fragment' or 'Fragment'. */
-		// "jsxImportSource": "",                            /* Specify module specifier used to import the JSX factory functions when using `jsx: react-jsx*`.` */
-		// "reactNamespace": "",                             /* Specify the object invoked for `createElement`. This only applies when targeting `react` JSX emit. */
-		// "noLib": true,                                    /* Disable including any library files, including the default lib.d.ts. */
-		// "useDefineForClassFields": true,                  /* Emit ECMAScript-standard-compliant class fields. */
-
-		/* Modules */
-		"module": "es2022" /* Specify what module code is generated. */,
-		// "rootDir": "./",                                  /* Specify the root folder within your source files. */
-		"moduleResolution": "Bundler" /* Specify how TypeScript looks up a file from a given module specifier. */,
-		// "baseUrl": "./",                                  /* Specify the base directory to resolve non-relative module names. */
-		// "paths": {},                                      /* Specify a set of entries that re-map imports to additional lookup locations. */
-		// "rootDirs": [],                                   /* Allow multiple folders to be treated as one when resolving modules. */
-		// "typeRoots": [],                                  /* Specify multiple folders that act like `./node_modules/@types`. */
+		/* Set the JavaScript language version for emitted JavaScript and include compatible library declarations. */
+		"target": "es2021",
+		/* Specify a set of bundled library declaration files that describe the target runtime environment. */
+		"lib": ["es2021"],
+		/* Specify what JSX code is generated. */
+		"jsx": "react-jsx",
+
+		/* Specify what module code is generated. */
+		"module": "es2022",
+		/* Specify how TypeScript looks up a file from a given module specifier. */
+		"moduleResolution": "Bundler",
+		/* Enable importing .json files */
+		"resolveJsonModule": true,
+
+		/* Allow JavaScript files to be a part of your program. Use the `checkJS` option to get errors from these files. */
+		"allowJs": true,
+		/* Enable error reporting in type-checked JavaScript files. */
+		"checkJs": false,
+
+		/* Disable emitting files from a compilation. */
+		"noEmit": true,
+
+		/* Ensure that each file can be safely transpiled without relying on other imports. */
+		"isolatedModules": true,
+		/* Allow 'import x from y' when a module doesn't have a default export. */
+		"allowSyntheticDefaultImports": true,
+		/* Ensure that casing is correct in imports. */
+		"forceConsistentCasingInFileNames": true,
+
+		/* Enable all strict type-checking options. */
+		"strict": true,
+
+		/* Skip type checking all .d.ts files. */
+		"skipLibCheck": true,
 		"types": [
-			"@cloudflare/workers-types/2023-07-01"
-		] /* Specify type package names to be included without being referenced in a source file. */,
-		// "allowUmdGlobalAccess": true,                     /* Allow accessing UMD globals from modules. */
-		"resolveJsonModule": true /* Enable importing .json files */,
-		// "noResolve": true,                                /* Disallow `import`s, `require`s or `<reference>`s from expanding the number of files TypeScript should add to a project. */
-
-		/* JavaScript Support */
-		"allowJs": true /* Allow JavaScript files to be a part of your program. Use the `checkJS` option to get errors from these files. */,
-		"checkJs": false /* Enable error reporting in type-checked JavaScript files. */,
-		// "maxNodeModuleJsDepth": 1,                        /* Specify the maximum folder depth used for checking JavaScript files from `node_modules`. Only applicable with `allowJs`. */
-
-		/* Emit */
-		// "declaration": true,                              /* Generate .d.ts files from TypeScript and JavaScript files in your project. */
-		// "declarationMap": true,                           /* Create sourcemaps for d.ts files. */
-		// "emitDeclarationOnly": true,                      /* Only output d.ts files and not JavaScript files. */
-		// "sourceMap": true,                                /* Create source map files for emitted JavaScript files. */
-		// "outFile": "./",                                  /* Specify a file that bundles all outputs into one JavaScript file. If `declaration` is true, also designates a file that bundles all .d.ts output. */
-		// "outDir": "./",                                   /* Specify an output folder for all emitted files. */
-		// "removeComments": true,                           /* Disable emitting comments. */
-		"noEmit": true /* Disable emitting files from a compilation. */,
-		// "importHelpers": true,                            /* Allow importing helper functions from tslib once per project, instead of including them per-file. */
-		// "importsNotUsedAsValues": "remove",               /* Specify emit/checking behavior for imports that are only used for types */
-		// "downlevelIteration": true,                       /* Emit more compliant, but verbose and less performant JavaScript for iteration. */
-		// "sourceRoot": "",                                 /* Specify the root path for debuggers to find the reference source code. */
-		// "mapRoot": "",                                    /* Specify the location where debugger should locate map files instead of generated locations. */
-		// "inlineSourceMap": true,                          /* Include sourcemap files inside the emitted JavaScript. */
-		// "inlineSources": true,                            /* Include source code in the sourcemaps inside the emitted JavaScript. */
-		// "emitBOM": true,                                  /* Emit a UTF-8 Byte Order Mark (BOM) in the beginning of output files. */
-		// "newLine": "crlf",                                /* Set the newline character for emitting files. */
-		// "stripInternal": true,                            /* Disable emitting declarations that have `@internal` in their JSDoc comments. */
-		// "noEmitHelpers": true,                            /* Disable generating custom helper functions like `__extends` in compiled output. */
-		// "noEmitOnError": true,                            /* Disable emitting files if any type checking errors are reported. */
-		// "preserveConstEnums": true,                       /* Disable erasing `const enum` declarations in generated code. */
-		// "declarationDir": "./",                           /* Specify the output directory for generated declaration files. */
-		// "preserveValueImports": true,                     /* Preserve unused imported values in the JavaScript output that would otherwise be removed. */
-
-		/* Interop Constraints */
-		"isolatedModules": true /* Ensure that each file can be safely transpiled without relying on other imports. */,
-		"allowSyntheticDefaultImports": true /* Allow 'import x from y' when a module doesn't have a default export. */,
-		// "esModuleInterop": true /* Emit additional JavaScript to ease support for importing CommonJS modules. This enables `allowSyntheticDefaultImports` for type compatibility. */,
-		// "preserveSymlinks": true,                         /* Disable resolving symlinks to their realpath. This correlates to the same flag in node. */
-		"forceConsistentCasingInFileNames": true /* Ensure that casing is correct in imports. */,
-
-		/* Type Checking */
-		"strict": true /* Enable all strict type-checking options. */,
-		// "noImplicitAny": true,                            /* Enable error reporting for expressions and declarations with an implied `any` type.. */
-		// "strictNullChecks": true,                         /* When type checking, take into account `null` and `undefined`. */
-		// "strictFunctionTypes": true,                      /* When assigning functions, check to ensure parameters and the return values are subtype-compatible. */
-		// "strictBindCallApply": true,                      /* Check that the arguments for `bind`, `call`, and `apply` methods match the original function. */
-		// "strictPropertyInitialization": true,             /* Check for class properties that are declared but not set in the constructor. */
-		// "noImplicitThis": true,                           /* Enable error reporting when `this` is given the type `any`. */
-		// "useUnknownInCatchVariables": true,               /* Type catch clause variables as 'unknown' instead of 'any'. */
-		// "alwaysStrict": true,                             /* Ensure 'use strict' is always emitted. */
-		// "noUnusedLocals": true,                           /* Enable error reporting when a local variables aren't read. */
-		// "noUnusedParameters": true,                       /* Raise an error when a function parameter isn't read */
-		// "exactOptionalPropertyTypes": true,               /* Interpret optional property types as written, rather than adding 'undefined'. */
-		// "noImplicitReturns": true,                        /* Enable error reporting for codepaths that do not explicitly return in a function. */
-		// "noFallthroughCasesInSwitch": true,               /* Enable error reporting for fallthrough cases in switch statements. */
-		// "noUncheckedIndexedAccess": true,                 /* Include 'undefined' in index signature results */
-		// "noImplicitOverride": true,                       /* Ensure overriding members in derived classes are marked with an override modifier. */
-		// "noPropertyAccessFromIndexSignature": true,       /* Enforces using indexed accessors for keys declared using an indexed type */
-		// "allowUnusedLabels": true,                        /* Disable error reporting for unused labels. */
-		// "allowUnreachableCode": true,                     /* Disable error reporting for unreachable code. */
-
-		/* Completeness */
-		// "skipDefaultLibCheck": true,                      /* Skip type checking .d.ts files that are included with TypeScript. */
-		"skipLibCheck": true /* Skip type checking all .d.ts files. */
+			"./worker-configuration.d.ts"
+		]
 	},
 	"exclude": ["test"],
 	"include": ["worker-configuration.d.ts", "src/**/*.ts"]