Add extra test cases for final outgoing events (#4389)

statelyai · Oct 24, 2023 · e4a4838 · e4a4838
1 parent 7a916da
commit e4a4838
Showing 1 changed file with 86 additions and 0 deletions.
diff --git a/packages/core/test/final.test.ts b/packages/core/test/final.test.ts
@@ -1155,4 +1155,90 @@ describe('final states', () => {
 
     expect(spy).toHaveBeenCalledTimes(1);
   });
+
+  it('should deliver final outgoing events (from final entry action) to the parent before delivering the `xstate.done.actor.*` event', () => {
+    const child = createMachine({
+      initial: 'start',
+      states: {
+        start: {
+          on: {
+            CANCEL: 'canceled'
+          }
+        },
+        canceled: {
+          type: 'final',
+          entry: sendParent({ type: 'CHILD_CANCELED' })
+        }
+      }
+    });
+    const parent = createMachine({
+      initial: 'start',
+      states: {
+        start: {
+          invoke: {
+            id: 'child',
+            src: child,
+            onDone: 'completed'
+          },
+          on: {
+            CHILD_CANCELED: 'canceled'
+          }
+        },
+        canceled: {},
+        completed: {}
+      }
+    });
+
+    const actorRef = createActor(parent).start();
+
+    actorRef.getSnapshot().children.child.send({
+      type: 'CANCEL'
+    });
+
+    // if `xstate.done.actor.*` would be delivered first the value would be `completed`
+    expect(actorRef.getSnapshot().value).toBe('canceled');
+  });
+
+  it('should deliver final outgoing events (from root exit action) to the parent before delivering the `xstate.done.actor.*` event', () => {
+    const child = createMachine({
+      initial: 'start',
+      states: {
+        start: {
+          on: {
+            CANCEL: 'canceled'
+          }
+        },
+        canceled: {
+          type: 'final'
+        }
+      },
+      exit: sendParent({ type: 'CHILD_CANCELED' })
+    });
+    const parent = createMachine({
+      initial: 'start',
+      states: {
+        start: {
+          invoke: {
+            id: 'child',
+            src: child,
+            onDone: 'completed'
+          },
+          on: {
+            CHILD_CANCELED: 'canceled'
+          }
+        },
+        canceled: {},
+        completed: {}
+      }
+    });
+
+    const actorRef = createActor(parent).start();
+
+    actorRef.getSnapshot().children.child.send({
+      type: 'CANCEL'
+    });
+
+    // if `xstate.done.actor.*` would be delivered first the value would be `completed`
+    expect(actorRef.getSnapshot().value).toBe('canceled');
+  });
 });