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

feat: Add metadata accessors to BugsnagEvent #465

Conversation

robinmacharg
Copy link
Contributor

Also added a BaseUnitTest to collect common setup patterns.

Goal

Add metadata accessor methods to BugsnagEvent, to align it with other metadata-utilising classes.

Design

Implement the necessary methods (add*, clear* and get*), add tests. These methods deal with NSDictionarys, not BugsnagMetadata

Changeset

Changes primarily to BugsnagEvent.

Tests

Added tests that the new methods performed as expected.

Also created a top-level Unit Test base class for common setup tasks. There's a question over whether it would be clearer to have a helper class with static methods.

Review

Outstanding Questions

See above.

  • 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
  • The correct target branch has been selected (master for fixes, next for
    features)
  • 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

@robinmacharg robinmacharg marked this pull request as ready for review February 18, 2020 15:26
Copy link
Contributor

@kattrali kattrali left a comment

Choose a reason for hiding this comment

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

The implementation looks good. There might be a couple of missing tests in the middle?

Tests/BugsnagEventTests.m Outdated Show resolved Hide resolved
Tests/BugsnagEventTests.m Outdated Show resolved Hide resolved
Also added a BaseUnitTest to collect common setup patterns.
@kattrali kattrali force-pushed the robinmacharg/Add-metadata-accessor-methods-to-BugsnagEvent branch from 7576799 to a6ea938 Compare February 25, 2020 09:53
@kattrali kattrali merged commit f955681 into spec-compliance Feb 25, 2020
@kattrali kattrali deleted the robinmacharg/Add-metadata-accessor-methods-to-BugsnagEvent branch February 25, 2020 13:48
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