test(e2e): Port React Router E2E test apps to span streaming #23839
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,164 @@ | ||
| import { expect, test } from '@playwright/test'; | ||
| import { | ||
| collectStreamedSpans, | ||
| getSpanOp, | ||
| waitForStreamedSpan, | ||
| waitForStreamedSpans, | ||
| } from '@sentry-internal/test-utils'; | ||
|
|
||
| const PREVIOUS_TRACE_LINK = [ | ||
| { | ||
| attributes: { | ||
| 'sentry.link.type': { value: 'previous_trace', type: 'string' }, | ||
| }, | ||
| sampled: true, | ||
| span_id: expect.stringMatching(/[a-f0-9]{16}/), | ||
| trace_id: expect.stringMatching(/[a-f0-9]{32}/), | ||
| }, | ||
| ]; | ||
|
|
||
| test('Captures a pageload span', async ({ page }) => { | ||
| const spanPromise = waitForStreamedSpan('react-create-browser-router', span => { | ||
| return getSpanOp(span) === 'pageload' && span.is_segment; | ||
| }); | ||
|
|
||
| await page.goto('/'); | ||
|
|
||
| const span = await spanPromise; | ||
|
|
||
| expect(span.name).toBe('/'); | ||
| expect(span.status).toBe('ok'); | ||
| expect(span.span_id).toMatch(/[a-f0-9]{16}/); | ||
| expect(span.trace_id).toMatch(/[a-f0-9]{32}/); | ||
|
|
||
| expect(span.attributes).toMatchObject({ | ||
| 'device.memory.estimated_capacity': { value: expect.any(Number), type: expect.any(String) }, | ||
| 'device.processor_count': { value: expect.any(Number), type: 'integer' }, | ||
| 'network.connection.effective_type': { value: expect.any(String), type: 'string' }, | ||
| 'sentry.idle_span_finish_reason': { value: 'idleTimeout', type: 'string' }, | ||
| 'sentry.op': { value: 'pageload', type: 'string' }, | ||
| 'sentry.origin': { value: 'auto.pageload.react.reactrouter_v6', type: 'string' }, | ||
| 'sentry.sample_rate': { value: 1, type: 'integer' }, | ||
| 'sentry.segment.name.source': { value: 'route', type: 'string' }, | ||
| 'url.template': { value: '/', type: 'string' }, | ||
| 'url.path': { value: '/', type: 'string' }, | ||
| 'url.full': { value: expect.stringMatching(/^https?:\/\/localhost:\d+\/$/), type: 'string' }, | ||
| }); | ||
| }); | ||
|
|
||
| test('Captures a navigation span', async ({ page }) => { | ||
| const spansPromise = waitForStreamedSpans('react-create-browser-router', spans => { | ||
| return spans.some(span => getSpanOp(span) === 'navigation' && span.is_segment); | ||
| }); | ||
|
|
||
| await page.goto('/'); | ||
| const linkElement = page.locator('id=navigation'); | ||
| await linkElement.click(); | ||
|
|
||
| const spans = await spansPromise; | ||
| const navigationSpan = spans.find(span => span.is_segment)!; | ||
|
|
||
| expect(navigationSpan.name).toBe('/user/:id'); | ||
| expect(navigationSpan.status).toBe('ok'); | ||
| expect(navigationSpan.span_id).toMatch(/[a-f0-9]{16}/); | ||
| expect(navigationSpan.trace_id).toMatch(/[a-f0-9]{32}/); | ||
|
|
||
| expect(navigationSpan.attributes).toMatchObject({ | ||
| 'sentry.idle_span_finish_reason': { value: 'idleTimeout', type: 'string' }, | ||
| 'sentry.op': { value: 'navigation', type: 'string' }, | ||
| 'sentry.origin': { value: 'auto.navigation.react.reactrouter_v6', type: 'string' }, | ||
| 'sentry.sample_rate': { value: 1, type: 'integer' }, | ||
| 'sentry.segment.name.source': { value: 'route', type: 'string' }, | ||
| 'url.template': { value: '/user/:id', type: 'string' }, | ||
| 'url.path': { value: '/user/5', type: 'string' }, | ||
| 'url.full': { value: expect.stringMatching(/^https?:\/\/localhost:\d+\/user\/5$/), type: 'string' }, | ||
| }); | ||
|
|
||
| expect(navigationSpan.links).toEqual(PREVIOUS_TRACE_LINK); | ||
|
|
||
| // Filter out favicon spans which may or may not be present depending on the browser version | ||
| const childSpans = spans.filter( | ||
| span => !span.is_segment && !(span.attributes['url.full']?.value as string | undefined)?.includes('favicon'), | ||
| ); | ||
| expect(childSpans).toEqual([]); | ||
|
There was a problem hiding this comment. Child-span absence checked too narrowlyMedium Severity These tests expect navigation to have no child spans, but they only inspect the single envelope that contains the navigation segment. Streamed children flush as they end, often in earlier envelopes, so unexpected children would not be seen and the empty-array assertion would still pass. Flagged because the review guidelines call out relaxed negative assertions that do not actually prove something is absent from the payload. Additional Locations (2)  Triggered by project rule: PR Review Guidelines for Cursor Bot Reviewed by Cursor Bugbot for commit 3ea1d9b. Configure here. |
||
| }); | ||
|
|
||
| test('Captures a lazy pageload span', async ({ page }) => { | ||
| const spansPromise = collectStreamedSpans('react-create-browser-router', spans => { | ||
| return spans.some(span => getSpanOp(span) === 'pageload' && span.is_segment); | ||
| }); | ||
|
|
||
| await page.goto('/lazy-loaded-user/5/foo'); | ||
|
|
||
| const spans = await spansPromise; | ||
| const pageloadSpan = spans.find(span => getSpanOp(span) === 'pageload' && span.is_segment)!; | ||
|
|
||
| expect(pageloadSpan.name).toBe('/lazy-loaded-user/:id/:innerId'); | ||
| expect(pageloadSpan.status).toBe('ok'); | ||
|
|
||
| expect(pageloadSpan.attributes).toMatchObject({ | ||
| 'sentry.idle_span_finish_reason': { value: 'idleTimeout', type: 'string' }, | ||
| 'sentry.op': { value: 'pageload', type: 'string' }, | ||
| 'sentry.origin': { value: 'auto.pageload.react.reactrouter_v6', type: 'string' }, | ||
| 'sentry.sample_rate': { value: 1, type: 'integer' }, | ||
| 'sentry.segment.name.source': { value: 'route', type: 'string' }, | ||
| 'url.template': { value: '/lazy-loaded-user/:id/:innerId', type: 'string' }, | ||
| 'url.path': { value: '/lazy-loaded-user/5/foo', type: 'string' }, | ||
| 'url.full': { | ||
| value: expect.stringMatching(/^https?:\/\/localhost:\d+\/lazy-loaded-user\/5\/foo$/), | ||
| type: 'string', | ||
| }, | ||
| }); | ||
|
|
||
| expect(await page.innerText('id=content')).toContain('I am a lazy loaded user'); | ||
|
|
||
| // One span for the outer lazy route, one for the inner one | ||
| const resourceSpans = spans.filter( | ||
| span => | ||
| getSpanOp(span) === 'resource.script' && | ||
| span.attributes['sentry.origin']?.value === 'auto.resource.browser.metrics', | ||
| ); | ||
| expect(resourceSpans.length).toBeGreaterThanOrEqual(2); | ||
| }); | ||
|
|
||
| test('Captures a lazy navigation span', async ({ page }) => { | ||
| const spansPromise = collectStreamedSpans('react-create-browser-router', spans => { | ||
| return spans.some(span => getSpanOp(span) === 'navigation' && span.is_segment); | ||
| }); | ||
|
|
||
| await page.goto('/'); | ||
| const linkElement = page.locator('id=lazy-navigation'); | ||
| await linkElement.click(); | ||
|
|
||
| const spans = await spansPromise; | ||
| const navigationSpan = spans.find(span => getSpanOp(span) === 'navigation' && span.is_segment)!; | ||
|
|
||
| expect(navigationSpan.name).toBe('/lazy-loaded-user/:id/:innerId'); | ||
| expect(navigationSpan.status).toBe('ok'); | ||
|
|
||
| expect(navigationSpan.attributes).toMatchObject({ | ||
| 'sentry.idle_span_finish_reason': { value: 'idleTimeout', type: 'string' }, | ||
| 'sentry.op': { value: 'navigation', type: 'string' }, | ||
| 'sentry.origin': { value: 'auto.navigation.react.reactrouter_v6', type: 'string' }, | ||
| 'sentry.sample_rate': { value: 1, type: 'integer' }, | ||
| 'sentry.segment.name.source': { value: 'route', type: 'string' }, | ||
| 'url.template': { value: '/lazy-loaded-user/:id/:innerId', type: 'string' }, | ||
| 'url.path': { value: '/lazy-loaded-user/5/foo', type: 'string' }, | ||
| 'url.full': { | ||
| value: expect.stringMatching(/^https?:\/\/localhost:\d+\/lazy-loaded-user\/5\/foo$/), | ||
| type: 'string', | ||
| }, | ||
| }); | ||
|
|
||
| expect(navigationSpan.links).toEqual(PREVIOUS_TRACE_LINK); | ||
|
|
||
| expect(await page.innerText('id=content')).toContain('I am a lazy loaded user'); | ||
|
|
||
| // One span for the outer lazy route, one for the inner one | ||
| const resourceSpans = spans.filter( | ||
| span => | ||
| getSpanOp(span) === 'resource.script' && | ||
| span.attributes['sentry.origin']?.value === 'auto.resource.browser.metrics', | ||
| ); | ||
| expect(resourceSpans.length).toBeGreaterThanOrEqual(2); | ||
|
There was a problem hiding this comment. Lazy navigation counts pageload scriptsMedium Severity
Triggered by project rule: PR Review Guidelines for Cursor Bot Reviewed by Cursor Bugbot for commit 3ea1d9b. Configure here. |
||
| }); | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Wrong segment picked for navigation
Medium Severity
The wait predicate requires a navigation segment, but the span under test is then selected with
spans.find(span => span.is_segment). That envelope can also contain the still-finishing pageload segment, especially here because the click is not sequenced after pageload. Memory-router is most exposed because pageload and navigation share the name/user/:id. Flagged from the review guidelines on flaky waits that are not unique enough when telemetry can arrive in arbitrary order.Additional Locations (2)
dev-packages/e2e-tests/test-applications/react-create-hash-router/tests/spans.test.ts#L77-L79dev-packages/e2e-tests/test-applications/react-create-memory-router/tests/spans.test.ts#L38-L40Triggered by project rule: PR Review Guidelines for Cursor Bot
Reviewed by Cursor Bugbot for commit 3ea1d9b. Configure here.