feat: add package to handle end-user error messages. #13
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
jvallesm
force-pushed
the
jvalles/ins-2779-improve-error-message-in-connector
branch
from
ca383a1
to
d92a26f
Compare
jvallesm
force-pushed
the
jvalles/ins-2779-improve-error-message-in-connector
branch
from
d92a26f
to
9c5fa1d
Compare
jvallesm
force-pushed
the
jvalles/ins-2779-improve-error-message-in-connector
branch
2 times, most recently
from
bda6d7e
to
ca196ff
Compare
Because - Connector errors produce an unfriendly output in VDP. - In order to trigger a pipeline, several repositories are involved in the execution. This commit - Implements a way to add and extract end-user messages to errors.
jvallesm
force-pushed
the
jvalles/ins-2779-improve-error-message-in-connector
branch
from
03cb8b0
to
237e70e
Compare
Codecov ReportAttention:
Additional details and impacted files@@ Coverage Diff @@
## main #13 +/- ##
==========================================
+ Coverage 70.81% 71.62% +0.81%
==========================================
Files 2 3 +1
Lines 185 215 +30
==========================================
+ Hits 131 154 +23
- Misses 48 55 +7
Partials 6 6
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. |
|
Hi @pinglin @xiaofei-du , |
xiaofei-du
deleted the
jvalles/ins-2779-improve-error-message-in-connector
branch
donch1989
pushed a commit
to instill-ai/connector
that referenced
this pull request
Dec 19, 2023
Console errorrs are unclear and expose implementation details to no-code / low-code users. This PR proposes a way to bubble up errors from components in a way that the end-user error is separated from the internal error information (stack, low-level details). The `sendReq` method in `pkg/openai` is modified to return human-friendly errors. instill-ai/pipeline-backend#311 is needed to test these changes. ~The [fault](https://github.com/Southclaws/fault) package is chosen to carry out this task.~ While `fault` was chosen originally, some of the features we were using were no longer needed after refactoring the code to adapt to the use of `temporal` workflows to execute sync pipelines. - A logger is injected in the `openai.Client` struct, so we no longer need to pass the request variables as part of the error context. - The client doesn't know the component ID and can't attach it to the end-user message. However, because communication between temporal processes prevents error unwrapping, we can only use temporal errors to pass the end-user message. Therefore, it was simpler to use [our own implementation](instill-ai/x#13) of error messages, at least while the required functionality doesn't get too sofisticated. ### 🗒️ Notes - Some coverage was added due to the rapid development in the `main` branches, which made manual testing a bit unreliable. Let me know if this is a potential change preventer and if we should focus on coverage later. - Additionally, the `frankban/quicktest` package was added in the tests. I'm a fan of the package but I can rework the tests with `require` in order to align with the current tests. - Many integration tests were removed as they were outdated. They aren't being run now, if there's a reason to keep them I can revert that change.  
xiaofei-du
pushed a commit
that referenced
this pull request
Feb 9, 2024
🤖 I have created a release *beep* *boop* --- ## [0.4.0-alpha](v0.3.0-alpha...v0.4.0-alpha) (2023-12-19) ### Features * add package to handle end-user error messages. ([#13](#13)) ([6230a89](6230a89)) --- This PR was generated with [Release Please](https://github.com/googleapis/release-please). See [documentation](https://github.com/googleapis/release-please#release-please).
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Because
the execution.
This commit