fix: show a more detailed error on Bad Request #1468
Conversation
while creating a component to a library: report the "max components" limit from the backend
openedx-webhooks
added
the
open-source-contribution
|
Thanks for the pull request, @pomegranited! What's next?Please work through the following steps to get your changes ready for engineering review: 🔘 Get product approvalIf you haven't already, check this list to see if your contribution needs to go through the product review process.
🔘 Provide contextTo help your reviewers and other members of the community understand the purpose and larger context of your changes, feel free to add as much of the following information to the PR description as you can:
🔘 Get a green buildIf one or more checks are failing, continue working on your changes until this is no longer the case and your build turns green. 🔘 Let us know that your PR is ready for review:Who will review my changes?This repository is currently maintained by Where can I find more information?If you'd like to get more details on all aspects of the review process for open source pull requests (OSPRs), check out the following resources:
When can I expect my changes to be merged?Our goal is to get community contributions seen and reviewed as efficiently as possible. However, the amount of time that it takes to review and merge a PR can vary significantly based on factors such as:
💡 As a result it may take up to several weeks or months to complete a review and merge your PR. |
There was a problem hiding this comment.
@pomegranited This works while creating new component but we also need to display the same error while pasting component.
Refactors parsePasteErrorMsg function and tests to share error response parsing logic between paste and create.
|
Ach, sorry I missed the "paste" part, and thank you for catching this @navinkarkera and @DanielVZ96. d0cad7e refactors the |
| try { | ||
| const { customAttributes: { httpErrorResponseData } } = error; | ||
| errMsg = JSON.parse(httpErrorResponseData).block_type; |
There was a problem hiding this comment.
Note: this line was erroring out, because the error response didn't (ever?) contain a block_type. So when I pasted a component and was over the limit, the toast would disappear without showing me an error at all. This refactor ensures an error message is shown, with detail if we have it.
There was a problem hiding this comment.
because the error response didn't (ever?)
It does return block_type here but it seems like the use of IncompatibleTypesError exception was removed now. I cannot find any place where it is raised.
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## master #1468 +/- ##
=======================================
Coverage 93.27% 93.27%
=======================================
Files 1052 1052
Lines 20496 20505 +9
Branches 4393 4314 -79
=======================================
+ Hits 19118 19127 +9
- Misses 1315 1318 +3
+ Partials 63 60 -3 ☔ View full report in Codecov by Sentry. |
There was a problem hiding this comment.
@pomegranited Looks good and thanks for the tests refactor 👍
- I tested this: (Verified error messages for block limit and unsupported block types)
- I read through the code
- I checked for accessibility issues
- Includes documentation
Description
Show a detailed error when 400 Bad Request received while adding a component to a library, either a new or pasted component. The most likely error from the backend here is "library can only have {max} components", and since this error is translated already, we can just report it through.
Content Authors using Libraries v2 are affected by this change.
Error shown on paste:
Error shown on create:
Supporting information
Relates to: #1456
Private-ref: FAL-3873
Testing instructions
settings.MAX_BLOCKS_PER_CONTENT_LIBRARYin the backend to a suitable limit for testing.settings.MAX_BLOCKS_PER_CONTENT_LIBRARYblocks to a content library