fix(instrumentation-node): refactor methods to private with ts-expect…

…-error within tests
open-telemetry · May 13, 2021 · 159eb90 · 159eb90
1 parent 1137b9c
commit 159eb90
Show file tree

Hide file tree

Showing 2 changed files with 12 additions and 21 deletions.
diff --git a/packages/opentelemetry-instrumentation/src/platform/node/instrumentation.ts b/packages/opentelemetry-instrumentation/src/platform/node/instrumentation.ts
@@ -59,7 +59,7 @@ export abstract class InstrumentationBase<T = any>
     }
   }
 
-  protected _onRequire<T>(
+  private _onRequire<T>(
     module: InstrumentationModuleDefinition<T>,
     exports: T,
     name: string,
@@ -102,15 +102,15 @@ export abstract class InstrumentationBase<T = any>
     return exports;
   }
 
-  protected getModuleVersion(directory: string): string {
+  private getModuleVersion(directory: string): string {
     const modulePackage = this.findModulePackage(directory);
     if (!modulePackage) {
       return '0.0.0';
     }
     return modulePackage.version;
   }
 
-  protected findModulePackage(directory: string): any {
+  private findModulePackage(directory: string): unknown {
     const parentDirectory = path.dirname(directory)
     if (directory === parentDirectory) { return; }
     let contents = null
@@ -122,7 +122,7 @@ export abstract class InstrumentationBase<T = any>
     return this.findModulePackage(parentDirectory)
   }
 
-  protected loadModulePackage(directory: string): any {
+  private loadModulePackage(directory: string): unknown {
     return require(path.join(directory, 'package.json'))
   }
 

diff --git a/packages/opentelemetry-instrumentation/test/common/Instrumentation.test.ts b/packages/opentelemetry-instrumentation/test/common/Instrumentation.test.ts
@@ -25,23 +25,6 @@ class TestInstrumentation extends InstrumentationBase {
   enable() {}
   disable() {}
   init() {}
-  _onRequire<T>(
-    module: InstrumentationModuleDefinition<T>,
-    exports: T,
-    name: string,
-    baseDir?: string
-  ): T {
-    return super._onRequire(module, exports, name, baseDir)
-  }
-  getModuleVersion(directory: string): string {
-    return super.getModuleVersion(directory)
-  }
-  findModulePackage(directory: string): any {
-    return super.findModulePackage(directory)
-  }
-  loadModulePackage(directory: string): any {
-    return super.loadModulePackage(directory)
-  }
 }
 
 describe('BaseInstrumentation', () => {
@@ -78,11 +61,15 @@ describe('BaseInstrumentation', () => {
   describe('_onRequire', () => {
     it('loads package.json recursively returning 0.0.0 when undiscovered', () => {
       const instrumentation = new TestInstrumentation()
+      // @ts-expect-error access internal property for testing
       const versionSpy = sinon.spy(instrumentation, 'getModuleVersion');
+      // @ts-expect-error access internal property for testing
       const findSpy = sinon.spy(instrumentation, 'findModulePackage');
+      // @ts-expect-error access internal property for testing
       const loadSpy = sinon.spy(instrumentation, 'loadModulePackage')
 
       const moduleDefinition = {} as InstrumentationModuleDefinition<unknown>
+      // @ts-expect-error access internal property for testing
       instrumentation._onRequire<unknown>(
         moduleDefinition,
         {} as unknown,
@@ -100,8 +87,11 @@ describe('BaseInstrumentation', () => {
 
     it('loads package.json recursively returning version when discovered', () => {
       const instrumentation = new TestInstrumentation()
+      // @ts-expect-error access internal property for testing
       const versionSpy = sinon.spy(instrumentation, 'getModuleVersion');
+      // @ts-expect-error access internal property for testing
       const findSpy = sinon.spy(instrumentation, 'findModulePackage');
+      // @ts-expect-error access internal property for testing
       const loadStub = sinon.stub(instrumentation, 'loadModulePackage')
 
       loadStub.withArgs('/foo/bar').returns({
@@ -110,6 +100,7 @@ describe('BaseInstrumentation', () => {
       })
 
       const moduleDefinition = {} as InstrumentationModuleDefinition<unknown>
+      // @ts-expect-error access internal property for testing
       instrumentation._onRequire<unknown>(
         moduleDefinition,
         {} as unknown,