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

Do not allow objectish [] event data; only actual objects #655

Merged
merged 2 commits into from
Jul 18, 2024

Conversation

jpwilliams
Copy link
Member

@jpwilliams jpwilliams commented Jul 18, 2024

Summary

Disallows setting the data of an event to something that is not an {} object.

Checklist

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

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

changeset-bot bot commented Jul 18, 2024

🦋 Changeset detected

Latest commit: 23f24f7

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 1 package
Name Type
inngest Patch

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

@inngest-release-bot inngest-release-bot added the 📦 inngest Affects the `inngest` package label Jul 18, 2024
@jpwilliams jpwilliams marked this pull request as ready for review July 18, 2024 15:54
@jpwilliams jpwilliams merged commit 12df420 into main Jul 18, 2024
42 checks passed
@jpwilliams jpwilliams deleted the fix/do-not-allow-objectish-event-data branch July 18, 2024 21:50
jpwilliams pushed a commit that referenced this pull request Jul 18, 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.21.1

### Patch Changes

- [#655](#655)
[`12df420`](12df420)
Thanks [@jpwilliams](https://github.com/jpwilliams)! - Do not allow
objectish `[]` for an event's `data` when providing schemas

This helps solve an issue whereby types would be happy but sending an
event fails at runtime.

Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
jpwilliams added a commit that referenced this pull request Jul 23, 2024
jpwilliams added a commit that referenced this pull request Jul 23, 2024
…660)

## Summary
<!-- Succinctly describe your change, providing context, what you've
changed, and why. -->

Revert the fix for disallowing "objectish" event data.

While `{}` are only allowed at runtime, `Record<string, unknown>` is not
valid for interfaces, which require index signatures. 🫠

## 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
- [ ] ~Added unit/integration tests~ N/A
- [x] Added changesets if applicable

## Related
<!-- A space for any related links, issues, or PRs. -->
<!-- Linear issues are autolinked. -->
<!-- e.g. - INN-123 -->
<!-- GitHub issues/PRs can be linked using shorthand. -->
<!-- e.g. "- inngest/inngest#123" -->
<!-- Feel free to remove this section if there are no applicable related
links.-->
- Reverts #655
- Closes #658 
- Closes #659
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.

3 participants