Improve guideline documentation for business errors #8321
Merged
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
twschiller
changed the title
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #8321 +/- ##
==========================================
- Coverage 73.54% 73.52% -0.02%
==========================================
Files 1330 1330
Lines 41019 41019
Branches 7601 7601
==========================================
- Hits 30167 30160 -7
- Misses 10852 10859 +7 ☔ View full report in Codecov by Sentry. |
fungairino
approved these changes
Apr 24, 2024
src/errors/businessErrors.ts
Outdated
| * by the PixieBrix team | ||
| * - Business errors indicate a problem with user-defined content or 3rd party services. They must be addressed | ||
| * by the customer | ||
| * - Business errors are not reported to Datadog, but are reported to the PixieBrix error telemetry service |
There was a problem hiding this comment.
A link here to some place that further describes or defines the Pixiebrix error telemetry service could be useful.
src/errors/businessErrors.ts
Outdated
| * An error indicating an invalid input was provided to a brick. Used for runtime checks that cannot be performed as | ||
| * part of JSONSchema input validation. | ||
| * | ||
| * Throwing PropError instead of BusinessError allows the Page Editor so show the error on the associated field |
There was a problem hiding this comment.
Suggested change
| * Throwing PropError instead of BusinessError allows the Page Editor so show the error on the associated field | |
| * Throwing PropError instead of BusinessError allows the Page Editor to show the error on the associated field |
|
No loom links were found in the first post. Please add one there if you'd like to it to appear on Slack. Do not edit this comment manually. |
grahamlangford
approved these changes
Apr 24, 2024
BLoe
approved these changes
Apr 24, 2024
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.
What does this PR do?
Discussion
Checklist