Repository navigation
fix(feedback): Improve dialog keyboard access and input contrast #26194
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.
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
Open
david-kirkland
wants to merge
1
commit into
getsentry:develop
Choose a base branch
from
david-kirkland:feat/feedback-accessibility
base: develop
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
9 changes: 9 additions & 0 deletions
9
dev-packages/browser-integration-tests/suites/feedback/accessibility/init.js
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,9 @@ | ||
| import * as Sentry from '@sentry/browser'; | ||
| import { feedbackIntegration } from '@sentry/browser'; | ||
|
|
||
| window.Sentry = Sentry; | ||
|
|
||
| Sentry.init({ | ||
| dsn: 'https://public@dsn.ingest.sentry.io/1337', | ||
| integrations: [feedbackIntegration({ colorScheme: 'light' })], | ||
| }); |
6 changes: 6 additions & 0 deletions
6
dev-packages/browser-integration-tests/suites/feedback/accessibility/template.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,6 @@ | ||
| <!doctype html> | ||
| <html> | ||
| <body> | ||
| <button id="background">Background control</button> | ||
| </body> | ||
| </html> |
195 changes: 195 additions & 0 deletions
195
dev-packages/browser-integration-tests/suites/feedback/accessibility/test.ts
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,195 @@ | ||
| import { expect } from '@playwright/test'; | ||
| import type * as SentrySDK from '@sentry/browser'; | ||
| import { sentryTest } from '../../../utils/fixtures'; | ||
| import { shouldSkipFeedbackTest } from '../../../utils/helpers'; | ||
|
|
||
| sentryTest.beforeEach(async ({ getLocalTestUrl, page }) => { | ||
| sentryTest.skip(shouldSkipFeedbackTest()); | ||
| await page.goto(await getLocalTestUrl({ testDir: __dirname, handleLazyLoadedFeedback: true })); | ||
| }); | ||
|
|
||
| sentryTest('names the native modal and restores focus after repeated keyboard dismissal @firefox', async ({ page }) => { | ||
| const launcher = page.getByRole('button', { name: 'Report a Bug', exact: true }); | ||
| const dialog = page.locator('dialog'); | ||
|
|
||
| for (const key of ['Escape', 'Enter', 'Escape']) { | ||
| await launcher.focus(); | ||
| await page.keyboard.press('Enter'); | ||
| await expect(dialog).toBeVisible(); | ||
| await expect(dialog).toHaveAccessibleName('Report a Bug'); | ||
| await expect(dialog).toHaveJSProperty('open', true); | ||
| expect(await dialog.evaluate(el => el.matches(':modal'))).toBe(true); | ||
| await expect(page.getByRole('textbox', { name: 'Description' })).toBeFocused(); | ||
|
|
||
| await page.locator('#background').evaluate(el => (el as HTMLElement).focus()); | ||
| await expect(page.getByRole('textbox', { name: 'Description' })).toBeFocused(); | ||
|
|
||
| if (key === 'Enter') { | ||
| await page.getByRole('button', { name: 'Cancel', exact: true }).focus(); | ||
| } else { | ||
| await page.getByRole('textbox', { name: 'Name', exact: true }).focus(); | ||
| } | ||
| await page.keyboard.press(key); | ||
| await expect(dialog).not.toBeVisible(); | ||
| await expect(launcher).toBeFocused(); | ||
| } | ||
| }); | ||
|
|
||
| sentryTest('keeps keyboard navigation inside the modal @firefox', async ({ page }) => { | ||
| await page.getByRole('button', { name: 'Report a Bug', exact: true }).click(); | ||
| const cancel = page.getByRole('button', { name: 'Cancel', exact: true }); | ||
| await cancel.focus(); | ||
| await page.keyboard.press('Tab'); | ||
| await expect(page.getByRole('link', { name: 'Powered by Sentry' })).toBeFocused(); | ||
| await page.keyboard.press('Shift+Tab'); | ||
| await expect(cancel).toBeFocused(); | ||
| await page.keyboard.press('Escape'); | ||
| await expect(page.locator('dialog')).not.toBeVisible(); | ||
| }); | ||
|
|
||
| sentryTest('returns to a custom launcher inside another native modal @firefox', async ({ page }) => { | ||
| await page.evaluate(() => { | ||
| const { Sentry } = window as unknown as { Sentry: typeof SentrySDK }; | ||
| const parent = document.createElement('dialog'); | ||
| parent.id = 'parent-modal'; | ||
| document.body.appendChild(parent); | ||
| parent.appendChild(document.querySelector('#background')!); | ||
| parent.showModal(); | ||
| Sentry.getFeedback()!.attachTo('#background', { | ||
| formTitle: 'Custom feedback title', | ||
| showName: false, | ||
| showEmail: false, | ||
| showBranding: false, | ||
| enableScreenshot: false, | ||
| }); | ||
| }); | ||
| const launcher = page.getByRole('button', { name: 'Background control' }); | ||
| await launcher.click(); | ||
| await expect(page.getByRole('dialog', { name: 'Custom feedback title' })).toBeVisible(); | ||
| await expect(page.getByRole('textbox', { name: 'Description' })).toBeFocused(); | ||
| await page.getByRole('button', { name: 'Cancel', exact: true }).focus(); | ||
| await page.keyboard.press('Tab'); | ||
| await expect(page.getByRole('textbox', { name: 'Description' })).toBeFocused(); | ||
| await page.keyboard.press('Shift+Tab'); | ||
| await expect(page.getByRole('button', { name: 'Cancel', exact: true })).toBeFocused(); | ||
| await page.keyboard.press('Escape'); | ||
| await expect(launcher).toBeFocused(); | ||
| expect(await page.locator('#parent-modal').evaluate(el => el.matches(':modal'))).toBe(true); | ||
| }); | ||
|
|
||
| sentryTest('dismisses on backdrop click and restores focus @firefox', async ({ page }) => { | ||
| const launcher = page.getByRole('button', { name: 'Report a Bug', exact: true }); | ||
| await launcher.focus(); | ||
| await page.keyboard.press('Enter'); | ||
| await page.locator('dialog').click({ position: { x: 1, y: 1 } }); | ||
| await expect(page.locator('dialog')).not.toBeVisible(); | ||
| await expect(launcher).toBeFocused(); | ||
| }); | ||
|
|
||
| sentryTest( | ||
| 'programmatic close and removal release modal state and preserve body overflow @firefox', | ||
| async ({ page }) => { | ||
| const launcher = page.locator('#background'); | ||
| await launcher.focus(); | ||
| const form = await page.evaluateHandle(async () => { | ||
| const { Sentry } = window as unknown as { Sentry: typeof SentrySDK }; | ||
| document.body.style.overflow = 'scroll'; | ||
| const form = await Sentry.getFeedback()!.createForm(); | ||
| form.appendToDom(); | ||
| return form; | ||
| }); | ||
|
|
||
| for (const remove of [false, true]) { | ||
| await form.evaluate(form => { | ||
| form.open(); | ||
| form.open(); | ||
| }); | ||
| await expect(page.getByRole('textbox', { name: 'Description' })).toBeFocused(); | ||
| await form.evaluate((form, remove) => (remove ? form.removeFromDom() : form.close()), remove); | ||
| await expect(page.locator('dialog:modal')).toHaveCount(0); | ||
| await expect(launcher).toBeFocused(); | ||
| expect(await page.evaluate(() => document.body.style.overflow)).toBe('scroll'); | ||
| } | ||
| await form.evaluate(form => { | ||
| form.appendToDom(); | ||
| form.open(); | ||
| }); | ||
| await expect(page.getByRole('textbox', { name: 'Description' })).toBeFocused(); | ||
| }, | ||
| ); | ||
|
|
||
| sentryTest('restores the launcher after successful submission @firefox', async ({ page }) => { | ||
| const launcher = page.getByRole('button', { name: 'Report a Bug', exact: true }); | ||
| await launcher.focus(); | ||
| await page.keyboard.press('Enter'); | ||
| await page.getByRole('textbox', { name: 'Description' }).fill('Feedback sent to the local test transport'); | ||
| await page.getByRole('button', { name: 'Send Bug Report' }).click(); | ||
| await expect(page.locator('dialog:modal')).toHaveCount(0); | ||
| await expect(page.locator('.success__content')).toBeVisible(); | ||
| await page.locator('.success__content').click(); | ||
| await expect(launcher).toBeFocused(); | ||
| await page.keyboard.press('Enter'); | ||
| await expect(page.getByRole('textbox', { name: 'Description' })).toBeFocused(); | ||
| }); | ||
|
|
||
| sentryTest('preserves input border overrides @firefox', async ({ page }) => { | ||
| await page.locator('#sentry-feedback').evaluate(el => { | ||
| (el as HTMLElement).style.setProperty('--input-border', '2px solid rgb(0, 0, 255)'); | ||
| }); | ||
| await page.getByRole('button', { name: 'Report a Bug', exact: true }).click(); | ||
| await expect(page.locator('[name="name"]')).toHaveCSS('border-top-color', 'rgb(0, 0, 255)'); | ||
| await expect(page.locator('[name="name"]')).toHaveCSS('border-top-width', '2px'); | ||
| }); | ||
|
|
||
| sentryTest('keeps the form usable without native dialog methods @firefox', async ({ page }) => { | ||
| await page.evaluate(() => { | ||
| Object.defineProperty(HTMLDialogElement.prototype, 'showModal', { value: undefined }); | ||
| Object.defineProperty(HTMLDialogElement.prototype, 'close', { value: undefined }); | ||
| }); | ||
| const launcher = page.getByRole('button', { name: 'Report a Bug', exact: true }); | ||
| for (const key of ['Escape', 'Enter']) { | ||
| await launcher.focus(); | ||
| await page.keyboard.press('Enter'); | ||
| await expect(page.getByRole('dialog', { name: 'Report a Bug' })).toBeVisible(); | ||
| await expect(page.getByRole('textbox', { name: 'Description' })).toBeFocused(); | ||
| await page.getByRole('button', { name: 'Cancel', exact: true }).focus(); | ||
| await page.keyboard.press('Tab'); | ||
| await expect(page.getByRole('link', { name: 'Powered by Sentry' })).toBeFocused(); | ||
| await page.keyboard.press('Shift+Tab'); | ||
| await page.keyboard.press(key); | ||
| await expect(page.locator('dialog')).not.toBeVisible(); | ||
| await expect(launcher).toBeFocused(); | ||
| } | ||
| }); | ||
|
|
||
| for (const scheme of ['light', 'dark'] as const) { | ||
| sentryTest(`enabled input boundaries have 3:1 contrast in ${scheme} mode @firefox`, async ({ page }) => { | ||
| await page.evaluate(scheme => { | ||
| const { Sentry } = window as unknown as { Sentry: typeof SentrySDK }; | ||
| Sentry.getFeedback()!.setTheme(scheme); | ||
| }, scheme); | ||
| await page.getByRole('button', { name: 'Report a Bug', exact: true }).click(); | ||
| await page.getByRole('button', { name: 'Cancel', exact: true }).focus(); | ||
|
|
||
| for (const name of ['name', 'email', 'message']) { | ||
| const contrast = await page.locator(`[name="${name}"]`).evaluate(el => { | ||
| const rgb = (color: string): number[] => color.match(/[\d.]+/g)!.map(Number); | ||
| const background = rgb(getComputedStyle(el.closest('.dialog__content')!).backgroundColor); | ||
| const border = rgb(getComputedStyle(el).borderTopColor); | ||
| const alpha = border[3] ?? 1; | ||
| const composited = border.slice(0, 3).map((channel, i) => channel * alpha + background[i] * (1 - alpha)); | ||
| const luminance = (channels: number[]): number => | ||
| channels.slice(0, 3).reduce((sum, channel, i) => { | ||
| const value = channel / 255; | ||
| return ( | ||
| sum + (value <= 0.04045 ? value / 12.92 : ((value + 0.055) / 1.055) ** 2.4) * [0.2126, 0.7152, 0.0722][i] | ||
| ); | ||
| }, 0); | ||
| const a = luminance(composited); | ||
| const b = luminance(background); | ||
| return (Math.max(a, b) + 0.05) / (Math.min(a, b) + 0.05); | ||
| }); | ||
| expect(contrast).toBeGreaterThanOrEqual(3); | ||
| } | ||
| }); | ||
| } |
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
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.
showModal throw bricks the widget
High Severity
showModal()is called without a try/catch, whileisOpenis already set totrue.showModal()throwsInvalidStateErrorwhen the dialog is disconnected or the document is sandboxed withoutallow-modals. That exception escapes the layout effect, and lateropen()calls no-op becauseisOpenstays true, so the widget never opens again. The missing-showModalfallback never runs in these cases.Additional Locations (1)
packages/feedback/src/modal/integration.tsx#L62-L76Triggered by project rule: PR Review Guidelines for Cursor Bot
Reviewed by Cursor Bugbot for commit 67b5d1d. Configure here.