Updates job mapping validator to return error codes #3179
Merged
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
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
|
The latest Buf updates on your PR. Results from workflow Buf / buf (pull_request).
|
Benchstat Geomean Results0.43% sec/op, -0.03% B/op, 0.00% allocs/op Benchstat results |
Codecov ReportAttention: Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## main #3179 +/- ##
==========================================
+ Coverage 27.82% 27.85% +0.02%
==========================================
Files 378 378
Lines 43259 43307 +48
==========================================
+ Hits 12037 12061 +24
- Misses 29772 29797 +25
+ Partials 1450 1449 -1 ☔ View full report in Codecov by Sentry. |
nickzelei
reviewed
Jan 22, 2025
| message ColumnError { | ||
| // The schema of the table | ||
| string schema = 1; | ||
| // The table of the column | ||
| string table = 2; | ||
| // The column of the error | ||
| string column = 3; | ||
| // The list of errors | ||
| // @deprecated - Use error_reports instead | ||
| repeated string errors = 4; |
There was a problem hiding this comment.
also worthwhile to add the [deprecated = true] rpc option to anywhere that you are using @deprecated
internal/job/jobmapping-validator.go
Outdated
| type JobMappingErrorCode string | ||
|
|
||
| const ( | ||
| TABLE_NOT_FOUND_IN_SOURCE JobMappingErrorCode = "TABLE_NOT_FOUND_IN_SOURCE" |
There was a problem hiding this comment.
these are great. so descriptive.
| repeated string errors = 4; | ||
| // The list of error reports | ||
| repeated ErrorReport error_reports = 5; |
There was a problem hiding this comment.
I think we could potentially be more descriptive here and move the enum you described out of Go and into the proto layer so that you have high quality error code typings in the frontend.
There was a problem hiding this comment.
Also, this is interesting, but does it make sense to have the ErrorReport specific to ColumnError ColumnWarning and DatabaseError? From there you could describe even further scoped error codes that are relevant only to those? Maybe let's talk more about this if this makes sense.
alishakawaguchi
requested review from
nickzelei
and removed request for
nickzelei
nickzelei
approved these changes
Jan 23, 2025
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.
No description provided.