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.

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

chore: remove references to NOOP singletons #2229

Merged
merged 4 commits into from
May 27, 2021
Merged
Show file tree
Hide file tree
Changes from 2 commits
Commits
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
13 changes: 6 additions & 7 deletions packages/opentelemetry-instrumentation-http/src/http.ts
Original file line number Diff line number Diff line change
Expand Up @@ -14,16 +14,17 @@
* limitations under the License.
*/
import {
SpanStatusCode,
context,
diag,
INVALID_SPAN_CONTEXT,
propagation,
ROOT_CONTEXT,
Span,
SpanKind,
SpanOptions,
SpanStatus,
ROOT_CONTEXT,
NOOP_TRACER,
diag, trace,
SpanStatusCode,
trace,
} from '@opentelemetry/api';
import { suppressTracing } from '@opentelemetry/core';
import type * as http from 'http';
Expand Down Expand Up @@ -599,9 +600,7 @@ export class HttpInstrumentation extends InstrumentationBase<Http> {
const currentSpan = trace.getSpan(ctx);

if (requireParent === true && currentSpan === undefined) {
// TODO: Refactor this when a solution is found in
// https://github.com/open-telemetry/opentelemetry-specification/issues/530
span = NOOP_TRACER.startSpan(name, options, ctx);
span = trace.wrapSpanContext(INVALID_SPAN_CONTEXT);
} else if (requireParent === true && currentSpan?.spanContext().isRemote) {
span = currentSpan;
} else {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,6 @@
* See the License for the specific language governing permissions and
* limitations under the License.
*/
import { NoopTracerProvider, NOOP_TRACER } from '@opentelemetry/api';
import * as assert from 'assert';
import { HttpInstrumentation } from '../../src/http';
import { AddressInfo } from 'net';
Expand All @@ -27,14 +26,24 @@ instrumentation.enable();
instrumentation.disable();

import * as http from 'http';
import { trace, TracerProvider, INVALID_SPAN_CONTEXT } from '@opentelemetry/api';


describe('HttpInstrumentation', () => {
let server: http.Server;
let serverPort = 0;

describe('disable()', () => {
const provider = new NoopTracerProvider();
let provider: TracerProvider;
let startSpanStub: sinon.SinonStub;

before(() => {
provider = {
getTracer: () => {
startSpanStub = sinon.stub().returns(trace.wrapSpanContext(INVALID_SPAN_CONTEXT));
return { startSpan: startSpanStub } as any;
}
};
nock.cleanAll();
nock.enableNetConnect();
instrumentation.enable();
Expand All @@ -51,10 +60,6 @@ describe('HttpInstrumentation', () => {
});
});

beforeEach(() => {
sinon.spy(NOOP_TRACER, 'startSpan');
});

afterEach(() => {
sinon.restore();
});
Expand All @@ -71,11 +76,8 @@ describe('HttpInstrumentation', () => {

const options = { host: 'localhost', path: testPath, port: serverPort };

await httpRequest.get(options).then(result => {
assert.strictEqual(
(NOOP_TRACER.startSpan as sinon.SinonSpy).called,
false
);
await httpRequest.get(options).then(() => {
sinon.assert.notCalled(startSpanStub);
});
});
});
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,6 @@
* limitations under the License.
*/

import { NoopTracerProvider, NOOP_TRACER } from '@opentelemetry/api';
import * as assert from 'assert';
import * as fs from 'fs';
import type { AddressInfo } from 'net';
Expand All @@ -29,14 +28,23 @@ instrumentation.disable();

import * as https from 'https';
import { httpsRequest } from '../utils/httpsRequest';
import { INVALID_SPAN_CONTEXT, trace, TracerProvider } from '@opentelemetry/api';

describe('HttpsInstrumentation', () => {
let server: https.Server;
let serverPort = 0;

describe('disable()', () => {
const provider = new NoopTracerProvider();
let provider: TracerProvider;
let startSpanStub: sinon.SinonStub;

before(() => {
provider = {
getTracer: () => {
startSpanStub = sinon.stub().returns(trace.wrapSpanContext(INVALID_SPAN_CONTEXT));
return { startSpan: startSpanStub } as any;
}
};
nock.cleanAll();
nock.enableNetConnect();

Expand All @@ -60,10 +68,6 @@ describe('HttpsInstrumentation', () => {
});
});

beforeEach(() => {
sinon.spy(NOOP_TRACER, 'startSpan');
});

afterEach(() => {
sinon.restore();
});
Expand All @@ -78,12 +82,8 @@ describe('HttpsInstrumentation', () => {

const options = { host: 'localhost', path: testPath, port: serverPort };

await httpsRequest.get(options).then(result => {
assert.strictEqual(
(NOOP_TRACER.startSpan as sinon.SinonSpy).called,
false
);

await httpsRequest.get(options).then(() => {
sinon.assert.notCalled(startSpanStub);
assert.strictEqual(isWrapped(https.Server.prototype.emit), false);
});
});
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,12 +14,17 @@
* limitations under the License.
*/

import { NOOP_TRACER_PROVIDER } from '@opentelemetry/api';
import { Tracer, TracerProvider } from '@opentelemetry/api';
import { NOOP_METER_PROVIDER } from '@opentelemetry/api-metrics';
import * as assert from 'assert';
import * as sinon from 'sinon';
import { InstrumentationBase, registerInstrumentations } from '../../src';

class DummyTracerProvider implements TracerProvider {
getTracer(name: string, version?: string): Tracer {
throw new Error("not implemented");
}
}
class FooInstrumentation extends InstrumentationBase {
init() {
return [];
Expand All @@ -45,7 +50,7 @@ describe('autoLoader', () => {
let enableSpy: sinon.SinonSpy;
let setTracerProviderSpy: sinon.SinonSpy;
let setsetMeterProvider: sinon.SinonSpy;
const tracerProvider = NOOP_TRACER_PROVIDER;
const tracerProvider = new DummyTracerProvider();
const meterProvider = NOOP_METER_PROVIDER;
beforeEach(() => {
instrumentation = new FooInstrumentation('foo', '1', {});
Expand Down
10 changes: 3 additions & 7 deletions packages/opentelemetry-tracing/src/Tracer.ts
Original file line number Diff line number Diff line change
Expand Up @@ -105,7 +105,7 @@ export class Tracer implements api.Tracer {
): api.Span {
if (isTracingSuppressed(context)) {
api.diag.debug('Instrumentation suppressed, returning Noop Span');
return api.NOOP_TRACER.startSpan(name, options, context);
return api.trace.wrapSpanContext(api.INVALID_SPAN_CONTEXT);
}

const parentContext = getParent(options, context);
Expand Down Expand Up @@ -144,12 +144,8 @@ export class Tracer implements api.Tracer {
: api.TraceFlags.NONE;
const spanContext = { traceId, spanId, traceFlags, traceState };
if (samplingResult.decision === api.SamplingDecision.NOT_RECORD) {
api.diag.debug('Recording is off, starting no recording span');
return api.NOOP_TRACER.startSpan(
name,
options,
api.trace.setSpanContext(context, spanContext)
);
api.diag.debug('Recording is off, propagating context in a non-recording span');
return api.trace.wrapSpanContext(spanContext);
}

const span = new Span(
Expand Down