Skip to content

Commit 010ab95

Browse files
dyladandyladan
authored
chore: update core to 0.20.0 (#513)
* chore: update core to 0.20.0 * chore: fix test * chore: review comments and lint * chore: get example versions from previous update * chore: lint
1 parent c1d1163 commit 010ab95

File tree

3 files changed

+78
-51
lines changed

3 files changed

+78
-51
lines changed

‎package.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -67,7 +67,7 @@
6767
"webpack": "4.46.0"
6868
},
6969
"dependencies": {
70-
"@opentelemetry/api": "^1.0.0-rc.0",
71-
"@opentelemetry/core": "^0.19.0"
70+
"@opentelemetry/api": "^0.20.0",
71+
"@opentelemetry/core": "^0.20.0"
7272
}
7373
}

‎src/AWSXRayPropagator.ts

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,7 @@
1515
*/
1616

1717
import {
18+
trace,
1819
Context,
1920
TextMapPropagator,
2021
SpanContext,
@@ -26,8 +27,6 @@ import {
2627
isValidTraceId,
2728
INVALID_TRACEID,
2829
INVALID_SPANID,
29-
getSpanContext,
30-
setSpanContext,
3130
INVALID_SPAN_CONTEXT,
3231
} from '@opentelemetry/api';
3332

@@ -60,7 +59,7 @@ const NOT_SAMPLED = '0';
6059
*/
6160
export class AWSXRayPropagator implements TextMapPropagator {
6261
inject(context: Context, carrier: unknown, setter: TextMapSetter) {
63-
const spanContext = getSpanContext(context);
62+
const spanContext = trace.getSpan(context)?.spanContext();
6463
if (!spanContext || !isSpanContextValid(spanContext)) return;
6564

6665
const otTraceId = spanContext.traceId;
@@ -82,7 +81,7 @@ export class AWSXRayPropagator implements TextMapPropagator {
8281
const spanContext = this.getSpanContextFromHeader(carrier, getter);
8382
if (!isSpanContextValid(spanContext)) return context;
8483

85-
return setSpanContext(context, spanContext);
84+
return trace.setSpan(context, trace.wrapSpanContext(spanContext));
8685
}
8786

8887
fields(): string[] {

‎test/AWSXRayPropagator.test.ts

Lines changed: 73 additions & 45 deletions
Original file line numberDiff line numberDiff line change
@@ -18,12 +18,11 @@ import * as assert from 'assert';
1818
import {
1919
defaultTextMapGetter,
2020
defaultTextMapSetter,
21-
getSpan,
2221
INVALID_SPAN_CONTEXT,
2322
ROOT_CONTEXT,
24-
setSpanContext,
2523
SpanContext,
2624
TraceFlags,
25+
trace,
2726
} from '@opentelemetry/api';
2827
import { TraceState } from '@opentelemetry/core';
2928

@@ -50,7 +49,7 @@ describe('AWSXRayPropagator', () => {
5049
traceFlags: SAMPLED_TRACE_FLAG,
5150
};
5251
xrayPropagator.inject(
53-
setSpanContext(ROOT_CONTEXT, spanContext),
52+
trace.setSpan(ROOT_CONTEXT, trace.wrapSpanContext(spanContext)),
5453
carrier,
5554
defaultTextMapSetter
5655
);
@@ -68,7 +67,7 @@ describe('AWSXRayPropagator', () => {
6867
traceFlags: NOT_SAMPLED_TRACE_FLAG,
6968
};
7069
xrayPropagator.inject(
71-
setSpanContext(ROOT_CONTEXT, spanContext),
70+
trace.setSpan(ROOT_CONTEXT, trace.wrapSpanContext(spanContext)),
7271
carrier,
7372
defaultTextMapSetter
7473
);
@@ -89,7 +88,7 @@ describe('AWSXRayPropagator', () => {
8988
traceState: traceState,
9089
};
9190
xrayPropagator.inject(
92-
setSpanContext(ROOT_CONTEXT, spanContext),
91+
trace.setSpan(ROOT_CONTEXT, trace.wrapSpanContext(spanContext)),
9392
carrier,
9493
defaultTextMapSetter
9594
);
@@ -109,7 +108,10 @@ describe('AWSXRayPropagator', () => {
109108

110109
it('inject default invalid spanContext - should inject nothing', () => {
111110
xrayPropagator.inject(
112-
setSpanContext(ROOT_CONTEXT, INVALID_SPAN_CONTEXT),
111+
trace.setSpan(
112+
ROOT_CONTEXT,
113+
trace.wrapSpanContext(INVALID_SPAN_CONTEXT)
114+
),
113115
carrier,
114116
defaultTextMapSetter
115117
);
@@ -130,9 +132,11 @@ describe('AWSXRayPropagator', () => {
130132
it('should extract sampled context', () => {
131133
carrier[AWSXRAY_TRACE_ID_HEADER] =
132134
'Root=1-8a3c60f7-d188f8fa79d48a391a778fa6;Parent=53995c3f42cd8ad8;Sampled=1';
133-
const extractedSpanContext = getSpan(
134-
xrayPropagator.extract(ROOT_CONTEXT, carrier, defaultTextMapGetter)
135-
)?.context();
135+
const extractedSpanContext = trace
136+
.getSpan(
137+
xrayPropagator.extract(ROOT_CONTEXT, carrier, defaultTextMapGetter)
138+
)
139+
?.spanContext();
136140

137141
assert.deepStrictEqual(extractedSpanContext, {
138142
traceId: TRACE_ID,
@@ -145,9 +149,11 @@ describe('AWSXRayPropagator', () => {
145149
it('should extract sampled context with arbitrary order', () => {
146150
carrier[AWSXRAY_TRACE_ID_HEADER] =
147151
'Parent=53995c3f42cd8ad8;Sampled=1;Root=1-8a3c60f7-d188f8fa79d48a391a778fa6';
148-
const extractedSpanContext = getSpan(
149-
xrayPropagator.extract(ROOT_CONTEXT, carrier, defaultTextMapGetter)
150-
)?.context();
152+
const extractedSpanContext = trace
153+
.getSpan(
154+
xrayPropagator.extract(ROOT_CONTEXT, carrier, defaultTextMapGetter)
155+
)
156+
?.spanContext();
151157

152158
assert.deepStrictEqual(extractedSpanContext, {
153159
traceId: TRACE_ID,
@@ -160,9 +166,11 @@ describe('AWSXRayPropagator', () => {
160166
it('should extract context with additional fields', () => {
161167
carrier[AWSXRAY_TRACE_ID_HEADER] =
162168
'Root=1-8a3c60f7-d188f8fa79d48a391a778fa6;Parent=53995c3f42cd8ad8;Sampled=1;Foo=Bar';
163-
const extractedSpanContext = getSpan(
164-
xrayPropagator.extract(ROOT_CONTEXT, carrier, defaultTextMapGetter)
165-
)?.context();
169+
const extractedSpanContext = trace
170+
.getSpan(
171+
xrayPropagator.extract(ROOT_CONTEXT, carrier, defaultTextMapGetter)
172+
)
173+
?.spanContext();
166174

167175
// TODO: assert additional fields when the propagator supports it
168176
assert.deepStrictEqual(extractedSpanContext, {
@@ -175,99 +183,119 @@ describe('AWSXRayPropagator', () => {
175183

176184
it('extract empty header value - should return undefined', () => {
177185
carrier[AWSXRAY_TRACE_ID_HEADER] = '';
178-
const extractedSpanContext = getSpan(
179-
xrayPropagator.extract(ROOT_CONTEXT, carrier, defaultTextMapGetter)
180-
)?.context();
186+
const extractedSpanContext = trace
187+
.getSpan(
188+
xrayPropagator.extract(ROOT_CONTEXT, carrier, defaultTextMapGetter)
189+
)
190+
?.spanContext();
181191

182192
assert.deepStrictEqual(extractedSpanContext, undefined);
183193
});
184194

185195
it('extract invalid traceId - should return undefined', () => {
186196
carrier[AWSXRAY_TRACE_ID_HEADER] =
187197
'Root=1-abcdefgh-ijklmnopabcdefghijklmnop;Parent=53995c3f42cd8ad8;Sampled=0';
188-
const extractedSpanContext = getSpan(
189-
xrayPropagator.extract(ROOT_CONTEXT, carrier, defaultTextMapGetter)
190-
)?.context();
198+
const extractedSpanContext = trace
199+
.getSpan(
200+
xrayPropagator.extract(ROOT_CONTEXT, carrier, defaultTextMapGetter)
201+
)
202+
?.spanContext();
191203

192204
assert.deepStrictEqual(extractedSpanContext, undefined);
193205
});
194206

195207
it('extract invalid traceId size - should return undefined', () => {
196208
carrier[AWSXRAY_TRACE_ID_HEADER] =
197209
'Root=1-8a3c60f7-d188f8fa79d48a391a778fa600;Parent=53995c3f42cd8ad8;Sampled=0';
198-
const extractedSpanContext = getSpan(
199-
xrayPropagator.extract(ROOT_CONTEXT, carrier, defaultTextMapGetter)
200-
)?.context();
210+
const extractedSpanContext = trace
211+
.getSpan(
212+
xrayPropagator.extract(ROOT_CONTEXT, carrier, defaultTextMapGetter)
213+
)
214+
?.spanContext();
201215

202216
assert.deepStrictEqual(extractedSpanContext, undefined);
203217
});
204218

205219
it('extract invalid traceId delimiter - should return undefined', () => {
206220
carrier[AWSXRAY_TRACE_ID_HEADER] =
207221
'Root=1*8a3c60f7+d188f8fa79d48a391a778fa6;Parent=53995c3f42cd8ad8;Sampled=1;Foo=Bar';
208-
const extractedSpanContext = getSpan(
209-
xrayPropagator.extract(ROOT_CONTEXT, carrier, defaultTextMapGetter)
210-
)?.context();
222+
const extractedSpanContext = trace
223+
.getSpan(
224+
xrayPropagator.extract(ROOT_CONTEXT, carrier, defaultTextMapGetter)
225+
)
226+
?.spanContext();
211227

212228
assert.deepStrictEqual(extractedSpanContext, undefined);
213229
});
214230

215231
it('extract invalid spanId - should return undefined', () => {
216232
carrier[AWSXRAY_TRACE_ID_HEADER] =
217233
'Root=1-8a3c60f7-d188f8fa79d48a391a778fa6;Parent=abcdefghijklmnop;Sampled=0';
218-
const extractedSpanContext = getSpan(
219-
xrayPropagator.extract(ROOT_CONTEXT, carrier, defaultTextMapGetter)
220-
)?.context();
234+
const extractedSpanContext = trace
235+
.getSpan(
236+
xrayPropagator.extract(ROOT_CONTEXT, carrier, defaultTextMapGetter)
237+
)
238+
?.spanContext();
221239

222240
assert.deepStrictEqual(extractedSpanContext, undefined);
223241
});
224242

225243
it('extract invalid spanId size - should return undefined', () => {
226244
carrier[AWSXRAY_TRACE_ID_HEADER] =
227245
'Root=1-8a3c60f7-d188f8fa79d48a391a778fa6;Parent=53995c3f42cd8ad800;Sampled=0';
228-
const extractedSpanContext = getSpan(
229-
xrayPropagator.extract(ROOT_CONTEXT, carrier, defaultTextMapGetter)
230-
)?.context();
246+
const extractedSpanContext = trace
247+
.getSpan(
248+
xrayPropagator.extract(ROOT_CONTEXT, carrier, defaultTextMapGetter)
249+
)
250+
?.spanContext();
231251

232252
assert.deepStrictEqual(extractedSpanContext, undefined);
233253
});
234254

235255
it('extract invalid traceFlags - should return undefined', () => {
236256
carrier[AWSXRAY_TRACE_ID_HEADER] =
237257
'Root=1-8a3c60f7-d188f8fa79d48a391a778fa6;Parent=53995c3f42cd8ad8;Sampled=';
238-
const extractedSpanContext = getSpan(
239-
xrayPropagator.extract(ROOT_CONTEXT, carrier, defaultTextMapGetter)
240-
)?.context();
258+
const extractedSpanContext = trace
259+
.getSpan(
260+
xrayPropagator.extract(ROOT_CONTEXT, carrier, defaultTextMapGetter)
261+
)
262+
?.spanContext();
241263

242264
assert.deepStrictEqual(extractedSpanContext, undefined);
243265
});
244266

245267
it('extract invalid traceFlags length - should return undefined', () => {
246268
carrier[AWSXRAY_TRACE_ID_HEADER] =
247269
'Root=1-8a3c60f7-d188f8fa79d48a391a778fa6;Parent=53995c3f42cd8ad8;Sampled=10220';
248-
const extractedSpanContext = getSpan(
249-
xrayPropagator.extract(ROOT_CONTEXT, carrier, defaultTextMapGetter)
250-
)?.context();
270+
const extractedSpanContext = trace
271+
.getSpan(
272+
xrayPropagator.extract(ROOT_CONTEXT, carrier, defaultTextMapGetter)
273+
)
274+
?.spanContext();
251275

252276
assert.deepStrictEqual(extractedSpanContext, undefined);
253277
});
254278

255279
it('extract nonnumeric invalid traceFlags - should return undefined', () => {
256280
carrier[AWSXRAY_TRACE_ID_HEADER] =
257281
'Root=1-8a3c60f7-d188f8fa79d48a391a778fa6;Parent=53995c3f42cd8ad8;Sampled=a';
258-
const extractedSpanContext = getSpan(
259-
xrayPropagator.extract(ROOT_CONTEXT, carrier, defaultTextMapGetter)
260-
)?.context();
282+
const extractedSpanContext = trace
283+
.getSpan(
284+
xrayPropagator.extract(ROOT_CONTEXT, carrier, defaultTextMapGetter)
285+
)
286+
?.spanContext();
261287

262288
assert.deepStrictEqual(extractedSpanContext, undefined);
263289
});
264290

265291
it('extract invalid aws xray version - should return undefined', () => {
266292
carrier[AWSXRAY_TRACE_ID_HEADER] =
267293
'Root=2-8a3c60f7-d188f8fa79d48a391a778fa6;Parent=53995c3f42cd8ad8;Sampled=1';
268-
const extractedSpanContext = getSpan(
269-
xrayPropagator.extract(ROOT_CONTEXT, carrier, defaultTextMapGetter)
270-
)?.context();
294+
const extractedSpanContext = trace
295+
.getSpan(
296+
xrayPropagator.extract(ROOT_CONTEXT, carrier, defaultTextMapGetter)
297+
)
298+
?.spanContext();
271299

272300
assert.deepStrictEqual(extractedSpanContext, undefined);
273301
});

0 commit comments

Comments
 (0)