RUM-3808 fix: Avoid name collision with Required Reason APIs #1774
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Datadog ReportBranch report: ✅ 0 Failed, 2727 Passed, 0 Skipped, 5m 51.73s Wall Time 🔻 Code Coverage Decreases vs Default Branch (8)
|
ncreated
commented
Apr 11, 2024
| private var userDefaults: UserDefaults | ||
| private var userDefaults: UserDefaults // swiftlint:disable:this required_reason_api_name |
There was a problem hiding this comment.
💡 This is true positive - UserDefaults is the only Required Reason API we use. It is declared in our manifest.
maxep
approved these changes
Apr 12, 2024
| @@ -89,6 +89,61 @@ custom_rules: | |||
| - doccomment | |||
| message: "`UIApplication.shared` is unavailable in some environments. Check `UIApplication.managedShared`." | |||
| severity: error | |||
| required_reason_api_name: # prevents from declaring symbols that may conflict with Apple's Required Reason APIs | |||
ncreated
deleted the
ncreated/RUM-3808/avoid-name-colision-with-required-reason-apis
branch
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What and why?
📦 This PR renames symbols in our codebase to avoid false-positive warnings on using Required Reason APIs. Next to this, it adds basic linter rule to prevent from using names that may result with conflicts.
Related GH Issues: #1749, #1756
How?
Renamed:
.creationDate→.fileCreationDateandsystemUptime→getSystemUptime.Added custom linter rule that scans the code for Required Reason API names. If found, it raises an error:
The rule is inspired by the text scanner from this repo. It is up to date with the list of Apple APIs.
Review checklist
Custom CI job configuration (optional)
tools/