Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[core] Tighten StateMachine types and fix issue #5008 #5009

Merged
merged 7 commits into from
Jul 31, 2024
Merged

[core] Tighten StateMachine types and fix issue #5008 #5009

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
a5499a5
Add failing test
davidkpiano Jul 31, 2024
1a005c7
Merge
davidkpiano Jul 31, 2024
40d065d
Make all StateMachine type params required
davidkpiano Jul 31, 2024
159d976
Changeset?
davidkpiano Jul 31, 2024
6e9eee1
Update packages/core/src/types.ts
davidkpiano Jul 31, 2024
59e06c6
Don't need the any check after all
davidkpiano Jul 31, 2024
3059beb
Merge branch 'davidkpiano/5008-bug-5170-property-machine-is-missing-i…
davidkpiano Jul 31, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .changeset/cold-suits-build.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
'xstate': patch
---

The internal types for `StateMachine<...>` have been improved so that all type params are required, to prevent errors when using the types. This fixes weird issues like #5008.
23 changes: 14 additions & 9 deletions packages/core/src/State.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,8 @@ import type {
MetaObject,
StateSchema,
StateId,
SnapshotStatus
SnapshotStatus,
SnapshotFrom
} from './types.ts';
import { matchesState } from './utils.ts';

Expand Down Expand Up @@ -56,7 +57,7 @@ interface MachineSnapshotBase<
TTag extends string,
TOutput,
TMeta,
TConfig extends StateSchema = StateSchema
TConfig extends StateSchema
> {
/** The state machine that produced this state snapshot. */
machine: StateMachine<
Expand All @@ -72,7 +73,8 @@ interface MachineSnapshotBase<
unknown,
TOutput,
EventObject, // TEmitted
any // TMeta
any, // TMeta
TConfig
>;
/** The tags of the active state nodes that represent the current state value. */
tags: Set<string>;
Expand Down Expand Up @@ -198,7 +200,7 @@ interface ErrorMachineSnapshot<
TTag extends string,
TOutput,
TMeta extends MetaObject,
TConfig extends StateSchema = StateSchema
TConfig extends StateSchema
> extends MachineSnapshotBase<
TContext,
TEvent,
Expand All @@ -222,7 +224,7 @@ interface StoppedMachineSnapshot<
TTag extends string,
TOutput,
TMeta extends MetaObject,
TConfig extends StateSchema = StateSchema
TConfig extends StateSchema
> extends MachineSnapshotBase<
TContext,
TEvent,
Expand All @@ -246,7 +248,7 @@ export type MachineSnapshot<
TTag extends string,
TOutput,
TMeta extends MetaObject,
TConfig extends StateSchema = StateSchema
TConfig extends StateSchema
> =
| ActiveMachineSnapshot<
TContext,
Expand Down Expand Up @@ -355,7 +357,8 @@ export function createMachineSnapshot<
TChildren extends Record<string, AnyActorRef | undefined>,
TStateValue extends StateValue,
TTag extends string,
TMeta extends MetaObject
TMeta extends MetaObject,
TStateSchema extends StateSchema
>(
config: StateConfig<TContext, TEvent>,
machine: AnyStateMachine
Expand All @@ -366,7 +369,8 @@ export function createMachineSnapshot<
TStateValue,
TTag,
undefined,
TMeta
TMeta,
TStateSchema
> {
return {
status: config.status as never,
Expand Down Expand Up @@ -413,7 +417,8 @@ export function getPersistedSnapshot<
TStateValue,
TTag,
TOutput,
TMeta
TMeta,
any // state schema
>,
options?: unknown
): Snapshot<unknown> {
Expand Down
9 changes: 5 additions & 4 deletions packages/core/src/StateMachine.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -66,9 +66,9 @@ export class StateMachine<
TTag extends string,
TInput,
TOutput,
TEmitted extends EventObject = EventObject, // TODO: remove default
TMeta extends MetaObject = MetaObject,
TConfig extends StateSchema = StateSchema
TEmitted extends EventObject,
TMeta extends MetaObject,
TConfig extends StateSchema
Comment on lines -69 to +71
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is the main change. By having these as optional, we were (well, at least I was) miscounting the generic type params, and some were erroneously using their default types.

> implements
ActorLogic<
MachineSnapshot<
Expand Down Expand Up @@ -199,7 +199,8 @@ export class StateMachine<
TInput,
TOutput,
TEmitted,
TMeta
TMeta,
TConfig
> {
const { actions, guards, actors, delays } = this.implementations;

Expand Down
6 changes: 4 additions & 2 deletions packages/core/src/StateNode.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -117,7 +117,8 @@ export class StateNode<
any, // input
any, // output
any, // emitted
any // meta
any, // meta
any // state schema
>;
/**
* The meta data associated with this state node, which will be returned in
Expand Down Expand Up @@ -368,7 +369,8 @@ export class StateNode<
any,
any,
any,
any // TMeta
any, // TMeta
any // TStateSchema
>,
event: TEvent
): TransitionDefinition<TContext, TEvent>[] | undefined {
Expand Down
8 changes: 5 additions & 3 deletions packages/core/src/createMachine.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
import { StateMachine } from './StateMachine.ts';
import { ResolvedStateMachineTypes } from './types.ts';
import { ResolvedStateMachineTypes, TODO } from './types.ts';
import {
AnyActorRef,
EventObject,
Expand Down Expand Up @@ -174,7 +174,8 @@ export function createMachine<
TInput,
TOutput,
TEmitted,
TMeta // TMeta
TMeta, // TMeta
TODO // TStateSchema
> {
return new StateMachine<
any,
Expand All @@ -189,6 +190,7 @@ export function createMachine<
any,
any,
any, // TEmitted
any // TMeta
any, // TMeta
any // TStateSchema
>(config as any, implementations as any);
}
20 changes: 16 additions & 4 deletions packages/core/src/stateUtils.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -660,7 +660,8 @@ function transitionAtomicNode<
any,
any,
any,
any // TMeta
any, // TMeta
any // TStateSchema
>,
event: TEvent
): Array<TransitionDefinition<TContext, TEvent>> | undefined {
Expand All @@ -687,7 +688,8 @@ function transitionCompoundNode<
any,
any,
any,
any // TMeta
any, // TMeta
any // TStateSchema
>,
event: TEvent
): Array<TransitionDefinition<TContext, TEvent>> | undefined {
Expand Down Expand Up @@ -721,7 +723,8 @@ function transitionParallelNode<
any,
any,
any,
any // TMeta
any, // TMeta
any // TStateSchema
>,
event: TEvent
): Array<TransitionDefinition<TContext, TEvent>> | undefined {
Expand Down Expand Up @@ -758,7 +761,16 @@ export function transitionNode<
>(
stateNode: AnyStateNode,
stateValue: StateValue,
snapshot: MachineSnapshot<TContext, TEvent, any, any, any, any, any>,
snapshot: MachineSnapshot<
TContext,
TEvent,
any,
any,
any,
any,
any,
any // TStateSchema
>,
event: TEvent
): Array<TransitionDefinition<TContext, TEvent>> | undefined {
// leaf node
Expand Down
51 changes: 34 additions & 17 deletions packages/core/src/types.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -110,7 +110,8 @@ export interface UnifiedArg<
StateValue,
string,
unknown,
TODO // TMeta
TODO, // TMeta
TODO // State schema
>,
TEvent,
AnyEventObject
Expand Down Expand Up @@ -139,7 +140,8 @@ export type InputFrom<T> = T extends StateMachine<
infer TInput,
infer _TOutput,
infer _TEmitted,
infer _TMeta
infer _TMeta,
infer _TStateSchema
>
? TInput
: T extends ActorLogic<
Expand Down Expand Up @@ -1122,7 +1124,8 @@ export type AnyStateMachine = StateMachine<
any, // input
any, // output
any, // emitted
any // TMeta
any, // TMeta
any // TStateSchema
>;

export type AnyStateConfig = StateConfig<any, AnyEventObject>;
Expand Down Expand Up @@ -1321,7 +1324,8 @@ export type ContextFactory<
StateValue,
string,
unknown,
TODO // TMeta
TODO, // TMeta
TODO // State schema
>,
TEvent,
AnyEventObject
Expand Down Expand Up @@ -1627,7 +1631,8 @@ export type Mapper<
StateValue,
string,
unknown,
TODO // TMeta
TODO, // TMeta
TODO // State schema
>,
TEvent,
AnyEventObject
Expand Down Expand Up @@ -1727,8 +1732,9 @@ export interface StateConfig<
any,
any,
any,
any,
any, // TMeta
any
any // TStateSchema
>;
}

Expand Down Expand Up @@ -1990,8 +1996,9 @@ export type ActorLogicFrom<T> = ReturnTypeOrValue<T> extends infer R
any,
any,
any,
any,
any, // TMeta
any
any // TStateSchema
>
? R
: R extends Promise<infer U>
Expand All @@ -2013,7 +2020,8 @@ export type ActorRefFrom<T> = ReturnTypeOrValue<T> extends infer R
infer _TInput,
infer TOutput,
infer TEmitted,
infer TMeta
infer TMeta,
infer TStateSchema
>
? ActorRef<
MachineSnapshot<
Expand All @@ -2023,7 +2031,8 @@ export type ActorRefFrom<T> = ReturnTypeOrValue<T> extends infer R
TStateValue,
TTag,
TOutput,
TMeta
TMeta,
TStateSchema
>,
TEvent,
TEmitted
Expand Down Expand Up @@ -2059,7 +2068,8 @@ export type InterpreterFrom<
infer TInput,
infer TOutput,
infer TEmitted,
infer TMeta
infer TMeta,
infer TStateSchema
>
? Actor<
ActorLogic<
Expand All @@ -2070,7 +2080,8 @@ export type InterpreterFrom<
TStateValue,
TTag,
TOutput,
TMeta
TMeta,
TStateSchema
>,
TEvent,
TInput,
Expand All @@ -2095,7 +2106,8 @@ export type MachineImplementationsFrom<
infer _TInput,
infer _TOutput,
infer TEmitted,
infer _TMeta
infer _TMeta,
infer _TStateSchema
>
? InternalMachineImplementations<
ResolvedStateMachineTypes<
Expand Down Expand Up @@ -2311,7 +2323,8 @@ type ResolveEventType<T> = ReturnTypeOrValue<T> extends infer R
infer _TInput,
infer _TOutput,
infer _TEmitted,
infer _TMeta
infer _TMeta,
infer _TStateSchema
>
? TEvent
: R extends MachineSnapshot<
Expand All @@ -2321,7 +2334,8 @@ type ResolveEventType<T> = ReturnTypeOrValue<T> extends infer R
infer _TStateValue,
infer _TTag,
infer _TOutput,
infer _TMeta
infer _TMeta,
infer _TStateSchema
>
? TEvent
: R extends ActorRef<infer _TSnapshot, infer TEvent, infer _TEmitted>
Expand Down Expand Up @@ -2349,7 +2363,8 @@ export type ContextFrom<T> = ReturnTypeOrValue<T> extends infer R
infer _TInput,
infer _TOutput,
infer _TEmitted,
infer _TMeta
infer _TMeta,
infer _TStateSchema
>
? TContext
: R extends MachineSnapshot<
Expand All @@ -2359,7 +2374,8 @@ export type ContextFrom<T> = ReturnTypeOrValue<T> extends infer R
infer _TStateValue,
infer _TTag,
infer _TOutput,
infer _TMeta
infer _TMeta,
infer _TStateSchema
>
? TContext
: R extends Actor<infer TActorLogic>
Expand All @@ -2371,12 +2387,13 @@ export type ContextFrom<T> = ReturnTypeOrValue<T> extends infer R
infer _TAction,
infer _TGuard,
infer _TDelay,
infer _TStateValue,
infer _TTag,
infer _TInput,
infer _TOutput,
infer _TEmitted,
infer _TMeta,
infer _TTypes
infer _TStateSchema
>
? TContext
: never
Expand Down
Loading
Loading