fix: error messages in OpenAPI/Swagger / improve error messages from failed webhooks and client timeouts #3218
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
alnr
commented
Apr 11, 2023
alnr
commented
Apr 11, 2023
alnr
commented
Apr 11, 2023
alnr
changed the title
Codecov Report
@@ Coverage Diff @@
## master #3218 +/- ##
=======================================
Coverage 77.89% 77.89%
=======================================
Files 319 319
Lines 20431 20443 +12
=======================================
+ Hits 15914 15925 +11
- Misses 3317 3320 +3
+ Partials 1200 1198 -2
... and 2 files with indirect coverage changes Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here. |
|
E2e tests fail, with 502 in webhooks, so it looks like this might related to these changes. If you haven't looked into it yet, I can try to repro this locally tomorrow (e2e test setup in Kratos is a bit finicky). We can also do a call, if you want. Let me know on slack :) |
aeneasr
requested changes
Apr 13, 2023
jonas-jonas
reviewed
Apr 13, 2023
Previously, the Swagger and OpenAPI specs would incorrectly describe
specific errors returned from Kratos' API. Instead of having a nested
"error" key in the returned JSON payload, the API specs would incorrectly
say the contents of the generic error were flattened into the payload.
Example before (incorrect):
{
"id": "browser_location_change_required",
"code": 422,
"status": "Unprocessable Entity",
"reason": "In order to complete this flow please redirect the browser to: /ui/settings?flow=22b3ad6f-c50a-4c2f-8c94-a16e9dc20083",
"message": "browser location change required",
"redirect_browser_to": "/ui/settings?flow=22b3ad6f-c50a-4c2f-8c94-a16e9dc20083"
}
Actual Kratos response (correct, unchanged):
{
"error": {
"id": "browser_location_change_required",
"code": 422,
"status": "Unprocessable Entity",
"reason": "In order to complete this flow please redirect the browser to: /ui/settings?flow=22b3ad6f-c50a-4c2f-8c94-a16e9dc20083",
"message": "browser location change required"
},
"redirect_browser_to": "/ui/settings?flow=22b3ad6f-c50a-4c2f-8c94-a16e9dc20083"
}
This issue occurs because go-swagger does not interpret embedded structs
with `json` structs correctly, i.e., it flattens the embedded struct's
fields into outer type instead of nesting it under the key specified in
the `json` tag.
The least bad fix is to use modified copies of the affected error structs
just for Swagger API spec generation.
|
CLA check is stuck 🤷 ? |
jonas-jonas
approved these changes
Apr 14, 2023
aeneasr
approved these changes
Apr 14, 2023
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.
Partial fix for ory-corp/cloud#4354.
ory/herodot@v0.9.13...v0.10.2
ory/x@v0.0.549...v0.0.551
Previously, the Swagger and OpenAPI specs would incorrectly describe
specific errors returned from Kratos' API. Instead of having a nested
"error" key in the returned JSON payload, the API specs would incorrectly
say the contents of the generic error were flattened into the payload.
Example before (incorrect):
{ "id": "browser_location_change_required", "code": 422, "status": "Unprocessable Entity", "reason": "In order to complete this flow please redirect the browser to: /ui/settings?flow=22b3ad6f-c50a-4c2f-8c94-a16e9dc20083", "message": "browser location change required", "redirect_browser_to": "/ui/settings?flow=22b3ad6f-c50a-4c2f-8c94-a16e9dc20083" }Actual Kratos response (correct, unchanged):
{ "error": { "id": "browser_location_change_required", "code": 422, "status": "Unprocessable Entity", "reason": "In order to complete this flow please redirect the browser to: /ui/settings?flow=22b3ad6f-c50a-4c2f-8c94-a16e9dc20083", "message": "browser location change required" }, "redirect_browser_to": "/ui/settings?flow=22b3ad6f-c50a-4c2f-8c94-a16e9dc20083" }This issue occurs because go-swagger does not interpret embedded structs with
jsontags correctly, i.e., it flattens the embedded struct's fields into outer type instead of nesting it under the key specified in thejsontag.The least bad fix is to use modified copies of the affected error structs just for Swagger API spec generation.