[Bug]: Validating entity relationships throws unhandled exception #2184
Comments
|
Does |
|
I get a different stack trace:
|
|
This issue looks like it stems from collections in the metadataprovider not being fully populated at time of validation: |
|
this was not caught presumably because it doesn't occur on |
|
This seems to be caused by
|
|
The above comment holds true when the @Aniruddh25 , can you confirm whether your config had a valid connection string or if you were using an environment variable placeholder for your connection string? Agreed that the error message isn't helpful so one path forward here is:
|
I found the same in my investiation. This only arises when the connection string is invalid. My thought was to add a try catch to the validation steps that rely on the connection string and then some messaging to help explain the problem. |
… correctly initialized (#2202) ## 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 `ValidateEntitiesMetadata` function into 2 functions, one called `ValidateRelationshipConfigCorrectness` that 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 to `ValidateRelationships` which happens from within `ValidateEntitiesMetadata` only when the initialization of the metadata provider resulted in no connection errors. Therefore, the normal code path when doing `dab validate` will be 1. Call `ValidateRelationshipConfigCorrectness` 2. Call `ValidateEntitiesMetadata` 2a. If there were no connection errors Call `ValidateRelationships`  ## How 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 <path to config>
What happened?
Cannot figure out what's wrong with this sample config. Doing
dab validatecauses anUnhandled Exceptionwith the stack trace as provided in the log output.{ "$schema": "https://dataapibuilder.azureedge.net/schemas/v0.5.34/dab.draft.schema.json", "data-source": { "database-type": "mssql", "options": { "set-session-context": false }, "connection-string": "Server=XXXXX;Persist Security Info=False;User ID=<USERHERE>;Password=<PWD HERE> ;MultipleActiveResultSets=False;Encrypt=True;TrustServerCertificate=False;Connection Timeout=30;" }, "runtime": { "rest": { "enabled": true, "path": "/api" }, "graphql": { "allow-introspection": true, "enabled": true, "path": "/graphql" }, "host": { "mode": "development", "cors": { "origins": [], "allow-credentials": false }, "authentication": { "provider": "StaticWebApps" } } }, "entities": { "Publisher": { "source": { "object": "publishers", "type": "table", "key-fields": ["id"] }, "graphql": { "enabled": true, "type": { "singular": "Publisher", "plural": "Publishers" } }, "rest": { "enabled": true }, "permissions": [ { "role": "anonymous", "actions": [ { "action": "read" } ] }, { "role": "authenticated", "actions": [ { "action": "create" }, { "action": "read" }, { "action": "update" }, { "action": "delete" } ] }, { "role": "policy_tester_01", "actions": [ { "action": "read", "fields": { "exclude": [], "include": [ "*" ] }, "policy": { "database": "@item.id eq 1940" } }, { "action": "update", "fields": { "exclude": [], "include": [ "*" ] } }, { "action": "create" }, { "action": "delete" } ] }, { "role": "policy_tester_02", "actions": [ { "action": "read", "fields": { "exclude": [], "include": [ "*" ] }, "policy": { "database": "@item.id ne 1940" } }, { "action": "update", "fields": { "exclude": [], "include": [ "*" ] } }, { "action": "create" }, { "action": "delete" } ] }, { "role": "policy_tester_03", "actions": [ { "action": "read", "fields": { "exclude": [], "include": [ "*" ] }, "policy": { "database": "@item.id ne 1940" } }, { "action": "update", "fields": { "exclude": [], "include": [ "*" ] } }, { "action": "create" }, { "action": "delete" } ] }, { "role": "policy_tester_04", "actions": [ { "action": "read", "fields": { "exclude": [], "include": [ "*" ] }, "policy": { "database": "@item.id eq 1940" } }, { "action": "update", "fields": { "exclude": [], "include": [ "*" ] } }, { "action": "create" }, { "action": "delete" } ] }, { "role": "policy_tester_06", "actions": [ { "action": "read", "fields": { "exclude": [], "include": [ "*" ] }, "policy": { "database": "@item.id eq 1940" } }, { "action": "update", "fields": { "exclude": [], "include": [ "*" ] } }, { "action": "create" }, { "action": "delete" } ] }, { "role": "database_policy_tester", "actions": [ { "action": "create", "policy": { "database": "@item.name ne 'New publisher'" } }, { "action": "update", "policy": { "database": "@item.id ne 1234" } }, { "action": "read", "policy": { "database": "@item.id ne 1234 or @item.id gt 1940" } } ] } ], "relationships": { "books": { "cardinality": "many", "target.entity": "Book", "source.fields": ["id"], "target.fields": ["publisher_id"], "linking.source.fields": [], "linking.target.fields": [] } } }, "Book": { "source": { "object": "books", "type": "table", "key-fields": ["id"] }, "graphql": { "enabled": true, "type": { "singular": "book", "plural": "books" } }, "rest": { "enabled": true }, "permissions": [ { "role": "anonymous", "actions": [ { "action": "create" }, { "action": "read" }, { "action": "update" }, { "action": "delete" } ] }, { "role": "authenticated", "actions": [ { "action": "create" }, { "action": "read" }, { "action": "update" }, { "action": "delete" } ] }, { "role": "policy_tester_01", "actions": [ { "action": "read", "fields": { "exclude": [], "include": [ "*" ] }, "policy": { "database": "@item.title eq 'Policy-Test-01'" } }, { "action": "update", "fields": { "exclude": [], "include": [ "*" ] } }, { "action": "create" }, { "action": "delete" } ] }, { "role": "policy_tester_02", "actions": [ { "action": "read", "fields": { "exclude": [], "include": [ "*" ] }, "policy": { "database": "@item.title ne 'Policy-Test-01'" } }, { "action": "update", "fields": { "exclude": [], "include": [ "*" ] } }, { "action": "create" }, { "action": "delete" } ] }, { "role": "policy_tester_03", "actions": [ { "action": "read", "fields": { "exclude": [], "include": [ "*" ] }, "policy": { "database": "@item.title eq 'Policy-Test-01'" } }, { "action": "update", "fields": { "exclude": [], "include": [ "*" ] } }, { "action": "create" }, { "action": "delete" } ] }, { "role": "policy_tester_04", "actions": [ { "action": "read", "fields": { "exclude": [], "include": [ "*" ] }, "policy": { "database": "@item.title ne 'Policy-Test-01'" } }, { "action": "update", "fields": { "exclude": [], "include": [ "*" ] } }, { "action": "create" }, { "action": "delete" } ] }, { "role": "policy_tester_05", "actions": [ { "action": "read", "fields": { "exclude": [], "include": [ "*" ] }, "policy": { "database": "@item.id ne 9" } }, { "action": "update", "fields": { "exclude": [], "include": [ "*" ] } }, { "action": "create" }, { "action": "delete" } ] }, { "role": "policy_tester_06", "actions": [ { "action": "read", "fields": { "exclude": [], "include": [ "*" ] }, "policy": { "database": "@item.id ne 10" } }, { "action": "create" }, { "action": "delete" }, { "action": "update", "fields": { "exclude": [], "include": [ "*" ] } } ] }, { "role": "policy_tester_07", "actions": [ { "action": "delete", "fields": { "exclude": [], "include": [ "*" ] }, "policy": { "database": "@item.id ne 9" } }, { "action": "read", "fields": { "exclude": [], "include": [ "*" ] } }, { "action": "update", "fields": { "exclude": [], "include": [ "*" ] }, "policy": { "database": "@item.id ne 9" } }, { "action": "create" } ] }, { "role": "policy_tester_08", "actions": [ { "action": "read", "fields": { "exclude": [], "include": [ "*" ] } }, { "action": "delete", "fields": { "exclude": [], "include": [ "*" ] }, "policy": { "database": "@item.id eq 9" } }, { "action": "update", "fields": { "exclude": [], "include": [ "*" ] }, "policy": { "database": "@item.id eq 9" } }, { "action": "create" } ] }, { "role": "test_role_with_noread", "actions": [ { "action": "create" }, { "action": "update" }, { "action": "delete" } ] }, { "role": "test_role_with_excluded_fields", "actions": [ { "action": "read", "fields": { "exclude": [ "publisher_id" ] } }, { "action": "create" }, { "action": "update" }, { "action": "delete" } ] }, { "role": "test_role_with_policy_excluded_fields", "actions": [ { "action": "read", "fields": { "exclude": [ "publisher_id" ] }, "policy": { "database": "@item.title ne 'Test'" } }, { "action": "create" }, { "action": "update" }, { "action": "delete" } ] } ], "mappings": { "id": "id", "title": "title" }, "relationships": { "publishers": { "cardinality": "one", "target.entity": "Publisher", "source.fields": ["publisher_id"], "target.fields": ["id"], "linking.source.fields": [], "linking.target.fields": [] } } } } }Version
0.12.0-rc
What database are you using?
Azure SQL
What hosting model are you using?
Local (including CLI)
Which API approach are you accessing DAB through?
No response
Relevant log output
Code of Conduct
The text was updated successfully, but these errors were encountered: