feat(web): add sidebar feedback popover

Co-authored-by: dadachann <185672915+dadachann@users.noreply.github.com>
This commit is contained in:
Hyu
2026-06-24 16:43:50 +08:00
committed by GitHub
parent 59b2a7cd51
commit 76471af179
8 changed files with 456 additions and 17 deletions
@@ -30,6 +30,50 @@ class SurveyRouterGroup(group.RouterGroup):
return self.fail(2, 'Failed to submit response')
return self.fail(3, 'Survey not available')
@self.route('/feedback', methods=['POST'], auth_type=group.AuthType.USER_TOKEN)
async def _feedback(user_email: str) -> str:
"""Submit on-demand user feedback from the sidebar."""
json_data = await quart.request.get_json(silent=True) or {}
content = str(json_data.get('content', '')).strip()
attachments = json_data.get('attachments', [])
page_url = str(json_data.get('page_url', ''))[:2048]
user_agent = str(json_data.get('user_agent', ''))[:512]
if not content:
return self.fail(1, 'content required')
if len(content) > 5000:
return self.fail(2, 'content too long')
if not isinstance(attachments, list):
return self.fail(3, 'attachments must be an array')
if len(attachments) > 3:
return self.fail(4, 'too many attachments')
normalized_attachments = []
for item in attachments:
if not isinstance(item, dict):
continue
data_url = str(item.get('data_url', ''))
mime_type = str(item.get('mime_type', ''))[:128]
name = str(item.get('name', ''))[:255]
if not data_url.startswith('data:image/'):
continue
if len(data_url) > 2_800_000:
return self.fail(5, 'attachment too large')
normalized_attachments.append({'name': name, 'mime_type': mime_type, 'data_url': data_url})
if self.ap.survey:
ok = await self.ap.survey.submit_feedback(
content=content,
attachments=normalized_attachments,
page_url=page_url,
user_agent=user_agent,
user_email=user_email,
)
if ok:
return self.success()
return self.fail(6, 'Failed to submit feedback')
return self.fail(7, 'Survey not available')
@self.route('/dismiss', methods=['POST'], auth_type=group.AuthType.USER_TOKEN)
async def _dismiss() -> str:
"""Dismiss survey."""
+51 -3
View File
@@ -159,6 +159,21 @@ class SurveyManager:
"""Clear the pending survey (after user responds or dismisses)."""
self._pending_survey = None
async def _build_base_metadata(self, user_email: str | None = None) -> dict:
metadata = {
'version': constants.semantic_version,
'instance_id': constants.instance_id,
}
if user_email:
metadata['login_account'] = user_email
try:
user_obj = await self.ap.user_service.get_user_by_email(user_email)
metadata['account_type'] = getattr(user_obj, 'account_type', '') or 'local'
metadata['space_account_uuid'] = getattr(user_obj, 'space_account_uuid', '') or ''
except Exception:
pass
return metadata
async def submit_response(self, survey_id: str, answers: dict, completed: bool = True) -> bool:
"""Submit a survey response to Space."""
if not self._is_space_configured():
@@ -169,9 +184,7 @@ class SurveyManager:
'survey_id': survey_id,
'instance_id': constants.instance_id,
'answers': answers,
'metadata': {
'version': constants.semantic_version,
},
'metadata': await self._build_base_metadata(),
'completed': completed,
}
async with httpx.AsyncClient(timeout=httpx.Timeout(10)) as client:
@@ -183,6 +196,41 @@ class SurveyManager:
self.ap.logger.warning(f'Failed to submit survey response: {e}')
return False
async def submit_feedback(
self,
content: str,
attachments: list[dict],
page_url: str,
user_agent: str,
user_email: str | None = None,
) -> bool:
"""Submit an on-demand user feedback item to Space."""
if not self._is_space_configured():
return False
try:
url = f'{self._space_url}/api/v1/survey/feedback'
metadata = await self._build_base_metadata(user_email)
metadata.update(
{
'page_url': page_url,
'user_agent': user_agent,
}
)
payload = {
'instance_id': constants.instance_id,
'content': content,
'attachments': attachments,
'metadata': metadata,
}
async with httpx.AsyncClient(timeout=httpx.Timeout(30)) as client:
resp = await client.post(url, json=payload)
if resp.status_code == 200:
return True
self.ap.logger.warning(f'Failed to submit feedback: {resp.status_code} {resp.text[:200]}')
except Exception as e:
self.ap.logger.warning(f'Failed to submit feedback: {e}')
return False
async def dismiss_survey(self, survey_id: str) -> bool:
"""Dismiss a survey."""
if not self._is_space_configured():
@@ -0,0 +1,278 @@
import { useCallback, useEffect, useRef, useState } from 'react';
import { Camera, ImagePlus, Loader2, Paperclip, Send, X } from 'lucide-react';
import { useTranslation } from 'react-i18next';
import { toast } from 'sonner';
import { Button } from '@/components/ui/button';
import { Textarea } from '@/components/ui/textarea';
import { httpClient } from '@/app/infra/http/HttpClient';
const MAX_ATTACHMENTS = 3;
const MAX_IMAGE_BYTES = 2 * 1024 * 1024;
type FeedbackAttachment = {
name: string;
mime_type: string;
data_url: string;
};
function bytesFromDataUrl(dataUrl: string): number {
const payload = dataUrl.split(',')[1] || '';
return Math.ceil((payload.length * 3) / 4);
}
function readImageFile(file: File): Promise<FeedbackAttachment> {
return new Promise((resolve, reject) => {
if (!file.type.startsWith('image/')) {
reject(new Error('not_image'));
return;
}
if (file.size > MAX_IMAGE_BYTES) {
reject(new Error('too_large'));
return;
}
const reader = new FileReader();
reader.onload = () => {
const dataUrl = String(reader.result || '');
if (!dataUrl.startsWith('data:image/')) {
reject(new Error('not_image'));
return;
}
resolve({
name: file.name || 'pasted-image.png',
mime_type: file.type || 'image/png',
data_url: dataUrl,
});
};
reader.onerror = () => reject(reader.error || new Error('read_failed'));
reader.readAsDataURL(file);
});
}
async function captureScreen(): Promise<FeedbackAttachment> {
if (!navigator.mediaDevices?.getDisplayMedia) {
throw new Error('unsupported');
}
const stream = await navigator.mediaDevices.getDisplayMedia({
video: true,
audio: false,
});
try {
const video = document.createElement('video');
video.srcObject = stream;
await video.play();
await new Promise((resolve) => requestAnimationFrame(resolve));
const canvas = document.createElement('canvas');
canvas.width = video.videoWidth;
canvas.height = video.videoHeight;
const ctx = canvas.getContext('2d');
if (!ctx) throw new Error('canvas_unavailable');
ctx.drawImage(video, 0, 0, canvas.width, canvas.height);
const dataUrl = canvas.toDataURL('image/png');
if (bytesFromDataUrl(dataUrl) > MAX_IMAGE_BYTES) {
throw new Error('too_large');
}
return {
name: `screenshot-${Date.now()}.png`,
mime_type: 'image/png',
data_url: dataUrl,
};
} finally {
stream.getTracks().forEach((track) => track.stop());
}
}
export function FeedbackPopoverContent({
onSubmitted,
}: {
onSubmitted?: () => void;
}) {
const { t } = useTranslation();
const [content, setContent] = useState('');
const [attachments, setAttachments] = useState<FeedbackAttachment[]>([]);
const [submitting, setSubmitting] = useState(false);
const [capturing, setCapturing] = useState(false);
const fileInputRef = useRef<HTMLInputElement>(null);
const addFiles = useCallback(
async (files: File[]) => {
const slots = MAX_ATTACHMENTS - attachments.length;
if (slots <= 0) {
toast.error(t('feedback.tooManyImages'));
return;
}
const picked = files.slice(0, slots);
const next: FeedbackAttachment[] = [];
for (const file of picked) {
try {
next.push(await readImageFile(file));
} catch (error) {
const msg = error instanceof Error ? error.message : '';
toast.error(
msg === 'too_large'
? t('feedback.imageTooLarge')
: t('feedback.imageOnly'),
);
}
}
if (next.length > 0) {
setAttachments((prev) => [...prev, ...next].slice(0, MAX_ATTACHMENTS));
}
},
[attachments.length, t],
);
useEffect(() => {
const onPaste = (event: ClipboardEvent) => {
const files = Array.from(event.clipboardData?.files || []).filter(
(file) => file.type.startsWith('image/'),
);
if (files.length > 0) {
event.preventDefault();
void addFiles(files);
}
};
window.addEventListener('paste', onPaste);
return () => window.removeEventListener('paste', onPaste);
}, [addFiles]);
const handleCapture = async () => {
try {
if (attachments.length >= MAX_ATTACHMENTS) {
toast.error(t('feedback.tooManyImages'));
return;
}
setCapturing(true);
const screenshot = await captureScreen();
setAttachments((prev) => [...prev, screenshot].slice(0, MAX_ATTACHMENTS));
} catch (error) {
const msg = error instanceof Error ? error.message : '';
toast.error(
msg === 'too_large'
? t('feedback.imageTooLarge')
: t('feedback.screenshotFailed'),
);
} finally {
setCapturing(false);
}
};
const handleSubmit = async () => {
const trimmed = content.trim();
if (!trimmed) {
toast.error(t('feedback.contentRequired'));
return;
}
try {
setSubmitting(true);
await httpClient.submitFeedback({
content: trimmed,
attachments,
page_url: window.location.href,
user_agent: navigator.userAgent,
});
toast.success(t('feedback.submitSuccess'));
setContent('');
setAttachments([]);
onSubmitted?.();
} catch {
toast.error(t('feedback.submitFailed'));
} finally {
setSubmitting(false);
}
};
return (
<div className="w-80 space-y-3 p-1" onClick={(e) => e.stopPropagation()}>
<div>
<div className="text-sm font-medium">{t('feedback.title')}</div>
<p className="mt-1 text-xs text-muted-foreground">
{t('feedback.description')}
</p>
</div>
<Textarea
value={content}
onChange={(e) => setContent(e.target.value)}
placeholder={t('feedback.placeholder')}
maxLength={5000}
className="min-h-28 resize-none text-sm"
/>
<div className="flex flex-wrap gap-2">
{attachments.map((item, index) => (
<div
key={`${item.name}-${index}`}
className="relative size-16 overflow-hidden rounded-md border"
>
<img
src={item.data_url}
alt={item.name}
className="h-full w-full object-cover"
/>
<button
type="button"
onClick={() =>
setAttachments((prev) => prev.filter((_, i) => i !== index))
}
className="absolute right-1 top-1 rounded-full bg-black/60 p-0.5 text-white"
aria-label={t('feedback.removeImage')}
>
<X className="size-3" />
</button>
</div>
))}
</div>
<div className="flex items-center justify-between gap-2">
<div className="flex gap-2">
<input
ref={fileInputRef}
type="file"
accept="image/*"
multiple
className="hidden"
onChange={(e) => {
void addFiles(Array.from(e.target.files || []));
e.target.value = '';
}}
/>
<Button
type="button"
size="sm"
variant="outline"
onClick={() => fileInputRef.current?.click()}
>
<ImagePlus className="mr-1 size-4" />
{t('feedback.attachImage')}
</Button>
<Button
type="button"
size="sm"
variant="outline"
onClick={handleCapture}
disabled={capturing}
>
{capturing ? (
<Loader2 className="mr-1 size-4 animate-spin" />
) : (
<Camera className="mr-1 size-4" />
)}
{t('feedback.screenshot')}
</Button>
</div>
<span className="flex items-center gap-1 text-xs text-muted-foreground">
<Paperclip className="size-3" />
{attachments.length}/{MAX_ATTACHMENTS}
</span>
</div>
<Button className="w-full" onClick={handleSubmit} disabled={submitting}>
{submitting ? (
<Loader2 className="mr-2 size-4 animate-spin" />
) : (
<Send className="mr-2 size-4" />
)}
{t('feedback.submit')}
</Button>
<p className="text-[11px] leading-relaxed text-muted-foreground">
{t('feedback.privacyHint')}
</p>
</div>
);
}
@@ -100,6 +100,7 @@ import {
} from '@/components/ui/popover';
import { cn } from '@/lib/utils';
import { useSidebarData, SidebarEntityItem } from './SidebarDataContext';
import { FeedbackPopoverContent } from './FeedbackPopover';
// Compare two version strings, returns true if v1 > v2
function compareVersions(v1: string, v2: string): boolean {
@@ -2039,17 +2040,25 @@ export default function HomeSidebar({
<CircleHelp />
{t('common.helpDocs')}
</DropdownMenuItem>
<DropdownMenuItem
onClick={() => {
window.open(
'https://github.com/langbot-app/LangBot/issues',
'_blank',
);
}}
>
<Lightbulb />
{t('common.featureRequest')}
</DropdownMenuItem>
<Popover>
<PopoverTrigger asChild>
<DropdownMenuItem
onSelect={(event) => event.preventDefault()}
>
<Lightbulb />
{t('common.featureRequest')}
</DropdownMenuItem>
</PopoverTrigger>
<PopoverContent
side={isMobile ? 'bottom' : 'right'}
align="start"
className="w-auto p-3"
>
<FeedbackPopoverContent
onSubmitted={() => setUserMenuOpen(false)}
/>
</PopoverContent>
</Popover>
<DropdownMenuItem
onClick={() => {
window.open(
+13
View File
@@ -1332,6 +1332,19 @@ export class BackendClient extends BaseHttpClient {
return this.post('/api/v1/survey/dismiss', { survey_id: surveyId });
}
public submitFeedback(data: {
content: string;
page_url?: string;
user_agent?: string;
attachments?: Array<{
name: string;
mime_type: string;
data_url: string;
}>;
}): Promise<object> {
return this.post('/api/v1/survey/feedback', data);
}
// ============ Skills API ============
public getSkills(): Promise<ApiRespSkills> {
+17 -1
View File
@@ -35,7 +35,7 @@ const enUS = {
emptyPassword: 'Please enter your password',
language: 'Language',
helpDocs: 'Get Help',
featureRequest: 'Feature Request',
featureRequest: 'Feedback',
starOnGitHub: 'Star on GitHub',
joinDiscord: 'Join our Discord',
create: 'Create',
@@ -1362,6 +1362,22 @@ const enUS = {
inaccurateReasons: 'Inaccurate Reasons',
platform: 'Platform',
exportFeedback: 'Export Feedback',
description:
'Tell us what went wrong or what could be better. Instance UUID, login account, and page info are included for diagnosis.',
placeholder: 'Describe your suggestion, issue, or reproduction steps...',
attachImage: 'Add image',
screenshot: 'Screenshot',
submit: 'Submit feedback',
privacyHint:
'Do not include secrets, passwords, or private chat content.',
contentRequired: 'Please enter feedback first',
imageOnly: 'Only image attachments are supported',
imageTooLarge: 'Each image must be under 2MB',
tooManyImages: 'You can attach up to 3 images',
screenshotFailed: 'Screenshot failed. Try pasting or uploading an image.',
submitSuccess: 'Feedback submitted. Thanks!',
submitFailed: 'Failed to submit feedback. Please try again later.',
removeImage: 'Remove image',
},
queries: {
title: 'Queries',
+17 -1
View File
@@ -36,7 +36,7 @@ const jaJP = {
emptyPassword: 'パスワードを入力してください',
language: '言語',
helpDocs: 'ヘルプドキュメント',
featureRequest: '機能リクエスト',
featureRequest: 'フィードバック',
starOnGitHub: 'GitHubでStarする',
joinDiscord: 'Discord に参加',
create: '作成',
@@ -1368,6 +1368,22 @@ const jaJP = {
inaccurateReasons: '不正確な理由',
platform: 'プラットフォーム',
exportFeedback: 'フィードバックをエクスポート',
description:
'問題点や改善案を教えてください。診断のため、インスタンス UUID、ログインアカウント、ページ情報も送信されます。',
placeholder: '提案、問題、再現手順を入力してください...',
attachImage: '画像を追加',
screenshot: 'スクリーンショット',
submit: '送信',
privacyHint: '秘密鍵、パスワード、個人的な会話内容は含めないでください。',
contentRequired: 'フィードバック内容を入力してください',
imageOnly: '画像のみ添付できます',
imageTooLarge: '画像は 1 枚 2MB 未満にしてください',
tooManyImages: '画像は最大 3 枚まで添付できます',
screenshotFailed:
'スクリーンショットに失敗しました。貼り付けまたはアップロードを試してください。',
submitSuccess: 'フィードバックを送信しました。ありがとうございます!',
submitFailed: '送信に失敗しました。後でもう一度お試しください。',
removeImage: '画像を削除',
},
messageDetails: {
noData: 'このクエリにはLLM呼び出しやエラーがありません',
+16 -1
View File
@@ -34,7 +34,7 @@ const zhHans = {
emptyPassword: '请输入密码',
language: '语言',
helpDocs: '帮助文档',
featureRequest: '需求建议',
featureRequest: '建议反馈',
starOnGitHub: '在 GitHub 上 Star',
joinDiscord: '加入 Discord 社区',
create: '创建',
@@ -1301,6 +1301,21 @@ const zhHans = {
inaccurateReasons: '不准确原因',
platform: '平台',
exportFeedback: '导出反馈',
description:
'告诉我们遇到的问题或想要的改进。提交时会附带实例 UUID、登录账号和当前页面信息,方便定位。',
placeholder: '请描述你的建议、问题或复现步骤...',
attachImage: '添加图片',
screenshot: '截图',
submit: '提交反馈',
privacyHint: '请勿提交敏感密钥、密码或私人聊天内容。',
contentRequired: '请先填写反馈内容',
imageOnly: '仅支持图片附件',
imageTooLarge: '单张图片不能超过 2MB',
tooManyImages: '最多添加 3 张图片',
screenshotFailed: '截图失败,请尝试粘贴或上传图片',
submitSuccess: '反馈已提交,感谢!',
submitFailed: '反馈提交失败,请稍后重试',
removeImage: '移除图片',
},
queries: {
title: '查询记录',