feat(gatsby): Add top-level error handling to state machine (#25995)

Author: ascorbic

packages/gatsby/src/state-machines/develop/actions.ts

@@ -129,6 +129,20 @@ export const finishParentSpan = ({ parentSpan }: IBuildContext): void =>
 
 export const saveDbState = (): Promise<void> => saveState()
 
+export const logError: ActionFunction<IBuildContext, AnyEventObject> = (
+  _context,
+  event
+) => {
+  reporter.error(event.data)
+}
+
+export const panic: ActionFunction<IBuildContext, AnyEventObject> = (
+  _context,
+  event
+) => {
+  reporter.panic(event.data)
+}
+
 /**
  * Event handler used in all states where we're not ready to process a file change
  * Instead we add it to a batch to process when we're next idle
@@ -158,4 +172,6 @@ export const buildActions: ActionFunctionMap<IBuildContext, AnyEventObject> = {
   markSourceFilesClean,
   saveDbState,
   setQueryRunningFinished,
+  panic,
+  logError,
 }

packages/gatsby/src/state-machines/develop/index.ts

@@ -45,6 +45,9 @@ const developConfig: MachineConfig<IBuildContext, any, AnyEventObject> = {
           target: `initializingData`,
           actions: [`assignStoreAndWorkerPool`, `spawnMutationListener`],
         },
+        onError: {
+          actions: `panic`,
+        },
       },
     },
     // Sourcing nodes, customising and inferring schema, then running createPages
@@ -77,6 +80,10 @@ const developConfig: MachineConfig<IBuildContext, any, AnyEventObject> = {
           ],
           target: `runningPostBootstrap`,
         },
+        onError: {
+          actions: `logError`,
+          target: `waiting`,
+        },
       },
     },
     runningPostBootstrap: {
@@ -132,6 +139,10 @@ const developConfig: MachineConfig<IBuildContext, any, AnyEventObject> = {
             target: `waiting`,
           },
         ],
+        onError: {
+          actions: `logError`,
+          target: `waiting`,
+        },
       },
     },
     // Recompile the JS bundle
@@ -142,6 +153,10 @@ const developConfig: MachineConfig<IBuildContext, any, AnyEventObject> = {
           actions: `markSourceFilesClean`,
           target: `waiting`,
         },
+        onError: {
+          actions: `logError`,
+          target: `waiting`,
+        },
       },
     },
     // Spin up webpack and socket.io
@@ -156,6 +171,10 @@ const developConfig: MachineConfig<IBuildContext, any, AnyEventObject> = {
             `markSourceFilesClean`,
           ],
         },
+        onError: {
+          actions: `panic`,
+          target: `waiting`,
+        },
       },
     },
     // Idle, waiting for events that make us rebuild
@@ -189,6 +208,10 @@ const developConfig: MachineConfig<IBuildContext, any, AnyEventObject> = {
           actions: `assignServiceResult`,
           target: `recreatingPages`,
         },
+        onError: {
+          actions: `panic`,
+          target: `waiting`,
+        },
       },
     },
     // Almost the same as initializing data, but skips various first-run stuff
@@ -223,6 +246,10 @@ const developConfig: MachineConfig<IBuildContext, any, AnyEventObject> = {
           ],
           target: `runningQueries`,
         },
+        onError: {
+          actions: `logError`,
+          target: `waiting`,
+        },
       },
     },
     // Rebuild pages if a node has been mutated outside of sourceNodes
@@ -236,6 +263,10 @@ const developConfig: MachineConfig<IBuildContext, any, AnyEventObject> = {
           actions: `assignServiceResult`,
           target: `runningQueries`,
         },
+        onError: {
+          actions: `logError`,
+          target: `waiting`,
+        },
       },
     },
   },