fix(hono): Allow passing env and fix type issues

Author: s1gr1d

packages/hono/README.md

@@ -48,6 +48,7 @@ compatibility_flags = ["nodejs_compat"]
 Initialize the Sentry Hono middleware as early as possible in your app:
 
 ```typescript
+import { Hono } from 'hono';
 import { sentry } from '@sentry/hono/cloudflare';
 
 const app = new Hono();
@@ -64,3 +65,20 @@ app.use(
 
 export default app;
 ```
+
+#### Access `env` from Cloudflare Worker bindings
+
+Pass the options as a callback instead of a plain options object. The function receives the Cloudflare Worker `env` as defined in the Worker's `Bindings`:
+
+```typescript
+import { Hono } from 'hono';
+import { sentry } from '@sentry/hono/cloudflare';
+
+type Bindings = { SENTRY_DSN: string };
+
+const app = new Hono<{ Bindings: Bindings }>();
+
+app.use(sentry(app, env => ({ dsn: env.SENTRY_DSN })));
+
+export default app;
+```

packages/hono/src/cloudflare/middleware.ts

@@ -7,40 +7,47 @@ import {
   type Integration,
   type Options,
 } from '@sentry/core';
-import type { Context, Hono, MiddlewareHandler } from 'hono';
+import type { Env, Hono, MiddlewareHandler } from 'hono';
 import { requestHandler, responseHandler } from '../shared/middlewareHandlers';
 import { patchAppUse } from '../shared/patchAppUse';
 
-export interface HonoOptions extends Options<BaseTransportOptions> {
-  context?: Context;
-}
+export interface HonoOptions extends Options<BaseTransportOptions> {}
 
 const filterHonoIntegration = (integration: Integration): boolean => integration.name !== 'Hono';
 
-export const sentry = (app: Hono, options: HonoOptions | undefined = {}): MiddlewareHandler => {
-  const isDebug = options.debug;
-
-  isDebug && debug.log('Initialized Sentry Hono middleware (Cloudflare)');
-
-  applySdkMetadata(options, 'hono');
-
-  const { integrations: userIntegrations } = options;
+/**
+ * Sentry middleware for Hono on Cloudflare Workers.
+ */
+export function sentry<E extends Env>(
+  app: Hono<E>,
+  options: HonoOptions | ((env: E['Bindings']) => HonoOptions),
+): MiddlewareHandler {
   withSentry(
-    () => ({
-      ...options,
-      // Always filter out the Hono integration from defaults and user integrations.
-      // The Hono integration is already set up by withSentry, so adding it again would cause capturing too early (in Cloudflare SDK) and non-parametrized URLs.
-      integrations: Array.isArray(userIntegrations)
-        ? defaults =>
-            getIntegrationsToSetup({
-              defaultIntegrations: defaults.filter(filterHonoIntegration),
-              integrations: userIntegrations.filter(filterHonoIntegration),
-            })
-        : typeof userIntegrations === 'function'
-          ? defaults => userIntegrations(defaults).filter(filterHonoIntegration)
-          : defaults => defaults.filter(filterHonoIntegration),
-    }),
-    app,
+    env => {
+      const honoOptions = typeof options === 'function' ? options(env as E['Bindings']) : options;
+
+      applySdkMetadata(honoOptions, 'hono', ['hono', 'cloudflare']);
+
+      honoOptions.debug && debug.log('Initialized Sentry Hono middleware (Cloudflare)');
+
+      const { integrations: userIntegrations } = honoOptions;
+      return {
+        ...honoOptions,
+        // Always filter out the Hono integration from defaults and user integrations.
+        // The Hono integration is already set up by withSentry, so adding it again would cause capturing too early (in Cloudflare SDK) and non-parametrized URLs.
+        integrations: Array.isArray(userIntegrations)
+          ? defaults =>
+              getIntegrationsToSetup({
+                defaultIntegrations: defaults.filter(filterHonoIntegration),
+                integrations: userIntegrations.filter(filterHonoIntegration),
+              })
+          : typeof userIntegrations === 'function'
+            ? defaults => userIntegrations(defaults).filter(filterHonoIntegration)
+            : defaults => defaults.filter(filterHonoIntegration),
+      };
+    },
+    // Cast needed because Hono<E> exposes a narrower fetch signature than ExportedHandler<unknown>
+    app as unknown as ExportedHandler<unknown>,
   );
 
   patchAppUse(app);
@@ -52,4 +59,4 @@ export const sentry = (app: Hono, options: HonoOptions | undefined = {}): Middle
 
     responseHandler(context);
   };
-};
+}

packages/hono/src/shared/patchAppUse.ts

@@ -6,15 +6,15 @@ import {
   SPAN_STATUS_OK,
   startInactiveSpan,
 } from '@sentry/core';
-import type { Hono, MiddlewareHandler } from 'hono';
+import type { Env, Hono, MiddlewareHandler } from 'hono';
 
 const MIDDLEWARE_ORIGIN = 'auto.middleware.hono';
 
 /**
  * Patches `app.use` so that every middleware registered through it is automatically
  * wrapped in a Sentry span. Supports both forms: `app.use(...handlers)` and `app.use(path, ...handlers)`.
  */
-export function patchAppUse(app: Hono): void {
+export function patchAppUse<E extends Env>(app: Hono<E>): void {
   app.use = new Proxy(app.use, {
     apply(target: typeof app.use, thisArg: typeof app, args: Parameters<typeof app.use>): ReturnType<typeof app.use> {
       const [first, ...rest] = args as [unknown, ...MiddlewareHandler[]];

packages/hono/test/cloudflare/middleware.test.ts

@@ -25,16 +25,19 @@ describe('Hono Cloudflare Middleware', () => {
   });
 
   describe('sentry middleware', () => {
-    it('calls applySdkMetadata with "hono"', () => {
+    it('calls applySdkMetadata with "hono" when the options callback is invoked', () => {
       const app = new Hono();
       const options = {
         dsn: 'https://public@dsn.ingest.sentry.io/1337',
       };
 
       sentry(app, options);
 
+      const optionsCallback = withSentryMock.mock.calls[0]?.[0];
+      optionsCallback();
+
       expect(applySdkMetadataMock).toHaveBeenCalledTimes(1);
-      expect(applySdkMetadataMock).toHaveBeenCalledWith(options, 'hono');
+      expect(applySdkMetadataMock).toHaveBeenCalledWith(options, 'hono', ['hono', 'cloudflare']);
     });
 
     it('calls withSentry with modified options', () => {
@@ -63,24 +66,13 @@ describe('Hono Cloudflare Middleware', () => {
           name: 'npm:@sentry/hono',
           version: SDK_VERSION,
         },
+        {
+          name: 'npm:@sentry/cloudflare',
+          version: SDK_VERSION,
+        },
       ]);
     });
 
-    it('calls applySdkMetadata before withSentry', () => {
-      const app = new Hono();
-      const options = {
-        dsn: 'https://public@dsn.ingest.sentry.io/1337',
-      };
-
-      sentry(app, options);
-
-      // Verify applySdkMetadata was called before withSentry
-      const applySdkMetadataCallOrder = applySdkMetadataMock.mock.invocationCallOrder[0];
-      const withSentryCallOrder = withSentryMock.mock.invocationCallOrder[0];
-
-      expect(applySdkMetadataCallOrder).toBeLessThan(withSentryCallOrder as number);
-    });
-
     it('preserves all user options', () => {
       const app = new Hono();
       const options = {