Clarify grpc errors for missing source collection #802
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
| @@ -214,6 +221,11 @@ func RunCmdWithErrorDetection(_ context.Context, cmd *exec.Cmd, _ log.Logger) (s | |||
| if stdOutMsg != "" { | |||
| errLog = stdOutMsg + errLog | |||
| } | |||
|
|
|||
| if strings.Contains(errLog, "rpc error") { | |||
| errLog = clarifyGrpcErrors(errLog) | |||
There was a problem hiding this comment.
any chance stdout would be helpful here?
There was a problem hiding this comment.
the entirety of stdout for this error is the grpc error. So we could:
- include the grpc error along with this clarified, actionable error (in case that stdout is useful for a different, concurrent issue)
- trim the grpc error from stdout, and add it to the actionable error
- replace stdout entirely with this clarified error (current approach)
There was a problem hiding this comment.
ok, I landed on a middle-ground solution that gives us some flexibility. I added a log.Debug() above when we are doing this replacing. that way, if we are debugging, we still have visibility into the full stdout, without adding more error-specific logic.
with --debug:
~/go/src/notion-s3 main
❯ ../cli/meroxa apps deploy --debug
Validating your app.json...
✔ Checked your language is "golang"
✔ Checked your application name is "notion-s3"
Checking for uncommitted changes...
✔ No uncommitted changes!
<redacted prior steps for conciseness>
2023/08/08 15:19:27 rpc error: code = Unknown desc = invalid ProcessCollectionRequest.Collection: embedded message failed validation | caused by: invalid Collection.Name: value length must be at least 1 runes
exit status 1
Error: missing source or source collection, please ensure that you have configured your source correctly:
https://docs.meroxa.com/turbine/troubleshooting#troubleshooting-checklist"
without --debug:
~/go/src/notion-s3 main
❯ ../cli/meroxa apps deploy
Validating your app.json...
✔ Checked your language is "golang"
✔ Checked your application name is "notion-s3"
Checking for uncommitted changes...
✔ No uncommitted changes!
Error: missing source or source collection, please ensure that you have configured your source correctly:
https://docs.meroxa.com/turbine/troubleshooting#troubleshooting-checklist"
jayjayjpg
reviewed
Aug 8, 2023
Co-authored-by: Janelle Tavares <janelletavares@users.noreply.github.com>
ericcheatham
approved these changes
Aug 8, 2023
samirketema
deleted the
samir/clarify-grpc-errors-missing-source-collection
branch
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.
Description of change
Adds more clarity to gRPC errors from turbine-core when an app has no sources defined.
Fixes https://github.com/meroxa/product/issues/936
Type of change
How was this tested?
Demo
Before
After
Documentation updated
Will need to make an adjustment to the docs before merging this PR, to link directly to the new high-level troubleshooting checklist: https://github.com/meroxa/meroxa-docs/pull/431