[v5] Remove autoForward

.changeset/fresh-garlics-fry.md

@@ -0,0 +1,22 @@
+---
+'xstate': major
+---
+
+Autoforwarding events is no longer supported and the `autoForward` property has been removed.
+
+Instead of autoforwarding, events should be explicitly sent to actors:
+
+```diff
+invoke: {
+  id: 'child',
+  src: 'someSrc',
+- autoForward: true
+},
+// ...
+on: {
+  // ...
++ EVENT_TO_FORWARD: {
++   actions: sendTo('child', (_, event) => event)
++ }
+}
+```

packages/core/src/actions/invoke.ts

@@ -85,7 +85,7 @@ export function invoke<
 
       resolvedInvokeAction.execute = (actorCtx) => {
         const interpreter = actorCtx.self as AnyInterpreter;
-        const { id, autoForward, ref } = resolvedInvokeAction.params;
+        const { id, ref } = resolvedInvokeAction.params;
         if (!ref) {
           if (!IS_PRODUCTION) {
             warn(
@@ -100,10 +100,6 @@ export function invoke<
             return;
           }
           try {
-            if (autoForward) {
-              interpreter._forwardTo.add(actorRef);
-            }
-
             actorRef.start?.();
           } catch (err) {
             interpreter.send(error(id, err));

packages/core/src/scxml.ts

@@ -445,8 +445,7 @@ function toConfig(
 
       return {
         ...(element.attributes!.id && { id: element.attributes!.id as string }),
-        src: scxmlToMachine(content, options),
-        autoForward: element.attributes!.autoforward === 'true'
+        src: scxmlToMachine(content, options)
       };
     });
 

packages/core/src/types.ts

@@ -396,12 +396,6 @@ export interface InvokeDefinition<
    * The source of the actor's behavior to be invoked
    */
   src: string;
-  /**
-   * If `true`, events sent to the parent service will be forwarded to the invoked service.
-   *
-   * Default: `false`
-   */
-  autoForward?: boolean;
 
   input?: Mapper<TContext, TEvent, any> | any;
   /**
@@ -530,12 +524,6 @@ export interface InvokeConfig<
    * The source of the machine to be invoked, or the machine itself.
    */
   src: string | ActorBehavior<any, any>; // TODO: fix types
-  /**
-   * If `true`, events sent to the parent service will be forwarded to the invoked service.
-   *
-   * Default: `false`
-   */
-  autoForward?: boolean;
 
   input?: Mapper<TContext, TEvent, any> | any;
   /**
@@ -1142,7 +1130,6 @@ export interface InvokeAction {
   type: ActionTypes.Invoke;
   src: string | ActorRef<any>;
   id: string;
-  autoForward?: boolean;
   exec?: undefined;
   meta: MetaObject | undefined;
 }
@@ -1160,7 +1147,6 @@ export interface InvokeActionObject extends BaseActionObject {
   params: {
     src: string | ActorRef<any>;
     id: string;
-    autoForward?: boolean;
     exec?: undefined;
     ref?: ActorRef<any>;
     meta: MetaObject | undefined;
@@ -1620,13 +1606,6 @@ export interface InterpreterOptions<_TActorBehavior extends AnyActorBehavior> {
    */
   devTools?: boolean | DevToolsAdapter; // TODO: add enhancer options
 
-  /**
-   * If `true`, events from the parent will be sent to this interpreter.
-   *
-   * Default: `false`
-   */
-  autoForward?: boolean;
-
   sync?: boolean;
 
   /**

packages/core/test/invoke.test.ts

@@ -118,16 +118,18 @@ describe('invoke', () => {
           start: {
             invoke: {
               src: 'child',
-              id: 'someService',
-              autoForward: true
+              id: 'someService'
             },
             always: {
               target: 'stop',
               guard: (ctx) => ctx.count === 2
             },
             on: {
               INC: {
-                actions: assign({ count: (ctx) => ctx.count + 1 })
+                actions: [
+                  assign({ count: (ctx) => ctx.count + 1 }),
+                  sendTo('someService', { type: 'INC' })
+                ]
               }
             }
           },
@@ -162,7 +164,7 @@ describe('invoke', () => {
       .start();
   });
 
-  it('should forward events to services if autoForward: true', () => {
+  it('can forward events to services', () => {
     const childMachine = createMachine({
       id: 'child',
       initial: 'init',
@@ -190,16 +192,17 @@ describe('invoke', () => {
           start: {
             invoke: {
               src: 'child',
-              id: 'someService',
-              autoForward: true
+              id: 'someService'
             },
             always: {
               target: 'stop',
               guard: (ctx) => ctx.count === -3
             },
             on: {
               DEC: { actions: assign({ count: (ctx) => ctx.count - 1 }) },
-              FORWARD_DEC: undefined
+              FORWARD_DEC: {
+                actions: sendTo('child', { type: 'FORWARD_DEC' })
+              }
             }
           },
           stop: {
@@ -221,7 +224,7 @@ describe('invoke', () => {
       })
       .onDone(() => {
         // 1. The 'parent' machine will not do anything (inert transition)
-        // 2. The 'FORWARD_DEC' event will be forwarded to the 'child' machine (autoForward: true)
+        // 2. The 'FORWARD_DEC' event will be "forwarded" to the 'child' machine
         // 3. On the 'child' machine, the 'FORWARD_DEC' event sends the 'DEC' action to the 'parent' thrice
         // 4. The context of the 'parent' machine will be updated from 2 to -1
 
@@ -232,7 +235,7 @@ describe('invoke', () => {
     service.send({ type: 'FORWARD_DEC' });
   });
 
-  it('should forward events to services if autoForward: true before processing them', (done) => {
+  it('another forwarding pattern', (done) => {
     const actual: string[] = [];
 
     const childMachine = createMachine<{ count: number }>({
@@ -284,8 +287,8 @@ describe('invoke', () => {
         },
         invokeChild: {
           invoke: {
+            id: 'child',
             src: childMachine,
-            autoForward: true,
             onDone: {
               target: 'done',
               actions: assign((_ctx, event) => ({
@@ -295,9 +298,12 @@ describe('invoke', () => {
           },
           on: {
             INCREMENT: {
-              actions: () => {
-                actual.push('parent got INCREMENT');
-              }
+              actions: [
+                () => {
+                  actual.push('parent got INCREMENT');
+                },
+                sendTo('child', { type: 'INCREMENT' })
+              ]
             }
           }
         },
@@ -315,12 +321,12 @@ describe('invoke', () => {
       .onDone(() => {
         expect(state.context).toEqual({ countedTo: 3 });
         expect(actual).toEqual([
-          'child got INCREMENT',
           'parent got INCREMENT',
           'child got INCREMENT',
           'parent got INCREMENT',
           'child got INCREMENT',
-          'parent got INCREMENT'
+          'parent got INCREMENT',
+          'child got INCREMENT'
         ]);
         done();
       })
@@ -516,8 +522,7 @@ describe('invoke', () => {
           start: {
             invoke: {
               src: 'child',
-              id: 'someService',
-              autoForward: true
+              id: 'someService'
             },
             on: {
               STOP: 'stop'

packages/core/test/json.test.ts

@@ -19,10 +19,10 @@ describe('json', () => {
         number: 0,
         string: 'hello'
       },
-      invoke: [{ id: 'invokeId', src: 'invokeSrc', autoForward: true }],
+      invoke: [{ id: 'invokeId', src: 'invokeSrc' }],
       states: {
         testActions: {
-          invoke: [{ id: 'invokeId', src: 'invokeSrc', autoForward: true }],
+          invoke: [{ id: 'invokeId', src: 'invokeSrc' }],
           entry: [
             'stringActionType',
             {

packages/core/test/scxml.test.ts

@@ -170,8 +170,8 @@ const testGroups: Record<string, string[]> = {
     // 'test225.txml', // unique invokeids generated at invoke time
     // 'test226.txml', // <invoke src="...">
     'test228.txml',
-    'test229.txml',
-    // 'test230.txml', // Manual test (TODO: check)
+    // 'test229.txml', // autoForward not supported in v5
+    // 'test230.txml', // autoForward not supported in v5
     'test232.txml',
     // 'test233.txml', // <finalize> not implemented yet
     // 'test234.txml', // <finalize> not implemented yet

packages/xstate-scxml/src/scxml.ts

@@ -460,8 +460,7 @@ function toConfig(
 
       return {
         ...(element.attributes!.id && { id: element.attributes!.id as string }),
-        src: scxmlToMachine(content, options),
-        autoForward: element.attributes!.autoforward === 'true'
+        src: scxmlToMachine(content, options)
       };
     });