Fix default error logging to include stack traces (#1393)

Shopify · Oct 12, 2023 · 4f735fd · 4f735fd
1 parent 4156d16
commit 4f735fd
Show file tree

Hide file tree

Showing 4 changed files with 27 additions and 13 deletions.
diff --git a/.changeset/ten-trainers-know.md b/.changeset/ten-trainers-know.md
@@ -0,0 +1,5 @@
+---
+'@shopify/remix-oxygen': patch
+---
+
+Update the Oxygen Remix adapter to make sure that stack traces are logged in production
diff --git a/examples/express/app/entry.server.tsx b/examples/express/app/entry.server.tsx
@@ -76,7 +76,9 @@ function handleBotRequest(
         },
         onError(error: unknown) {
           responseStatusCode = 500;
-          console.error(error);
+          console.error(
+            (error as Error)?.stack ? (error as Error).stack : error,
+          );
         },
       },
     );
@@ -123,7 +125,9 @@ function handleBrowserRequest(
           reject(error);
         },
         onError(error: unknown) {
-          console.error(error);
+          console.error(
+            (error as Error)?.stack ? (error as Error).stack : error,
+          );
           responseStatusCode = 500;
         },
       },

diff --git a/package-lock.json b/package-lock.json
diff --git a/packages/remix-oxygen/src/server.ts b/packages/remix-oxygen/src/server.ts
@@ -9,6 +9,11 @@ declare global {
   var __H2O_LOG_EVENT: undefined | ((event: H2OEvent) => void);
 }
 
+const originalErrorToString = Error.prototype.toString;
+Error.prototype.toString = function () {
+  return this.stack || originalErrorToString.call(this);
+};
+
 export function createRequestHandler<Context = unknown>({
   build,
   mode,