Remove actor.onDone(...) (#3991)

* Replace a lot of .onDone with .subscribe({ complete }) * Get rid of remaining .onDone() calls * Fix types * Remove onStop * Remove stopListeners * Add changeset
statelyai · May 19, 2023 · 98db493 · 98db493
1 parent fe6db14
commit 98db493
Show file tree

Hide file tree

Showing 22 changed files with 562 additions and 414 deletions.
diff --git a/.changeset/smart-laws-perform.md b/.changeset/smart-laws-perform.md
@@ -0,0 +1,14 @@
+---
+'xstate': major
+---
+
+The `actor.onDone(...)` method is removed. Use `actor.subscribe({ complete() {... } })` instead.
+
+```diff
+- actor.onDone(() => { ... })
++ actor.subscribe({
++  complete() {
++    // ...
++  }
++})
+```
diff --git a/docs/fr/guides/communication.md b/docs/fr/guides/communication.md
@@ -251,10 +251,9 @@ const pingPongMachine = createMachine({
     }
   }
 });
-
-interpret(pingPongMachine)
-  .onDone(() => done())
-  .start();
+const actor = interpret(pingPongMachine);
+actor.subscribe({ complete: () => done() });
+actor.start();
 ```
 
 ## Invoking Observables <Badge text="4.6"/>

diff --git a/docs/fr/guides/delays.md b/docs/fr/guides/delays.md
@@ -245,9 +245,9 @@ const dynamicDelayMachine = createMachine({
   }
 });
 
-const dynamicDelayService = interpret(dynamicDelayMachine)
-  .onDone(() => console.log('done!'))
-  .start();
+const dynamicDelayService = interpret(dynamicDelayMachine);
+dynamicDelayService.subscribe({ complete: () => console.log('done!') });
+dynamicDelayService.start();
 
 dynamicDelayService.send({
   type: 'ACTIVATE',

diff --git a/docs/guides/communication.md b/docs/guides/communication.md
@@ -255,10 +255,9 @@ const pingPongMachine = createMachine({
     }
   }
 });
-
-interpret(pingPongMachine)
-  .onDone(() => done())
-  .start();
+const actor = interpret(pingPongMachine);
+actor.subscribe({ complete: () => done() });
+actor.start();
 ```
 
 ## Invoking Observables <Badge text="4.6"/>

diff --git a/docs/guides/delays.md b/docs/guides/delays.md
@@ -249,9 +249,9 @@ const dynamicDelayMachine = createMachine({
   }
 });
 
-const dynamicDelayService = interpret(dynamicDelayMachine)
-  .onDone(() => console.log('done!'))
-  .start();
+const dynamicDelayService = interpret(dynamicDelayMachine);
+dynamicDelayService.subscribe({ complete: () => console.log('done!') });
+dynamicDelayService.start();
 
 dynamicDelayService.send({
   type: 'ACTIVATE',

diff --git a/docs/zh/guides/communication.md b/docs/zh/guides/communication.md
@@ -251,10 +251,9 @@ const pingPongMachine = createMachine({
     }
   }
 });
-
-interpret(pingPongMachine)
-  .onDone(() => done())
-  .start();
+const actor = interpret(pingPongMachine);
+actor.subscribe({ complete: () => done() });
+actor.start();
 ```
 
 ## 调用 Observables <Badge text="4.6"/>

diff --git a/docs/zh/guides/delays.md b/docs/zh/guides/delays.md
@@ -245,9 +245,9 @@ const dynamicDelayMachine = createMachine({
   }
 });
 
-const dynamicDelayService = interpret(dynamicDelayMachine)
-  .onDone(() => console.log('done!'))
-  .start();
+const dynamicDelayService = interpret(dynamicDelayMachine);
+dynamicDelayService.subscribe({ complete: () => console.log('done!') });
+dynamicDelayService.start();
 
 dynamicDelayService.send({
   type: 'ACTIVATE',

diff --git a/packages/core/src/interpreter.ts b/packages/core/src/interpreter.ts
@@ -258,26 +258,6 @@ export class Interpreter<
     };
   }
 
-  /**
-   * Adds a state listener that is notified when the statechart has reached its final state.
-   * @param listener The state listener
-   */
-  public onDone(listener: EventListener<DoneEvent>): this {
-    if (this.status === ActorStatus.Stopped && this._doneEvent) {
-      listener(this._doneEvent);
-    } else {
-      this.observers.add({
-        complete: () => {
-          if (this._doneEvent) {
-            listener(this._doneEvent);
-          }
-        }
-      });
-    }
-
-    return this;
-  }
-
   /**
    * Starts the interpreter from the initial state
    */

diff --git a/packages/core/test/actions.test.ts b/packages/core/test/actions.test.ts
@@ -1372,13 +1372,15 @@ describe('entry/exit actions', () => {
         }
       });
 
-      interpret(parentMachine)
-        .onDone(() => {
+      const actor = interpret(parentMachine);
+      actor.subscribe({
+        complete: () => {
           expect(exitCalled).toBeTruthy();
           expect(childExitCalled).toBeTruthy();
           done();
-        })
-        .start();
+        }
+      });
+      actor.start();
     });
   });
 
@@ -2443,9 +2445,9 @@ describe('forwardTo()', () => {
       }
     });
 
-    const service = interpret(parent)
-      .onDone(() => done())
-      .start();
+    const service = interpret(parent);
+    service.subscribe({ complete: () => done() });
+    service.start();
 
     service.send({ type: 'EVENT', value: 42 });
   });
@@ -2493,9 +2495,9 @@ describe('forwardTo()', () => {
       }
     });
 
-    const service = interpret(parent)
-      .onDone(() => done())
-      .start();
+    const service = interpret(parent);
+    service.subscribe({ complete: () => done() });
+    service.start();
 
     service.send({ type: 'EVENT', value: 42 });
   });
@@ -3112,7 +3114,7 @@ describe('raise', () => {
 
     const service = interpret(machine).start();
 
-    service.onDone(() => done());
+    service.subscribe({ complete: () => done() });
 
     // Ensures that the delayed self-event is sent when in the `b` state
     service.send({ type: 'TO_B' });
@@ -3193,7 +3195,7 @@ describe('raise', () => {
 
     const service = interpret(machine).start();
 
-    service.onDone(() => done());
+    service.subscribe({ complete: () => done() });
 
     setTimeout(() => {
       // didn't transition yet