fix: Add route information to render errors (#86)

Co-authored-by: Jahred Hope <[email protected]>

Author: mrm007

src/index.ts

@@ -115,8 +115,12 @@ export default class HtmlRenderPlugin<Route extends BaseRoute = BaseRoute> {
           `Successfully rendered ${route.route} (${timeSince(startRenderTime)})`
         );
         return result;
-      } catch (error) {
-        error.webpackStats = webpackStats;
+      } catch (error: any) {
+        log(`Error rendering ${route.route}`);
+        if (error) {
+          error.route = route.route;
+          error.webpackStats = webpackStats;
+        }
         throw error;
       }
     };

src/renderRoutes.ts

@@ -5,6 +5,7 @@ import {
   TransformPath,
   Render,
   FileSystem,
+  BaseRoute,
 } from "./common-types";
 import { Compilation } from "webpack";
 import { log } from "./logging";
@@ -53,7 +54,7 @@ function safeMkdir(fileSystem: FileSystem, dir: string) {
   });
 }
 
-export default async function renderRoutes<Route>({
+export default async function renderRoutes<Route extends BaseRoute>({
   render: performRender,
   renderConcurrency,
   routes,
@@ -98,7 +99,9 @@ export default async function renderRoutes<Route>({
       renderResult = await performRender(route);
     } catch (error) {
       console.error(
-        `🚨 ${chalk.red(`An error occurred rendering "`)}". Exiting render.`
+        `🚨 ${chalk.red(
+          `An error occurred rendering route: "${route.route}"`
+        )}. Exiting render.`
       );
       throw error;
     }

tests/test-cases/render-when-ready/render-when-ready.test.ts

@@ -59,7 +59,10 @@ describe("renderWhenReady", () => {
 
     compiler.run(async () => {
       await expect(promise).rejects.toEqual(
-        expect.objectContaining({ webpackStats: expect.any(Object) })
+        expect.objectContaining({
+          route: "/new",
+          webpackStats: expect.any(Object),
+        })
       );
       done();
     });