feat(node): Add an instrumentation interface for Hono

Author: Karibash

packages/node/src/integrations/tracing/hono/enums.ts

@@ -0,0 +1,14 @@
+export enum AttributeNames {
+  HONO_TYPE = 'hono.type',
+  HONO_NAME = 'hono.name',
+}
+
+export enum HonoTypes {
+  MIDDLEWARE = 'middleware',
+  REQUEST_HANDLER = 'request_handler',
+}
+
+export enum HonoNames {
+  MIDDLEWARE = 'middleware',
+  REQUEST_HANDLER = 'request handler',
+}

packages/node/src/integrations/tracing/hono/index.ts

@@ -0,0 +1,38 @@
+import type { IntegrationFn } from '@sentry/core';
+import { defineIntegration } from '@sentry/core';
+import { generateInstrumentOnce } from '@sentry/node-core';
+import { HonoInstrumentation } from './instrumentation';
+
+const INTEGRATION_NAME = 'Hono';
+
+export const instrumentHono = generateInstrumentOnce(
+  INTEGRATION_NAME,
+  () => new HonoInstrumentation(),
+);
+
+const _honoIntegration = (() => {
+  return {
+    name: INTEGRATION_NAME,
+    setupOnce() {
+      instrumentHono();
+    },
+  };
+}) satisfies IntegrationFn;
+
+/**
+ * Adds Sentry tracing instrumentation for [Hono](https://hono.dev/).
+ *
+ * If you also want to capture errors, you need to call `setupHonoErrorHandler(app)` after you set up your Hono server.
+ *
+ * For more information, see the [hono documentation](https://docs.sentry.io/platforms/javascript/guides/hono/).
+ *
+ * @example
+ * ```javascript
+ * const Sentry = require('@sentry/node');
+ *
+ * Sentry.init({
+ *   integrations: [Sentry.honoIntegration()],
+ * })
+ * ```
+ */
+export const honoIntegration = defineIntegration(_honoIntegration);

packages/node/src/integrations/tracing/hono/instrumentation.ts

@@ -0,0 +1,94 @@
+import { InstrumentationBase,InstrumentationNodeModuleDefinition  } from '@opentelemetry/instrumentation';
+import type { HandlerInterface, Hono, HonoInstance, MiddlewareHandlerInterface, OnHandlerInterface } from './types';
+
+const PACKAGE_NAME = '@sentry/instrumentation-hono';
+const PACKAGE_VERSION = '0.0.1';
+
+/**
+ * Hono instrumentation for OpenTelemetry
+ */
+export class HonoInstrumentation extends InstrumentationBase {
+  public constructor() {
+    super(PACKAGE_NAME, PACKAGE_VERSION, {});
+  }
+
+  /**
+   * Initialize the instrumentation.
+   */
+  public init(): InstrumentationNodeModuleDefinition[] {
+    return [
+      new InstrumentationNodeModuleDefinition(
+        'hono',
+        ['^4.0.0'],
+        moduleExports => this._patch(moduleExports),
+      ),
+    ];
+  }
+
+  /**
+   * Patches the module exports to instrument Hono.
+   */
+  private _patch(moduleExports: { Hono: Hono }): { Hono: Hono } {
+    // eslint-disable-next-line @typescript-eslint/no-this-alias
+    const instrumentation = this;
+
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    function Hono(this: HonoInstance, ...args: any): HonoInstance {
+      const app: HonoInstance = moduleExports.Hono.apply(this, args);
+
+      instrumentation._wrap(app, 'get', instrumentation._patchHandler());
+      instrumentation._wrap(app, 'post', instrumentation._patchHandler());
+      instrumentation._wrap(app, 'put', instrumentation._patchHandler());
+      instrumentation._wrap(app, 'delete', instrumentation._patchHandler());
+      instrumentation._wrap(app, 'options', instrumentation._patchHandler());
+      instrumentation._wrap(app, 'patch', instrumentation._patchHandler());
+      instrumentation._wrap(app, 'all', instrumentation._patchHandler());
+      instrumentation._wrap(app, 'on', instrumentation._patchOnHandler());
+      instrumentation._wrap(app, 'use', instrumentation._patchMiddlewareHandler());
+
+      return app;
+    }
+
+    moduleExports.Hono = Hono;
+    return moduleExports;
+  }
+
+  /**
+   * Patches the route handler to instrument it.
+   */
+  private _patchHandler(): (original: HandlerInterface) => HandlerInterface {
+    return function(original: HandlerInterface) {
+      // eslint-disable-next-line @typescript-eslint/no-explicit-any
+      return function wrappedHandler(this: HonoInstance, ...args: any) {
+        // TODO: Add OpenTelemetry tracing logic here
+        return original.apply(this, args);
+      };
+    };
+  }
+
+  /**
+   * Patches the 'on' handler to instrument it.
+   */
+  private _patchOnHandler(): (original: OnHandlerInterface) => OnHandlerInterface {
+    return function(original: OnHandlerInterface) {
+      // eslint-disable-next-line @typescript-eslint/no-explicit-any
+      return function wrappedHandler(this: HonoInstance, ...args: any) {
+        // TODO: Add OpenTelemetry tracing logic here
+        return original.apply(this, args);
+      };
+    };
+  }
+
+  /**
+   * Patches the middleware handler to instrument it.
+   */
+  private _patchMiddlewareHandler(): (original: MiddlewareHandlerInterface) => MiddlewareHandlerInterface {
+    return function(original: MiddlewareHandlerInterface) {
+      // eslint-disable-next-line @typescript-eslint/no-explicit-any
+      return function wrappedHandler(this: HonoInstance, ...args: any) {
+        // TODO: Add OpenTelemetry tracing logic here
+        return original.apply(this, args);
+      };
+    };
+  }
+}

packages/node/src/integrations/tracing/hono/types.ts

@@ -0,0 +1,50 @@
+// Vendored from: https://github.com/honojs/hono/blob/855e5b1adbf685bf4b3e6b76573aa7cb0a108d04/src/request.ts#L30
+export type HonoRequest = {
+  path: string;
+};
+
+// Vendored from: https://github.com/honojs/hono/blob/855e5b1adbf685bf4b3e6b76573aa7cb0a108d04/src/context.ts#L291
+export type Context = {
+  req: HonoRequest;
+};
+
+// Vendored from: https://github.com/honojs/hono/blob/855e5b1adbf685bf4b3e6b76573aa7cb0a108d04/src/types.ts#L36C1-L36C39
+export type Next = () => Promise<void>;
+
+// Vendored from: https://github.com/honojs/hono/blob/855e5b1adbf685bf4b3e6b76573aa7cb0a108d04/src/types.ts#L73
+export type Handler = (c: Context, next: Next) => Promise<Response> | Response;
+
+// Vendored from: https://github.com/honojs/hono/blob/855e5b1adbf685bf4b3e6b76573aa7cb0a108d04/src/types.ts#L80
+export type MiddlewareHandler = (c: Context, next: Next) => Promise<Response | void> | Response | void;
+
+// Vendored from: https://github.com/honojs/hono/blob/855e5b1adbf685bf4b3e6b76573aa7cb0a108d04/src/types.ts#L109
+export type HandlerInterface = {
+  (...handlers: (Handler | MiddlewareHandler)[]): HonoInstance;
+  (path: string, ...handlers: (Handler | MiddlewareHandler)[]): HonoInstance;
+};
+
+// Vendored from: https://github.com/honojs/hono/blob/855e5b1adbf685bf4b3e6b76573aa7cb0a108d04/src/types.ts#L1071
+export type OnHandlerInterface = {
+  (method: string | string[], path: string | string[], ...handlers: (Handler | MiddlewareHandler)[]): HonoInstance;
+};
+
+// Vendored from: https://github.com/honojs/hono/blob/855e5b1adbf685bf4b3e6b76573aa7cb0a108d04/src/types.ts#L679
+export type MiddlewareHandlerInterface = {
+  (...handlers: MiddlewareHandler[]): HonoInstance;
+  (path: string, ...handlers: MiddlewareHandler[]): HonoInstance;
+};
+
+// Vendored from: https://github.com/honojs/hono/blob/855e5b1adbf685bf4b3e6b76573aa7cb0a108d04/src/hono-base.ts#L99
+export interface HonoInstance {
+  get: HandlerInterface;
+  post: HandlerInterface;
+  put: HandlerInterface;
+  delete: HandlerInterface;
+  options:HandlerInterface;
+  patch:HandlerInterface;
+  all: HandlerInterface;
+  on: OnHandlerInterface;
+  use: MiddlewareHandlerInterface;
+}
+
+export type Hono = () => HonoInstance;