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

INN-2152 Slim down "pretty errors" before sending to Inngest #360

Conversation

jpwilliams
Copy link
Member

@jpwilliams jpwilliams commented Oct 12, 2023

Summary

Slims down "pretty errors," whose name is already subjective, before sending them to Inngest, by stripping ANSI codes and removing immediate debugging information.

Before image
Before After

The UI could access the code being sent (e.g. AUTOMATIC_PARALLEL_INDEXING), but it's probably nicer to send this code inside serialized errors in the future, allowing the UI to provide hints and links to documentation, inclusive of short links such as https://innge.st/ERR_CODE_HERE.

Checklist

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

Related

@jpwilliams jpwilliams added the ⬆️ improvement Performance, reliability, or usability improvements label Oct 12, 2023
@jpwilliams jpwilliams self-assigned this Oct 12, 2023
@changeset-bot
Copy link

changeset-bot bot commented Oct 12, 2023

🦋 Changeset detected

Latest commit: 2ce4507

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

@tonyhb tonyhb merged commit 260dd75 into main Oct 16, 2023
23 checks passed
@tonyhb tonyhb deleted the jack/inn-2152-fix-ugly-error-when-sending-event-without-inngest_event_key branch October 16, 2023 20:29
tonyhb pushed a commit that referenced this pull request Oct 16, 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.2.1

### Patch Changes

- [#360](#360)
[`260dd75`](260dd75)
Thanks [@jpwilliams](https://github.com/jpwilliams)! - Inngest errors
now appear more succintly in UIs, free of ANSI codes and verbose
information

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
⬆️ improvement Performance, reliability, or usability improvements
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants