fix(cloudflare): Import types explicitly from worker-types

Author: AbhiPrasad

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

@@ -1,4 +1,5 @@
 import { Hono } from 'hono';
+import { DurableObject } from 'cloudflare:workers';
 import * as Sentry from '@sentry/cloudflare';
 
 const app = new Hono();
@@ -25,6 +26,19 @@ app.notFound(ctx => {
   return ctx.json({ message: 'Not Found' }, 404);
 });
 
+class MyDurableObjectBase extends DurableObject<Env> {
+  // impl
+}
+
+// Typecheck that the instrumented durable object is valid
+export const MyDurableObject = Sentry.instrumentDurableObjectWithSentry(
+  (env: Env) => ({
+    dsn: env?.E2E_TEST_DSN,
+    tracesSampleRate: 1.0,
+  }),
+  MyDurableObjectBase,
+);
+
 export default Sentry.withSentry(
   (env: Env) => ({
     dsn: env?.E2E_TEST_DSN,

packages/cloudflare/package.json

@@ -60,7 +60,7 @@
     }
   },
   "devDependencies": {
-    "@cloudflare/workers-types": "4.20240725.0",
+    "@cloudflare/workers-types": "^4.20250618.0",
     "@types/node": "^18.19.1",
     "wrangler": "^3.67.1"
   },

packages/cloudflare/src/durableobject.ts

@@ -1,4 +1,5 @@
 /* eslint-disable @typescript-eslint/unbound-method */
+import type { DurableObject, DurableObjectState, ExecutionContext, Rpc } from '@cloudflare/workers-types';
 import {
   captureException,
   flush,
@@ -9,7 +10,6 @@ import {
   withIsolationScope,
   withScope,
 } from '@sentry/core';
-import type { DurableObject } from 'cloudflare:workers';
 import { setAsyncLocalStorageAsyncContextStrategy } from './async';
 import type { CloudflareOptions } from './client';
 import { isInstrumented, markAsInstrumented } from './instrument';
@@ -135,8 +135,8 @@ function wrapMethodWithSentry<T extends (...args: any[]) => any>(
  */
 export function instrumentDurableObjectWithSentry<
   E,
-  T extends DurableObject<E>,
-  C extends new (state: DurableObjectState, env: E) => T,
+  T extends DurableObject & Rpc.DurableObjectBranded,
+  C extends new (ctx: DurableObjectState, env: E) => T,
 >(optionsCallback: (env: E) => CloudflareOptions, DurableObjectClass: C): C {
   return new Proxy(DurableObjectClass, {
     construct(target, [context, env]) {

packages/cloudflare/src/handler.ts

@@ -1,3 +1,11 @@
+import type {
+  EmailExportedHandler,
+  ExportedHandler,
+  ExportedHandlerFetchHandler,
+  ExportedHandlerQueueHandler,
+  ExportedHandlerScheduledHandler,
+  ExportedHandlerTailHandler,
+} from '@cloudflare/workers-types';
 import {
   captureException,
   flush,

packages/cloudflare/src/pages-plugin.ts

@@ -1,3 +1,4 @@
+import type { EventPluginContext, PagesPluginFunction } from '@cloudflare/workers-types';
 import { setAsyncLocalStorageAsyncContextStrategy } from './async';
 import type { CloudflareOptions } from './client';
 import { wrapRequestHandler } from './request';

packages/cloudflare/src/request.ts

@@ -1,4 +1,10 @@
-import type { ExecutionContext, IncomingRequestCfProperties } from '@cloudflare/workers-types';
+import type {
+  EventPluginContext,
+  ExecutionContext,
+  IncomingRequestCfProperties,
+  Request,
+  Response,
+} from '@cloudflare/workers-types';
 import {
   captureException,
   continueTrace,
@@ -14,10 +20,18 @@ import type { CloudflareOptions } from './client';
 import { addCloudResourceContext, addCultureContext, addRequest } from './scope-utils';
 import { init } from './sdk';
 
-interface RequestHandlerWrapperOptions {
+interface RequestHandlerWrapperOptions<
+  Env = unknown,
+  // eslint-disable-next-line @typescript-eslint/no-explicit-any
+  Params extends string = any,
+  Data extends Record<string, unknown> = Record<string, unknown>,
+  // Although it is not ideal to use `any` here, it makes usage more flexible for different setups.
+  // eslint-disable-next-line @typescript-eslint/no-explicit-any
+  PluginParams = any,
+> {
   options: CloudflareOptions;
   request: Request<unknown, IncomingRequestCfProperties<unknown>>;
-  context: ExecutionContext;
+  context: ExecutionContext | EventPluginContext<Env, Params, Data, PluginParams>;
 }
 
 /**
@@ -33,7 +47,7 @@ export function wrapRequestHandler(
     // In certain situations, the passed context can become undefined.
     // For example, for Astro while prerendering pages at build time.
     // see: https://github.com/getsentry/sentry-javascript/issues/13217
-    const context = wrapperOptions.context as ExecutionContext | undefined;
+    const context = wrapperOptions.context as RequestHandlerWrapperOptions['context'] | undefined;
 
     const client = init(options);
     isolationScope.setClient(client);

packages/cloudflare/src/scope-utils.ts

@@ -1,4 +1,4 @@
-import type { IncomingRequestCfProperties } from '@cloudflare/workers-types';
+import type { IncomingRequestCfProperties, Request } from '@cloudflare/workers-types';
 import type { Scope } from '@sentry/core';
 import { winterCGRequestToRequestData } from '@sentry/core';
 

packages/cloudflare/tsconfig.json

@@ -4,7 +4,6 @@
   "include": ["src/**/*"],
 
   "compilerOptions": {
-    "module": "esnext",
-    "types": ["node", "@cloudflare/workers-types"]
+    "module": "esnext"
   }
 }

yarn.lock

@@ -2671,10 +2671,10 @@
   resolved "https://registry.yarnpkg.com/@cloudflare/workerd-windows-64/-/workerd-windows-64-1.20240718.0.tgz#940893e62df7f5a8ec895572b834c95c1e256fbd"
   integrity sha512-YpCRvvT47XanFum7C3SedOZKK6BfVhqmwdAAVAQFyc4gsCdegZo0JkUkdloC/jwuWlbCACOG2HTADHOqyeolzQ==
 
-"@cloudflare/workers-types@4.20240725.0":
-  version "4.20240725.0"
-  resolved "https://registry.yarnpkg.com/@cloudflare/workers-types/-/workers-types-4.20240725.0.tgz#e151e0c069c0070b4d7168c7b0d4ae6c50d3f237"
-  integrity sha512-L6T/Bg50zm9IIACQVQ0CdVcQL+2nLkRXdPz6BsXF3SlzgjyWR5ndVctAbfr/HLV7aKYxWnnEZsIORsTWb+FssA==
+"@cloudflare/workers-types@^4.20250618.0":
+  version "4.20250618.0"
+  resolved "https://registry.yarnpkg.com/@cloudflare/workers-types/-/workers-types-4.20250618.0.tgz#58b794beab67c13a38fee987e7c7de078a519ab5"
+  integrity sha512-5c26+nZEXDRrlzsIaVt3npuElwLi6bhLZHyDfMX5JmcM9sogeBMyyXrU3gJG0DII3QenE7DuyMC8uFzJHTcnDA==
 
 "@cnakazawa/watch@^1.0.3":
   version "1.0.4"
@@ -27148,7 +27148,6 @@ stylus@0.59.0, stylus@^0.59.0:
 
 sucrase@^3.27.0, sucrase@^3.35.0, sucrase@getsentry/sucrase#es2020-polyfills:
   version "3.36.0"
-  uid fd682f6129e507c00bb4e6319cc5d6b767e36061
   resolved "https://codeload.github.com/getsentry/sucrase/tar.gz/fd682f6129e507c00bb4e6319cc5d6b767e36061"
   dependencies:
     "@jridgewell/gen-mapping" "^0.3.2"