MISC: Always include stack trace in Recovery Mode (#1487)

We are getting some more error reports coming in that don't have enough
info in them. It turns out that populating the stack trace was gated
behind the dev flag; in reality, production builds are where we need it
most. Even if it ends up being obfuscated (source maps should prevent
this), we can figure out the actual source lines with enough effort if
need be.

This also changes to using the actual stack trace, rather than the
"component" trace (the tree of JSX objects), since knowing where the
code failed is far more valuable. Also, it ensures we get the full error
details when things go wrong in savefile loading.

src/ui/React/RecoveryRoot.tsx

@@ -5,7 +5,7 @@ import { Settings } from "../../Settings/Settings";
 import { load } from "../../db";
 import { Router } from "../GameRoot";
 import { Page } from "../Router";
-import { IErrorData, newIssueUrl } from "../../utils/ErrorHelper";
+import { IErrorData, newIssueUrl, getErrorForDisplay } from "../../utils/ErrorHelper";
 import { DeleteGameButton } from "./DeleteGameButton";
 import { SoftResetButton } from "./SoftResetButton";
 
@@ -38,6 +38,13 @@ export function RecoveryRoot({ softReset, errorData, resetError }: IProps): Reac
   }
   Settings.AutosaveInterval = 0;
 
+  // The architecture around RecoveryRoot is awkward, and it can be invoked in
+  // a number of ways. If we are invoked via a save error, sourceError will be set
+  // and we won't have decoded the information into errorData.
+  if (errorData == null && sourceError) {
+    errorData = getErrorForDisplay(sourceError, undefined, Page.LoadingScreen);
+  }
+
   useEffect(() => {
     load()
       .then((content) => {

src/utils/ErrorHelper.ts

@@ -30,7 +30,7 @@ interface BrowserFeatures {
 }
 
 interface IErrorMetadata {
-  error: Error;
+  error: Record<string, unknown>;
   errorInfo?: React.ErrorInfo;
   page?: Page;
 
@@ -54,7 +54,7 @@ export interface IErrorData {
 
 export const newIssueUrl = `https://github.com/bitburner-official/bitburner-src/issues/new`;
 
-function getErrorMetadata(error: Error, errorInfo?: React.ErrorInfo, page?: Page): IErrorMetadata {
+function getErrorMetadata(error: unknown, errorInfo?: React.ErrorInfo, page?: Page): IErrorMetadata {
   const isElectron = navigator.userAgent.toLowerCase().includes(" electron/");
   const env = process.env.NODE_ENV === "development" ? GameEnv.Development : GameEnv.Production;
   const version: GameVersion = {
@@ -70,19 +70,20 @@ function getErrorMetadata(error: Error, errorInfo?: React.ErrorInfo, page?: Page
     doNotTrack: navigator.doNotTrack,
     indexedDb: !!window.indexedDB,
   };
+  const errorObj = typeof error === "object" && error !== null ? (error as Record<string, unknown>) : {};
   const metadata: IErrorMetadata = {
     platform: isElectron ? Platform.Steam : Platform.Browser,
     environment: env,
     version,
     features,
-    error,
+    error: errorObj,
     errorInfo,
     page,
   };
   return metadata;
 }
 
-export function getErrorForDisplay(error: Error, errorInfo?: React.ErrorInfo, page?: Page): IErrorData {
+export function getErrorForDisplay(error: unknown, errorInfo?: React.ErrorInfo, page?: Page): IErrorData {
   const metadata = getErrorMetadata(error, errorInfo, page);
   const fileName = (metadata.error as any).fileName;
   const features =
@@ -112,16 +113,11 @@ Please fill this information with details if relevant.
 * Features: ${features}
 * Source: ${fileName ?? "n/a"}
 
-${
-  metadata.environment === GameEnv.Development
-    ? `
 ### Stack Trace
 \`\`\`
-${metadata.errorInfo?.componentStack.toString().trim()}
+${metadata.error.stack}
 \`\`\`
-`
+
-    : ""
-}
 ### Save
 \`\`\`
 Copy your save here if possible