Simplify step returns such that JsonifyObject<> is hidden entirely
#371
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
prerelease/inngest
🦋 Changeset detectedLatest commit: 4746da6 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 |
|
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-371The last release was built and published from 4746da6. |
3 tasks
amh4r
approved these changes
Oct 25, 2023
Merged
jpwilliams
added a commit
that referenced
this pull request
Oct 26, 2023
## Summary <!-- Succinctly describe your change, providing context, what you've changed, and why. --> [`BigInt`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/BigInt)s are not natively parsed by JSON. Attempting to return a `BigInt` from a step or function will throw an error. This error was hard to see, which is fixed in #374. Our types reflect that `BigInt` is unparseable and will type it as `never`, though these were obscured from the user a touch, which is fixed in #371. For this reason, this PR ensures `BigInt`s are removed during parsing instead of throwing. We can investigate adding `BigInt` support across our SDKs past this fix; the `n` suffix seems an unwritten standard. ## Checklist <!-- Tick these items off as you progress. --> <!-- If an item isn't applicable, ideally please strikeout the item by wrapping it in "~~"" and suffix it with "N/A My reason for skipping this." --> <!-- e.g. "- [ ] ~~Added tests~~ N/A Only touches docs" --> - [ ] ~~Added a [docs PR](https://github.com/inngest/website) that references this PR~~ N/A - [x] Added unit/integration tests - [x] Added changesets if applicable ## Related - #371 - #374
jpwilliams
pushed a commit
that referenced
this pull request
Oct 26, 2023
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 ## [email protected] ### Patch Changes - [#371](#371) [`d45bfbd`](d45bfbd) Thanks [@jpwilliams](https://github.com/jpwilliams)! - Remove `JsonifyObject<>` wrapper from step output - it's now clearer to see the actual type of a step's result - [#375](#375) [`e19f9b4`](e19f9b4) Thanks [@jpwilliams](https://github.com/jpwilliams)! - Fix failing to parse `BigInt` during step/function result serialization; it is now correctly typed and returned as `never` - [#374](#374) [`dcafc2b`](dcafc2b) Thanks [@jpwilliams](https://github.com/jpwilliams)! - Fixed an issue where an error log wasn't shown if execution result parsing failed, such as in the case of serialization failures 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
Step results are serialized and deserialized while being pushed to/from Inngest, so step returns are typed as JSON to make this clear.
These returns still came back wrapped in
JsonifyObject<>, though, meaning they didn't actually show the resulting changes unless the user started to attempt to use them. This small change ensures we display the resulting type correctly, free of any wrappers.Checklist
Added a docs PR that references this PRN/AAdded unit/integration testsN/A