add Hono integration

Author: s1gr1d

packages/cloudflare/src/handler.ts

@@ -10,6 +10,7 @@ import {
 import { setAsyncLocalStorageAsyncContextStrategy } from './async';
 import type { CloudflareOptions } from './client';
 import { isInstrumented, markAsInstrumented } from './instrument';
+import { getHonoIntegration } from './integrations/hono';
 import { getFinalOptions } from './options';
 import { wrapRequestHandler } from './request';
 import { addCloudResourceContext } from './scope-utils';
@@ -48,7 +49,7 @@ export function withSentry<Env = unknown, QueueHandlerMessage = unknown, CfHostM
       markAsInstrumented(handler.fetch);
     }
 
-    /* hono does not reach the catch block of the fetch handler and captureException needs to be called in the hono errorHandler */
+    /* Hono does not reach the catch block of the fetch handler and captureException needs to be called in the hono errorHandler */
     if (
       'onError' in handler &&
       'errorHandler' in handler &&
@@ -59,7 +60,7 @@ export function withSentry<Env = unknown, QueueHandlerMessage = unknown, CfHostM
         apply(target, thisArg, args) {
           const [err] = args;
 
-          captureException(err, { mechanism: { handled: false, type: 'auto.faas.cloudflare.error_handler' } });
+          getHonoIntegration()?.handleHonoException(err);
 
           return Reflect.apply(target, thisArg, args);
         },

packages/cloudflare/src/index.ts

@@ -111,6 +111,7 @@ export { getDefaultIntegrations } from './sdk';
 
 export { fetchIntegration } from './integrations/fetch';
 export { vercelAIIntegration } from './integrations/tracing/vercelai';
+export { honoIntegration } from './integrations/hono';
 
 export { instrumentD1WithSentry } from './d1';
 

packages/cloudflare/src/integrations/hono.ts

@@ -0,0 +1,72 @@
+import type { IntegrationFn } from '@sentry/core';
+import { captureException, debug, defineIntegration, getClient } from '@sentry/core';
+import { DEBUG_BUILD } from '../debug-build';
+
+const INTEGRATION_NAME = 'Hono';
+
+interface HonoError extends Error {
+  status?: number;
+}
+
+export interface Options {
+  /**
+   * Callback method deciding whether error should be captured and sent to Sentry
+   * @param error Captured middleware error
+   */
+  shouldHandleError?(this: void, error: HonoError): boolean;
+}
+
+/** Only exported for internal use */
+export function getHonoIntegration(): ReturnType<typeof _honoIntegration> | undefined {
+  const client = getClient();
+  if (!client) {
+    return undefined;
+  } else {
+    return client.getIntegrationByName(_honoIntegration.name);
+  }
+}
+
+// todo: implement this
+function isHonoError(err: unknown): err is HonoError {
+  // @ts-ignore
+  return 'status' in err;
+}
+
+const _honoIntegration = ((options: Partial<Options> = {}) => {
+  let _shouldHandleError: (error: Error) => boolean;
+
+  return {
+    name: INTEGRATION_NAME,
+    setupOnce() {
+      _shouldHandleError = options.shouldHandleError || defaultShouldHandleError;
+    },
+    handleHonoException(err: HonoError): void {
+      if (!isHonoError) {
+        DEBUG_BUILD && debug.log('Hono integration could not detect a Hono error');
+        return;
+      }
+      if (_shouldHandleError(err)) {
+        captureException(err, { mechanism: { handled: false, type: 'auto.faas.cloudflare.error_handler' } });
+      }
+    },
+  };
+}) satisfies IntegrationFn;
+
+/**
+ * Automatically captures exceptions caught with the `onError` handler in Hono.
+ *
+ * The integration is added by default.
+ */
+export const honoIntegration = defineIntegration(_honoIntegration);
+
+/**
+ * Default function to determine if an error should be sent to Sentry
+ *
+ * 3xx and 4xx errors are not sent by default.
+ */
+function defaultShouldHandleError(error: HonoError): boolean {
+  // todo: add test for checking error without status
+  const statusCode = error?.status;
+  // 3xx and 4xx errors are not sent by default.
+  return statusCode ? statusCode >= 500 || statusCode <= 299 : true;
+}

packages/cloudflare/src/sdk.ts

@@ -14,6 +14,7 @@ import type { CloudflareClientOptions, CloudflareOptions } from './client';
 import { CloudflareClient } from './client';
 import { makeFlushLock } from './flush';
 import { fetchIntegration } from './integrations/fetch';
+import { honoIntegration } from './integrations/hono';
 import { setupOpenTelemetryTracer } from './opentelemetry/tracer';
 import { makeCloudflareTransport } from './transport';
 import { defaultStackParser } from './vendor/stacktrace';
@@ -31,6 +32,7 @@ export function getDefaultIntegrations(options: CloudflareOptions): Integration[
     functionToStringIntegration(),
     linkedErrorsIntegration(),
     fetchIntegration(),
+    honoIntegration(),
     // TODO(v11): the `include` object should be defined directly in the integration based on `sendDefaultPii`
     requestDataIntegration(sendDefaultPii ? undefined : { include: { cookies: false } }),
     consoleIntegration(),