Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Set maxBreadcrumbs via Configuration rather than Client #359

Merged
merged 3 commits into from
Aug 20, 2018

Conversation

fractalwrench
Copy link
Contributor

@fractalwrench fractalwrench commented Aug 15, 2018

Goal

Provides config.setMaxBreadcrumbs in favour of client.setMaxBreadcrumbs, which is now deprecated.

Changeset

  • Deprecates client.setMaxBreadcrumbs and Bugsnag.setMaxBreadcrumbs
  • Add maxBreadcrumbs property to Configuration
  • Convert BreadcrumbsTest to Kotlin, documenting what each test case attempts to verify, and adding new tests

Tests

Ran unit tests, mazerunner locally, performed manual testing on dashboard around breadcrumb limits. Added new unit tests for accessor behaviour, and documented existing tests.

Review

For the submitter, initial self-review:

  • Commented on code changes inline explain the reasoning behind the approach
  • Reviewed the test cases added for completeness and possible points for discussion
  • A changelog entry was added for the goal of this pull request
  • Check the scope of the changeset - is everything in the diff required for the pull request?
  • This pull request is ready for:
    • Initial review of the intended approach, not yet feature complete
    • Structural review of the classes, functions, and properties modified
    • Final review

For the pull request reviewer(s), this changeset has been reviewed for:

  • Consistency across platforms for structures or concepts added or modified
  • Consistency between the changeset and the goal stated above
  • Internal consistency with the rest of the library - is there any overlap between existing interfaces and any which have been added?
  • Usage friction - is the proposed change in usage cumbersome or complicated?
  • Performance and complexity - are there any cases of unexpected O(n^3) when iterating, recursing, flat mapping, etc?
  • Concurrency concerns - if components are accessed asynchronously, what issues will arise
  • Thoroughness of added tests and any missing edge cases
  • Idiomatic use of the language

@fractalwrench fractalwrench requested a review from a team August 15, 2018 14:32
Copy link
Contributor

@simonbowring simonbowring left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, very minor comment

private void pruneBreadcrumbs() {
int maxBreadcrumbs = configuration.getMaxBreadcrumbs();

// Remove oldest breadcrumb
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This comment just needs to be tweaked to state that the oldest breadcrumbs will be removed until the max size is reached, not just one breadcrumb

@fractalwrench fractalwrench merged commit 0ef94d8 into next Aug 20, 2018
@fractalwrench fractalwrench deleted the breadcrumb-size-accessors branch August 20, 2018 14:54
lemnik pushed a commit that referenced this pull request Jun 2, 2021
rich-bugsnag added a commit that referenced this pull request Sep 3, 2021
add new BundleVersion configuration option

Co-authored-by: Steve Kirkland <steve@bugsnag.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants