Enable exception reporting & default error screen to report GitHub bug (#82)

This commit is contained in:
Will Chen
2025-05-05 14:19:33 -07:00
committed by GitHub
parent ac8ef73bee
commit 43cf62a93c
4 changed files with 123 additions and 0 deletions

View File

@@ -0,0 +1,119 @@
import React, {
Component,
ErrorInfo,
ReactNode,
useState,
useEffect,
} from "react";
import { Button } from "@/components/ui/button";
import { LightbulbIcon } from "lucide-react";
import { ErrorComponentProps } from "@tanstack/react-router";
import { usePostHog } from "posthog-js/react";
import { IpcClient } from "@/ipc/ipc_client";
export function ErrorBoundary({ error }: ErrorComponentProps) {
const [isLoading, setIsLoading] = useState(false);
const posthog = usePostHog();
useEffect(() => {
console.error("An error occurred in the route:", error);
posthog.captureException(error);
}, [error]);
const handleReportBug = async () => {
setIsLoading(true);
try {
// Get system debug info
const debugInfo = await IpcClient.getInstance().getSystemDebugInfo();
// Create a formatted issue body with the debug info and error information
const issueBody = `
## Bug Description
<!-- Please describe the issue you're experiencing -->
## Steps to Reproduce
<!-- Please list the steps to reproduce the issue -->
## Expected Behavior
<!-- What did you expect to happen? -->
## Actual Behavior
<!-- What actually happened? -->
## Error Details
- Error Name: ${error?.name || "Unknown"}
- Error Message: ${error?.message || "Unknown"}
${error?.stack ? `\n\`\`\`\n${error.stack.slice(0, 1000)}\n\`\`\`` : ""}
## System Information
- Dyad Version: ${debugInfo.dyadVersion}
- Platform: ${debugInfo.platform}
- Architecture: ${debugInfo.architecture}
- Node Version: ${debugInfo.nodeVersion || "Not available"}
- PNPM Version: ${debugInfo.pnpmVersion || "Not available"}
- Node Path: ${debugInfo.nodePath || "Not available"}
- Telemetry ID: ${debugInfo.telemetryId || "Not available"}
## Logs
\`\`\`
${debugInfo.logs.slice(-3_500) || "No logs available"}
\`\`\`
`;
// Create the GitHub issue URL with the pre-filled body
const encodedBody = encodeURIComponent(issueBody);
const encodedTitle = encodeURIComponent(
"[bug] Error in Dyad application"
);
const githubIssueUrl = `https://github.com/dyad-sh/dyad/issues/new?title=${encodedTitle}&labels=bug,filed-from-app,client-error&body=${encodedBody}`;
// Open the pre-filled GitHub issue page
await IpcClient.getInstance().openExternalUrl(githubIssueUrl);
} catch (err) {
console.error("Failed to prepare bug report:", err);
// Fallback to opening the regular GitHub issue page
IpcClient.getInstance().openExternalUrl(
"https://github.com/dyad-sh/dyad/issues/new"
);
} finally {
setIsLoading(false);
}
};
return (
<div className="flex flex-col items-center justify-center h-screen p-6">
<div className="max-w-md w-full bg-background p-6 rounded-lg shadow-lg">
<h2 className="text-xl font-bold mb-4">
Sorry, that shouldn't have happened!
</h2>
<p className="text-sm mb-3">There was an error loading the app...</p>
{error && (
<div className="bg-slate-100 dark:bg-slate-800 p-4 rounded-md mb-6">
<p className="text-sm mb-1">
<strong>Error name:</strong> {error.name}
</p>
<p className="text-sm">
<strong>Error message:</strong> {error.message}
</p>
</div>
)}
<div className="flex flex-col gap-2">
<Button onClick={handleReportBug} disabled={isLoading}>
{isLoading ? "Preparing report..." : "Report Bug"}
</Button>
</div>
<div className="mt-4 p-3 bg-blue-50 dark:bg-blue-950 border border-blue-200 dark:border-blue-800 rounded-md flex items-center gap-2">
<LightbulbIcon className="h-4 w-4 text-blue-700 dark:text-blue-400 flex-shrink-0" />
<p className="text-sm text-blue-700 dark:text-blue-400">
<strong>Tip:</strong> Try closing and re-opening Dyad as a temporary
workaround.
</p>
</div>
</div>
</div>
);
}

View File

@@ -86,6 +86,7 @@ export function HelpDialog({ isOpen, onClose }: HelpDialogProps) {
- Node Version: ${debugInfo.nodeVersion || "Not available"} - Node Version: ${debugInfo.nodeVersion || "Not available"}
- PNPM Version: ${debugInfo.pnpmVersion || "Not available"} - PNPM Version: ${debugInfo.pnpmVersion || "Not available"}
- Node Path: ${debugInfo.nodePath || "Not available"} - Node Path: ${debugInfo.nodePath || "Not available"}
- Telemetry ID: ${debugInfo.telemetryId || "Not available"}
## Logs ## Logs
\`\`\` \`\`\`

View File

@@ -16,6 +16,7 @@ const posthogClient = posthog.init(
// @ts-ignore // @ts-ignore
debug: import.meta.env.MODE === "development", debug: import.meta.env.MODE === "development",
autocapture: false, autocapture: false,
capture_exceptions: true,
capture_pageview: false, capture_pageview: false,
before_send: (event) => { before_send: (event) => {
if (!isTelemetryOptedIn()) { if (!isTelemetryOptedIn()) {

View File

@@ -16,6 +16,7 @@ const routeTree = rootRoute.addChildren([
// src/components/NotFoundRedirect.tsx // src/components/NotFoundRedirect.tsx
import * as React from "react"; import * as React from "react";
import { useNavigate } from "@tanstack/react-router"; import { useNavigate } from "@tanstack/react-router";
import { ErrorBoundary } from "./components/ErrorBoundary";
export function NotFoundRedirect() { export function NotFoundRedirect() {
const navigate = useNavigate(); const navigate = useNavigate();
@@ -35,6 +36,7 @@ export function NotFoundRedirect() {
export const router = createRouter({ export const router = createRouter({
routeTree, routeTree,
defaultNotFoundComponent: NotFoundRedirect, defaultNotFoundComponent: NotFoundRedirect,
defaultErrorComponent: ErrorBoundary,
}); });
declare module "@tanstack/react-router" { declare module "@tanstack/react-router" {