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

Fix path matching types getting lost in recursive types #354

Merged
merged 5 commits into from
Oct 10, 2023

Conversation

jpwilliams
Copy link
Member

@jpwilliams jpwilliams commented Oct 10, 2023

Summary

Fixes a "Type instantiation is excessively deep and possibly infinite" bug when attempting to generate paths for events with recursive types, such as a common JsonValue type.

type JsonObject = { [Key in string]?: JsonValue };
type JsonArray = Array<JsonValue>;
type JsonValue =
  | string
  | number
  | boolean
  | JsonObject
  | JsonArray
  | null;

We refactor the way paths are generated a little here, most notably ensuring we skip known deep/recursive types and don't needlessly iterate those we've seen before.

Checklist

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

@jpwilliams jpwilliams added Bug Something isn't working prerelease/inngest Create snapshot releases for a PR for the "inngest" package. labels Oct 10, 2023
@jpwilliams jpwilliams self-assigned this Oct 10, 2023
@changeset-bot
Copy link

changeset-bot bot commented Oct 10, 2023

🦋 Changeset detected

Latest commit: 3e516ee

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
Copy link
Collaborator

inngest-release-bot commented Oct 10, 2023

A user has added the prerelease/inngest label, so this PR will be published to npm with the tag pr-354. It will be updated with the latest changes as you push commits to this PR.

You can install this prerelease version with:

npm install inngest@pr-354

The last release was built and published from 3e516ee.

@jpwilliams jpwilliams merged commit e2f68d6 into main Oct 10, 2023
23 checks passed
@jpwilliams jpwilliams deleted the fix/recursive-types-paths branch October 10, 2023 13:36
jpwilliams pushed a commit that referenced this pull request Oct 10, 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
## inngest@3.1.1

### Patch Changes

- [#354](#354)
[`e2f68d6`](e2f68d6)
Thanks [@jpwilliams](https://github.com/jpwilliams)! - Fix path matching
types getting lost in certain recursive event types

- [#350](#350)
[`933b998`](933b998)
Thanks [@jpwilliams](https://github.com/jpwilliams)! - Separate Zod
typing from library, enabling minor-agnostic versioning support

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
Labels
Bug Something isn't working prerelease/inngest Create snapshot releases for a PR for the "inngest" package.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants