feat: in-app bug report and feature request modal

- Add BugReportModal component with type selector (bug/feature)
- Debounced GitHub Search API integration for similar open issues
- Auto-populate platform info (Sable version, user agent) for bugs
- /report slash command opens the modal
- 'Report an Issue' button in Settings > About
- Uses existing Jotai atom + hooks pattern (bugReportOpenAtom)
- No authentication required; submits to GitHub pre-fill URL
This commit is contained in:
Evie Gauthier committed 2026-03-09 19:28:05 -04:00
1 parent f529e9ed4c
commit 4ce1bd4ffa
8 files changed
+375 -1

No files matched your search

+7
View File
@@ -0,0 +1,7 @@
---
sable: minor
---
feat: in-app bug report and feature request modal
Adds a `/report` slash command and a "Report an Issue" button on the About settings page. Both open a modal with a type selector (Bug Report / Feature Request), a title field with debounced GitHub issue search for duplicate detection, description and type-specific fields, and auto-populated platform/version info. Submitting opens the pre-filled GitHub new issue page in a new tab — no authentication required.
@@ -0,0 +1,315 @@
import { useState, useEffect } from 'react';
import FocusTrap from 'focus-trap-react';
import {
Box,
Button,
Chip,
config,
Header,
Icon,
IconButton,
Icons,
Input,
Modal,
Overlay,
OverlayBackdrop,
OverlayCenter,
Scroll,
Spinner,
Text,
TextArea,
} from 'folds';
import { useCloseBugReportModal, useBugReportModalOpen } from '$state/hooks/bugReportModal';
import { stopPropagation } from '$utils/keyboard';
type ReportType = 'bug' | 'feature';
type SimilarIssue = {
number: number;
title: string;
html_url: string;
};
const GITHUB_REPO = '7w1/sable';
async function searchSimilarIssues(query: string, signal: AbortSignal): Promise<SimilarIssue[]> {
const params = new URLSearchParams({
q: `${query} repo:${GITHUB_REPO} is:issue is:open`,
per_page: '5',
});
const res = await fetch(`https://api.github.com/search/issues?${params}`, { signal });
if (!res.ok) return [];
const data = (await res.json()) as { items?: SimilarIssue[] };
return data.items ?? [];
}
function buildGitHubUrl(
type: ReportType,
title: string,
description: string,
steps: string,
solution: string
): string {
const devLabel = IS_RELEASE_TAG ? '' : '-dev';
const buildLabel = BUILD_HASH ? ` (${BUILD_HASH})` : '';
const version = `v${APP_VERSION}${devLabel}${buildLabel}`;
let body: string;
if (type === 'bug') {
const sections: string[] = [
`**Describe the bug**\n\n${description}`,
steps ? `**Reproduction**\n\n${steps}` : '',
`**Platform and versions**\n\n- Sable: ${version}\n- Browser: ${navigator.userAgent}`,
];
body = sections.filter(Boolean).join('\n\n---\n\n');
} else {
const sections: string[] = [
`**Describe the problem**\n\n${description}`,
solution ? `**Describe the solution you'd like**\n\n${solution}` : '',
];
body = sections.filter(Boolean).join('\n\n---\n\n');
}
const params = new URLSearchParams({ title, body });
if (type === 'bug') params.set('labels', 'bug');
if (type === 'feature') params.set('labels', 'enhancement');
return `https://github.com/${GITHUB_REPO}/issues/new?${params}`;
}
function BugReportModal() {
const close = useCloseBugReportModal();
const [type, setType] = useState<ReportType>('bug');
const [title, setTitle] = useState('');
const [description, setDescription] = useState('');
const [steps, setSteps] = useState('');
const [solution, setSolution] = useState('');
const [similarIssues, setSimilarIssues] = useState<SimilarIssue[]>([]);
const [searching, setSearching] = useState(false);
useEffect(() => {
const trimmed = title.trim();
const controller = new AbortController();
let cancelled = false;
let timer: ReturnType<typeof setTimeout> | undefined;
if (trimmed.length >= 3) {
timer = setTimeout(async () => {
setSearching(true);
try {
const issues = await searchSimilarIssues(trimmed, controller.signal);
if (!cancelled) setSimilarIssues(issues);
} catch {
// silently ignore network errors / rate limits
} finally {
if (!cancelled) setSearching(false);
}
}, 600);
} else {
setSimilarIssues([]);
setSearching(false);
}
return () => {
cancelled = true;
if (timer !== undefined) clearTimeout(timer);
controller.abort();
};
}, [title]);
const canSubmit = title.trim().length > 0;
const handleSubmit = () => {
if (!canSubmit) return;
const url = buildGitHubUrl(
type,
title.trim(),
description.trim(),
steps.trim(),
solution.trim()
);
window.open(url, '_blank', 'noopener,noreferrer');
close();
};
return (
<Overlay open backdrop={<OverlayBackdrop />}>
<OverlayCenter>
<FocusTrap
focusTrapOptions={{
initialFocus: false,
clickOutsideDeactivates: true,
onDeactivate: close,
escapeDeactivates: stopPropagation,
}}
>
<Modal size="500" flexHeight variant="Surface">
<Box direction="Column">
<Header
size="500"
style={{ padding: config.space.S200, paddingLeft: config.space.S400 }}
>
<Box grow="Yes">
<Text size="H4">Report an Issue</Text>
</Box>
<IconButton size="300" radii="300" onClick={close}>
<Icon src={Icons.Cross} />
</IconButton>
</Header>
<Scroll size="300" hideTrack>
<Box
style={{ padding: config.space.S400, paddingRight: config.space.S200 }}
direction="Column"
gap="500"
>
{/* Type */}
<Box direction="Column" gap="100">
<Text size="L400">Type</Text>
<Box gap="200">
<Chip
radii="Pill"
variant={type === 'bug' ? 'Primary' : 'SurfaceVariant'}
aria-pressed={type === 'bug'}
onClick={() => setType('bug')}
>
<Text size="T300">Bug Report</Text>
</Chip>
<Chip
radii="Pill"
variant={type === 'feature' ? 'Primary' : 'SurfaceVariant'}
aria-pressed={type === 'feature'}
onClick={() => setType('feature')}
>
<Text size="T300">Feature Request</Text>
</Chip>
</Box>
</Box>
{/* Title + duplicate check */}
<Box direction="Column" gap="100">
<Text size="L400">Title *</Text>
<Input
size="500"
variant="SurfaceVariant"
radii="400"
autoFocus
placeholder="Brief description"
value={title}
onChange={(e) => setTitle((e.target as HTMLInputElement).value)}
/>
{searching && (
<Box gap="200" alignItems="Center">
<Spinner size="100" variant="Secondary" />
<Text size="T200">Searching for similar issues…</Text>
</Box>
)}
{!searching && similarIssues.length > 0 && (
<Box direction="Column" gap="100">
<Text size="T200">
Similar open issues — please check before submitting:
</Text>
{similarIssues.map((issue) => (
<Text key={issue.number} size="T200">
{'→ '}
<a href={issue.html_url} target="_blank" rel="noopener noreferrer">
#{issue.number}: {issue.title}
</a>
</Text>
))}
</Box>
)}
</Box>
{/* Description */}
<Box direction="Column" gap="100">
<Text size="L400">
{type === 'bug' ? 'Describe the bug *' : 'Describe the problem *'}
</Text>
<TextArea
size="500"
variant="SurfaceVariant"
radii="400"
rows={4}
placeholder={
type === 'bug'
? 'A clear description of what the bug is.'
: 'A clear description of the problem this feature would solve.'
}
value={description}
onChange={(e) => setDescription((e.target as HTMLTextAreaElement).value)}
/>
</Box>
{/* Bug: steps to reproduce */}
{type === 'bug' && (
<Box direction="Column" gap="100">
<Text size="L400">Steps to reproduce (optional)</Text>
<TextArea
size="500"
variant="SurfaceVariant"
radii="400"
rows={3}
placeholder={'1. Go to…\n2. Click on…\n3. See error'}
value={steps}
onChange={(e) => setSteps((e.target as HTMLTextAreaElement).value)}
/>
</Box>
)}
{/* Feature: solution */}
{type === 'feature' && (
<Box direction="Column" gap="100">
<Text size="L400">Describe the solution you&apos;d like *</Text>
<TextArea
size="500"
variant="SurfaceVariant"
radii="400"
rows={3}
placeholder="I would like to…"
value={solution}
onChange={(e) => setSolution((e.target as HTMLTextAreaElement).value)}
/>
</Box>
)}
{/* Platform info for bugs */}
{type === 'bug' && (
<Box direction="Column" gap="100">
<Text size="L400">Platform info (auto-included)</Text>
<Text size="T200" style={{ opacity: 0.7, wordBreak: 'break-all' }}>
{`Sable v${APP_VERSION}${IS_RELEASE_TAG ? '' : '-dev'} • ${navigator.userAgent}`}
</Text>
</Box>
)}
{/* Actions */}
<Box gap="300" justifyContent="End">
<Button size="400" variant="Secondary" fill="None" radii="400" onClick={close}>
<Text size="B400">Cancel</Text>
</Button>
<Button
size="400"
variant="Primary"
radii="400"
disabled={!canSubmit}
onClick={handleSubmit}
after={<Icon src={Icons.ArrowRight} size="100" />}
>
<Text size="B400">Open on GitHub</Text>
</Button>
</Box>
</Box>
</Scroll>
</Box>
</Modal>
</FocusTrap>
</OverlayCenter>
</Overlay>
);
}
export function BugReportModalRenderer() {
const open = useBugReportModalOpen();
if (!open) return null;
return <BugReportModal />;
}
+1
View File
@@ -0,0 +1 @@
export { BugReportModalRenderer } from './BugReportModal';
+18
View File
@@ -8,6 +8,7 @@ import { useMatrixClient } from '$hooks/useMatrixClient';
import { SequenceCardStyle } from '$features/settings/styles.css';
import { Method } from '$types/matrix-sdk';
import { useState } from 'react';
import { useOpenBugReportModal } from '$state/hooks/bugReportModal';
export function HomeserverInfo() {
const mx = useMatrixClient();
@@ -149,6 +150,7 @@ export function About({ requestClose }: AboutProps) {
const mx = useMatrixClient();
const devLabel = IS_RELEASE_TAG ? '' : '-dev';
const buildLabel = BUILD_HASH ? ` (${BUILD_HASH})` : '';
const openBugReport = useOpenBugReportModal();
return (
<Page>
@@ -241,6 +243,22 @@ export function About({ requestClose }: AboutProps) {
</Button>
}
/>
<SettingTile
title="Report an Issue"
description="Report a bug or request a feature on GitHub."
after={
<Button
onClick={openBugReport}
variant="Secondary"
fill="Soft"
size="300"
radii="300"
outlined
>
<Text size="B300">Report</Text>
</Button>
}
/>
</SequenceCard>
</Box>
<HomeserverInfo />
+14 -1
View File
@@ -29,6 +29,7 @@ import { getStateEvent } from '$utils/room';
import { splitWithSpace } from '$utils/common';
import { useSetting } from '$state/hooks/settings';
import { settingsAtom } from '$state/settings';
import { useOpenBugReportModal } from '$state/hooks/bugReportModal';
import { createRoomEncryptionState } from '$components/create-room';
import { parsePronounsInput } from '$utils/pronouns';
import { useRoomNavigate } from './useRoomNavigate';
@@ -248,6 +249,8 @@ export enum Command {
Wave = 'wave',
Poke = 'poke',
Headpat = 'headpat',
// Meta
Report = 'bugreport',
}
export type CommandContent = {
@@ -262,6 +265,7 @@ export const useCommands = (mx: MatrixClient, room: Room): CommandRecord => {
const { navigateRoom } = useRoomNavigate();
const [developerTools] = useSetting(settingsAtom, 'developerTools');
const profile = useUserProfile(mx.getSafeUserId());
const openBugReport = useOpenBugReportModal();
const commands: CommandRecord = useMemo(
() => ({
@@ -1302,6 +1306,7 @@ export const useCommands = (mx: MatrixClient, room: Room): CommandRecord => {
}
},
},
<<<<<<< HEAD
// Cute Events
[Command.Hug]: {
name: Command.Hug,
@@ -1379,8 +1384,16 @@ export const useCommands = (mx: MatrixClient, room: Room): CommandRecord => {
} as any);
},
},
// Meta commands
[Command.Report]: {
name: Command.Report,
description: 'Report a bug or request a feature',
exe: async () => {
openBugReport();
},
},
}),
[mx, navigateRoom, room, profile.displayName, profile.avatarUrl, developerTools]
[mx, navigateRoom, room, profile.displayName, profile.avatarUrl, developerTools, openBugReport]
);
return commands;
+2
View File
@@ -19,6 +19,7 @@ import { SpaceSettingsRenderer } from '$features/space-settings';
import { UserRoomProfileRenderer } from '$components/UserRoomProfileRenderer';
import { CreateRoomModalRenderer } from '$features/create-room';
import { CreateSpaceModalRenderer } from '$features/create-space';
import { BugReportModalRenderer } from '$features/bug-report';
import { getFallbackSession, MATRIX_SESSIONS_KEY, Sessions } from '$state/sessions';
import { getLocalStorageItem } from '$state/utils/atomWithLocalStorage';
import { NotificationJumper } from '$hooks/useNotificationJumper';
@@ -168,6 +169,7 @@ export const createRouter = (clientConfig: ClientConfig, screenSize: ScreenSize)
<UserRoomProfileRenderer />
<CreateRoomModalRenderer />
<CreateSpaceModalRenderer />
<BugReportModalRenderer />
<RoomSettingsRenderer />
<SpaceSettingsRenderer />
<GlobalKeyboardShortcuts />
+3
View File
@@ -0,0 +1,3 @@
import { atom } from 'jotai';
export const bugReportOpenAtom = atom(false);
+15
View File
@@ -0,0 +1,15 @@
import { useCallback } from 'react';
import { useAtomValue, useSetAtom } from 'jotai';
import { bugReportOpenAtom } from '$state/bugReportModal';
export const useBugReportModalOpen = (): boolean => useAtomValue(bugReportOpenAtom);
export const useOpenBugReportModal = (): (() => void) => {
const setOpen = useSetAtom(bugReportOpenAtom);
return useCallback(() => setOpen(true), [setOpen]);
};
export const useCloseBugReportModal = (): (() => void) => {
const setOpen = useSetAtom(bugReportOpenAtom);
return useCallback(() => setOpen(false), [setOpen]);
};