Skip to content

Commit 5f8c69d

Browse files
committed
lint fixes
1 parent 81a6995 commit 5f8c69d

File tree

2 files changed

+70
-44
lines changed

2 files changed

+70
-44
lines changed

propagators/propagator-aws-xray/src/AWSXRayPropagator.ts

Lines changed: 31 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -50,8 +50,8 @@ const SAMPLED_FLAG_KEY = 'Sampled';
5050
const IS_SAMPLED = '1';
5151
const NOT_SAMPLED = '0';
5252

53-
const LINEAGE_KEY = "Lineage";
54-
const LINEAGE_DELIMITER = ":";
53+
const LINEAGE_KEY = 'Lineage';
54+
const LINEAGE_DELIMITER = ':';
5555
const LINEAGE_HASH_LENGTH = 8;
5656
const LINEAGE_MAX_REQUEST_COUNTER = 255;
5757
const LINEAGE_MAX_LOOP_COUNTER = 32767;
@@ -82,24 +82,24 @@ export class AWSXRayPropagator implements TextMapPropagator {
8282
: NOT_SAMPLED;
8383
// TODO: Add OT trace state to the X-Ray trace header
8484

85-
let traceHeader =
86-
`${TRACE_ID_KEY}` +
87-
`${KV_DELIMITER}` +
88-
`${xrayTraceId}` +
89-
`${TRACE_HEADER_DELIMITER}` +
90-
`${PARENT_ID_KEY}` +
91-
`${KV_DELIMITER}` +
92-
`${parentId}` +
93-
`${TRACE_HEADER_DELIMITER}` +
94-
`${SAMPLED_FLAG_KEY}` +
95-
`${KV_DELIMITER}` +
96-
`${samplingFlag}`;
85+
let traceHeader =
86+
`${TRACE_ID_KEY}` +
87+
`${KV_DELIMITER}` +
88+
`${xrayTraceId}` +
89+
`${TRACE_HEADER_DELIMITER}` +
90+
`${PARENT_ID_KEY}` +
91+
`${KV_DELIMITER}` +
92+
`${parentId}` +
93+
`${TRACE_HEADER_DELIMITER}` +
94+
`${SAMPLED_FLAG_KEY}` +
95+
`${KV_DELIMITER}` +
96+
`${samplingFlag}`;
9797

9898
const baggage = propagation.getBaggage(context);
9999
const lineageV2Header = baggage?.getEntry(LINEAGE_KEY)?.value;
100100

101101
if (lineageV2Header) {
102-
traceHeader +=
102+
traceHeader +=
103103
`${TRACE_HEADER_DELIMITER}` +
104104
`${LINEAGE_KEY}` +
105105
`${KV_DELIMITER}` +
@@ -138,7 +138,8 @@ export class AWSXRayPropagator implements TextMapPropagator {
138138
return context;
139139
}
140140

141-
let baggage: Baggage = propagation.getBaggage(context) || propagation.createBaggage();
141+
let baggage: Baggage =
142+
propagation.getBaggage(context) || propagation.createBaggage();
142143

143144
let pos = 0;
144145
let trimmedPart: string;
@@ -167,7 +168,7 @@ export class AWSXRayPropagator implements TextMapPropagator {
167168
parsedTraceFlags = AWSXRayPropagator._parseTraceFlag(value);
168169
} else if (trimmedPart.startsWith(LINEAGE_KEY)) {
169170
if (AWSXRayPropagator._isValidLineageV2Header(value)) {
170-
baggage = baggage.setEntry(LINEAGE_KEY, {value});
171+
baggage = baggage.setEntry(LINEAGE_KEY, { value });
171172
}
172173
}
173174
}
@@ -181,7 +182,10 @@ export class AWSXRayPropagator implements TextMapPropagator {
181182
isRemote: true,
182183
};
183184
if (isSpanContextValid(resultSpanContext)) {
184-
context = trace.setSpan(context, trace.wrapSpanContext(resultSpanContext));
185+
context = trace.setSpan(
186+
context,
187+
trace.wrapSpanContext(resultSpanContext)
188+
);
185189
}
186190
if (baggage.getAllEntries().length > 0) {
187191
context = propagation.setBaggage(context, baggage);
@@ -233,17 +237,21 @@ export class AWSXRayPropagator implements TextMapPropagator {
233237

234238
private static _isValidLineageV2Header(xrayLineageHeader: string): boolean {
235239
const lineageSubstrings = xrayLineageHeader.split(LINEAGE_DELIMITER);
236-
if (lineageSubstrings.length != 3) {
240+
if (lineageSubstrings.length !== 3) {
237241
return false;
238242
}
239243

240244
const requestCounter = parseInt(lineageSubstrings[0]);
241245
const hashedResourceId = lineageSubstrings[1];
242246
const loopCounter = parseInt(lineageSubstrings[2]);
243-
244-
const isValidKey = hashedResourceId.length == LINEAGE_HASH_LENGTH && !!hashedResourceId.match(/^[0-9a-fA-F]+$/);
245-
const isValidRequestCounter = requestCounter >= 0 && requestCounter <= LINEAGE_MAX_REQUEST_COUNTER;
246-
const isValidLoopCounter = loopCounter >= 0 && loopCounter <= LINEAGE_MAX_LOOP_COUNTER;
247+
248+
const isValidKey =
249+
hashedResourceId.length === LINEAGE_HASH_LENGTH &&
250+
!!hashedResourceId.match(/^[0-9a-fA-F]+$/);
251+
const isValidRequestCounter =
252+
requestCounter >= 0 && requestCounter <= LINEAGE_MAX_REQUEST_COUNTER;
253+
const isValidLoopCounter =
254+
loopCounter >= 0 && loopCounter <= LINEAGE_MAX_LOOP_COUNTER;
247255

248256
return isValidKey && isValidRequestCounter && isValidLoopCounter;
249257
}

propagators/propagator-aws-xray/test/AWSXRayPropagator.test.ts

Lines changed: 39 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -121,17 +121,20 @@ describe('AWSXRayPropagator', () => {
121121

122122
assert.deepStrictEqual(carrier, {});
123123
});
124-
124+
125125
it('should inject with lineage', () => {
126126
const spanContext: SpanContext = {
127127
traceId: TRACE_ID,
128128
spanId: SPAN_ID,
129129
traceFlags: SAMPLED_TRACE_FLAG,
130130
};
131131
xrayPropagator.inject(
132-
propagation.setBaggage(trace.setSpan(ROOT_CONTEXT, trace.wrapSpanContext(spanContext)), propagation.createBaggage({
133-
'Lineage': { value: LINEAGE_ID }
134-
})),
132+
propagation.setBaggage(
133+
trace.setSpan(ROOT_CONTEXT, trace.wrapSpanContext(spanContext)),
134+
propagation.createBaggage({
135+
Lineage: { value: LINEAGE_ID },
136+
})
137+
),
135138
carrier,
136139
defaultTextMapSetter
137140
);
@@ -370,30 +373,45 @@ describe('AWSXRayPropagator', () => {
370373
it('should extract lineage into baggage', () => {
371374
carrier[AWSXRAY_TRACE_ID_HEADER] =
372375
'Root=1-8a3c60f7-d188f8fa79d48a391a778fa6;Parent=53995c3f42cd8ad8;Sampled=1;Lineage=100:e3b0c442:11';
373-
const extractedContext = xrayPropagator.extract(ROOT_CONTEXT, carrier, defaultTextMapGetter)
376+
const extractedContext = xrayPropagator.extract(
377+
ROOT_CONTEXT,
378+
carrier,
379+
defaultTextMapGetter
380+
);
374381

375-
assert.deepStrictEqual(propagation.getBaggage(extractedContext)?.getEntry('Lineage'), {
376-
"value": LINEAGE_ID
377-
});
382+
assert.deepStrictEqual(
383+
propagation.getBaggage(extractedContext)?.getEntry('Lineage'),
384+
{
385+
value: LINEAGE_ID,
386+
}
387+
);
378388
});
379389

380390
const invalidLineageHeaders = [
381-
"",
382-
"::",
383-
"1::",
384-
"1::1",
385-
"1:badc0de:13",
386-
":fbadc0de:13",
387-
"65535:fbadc0de:255"
391+
'',
392+
'::',
393+
'1::',
394+
'1::1',
395+
'1:badc0de:13',
396+
':fbadc0de:13',
397+
'65535:fbadc0de:255',
388398
];
389399

390-
invalidLineageHeaders.forEach((lineageHeader) => {
400+
invalidLineageHeaders.forEach(lineageHeader => {
391401
it(`should ignore invalid lineage header: ${lineageHeader}`, () => {
392-
carrier[AWSXRAY_TRACE_ID_HEADER] =
393-
`Root=1-8a3c60f7-d188f8fa79d48a391a778fa6;Parent=53995c3f42cd8ad8;Sampled=1;Lineage=${lineageHeader}`;
394-
const extractedContext = xrayPropagator.extract(ROOT_CONTEXT, carrier, defaultTextMapGetter)
395-
396-
assert.deepStrictEqual(propagation.getBaggage(extractedContext), undefined);
402+
carrier[
403+
AWSXRAY_TRACE_ID_HEADER
404+
] = `Root=1-8a3c60f7-d188f8fa79d48a391a778fa6;Parent=53995c3f42cd8ad8;Sampled=1;Lineage=${lineageHeader}`;
405+
const extractedContext = xrayPropagator.extract(
406+
ROOT_CONTEXT,
407+
carrier,
408+
defaultTextMapGetter
409+
);
410+
411+
assert.deepStrictEqual(
412+
propagation.getBaggage(extractedContext),
413+
undefined
414+
);
397415
});
398416
});
399417

0 commit comments

Comments
 (0)