Skip to content

test(browser-integration-tests): Check trace envelope headers in trace lifetime tests #11660

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 3 commits into from
Apr 18, 2024
Merged

test(browser-integration-tests): Check trace envelope headers in trace lifetime tests #11660

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
8cd3b1d
wip
Lms24 Apr 17, 2024
64a9c6c
more test refactors
Lms24 Apr 17, 2024
cdfab9d
biome
Lms24 Apr 17, 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
169 changes: 148 additions & 21 deletions dev-packages/browser-integration-tests/suites/tracing/trace-lifetime/navigation/test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,9 @@
import { expect } from '@playwright/test';
import type { Event } from '@sentry/types';
import { sentryTest } from '../../../../utils/fixtures';
import type { EventAndTraceHeader } from '../../../../utils/helpers';
import {
eventAndTraceHeaderRequestParser,
getFirstSentryEnvelopeRequest,
getMultipleSentryEnvelopeRequests,
shouldSkipTracingTest,
Expand All @@ -14,12 +16,21 @@ sentryTest('creates a new trace on each navigation', async ({ getLocalTestPath,

const url = await getLocalTestPath({ testDir: __dirname });

await getFirstSentryEnvelopeRequest<Event>(page, url);
const navigationEvent1 = await getFirstSentryEnvelopeRequest<Event>(page, `${url}#foo`);
const navigationEvent2 = await getFirstSentryEnvelopeRequest<Event>(page, `${url}#bar`);
await getFirstSentryEnvelopeRequest(page, url);

const [navigation1Event, navigation1TraceHeader] = await getFirstSentryEnvelopeRequest<EventAndTraceHeader>(
page,
`${url}#foo`,
eventAndTraceHeaderRequestParser,
);
const [navigation2Event, navigation2TraceHeader] = await getFirstSentryEnvelopeRequest<EventAndTraceHeader>(
page,
`${url}#bar`,
eventAndTraceHeaderRequestParser,
);

const navigation1TraceContext = navigationEvent1.contexts?.trace;
const navigation2TraceContext = navigationEvent2.contexts?.trace;
const navigation1TraceContext = navigation1Event.contexts?.trace;
const navigation2TraceContext = navigation2Event.contexts?.trace;

expect(navigation1TraceContext).toMatchObject({
op: 'navigation',
Expand All @@ -28,13 +39,29 @@ sentryTest('creates a new trace on each navigation', async ({ getLocalTestPath,
});
expect(navigation1TraceContext).not.toHaveProperty('parent_span_id');

expect(navigation1TraceHeader).toEqual({
environment: 'production',
public_key: 'public',
sample_rate: '1',
sampled: 'true',
trace_id: navigation1TraceContext?.trace_id,
});

expect(navigation2TraceContext).toMatchObject({
op: 'navigation',
trace_id: expect.stringMatching(/^[0-9a-f]{32}$/),
span_id: expect.stringMatching(/^[0-9a-f]{16}$/),
});
expect(navigation2TraceContext).not.toHaveProperty('parent_span_id');

expect(navigation2TraceHeader).toEqual({
environment: 'production',
public_key: 'public',
sample_rate: '1',
sampled: 'true',
trace_id: navigation2TraceContext?.trace_id,
});

expect(navigation1TraceContext?.trace_id).not.toEqual(navigation2TraceContext?.trace_id);
});

Expand All @@ -48,7 +75,11 @@ sentryTest('error after navigation has navigation traceId', async ({ getLocalTes
// ensure pageload transaction is finished
await getFirstSentryEnvelopeRequest<Event>(page, url);

const navigationEvent = await getFirstSentryEnvelopeRequest<Event>(page, `${url}#foo`);
const [navigationEvent, navigationTraceHeader] = await getFirstSentryEnvelopeRequest<EventAndTraceHeader>(
page,
`${url}#foo`,
eventAndTraceHeaderRequestParser,
);
const navigationTraceContext = navigationEvent.contexts?.trace;

expect(navigationTraceContext).toMatchObject({
Expand All @@ -58,15 +89,34 @@ sentryTest('error after navigation has navigation traceId', async ({ getLocalTes
});
expect(navigationTraceContext).not.toHaveProperty('parent_span_id');

const errorEventPromise = getFirstSentryEnvelopeRequest<Event>(page);
expect(navigationTraceHeader).toEqual({
environment: 'production',
public_key: 'public',
sample_rate: '1',
sampled: 'true',
trace_id: navigationTraceContext?.trace_id,
});

const errorEventPromise = getFirstSentryEnvelopeRequest<EventAndTraceHeader>(
page,
undefined,
eventAndTraceHeaderRequestParser,
);
await page.locator('#errorBtn').click();
const errorEvent = await errorEventPromise;
const [errorEvent, errorTraceHeader] = await errorEventPromise;

const errorTraceContext = errorEvent.contexts?.trace;
expect(errorTraceContext).toEqual({
trace_id: navigationTraceContext?.trace_id,
span_id: expect.stringMatching(/^[0-9a-f]{16}$/),
});
expect(errorTraceHeader).toEqual({
environment: 'production',
public_key: 'public',
sample_rate: '1',
sampled: 'true',
trace_id: navigationTraceContext?.trace_id,
});
});

sentryTest('error during navigation has new navigation traceId', async ({ getLocalTestPath, page }) => {
Expand All @@ -79,13 +129,19 @@ sentryTest('error during navigation has new navigation traceId', async ({ getLoc
// ensure navigation transaction is finished
await getFirstSentryEnvelopeRequest<Event>(page, url);

const envelopeRequestsPromise = getMultipleSentryEnvelopeRequests<Event>(page, 2);
const envelopeRequestsPromise = getMultipleSentryEnvelopeRequests<EventAndTraceHeader>(
page,
2,
undefined,
eventAndTraceHeaderRequestParser,
);

await page.goto(`${url}#foo`);
await page.locator('#errorBtn').click();
const events = await envelopeRequestsPromise;
const envelopes = await envelopeRequestsPromise;

const navigationEvent = events.find(event => event.type === 'transaction');
const errorEvent = events.find(event => !event.type);
const [navigationEvent, navigationTraceHeader] = envelopes.find(envelope => envelope[0].type === 'transaction')!;
const [errorEvent, errorTraceHeader] = envelopes.find(envelope => !envelope[0].type)!;

const navigationTraceContext = navigationEvent?.contexts?.trace;
expect(navigationTraceContext).toMatchObject({
Expand All @@ -95,12 +151,28 @@ sentryTest('error during navigation has new navigation traceId', async ({ getLoc
});
expect(navigationTraceContext).not.toHaveProperty('parent_span_id');

expect(navigationTraceHeader).toEqual({
environment: 'production',
public_key: 'public',
sample_rate: '1',
sampled: 'true',
trace_id: navigationTraceContext?.trace_id,
});

const errorTraceContext = errorEvent?.contexts?.trace;
expect(errorTraceContext).toMatchObject({
op: 'navigation',
trace_id: errorTraceContext?.trace_id,
trace_id: navigationTraceContext?.trace_id,
span_id: expect.stringMatching(/^[0-9a-f]{16}$/),
});

expect(errorTraceHeader).toEqual({
environment: 'production',
public_key: 'public',
sample_rate: '1',
sampled: 'true',
trace_id: navigationTraceContext?.trace_id,
});
});

sentryTest(
Expand All @@ -115,7 +187,11 @@ sentryTest(
// ensure navigation transaction is finished
await getFirstSentryEnvelopeRequest<Event>(page, url);

const navigationEvent = await getFirstSentryEnvelopeRequest<Event>(page, `${url}#foo`);
const [navigationEvent, navigationTraceHeader] = await getFirstSentryEnvelopeRequest<EventAndTraceHeader>(
page,
`${url}#foo`,
eventAndTraceHeaderRequestParser,
);

const navigationTraceContext = navigationEvent.contexts?.trace;
expect(navigationTraceContext).toMatchObject({
Expand All @@ -125,6 +201,14 @@ sentryTest(
});
expect(navigationTraceContext).not.toHaveProperty('parent_span_id');

expect(navigationTraceHeader).toEqual({
environment: 'production',
public_key: 'public',
sample_rate: '1',
sampled: 'true',
trace_id: navigationTraceContext?.trace_id,
});

const requestPromise = page.waitForRequest('http://example.com/*');
await page.locator('#fetchBtn').click();
const request = await requestPromise;
Expand All @@ -151,11 +235,18 @@ sentryTest(
// ensure navigation transaction is finished
await getFirstSentryEnvelopeRequest<Event>(page, url);

const navigationEventPromise = getFirstSentryEnvelopeRequest<Event>(page);
const navigationEventPromise = getFirstSentryEnvelopeRequest<EventAndTraceHeader>(
page,
undefined,
eventAndTraceHeaderRequestParser,
);
const requestPromise = page.waitForRequest('http://example.com/*');
await page.goto(`${url}#foo`);
await page.locator('#fetchBtn').click();
const [navigationEvent, request] = await Promise.all([navigationEventPromise, requestPromise]);
const [[navigationEvent, navigationTraceHeader], request] = await Promise.all([
navigationEventPromise,
requestPromise,
]);

const navigationTraceContext = navigationEvent.contexts?.trace;
expect(navigationTraceContext).toMatchObject({
Expand All @@ -165,6 +256,14 @@ sentryTest(
});
expect(navigationTraceContext).not.toHaveProperty('parent_span_id');

expect(navigationTraceHeader).toEqual({
environment: 'production',
public_key: 'public',
sample_rate: '1',
sampled: 'true',
trace_id: navigationTraceContext?.trace_id,
});

const headers = request.headers();

// sampling decision is propagated from active span sampling decision
Expand All @@ -186,9 +285,13 @@ sentryTest(
const url = await getLocalTestPath({ testDir: __dirname });

// ensure navigation transaction is finished
await getFirstSentryEnvelopeRequest<Event>(page, url);
await getFirstSentryEnvelopeRequest(page, url);

const navigationEvent = await getFirstSentryEnvelopeRequest<Event>(page, `${url}#foo`);
const [navigationEvent, navigationTraceHeader] = await getFirstSentryEnvelopeRequest<EventAndTraceHeader>(
page,
`${url}#foo`,
eventAndTraceHeaderRequestParser,
);

const navigationTraceContext = navigationEvent.contexts?.trace;
expect(navigationTraceContext).toMatchObject({
Expand All @@ -198,6 +301,14 @@ sentryTest(
});
expect(navigationTraceContext).not.toHaveProperty('parent_span_id');

expect(navigationTraceHeader).toEqual({
environment: 'production',
public_key: 'public',
sample_rate: '1',
sampled: 'true',
trace_id: navigationTraceContext?.trace_id,
});

const xhrPromise = page.waitForRequest('http://example.com/*');
await page.locator('#xhrBtn').click();
const request = await xhrPromise;
Expand All @@ -222,13 +333,20 @@ sentryTest(
const url = await getLocalTestPath({ testDir: __dirname });

// ensure navigation transaction is finished
await getFirstSentryEnvelopeRequest<Event>(page, url);
await getFirstSentryEnvelopeRequest(page, url);

const navigationEventPromise = getFirstSentryEnvelopeRequest<Event>(page);
const navigationEventPromise = getFirstSentryEnvelopeRequest<EventAndTraceHeader>(
page,
undefined,
eventAndTraceHeaderRequestParser,
);
const requestPromise = page.waitForRequest('http://example.com/*');
await page.goto(`${url}#foo`);
await page.locator('#xhrBtn').click();
const [navigationEvent, request] = await Promise.all([navigationEventPromise, requestPromise]);
const [[navigationEvent, navigationTraceHeader], request] = await Promise.all([
navigationEventPromise,
requestPromise,
]);

const navigationTraceContext = navigationEvent.contexts?.trace;
expect(navigationTraceContext).toMatchObject({
Expand All @@ -237,6 +355,15 @@ sentryTest(
span_id: expect.stringMatching(/^[0-9a-f]{16}$/),
});
expect(navigationTraceContext).not.toHaveProperty('parent_span_id');

expect(navigationTraceHeader).toEqual({
environment: 'production',
public_key: 'public',
sample_rate: '1',
sampled: 'true',
trace_id: navigationTraceContext?.trace_id,
});

const headers = request.headers();

// sampling decision is propagated from active span sampling decision
Expand Down
Loading
Loading