fix: Removed deprecated properties usage in Fastify instrumentation (#…

…1679) Co-authored-by: Marc Pichler <[email protected]>
open-telemetry · Oct 10, 2023 · d3328f8 · d3328f8
1 parent 52dd42d
commit d3328f8
Show file tree

Hide file tree

Showing 4 changed files with 20 additions and 16 deletions.
diff --git a/plugins/node/opentelemetry-instrumentation-fastify/package.json b/plugins/node/opentelemetry-instrumentation-fastify/package.json
@@ -54,7 +54,7 @@
     "@opentelemetry/sdk-trace-node": "^1.8.0",
     "@types/express": "4.17.18",
     "@types/mocha": "7.0.2",
-    "@types/node": "18.6.5",
+    "@types/node": "18.15.3",
     "fastify": "4.18.0",
     "mocha": "7.2.0",
     "nyc": "15.1.0",

diff --git a/plugins/node/opentelemetry-instrumentation-fastify/src/instrumentation.ts b/plugins/node/opentelemetry-instrumentation-fastify/src/instrumentation.ts
@@ -93,8 +93,11 @@ export class FastifyInstrumentation extends InstrumentationBase {
       }
       instrumentation._wrap(reply, 'send', instrumentation._patchSend());
 
+      const anyRequest = request as any;
+
       const rpcMetadata = getRPCMetadata(context.active());
-      const routeName = request.routerPath;
+      const routeName =
+        anyRequest.routeOptions?.config?.url || request.routerPath;
       if (routeName && rpcMetadata?.type === RPCType.HTTP) {
         rpcMetadata.route = routeName;
       }
@@ -176,22 +179,22 @@ export class FastifyInstrumentation extends InstrumentationBase {
         const handler = args[1] as HandlerOriginal;
         const pluginName = this.pluginName;
         if (applicationHookNames.includes(name)) {
-          return original.apply(this, [name as any, handler]);
+          return original.apply(this, [name, handler] as never);
         }
 
         const syncFunctionWithDone =
           typeof args[args.length - 1] === 'function' &&
           handler.constructor.name !== 'AsyncFunction';
 
         return original.apply(this, [
-          name as any,
+          name,
           instrumentation._wrapHandler(
             pluginName,
             name,
             handler,
             syncFunctionWithDone
           ),
-        ]);
+        ] as never);
       };
     };
   }
@@ -259,16 +262,21 @@ export class FastifyInstrumentation extends InstrumentationBase {
       if (!instrumentation.isEnabled()) {
         return done();
       }
-      const requestContext = (request as any).context || {};
-      const handlerName = (requestContext.handler?.name || '').substr(6);
+      const anyRequest = request as any;
+
+      const handler =
+        anyRequest.routeOptions?.handler || anyRequest.context?.handler || {};
+
+      const handlerName = handler?.name.substr(6);
       const spanName = `${FastifyNames.REQUEST_HANDLER} - ${
         handlerName || this.pluginName || ANONYMOUS_NAME
       }`;
 
       const spanAttributes: SpanAttributes = {
         [AttributeNames.PLUGIN_NAME]: this.pluginName,
         [AttributeNames.FASTIFY_TYPE]: FastifyTypes.REQUEST_HANDLER,
-        [SemanticAttributes.HTTP_ROUTE]: request.routerPath,
+        [SemanticAttributes.HTTP_ROUTE]:
+          anyRequest.routeOptions?.config?.url || request.routerPath,
       };
       if (handlerName) {
         spanAttributes[AttributeNames.FASTIFY_NAME] = handlerName;

diff --git a/plugins/node/opentelemetry-instrumentation-fastify/src/utils.ts b/plugins/node/opentelemetry-instrumentation-fastify/src/utils.ts
@@ -14,12 +14,7 @@
  * limitations under the License.
  */
 
-import {
-  Span,
-  SpanAttributes,
-  SpanStatusCode,
-  Tracer,
-} from '@opentelemetry/api';
+import { Attributes, Span, SpanStatusCode, Tracer } from '@opentelemetry/api';
 import { spanRequestSymbol } from './constants';
 
 import type { PluginFastifyReply } from './internal-types';
@@ -35,13 +30,14 @@ export function startSpan(
   reply: PluginFastifyReply,
   tracer: Tracer,
   spanName: string,
-  spanAttributes: SpanAttributes = {}
+  spanAttributes: Attributes = {}
 ) {
   const span = tracer.startSpan(spanName, { attributes: spanAttributes });
 
   const spans: Span[] = reply[spanRequestSymbol] || [];
   spans.push(span);
 
+  // eslint-disable-next-line @typescript-eslint/no-floating-promises
   Object.defineProperty(reply, spanRequestSymbol, {
     enumerable: false,
     configurable: true,

diff --git a/plugins/node/opentelemetry-instrumentation-fastify/test/instrumentation.test.ts b/plugins/node/opentelemetry-instrumentation-fastify/test/instrumentation.test.ts
@@ -190,7 +190,7 @@ describe('fastify', () => {
         async function subsystem(fastify: FastifyInstance) {
           fastify.addHook(
             'onRequest',
-            async (
+            (
               req: FastifyRequest,
               res: FastifyReply,
               next: HookHandlerDoneFunction