Skip to content

Commit 810b618

Browse files
david-lunadavid-luna
authored
refactor(sdk-trace-base): rename activeSpanProcessor private property (#5211)
1 parent c28abac commit 810b618

File tree

8 files changed

+64
-64
lines changed

8 files changed

+64
-64
lines changed

‎CHANGELOG_NEXT.md‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,7 @@
2424
### :house: (Internal)
2525

2626
* chore: remove checks for unsupported node versions [#4341](https://github.com/open-telemetry/opentelemetry-js/pull/4341) @dyladan
27-
* refactor(sdk-trace-base): remove `BasicTracerProvider._registeredSpanProcessors` private property. [#5134](https://github.com/open-telemetry/opentelemetry-js/pull/5177) @david-luna
27+
* refactor(sdk-trace-base): remove `BasicTracerProvider._registeredSpanProcessors` private property. [#5134](https://github.com/open-telemetry/opentelemetry-js/pull/5134) @david-luna
28+
* refactor(sdk-trace-base): rename `BasicTracerProvider.activeSpanProcessor` private property. [#5211](https://github.com/open-telemetry/opentelemetry-js/pull/5211) @david-luna
2829

2930
### :bug: (Bug Fix)

‎experimental/packages/opentelemetry-sdk-node/test/sdk.test.ts‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -262,7 +262,7 @@ describe('Node SDK', () => {
262262

263263
assert.ok(nodeTracerProvider instanceof NodeTracerProvider);
264264

265-
const spanProcessor = nodeTracerProvider['activeSpanProcessor'] as any;
265+
const spanProcessor = nodeTracerProvider['_activeSpanProcessor'] as any;
266266

267267
assert(
268268
spanProcessor.constructor.name === 'MultiSpanProcessor',
@@ -1117,7 +1117,7 @@ describe('setup exporter from env', () => {
11171117

11181118
assert(tracerProvider instanceof NodeTracerProvider);
11191119

1120-
const activeSpanProcessor = tracerProvider['activeSpanProcessor'];
1120+
const activeSpanProcessor = tracerProvider['_activeSpanProcessor'];
11211121

11221122
assert(activeSpanProcessor.constructor.name === 'MultiSpanProcessor');
11231123

‎packages/opentelemetry-sdk-trace-base/src/BasicTracerProvider.ts‎

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -69,8 +69,7 @@ export class BasicTracerProvider implements TracerProvider {
6969
private readonly _config: TracerConfig;
7070
private readonly _tracers: Map<string, Tracer> = new Map();
7171
private readonly _resource: IResource;
72-
73-
private activeSpanProcessor: MultiSpanProcessor;
72+
private readonly _activeSpanProcessor: MultiSpanProcessor;
7473

7574
constructor(config: TracerConfig = {}) {
7675
const mergedConfig = merge(
@@ -101,7 +100,7 @@ export class BasicTracerProvider implements TracerProvider {
101100
);
102101
}
103102

104-
this.activeSpanProcessor = new MultiSpanProcessor(spanProcessors);
103+
this._activeSpanProcessor = new MultiSpanProcessor(spanProcessors);
105104
}
106105

107106
getTracer(
@@ -117,7 +116,7 @@ export class BasicTracerProvider implements TracerProvider {
117116
{ name, version, schemaUrl: options?.schemaUrl },
118117
this._config,
119118
this._resource,
120-
this.activeSpanProcessor
119+
this._activeSpanProcessor
121120
)
122121
);
123122
}
@@ -150,7 +149,7 @@ export class BasicTracerProvider implements TracerProvider {
150149

151150
forceFlush(): Promise<void> {
152151
const timeout = this._config.forceFlushTimeoutMillis;
153-
const promises = this.activeSpanProcessor['_spanProcessors'].map(
152+
const promises = this._activeSpanProcessor['_spanProcessors'].map(
154153
(spanProcessor: SpanProcessor) => {
155154
return new Promise(resolve => {
156155
let state: ForceFlushState;
@@ -198,7 +197,7 @@ export class BasicTracerProvider implements TracerProvider {
198197
}
199198

200199
shutdown(): Promise<void> {
201-
return this.activeSpanProcessor.shutdown();
200+
return this._activeSpanProcessor.shutdown();
202201
}
203202

204203
/**

‎packages/opentelemetry-sdk-trace-base/test/common/BasicTracerProvider.test.ts‎

Lines changed: 26 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -92,25 +92,25 @@ describe('BasicTracerProvider', () => {
9292

9393
it('should use noop span processor by default', () => {
9494
const tracer = new BasicTracerProvider();
95-
assert.ok(tracer['activeSpanProcessor'] instanceof MultiSpanProcessor);
95+
assert.ok(tracer['_activeSpanProcessor'] instanceof MultiSpanProcessor);
9696
assert.ok(
97-
tracer['activeSpanProcessor']['_spanProcessors'].length === 1
97+
tracer['_activeSpanProcessor']['_spanProcessors'].length === 1
9898
);
9999
assert.ok(
100-
tracer['activeSpanProcessor']['_spanProcessors'][0] instanceof
100+
tracer['_activeSpanProcessor']['_spanProcessors'][0] instanceof
101101
NoopSpanProcessor
102102
);
103103
});
104104
it('should use noop span processor by default and no diag error', () => {
105105
const errorStub = sinon.spy(diag, 'error');
106106
const tracer = new BasicTracerProvider();
107107

108-
assert.ok(tracer['activeSpanProcessor'] instanceof MultiSpanProcessor);
108+
assert.ok(tracer['_activeSpanProcessor'] instanceof MultiSpanProcessor);
109109
assert.ok(
110-
tracer['activeSpanProcessor']['_spanProcessors'].length === 1
110+
tracer['_activeSpanProcessor']['_spanProcessors'].length === 1
111111
);
112112
assert.ok(
113-
tracer['activeSpanProcessor']['_spanProcessors'][0] instanceof
113+
tracer['_activeSpanProcessor']['_spanProcessors'][0] instanceof
114114
NoopSpanProcessor
115115
);
116116
sinon.assert.notCalled(errorStub);
@@ -123,12 +123,12 @@ describe('BasicTracerProvider', () => {
123123
const errorStub = sinon.spy(diag, 'error');
124124
const tracer = new BasicTracerProvider();
125125

126-
assert.ok(tracer['activeSpanProcessor'] instanceof MultiSpanProcessor);
126+
assert.ok(tracer['_activeSpanProcessor'] instanceof MultiSpanProcessor);
127127
assert.ok(
128-
tracer['activeSpanProcessor']['_spanProcessors'].length === 1
128+
tracer['_activeSpanProcessor']['_spanProcessors'].length === 1
129129
);
130130
assert.ok(
131-
tracer['activeSpanProcessor']['_spanProcessors'][0] instanceof
131+
tracer['_activeSpanProcessor']['_spanProcessors'][0] instanceof
132132
NoopSpanProcessor
133133
);
134134
sinon.assert.calledWith(
@@ -147,16 +147,16 @@ describe('BasicTracerProvider', () => {
147147
spanProcessors: [spanProcessor],
148148
});
149149

150-
assert.ok(tracer['activeSpanProcessor'] instanceof MultiSpanProcessor);
150+
assert.ok(tracer['_activeSpanProcessor'] instanceof MultiSpanProcessor);
151151
assert.ok(
152-
tracer['activeSpanProcessor']['_spanProcessors'].length === 1
152+
tracer['_activeSpanProcessor']['_spanProcessors'].length === 1
153153
);
154154
assert.ok(
155-
tracer['activeSpanProcessor']['_spanProcessors'][0] instanceof
155+
tracer['_activeSpanProcessor']['_spanProcessors'][0] instanceof
156156
SimpleSpanProcessor
157157
);
158158
assert.ok(
159-
tracer['activeSpanProcessor']['_spanProcessors'][0][
159+
tracer['_activeSpanProcessor']['_spanProcessors'][0][
160160
'_exporter'
161161
] instanceof ConsoleSpanExporter
162162
);
@@ -466,16 +466,16 @@ describe('BasicTracerProvider', () => {
466466
/* BasicTracerProvider has no exporters by default, so skipping testing the exporter getter */
467467
provider.register();
468468

469-
assert.ok(provider['activeSpanProcessor'] instanceof MultiSpanProcessor);
469+
assert.ok(provider['_activeSpanProcessor'] instanceof MultiSpanProcessor);
470470
assert.ok(
471-
provider['activeSpanProcessor']['_spanProcessors'].length === 1
471+
provider['_activeSpanProcessor']['_spanProcessors'].length === 1
472472
);
473473
assert.ok(
474-
provider['activeSpanProcessor']['_spanProcessors'][0] instanceof
474+
provider['_activeSpanProcessor']['_spanProcessors'][0] instanceof
475475
BatchSpanProcessor
476476
);
477477
assert.ok(
478-
provider['activeSpanProcessor']['_spanProcessors'][0][
478+
provider['_activeSpanProcessor']['_spanProcessors'][0][
479479
'_exporter'
480480
] instanceof DummyExporter
481481
);
@@ -521,16 +521,16 @@ describe('BasicTracerProvider', () => {
521521
const provider = new CustomTracerProvider({});
522522
provider.register();
523523

524-
assert.ok(provider['activeSpanProcessor'] instanceof MultiSpanProcessor);
524+
assert.ok(provider['_activeSpanProcessor'] instanceof MultiSpanProcessor);
525525
assert.ok(
526-
provider['activeSpanProcessor']['_spanProcessors'].length === 1
526+
provider['_activeSpanProcessor']['_spanProcessors'].length === 1
527527
);
528528
assert.ok(
529-
provider['activeSpanProcessor']['_spanProcessors'][0] instanceof
529+
provider['_activeSpanProcessor']['_spanProcessors'][0] instanceof
530530
BatchSpanProcessor
531531
);
532532
assert.ok(
533-
provider['activeSpanProcessor']['_spanProcessors'][0][
533+
provider['_activeSpanProcessor']['_spanProcessors'][0][
534534
'_exporter'
535535
] instanceof DummyExporter
536536
);
@@ -635,17 +635,17 @@ describe('BasicTracerProvider', () => {
635635
provider.register();
636636

637637
assert.ok(
638-
provider['activeSpanProcessor'] instanceof MultiSpanProcessor
638+
provider['_activeSpanProcessor'] instanceof MultiSpanProcessor
639639
);
640640
assert.ok(
641-
provider['activeSpanProcessor']['_spanProcessors'].length === 1
641+
provider['_activeSpanProcessor']['_spanProcessors'].length === 1
642642
);
643643
assert.ok(
644-
provider['activeSpanProcessor']['_spanProcessors'][0] instanceof
644+
provider['_activeSpanProcessor']['_spanProcessors'][0] instanceof
645645
BatchSpanProcessor
646646
);
647647
assert.ok(
648-
provider['activeSpanProcessor']['_spanProcessors'][0][
648+
provider['_activeSpanProcessor']['_spanProcessors'][0][
649649
'_exporter'
650650
] instanceof InMemorySpanExporter
651651
);
@@ -958,7 +958,7 @@ describe('BasicTracerProvider', () => {
958958
it('should trigger shutdown when manually invoked', () => {
959959
const tracerProvider = new BasicTracerProvider();
960960
const shutdownStub = sinon.stub(
961-
tracerProvider['activeSpanProcessor'],
961+
tracerProvider['_activeSpanProcessor'],
962962
'shutdown'
963963
);
964964
tracerProvider.shutdown();

‎packages/opentelemetry-sdk-trace-base/test/common/MultiSpanProcessor.test.ts‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,7 @@ describe('MultiSpanProcessor', () => {
6363
assert.strictEqual(processor1.spans.length, 0);
6464
span.end();
6565
assert.strictEqual(processor1.spans.length, 1);
66-
tracerProvider['activeSpanProcessor'].shutdown();
66+
tracerProvider['_activeSpanProcessor'].shutdown();
6767
});
6868

6969
it('should handle two span processor', async () => {

‎packages/opentelemetry-sdk-trace-base/test/common/Tracer.test.ts‎

Lines changed: 19 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -115,7 +115,7 @@ describe('Tracer', () => {
115115
{ name: 'default', version: '0.0.1' },
116116
{},
117117
tracerProvider['_resource'],
118-
tracerProvider['activeSpanProcessor']
118+
tracerProvider['_activeSpanProcessor']
119119
);
120120
assert.ok(tracer instanceof Tracer);
121121
});
@@ -125,7 +125,7 @@ describe('Tracer', () => {
125125
{ name: 'default', version: '0.0.1' },
126126
{},
127127
tracerProvider['_resource'],
128-
tracerProvider['activeSpanProcessor']
128+
tracerProvider['_activeSpanProcessor']
129129
);
130130
assert.strictEqual(
131131
tracer['_sampler'].toString(),
@@ -138,7 +138,7 @@ describe('Tracer', () => {
138138
{ name: 'default', version: '0.0.1' },
139139
{ sampler: new AlwaysOffSampler() },
140140
tracerProvider['_resource'],
141-
tracerProvider['activeSpanProcessor']
141+
tracerProvider['_activeSpanProcessor']
142142
);
143143
const span = tracer.startSpan('span1');
144144
assert.ok(!span.isRecording());
@@ -150,7 +150,7 @@ describe('Tracer', () => {
150150
{ name: 'default', version: '0.0.1' },
151151
{ sampler: new AlwaysOnSampler() },
152152
tracerProvider['_resource'],
153-
tracerProvider['activeSpanProcessor']
153+
tracerProvider['_activeSpanProcessor']
154154
);
155155
const span = tracer.startSpan('span2');
156156
assert.ok(span.isRecording());
@@ -162,7 +162,7 @@ describe('Tracer', () => {
162162
{ name: 'default', version: '0.0.1' },
163163
{ sampler: new TestSampler() },
164164
tracerProvider['_resource'],
165-
tracerProvider['activeSpanProcessor']
165+
tracerProvider['_activeSpanProcessor']
166166
);
167167
const span = tracer.startSpan('span3');
168168
assert.strictEqual((span as Span).attributes.testAttribute, 'foobar');
@@ -175,7 +175,7 @@ describe('Tracer', () => {
175175
{ name: 'default', version: '0.0.1' },
176176
{ sampler: new TestSampler(traceState) },
177177
tracerProvider['_resource'],
178-
tracerProvider['activeSpanProcessor']
178+
tracerProvider['_activeSpanProcessor']
179179
);
180180
const span = tracer.startSpan('stateSpan');
181181
assert.strictEqual(span.spanContext().traceState, traceState);
@@ -186,7 +186,7 @@ describe('Tracer', () => {
186186
{ name: 'default', version: '0.0.1' },
187187
{},
188188
tracerProvider['_resource'],
189-
tracerProvider['activeSpanProcessor']
189+
tracerProvider['_activeSpanProcessor']
190190
);
191191

192192
const lib: InstrumentationLibrary = tracer.instrumentationLibrary;
@@ -203,7 +203,7 @@ describe('Tracer', () => {
203203
{ name: 'default', version: '0.0.1' },
204204
{ sampler: new TestSampler() },
205205
tracerProvider['_resource'],
206-
tracerProvider['activeSpanProcessor']
206+
tracerProvider['_activeSpanProcessor']
207207
);
208208

209209
const span = tracer.startSpan('span3', undefined, context);
@@ -227,7 +227,7 @@ describe('Tracer', () => {
227227
{ name: 'default', version: '0.0.1' },
228228
{},
229229
tracerProvider['_resource'],
230-
tracerProvider['activeSpanProcessor']
230+
tracerProvider['_activeSpanProcessor']
231231
);
232232
const span = tracer.startSpan(
233233
'aSpan',
@@ -249,7 +249,7 @@ describe('Tracer', () => {
249249
{ name: 'default', version: '0.0.1' },
250250
{},
251251
tracerProvider['_resource'],
252-
tracerProvider['activeSpanProcessor']
252+
tracerProvider['_activeSpanProcessor']
253253
);
254254
const span = tracer.startSpan(
255255
'aSpan',
@@ -279,7 +279,7 @@ describe('Tracer', () => {
279279
{ name: 'default' },
280280
{ sampler },
281281
tp['_resource'],
282-
tp['activeSpanProcessor']
282+
tp['_activeSpanProcessor']
283283
);
284284
const span = tracer.startSpan('a', {}, context) as Span;
285285
assert.strictEqual(span.parentSpanId, parent.spanId);
@@ -315,7 +315,7 @@ describe('Tracer', () => {
315315
{ name: 'default' },
316316
{ sampler },
317317
tp['_resource'],
318-
tp['activeSpanProcessor']
318+
tp['_activeSpanProcessor']
319319
);
320320
const span = tracer.startSpan('a', { root: true }, context) as Span;
321321
assert.strictEqual(span.parentSpanId, undefined);
@@ -334,7 +334,7 @@ describe('Tracer', () => {
334334
{ name: 'default', version: '0.0.1' },
335335
{},
336336
tracerProvider['_resource'],
337-
tracerProvider['activeSpanProcessor']
337+
tracerProvider['_activeSpanProcessor']
338338
);
339339
const span = tracer.startSpan('my-span');
340340
const context = span.spanContext();
@@ -349,7 +349,7 @@ describe('Tracer', () => {
349349
{ name: 'default', version: '0.0.1' },
350350
{},
351351
tracerProvider['_resource'],
352-
tracerProvider['activeSpanProcessor']
352+
tracerProvider['_activeSpanProcessor']
353353
);
354354
const span = tracer.startSpan('my-span');
355355
const context = span.spanContext();
@@ -364,7 +364,7 @@ describe('Tracer', () => {
364364
{ name: 'default', version: '0.0.1' },
365365
{},
366366
tracerProvider['_resource'],
367-
tracerProvider['activeSpanProcessor']
367+
tracerProvider['_activeSpanProcessor']
368368
);
369369
const span = tracer.startSpan('my-span');
370370
const context = span.spanContext();
@@ -377,7 +377,7 @@ describe('Tracer', () => {
377377
{ name: 'default', version: '0.0.1' },
378378
{ sampler: new TestSampler() },
379379
tracerProvider['_resource'],
380-
tracerProvider['activeSpanProcessor']
380+
tracerProvider['_activeSpanProcessor']
381381
);
382382

383383
const spy = sinon.spy(tracer, 'startSpan');
@@ -401,7 +401,7 @@ describe('Tracer', () => {
401401
{ name: 'default', version: '0.0.1' },
402402
{ sampler: new TestSampler() },
403403
tracerProvider['_resource'],
404-
tracerProvider['activeSpanProcessor']
404+
tracerProvider['_activeSpanProcessor']
405405
);
406406

407407
const spy = sinon.spy(tracer, 'startSpan');
@@ -429,7 +429,7 @@ describe('Tracer', () => {
429429
{ name: 'default', version: '0.0.1' },
430430
{ sampler: new TestSampler() },
431431
tracerProvider['_resource'],
432-
tracerProvider['activeSpanProcessor']
432+
tracerProvider['_activeSpanProcessor']
433433
);
434434

435435
const ctxKey = createContextKey('foo');
@@ -465,7 +465,7 @@ describe('Tracer', () => {
465465
{ name: 'default', version: '0.0.1' },
466466
{ sampler: new TestSampler() },
467467
tracerProvider['_resource'],
468-
tracerProvider['activeSpanProcessor']
468+
tracerProvider['_activeSpanProcessor']
469469
);
470470

471471
const attributes = {

0 commit comments

Comments
 (0)