Add extra test cases related to error reporting (#4517)

packages/core/test/actor.test.ts

@@ -30,10 +30,7 @@ import {
   stopChild
 } from '../src/index.ts';
 import { setup } from '../src/setup.ts';
-
-function sleep(ms: number) {
-  return new Promise((res) => setTimeout(res, ms));
-}
+import { sleep } from '@xstate-repo/jest-utils';
 
 describe('spawning machines', () => {
   const context = {

packages/core/test/errors.test.ts

@@ -1,4 +1,5 @@
 import { createMachine, fromCallback, fromPromise, createActor } from '../src';
+import { sleep } from '@xstate-repo/jest-utils';
 
 const cleanups: (() => void)[] = [];
 function installGlobalOnErrorHandler(handler: (ev: ErrorEvent) => void) {
@@ -165,14 +166,18 @@ describe('error handling', () => {
     });
   });
 
-  it('unhandled rejections when starting a child actor should be reported globally', (done) => {
+  it('unhandled rejection of a promise actor should be reported globally in absence of error listener', (done) => {
     const machine = createMachine({
       initial: 'pending',
       states: {
         pending: {
           invoke: {
             src: fromPromise(() =>
-              Promise.reject(new Error('unhandled_rejection_in_actor_start'))
+              Promise.reject(
+                new Error(
+                  'unhandled_rejection_in_promise_actor_without_error_listener'
+                )
+              )
             ),
             onDone: 'success'
           }
@@ -187,11 +192,110 @@ describe('error handling', () => {
 
     installGlobalOnErrorHandler((ev) => {
       ev.preventDefault();
-      expect(ev.error.message).toEqual('unhandled_rejection_in_actor_start');
+      expect(ev.error.message).toEqual(
+        'unhandled_rejection_in_promise_actor_without_error_listener'
+      );
       done();
     });
   });
 
+  it('unhandled rejection of a promise actor should be reported to the existing error listener of its parent', async () => {
+    const errorSpy = jest.fn();
+
+    const machine = createMachine({
+      initial: 'pending',
+      states: {
+        pending: {
+          invoke: {
+            src: fromPromise(() =>
+              Promise.reject(
+                new Error(
+                  'unhandled_rejection_in_promise_actor_with_parent_listener'
+                )
+              )
+            ),
+            onDone: 'success'
+          }
+        },
+        success: {
+          type: 'final'
+        }
+      }
+    });
+
+    const actorRef = createActor(machine);
+    actorRef.subscribe({
+      error: errorSpy
+    });
+    actorRef.start();
+
+    await sleep(0);
+
+    expect(errorSpy).toMatchMockCallsInlineSnapshot(`
+      [
+        [
+          [Error: unhandled_rejection_in_promise_actor_with_parent_listener],
+        ],
+      ]
+    `);
+  });
+
+  it('unhandled rejection of a promise actor should be reported to the existing error listener of its grandparent', async () => {
+    const errorSpy = jest.fn();
+
+    const child = createMachine({
+      initial: 'pending',
+      states: {
+        pending: {
+          invoke: {
+            src: fromPromise(() =>
+              Promise.reject(
+                new Error(
+                  'unhandled_rejection_in_promise_actor_with_grandparent_listener'
+                )
+              )
+            ),
+            onDone: 'success'
+          }
+        },
+        success: {
+          type: 'final'
+        }
+      }
+    });
+
+    const machine = createMachine({
+      initial: 'pending',
+      states: {
+        pending: {
+          invoke: {
+            src: child,
+            onDone: 'success'
+          }
+        },
+        success: {
+          type: 'final'
+        }
+      }
+    });
+
+    const actorRef = createActor(machine);
+    actorRef.subscribe({
+      error: errorSpy
+    });
+    actorRef.start();
+
+    await sleep(0);
+
+    expect(errorSpy).toMatchMockCallsInlineSnapshot(`
+      [
+        [
+          [Error: unhandled_rejection_in_promise_actor_with_grandparent_listener],
+        ],
+      ]
+    `);
+  });
+
   it('handled sync errors thrown when starting a child actor should not be reported globally', (done) => {
     const machine = createMachine({
       initial: 'pending',

packages/core/test/invoke.test.ts

@@ -23,10 +23,7 @@ import {
   Snapshot,
   ActorRef
 } from '../src/index.ts';
-
-function sleep(ms: number) {
-  return new Promise((resolve) => setTimeout(resolve, ms));
-}
+import { sleep } from '@xstate-repo/jest-utils';
 
 const user = { name: 'David' };
 

scripts/jest-utils/index.d.ts

@@ -1 +1,2 @@
+export declare function sleep(ms: number): Promise<undefined>;
 export declare function clearConsoleMocks(): void;

scripts/jest-utils/index.js

@@ -2,3 +2,5 @@ const { consoleSpies } = require('./console-spies');
 
 module.exports.clearConsoleMocks = () =>
   Object.values(consoleSpies).forEach((spy) => spy.mockClear());
+
+module.exports.sleep = (ms) => new Promise((res) => setTimeout(res, ms));