Improve usage of format strings #687
Merged
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
vytis
reviewed
Feb 5, 2018
| case 0: | ||
| fallthrough | ||
| default: | ||
| return String.localizedStringWithFormat(format) |
There was a problem hiding this comment.
We still are passing dynamic string to a format here, we should use regular localizedString(forKey: method instead
vytis
reviewed
Feb 5, 2018
| @@ -304,6 +304,7 @@ extension LocalNotificationDispatcherTests { | |||
| XCTAssertEqual(self.application.scheduledLocalNotifications.count, 1) | |||
| XCTAssertEqual(self.notificationDelegate.receivedLocalNotifications.count, 0) | |||
| guard let notification = self.application.scheduledLocalNotifications.first else { return XCTFail() } | |||
| print(notification.alertBody!) | |||
vytis
approved these changes
Feb 5, 2018
Codecov Report
@@ Coverage Diff @@
## develop #687 +/- ##
==========================================
+ Coverage 82.23% 82.4% +0.16%
==========================================
Files 173 173
Lines 12358 12344 -14
==========================================
+ Hits 10163 10172 +9
+ Misses 2195 2172 -23
Continue to review full report at Codecov.
|
zenkins
added a commit
that referenced
this pull request
Feb 6, 2018
Diff with previous: 142.0.7...142.0.8 Commits: b7a969f Improve usage of format strings (#687)
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.
What's new in this PR?
Issues
We have some usage of format strings where it is possible to construct incorrect format strings if great care is not taken when using the localization methods.
Solutions
Issue 1:
ZMUserSession+UserNotificationCategories.mHere we are passing format strings as variables down a chain of methods which can be risky if the key is not used as expected. We can fix this by resolving the localized string at the top level and pass it down instead.
issue 2:
ZMLocalNotificationLocalization.hHere we expose several localization API method as an extension on
NSString. These methods however only work with a certain set of localization strings defined inPush.strings. Knowing which methods work together with which localization strings requires careful inspection of the code and is easy to get wrong.We will solve this replacing these methods with an enum representing every case of possible push notifications. This enum will then expose methods for creating the necessary localized strings which will always return a valid result.