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

Delay JSON serialization until delivery when using the thread queue delivery method #623

Merged
merged 1 commit into from
Aug 5, 2020

Conversation

imjoehaines
Copy link
Contributor

@imjoehaines imjoehaines commented Aug 5, 2020

Goal

This PR adds a new method that delivery methods can implement in order to delay serialization of the Bugnsag::Report object. This is used by the thread queue delivery method to shift some work off of the main thread

This works by passing a proc that will serialize the Report rather than the serialized Report itself, this way the delivery method doesn't have to know how things are serialized only how to get the serialized value. This is a bit less flexible than passing the Report directly, but I don't think it makes sense for delivery methods to use different serialization

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

@imjoehaines imjoehaines force-pushed the delay-serialization-until-delivery branch from eab6d26 to 10ddc70 Compare August 5, 2020 12:30
@imjoehaines imjoehaines force-pushed the delay-serialization-until-delivery branch from 10ddc70 to b32525d Compare August 5, 2020 12:37
@imjoehaines imjoehaines merged commit 0b3ecf6 into next Aug 5, 2020
@imjoehaines imjoehaines deleted the delay-serialization-until-delivery branch August 5, 2020 14:44
@imjoehaines imjoehaines mentioned this pull request Aug 7, 2020
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