Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
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' })],
});
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>
Original file line number Diff line number Diff line change
@@ -0,0 +1,242 @@
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 }));
});

const keyboardDismissals = [
{ description: 'Escape in a field', role: 'textbox', name: 'Name', key: 'Escape' },
{ description: 'Enter on Cancel', role: 'button', name: 'Cancel', key: 'Enter' },
] as const;

for (const { description, role, name, key } of keyboardDismissals) {
sentryTest(`names the native modal and restores focus after ${description} @firefox`, async ({ page }) => {
const launcher = page.getByRole('button', { name: 'Report a Bug', exact: true });
const dialog = page.locator('dialog');
const messageInput = page.getByRole('textbox', { name: 'Description' });

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(messageInput).toBeFocused();

await page.locator('#background').evaluate(el => (el as HTMLElement).focus());
await expect(messageInput).toBeFocused();

await page.getByRole(role, { name, exact: true }).focus();
await page.keyboard.press(key);
await expect(dialog).not.toBeVisible();
await expect(launcher).toBeFocused();

await page.keyboard.press('Enter');
await expect(messageInput).toBeFocused();
});
}

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.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();
});

for (const method of ['close', 'removeFromDom'] as const) {
sentryTest(`${method}() releases modal state and preserves 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;
});

await form.evaluate(form => {
form.open();
form.open();
});
await expect(page.getByRole('textbox', { name: 'Description' })).toBeFocused();
await form.evaluate((form, method) => form[method](), method);
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');
});

for (const key of ['Escape', 'Enter'] as const) {
sentryTest(`keeps the form usable without native dialog methods, closing with ${key} @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 });
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(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);
}
});
}

sentryTest('names each dialog after its own title @firefox', async ({ page }) => {
await page.evaluate(async () => {
const { Sentry } = window as unknown as { Sentry: typeof SentrySDK };
const first = await Sentry.getFeedback()!.createForm({ formTitle: 'First form' });
first.appendToDom();
first.open();
first.close();
const second = await Sentry.getFeedback()!.createForm({ formTitle: 'Second form' });
second.appendToDom();
second.open();
});
await expect(page.getByRole('dialog', { name: 'Second form' })).toBeVisible();
});

sentryTest('falls back to a non-modal dialog when showModal throws @firefox', async ({ page }) => {
await page.evaluate(() => {
HTMLDialogElement.prototype.showModal = () => {
throw new DOMException('The document is sandboxed', 'InvalidStateError');
};
});
const launcher = page.getByRole('button', { name: 'Report a Bug', exact: true });
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.keyboard.press('Escape');
await expect(page.locator('dialog')).not.toBeVisible();
await expect(launcher).toBeFocused();

await page.keyboard.press('Enter');
await expect(page.getByRole('dialog', { name: 'Report a Bug' })).toBeVisible();
});

sentryTest('does not take focus back when the success message times out @firefox', async ({ page }) => {
await page.getByRole('button', { name: 'Report a Bug', exact: true }).click();
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('.success__content')).toBeVisible();
const background = page.locator('#background');
await background.focus();
await expect(page.locator('.success__content')).not.toBeVisible({ timeout: 10_000 });
await expect(page.getByRole('button', { name: 'Report a Bug', exact: true })).toBeVisible();
await expect(background).toBeFocused();
});

sentryTest('calls onFormClose once when Escape closes the modal @firefox', async ({ page }) => {
await page.evaluate(async () => {
const { Sentry } = window as unknown as { Sentry: typeof SentrySDK };
const win = window as unknown as { closeCount: number };
win.closeCount = 0;
const form = await Sentry.getFeedback()!.createForm({
onFormClose: () => {
win.closeCount++;
},
});
form.appendToDom();
form.open();
});
await expect(page.getByRole('textbox', { name: 'Description' })).toBeFocused();
await page.keyboard.press('Escape');
await expect(page.locator('dialog:modal')).toHaveCount(0);
expect(await page.evaluate(() => (window as unknown as { closeCount: number }).closeCount)).toBe(1);
});
4 changes: 4 additions & 0 deletions packages/feedback/src/core/createMainStyles.ts
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ const PURPLE = 'rgba(88, 74, 192, 1)';

interface InternalTheme extends NonNullable<FeedbackInternalOptions['themeLight']> {
border: string;
inputBorder: string;
interactiveFilter: string;
}

Expand All @@ -16,6 +17,7 @@ const DEFAULT_LIGHT: InternalTheme = {
successColor: '#268d75',
errorColor: '#df3338',
border: '1.5px solid rgba(41, 35, 47, 0.13)',
inputBorder: '1.5px solid rgba(41, 35, 47, 0.6)',
boxShadow: '0px 4px 24px 0px rgba(43, 34, 51, 0.12)',
outline: '1px auto var(--accent-background)',
interactiveFilter: 'brightness(95%)',
Expand All @@ -28,6 +30,7 @@ const DEFAULT_DARK: InternalTheme = {
successColor: '#2da98c',
errorColor: '#f55459',
border: '1.5px solid rgba(235, 230, 239, 0.15)',
inputBorder: '1.5px solid rgba(235, 230, 239, 0.6)',
boxShadow: '0px 4px 24px 0px rgba(43, 34, 51, 0.12)',
outline: '1px auto var(--accent-background)',
interactiveFilter: 'brightness(150%)',
Expand All @@ -42,6 +45,7 @@ function getThemedCssVariables(theme: InternalTheme): string {
--success-color: ${theme.successColor};
--error-color: ${theme.errorColor};
--border: ${theme.border};
--input-border: ${theme.inputBorder};
--box-shadow: ${theme.boxShadow};
--outline: ${theme.outline};
--interactive-filter: ${theme.interactiveFilter};
Expand Down
6 changes: 6 additions & 0 deletions packages/feedback/src/modal/components/Dialog.css.ts
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,8 @@ const DIALOG = `
padding: 0;
height: 100vh;
width: 100vw;
max-height: none;
max-width: none;

color: var(--dialog-color, var(--foreground));
fill: var(--dialog-color, var(--foreground));
Expand All @@ -25,6 +27,10 @@ const DIALOG = `
transition: opacity 0.2s ease-in-out;
}

.dialog::backdrop {
background: transparent;
}

.dialog__position {
position: fixed;
z-index: var(--z-index);
Expand Down
49 changes: 47 additions & 2 deletions packages/feedback/src/modal/components/Dialog.tsx
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
import type { FeedbackFormData, FeedbackInternalOptions } from '@sentry/core';
import type { VNode } from 'preact';
import { Fragment, h } from 'preact'; // eslint-disable-line @typescript-eslint/no-unused-vars
import { useCallback, useMemo, useState } from 'preact/hooks';
import { useCallback, useLayoutEffect, useMemo, useRef, useState } from 'preact/hooks';
import { SUCCESS_MESSAGE_TIMEOUT } from '../../constants';
import type { Props as HeaderProps } from './DialogHeader';
import { DialogHeader } from './DialogHeader';
Expand All @@ -20,6 +20,36 @@ export function Dialog({ open, onFormSubmitted, ...props }: Props): VNode {
const successIconHtml = useMemo(() => ({ __html: SuccessIcon().outerHTML }), []);

const [timeoutId, setTimeoutId] = useState<NodeJS.Timeout | null>(null);
const dialogRef = useRef<HTMLDialogElement>(null);

useLayoutEffect(() => {
const dialog = dialogRef.current;
if (open && dialog && !dialog.open) {
try {
dialog.showModal();
} catch {
// `showModal` is missing in older browsers and throws in iframes sandboxed without `allow-modals`.
dialog.setAttribute('open', '');
}
// WebKit does not always move focus to the `autofocus` control of a modal inside a shadow root.
dialog.querySelector<HTMLElement>('[autofocus]')?.focus();
}
return () => {
if (typeof dialog?.close === 'function') {
dialog.close();
} else {
dialog?.removeAttribute('open');
}
};
}, [open, timeoutId]);
Comment thread
sentry-junior[bot] marked this conversation as resolved.
Resolved

useLayoutEffect(() => {
return () => {
if (timeoutId) {
clearTimeout(timeoutId);
}
};
}, [timeoutId]);

const handleOnSuccessClick = useCallback(() => {
if (timeoutId) {
Expand Down Expand Up @@ -52,7 +82,22 @@ export function Dialog({ open, onFormSubmitted, ...props }: Props): VNode {
</div>
</div>
) : (
<dialog class="dialog" onClick={options.onFormClose} open={open}>
<dialog
class="dialog"
ref={dialogRef}
aria-label={options.formTitle}
onClick={options.onFormClose}
onCancel={event => {
event.preventDefault();
options.onFormClose?.();
}}
onKeyDown={event => {
if (event.key === 'Escape') {
event.preventDefault();
options.onFormClose?.();
}
}}
Comment thread
sentry-junior[bot] marked this conversation as resolved.
Resolved
>
<div class="dialog__position">
<div
class="dialog__content"
Expand Down
Loading
Loading