/
composite.test.ts
237 lines (210 loc) · 6.64 KB
/
composite.test.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
/*
* 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 {
defaultTextMapGetter,
defaultTextMapSetter,
TextMapPropagator,
SpanContext,
TextMapGetter,
TextMapSetter, trace,
} from '@opentelemetry/api';
import { Context, ROOT_CONTEXT } from '@opentelemetry/api';
import * as assert from 'assert';
import {
CompositePropagator,
TraceContextTextMapPropagator,
RandomIdGenerator,
} from '../../src';
import {
TRACE_PARENT_HEADER,
TRACE_STATE_HEADER,
} from '../../src/trace/TraceContextTextMapPropagator';
import { TraceState } from '../../src/trace/TraceState';
class DummyPropagator implements TextMapPropagator {
inject(context: Context, carrier: any, setter: TextMapSetter<any>): void {
carrier['dummy'] = trace.getSpanContext(context);
}
extract(context: Context, carrier: any, getter: TextMapGetter<any>): Context {
if (carrier['dummy']) {
return trace.setSpanContext(context, carrier['dummy']);
}
return context;
}
fields(): string[] {
return ['dummy'];
}
}
describe('Composite Propagator', () => {
let traceId: string;
let spanId: string;
beforeEach(() => {
const idGenerator = new RandomIdGenerator();
traceId = idGenerator.generateTraceId();
spanId = idGenerator.generateSpanId();
});
describe('inject', () => {
let carrier: { [key: string]: unknown };
let spanContext: SpanContext;
let ctxWithSpanContext: Context;
beforeEach(() => {
carrier = {};
spanContext = {
spanId,
traceId,
traceFlags: 1,
traceState: new TraceState('foo=bar'),
};
ctxWithSpanContext = trace.setSpanContext(ROOT_CONTEXT, spanContext);
});
it('should inject context using all configured propagators', () => {
const composite = new CompositePropagator({
propagators: [new DummyPropagator(), new TraceContextTextMapPropagator()],
});
composite.inject(ctxWithSpanContext, carrier, defaultTextMapSetter);
assert.strictEqual(carrier['dummy'], spanContext);
assert.strictEqual(
carrier[TRACE_PARENT_HEADER],
`00-${traceId}-${spanId}-01`
);
assert.strictEqual(carrier[TRACE_STATE_HEADER], 'foo=bar');
});
it('should not throw', () => {
const composite = new CompositePropagator({
propagators: [
new ThrowingPropagator(),
new TraceContextTextMapPropagator(),
],
});
composite.inject(ctxWithSpanContext, carrier, defaultTextMapSetter);
assert.strictEqual(
carrier[TRACE_PARENT_HEADER],
`00-${traceId}-${spanId}-01`
);
});
});
describe('extract', () => {
let carrier: { [key: string]: unknown };
beforeEach(() => {
carrier = {
['dummy']: { traceId, spanId },
[TRACE_PARENT_HEADER]: `00-${traceId}-${spanId}-01`,
[TRACE_STATE_HEADER]: 'foo=bar',
};
});
it('should extract context using all configured propagators', () => {
const composite = new CompositePropagator({
propagators: [new DummyPropagator(), new TraceContextTextMapPropagator()],
});
const spanContext = trace.getSpanContext(
composite.extract(ROOT_CONTEXT, carrier, defaultTextMapGetter)
);
if (!spanContext) {
throw new Error('no extracted context');
}
assert.strictEqual(spanContext.traceId, traceId);
assert.strictEqual(spanContext.spanId, spanId);
assert.strictEqual(spanContext.traceFlags, 1);
assert.strictEqual(spanContext.isRemote, true);
assert.strictEqual(spanContext.traceState!.get('foo'), 'bar');
});
it('should not throw', () => {
const composite = new CompositePropagator({
propagators: [
new ThrowingPropagator(),
new TraceContextTextMapPropagator(),
],
});
const spanContext = trace.getSpanContext(
composite.extract(ROOT_CONTEXT, carrier, defaultTextMapGetter)
);
if (!spanContext) {
throw new Error('no extracted context');
}
assert.strictEqual(spanContext.traceId, traceId);
assert.strictEqual(spanContext.spanId, spanId);
assert.strictEqual(spanContext.traceFlags, 1);
assert.strictEqual(spanContext.isRemote, true);
assert.strictEqual(spanContext.traceState!.get('foo'), 'bar');
});
});
describe('fields()', () => {
it('should combine fields from both propagators', () => {
const composite = new CompositePropagator({
propagators: [
{
extract: c => c,
inject: () => {},
fields: () => ['p1'],
},
{
extract: c => c,
inject: () => {},
fields: () => ['p2'],
},
],
});
assert.deepStrictEqual(composite.fields(), ['p1', 'p2']);
});
it('should ignore propagators without fields function', () => {
const composite = new CompositePropagator({
propagators: [
{
extract: c => c,
inject: () => {},
fields: () => ['p1'],
},
// @ts-expect-error verify missing fields case
{
extract: c => c,
inject: () => {},
},
],
});
assert.deepStrictEqual(composite.fields(), ['p1']);
});
it('should not allow caller to modify fields', () => {
const composite = new CompositePropagator({
propagators: [
{
extract: c => c,
inject: () => {},
fields: () => ['p1'],
},
{
extract: c => c,
inject: () => {},
fields: () => ['p2'],
},
],
});
const fields = composite.fields();
assert.deepStrictEqual(fields, ['p1', 'p2']);
fields[1] = 'p3';
assert.deepStrictEqual(composite.fields(), ['p1', 'p2']);
});
});
});
class ThrowingPropagator implements TextMapPropagator {
inject(context: Context, carrier: unknown) {
throw new Error('this propagator throws');
}
extract(context: Context, carrier: unknown): Context {
throw new Error('This propagator throws');
}
fields(): string[] {
return [];
}
}