Run onSendEvent middleware hooks for step.invoke() payloads
#503
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
jpwilliams
added
the
⬆️ improvement
🦋 Changeset detectedLatest commit: 507a51a 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 |
jpwilliams
added
the
prerelease/inngest
|
A user has added the prerelease/inngest label, so this PR will be published to npm with the tag You can install this prerelease version with: npm install inngest@pr-503The last release was built and published from 507a51a. |
Merged
jpwilliams
pushed a commit
that referenced
this pull request
Feb 28, 2024
This PR was opened by the [Changesets release](https://github.com/changesets/action) GitHub action. When you're ready to do a release, you can merge this and the packages will be published to npm automatically. If you're not ready to do a release yet, that's fine, whenever you add more changesets to main, this PR will be updated. # Releases ## inngest@3.15.2 ### Patch Changes - [#503](#503) [`f6088e0`](f6088e0) Thanks [@jpwilliams](https://github.com/jpwilliams)! - Fix `onSendEvent.transformInput()` middleware hooks not running for `step.invoke()` payloads Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
The
onSendEvent.transformInput()middleware hook is used to intercept events being sent and change either the shape or number of events being sent. When invoking a function viastep.invoke(), an internalinngest/function.invokedevent is sent, though theonSendEvent.transformInput()hook is not currently run.For middleware like
@inngest/middleware-encryption, this poses a challenge, as it can no longer encrypt fields when usingstep.invoke()instead ofstep.sendEvent().This PR ensures that the hook is also used for events being sent via
step.invoke(), such that middleware can now appropriately affect the payloads.Some notes on design decisions here:
onSendEventhook will be run for each individualstep.invoke(). This is the same functionality as callingstep.sendEvent()multiple times. While thetransformInput()hook supports batchedpayloads, this makes it difficult to determine which payloads have been affected if a user has omitted some from the returned array.step.sendEvent()orinngest.send(), we do not allow a developer to omit the event to be sent bystep.invoke()Checklist