feat(plugin): add http plugin

Closes open-telemetry#157 Signed-off-by: Olivier Albertini <[email protected]>
OlivierAlbertini · Aug 5, 2019 · a99e08d · a99e08d
1 parent 20c9a49
commit a99e08d
Show file tree

Hide file tree

Showing 10 changed files with 893 additions and 2 deletions.
diff --git a/packages/opentelemetry-basic-tracer/src/BasicTracer.ts b/packages/opentelemetry-basic-tracer/src/BasicTracer.ts
@@ -34,7 +34,7 @@ export class BasicTracer implements types.Tracer {
   private readonly _binaryFormat: types.BinaryFormat;
   private readonly _httpTextFormat: types.HttpTextFormat;
   private readonly _sampler: types.Sampler;
-  private readonly _scopeManager: ScopeManager;
+  protected readonly _scopeManager: ScopeManager;
 
   /**
    * Constructs a new Tracer instance.

diff --git a/packages/opentelemetry-node-tracer/src/NodeTracer.ts b/packages/opentelemetry-node-tracer/src/NodeTracer.ts
@@ -31,4 +31,15 @@ export class NodeTracer extends BasicTracer {
 
     // @todo: Integrate Plugin Loader (pull/126).
   }
+
+  /**
+   * Binds the trace context to the given event emitter.
+   * This is necessary in order to create child spans correctly in event
+   * handlers.
+   * @param emitter An event emitter whose handlers should have
+   *     the trace context binded to them.
+   */
+  wrapEmitter(emitter: NodeJS.EventEmitter, scope?: unknown): void {
+    this._scopeManager.bind(emitter, scope);
+  }
 }
diff --git a/packages/opentelemetry-node-tracer/src/index.ts b/packages/opentelemetry-node-tracer/src/index.ts
@@ -13,3 +13,5 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
+
+ export * from './NodeTracer';
diff --git a/packages/opentelemetry-node-tracer/test/NodeTracer.test.ts b/packages/opentelemetry-node-tracer/test/NodeTracer.test.ts
@@ -25,6 +25,7 @@ import {
 } from '@opentelemetry/core';
 import { AsyncHooksScopeManager } from '@opentelemetry/scope-async-hooks';
 import { NodeTracer } from '../src/NodeTracer';
+import { EventEmitter } from 'events';
 
 describe('NodeTracer', () => {
   describe('constructor', () => {
@@ -180,4 +181,40 @@ describe('NodeTracer', () => {
       assert.ok(tracer.getHttpTextFormat() instanceof HttpTraceContext);
     });
   });
+  describe.only('.wrapEmitter()', () => {
+    it('should not throw', () => {
+      const tracer = new NodeTracer({
+        scopeManager: new AsyncHooksScopeManager(),
+      });
+      tracer.wrapEmitter(undefined as any);
+    });
+    // TODO: remove skip onace https://github.com/open-telemetry/opentelemetry-js/pull/146 is merged
+    it.skip('should get current Span', (done) => {
+      const tracer = new NodeTracer({
+        scopeManager: new AsyncHooksScopeManager(),
+      });
+
+      const span = tracer.startSpan('my-span');
+      class FakeEventEmitter extends EventEmitter {
+        constructor() {
+          super()
+        }
+        test() {
+          this.emit('event');
+        }
+      }
+
+      tracer.withSpan(span, () => {
+        const fake = new FakeEventEmitter();
+        tracer.wrapEmitter(fake);
+        fake.on('event', () => {
+          setTimeout(() => {
+            assert.deepStrictEqual(tracer.getCurrentSpan(), span);
+            done();
+          }, 100);
+        });
+        fake.test();
+      });
+    });
+  });
 });
diff --git a/packages/opentelemetry-plugin-http/package.json b/packages/opentelemetry-plugin-http/package.json
@@ -38,19 +38,30 @@
     "access": "public"
   },
   "devDependencies": {
+    "@opentelemetry/scope-async-hooks": "^0.0.1",
     "@types/mocha": "^5.2.7",
     "@types/node": "^12.6.9",
+    "@types/semver": "^6.0.1",
+    "@types/shimmer": "^1.0.1",
+    "@types/sinon":"^7.0.13",
     "codecov": "^3.5.0",
     "gts": "^1.1.0",
     "mocha": "^6.2.0",
     "nyc": "^14.1.1",
+    "sinon": "^7.3.2",
+    "c8": "^5.0.1",
+    "nock": "^10.0.6",
     "ts-mocha": "^6.0.0",
     "ts-node": "^8.3.0",
     "typescript": "^3.5.3"
   },
   "dependencies": {
     "@opentelemetry/core": "^0.0.1",
     "@opentelemetry/node-tracer": "^0.0.1",
-    "@opentelemetry/types": "^0.0.1"
+    "@opentelemetry/types": "^0.0.1",
+    "@types/nock": "^10.0.3",
+    "nock": "^10.0.6",
+    "semver": "^6.3.0",
+    "shimmer": "^1.2.1"
   }
 }