fixup! feat(cloudflare): Support Cloudflare types v5 & newer wrangler versions

Author: JPeer264

packages/cloudflare/src/client.ts

@@ -1,6 +1,7 @@
 import type { ClientOptions, Options, ServerRuntimeClientOptions } from '@sentry/core';
 import { applySdkMetadata, debug, ServerRuntimeClient, spanIsSampled } from '@sentry/core';
 import { DEBUG_BUILD } from './debug-build';
+import type { ExecutionContextCompat } from './executionContext';
 import type { makeFlushLock } from './flush';
 import type { CloudflareTransportOptions } from './transport';
 
@@ -230,7 +231,7 @@ interface BaseCloudflareOptions {
  * @see @sentry/core Options for more information.
  */
 export interface CloudflareOptions extends Options<CloudflareTransportOptions>, BaseCloudflareOptions {
-  ctx?: ExecutionContext;
+  ctx?: ExecutionContextCompat;
 }
 
 /**

packages/cloudflare/src/executionContext.ts

@@ -0,0 +1,13 @@
+import type { ExecutionContext } from '@cloudflare/workers-types';
+
+/**
+ * A structural subset of `ExecutionContext` that is compatible with both `@cloudflare/workers-types`
+ * v4 and v5.
+ *
+ * v5 added `exports` and `tracing` as required members. Referencing the full `ExecutionContext` in
+ * public input positions would force consumers on v4 (still allowed by our `peerDependencies` range)
+ * to provide members their types don't have. We only ever use `waitUntil` (plus a runtime
+ * `'storage' in ctx` check), so picking the members that exist in both majors keeps a context
+ * constructed against either version assignable here.
+ */
+export type ExecutionContextCompat = Pick<ExecutionContext, 'waitUntil' | 'passThroughOnException'> | ExecutionContext;

packages/cloudflare/src/flush.ts

@@ -2,6 +2,7 @@ import type { ExecutionContext } from '@cloudflare/workers-types';
 import type { Client } from '@sentry/core';
 import { debug, flush } from '@sentry/core';
 import { DEBUG_BUILD } from './debug-build';
+import type { ExecutionContextCompat } from './executionContext';
 
 type FlushLock = {
   readonly ready: Promise<void>;
@@ -34,7 +35,7 @@ const flushLockRegistries = new WeakMap<ExecutionContext['waitUntil'], FlushLock
  *
  * By using the original waitUntil for flush operations, we bypass this issue.
  */
-export function getOriginalWaitUntil(context: ExecutionContext): ExecutionContext['waitUntil'] | undefined {
+export function getOriginalWaitUntil(context: ExecutionContextCompat): ExecutionContext['waitUntil'] | undefined {
   // eslint-disable-next-line @typescript-eslint/unbound-method
   const currentWaitUntil = context.waitUntil;
   const original = flushLockRegistries.get(currentWaitUntil)?.originalWaitUntil;
@@ -49,7 +50,7 @@ export function getOriginalWaitUntil(context: ExecutionContext): ExecutionContex
  * @param {ExecutionContext} context - The execution context to be enhanced. If no context is provided, the function returns undefined.
  * @return {FlushLock} Returns a flusher function if a valid context is provided, otherwise undefined.
  */
-export function makeFlushLock(context: ExecutionContext): FlushLock {
+export function makeFlushLock(context: ExecutionContextCompat): FlushLock {
   const registry = getOrCreateFlushLockRegistry(context);
   let resolveAllDone: () => void = () => undefined;
   const allDone = new Promise<void>(res => {
@@ -81,7 +82,7 @@ export function makeFlushLock(context: ExecutionContext): FlushLock {
   return Object.freeze(lock);
 }
 
-function getOrCreateFlushLockRegistry(context: ExecutionContext): FlushLockRegistry {
+function getOrCreateFlushLockRegistry(context: ExecutionContextCompat): FlushLockRegistry {
   // eslint-disable-next-line @typescript-eslint/unbound-method
   const waitUntil = context.waitUntil;
   const existingRegistry = flushLockRegistries.get(waitUntil);

packages/cloudflare/src/pages-plugin.ts

@@ -1,6 +1,6 @@
-import type { ExecutionContext } from '@cloudflare/workers-types';
 import { setAsyncLocalStorageAsyncContextStrategy } from './async';
 import type { CloudflareOptions } from './client';
+import type { ExecutionContextCompat } from './executionContext';
 import { wrapRequestHandler } from './request';
 
 /**
@@ -54,9 +54,9 @@ export function sentryPagesPlugin<
     }
 
     const options = typeof handlerOrOptions === 'function' ? handlerOrOptions(context) : handlerOrOptions;
-    // A Pages `EventPluginContext` is not a Workers `ExecutionContext` (it lacks `exports`/`tracing`),
-    // but `wrapRequestHandler` only reads `waitUntil` off it, so a structural cast is safe here.
-    const executionContext = { ...context, props: {} } as unknown as ExecutionContext;
+    // A Pages `EventPluginContext` is not a Workers `ExecutionContext`, but `wrapRequestHandler` only
+    // uses `waitUntil` and a `'storage' in context` check, both of which this satisfies.
+    const executionContext = { ...context, props: {} } as unknown as ExecutionContextCompat;
     return wrapRequestHandler({ options, request: context.request, context: executionContext }, () => context.next());
   };
 }

packages/cloudflare/src/request.ts

@@ -1,4 +1,4 @@
-import type { CfProperties, ExecutionContext, IncomingRequestCfProperties } from '@cloudflare/workers-types';
+import type { CfProperties, IncomingRequestCfProperties } from '@cloudflare/workers-types';
 import {
   captureException,
   continueTrace,
@@ -14,20 +14,21 @@ import {
 } from '@sentry/core';
 import { captureIncomingRequestBody } from './integrations/httpServer';
 import type { CloudflareOptions } from './client';
+import type { ExecutionContextCompat } from './executionContext';
 import { flushAndDispose, getOriginalWaitUntil } from './flush';
 import { addCloudResourceContext, addCultureContext, addRequest } from './scope-utils';
 import { init } from './sdk';
 import { classifyResponseStreaming } from './utils/streaming';
 
-function getRequestErrorMechanismType(context: ExecutionContext | undefined): string {
+function getRequestErrorMechanismType(context: ExecutionContextCompat | undefined): string {
   // Durable Object fetch handlers use DO state as context (see instrumentDurableObjectWithSentry)
   return context && 'storage' in context ? 'auto.faas.cloudflare.durable_object' : 'auto.http.cloudflare';
 }
 
 interface RequestHandlerWrapperOptions {
   options: CloudflareOptions;
   request: Request<unknown, IncomingRequestCfProperties<unknown> | CfProperties<unknown>>;
-  context: ExecutionContext | undefined;
+  context: ExecutionContextCompat | undefined;
   /**
    * If true, errors will be captured, rethrown and sent to Sentry.
    * Otherwise, errors are rethrown but not captured.