[v5] Behavior to logic (#4041)

* behavior -> logic # Conflicts: # packages/core/src/State.ts # packages/core/src/StateMachine.ts # packages/core/src/StateNode.ts # packages/core/src/actors/callback.ts # packages/core/src/actors/observable.ts # packages/core/src/types.ts # packages/core/src/utils.ts # packages/core/test/invoke.test.ts # packages/xstate-test/test/paths.test.ts * Update packages/xstate-solid/test/createSpawn.test.tsx Co-authored-by: Mateusz Burzyński <mateuszburzynski@gmail.com> * Rename * createActorContext machine -> logic * Promise test for createActorContext * rename leftover type helper * use ActorLogic in test+graph * Rename remaining references to behaviors * Changeset --------- Co-authored-by: Mateusz Burzyński <mateuszburzynski@gmail.com>
statelyai · Jun 1, 2023 · 50fe8cd · 50fe8cd
1 parent c59bb6a
commit 50fe8cd
Show file tree

Hide file tree

Showing 41 changed files with 378 additions and 383 deletions.
diff --git a/.changeset/poor-bottles-sort.md b/.changeset/poor-bottles-sort.md
@@ -0,0 +1,8 @@
+---
+'xstate': major
+'@xstate/fsm': major
+'@xstate/react': major
+'@xstate/vue': major
+---
+
+Instances of "behavior" in the codebase have been replaced with "actor logic".
diff --git a/packages/core/src/StateMachine.ts b/packages/core/src/StateMachine.ts
@@ -25,8 +25,8 @@ import type {
 } from './typegenTypes.ts';
 import type {
   ActorContext,
+  ActorLogic,
   ActorMap,
-  ActorBehavior,
   EventObject,
   InternalMachineImplementations,
   InvokeActionObject,
@@ -72,7 +72,7 @@ export class StateMachine<
     TActorMap
   >
 > implements
-    ActorBehavior<
+    ActorLogic<
       TEvent,
       State<TContext, TEvent, TResolvedTypesMeta>,
       State<TContext, TEvent, TResolvedTypesMeta>,
@@ -418,17 +418,17 @@ export class StateMachine<
       const childState = actorData.state;
       const src = actorData.src;
 
-      const behavior = src
+      const logic = src
         ? resolveReferencedActor(this.options.actors[src])?.src
         : undefined;
 
-      if (!behavior) {
+      if (!logic) {
         return;
       }
 
-      const actorState = behavior.restoreState?.(childState, _actorCtx);
+      const actorState = logic.restoreState?.(childState, _actorCtx);
 
-      const actorRef = interpret(behavior, {
+      const actorRef = interpret(logic, {
         id: actorId,
         state: actorState
       });

diff --git a/packages/core/src/StateNode.ts b/packages/core/src/StateNode.ts
@@ -23,7 +23,8 @@ import type {
   TransitionDefinitionMap,
   InitialTransitionDefinition,
   MachineContext,
-  BaseActionObject
+  BaseActionObject,
+  AnyActorLogic
 } from './types.ts';
 import type { State } from './State.ts';
 import * as actionTypes from './actionTypes.ts';
@@ -250,15 +251,16 @@ export class StateNode<
   }
 
   /**
-   * The behaviors invoked as actors by this state node.
+   * The logic invoked as actors by this state node.
    */
   public get invoke(): Array<InvokeDefinition<TContext, TEvent>> {
     return memo(this, 'invoke', () =>
       toArray(this.config.invoke).map((invocable, i) => {
         const generatedId = createInvokeId(this.id, i);
         const invokeConfig = toInvokeConfig(invocable, generatedId);
         const resolvedId = invokeConfig.id || generatedId;
-        const { src, systemId } = invokeConfig;
+        const src = invokeConfig.src as string | AnyActorLogic;
+        const { systemId } = invokeConfig;
 
         const resolvedSrc = isString(src)
           ? src

diff --git a/packages/core/src/actors/callback.ts b/packages/core/src/actors/callback.ts
@@ -1,7 +1,7 @@
 import {
   InvokeCallback,
   Receiver,
-  ActorBehavior,
+  ActorLogic,
   EventObject,
   AnyEventObject
 } from '../types';
@@ -18,8 +18,8 @@ export interface CallbackInternalState {
 
 export function fromCallback<TEvent extends EventObject>(
   invokeCallback: InvokeCallback
-): ActorBehavior<TEvent, undefined, CallbackInternalState> {
-  const behavior: ActorBehavior<TEvent, undefined, CallbackInternalState> = {
+): ActorLogic<TEvent, undefined, CallbackInternalState> {
+  const logic: ActorLogic<TEvent, undefined, CallbackInternalState> = {
     config: invokeCallback,
     start: (_state, { self }) => {
       self.send({ type: startSignalType } as TEvent);
@@ -89,5 +89,5 @@ export function fromCallback<TEvent extends EventObject>(
     getPersistedState: ({ input }) => input
   };
 
-  return behavior;
+  return logic;
 }
diff --git a/packages/core/src/actors/index.ts b/packages/core/src/actors/index.ts
@@ -31,7 +31,7 @@ export type LifecycleSignalType =
   | typeof stopSignalType;
 
 /**
- * An object that expresses the behavior of an actor in reaction to received events,
+ * An object that expresses the actor logic in reaction to received events,
  * as well as an optionally emitted stream of values.
  *
  * @template TReceived The received event
@@ -48,7 +48,7 @@ export function isActorRef(item: any): item is ActorRef<any> {
 
 // TODO: refactor the return type, this could be written in a better way
 // but it's best to avoid unneccessary breaking changes now
-// @deprecated use `interpret(behavior)` instead
+// @deprecated use `interpret(actorLogic)` instead
 export function toActorRef<
   TEvent extends EventObject,
   TSnapshot = any,
@@ -70,8 +70,8 @@ export function toActorRef<
   };
 }
 
-const emptyBehavior = fromTransition((_) => undefined, undefined);
+const emptyLogic = fromTransition((_) => undefined, undefined);
 
 export function createEmptyActor(): ActorRef<AnyEventObject, undefined> {
-  return interpret(emptyBehavior);
+  return interpret(emptyLogic);
 }
diff --git a/packages/core/src/actors/observable.ts b/packages/core/src/actors/observable.ts
@@ -1,9 +1,4 @@
-import {
-  Subscribable,
-  ActorBehavior,
-  EventObject,
-  Subscription
-} from '../types';
+import { Subscribable, ActorLogic, EventObject, Subscription } from '../types';
 import { stopSignalType } from '../actors';
 
 export interface ObservableInternalState<T> {
@@ -21,7 +16,7 @@ export type ObservablePersistedState<T> = Omit<
 // TODO: this likely shouldn't accept TEvent, observable actor doesn't accept external events
 export function fromObservable<T, TEvent extends EventObject>(
   observableCreator: ({ input }: { input: any }) => Subscribable<T>
-): ActorBehavior<
+): ActorLogic<
   TEvent,
   T | undefined,
   ObservableInternalState<T>,
@@ -32,7 +27,7 @@ export function fromObservable<T, TEvent extends EventObject>(
   const completeEventType = '$$xstate.complete';
 
   // TODO: add event types
-  const behavior: ActorBehavior<
+  const logic: ActorLogic<
     any,
     T | undefined,
     ObservableInternalState<T>,
@@ -123,21 +118,21 @@ export function fromObservable<T, TEvent extends EventObject>(
     })
   };
 
-  return behavior;
+  return logic;
 }
 
 /**
- * Creates an event observable behavior that listens to an observable
+ * Creates event observable logic that listens to an observable
  * that delivers event objects.
  *
  *
  * @param lazyObservable A function that creates an observable
- * @returns An event observable behavior
+ * @returns Event observable logic
  */
 
 export function fromEventObservable<T extends EventObject>(
   lazyObservable: ({ input }: { input: any }) => Subscribable<T>
-): ActorBehavior<
+): ActorLogic<
   EventObject,
   T | undefined,
   ObservableInternalState<T>,
@@ -147,7 +142,7 @@ export function fromEventObservable<T extends EventObject>(
   const completeEventType = '$$xstate.complete';
 
   // TODO: event types
-  const behavior: ActorBehavior<
+  const logic: ActorLogic<
     any,
     T | undefined,
     ObservableInternalState<T>,
@@ -226,5 +221,5 @@ export function fromEventObservable<T extends EventObject>(
     })
   };
 
-  return behavior;
+  return logic;
 }
diff --git a/packages/core/src/actors/promise.ts b/packages/core/src/actors/promise.ts
@@ -1,4 +1,4 @@
-import { ActorBehavior } from '../types';
+import { ActorLogic } from '../types';
 import { stopSignalType } from '../actors';
 
 export interface PromiseInternalState<T> {
@@ -10,12 +10,12 @@ export interface PromiseInternalState<T> {
 export function fromPromise<T>(
   // TODO: add types
   promiseCreator: ({ input }: { input: any }) => PromiseLike<T>
-): ActorBehavior<{ type: string }, T | undefined, PromiseInternalState<T>> {
+): ActorLogic<{ type: string }, T | undefined, PromiseInternalState<T>> {
   const resolveEventType = '$$xstate.resolve';
   const rejectEventType = '$$xstate.reject';
 
   // TODO: add event types
-  const behavior: ActorBehavior<
+  const logic: ActorLogic<
     | {
         type: typeof resolveEventType;
         data: T;
@@ -99,5 +99,5 @@ export function fromPromise<T>(
     restoreState: (state) => state
   };
 
-  return behavior;
+  return logic;
 }
diff --git a/packages/core/src/actors/transition.ts b/packages/core/src/actors/transition.ts
@@ -1,18 +1,13 @@
-import {
-  ActorBehavior,
-  ActorContext,
-  ActorSystem,
-  EventObject
-} from '../types';
+import { ActorLogic, ActorContext, ActorSystem, EventObject } from '../types';
 
 /**
- * Returns an actor behavior from a transition function and its initial state.
+ * Returns actor logic from a transition function and its initial state.
  *
  * A transition function is a function that takes the current state and an event and returns the next state.
  *
  * @param transition The transition function that returns the next state given the current state and event.
  * @param initialState The initial state of the transition function.
- * @returns An actor behavior
+ * @returns Actor logic
  */
 export function fromTransition<
   TState,
@@ -25,8 +20,8 @@ export function fromTransition<
     actorContext: ActorContext<TEvent, TState, TSystem>
   ) => TState,
   initialState: TState | (({ input }: { input: any }) => TState) // TODO: type
-): ActorBehavior<TEvent, TState, TState> {
-  const behavior: ActorBehavior<TEvent, TState, TState, TState> = {
+): ActorLogic<TEvent, TState, TState> {
+  const logic: ActorLogic<TEvent, TState, TState, TState> = {
     config: transition,
     transition: (state, event, actorContext) => {
       return transition(state, event as TEvent, actorContext as any);
@@ -41,5 +36,5 @@ export function fromTransition<
     restoreState: (state) => state
   };
 
-  return behavior;
+  return logic;
 }
diff --git a/packages/core/src/dev/redux.ts b/packages/core/src/dev/redux.ts
@@ -28,7 +28,7 @@ export const createReduxDevTools = (
             ...(options ? options.features : undefined)
           }
         },
-        service.behavior
+        service.logic
       );
 
       service.subscribe((state) => {