Handle Exception during dab validate when SqlMetadataProvider has not correctly initialized #2202
Conversation
This file contains hidden or 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
aaronburtle
requested review from
mbhaskar,
Aniruddh25,
seantleonard,
Mathos1432,
gledis69,
tarazou9 and
ayush3797
as code owners
seantleonard
approved these changes
May 4, 2024
|
/azp run |
seantleonard
approved these changes
May 6, 2024
Aniruddh25
reviewed
May 6, 2024
Aniruddh25
previously requested changes
May 7, 2024
…b.com:Azure/data-api-builder into dev/aaronburtle/DabValidateUnhandledException
…vided DB meta, and generated Db meta
seantleonard
requested changes
May 8, 2024
|
/azp run |
ayush3797
reviewed
May 9, 2024
ayush3797
reviewed
May 9, 2024
ayush3797
reviewed
May 9, 2024
|
Might not need this |
ayush3797
approved these changes
May 9, 2024
|
/azp run |
seantleonard
approved these changes
May 9, 2024
seantleonard
dismissed
Aniruddh25’s stale review
feedback addressed, removing stale review.
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.
Why make this change?
Closes #2184
Closes #2180
What is this change?
When we don't properly initialize the
SqlMetadataProvider, certain functions will not behave as intended. This change adds some defensive programming around this fact so that we have more readable exceptions in these cases, as well as restructuring the validation to avoid the potential of such a circumstance.We refactor the
ValidateEntitiesMetadatafunction into 2 functions, one calledValidateRelationshipConfigCorrectnessthat validates the relationships in the config without needing to cross reference database metadata, and leaving the remaining validations that do require such metadata within the original function. This validation is then handled by a mix of the initialization of the metadata provider (this init process does some validation), and the call toValidateRelationshipswhich happens from withinValidateEntitiesMetadataonly when the initialization of the metadata provider resulted in no connection errors.Therefore, the normal code path when doing
dab validatewill beValidateRelationshipConfigCorrectnessValidateEntitiesMetadata2a. If there were no connection errors Call
ValidateRelationshipsHow was this tested?
Manually, against our test suite, and we add a regression test that looks for the correct error messaging when the config that caused the error from the finding of the bug is used.
Sample Request(s)
This can be reprod by using the command `dab validate -c