Move fastify into its own folder.

Author: onurtemizkan

packages/node/src/integrations/tracing/fastify-v3/internal-types.ts

@@ -10,52 +10,46 @@ import {
   spanToJSON,
 } from '@sentry/core';
 import type { IntegrationFn, Span } from '@sentry/core';
-import { generateInstrumentOnce } from '../../otel/instrument';
-import { FastifyInstrumentationV3 } from './fastify-v3/instrumentation';
+import { generateInstrumentOnce } from '../../../otel/instrument';
+import { FastifyInstrumentationV3 } from './v3/instrumentation';
 import * as diagnosticsChannel from 'node:diagnostics_channel';
-import type { FastifyInstance } from './fastify-v3/internal-types';
-import { DEBUG_BUILD } from '../../debug-build';
-
-/**
- * Minimal request type containing properties around route information.
- * Works for Fastify 3, 4 and presumably 5.
- *
- * Based on https://github.com/fastify/fastify/blob/ce3811f5f718be278bbcd4392c615d64230065a6/types/request.d.ts
- */
-// eslint-disable-next-line @typescript-eslint/no-explicit-any
-interface MinimalFastifyRequest extends Record<string, any> {
-  method?: string;
-  // since fastify@4.10.0
-  routeOptions?: {
-    url?: string;
-  };
-  routerPath?: string;
-}
-
-/**
- * Minimal reply type containing properties needed for error handling.
- *
- * Based on https://github.com/fastify/fastify/blob/ce3811f5f718be278bbcd4392c615d64230065a6/types/reply.d.ts
- */
-// eslint-disable-next-line @typescript-eslint/no-explicit-any
-interface MinimalFastifyReply extends Record<string, any> {
-  statusCode: number;
-}
-
-// We inline the types we care about here
-interface Fastify {
-  // eslint-disable-next-line @typescript-eslint/no-explicit-any
-  register: (plugin: any) => void;
-  addHook: (hook: string, handler: (...params: unknown[]) => void) => void;
-}
-
-interface FastifyWithHooks extends Omit<Fastify, 'addHook'> {
-  addHook(
-    hook: 'onError',
-    handler: (request: MinimalFastifyRequest, reply: MinimalFastifyReply, error: Error) => void,
-  ): void;
-  addHook(hook: 'onRequest', handler: (request: MinimalFastifyRequest, reply: MinimalFastifyReply) => void): void;
-}
+import { DEBUG_BUILD } from '../../../debug-build';
+import type { FastifyInstance, FastifyReply, FastifyRequest } from './types';
+
+// /**
+//  * Minimal request type containing properties around route information.
+//  * Works for Fastify 3, 4 and presumably 5.
+//  *
+//  * Based on https://github.com/fastify/fastify/blob/ce3811f5f718be278bbcd4392c615d64230065a6/types/request.d.ts
+//  */
+// // eslint-disable-next-line @typescript-eslint/no-explicit-any
+// interface MinimalFastifyRequest extends Record<string, any> {
+//   method?: string;
+//   // since fastify@4.10.0
+//   routeOptions?: {
+//     url?: string;
+//   };
+//   routerPath?: string;
+// }
+
+// /**
+//  * Minimal reply type containing properties needed for error handling.
+//  *
+//  * Based on https://github.com/fastify/fastify/blob/ce3811f5f718be278bbcd4392c615d64230065a6/types/reply.d.ts
+//  */
+// // eslint-disable-next-line @typescript-eslint/no-explicit-any
+// interface MinimalFastifyReply extends Record<string, any> {
+//   statusCode: number;
+// }
+
+// // We inline the types we care about here
+// interface Fastify {
+//   // eslint-disable-next-line @typescript-eslint/no-explicit-any
+//   version: string;
+//   register: (plugin: any) => Fastify;
+//   after: (listener?: (err: Error) => void) => Fastify;
+//   addHook: (name: string, handler: (...params: unknown[]) => void) => Fastify;
+// }
 
 interface FastifyHandlerOptions {
   /**
@@ -89,7 +83,7 @@ interface FastifyHandlerOptions {
    * });
    * ```
    */
-  shouldHandleError: (error: Error, request: MinimalFastifyRequest, reply: MinimalFastifyReply) => boolean;
+  shouldHandleError: (error: Error, request: FastifyRequest, reply: FastifyReply) => boolean;
 }
 
 const INTEGRATION_NAME = 'Fastify';
@@ -157,7 +151,7 @@ export const fastifyIntegration = defineIntegration(_fastifyIntegration);
  *
  * 3xx and 4xx errors are not sent by default.
  */
-function defaultShouldHandleError(_error: Error, _request: MinimalFastifyRequest, reply: MinimalFastifyReply): boolean {
+function defaultShouldHandleError(_error: Error, _request: FastifyRequest, reply: FastifyReply): boolean {
   const statusCode = reply.statusCode;
   // 3xx and 4xx errors are not sent by default.
   return statusCode >= 500 || statusCode <= 299;
@@ -183,11 +177,11 @@ function defaultShouldHandleError(_error: Error, _request: MinimalFastifyRequest
  * app.listen({ port: 3000 });
  * ```
  */
-export function setupFastifyErrorHandler(fastify: Fastify, options?: Partial<FastifyHandlerOptions>): void {
+export function setupFastifyErrorHandler(fastify: FastifyInstance, options?: Partial<FastifyHandlerOptions>): void {
   const shouldHandleError = options?.shouldHandleError || defaultShouldHandleError;
 
   const plugin = Object.assign(
-    function (fastify: FastifyWithHooks, _options: unknown, done: () => void): void {
+    function (fastify: FastifyInstance, _options: unknown, done: () => void): void {
       fastify.addHook('onError', async (request, reply, error) => {
         if (shouldHandleError(error, request, reply)) {
           captureException(error);

packages/node/src/integrations/tracing/fastify.ts renamed to packages/node/src/integrations/tracing/fastify/index.ts

@@ -0,0 +1,43 @@
+export type HandlerOriginal =
+  | ((request: FastifyRequest, reply: FastifyReply, done: HookHandlerDoneFunction) => Promise<void>)
+  | ((request: FastifyRequest, reply: FastifyReply, done: HookHandlerDoneFunction) => void);
+
+export type FastifyError = any;
+
+export type HookHandlerDoneFunction = <TError extends Error = FastifyError>(err?: TError) => void;
+
+export type FastifyErrorCodes = any;
+
+export type FastifyPlugin = (
+  instance: FastifyInstance,
+  opts: any,
+  done: HookHandlerDoneFunction,
+) => unknown | Promise<unknown>;
+
+export interface FastifyInstance {
+  version: string;
+  register: (plugin: any) => FastifyInstance;
+  after: (listener?: (err: Error) => void) => FastifyInstance;
+  addHook(hook: string, handler: HandlerOriginal): FastifyInstance;
+  addHook(
+    hook: 'onError',
+    handler: (request: FastifyRequest, reply: FastifyReply, error: Error) => void,
+  ): FastifyInstance;
+  addHook(
+    hook: 'onRequest', handler: (request: FastifyRequest, reply: FastifyReply) => void): FastifyInstance;
+
+}
+
+export interface FastifyReply {
+  send: () => FastifyReply;
+  statusCode: number;
+}
+
+export interface FastifyRequest {
+  method?: string;
+  // since fastify@4.10.0
+  routeOptions?: {
+    url?: string;
+  };
+  routerPath?: string;
+}

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

@@ -31,15 +31,18 @@ import { SEMATTRS_HTTP_ROUTE } from '@opentelemetry/semantic-conventions';
 
 import { AttributeNames, FastifyNames, FastifyTypes } from './enums/AttributeNames';
 
+import type {
+  PluginFastifyReply,
+} from './internal-types';
+
 import type {
   FastifyErrorCodes,
   FastifyInstance,
   FastifyReply,
   FastifyRequest,
   HandlerOriginal,
   HookHandlerDoneFunction,
-  PluginFastifyReply,
-} from './internal-types';
+} from '../types';
 
 import type { FastifyInstrumentationConfig } from './types';
 import { endSpan, safeExecuteInTheMiddleMaybePromise, startSpan } from './utils';

packages/node/src/integrations/tracing/fastify-v3/constants.ts renamed to packages/node/src/integrations/tracing/fastify/v3/constants.ts

@@ -0,0 +1,24 @@
+/*
+ * Copyright The OpenTelemetry Authors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+// Vendored from: https://github.com/open-telemetry/opentelemetry-js-contrib/blob/407f61591ba69a39a6908264379d4d98a48dbec4/plugins/node/opentelemetry-instrumentation-fastify/src/internal-types.ts
+import type { Span } from '@opentelemetry/api';
+import type { FastifyReply } from '../types';
+import type { spanRequestSymbol } from './constants';
+
+export type PluginFastifyReply = FastifyReply & {
+  [spanRequestSymbol]?: Span[];
+};