@zendesk/retrace
Version:
define and capture Product Operation Traces along with computed metrics with an optional friendly React beacon API
490 lines • 25.9 kB
JavaScript
"use strict";
var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
if (k2 === undefined) k2 = k;
var desc = Object.getOwnPropertyDescriptor(m, k);
if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
desc = { enumerable: true, get: function() { return m[k]; } };
}
Object.defineProperty(o, k2, desc);
}) : (function(o, m, k, k2) {
if (k2 === undefined) k2 = k;
o[k2] = m[k];
}));
var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
Object.defineProperty(o, "default", { enumerable: true, value: v });
}) : function(o, v) {
o["default"] = v;
});
var __importStar = (this && this.__importStar) || (function () {
var ownKeys = function(o) {
ownKeys = Object.getOwnPropertyNames || function (o) {
var ar = [];
for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
return ar;
};
return ownKeys(o);
};
return function (mod) {
if (mod && mod.__esModule) return mod;
var result = {};
if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
__setModuleDefault(result, mod);
return result;
};
})();
Object.defineProperty(exports, "__esModule", { value: true });
require("./testUtility/asciiTimelineSerializer");
const vitest_1 = require("vitest");
const match = __importStar(require("./matchSpan"));
const relationSchemas_1 = require("./testUtility/fixtures/relationSchemas");
const makeTimeline_1 = require("./testUtility/makeTimeline");
const processSpans_1 = require("./testUtility/processSpans");
const TraceManager_1 = require("./TraceManager");
(0, vitest_1.describe)('Trace Definitions', () => {
let reportFn;
// TS doesn't like that reportFn is wrapped in Mock<> type
const getReportFn = () => reportFn;
let generateId;
let reportErrorFn;
const DEFAULT_COLDBOOT_TIMEOUT_DURATION = 45_000;
vitest_1.vitest.useFakeTimers({
now: 0,
});
let idPerType = {
span: 0,
trace: 0,
tick: 0,
};
(0, vitest_1.beforeEach)(() => {
idPerType = {
span: 0,
trace: 0,
tick: 0,
};
generateId = vitest_1.vitest.fn((type) => {
const seq = idPerType[type]++;
return type === 'span'
? `id-${seq}`
: type === 'trace'
? `trace-${seq}`
: `tick-${seq}`;
});
reportFn = vitest_1.vitest.fn();
reportErrorFn = vitest_1.vitest.fn();
});
(0, vitest_1.describe)('computedSpanDefinitions', () => {
(0, vitest_1.it)('correctly calculates a computed span provided in definition', () => {
const traceManager = new TraceManager_1.TraceManager({
relationSchemas: relationSchemas_1.ticketAndUserAndGlobalRelationSchemasFixture,
reportFn: getReportFn(),
generateId,
reportErrorFn,
});
const computedSpanName = 'render-1-to-3';
const tracer = traceManager.createTracer({
name: 'ticket.computed-span-operation',
type: 'operation',
relationSchemaName: 'ticket',
requiredSpans: [{ name: 'end' }],
variants: {
cold_boot: { timeout: DEFAULT_COLDBOOT_TIMEOUT_DURATION },
},
// Define computed span in the initial definition as a Record
computedSpanDefinitions: {
[computedSpanName]: {
startSpan: match.withName('render-1'),
endSpan: match.withName('render-3'),
},
},
});
const traceId = tracer.start({
relatedTo: { ticketId: '1' },
variant: 'cold_boot',
});
(0, vitest_1.expect)(traceId).toBe('trace-0');
// prettier-ignore
const { spans } = (0, makeTimeline_1.getSpansFromTimeline) `
Events: ${(0, makeTimeline_1.Render)('start', 0)}---${(0, makeTimeline_1.Render)('render-1', 50)}----${(0, makeTimeline_1.Render)('render-2', 50)}----${(0, makeTimeline_1.Render)('render-3', 50)}--------${(0, makeTimeline_1.Render)('end', 0)}
Time: ${0} ${50} ${100} ${150} ${200}
`;
(0, processSpans_1.processSpans)(spans, traceManager);
(0, vitest_1.expect)(reportFn).toHaveBeenCalled();
const report = reportFn.mock.calls[0][0];
(0, vitest_1.expect)(report.name).toBe('ticket.computed-span-operation');
(0, vitest_1.expect)(report.duration).toBe(200);
(0, vitest_1.expect)(report.status).toBe('ok');
(0, vitest_1.expect)(report.interruption).toBeUndefined();
(0, vitest_1.expect)(report.computedSpans[computedSpanName]?.startOffset).toBe(50);
(0, vitest_1.expect)(report.computedSpans[computedSpanName]?.duration).toBe(150);
});
(0, vitest_1.it)('correctly calculates multiple computed spans in definition', () => {
const traceManager = new TraceManager_1.TraceManager({
relationSchemas: relationSchemas_1.ticketAndUserAndGlobalRelationSchemasFixture,
reportFn: getReportFn(),
generateId,
reportErrorFn,
});
const tracer = traceManager.createTracer({
name: 'ticket.multiple-computed-spans',
type: 'operation',
relationSchemaName: 'global',
requiredSpans: [{ name: 'end' }],
variants: {
cold_boot: { timeout: DEFAULT_COLDBOOT_TIMEOUT_DURATION },
},
computedSpanDefinitions: {
'first-to-second': {
startSpan: match.withName('render-1'),
endSpan: match.withName('render-2'),
},
'second-to-third': {
startSpan: match.withName('render-2'),
endSpan: match.withName('render-3'),
},
},
});
tracer.start({
relatedTo: { ticketId: '1' },
variant: 'cold_boot',
});
// prettier-ignore
const { spans } = (0, makeTimeline_1.getSpansFromTimeline) `
Events: ${(0, makeTimeline_1.Render)('start', 0)}---${(0, makeTimeline_1.Render)('render-1', 50)}----${(0, makeTimeline_1.Render)('render-2', 50)}----${(0, makeTimeline_1.Render)('render-3', 50)}--------${(0, makeTimeline_1.Render)('end', 0)}
Time: ${0} ${50} ${100} ${150} ${200}
`;
(0, processSpans_1.processSpans)(spans, traceManager);
(0, vitest_1.expect)(reportFn).toHaveBeenCalled();
const report = reportFn.mock.calls[0][0];
(0, vitest_1.expect)(report.computedSpans['first-to-second']?.startOffset).toBe(50);
(0, vitest_1.expect)(report.computedSpans['first-to-second']?.duration).toBe(100);
(0, vitest_1.expect)(report.computedSpans['second-to-third']?.startOffset).toBe(100);
(0, vitest_1.expect)(report.computedSpans['second-to-third']?.duration).toBe(100);
});
});
(0, vitest_1.describe)('requiredSpans error behavior', () => {
(0, vitest_1.it)('interrupts trace when a required span has an error status', () => {
const traceManager = new TraceManager_1.TraceManager({
relationSchemas: relationSchemas_1.ticketAndUserAndGlobalRelationSchemasFixture,
reportFn: getReportFn(),
generateId,
reportErrorFn,
});
const tracer = traceManager.createTracer({
name: 'ticket.required-span-error',
type: 'operation',
relationSchemaName: 'global',
requiredSpans: [{ name: 'feature' }],
variants: {
cold_boot: { timeout: DEFAULT_COLDBOOT_TIMEOUT_DURATION },
},
});
tracer.start({
relatedTo: { ticketId: '1' },
variant: 'cold_boot',
});
// prettier-ignore
const { spans } = (0, makeTimeline_1.getSpansFromTimeline) `
Events: ${(0, makeTimeline_1.Render)('start', 0)}--${(0, makeTimeline_1.Render)('feature', 50, { status: 'error' })}
Time: ${0} ${50}
`;
(0, processSpans_1.processSpans)(spans, traceManager);
(0, vitest_1.expect)(reportFn).toHaveBeenCalled();
const report = reportFn.mock.calls[0][0];
(0, vitest_1.expect)(report.status).toBe('interrupted');
(0, vitest_1.expect)(report.interruption).toMatchObject({
reason: 'matched-on-required-span-with-error',
});
});
(0, vitest_1.it)('does not interrupt trace when required span error is explicitly ignored', () => {
const traceManager = new TraceManager_1.TraceManager({
relationSchemas: relationSchemas_1.ticketAndUserAndGlobalRelationSchemasFixture,
reportFn: getReportFn(),
generateId,
reportErrorFn,
});
const tracer = traceManager.createTracer({
name: 'ticket.required-span-error-ignored',
type: 'operation',
relationSchemaName: 'global',
requiredSpans: [
match.withAllConditions(match.withName('feature'), match.continueWithErrorStatus()),
],
variants: {
cold_boot: { timeout: DEFAULT_COLDBOOT_TIMEOUT_DURATION },
},
});
tracer.start({
relatedTo: { ticketId: '1' },
variant: 'cold_boot',
});
// prettier-ignore
const { spans } = (0, makeTimeline_1.getSpansFromTimeline) `
Events: ${(0, makeTimeline_1.Render)('start', 0)}--${(0, makeTimeline_1.Render)('feature', 50, { status: 'error' })}--${(0, makeTimeline_1.Render)('end', 0)}
Time: ${0} ${50} ${100}
`;
(0, processSpans_1.processSpans)(spans, traceManager);
(0, vitest_1.expect)(reportFn).toHaveBeenCalled();
const report = reportFn.mock.calls[0][0];
(0, vitest_1.expect)(report.status).toBe('error');
(0, vitest_1.expect)(report.interruption).toBeUndefined();
});
(0, vitest_1.it)('interrupts trace when one of multiple required spans has an error', () => {
const traceManager = new TraceManager_1.TraceManager({
relationSchemas: relationSchemas_1.ticketAndUserAndGlobalRelationSchemasFixture,
reportFn: getReportFn(),
generateId,
reportErrorFn,
});
const tracer = traceManager.createTracer({
name: 'ticket.multiple-required-spans-error',
type: 'operation',
relationSchemaName: 'global',
requiredSpans: [{ name: 'feature-1' }, { name: 'feature-2' }],
variants: {
cold_boot: { timeout: DEFAULT_COLDBOOT_TIMEOUT_DURATION },
},
});
tracer.start({
relatedTo: { ticketId: '1' },
variant: 'cold_boot',
});
// prettier-ignore
const { spans } = (0, makeTimeline_1.getSpansFromTimeline) `
Events: ${(0, makeTimeline_1.Render)('start', 0)}--${(0, makeTimeline_1.Render)('feature-1', 50)}--${(0, makeTimeline_1.Render)('feature-2', 50, { status: 'error' })}
Time: ${0} ${50} ${100}
`;
(0, processSpans_1.processSpans)(spans, traceManager);
(0, vitest_1.expect)(reportFn).toHaveBeenCalled();
const report = reportFn.mock.calls[0][0];
(0, vitest_1.expect)(report.status).toBe('interrupted');
(0, vitest_1.expect)(report.interruption).toMatchObject({
reason: 'matched-on-required-span-with-error',
});
});
});
(0, vitest_1.describe)('computedValueDefinitions', () => {
(0, vitest_1.it)('correctly calculates a computed value provided in definition', () => {
const traceManager = new TraceManager_1.TraceManager({
relationSchemas: relationSchemas_1.ticketAndUserAndGlobalRelationSchemasFixture,
reportFn: getReportFn(),
generateId,
reportErrorFn,
});
const tracer = traceManager.createTracer({
name: 'ticket.computed-value-operation',
type: 'operation',
relationSchemaName: 'global',
requiredSpans: [{ name: 'end' }],
variants: {
cold_boot: { timeout: DEFAULT_COLDBOOT_TIMEOUT_DURATION },
},
// Define computed value in the initial definition as a Record
computedValueDefinitions: {
feature: {
matches: [{ name: 'feature' }],
computeValueFromMatches: (feature) => feature.length,
},
},
});
tracer.start({
relatedTo: { ticketId: '1' },
variant: 'cold_boot',
});
// prettier-ignore
const { spans } = (0, makeTimeline_1.getSpansFromTimeline) `
Events: ${(0, makeTimeline_1.Render)('start', 0)}--${(0, makeTimeline_1.Render)('feature', 50)}--${(0, makeTimeline_1.Render)('feature', 50)}-${(0, makeTimeline_1.Render)('end', 0)}
Time: ${0} ${50} ${100} ${150}
`;
(0, processSpans_1.processSpans)(spans, traceManager);
(0, vitest_1.expect)(reportFn).toHaveBeenCalled();
const report = reportFn.mock.calls[0][0];
(0, vitest_1.expect)(report.computedValues).toEqual({
feature: 2,
});
});
(0, vitest_1.it)('correctly calculates multiple computed values with different matchers', () => {
const traceManager = new TraceManager_1.TraceManager({
relationSchemas: relationSchemas_1.ticketAndUserAndGlobalRelationSchemasFixture,
reportFn: getReportFn(),
generateId,
reportErrorFn,
});
const tracer = traceManager.createTracer({
name: 'ticket.multiple-computed-values',
type: 'operation',
relationSchemaName: 'global',
requiredSpans: [{ name: 'end' }],
variants: {
cold_boot: { timeout: DEFAULT_COLDBOOT_TIMEOUT_DURATION },
},
computedValueDefinitions: {
'feature-count': {
matches: [match.withName('feature'), match.withName('feature-2')],
computeValueFromMatches: (feature, feature2) =>
// @ts-expect-error unexpected TS error
// eslint-disable-next-line @typescript-eslint/restrict-plus-operands
feature.length + feature2.length,
},
'error-count': {
matches: [match.withName((name) => name.startsWith('error'))],
// @ts-expect-error unexpected TS error
computeValueFromMatches: (errors) => errors.length,
},
},
});
tracer.start({
relatedTo: { ticketId: '1' },
variant: 'cold_boot',
});
// prettier-ignore
const { spans } = (0, makeTimeline_1.getSpansFromTimeline) `
Events: ${(0, makeTimeline_1.Render)('start', 0)}--${(0, makeTimeline_1.Render)('feature', 50)}--${(0, makeTimeline_1.Render)('error-1', 50)}--${(0, makeTimeline_1.Render)('feature', 50)}--${(0, makeTimeline_1.Render)('error-2', 50)}--${(0, makeTimeline_1.Render)('end', 0)}
Time: ${0} ${50} ${100} ${150} ${200} ${250}
`;
(0, processSpans_1.processSpans)(spans, traceManager);
(0, vitest_1.expect)(reportFn).toHaveBeenCalled();
const report = reportFn.mock.calls[0][0];
(0, vitest_1.expect)(report.computedValues).toEqual({
'feature-count': 2,
'error-count': 2,
});
});
(0, vitest_1.describe)('promoteSpanAttributes integration', () => {
(0, vitest_1.it)('should promote span attributes to trace attributes from specific span only', () => {
const traceManager = new TraceManager_1.TraceManager({
relationSchemas: relationSchemas_1.ticketAndUserAndGlobalRelationSchemasFixture,
reportFn: getReportFn(),
generateId,
reportErrorFn,
});
const tracer = traceManager.createTracer({
name: 'ticket.promote-span-attributes',
type: 'operation',
relationSchemaName: 'ticket',
requiredSpans: [match.withName('final')],
variants: { x: { timeout: 1_000 } },
promoteSpanAttributes: [
{
span: { name: 'foo', nthMatch: -1 },
attributes: ['foo', 'only'],
},
{
span: { name: 'bar', nthMatch: -1 },
attributes: ['bar', 'baz'],
},
],
});
tracer.start({ relatedTo: { ticketId: 't-aaa' }, variant: 'x' });
// prettier-ignore
const { spans } = (0, makeTimeline_1.getSpansFromTimeline) `
Events: ${(0, makeTimeline_1.Render)('foo', 0, { attributes: { foo: 'abc', only: 1, other: 99 } })}---${(0, makeTimeline_1.Render)('foo', 2, { attributes: { foo: 'bar' } })}---${(0, makeTimeline_1.Render)('bar', 4, { attributes: { bar: 123, baz: 'b', ignoreMe: 20 } })}---${(0, makeTimeline_1.Render)('final', 6)}
Time: ${0} ${2} ${4} ${6}
`;
(0, processSpans_1.processSpans)(spans, traceManager);
(0, vitest_1.expect)(reportFn).toHaveBeenCalled();
const report = reportFn.mock.calls[0][0];
(0, vitest_1.expect)(report.attributes.foo).toBe('bar');
(0, vitest_1.expect)(report.attributes.only).toBeUndefined();
(0, vitest_1.expect)(report.attributes.bar).toBe(123);
(0, vitest_1.expect)(report.attributes.baz).toBe('b');
(0, vitest_1.expect)(report.attributes.other).toBeUndefined();
});
(0, vitest_1.it)('should promote all span attributes to trace attributes when no nthMatch is specified', () => {
const traceManager = new TraceManager_1.TraceManager({
relationSchemas: relationSchemas_1.ticketAndUserAndGlobalRelationSchemasFixture,
reportFn: getReportFn(),
generateId,
reportErrorFn,
});
const tracer = traceManager.createTracer({
name: 'ticket.promote-span-attributes',
type: 'operation',
relationSchemaName: 'ticket',
requiredSpans: [match.withName('final')],
variants: { x: { timeout: 1_000 } },
promoteSpanAttributes: [
{ span: match.withName('foo'), attributes: ['foo', 'only'] },
{ span: match.withName('bar'), attributes: ['bar', 'baz'] },
],
});
tracer.start({ relatedTo: { ticketId: 't-aaa' }, variant: 'x' });
// prettier-ignore
const { spans } = (0, makeTimeline_1.getSpansFromTimeline) `
Events: ${(0, makeTimeline_1.Render)('foo', 0, { attributes: { foo: 'abc', only: 1, other: 99 } })}---${(0, makeTimeline_1.Render)('foo', 2, { attributes: { foo: 'bar' } })}---${(0, makeTimeline_1.Render)('bar', 4, { attributes: { bar: 123, baz: 'b', ignoreMe: 20 } })}---${(0, makeTimeline_1.Render)('final', 6)}
Time: ${0} ${2} ${4} ${6}
`;
(0, processSpans_1.processSpans)(spans, traceManager);
(0, vitest_1.expect)(reportFn).toHaveBeenCalled();
const report = reportFn.mock.calls[0][0];
(0, vitest_1.expect)(report.attributes.foo).toBe('bar');
(0, vitest_1.expect)(report.attributes.only).toBe(1);
(0, vitest_1.expect)(report.attributes.bar).toBe(123);
(0, vitest_1.expect)(report.attributes.baz).toBe('b');
(0, vitest_1.expect)(report.attributes.other).toBeUndefined();
});
(0, vitest_1.it)('should prefer explicit trace attributes over promoted', () => {
const traceManager = new TraceManager_1.TraceManager({
relationSchemas: relationSchemas_1.ticketAndUserAndGlobalRelationSchemasFixture,
reportFn: getReportFn(),
generateId,
reportErrorFn,
});
const tracer = traceManager.createTracer({
name: 'ticket.promote-span-precedence',
type: 'operation',
relationSchemaName: 'ticket',
requiredSpans: [match.withName('final')],
variants: { v: { timeout: 1_000 } },
promoteSpanAttributes: [
{ span: match.withName('foo'), attributes: ['foo', 'bar'] },
],
});
tracer.start({
relatedTo: { ticketId: 't-bbb' },
variant: 'v',
attributes: { foo: 'winner', bar: 'own' },
});
// prettier-ignore
const { spans } = (0, makeTimeline_1.getSpansFromTimeline) `
Events: ${(0, makeTimeline_1.Render)('foo', 3, { attributes: { foo: 'loser', bar: 'lost' } })}---${(0, makeTimeline_1.Render)('final', 5)}
Time: ${3} ${5}
`;
(0, processSpans_1.processSpans)(spans, traceManager);
(0, vitest_1.expect)(reportFn).toHaveBeenCalled();
const report = reportFn.mock.calls[0][0];
(0, vitest_1.expect)(report.attributes.foo).toBe('winner');
(0, vitest_1.expect)(report.attributes.bar).toBe('own');
});
(0, vitest_1.it)('should promote on interruption', () => {
const traceManager = new TraceManager_1.TraceManager({
relationSchemas: relationSchemas_1.ticketAndUserAndGlobalRelationSchemasFixture,
reportFn: getReportFn(),
generateId,
reportErrorFn,
});
const tracer = traceManager.createTracer({
name: 'ticket.promote-span-interrupt',
type: 'operation',
relationSchemaName: 'ticket',
requiredSpans: [match.withName('done')],
variants: { iv: { timeout: 1_000 } },
promoteSpanAttributes: [
{ span: match.withName('interruptme'), attributes: ['interrupt'] },
],
});
tracer.start({ relatedTo: { ticketId: 't-interrupt' }, variant: 'iv' });
// prettier-ignore
const { spans } = (0, makeTimeline_1.getSpansFromTimeline) `
Events: ${(0, makeTimeline_1.Render)('interruptme', 8, { attributes: { interrupt: 'here' } })}---${(0, makeTimeline_1.Render)('done', 20)}
Time: ${8} ${20}
`;
// forcibly interrupt
(0, processSpans_1.processSpans)(spans, traceManager);
(0, vitest_1.expect)(reportFn).toHaveBeenCalled();
const report = reportFn.mock.calls[0][0];
(0, vitest_1.expect)(report.attributes.interrupt).toBe('here');
});
});
});
});
//# sourceMappingURL=tracerDefinitions.test.js.map