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.

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

Ensure event payloads are typed as JSON #700

Draft
wants to merge 3 commits into
base: main
Choose a base branch
from

Conversation

jpwilliams
Copy link
Member

Summary

Warning

This is a breaking change for some builds.

This PR ensures that, similar to step.run() outputs, event data is also represented as being (de)serialized with JSON, stripping fields such as Date.

There are ongoing discussions on the appropriateness and typing application of middleware-based transformers (see #160), but for now we should make sure that they the typing correctly represents the runtime values.

Even though this is fixing a misrepresentation of an event's data, it could still break builds for users pushing event.data into other formats. Thus we cannot ship this until v4.

Checklist

  • Added a docs PR that references this PR N/A Bug fix
  • Added unit/integration tests
  • Added changesets if applicable

Related

@jpwilliams jpwilliams added the Bug Something isn't working label Sep 6, 2024
@jpwilliams jpwilliams self-assigned this Sep 6, 2024
Copy link

changeset-bot bot commented Sep 6, 2024

⚠️ No Changeset found

Latest commit: bd64e5b

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@inngest-release-bot inngest-release-bot added the 📦 inngest Affects the `inngest` package label Sep 6, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Bug Something isn't working 📦 inngest Affects the `inngest` package
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants