Make proto object verification give more descriptive error messages #1733
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
BenBirt
requested changes
May 9, 2024
common/protos/index.ts
Outdated
Comment on lines
32
to
33
| suggestReportToDataformTeam: boolean = false, | ||
| showDocsLink: boolean = true |
There was a problem hiding this comment.
give me an Options type so that these can be named and therefore readable at the callsite
BenBirt
approved these changes
May 10, 2024
common/protos/index.ts
Outdated
| @@ -24,7 +28,8 @@ export interface IProtoClass<IProto, Proto> { | |||
| // meaning that the type of fields cannot be verified; an int can be confused with a string. | |||
| export function verifyObjectMatchesProto<Proto>( | |||
| protoType: IProtoClass<any, Proto>, | |||
| object: object | |||
| object: object, | |||
| options?: { suggestReportToDataformTeam?: boolean; showDocsLink?: boolean } | |||
There was a problem hiding this comment.
sorry, now I see that it looks like these options are effectively an enumeration - it essentially never makes sense for them both to be true; because suggestReportToDataformTeam always takes precedence.
I'd suggest:
errorBehaviour?: enum ErrorBehaviour { SUGGEST_REPORTING_TO_DATAFORM_TEAM, SHOW_DOCS_LINK }
moker-spaghetti
pushed a commit
to moker-spaghetti/dataform
that referenced
this pull request
May 26, 2024
…ataform-co#1733) * Make proto object verification give better details * Fix error messages * Tidy * Add proto type URL to docs URL * Update options to be object based * Update to use enum for error behaviour
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.
Given that we can't do proper type validation due to ProtobufJS, this is the next best thing that I can think of.