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] Add snapshot update feature to promise logic #5132

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

[core] Add snapshot update feature to promise logic #5132

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
284ce32
Add snapshot update feature to promises
davidkpiano Dec 2, 2024
6a17ed6
Update packages/core/src/actors/promise.ts
davidkpiano Dec 4, 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
73 changes: 55 additions & 18 deletions packages/core/src/actors/promise.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,24 +5,42 @@ import {
ActorRefFromLogic,
AnyActorRef,
EventObject,
MachineContext,
NonReducibleUnknown,
Snapshot
Snapshot,
StateValue
} from '../types.ts';

export type PromiseSnapshot<TOutput, TInput> = Snapshot<TOutput> & {
input: TInput | undefined;
};
export interface PromiseState {
value?: StateValue;
context?: MachineContext;
}
Comment on lines +14 to +17
Copy link
Member

Choose a reason for hiding this comment

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

it would be nice to add some type-level tests for usage with discriminated unions, including tests that would exercise .getSnapshot()


export type PromiseSnapshot<
TOutput,
TInput,
TPromiseState extends PromiseState
> = Snapshot<TOutput> &
TPromiseState & {
input: TInput | undefined;
};

const XSTATE_PROMISE_RESOLVE = 'xstate.promise.resolve';
const XSTATE_PROMISE_REJECT = 'xstate.promise.reject';
const XSTATE_PROMISE_UPDATE = 'xstate.promise.update';

export type PromiseActorLogic<
TOutput,
TInput = unknown,
TEmitted extends EventObject = EventObject
TEmitted extends EventObject = EventObject,
TPromiseState extends PromiseState = {}
> = ActorLogic<
PromiseSnapshot<TOutput, TInput>,
{ type: string; [k: string]: unknown },
PromiseSnapshot<TOutput, TInput, TPromiseState>,
// | { type: string; [k: string]: unknown }
davidkpiano marked this conversation as resolved.
Show resolved Hide resolved
| { type: typeof XSTATE_PROMISE_RESOLVE; data: TOutput }
| { type: typeof XSTATE_PROMISE_REJECT; data: unknown }
| { type: typeof XSTATE_STOP }
| { type: typeof XSTATE_PROMISE_UPDATE; state: TPromiseState },
TInput, // input
AnyActorSystem,
TEmitted // TEmitted
Expand Down Expand Up @@ -61,9 +79,10 @@ export type PromiseActorLogic<
*
* @see {@link fromPromise}
*/
export type PromiseActorRef<TOutput> = ActorRefFromLogic<
PromiseActorLogic<TOutput, unknown>
>;
export type PromiseActorRef<
TOutput,
TPromiseState extends PromiseState = {}
> = ActorRefFromLogic<PromiseActorLogic<TOutput, unknown, any, TPromiseState>>;

const controllerMap = new WeakMap<AnyActorRef, AbortController>();

Expand Down Expand Up @@ -120,26 +139,29 @@ const controllerMap = new WeakMap<AnyActorRef, AbortController>();
export function fromPromise<
TOutput,
TInput = NonReducibleUnknown,
TEmitted extends EventObject = EventObject
TEmitted extends EventObject = EventObject,
TPromiseState extends PromiseState = {}
>(
promiseCreator: ({
input,
system,
self,
signal,
emit
emit,
update
}: {
/** Data that was provided to the promise actor */
input: TInput;
/** The actor system to which the promise actor belongs */
system: AnyActorSystem;
/** The parent actor of the promise actor */
self: PromiseActorRef<TOutput>;
self: PromiseActorRef<TOutput, TPromiseState>;
signal: AbortSignal;
emit: (emitted: TEmitted) => void;
update: (state: TPromiseState) => void;
}) => PromiseLike<TOutput>
): PromiseActorLogic<TOutput, TInput, TEmitted> {
const logic: PromiseActorLogic<TOutput, TInput, TEmitted> = {
): PromiseActorLogic<TOutput, TInput, TEmitted, TPromiseState> {
const logic: PromiseActorLogic<TOutput, TInput, TEmitted, TPromiseState> = {
config: promiseCreator,
transition: (state, event, scope) => {
if (state.status !== 'active') {
Expand All @@ -148,7 +170,7 @@ export function fromPromise<

switch (event.type) {
case XSTATE_PROMISE_RESOLVE: {
const resolvedValue = (event as any).data;
const resolvedValue = event.data;
return {
...state,
status: 'done',
Expand All @@ -160,7 +182,7 @@ export function fromPromise<
return {
...state,
status: 'error',
error: (event as any).data,
error: event.data,
input: undefined
};
case XSTATE_STOP: {
Expand All @@ -171,6 +193,16 @@ export function fromPromise<
input: undefined
};
}
case XSTATE_PROMISE_UPDATE: {
const {
state: { context, value }
} = event;
return {
...state,
context,
value
};
}
default:
return state;
}
Expand All @@ -189,7 +221,12 @@ export function fromPromise<
system,
self,
signal: controller.signal,
emit
emit,
update: (state) =>
self.send({
type: XSTATE_PROMISE_UPDATE,
state
})
})
);

Expand Down
41 changes: 40 additions & 1 deletion packages/core/test/actorLogic.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,8 @@ import {
createActor,
AnyActorLogic,
Snapshot,
ActorLogic
ActorLogic,
toPromise
} from '../src/index.ts';
import {
fromCallback,
Expand Down Expand Up @@ -464,6 +465,44 @@ describe('promise logic (fromPromise)', () => {
const fn2 = signalListenerList[1];
expect(fn2).toHaveBeenCalled();
});

it('can emit updates', async () => {
const p = fromPromise(async ({ update }) => {
update({ value: 'starting' });
update({ value: 'loading', context: { progress: 0.6 } });
update({ value: 'finished' });
return 'done data';
});

const stuff: Array<{}> = [];

const actor = createActor(p);
actor.subscribe((s) => {
stuff.push(s);
});
actor.start();

const res = await toPromise(actor);

expect(res).toEqual('done data');

expect(stuff).toEqual(
expect.arrayContaining([
expect.objectContaining({}),
Copy link
Member

Choose a reason for hiding this comment

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

it feels like a better "assertion" could be put here, this one looks suspicious - maybe we could use { status: 'active' } or smth like that?

Copy link
Member

Choose a reason for hiding this comment

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

then it would make sense to include the status in all of those assertions~

expect.objectContaining({ value: 'starting', context: undefined }),
expect.objectContaining({
value: 'loading',
context: { progress: 0.6 }
}),
expect.objectContaining({ value: 'finished', context: undefined }),
Copy link
Member

Choose a reason for hiding this comment

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

I feel like this test case is too big. "can emit updates" is too broad and doesn't give me much insight into what is actually expected because it reads as "it works".

For instance, I noticed that an update with just one of those fields would wipe out the other one. I was wondering how deliberate that was and if we have a test for it. It turns out we do - but it's just so buried in this item here. It's hard to tell if this was intentional or accidental. I think it was intentional and that's fine - but my point stands: a test with so many details in it isn't particularly informative/explicit about its intentions

expect.objectContaining({
status: 'done',
output: 'done data',
value: 'finished'
})
])
);
});
});

describe('transition function logic (fromTransition)', () => {
Expand Down
Loading