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

Remove unused APIs on BugsnagEvent interface #498

Merged
merged 5 commits into from
Mar 27, 2020
Merged

Conversation

fractalwrench
Copy link
Contributor

@fractalwrench fractalwrench commented Mar 25, 2020

Goal

Removes/hides unused APIs from the BugsnagEvent interface. These are either no longer required or were originally part of the internal implementation and mistakenly included in the public header.

Changeset

The following APIs have been removed/hidden using a class extension:

BSGParseSeverity
BSGFormatSeverity
serializableValueWithTopLevelData
shouldBeSent
toJson
attachCustomStacktrace:withType:
enhancedErrorMessageForThread
notifyReleaseStages
handledState
overrides
depth
error
isIncomplete

Tests

Updated existing test coverage to avoid using deprecated APIs. Mazerunner scenarios which were testing individual stackframes have had these assertions removed as historically this could be quite flaky.

@fractalwrench fractalwrench marked this pull request as ready for review March 26, 2020 17:05
@tomlongridge
Copy link
Contributor

It looks like we've had to remove some of the test rigor in this change now that we've made some field private. Can we not use some class extensions to give access in the tests?

@fractalwrench
Copy link
Contributor Author

After IRL discussion attachCustomStacktrace has been reinstated as it was before, as this allows us to retain the same test coverage. It will be removed as part of future work once the Error interface has been implemented and the existing scenarios can be updated to use this API.

@fractalwrench fractalwrench merged commit 436f968 into v6 Mar 27, 2020
@fractalwrench fractalwrench deleted the v6-remove-event-apis branch March 27, 2020 15:13
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.

3 participants