opentelemetry-js/experimental/packages/opentelemetry-instrumentation/test/common/Instrumentation.test.ts

/*
 * Copyright The OpenTelemetry Authors
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      https://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

import * as assert from 'assert';
import {
  Instrumentation,
  InstrumentationBase,
  InstrumentationConfig,
  InstrumentationModuleDefinition,
  SpanCustomizationHook,
} from '../../src';

import { MeterProvider } from '@opentelemetry/sdk-metrics';
import { LoggerProvider } from '@opentelemetry/sdk-logs';

interface TestInstrumentationConfig extends InstrumentationConfig {
  isActive?: boolean;
}

class TestInstrumentation extends InstrumentationBase<TestInstrumentationConfig> {
  constructor(config = {}) {
    super('test', '1.0.0', config);
  }
  override enable() {}
  override disable() {}
  init() {}

  // the runInstrumentationEventHook, so we have to invoke it from the class for testing
  testRunHook(hookHandler?: SpanCustomizationHook<any>) {
    const span = this.tracer.startSpan('test');
    this._runSpanCustomizationHook(hookHandler, 'test', span, {});
  }
}

describe('BaseInstrumentation', () => {
  let instrumentation: Instrumentation;
  beforeEach(() => {
    instrumentation = new TestInstrumentation();
  });

  it('should create an instance', () => {
    assert.ok(instrumentation instanceof InstrumentationBase);
  });

  it('should have a name', () => {
    assert.deepStrictEqual(instrumentation.instrumentationName, 'test');
  });

  it('should have a version', () => {
    assert.deepStrictEqual(instrumentation.instrumentationVersion, '1.0.0');
  });

  describe('constructor', () => {
    it('should enable instrumentation by default', () => {
      let enableCalled = false;
      let updateMetricInstrumentsCalled = false;
      class TestInstrumentation2 extends TestInstrumentation {
        override enable() {
          enableCalled = true;
        }
        override _updateMetricInstruments() {
          updateMetricInstrumentsCalled = true;
        }
      }
      instrumentation = new TestInstrumentation2();
      assert.strictEqual(enableCalled, true);
      assert.strictEqual(updateMetricInstrumentsCalled, true);
    });
  });

  describe('setMeterProvider', () => {
    let otelTestingMeterProvider: MeterProvider;
    beforeEach(() => {
      otelTestingMeterProvider = new MeterProvider();
    });
    it('should call _updateMetricInstruments', () => {
      let called = true;
      class TestInstrumentation2 extends TestInstrumentation {
        override _updateMetricInstruments() {
          called = true;
        }
      }
      instrumentation = new TestInstrumentation2();
      instrumentation.setMeterProvider(otelTestingMeterProvider);
      assert.strictEqual(called, true);
    });
  });

  describe('setLoggerProvider', () => {
    it('should get a logger from provider', () => {
      let called = true;
      class TestLoggerProvider extends LoggerProvider {
        override getLogger(name: any, version?: any, options?: any) {
          called = true;
          return super.getLogger(name, version, options);
        }
      }
      instrumentation = new TestInstrumentation();
      if (instrumentation.setLoggerProvider) {
        instrumentation.setLoggerProvider(new TestLoggerProvider());
      }
      assert.strictEqual(called, true);
    });
  });

  describe('getConfig', () => {
    it('should return instrumentation config, "enabled" should be true by default', () => {
      const instrumentation: Instrumentation = new TestInstrumentation({
        isActive: false,
      });
      const configuration =
        instrumentation.getConfig() as TestInstrumentationConfig;
      assert.notStrictEqual(configuration, null);
      assert.strictEqual(configuration.isActive, false);
      assert.strictEqual(configuration.enabled, true);
    });
  });

  describe('setConfig', () => {
    it('should set a new config for instrumentation', () => {
      const instrumentation: Instrumentation = new TestInstrumentation();
      const config: TestInstrumentationConfig = {
        isActive: true,
      };
      instrumentation.setConfig(config);
      const configuration =
        instrumentation.getConfig() as TestInstrumentationConfig;
      assert.strictEqual(configuration.isActive, true);
    });

    it('should ensure "enabled" defaults to true', () => {
      const instrumentation: Instrumentation = new TestInstrumentation();
      const config: TestInstrumentationConfig = {
        isActive: true,
      };
      instrumentation.setConfig(config);
      const configuration =
        instrumentation.getConfig() as TestInstrumentationConfig;
      assert.strictEqual(configuration.enabled, true);
      assert.strictEqual(configuration.isActive, true);
    });
  });

  describe('getModuleDefinitions', () => {
    const moduleDefinition: InstrumentationModuleDefinition = {
      name: 'foo',
      patch: moduleExports => {},
      unpatch: moduleExports => {},
      moduleExports: {},
      files: [],
      supportedVersions: ['*'],
    };

    it('should return single module definition from init() as array ', () => {
      class TestInstrumentation2 extends TestInstrumentation {
        override init() {
          return moduleDefinition;
        }
      }
      const instrumentation = new TestInstrumentation2();

      assert.deepStrictEqual(instrumentation.getModuleDefinitions(), [
        moduleDefinition,
      ]);
    });

    it('should return multiple module definitions from init() as array ', () => {
      class TestInstrumentation2 extends TestInstrumentation {
        override init() {
          return [moduleDefinition, moduleDefinition, moduleDefinition];
        }
      }
      const instrumentation = new TestInstrumentation2();

      assert.deepStrictEqual(instrumentation.getModuleDefinitions(), [
        moduleDefinition,
        moduleDefinition,
        moduleDefinition,
      ]);
    });

    it('should return void from init() as empty array ', () => {
      class TestInstrumentation2 extends TestInstrumentation {
        override init() {
          return;
        }
      }
      const instrumentation = new TestInstrumentation2();

      assert.deepStrictEqual(instrumentation.getModuleDefinitions(), []);
    });

    describe('runInstrumentationEventHook', () => {
      it('should call the hook', () => {
        const instrumentation = new TestInstrumentation({});
        let called = false;
        const hook = () => {
          called = true;
        };
        instrumentation.testRunHook(hook);
        assert.strictEqual(called, true);
      });

      it('empty hook should work', () => {
        const instrumentation = new TestInstrumentation({});
        instrumentation.testRunHook(undefined);
      });

      it('exception in hook should not crash', () => {
        const instrumentation = new TestInstrumentation({});
        const hook = () => {
          throw new Error('test');
        };
        instrumentation.testRunHook(hook);
      });
    });
  });
});