CPLAT-7721 Add error logging to ErrorBoundary #370
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
Security InsightsNo security relevant content was detected by automated scans. Action Items
Questions or Comments? Reach out on Slack: #support-infosec. |
aaronlademann-wf
force-pushed
the
3.0.0/error-boundary-logging+dart2
branch
from
2ac4788
to
96714f3
Compare
aaronlademann-wf
force-pushed
the
3.0.0/error-boundary-logging+dart2
branch
from
96714f3
to
be378d7
Compare
greglittlefield-wf
requested changes
Oct 15, 2019
greglittlefield-wf
requested changes
Oct 15, 2019
| Logger get logger => _logger; | ||
| Logger _logger; | ||
| /// The value that will be used when creating a [Logger] to log errors from this component. | ||
| String get loggerName { |
There was a problem hiding this comment.
Is there a use-case for making this public? Consumers know which logger/loggerName they passed in; we shouldn't need to expose that info via an API method.
| Logger _logger; | ||
| /// The value that will be used when creating a [Logger] to log errors from this component. | ||
| String get loggerName { | ||
| if (props.logger != null) return props.logger.name; |
There was a problem hiding this comment.
Related to the above comment; if this isn't public, this won't be necessary.
aaronlademann-wf
added a commit
that referenced
this pull request
Oct 16, 2019
+ Dart 1 port of #370
|
QA +1 @Workiva/release-management-p |
This was referenced Oct 16, 2019
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.
Motivation
Consumers currently have to set their own
onComponentDidCatchprop callback, and then manually pass the errors passed to that callback into their own instance ofLogger.Changes
ErrorBoundaryso that consumers get it for free, and they can simply setprops.loggerNameto customize the logger name if they choose.ErrorBoundaryComponent.loggerif they want to log it to the service of their choice.Release Notes
Add logging functionality to the ErrorBoundary
Review
See CONTRIBUTING.md for more details on review types (+1 / QA +1 / +10) and code review process.
Please review: @greglittlefield-wf @kealjones-wk @joebingham-wk @sydneyjodon-wk @maxwellpeterson-wf
QA Checklist
Merge Checklist
While we perform many automated checks before auto-merging, some manual checks are needed: