chore(scope-managers): return undefined if no scope is found (following

open-telemetry#569)
mayurkale22 · Dec 10, 2019 · c699f14 · c699f14
1 parent c125012
commit c699f14
Show file tree

Hide file tree

Showing 4 changed files with 15 additions and 7 deletions.
diff --git a/packages/opentelemetry-scope-async-hooks/src/AsyncHooksScopeManager.ts b/packages/opentelemetry-scope-async-hooks/src/AsyncHooksScopeManager.ts
@@ -50,7 +50,7 @@ export class AsyncHooksScopeManager implements ScopeManager {
   }
 
   active(): unknown {
-    return this._scopes[asyncHooks.executionAsyncId()] || null;
+    return this._scopes[asyncHooks.executionAsyncId()] || undefined;
   }
 
   with<T extends (...args: unknown[]) => ReturnType<T>>(

diff --git a/packages/opentelemetry-scope-async-hooks/test/AsyncHooksScopeManager.test.ts b/packages/opentelemetry-scope-async-hooks/test/AsyncHooksScopeManager.test.ts
@@ -135,7 +135,7 @@ describe('AsyncHooksScopeManager', () => {
         setTimeout(() => {
           assert.strictEqual(
             scopeManager.active(),
-            null,
+            undefined,
             'should have no scope'
           );
           return done();
@@ -228,7 +228,7 @@ describe('AsyncHooksScopeManager', () => {
       const patchedEe = scopeManager.bind(ee, scope);
       const handler = () => {
         setImmediate(() => {
-          assert.deepStrictEqual(scopeManager.active(), null);
+          assert.deepStrictEqual(scopeManager.active(), undefined);
           patchedEe.removeAllListeners('test');
           assert.strictEqual(patchedEe.listeners('test').length, 0);
           return done();

diff --git a/packages/opentelemetry-scope-base/src/NoopScopeManager.ts b/packages/opentelemetry-scope-base/src/NoopScopeManager.ts
@@ -18,7 +18,7 @@ import * as types from './types';
 
 export class NoopScopeManager implements types.ScopeManager {
   active(): unknown {
-    return null;
+    return undefined;
   }
 
   with<T extends (...args: unknown[]) => ReturnType<T>>(

diff --git a/packages/opentelemetry-scope-base/test/NoopScopeManager.test.ts b/packages/opentelemetry-scope-base/test/NoopScopeManager.test.ts
@@ -48,7 +48,7 @@ describe('NoopScopeManager', () => {
       scopeManager.with(test, () => {
         assert.strictEqual(
           scopeManager.active(),
-          null,
+          undefined,
           'should not have scope'
         );
         return done();
@@ -66,12 +66,20 @@ describe('NoopScopeManager', () => {
 
   describe('.active()', () => {
     it('should always return null (when enabled)', () => {
-      assert.strictEqual(scopeManager.active(), null, 'should not have scope');
+      assert.strictEqual(
+        scopeManager.active(),
+        undefined,
+        'should not have scope'
+      );
     });
 
     it('should always return null (when disabled)', () => {
       scopeManager.disable();
-      assert.strictEqual(scopeManager.active(), null, 'should not have scope');
+      assert.strictEqual(
+        scopeManager.active(),
+        undefined,
+        'should not have scope'
+      );
       scopeManager.enable();
     });
   });