Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

chore: remove references to Noop classes from API #2230

Merged
merged 3 commits into from
May 27, 2021
Merged

chore: remove references to Noop classes from API #2230

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
c975514
chore: remove references to Noop classes from API
dyladan May 26, 2021
23d856c
chore: add mock enable
dyladan May 26, 2021
efcfaaf
Merge branch 'main' into remove-noop-classes
dyladan May 26, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 12 additions & 13 deletions packages/opentelemetry-node/test/registration.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,6 @@

import {
context,
NoopTextMapPropagator,
propagation,
trace,
ProxyTracerProvider,
Expand All @@ -25,7 +24,6 @@ import {
AsyncHooksContextManager,
AsyncLocalStorageContextManager,
} from '@opentelemetry/context-async-hooks';
import { NoopContextManager } from '@opentelemetry/api';
import { CompositePropagator } from '@opentelemetry/core';
import * as assert from 'assert';
import { NodeTracerProvider } from '../src';
Expand Down Expand Up @@ -58,28 +56,29 @@ describe('API registration', () => {
it('should register configured implementations', () => {
const tracerProvider = new NodeTracerProvider();

const contextManager = new NoopContextManager();
const propagator = new NoopTextMapPropagator();
const mockContextManager = { disable() {} } as any;
dyladan marked this conversation as resolved.
Show resolved Hide resolved
const mockPropagator = {} as any;

tracerProvider.register({
contextManager,
propagator,
contextManager: mockContextManager,
propagator: mockPropagator,
});

assert.ok(context['_getContextManager']() === contextManager);
assert.ok(propagation['_getGlobalPropagator']() === propagator);
assert.strictEqual(context['_getContextManager'](), mockContextManager);
assert.strictEqual(propagation['_getGlobalPropagator'](), mockPropagator);

const apiTracerProvider = trace.getTracerProvider() as ProxyTracerProvider;
assert.ok(apiTracerProvider.getDelegate() === tracerProvider);
assert.strictEqual(apiTracerProvider.getDelegate(), tracerProvider);
});

it('should skip null context manager', () => {
const tracerProvider = new NodeTracerProvider();
const ctxManager = context['_getContextManager']();
tracerProvider.register({
contextManager: null,
});

assert.ok(context['_getContextManager']() instanceof NoopContextManager);
assert.strictEqual(context['_getContextManager'](), ctxManager, "context manager should not change");

assert.ok(
propagation['_getGlobalPropagator']() instanceof CompositePropagator
Expand All @@ -90,14 +89,14 @@ describe('API registration', () => {
});

it('should skip null propagator', () => {
const propagator = propagation['_getGlobalPropagator']();

const tracerProvider = new NodeTracerProvider();
tracerProvider.register({
propagator: null,
});

assert.ok(
propagation['_getGlobalPropagator']() instanceof NoopTextMapPropagator
);
assert.strictEqual(propagation['_getGlobalPropagator'](), propagator);

assert.ok(context['_getContextManager']() instanceof DefaultContextManager);

Expand Down
31 changes: 14 additions & 17 deletions packages/opentelemetry-sdk-node/test/sdk.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,8 +16,6 @@

import {
context,
NoopTextMapPropagator,
NoopTracerProvider,
propagation,
ProxyTracerProvider,
trace,
Expand All @@ -29,7 +27,6 @@ import {
AsyncHooksContextManager,
AsyncLocalStorageContextManager,
} from '@opentelemetry/context-async-hooks';
import { NoopContextManager } from '@opentelemetry/api';
import { CompositePropagator } from '@opentelemetry/core';
import { ConsoleMetricExporter, MeterProvider } from '@opentelemetry/metrics';
import { NodeTracerProvider } from '@opentelemetry/node';
Expand Down Expand Up @@ -89,6 +86,10 @@ const DefaultContextManager = semver.gte(process.version, '14.8.0')
: AsyncHooksContextManager;

describe('Node SDK', () => {
let ctxManager: any;
let propagator: any;
let delegate: any;

before(() => {
nock.disableNetConnect();
});
Expand All @@ -98,6 +99,10 @@ describe('Node SDK', () => {
trace.disable();
propagation.disable();
metrics.disable();

ctxManager = context['_getContextManager']();
propagator = propagation['_getGlobalPropagator']();
delegate = (trace.getTracerProvider() as ProxyTracerProvider).getDelegate();
});

describe('Basic Registration', () => {
Expand All @@ -108,13 +113,9 @@ describe('Node SDK', () => {

await sdk.start();

assert.ok(context['_getContextManager']() instanceof NoopContextManager);
assert.ok(
propagation['_getGlobalPropagator']() instanceof NoopTextMapPropagator
);

const apiTracerProvider = trace.getTracerProvider() as ProxyTracerProvider;
assert.ok(apiTracerProvider.getDelegate() instanceof NoopTracerProvider);
assert.strictEqual(context['_getContextManager'](), ctxManager, "context manager should not change");
assert.strictEqual(propagation['_getGlobalPropagator'](), propagator, "propagator should not change");
assert.strictEqual((trace.getTracerProvider() as ProxyTracerProvider).getDelegate(), delegate, "tracer provider should not have changed");

assert.ok(metrics.getMeterProvider() instanceof NoopMeterProvider);
});
Expand Down Expand Up @@ -172,13 +173,9 @@ describe('Node SDK', () => {

await sdk.start();

assert.ok(context['_getContextManager']() instanceof NoopContextManager);
assert.ok(
propagation['_getGlobalPropagator']() instanceof NoopTextMapPropagator
);

const apiTracerProvider = trace.getTracerProvider() as ProxyTracerProvider;
assert.ok(apiTracerProvider.getDelegate() instanceof NoopTracerProvider);
assert.strictEqual(context['_getContextManager'](), ctxManager, "context manager should not change");
assert.strictEqual(propagation['_getGlobalPropagator'](), propagator, "propagator should not change");
assert.strictEqual((trace.getTracerProvider() as ProxyTracerProvider).getDelegate(), delegate, "tracer provider should not have changed");

assert.ok(metrics.getMeterProvider() instanceof MeterProvider);
});
Expand Down
14 changes: 6 additions & 8 deletions packages/opentelemetry-web/test/registration.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,8 +16,6 @@

import {
context,
NoopContextManager,
NoopTextMapPropagator,
propagation,
trace,
ProxyTracerProvider,
Expand Down Expand Up @@ -48,8 +46,8 @@ describe('API registration', () => {
it('should register configured implementations', () => {
const tracerProvider = new WebTracerProvider();

const contextManager = new NoopContextManager();
const propagator = new NoopTextMapPropagator();
const contextManager = { disable() { }, enable() { } } as any;
const propagator = {} as any;

tracerProvider.register({
contextManager,
Expand All @@ -64,12 +62,13 @@ describe('API registration', () => {
});

it('should skip null context manager', () => {
const ctxManager = context['_getContextManager']();
const tracerProvider = new WebTracerProvider();
tracerProvider.register({
contextManager: null,
});

assert.ok(context['_getContextManager']() instanceof NoopContextManager);
assert.strictEqual(context['_getContextManager'](), ctxManager, "context manager should not change");

assert.ok(
propagation['_getGlobalPropagator']() instanceof CompositePropagator
Expand All @@ -79,14 +78,13 @@ describe('API registration', () => {
});

it('should skip null propagator', () => {
const propagator = propagation['_getGlobalPropagator']();
const tracerProvider = new WebTracerProvider();
tracerProvider.register({
propagator: null,
});

assert.ok(
propagation['_getGlobalPropagator']() instanceof NoopTextMapPropagator
);
assert.strictEqual(propagation["_getGlobalPropagator"](), propagator, "propagator should not change")

assert.ok(context['_getContextManager']() instanceof StackContextManager);
const apiTracerProvider = trace.getTracerProvider() as ProxyTracerProvider;
Expand Down