Ensure event payloads are typed as JSON #700
Draft
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
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 asDate
.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 PRN/A Bug fixRelated