Centralize method to cache badge count

nan-li · nan-li · commit 208ff4e6833f · 2025-05-27T23:16:57.000-07:00
* Use one method to cache badge count and move this method `updateCachedBadgeValue` out of OneSignalExtension so it can be used by other modules. Move it to a badge helpers class in OneSignalCore.
diff --git a/iOS_SDK/OneSignalSDK/OneSignal.xcodeproj/project.pbxproj b/iOS_SDK/OneSignalSDK/OneSignal.xcodeproj/project.pbxproj
@@ -73,6 +73,8 @@
 		3C277D7E2BD76E0000857606 /* OSIdentityModelRepo.swift in Sources */ = {isa = PBXBuildFile; fileRef = 3C277D7D2BD76E0000857606 /* OSIdentityModelRepo.swift */; };
 		3C2C7DC8288F3C020020F9AE /* OSSubscriptionModel.swift in Sources */ = {isa = PBXBuildFile; fileRef = 3C2C7DC7288F3C020020F9AE /* OSSubscriptionModel.swift */; };
 		3C2D8A5928B4C4E300BE41F6 /* OSDelta.swift in Sources */ = {isa = PBXBuildFile; fileRef = 3C2D8A5828B4C4E300BE41F6 /* OSDelta.swift */; };
+		3C2DB2F12DE6CB5E0006B905 /* OneSignalBadgeHelpers.h in Headers */ = {isa = PBXBuildFile; fileRef = 3C2DB2EF2DE6CB5E0006B905 /* OneSignalBadgeHelpers.h */; settings = {ATTRIBUTES = (Public, ); }; };
+		3C2DB2F22DE6CB5E0006B905 /* OneSignalBadgeHelpers.m in Sources */ = {isa = PBXBuildFile; fileRef = 3C2DB2F02DE6CB5E0006B905 /* OneSignalBadgeHelpers.m */; };
 		3C44673E296D099D0039A49E /* OneSignalMobileProvision.m in Sources */ = {isa = PBXBuildFile; fileRef = 912411FD1E73342200E41FD7 /* OneSignalMobileProvision.m */; };
 		3C44673F296D09CC0039A49E /* OneSignalMobileProvision.h in Headers */ = {isa = PBXBuildFile; fileRef = 912411FC1E73342200E41FD7 /* OneSignalMobileProvision.h */; settings = {ATTRIBUTES = (Public, ); }; };
 		3C448B9D2936ADFD002F96BC /* OSBackgroundTaskHandlerImpl.h in Headers */ = {isa = PBXBuildFile; fileRef = 3C448B9B2936ADFD002F96BC /* OSBackgroundTaskHandlerImpl.h */; };
@@ -1251,6 +1253,8 @@
 		3C2C7DC2288E007E0020F9AE /* UnitTests-Bridging-Header.h */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.h; path = "UnitTests-Bridging-Header.h"; sourceTree = "<group>"; };
 		3C2C7DC7288F3C020020F9AE /* OSSubscriptionModel.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = OSSubscriptionModel.swift; sourceTree = "<group>"; };
 		3C2D8A5828B4C4E300BE41F6 /* OSDelta.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = OSDelta.swift; sourceTree = "<group>"; };
+		3C2DB2EF2DE6CB5E0006B905 /* OneSignalBadgeHelpers.h */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.h; path = OneSignalBadgeHelpers.h; sourceTree = "<group>"; };
+		3C2DB2F02DE6CB5E0006B905 /* OneSignalBadgeHelpers.m */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.objc; path = OneSignalBadgeHelpers.m; sourceTree = "<group>"; };
 		3C448B9B2936ADFD002F96BC /* OSBackgroundTaskHandlerImpl.h */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.h; path = OSBackgroundTaskHandlerImpl.h; sourceTree = "<group>"; };
 		3C448B9C2936ADFD002F96BC /* OSBackgroundTaskHandlerImpl.m */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.objc; path = OSBackgroundTaskHandlerImpl.m; sourceTree = "<group>"; };
 		3C448BA12936B474002F96BC /* OSBackgroundTaskManager.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = OSBackgroundTaskManager.swift; sourceTree = "<group>"; };
@@ -2596,6 +2600,8 @@
 				DE7D182C270273B0002D3A5D /* OSNotification.h */,
 				454F94F41FAD2E5A00D74CCF /* OSNotification.m */,
 				454F94F61FAD2EC300D74CCF /* OSNotification+Internal.h */,
+				3C2DB2EF2DE6CB5E0006B905 /* OneSignalBadgeHelpers.h */,
+				3C2DB2F02DE6CB5E0006B905 /* OneSignalBadgeHelpers.m */,
 				3CE8CC4C2911ADD1000DB0D3 /* OSDeviceUtils.h */,
 				3C47A972292642B100312125 /* OneSignalConfigManager.h */,
 				3C47A973292642B100312125 /* OneSignalConfigManager.m */,
@@ -3138,6 +3144,7 @@
 				DE7D182F270275FF002D3A5D /* OneSignalTrackFirebaseAnalytics.h in Headers */,
 				DEF7845C2912E89200A1F3A5 /* OSObservable.h in Headers */,
 				DE7D1875270375FF002D3A5D /* OSReattemptRequest.h in Headers */,
+				3C2DB2F12DE6CB5E0006B905 /* OneSignalBadgeHelpers.h in Headers */,
 				DEF784652912FB2200A1F3A5 /* OSDialogInstanceManager.h in Headers */,
 				DEF78493291479B200A1F3A5 /* OneSignalSelectorHelpers.h in Headers */,
 				DE7D1862270374EE002D3A5D /* OSJSONHandling.h in Headers */,
@@ -4427,6 +4434,7 @@
 				DEF784642912FA5100A1F3A5 /* OSDialogInstanceManager.m in Sources */,
 				DE7D183B27027EFC002D3A5D /* NSURL+OneSignal.m in Sources */,
 				DE7D186B270374EE002D3A5D /* OneSignalRequest.m in Sources */,
+				3C2DB2F22DE6CB5E0006B905 /* OneSignalBadgeHelpers.m in Sources */,
 				3C44673E296D099D0039A49E /* OneSignalMobileProvision.m in Sources */,
 				3CCF44BF299B17290021964D /* OneSignalWrapper.m in Sources */,
 				DEF78492291479B200A1F3A5 /* OneSignalSelectorHelpers.m in Sources */,
diff --git a/iOS_SDK/OneSignalSDK/OneSignalCore/Source/OneSignalBadgeHelpers.h b/iOS_SDK/OneSignalSDK/OneSignalCore/Source/OneSignalBadgeHelpers.h
@@ -0,0 +1,32 @@
+/**
+ * Modified MIT License
+ *
+ * Copyright 2025 OneSignal
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * 1. The above copyright notice and this permission notice shall be included in
+ * all copies or substantial portions of the Software.
+ *
+ * 2. All copies of substantial portions of the Software may only be used in connection
+ * with services provided by OneSignal.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+ * THE SOFTWARE.
+ */
+
+#import <Foundation/Foundation.h>
+
+@interface OneSignalBadgeHelpers : NSObject
++ (void)updateCachedBadgeValue:(NSInteger)value;
+@end
diff --git a/iOS_SDK/OneSignalSDK/OneSignalCore/Source/OneSignalBadgeHelpers.m b/iOS_SDK/OneSignalSDK/OneSignalCore/Source/OneSignalBadgeHelpers.m
@@ -0,0 +1,38 @@
+/**
+ * Modified MIT License
+ *
+ * Copyright 2025 OneSignal
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * 1. The above copyright notice and this permission notice shall be included in
+ * all copies or substantial portions of the Software.
+ *
+ * 2. All copies of substantial portions of the Software may only be used in connection
+ * with services provided by OneSignal.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+ * THE SOFTWARE.
+ */
+
+#import "OneSignalBadgeHelpers.h"
+#import "OneSignalUserDefaults.h"
+#import "OneSignalCommonDefines.h"
+
+@implementation OneSignalBadgeHelpers
++ (void)updateCachedBadgeValue:(NSInteger)value {
+    // Since badge logic can be executed in an extension, we need to use app groups to get
+    // a shared NSUserDefaults from the app group suite name
+    [OneSignalUserDefaults.initShared saveIntegerForKey:ONESIGNAL_BADGE_KEY withValue:value];
+}
+@end
diff --git a/iOS_SDK/OneSignalSDK/OneSignalCore/Source/OneSignalCore.h b/iOS_SDK/OneSignalSDK/OneSignalCore/Source/OneSignalCore.h
@@ -58,6 +58,7 @@
 #import <OneSignalCore/OSLocation.h>
 #import <OneSignalCore/OSBundleUtils.h>
 #import <OneSignalCore/OneSignalClientError.h>
+#import <OneSignalCore/OneSignalBadgeHelpers.h>
 
 // TODO: Testing: Should this class be defined in this file?
 @interface OneSignalCoreImpl : NSObject
diff --git a/iOS_SDK/OneSignalSDK/OneSignalExtension/OneSignalExtensionBadgeHandler.h b/iOS_SDK/OneSignalSDK/OneSignalExtension/OneSignalExtensionBadgeHandler.h
@@ -31,6 +31,5 @@
 
 @interface OneSignalExtensionBadgeHandler : NSObject
 + (void)handleBadgeCountWithNotificationRequest:(UNNotificationRequest *)request withNotification:(OSNotification *)notification withMutableNotificationContent:(UNMutableNotificationContent *)replacementContent;
-+ (void)updateCachedBadgeValue:(NSInteger)value;
 + (NSInteger)currentCachedBadgeValue;
 @end
diff --git a/iOS_SDK/OneSignalSDK/OneSignalExtension/OneSignalExtensionBadgeHandler.m b/iOS_SDK/OneSignalSDK/OneSignalExtension/OneSignalExtensionBadgeHandler.m
@@ -35,7 +35,7 @@ + (void)handleBadgeCountWithNotificationRequest:(UNNotificationRequest *)request
     //make sure the OneSignal cached value is updated to this value
     if (!notification.badgeIncrement) {
         if (notification.hasBadge)
-            [OneSignalExtensionBadgeHandler updateCachedBadgeValue:notification.badge];
+            [OneSignalBadgeHelpers updateCachedBadgeValue:notification.badge];
         
         return;
     }
@@ -50,17 +50,11 @@ + (void)handleBadgeCountWithNotificationRequest:(UNNotificationRequest *)request
     
     replacementContent.badge = @(currentValue);
     
-    [OneSignalExtensionBadgeHandler updateCachedBadgeValue:currentValue];
+    [OneSignalBadgeHelpers updateCachedBadgeValue:currentValue];
 }
 
 + (NSInteger)currentCachedBadgeValue {
     return [OneSignalUserDefaults.initShared getSavedIntegerForKey:ONESIGNAL_BADGE_KEY defaultValue:0];
 }
 
-+ (void)updateCachedBadgeValue:(NSInteger)value {
-    // Since badge logic can be executed in an extension, we need to use app groups to get
-    //  a shared NSUserDefaults from the app group suite name
-    [OneSignalUserDefaults.initShared saveIntegerForKey:ONESIGNAL_BADGE_KEY withValue:value];
-}
-
 @end
diff --git a/iOS_SDK/OneSignalSDK/OneSignalNotifications/OSNotification+OneSignal.m b/iOS_SDK/OneSignalSDK/OneSignalNotifications/OSNotification+OneSignal.m
@@ -77,7 +77,7 @@ - (void)complete:(OSDisplayableNotification *)notification {
      */
     if (!notification) {
         NSInteger previousBadgeCount = [UIApplication sharedApplication].applicationIconBadgeNumber;
-        [OneSignalUserDefaults.initShared saveIntegerForKey:ONESIGNAL_BADGE_KEY withValue:previousBadgeCount];
+        [OneSignalBadgeHelpers updateCachedBadgeValue:previousBadgeCount];
     }
     if (_completion) {
         _completion(notification);
diff --git a/iOS_SDK/OneSignalSDK/OneSignalNotifications/OSNotificationsManager.m b/iOS_SDK/OneSignalSDK/OneSignalNotifications/OSNotificationsManager.m
@@ -795,7 +795,7 @@ + (void)clearBadgeCount:(BOOL)fromNotifOpened fromClearAll:(BOOL)fromClearAll {
     
     if (_disableBadgeClearing && !fromClearAll) {
         // The customer could have manually changed the badge value. We must ensure our cached value will match the current state.
-        [OneSignalUserDefaults.initShared saveIntegerForKey:ONESIGNAL_BADGE_KEY withValue:[UIApplication sharedApplication].applicationIconBadgeNumber];
+        [OneSignalBadgeHelpers updateCachedBadgeValue:[UIApplication sharedApplication].applicationIconBadgeNumber];
         return;
     }
     
diff --git a/iOS_SDK/OneSignalSDK/Source/OneSignal.m b/iOS_SDK/OneSignalSDK/Source/OneSignal.m
@@ -809,7 +809,7 @@ + (void)load {
     We swizzle the 'setApplicationIconBadgeNumber()' to intercept these calls so we always know the latest count
 */
 - (void)onesignalSetApplicationIconBadgeNumber:(NSInteger)badge {
-    [OneSignalExtensionBadgeHandler updateCachedBadgeValue:badge];
+    [OneSignalBadgeHelpers updateCachedBadgeValue:badge];
     [self onesignalSetApplicationIconBadgeNumber:badge];
 }
 

Original file line number	Diff line number	Diff line change
`@@ -77,7 +77,7 @@ - (void)complete:(OSDisplayableNotification *)notification {`
`77`	`77`	`*/`
`78`	`78`	`if (!notification) {`
`79`	`79`	`NSInteger previousBadgeCount = [UIApplication sharedApplication].applicationIconBadgeNumber;`
`80`		`- [OneSignalUserDefaults.initShared saveIntegerForKey:ONESIGNAL_BADGE_KEY withValue:previousBadgeCount];`
	`80`	`+ [OneSignalBadgeHelpers updateCachedBadgeValue:previousBadgeCount];`
`81`	`81`	`}`
`82`	`82`	`if (_completion) {`
`83`	`83`	`_completion(notification);`
Original file line number	Diff line number	Diff line change
`@@ -795,7 +795,7 @@ + (void)clearBadgeCount:(BOOL)fromNotifOpened fromClearAll:(BOOL)fromClearAll {`
`795`	`795`
`796`	`796`	`if (_disableBadgeClearing && !fromClearAll) {`
`797`	`797`	`// The customer could have manually changed the badge value. We must ensure our cached value will match the current state.`
`798`		`- [OneSignalUserDefaults.initShared saveIntegerForKey:ONESIGNAL_BADGE_KEY withValue:[UIApplication sharedApplication].applicationIconBadgeNumber];`
	`798`	`+ [OneSignalBadgeHelpers updateCachedBadgeValue:[UIApplication sharedApplication].applicationIconBadgeNumber];`
`799`	`799`	`return;`
`800`	`800`	`}`
`801`	`801`
Original file line number	Diff line number	Diff line change
`@@ -809,7 +809,7 @@ + (void)load {`
`809`	`809`	`We swizzle the 'setApplicationIconBadgeNumber()' to intercept these calls so we always know the latest count`
`810`	`810`	`*/`
`811`	`811`	`- (void)onesignalSetApplicationIconBadgeNumber:(NSInteger)badge {`
`812`		`- [OneSignalExtensionBadgeHandler updateCachedBadgeValue:badge];`
	`812`	`+ [OneSignalBadgeHelpers updateCachedBadgeValue:badge];`
`813`	`813`	`[self onesignalSetApplicationIconBadgeNumber:badge];`
`814`	`814`	`}`
`815`	`815`