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

refactor: rename Bugsnag.addAttribute to addMetadata, add tests #454

Conversation

robinmacharg
Copy link
Contributor

@robinmacharg robinmacharg commented Feb 5, 2020

Goal

Simple rename of Bugsnag.addAttribute to Bugsnag.addMetadata to add consistency across notifier platforms.

Design

Simple search and replace. Unit tests were missing so have been added. Swift name differs from default translation so has been provided via NS_SWIFT_NAME.

The change was only applied at the top level. A separate change will be required at the Configuration level.

Changeset

M	CHANGELOG.md
M	Source/Bugsnag.h
M	Source/Bugsnag.m
A	Tests/BugsnagTests.m
M	UPGRADING.md
M	iOS/Bugsnag.xcodeproj/project.pbxproj
A	iOS/BugsnagTests/Swift Tests/BugsnagSwiftTests.swift

Tests

Added ObjC unit tests and a Swift UT to check Swift name exposure.

Review

Outstanding Questions

  • 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 force-pushed the robinmacharg/rename-addattribute-to-addmetadata branch from 84481f2 to af77a8c Compare February 5, 2020 11:34
@robinmacharg robinmacharg marked this pull request as ready for review February 5, 2020 11:36
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.

Tests which notify should start Bugsnag with a configuration which disables delivering reports in the test, either by changing endpoints or adding a beforeSend block to reject them. Looks good otherwise.

@robinmacharg robinmacharg force-pushed the robinmacharg/rename-addattribute-to-addmetadata branch from af77a8c to 1521d76 Compare February 10, 2020 09:57
@kattrali kattrali closed this Feb 25, 2020
@twometresteve twometresteve deleted the robinmacharg/rename-addattribute-to-addmetadata branch June 8, 2020 17:02
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