feat: added kLayerPatched check

open-telemetry · Jul 10, 2020 · 9b93428 · 9b93428
1 parent 0200d23
commit 9b93428
Show file tree

Hide file tree

Showing 5 changed files with 21 additions and 19 deletions.
diff --git a/plugins/node/opentelemetry-plugin-koa/package.json b/plugins/node/opentelemetry-plugin-koa/package.json
@@ -4,7 +4,7 @@
   "description": "OpenTelemetry Koa automatic instrumentation package.",
   "main": "build/src/index.js",
   "types": "build/src/index.d.ts",
-  "repository": "open-telemetry/opentelemetry-js",
+  "repository": "open-telemetry/opentelemetry-js-contrib",
   "scripts": {
     "test": "nyc ts-mocha -p tsconfig.json 'test/**/*.ts'",
     "codecov": "nyc report --reporter=json && codecov -f coverage/*.json -p ../../",

diff --git a/plugins/node/opentelemetry-plugin-koa/src/koa.ts b/plugins/node/opentelemetry-plugin-koa/src/koa.ts
@@ -14,16 +14,22 @@
  * limitations under the License.
  */
 
-import { BasePlugin } from '@opentelemetry/core';
+import { BasePlugin, hrTime } from '@opentelemetry/core';
 import * as koa from 'koa';
 import * as shimmer from 'shimmer';
 import { Parameters, KoaMiddleware, KoaContext, KoaComponentName } from './types';
 import { VERSION } from './version';
 import { getMiddlewareMetadata } from './utils';
-// import { Layer } from '@koa/router';
 import Router = require('@koa/router');
 
 
+/**
+ * This symbol is used to mark a Koa layer as being already instrumented
+ * since its possible to use a given layer multiple times (ex: middlewares)
+ */
+export const kLayerPatched: unique symbol = Symbol('koa-layer-patched');
+
+
 /** Koa instrumentation plugin for OpenTelemetry */
 export class KoaPlugin extends BasePlugin<typeof koa> {
   static readonly component = KoaComponentName;
@@ -86,8 +92,11 @@ export class KoaPlugin extends BasePlugin<typeof koa> {
 
   }
 
-  private _patchLayer (middlewareLayer: KoaMiddleware, isRouter: boolean, layerPath?: string) {
+  private _patchLayer (middlewareLayer: KoaMiddleware, isRouter: boolean, layerPath?: string) : KoaMiddleware {
     const plugin = this;
+    if (middlewareLayer[kLayerPatched] === true) return middlewareLayer;
+    middlewareLayer[kLayerPatched] = true;
+
     const patchedLayer = (context: KoaContext, next: koa.Next) => {
         if (plugin._tracer.getCurrentSpan() === undefined) {
 
@@ -97,9 +106,10 @@ export class KoaPlugin extends BasePlugin<typeof koa> {
         const span = plugin._tracer.startSpan(metadata.name, {
           attributes: metadata.attributes,
         });
+        const startTime = hrTime();
 
         var result = middlewareLayer(context, next);
-        span.end();
+        span.end(startTime);
         return result;
     }
     return patchedLayer;
@@ -118,9 +128,8 @@ export class KoaPlugin extends BasePlugin<typeof koa> {
       var path = pathLayer.path;
       var pathStack = pathLayer.stack;
       for (var j = 0; j < pathStack.length; j++) {
-        var pop = pathStack[j];
-        var newpop = plugin._patchLayer(pop, true, path);
-        pathStack[j] = newpop;
+        var routedMiddleware : KoaMiddleware = pathStack[j];
+        pathStack[j] = plugin._patchLayer(routedMiddleware, true, path);;
       }
     }
 

diff --git a/plugins/node/opentelemetry-plugin-koa/src/types.ts b/plugins/node/opentelemetry-plugin-koa/src/types.ts
@@ -15,22 +15,15 @@
  */
 import { Middleware, ParameterizedContext} from 'koa';
 import { RouterParamContext} from '@koa/router';
+import { kLayerPatched } from './koa';
 
 export type Parameters<T> = T extends (...args: infer T) => any ? T : unknown[];
 
-export type KoaMiddleware = Middleware<any, RouterParamContext>;
+export type KoaMiddleware = Middleware<any, RouterParamContext> & {[kLayerPatched]?: boolean;};
 
 // export type KoaContext = ParameterizedContext<ParameterizedContext<any, DefaultContext>, DefaultContext>;
 export type KoaContext = ParameterizedContext<ParameterizedContext<any, any>, any>;
 
-export type KoaLayer = {
-    handle: Function;
-    name: string;
-    params: { [key: string]: string };
-    path: string;
-    regexp: RegExp;
-  };
-
 export enum AttributeNames {
     COMPONENT = 'component',
     HTTP_ROUTE = 'http.route',

diff --git a/plugins/node/opentelemetry-plugin-koa/test/koa-router.test.ts b/plugins/node/opentelemetry-plugin-koa/test/koa-router.test.ts
@@ -55,7 +55,7 @@ const httpRequest = {
 };
 
 
-describe('Koa Plugin', () => {
+describe('Koa Plugin - Router Tests', () => {
     const logger = new NoopLogger();
     const provider = new NodeTracerProvider();
     const memoryExporter = new InMemorySpanExporter();

diff --git a/plugins/node/opentelemetry-plugin-koa/test/koa.test.ts b/plugins/node/opentelemetry-plugin-koa/test/koa.test.ts
@@ -52,7 +52,7 @@ const httpRequest = {
 };
 
 
-describe('Koa Plugin', () => {
+describe('Koa Plugin - Core Tests', () => {
     const logger = new NoopLogger();
     const provider = new NodeTracerProvider();
     const memoryExporter = new InMemorySpanExporter();