Skip to content

test(instr-document-load): fix test to allow missing network span events #2145

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Apr 25, 2024
Merged

test(instr-document-load): fix test to allow missing network span events #2145

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c7e9980
test(instr-document-load): fix test to allow missing network span events
trentm Apr 24, 2024
111bb25
Merge branch 'main' into tm-document-load-allow-missing-network-span-…
trentm Apr 25, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
59 changes: 30 additions & 29 deletions plugins/web/opentelemetry-instrumentation-document-load/test/documentLoad.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -555,43 +555,44 @@ describe('DocumentLoad Instrumentation', () => {
assert.strictEqual(rootSpan.attributes['http.user_agent'], userAgent);

ensureNetworkEventsExists(fsEvents);
assert.strictEqual(fsEvents.length, 8);

assert.strictEqual(rsEvents[0].name, PTN.FETCH_START);
assert.strictEqual(rsEvents[1].name, PTN.UNLOAD_EVENT_START);
assert.strictEqual(rsEvents[2].name, PTN.UNLOAD_EVENT_END);
assert.strictEqual(rsEvents[3].name, PTN.DOM_INTERACTIVE);
assert.strictEqual(
rsEvents[4].name,
PTN.DOM_CONTENT_LOADED_EVENT_START
);
assert.strictEqual(rsEvents[5].name, PTN.DOM_CONTENT_LOADED_EVENT_END);
assert.strictEqual(rsEvents[6].name, PTN.DOM_COMPLETE);
assert.strictEqual(rsEvents[7].name, PTN.LOAD_EVENT_START);
assert.strictEqual(rsEvents[8].name, PTN.LOAD_EVENT_END);
const rsEventNames = rsEvents.map(e => e.name);
// Allow the unloadEvent{Start,End} events to be missing. Tests that
// are simulating a fallback to window.performance.timing are using
// values (entriesFallback) for that result in those network span
// events being dropped after https://github.com/open-telemetry/opentelemetry-js/pull/4486
// (@opentelemetry/[email protected]).
const expectedRsEventNames =
rsEventNames[1] === PTN.UNLOAD_EVENT_START
? [
PTN.FETCH_START,
PTN.UNLOAD_EVENT_START,
PTN.UNLOAD_EVENT_END,
PTN.DOM_INTERACTIVE,
PTN.DOM_CONTENT_LOADED_EVENT_START,
PTN.DOM_CONTENT_LOADED_EVENT_END,
PTN.DOM_COMPLETE,
PTN.LOAD_EVENT_START,
PTN.LOAD_EVENT_END,
]
: [
PTN.FETCH_START,
PTN.DOM_INTERACTIVE,
PTN.DOM_CONTENT_LOADED_EVENT_START,
PTN.DOM_CONTENT_LOADED_EVENT_END,
PTN.DOM_COMPLETE,
PTN.LOAD_EVENT_START,
PTN.LOAD_EVENT_END,
];
assert.deepStrictEqual(rsEventNames, expectedRsEventNames);

assert.strictEqual(fsEvents.length, 8);
assert.strictEqual(rsEvents.length, 9);
assert.strictEqual(exporter.getFinishedSpans().length, 2);
done();
});
});
}

describe('when navigation entries types are NOT available then fallback to "performance.timing"', () => {
const sandbox = sinon.createSandbox();
beforeEach(() => {
sandbox.stub(window.performance, 'getEntriesByType').value(undefined);
sandbox.stub(window.performance, 'timing').get(() => {
return entriesFallback;
});
});
afterEach(() => {
sandbox.restore();
});

shouldExportCorrectSpan();
});

describe('when getEntriesByType is not defined then fallback to "performance.timing"', () => {
const sandbox = sinon.createSandbox();
beforeEach(() => {
Expand Down