Add filterBreadcrumbActions option #39
Conversation
Codecov Report
@@ Coverage Diff @@
## master #39 +/- ##
=====================================
Coverage 100% 100%
=====================================
Files 1 1
Lines 18 21 +3
Branches 6 8 +2
=====================================
+ Hits 18 21 +3
Continue to review full report at Codecov.
|
|
How about instead of an array of types, we allow the user to supply a Also, I think the action should still be set as the Thanks for the PR, I think this will be a great improvement. |
|
@captbaritone Good idea. Updated PR with your suggestion. The test I added now confirms that the filtered action was omitted from breadcrumbs, but still included in lastAction. Thanks! |
index.js
Outdated
| message: action.type, | ||
| data: breadcrumbDataFromAction(action) | ||
| }); | ||
| if (filterBreadcrumbActions(action) === true) { |
There was a problem hiding this comment.
I think it would be less confusing for this to just check for truthy values.
if (filterBreadcrumbActions(action)) {
There was a problem hiding this comment.
Yeah, I did that at first, but thought being explicit might catch some bugs in the user-supplied function.
There was a problem hiding this comment.
I think truths/falsy is a perfectly valid return value from a filter predicate. Not nessesarily a bug.
| @@ -128,6 +128,16 @@ Each breadcrumb is assigned a category. By default all action breadcrumbs are | |||
| given the category `"redux-action"`. If you would prefer a different category | |||
| name, specify it here. | |||
|
|
|||
| #### `filterBreadcrumbActions` _(Function)_ | |||
There was a problem hiding this comment.
This might also be worth adding to the "improvements" section above.
index.test.js
Outdated
| extra, | ||
| breadcrumbs | ||
| } = context.mockTransport.mock.calls[0][0].data; | ||
| // Even though the action isn't added to breadcrumbs, it should be sent with extra data |
There was a problem hiding this comment.
I think this would be better as a separate it() block, that way if it fails, we get a nice error message, but don't worry about it. I can always clean this up later.
|
Looks good! I'll cut a point release. |
|
Thanks for the quick feedback & merge! This is definitely going to improve our debugging process. |
|
Okay. Should be available in v1.1.0 Thanks again for your work on this! |
filterBreadcrumbActions is a function that returns
trueif an action should be added to the breadcrumbs.The rationale for this is that some Redux apps use some actions internally to trigger state changes that are both prolific and not directly connected to user behavior. They can overwhelm the logs and have essentially no value for debugging purposes.