Show a crash dialog when the editor panics (#362)

Keavon · web-flow · commit 51c2494d43a8 · 2021-08-31T18:34:19.000-07:00
* Show a crash dialog when the editor panics Closes #357 * Suppress console usage lints * Proxy cleanup and comments
diff --git a/editor/src/document/document_message_handler.rs b/editor/src/document/document_message_handler.rs
@@ -202,7 +202,13 @@ impl MessageHandler<DocumentsMessage, &InputPreprocessor> for DocumentsMessageHa
 					Ok(document) => {
 						self.load_document(document, responses);
 					}
-					Err(e) => responses.push_back(FrontendMessage::DisplayError { description: e.to_string() }.into()),
+					Err(e) => responses.push_back(
+						FrontendMessage::DisplayError {
+							title: "Failed to open document".to_string(),
+							description: e.to_string(),
+						}
+						.into(),
+					),
 				}
 			}
 			GetOpenDocumentsList => {
diff --git a/editor/src/frontend/frontend_message_handler.rs b/editor/src/frontend/frontend_message_handler.rs
@@ -12,7 +12,8 @@ pub enum FrontendMessage {
 	SetActiveTool { tool_name: String, tool_options: Option<ToolOptions> },
 	SetActiveDocument { document_index: usize },
 	UpdateOpenDocumentsList { open_documents: Vec<String> },
-	DisplayError { description: String },
+	DisplayError { title: String, description: String },
+	DisplayPanic { title: String, description: String },
 	DisplayConfirmationToCloseDocument { document_index: usize },
 	DisplayConfirmationToCloseAllDocuments,
 	UpdateCanvas { document: String },
diff --git a/editor/src/lib.rs b/editor/src/lib.rs
@@ -41,8 +41,10 @@ impl Editor {
 
 	pub fn handle_message<T: Into<Message>>(&mut self, message: T) -> Vec<FrontendMessage> {
 		self.dispatcher.handle_message(message);
+
 		let mut responses = Vec::new();
 		std::mem::swap(&mut responses, &mut self.dispatcher.responses);
+
 		responses
 	}
 }
diff --git a/frontend/src/components/panels/Document.vue b/frontend/src/components/panels/Document.vue
@@ -227,6 +227,7 @@ import { defineComponent } from "vue";
 import { ResponseType, registerResponseHandler, Response, UpdateCanvas, UpdateScrollbars, SetActiveTool, SetCanvasZoom, SetCanvasRotation } from "@/utilities/response-handler";
 import { SeparatorDirection, SeparatorType } from "@/components/widgets/widgets";
 import { comingSoon } from "@/utilities/errors";
+import { panicProxy } from "@/utilities/panic";
 
 import LayoutRow from "@/components/layout/LayoutRow.vue";
 import LayoutCol from "@/components/layout/LayoutCol.vue";
@@ -245,7 +246,7 @@ import OptionalInput from "@/components/widgets/inputs/OptionalInput.vue";
 import ToolOptions from "@/components/widgets/options/ToolOptions.vue";
 import { SectionsOfMenuListEntries } from "@/components/widgets/floating-menus/MenuList.vue";
 
-const wasm = import("@/../wasm/pkg");
+const wasm = import("@/../wasm/pkg").then(panicProxy);
 
 const documentModeEntries: SectionsOfMenuListEntries = [
 	[
diff --git a/frontend/src/components/panels/LayerTree.vue b/frontend/src/components/panels/LayerTree.vue
@@ -182,6 +182,7 @@
 import { defineComponent } from "vue";
 
 import { ResponseType, registerResponseHandler, Response, BlendMode, ExpandFolder, CollapseFolder, UpdateLayer, LayerPanelEntry, LayerType } from "@/utilities/response-handler";
+import { panicProxy } from "@/utilities/panic";
 import { SeparatorType } from "@/components/widgets/widgets";
 
 import LayoutRow from "@/components/layout/LayoutRow.vue";
@@ -195,7 +196,7 @@ import IconLabel from "@/components/widgets/labels/IconLabel.vue";
 import DropdownInput from "@/components/widgets/inputs/DropdownInput.vue";
 import { SectionsOfMenuListEntries } from "@/components/widgets/floating-menus/MenuList.vue";
 
-const wasm = import("@/../wasm/pkg");
+const wasm = import("@/../wasm/pkg").then(panicProxy);
 
 const blendModeEntries: SectionsOfMenuListEntries = [
 	[{ label: "Normal", value: BlendMode.Normal }],
diff --git a/frontend/src/components/widgets/floating-menus/DialogModal.vue b/frontend/src/components/widgets/floating-menus/DialogModal.vue
@@ -57,12 +57,14 @@
 
 	.main-column {
 		.heading {
-			white-space: pre;
+			white-space: pre-wrap;
+			max-width: 400px;
 			margin-bottom: 4px;
 		}
 
 		.details {
-			white-space: pre;
+			white-space: pre-wrap;
+			max-width: 400px;
 		}
 
 		.buttons-row {
diff --git a/frontend/src/components/widgets/inputs/MenuBarInput.vue b/frontend/src/components/widgets/inputs/MenuBarInput.vue
@@ -54,13 +54,14 @@
 import { defineComponent } from "vue";
 
 import { comingSoon } from "@/utilities/errors";
+import { panicProxy } from "@/utilities/panic";
 
 import IconLabel from "@/components/widgets/labels/IconLabel.vue";
 import { ApplicationPlatform } from "@/components/window/MainWindow.vue";
 import MenuList, { MenuListEntry, MenuListEntries } from "@/components/widgets/floating-menus/MenuList.vue";
 import { MenuDirection } from "@/components/widgets/floating-menus/FloatingMenu.vue";
 
-const wasm = import("@/../wasm/pkg");
+const wasm = import("@/../wasm/pkg").then(panicProxy);
 
 const menuEntries: MenuListEntries = [
 	{
diff --git a/frontend/src/components/widgets/inputs/SwatchPairInput.vue b/frontend/src/components/widgets/inputs/SwatchPairInput.vue
@@ -69,12 +69,13 @@
 import { defineComponent } from "vue";
 
 import { rgbToDecimalRgb, RGB } from "@/utilities/color";
+import { panicProxy } from "@/utilities/panic";
 import { ResponseType, registerResponseHandler, Response, UpdateWorkingColors } from "@/utilities/response-handler";
 
 import ColorPicker from "@/components/widgets/floating-menus/ColorPicker.vue";
 import FloatingMenu, { MenuDirection, MenuType } from "@/components/widgets/floating-menus/FloatingMenu.vue";
 
-const wasm = import("@/../wasm/pkg");
+const wasm = import("@/../wasm/pkg").then(panicProxy);
 
 export default defineComponent({
 	components: {
diff --git a/frontend/src/components/widgets/options/ToolOptions.vue b/frontend/src/components/widgets/options/ToolOptions.vue
@@ -32,14 +32,15 @@
 import { defineComponent, PropType } from "vue";
 
 import { comingSoon } from "@/utilities/errors";
+import { panicProxy } from "@/utilities/panic";
 import { WidgetRow, SeparatorType, IconButtonWidget } from "@/components/widgets/widgets";
 
 import Separator from "@/components/widgets/separators/Separator.vue";
 import IconButton from "@/components/widgets/buttons/IconButton.vue";
 import PopoverButton from "@/components/widgets/buttons/PopoverButton.vue";
 import NumberInput from "@/components/widgets/inputs/NumberInput.vue";
 
-const wasm = import("@/../wasm/pkg");
+const wasm = import("@/../wasm/pkg").then(panicProxy);
 
 export default defineComponent({
 	props: {
diff --git a/frontend/src/components/window/title-bar/WindowButtonsWeb.vue b/frontend/src/components/window/title-bar/WindowButtonsWeb.vue
@@ -1,6 +1,6 @@
 <template>
 	<div class="window-buttons-web" @click="handleClick" :title="fullscreen.windowFullscreen ? 'Exit Fullscreen (F11)' : 'Enter Fullscreen (F11)'">
-		<TextLabel v-if="requestFullscreenHotkeys" :italic="true">Click to access all hotkeys</TextLabel>
+		<TextLabel v-if="requestFullscreenHotkeys" :italic="true">Go fullscreen to access all hotkeys</TextLabel>
 		<IconLabel :icon="fullscreen.windowFullscreen ? 'FullscreenExit' : 'FullscreenEnter'" />
 	</div>
 </template>
diff --git a/frontend/src/utilities/documents.ts b/frontend/src/utilities/documents.ts
@@ -11,9 +11,10 @@ import {
 	ExportDocument,
 	SaveDocument,
 } from "@/utilities/response-handler";
-import { download, upload } from "./files";
+import { download, upload } from "@/utilities/files";
+import { panicProxy } from "@/utilities/panic";
 
-const wasm = import("@/../wasm/pkg");
+const wasm = import("@/../wasm/pkg").then(panicProxy);
 
 const state = reactive({
 	title: "",
diff --git a/frontend/src/utilities/errors.ts b/frontend/src/utilities/errors.ts
@@ -1,6 +1,7 @@
 import { createDialog, dismissDialog } from "@/utilities/dialog";
 import { TextButtonWidget } from "@/components/widgets/widgets";
-import { ResponseType, registerResponseHandler, Response, DisplayError } from "@/utilities/response-handler";
+import { getPanicDetails } from "@/utilities/panic";
+import { ResponseType, registerResponseHandler, Response, DisplayError, DisplayPanic } from "@/utilities/response-handler";
 
 export function comingSoon(issueNumber?: number) {
 	const bugMessage = `— but you can help add it!\nSee issue #${issueNumber} on GitHub.`;
@@ -32,5 +33,74 @@ registerResponseHandler(ResponseType.DisplayError, (responseData: Response) => {
 	};
 	const buttons = [okButton];
 
-	createDialog("Warning", "Editor error", data.description, buttons);
+	createDialog("Warning", data.title, data.description, buttons);
 });
+
+registerResponseHandler(ResponseType.DisplayPanic, (responseData: Response) => {
+	const data = responseData as DisplayPanic;
+
+	const reloadButton: TextButtonWidget = {
+		kind: "TextButton",
+		callback: async () => window.location.reload(),
+		props: { label: "Reload", emphasized: true, minWidth: 96 },
+	};
+	const copyErrorLogButton: TextButtonWidget = {
+		kind: "TextButton",
+		callback: async () => navigator.clipboard.writeText(getPanicDetails()),
+		props: { label: "Copy Error Log", emphasized: false, minWidth: 96 },
+	};
+	const reportOnGithubButton: TextButtonWidget = {
+		kind: "TextButton",
+		callback: async () => window.open(githubUrl(), "_blank"),
+		props: { label: "Report Bug", emphasized: false, minWidth: 96 },
+	};
+	const buttons = [reloadButton, copyErrorLogButton, reportOnGithubButton];
+
+	createDialog("Warning", data.title, data.description, buttons);
+});
+
+function githubUrl() {
+	const url = new URL("https://github.com/GraphiteEditor/Graphite/issues/new");
+
+	const body = `
+**Describe the Crash**
+Explain clearly what you were doing when the crash occurred.
+
+**Steps To Reproduce**
+Describe precisely how the crash occurred, step by step, starting with a new editor window.
+1. Open the Graphite Editor at https://editor.graphite.design
+2. 
+3. 
+4. 
+5. 
+
+**Browser and OS*
+List of your browser and its version, as well as your operating system.
+
+**Additional Details**
+Provide any further information or context that you think would be helpful in fixing the issue. Screenshots or video can be linked or attached to this issue.
+
+**Stack Trace**
+Copied from the crash dialog in the Graphite Editor:
+
+\`\`\`
+${getPanicDetails()}
+\`\`\`
+`.trim();
+
+	const fields = {
+		title: "[Crash Report] ",
+		body,
+		labels: ["Crash"].join(","),
+		projects: [].join(","),
+		milestone: "",
+		assignee: "",
+		template: "",
+	};
+
+	Object.entries(fields).forEach(([field, value]) => {
+		if (value) url.searchParams.set(field, value);
+	});
+
+	return url.toString();
+}
diff --git a/frontend/src/utilities/input.ts b/frontend/src/utilities/input.ts
@@ -1,7 +1,8 @@
 import { toggleFullscreen } from "@/utilities/fullscreen";
 import { dialogIsVisible, dismissDialog, submitDialog } from "@/utilities/dialog";
+import { panicProxy } from "@/utilities/panic";
 
-const wasm = import("@/../wasm/pkg");
+const wasm = import("@/../wasm/pkg").then(panicProxy);
 
 let viewportMouseInteractionOngoing = false;
 
@@ -45,10 +46,12 @@ export async function onKeyDown(e: KeyboardEvent) {
 
 	if (dialogIsVisible()) {
 		if (e.key === "Escape") dismissDialog();
-		if (e.key === "Enter") submitDialog();
+		if (e.key === "Enter") {
+			submitDialog();
 
-		// Prevent the Enter key from acting like a click on the last clicked button, which might reopen the dialog
-		e.preventDefault();
+			// Prevent the Enter key from acting like a click on the last clicked button, which might reopen the dialog
+			e.preventDefault();
+		}
 	}
 }
 
diff --git a/frontend/src/utilities/panic.ts b/frontend/src/utilities/panic.ts
@@ -0,0 +1,50 @@
+// Import this function and chain it on all `wasm` imports like: const wasm = import("@/../wasm/pkg").then(panicProxy);
+// This works by proxying every function call wrapping a try-catch block to filter out redundant and confusing `RuntimeError: unreachable` exceptions sent to the console
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+export function panicProxy(module: any) {
+	const proxyHandler = {
+		// eslint-disable-next-line @typescript-eslint/no-explicit-any
+		get(target: any, propKey: any, receiver: any) {
+			const targetValue = Reflect.get(target, propKey, receiver);
+
+			// Keep the original value being accessed if it isn't a function or it is a class
+			// TODO: Figure out how to also wrap (class) constructor functions instead of skipping them for now
+			const isFunction = typeof targetValue === "function";
+			const isClass = isFunction && /^\s*class\s+/.test(targetValue.toString());
+			if (!isFunction || isClass) return targetValue;
+
+			// Replace the original function with a wrapper function that runs the original in a try-catch block
+			// eslint-disable-next-line @typescript-eslint/no-explicit-any, func-names
+			return function (...args: any) {
+				let result;
+				try {
+					// @ts-expect-error
+					result = targetValue.apply(this, args);
+				} catch (err: any) {
+					// Suppress `unreachable` WebAssembly.RuntimeError exceptions
+					if (!`${err}`.startsWith("RuntimeError: unreachable")) throw err;
+				}
+				return result;
+			};
+		},
+	};
+
+	return new Proxy(module, proxyHandler);
+}
+
+// Intercept console.error() for panic messages sent by code in the WASM toolchain
+let panicDetails = "";
+// eslint-disable-next-line no-console
+const error = console.error.bind(console);
+// eslint-disable-next-line no-console
+console.error = (...args) => {
+	const details = "".concat(...args).trim();
+	if (details.startsWith("panicked at")) panicDetails = details;
+
+	error(...args);
+};
+
+// Get the body of the panic's exception that was printed in the console
+export function getPanicDetails(): string {
+	return panicDetails;
+}
diff --git a/frontend/src/utilities/response-handler.ts b/frontend/src/utilities/response-handler.ts
@@ -28,6 +28,7 @@ export enum ResponseType {
 	SetCanvasZoom = "SetCanvasZoom",
 	SetCanvasRotation = "SetCanvasRotation",
 	DisplayError = "DisplayError",
+	DisplayPanic = "DisplayPanic",
 	DisplayConfirmationToCloseDocument = "DisplayConfirmationToCloseDocument",
 	DisplayConfirmationToCloseAllDocuments = "DisplayConfirmationToCloseAllDocuments",
 }
@@ -43,8 +44,10 @@ export function handleResponse(responseType: string, responseData: any) {
 	if (callback && data) {
 		callback(data);
 	} else if (data) {
+		// eslint-disable-next-line no-console
 		console.error(`Received a Response of type "${responseType}" but no handler was registered for it from the client.`);
 	} else {
+		// eslint-disable-next-line no-console
 		console.error(`Received a Response of type "${responseType}" but but was not able to parse the data.`);
 	}
 }
@@ -83,6 +86,8 @@ function parseResponse(responseType: string, data: any): Response {
 			return newUpdateWorkingColors(data.UpdateWorkingColors);
 		case "DisplayError":
 			return newDisplayError(data.DisplayError);
+		case "DisplayPanic":
+			return newDisplayPanic(data.DisplayPanic);
 		case "DisplayConfirmationToCloseDocument":
 			return newDisplayConfirmationToCloseDocument(data.DisplayConfirmationToCloseDocument);
 		case "DisplayConfirmationToCloseAllDocuments":
@@ -144,10 +149,23 @@ function newSetActiveDocument(input: any): SetActiveDocument {
 }
 
 export interface DisplayError {
+	title: string;
 	description: string;
 }
 function newDisplayError(input: any): DisplayError {
 	return {
+		title: input.title,
+		description: input.description,
+	};
+}
+
+export interface DisplayPanic {
+	title: string;
+	description: string;
+}
+function newDisplayPanic(input: any): DisplayPanic {
+	return {
+		title: input.title,
 		description: input.description,
 	};
 }
diff --git a/frontend/wasm/src/lib.rs b/frontend/wasm/src/lib.rs

Original file line number	Diff line number	Diff line change
`@@ -202,7 +202,13 @@ impl MessageHandler<DocumentsMessage, &InputPreprocessor> for DocumentsMessageHa`
`202`	`202`	`Ok(document) => {`
`203`	`203`	`self.load_document(document, responses);`
`204`	`204`	`}`
`205`		`- Err(e) => responses.push_back(FrontendMessage::DisplayError { description: e.to_string() }.into()),`
	`205`	`+ Err(e) => responses.push_back(`
	`206`	`+ FrontendMessage::DisplayError {`
	`207`	`+ title: "Failed to open document".to_string(),`
	`208`	`+ description: e.to_string(),`
	`209`	`+ }`
	`210`	`+ .into(),`
	`211`	`+ ),`
`206`	`212`	`}`
`207`	`213`	`}`
`208`	`214`	`GetOpenDocumentsList => {`
Original file line number	Diff line number	Diff line change
`@@ -41,8 +41,10 @@ impl Editor {`
`41`	`41`
`42`	`42`	`pub fn handle_message<T: Into<Message>>(&mut self, message: T) -> Vec<FrontendMessage> {`
`43`	`43`	`self.dispatcher.handle_message(message);`
	`44`	`+`
`44`	`45`	`let mut responses = Vec::new();`
`45`	`46`	`std::mem::swap(&mut responses, &mut self.dispatcher.responses);`
	`47`	`+`
`46`	`48`	`responses`
`47`	`49`	`}`
`48`	`50`	`}`
Original file line number	Diff line number	Diff line change
`@@ -57,12 +57,14 @@`
`57`	`57`
`58`	`58`	`.main-column {`
`59`	`59`	`.heading {`
`60`		`- white-space: pre;`
	`60`	`+ white-space: pre-wrap;`
	`61`	`+ max-width: 400px;`
`61`	`62`	`margin-bottom: 4px;`
`62`	`63`	`}`
`63`	`64`
`64`	`65`	`.details {`
`65`		`- white-space: pre;`
	`66`	`+ white-space: pre-wrap;`
	`67`	`+ max-width: 400px;`
`66`	`68`	`}`
`67`	`69`
`68`	`70`	`.buttons-row {`