Deprecate send() action creator
#3393
Conversation
🦋 Changeset detectedLatest commit: 2637bab The changes in this PR will be included in the next version bump. This PR includes changesets to release 1 package
Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
👇 Click on the image for a new way to code review
Legend |
|
This pull request is automatically built and testable in CodeSandbox. To see build info of the built libraries, click here or the icon next to each commit SHA. |
|
@Andarist Is this good to go? |
packages/core/src/actions.ts
Outdated
| ): RaiseAction<TEvent> | SendAction<TContext, AnyEventObject, TEvent> { | ||
| if (!isString(event)) { | ||
| return send(event, { to: SpecialTargets.Internal }); | ||
| event: Event<TEvent>, |
There was a problem hiding this comment.
This doesn't support expressions right now. I think that we should bring it to here - otherwise not all sends can be refactored to raise
packages/core/src/actions.ts
Outdated
| ): RaiseAction<TEvent> { | ||
| if (!isString(event) || options) { | ||
| return send(event, { ...options, to: SpecialTargets.Internal }) as any; | ||
| } |
There was a problem hiding this comment.
IMHO we should stop piggybacking on send here. It's especially important right now because you are suppressing the type checker to satisfy the declared return type. I wouldn't be surprised if we miss something that should be handled because of that, now or in the future. At times, we are checking action.type after all.
packages/core/test/types.test.ts
Outdated
| @@ -253,23 +253,23 @@ describe('Raise events', () => { | |||
| { | |||
| actions: raise({ | |||
| type: 'ALOHA' | |||
| }) as any /* TODO: FIX */, | |||
| }), | |||
There was a problem hiding this comment.
I created a spike for type-related improvements around this here: #3694
packages/core/test/actions.test.ts
Outdated
| service.send('TO_B'); | ||
| }); | ||
|
|
||
| it('should be able to send an event to itself', (done) => { |
There was a problem hiding this comment.
This test case has the very same title as the one above. This should be fixed as I'm not exactly sure what this test is testing here.
packages/core/test/actions.test.ts
Outdated
| const service = interpret(machine).start(); | ||
|
|
||
| service.onDone(() => done()); | ||
|
|
||
| // Ensures that the delayed self-event is sent when in the `b` state | ||
| service.send('TO_B'); |
There was a problem hiding this comment.
This test isn't testing anything right now - it has 0 expectations ;p
Andarist
force-pushed
the
davidkpiano/deprecate-send
branch
3 times, most recently
from
466d4b1
to
b0bb50d
Compare
Co-authored-by: Mateusz Burzyński <mateuszburzynski@gmail.com>
Co-authored-by: Mateusz Burzyński <mateuszburzynski@gmail.com>
Co-authored-by: Mateusz Burzyński <mateuszburzynski@gmail.com>
Andarist
force-pushed
the
davidkpiano/deprecate-send
branch
from
b0bb50d
to
1711278
Compare
# Conflicts: # packages/core/src/StateNode.ts # packages/core/src/actions.ts # packages/core/src/interpreter.ts # packages/core/src/types.ts # packages/core/test/interpreter.test.ts # packages/xstate-scxml/src/index.ts
# Conflicts: # packages/core/src/actions.ts
Andarist
force-pushed
the
davidkpiano/deprecate-send
branch
from
b387ec8
to
dd989c5
Compare
# Conflicts: # packages/xstate-react/src/useInterpret.ts
This PR deprecates the
send()action creator in favor ofsendTo()andraise().