feat(replay): Add additional properties for UI clicks #7395
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,18 @@ | ||
| import * as Sentry from '@sentry/browser'; | ||
|
|
||
| window.Sentry = Sentry; | ||
| window.Replay = new Sentry.Replay({ | ||
| flushMinDelay: 500, | ||
| flushMaxDelay: 500, | ||
| useCompression: false, | ||
| blockAllMedia: false, | ||
| }); | ||
|
|
||
| Sentry.init({ | ||
| dsn: 'https://[email protected]/1337', | ||
| sampleRate: 0, | ||
| replaysSessionSampleRate: 1.0, | ||
| replaysOnErrorSampleRate: 0.0, | ||
|
|
||
| integrations: [window.Replay], | ||
| }); |
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,17 @@ | ||
| <!DOCTYPE html> | ||
| <html> | ||
| <head> | ||
| <meta charset="utf-8" /> | ||
| </head> | ||
| <body> | ||
| <div role="button" id="error" class="btn btn-error" aria-label="An Error">An Error</div> | ||
| <button> | ||
| <img id="img" | ||
| alt="Alt Text" | ||
| /> | ||
| </button> | ||
| <button class="sentry-unmask" aria-label="Unmasked label"> | ||
| Unmasked | ||
| </button> | ||
| </body> | ||
| </html> |
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,103 @@ | ||
| import { expect } from '@playwright/test'; | ||
|
|
||
| import { sentryTest } from '../../../utils/fixtures'; | ||
| import { expectedClickBreadcrumb } from '../../../utils/replayEventTemplates'; | ||
| import { getReplayRecordingContent, shouldSkipReplayTest, waitForReplayRequest } from '../../../utils/replayHelpers'; | ||
|
|
||
| for (let i = 0; i < 100; i++) { | ||
| sentryTest( | ||
| `replay should have correct click breadcrumbs${i}`, | ||
| async ({ forceFlushReplay, getLocalTestPath, page }) => { | ||
| if (shouldSkipReplayTest()) { | ||
| sentryTest.skip(); | ||
| } | ||
|
|
||
| const reqPromise0 = waitForReplayRequest(page, 0); | ||
| const reqPromise1 = waitForReplayRequest(page, 1); | ||
|
|
||
| await page.route('https://dsn.ingest.sentry.io/**/*', route => { | ||
| return route.fulfill({ | ||
| status: 200, | ||
| contentType: 'application/json', | ||
| body: JSON.stringify({ id: 'test-id' }), | ||
| }); | ||
| }); | ||
|
|
||
| const url = await getLocalTestPath({ testDir: __dirname }); | ||
|
|
||
| await page.goto(url); | ||
| await reqPromise0; | ||
|
|
||
| await page.click('#error'); | ||
| await page.click('#img'); | ||
| await page.click('.sentry-unmask'); | ||
| await forceFlushReplay(); | ||
| const req1 = await reqPromise1; | ||
| const content1 = getReplayRecordingContent(req1); | ||
| expect(content1.breadcrumbs).toEqual( | ||
| expect.arrayContaining([ | ||
| { | ||
| ...expectedClickBreadcrumb, | ||
| data: { | ||
| nodeId: expect.any(Number), | ||
| node: { | ||
| attributes: { | ||
| 'aria-label': '** *****', | ||
| class: 'btn btn-error', | ||
| id: 'error', | ||
| role: 'button', | ||
| }, | ||
| id: expect.any(Number), | ||
| tagName: 'div', | ||
| textContent: '** *****', | ||
| }, | ||
| }, | ||
| }, | ||
| ]), | ||
| ); | ||
|
|
||
| expect(content1.breadcrumbs).toEqual( | ||
| expect.arrayContaining([ | ||
| { | ||
| ...expectedClickBreadcrumb, | ||
| data: { | ||
| nodeId: expect.any(Number), | ||
| node: { | ||
| attributes: { | ||
| alt: 'Alt Text', | ||
| id: 'img', | ||
| }, | ||
| id: expect.any(Number), | ||
| tagName: 'img', | ||
| textContent: '', | ||
| }, | ||
| }, | ||
| }, | ||
| ]), | ||
| ); | ||
|
|
||
| expect(content1.breadcrumbs).toEqual( | ||
| expect.arrayContaining([ | ||
| { | ||
| ...expectedClickBreadcrumb, | ||
| data: { | ||
| nodeId: expect.any(Number), | ||
| node: { | ||
| attributes: { | ||
| // TODO(rrweb): This is a bug in our rrweb fork! | ||
| // This attribute should be unmasked. | ||
| // 'aria-label': 'Unmasked label', | ||
| 'aria-label': '******** *****', | ||
| class: 'sentry-unmask', | ||
| }, | ||
| id: expect.any(Number), | ||
| tagName: 'button', | ||
| textContent: 'Unmasked', | ||
| }, | ||
| }, | ||
| }, | ||
| ]), | ||
| ); | ||
| }, | ||
| ); | ||
| } |
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
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
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,32 @@ | ||
| // Attributes we are interested in: | ||
| const ATTRIBUTES_TO_RECORD = new Set([ | ||
| 'id', | ||
| 'class', | ||
| 'aria-label', | ||
| 'role', | ||
| 'name', | ||
| 'alt', | ||
| 'title', | ||
| 'data-test-id', | ||
| 'data-testid', | ||
| ]); | ||
|
|
||
| /** | ||
| * Inclusion list of attributes that we want to record from the DOM element | ||
| */ | ||
| export function getAttributesToRecord(attributes: Record<string, unknown>): Record<string, unknown> { | ||
| const obj: Record<string, unknown> = {}; | ||
| for (const key in attributes) { | ||
| if (ATTRIBUTES_TO_RECORD.has(key)) { | ||
| let normalizedKey = key; | ||
|
|
||
| if (key === 'data-testid' || key === 'data-test-id') { | ||
| normalizedKey = 'testId'; | ||
| } | ||
|
Comment on lines
+24
to
+26
There was a problem hiding this comment. @ryan953 let's capture both and normal to |
||
|
|
||
| obj[normalizedKey] = attributes[key]; | ||
| } | ||
| } | ||
|
|
||
| return obj; | ||
| } | ||
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,32 @@ | ||
| import { getAttributesToRecord } from '../../../../src/coreHandlers/util/getAttributesToRecord'; | ||
|
|
||
| it('records only included attributes', function () { | ||
| expect( | ||
| getAttributesToRecord({ | ||
| id: 'foo', | ||
| classList: ['btn', 'btn-primary'], | ||
| }), | ||
| ).toEqual({ | ||
| id: 'foo', | ||
| classList: ['btn', 'btn-primary'], | ||
| }); | ||
|
|
||
| expect( | ||
| getAttributesToRecord({ | ||
| id: 'foo', | ||
| classList: ['btn', 'btn-primary'], | ||
| tabIndex: 2, | ||
| ariaDescribedBy: 'tooltip-1', | ||
| }), | ||
| ).toEqual({ | ||
| id: 'foo', | ||
| classList: ['btn', 'btn-primary'], | ||
| }); | ||
|
|
||
| expect( | ||
| getAttributesToRecord({ | ||
| tabIndex: 2, | ||
| ariaDescribedBy: 'tooltip-1', | ||
| }), | ||
| ).toEqual({}); | ||
| }); |
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.
Removing this as it can leak attributes (e.g. aria label) that are masked with
maskAllText