Moving getCompletionBlock to a category in OneSignalFramework

emawby · emawby · commit 5ea8674911de · 2022-04-21T11:38:10.000-07:00
This allows us to use UIApplication sharedApplication since it is not included in OneSignalCore. To accomplish this I created an OSNotification category in OneSignalFramework. I needed to expose the complete method to do this.
diff --git a/iOS_SDK/OneSignalSDK/OneSignal.xcodeproj/project.pbxproj b/iOS_SDK/OneSignalSDK/OneSignal.xcodeproj/project.pbxproj
@@ -382,6 +382,10 @@
 		DE367CC824EEF2BE00165207 /* OSInAppMessagePage.m in Sources */ = {isa = PBXBuildFile; fileRef = DE367CC624EEF2BE00165207 /* OSInAppMessagePage.m */; };
 		DE367CC924EEF2BE00165207 /* OSInAppMessagePage.m in Sources */ = {isa = PBXBuildFile; fileRef = DE367CC624EEF2BE00165207 /* OSInAppMessagePage.m */; };
 		DE367CCA24EEF2C800165207 /* OSInAppMessagePage.h in Headers */ = {isa = PBXBuildFile; fileRef = DE367CC524EEF2A800165207 /* OSInAppMessagePage.h */; };
+		DE3CD2F9270F9A6D00A5BECD /* OSNotification+OneSignal.m in Sources */ = {isa = PBXBuildFile; fileRef = DE3CD2F8270F9A6D00A5BECD /* OSNotification+OneSignal.m */; };
+		DE3CD2FA270F9A6D00A5BECD /* OSNotification+OneSignal.m in Sources */ = {isa = PBXBuildFile; fileRef = DE3CD2F8270F9A6D00A5BECD /* OSNotification+OneSignal.m */; };
+		DE3CD2FB270F9A6D00A5BECD /* OSNotification+OneSignal.m in Sources */ = {isa = PBXBuildFile; fileRef = DE3CD2F8270F9A6D00A5BECD /* OSNotification+OneSignal.m */; };
+		DE3CD2FD270F9A8100A5BECD /* OSNotification+OneSignal.h in Headers */ = {isa = PBXBuildFile; fileRef = DE3CD2FC270F9A8100A5BECD /* OSNotification+OneSignal.h */; };
 		DE5EFECA24D8DBF70032632D /* OSInAppMessageViewControllerOverrider.m in Sources */ = {isa = PBXBuildFile; fileRef = DE5EFEC924D8DBF70032632D /* OSInAppMessageViewControllerOverrider.m */; };
 		DE7D17EA27026B95002D3A5D /* OneSignalCore.docc in Sources */ = {isa = PBXBuildFile; fileRef = DE7D17E927026B95002D3A5D /* OneSignalCore.docc */; };
 		DE7D17EB27026B95002D3A5D /* OneSignalCore.h in Headers */ = {isa = PBXBuildFile; fileRef = DE7D17E827026B95002D3A5D /* OneSignalCore.h */; settings = {ATTRIBUTES = (Public, ); }; };
@@ -931,6 +935,8 @@
 		DE20425D24E21C2C00350E4F /* UIApplication+OneSignal.m */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.objc; path = "UIApplication+OneSignal.m"; sourceTree = "<group>"; };
 		DE367CC524EEF2A800165207 /* OSInAppMessagePage.h */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.h; path = OSInAppMessagePage.h; sourceTree = "<group>"; };
 		DE367CC624EEF2BE00165207 /* OSInAppMessagePage.m */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.objc; path = OSInAppMessagePage.m; sourceTree = "<group>"; };
+		DE3CD2F8270F9A6D00A5BECD /* OSNotification+OneSignal.m */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.objc; path = "OSNotification+OneSignal.m"; sourceTree = "<group>"; };
+		DE3CD2FC270F9A8100A5BECD /* OSNotification+OneSignal.h */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.h; path = "OSNotification+OneSignal.h"; sourceTree = "<group>"; };
 		DE5EFEC924D8DBF70032632D /* OSInAppMessageViewControllerOverrider.m */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.objc; path = OSInAppMessageViewControllerOverrider.m; sourceTree = "<group>"; };
 		DE5EFECB24D8DC0E0032632D /* OSInAppMessageViewControllerOverrider.h */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.h; path = OSInAppMessageViewControllerOverrider.h; sourceTree = "<group>"; };
 		DE7D17E627026B95002D3A5D /* OneSignalCore.framework */ = {isa = PBXFileReference; explicitFileType = wrapper.framework; includeInIndex = 0; path = OneSignalCore.framework; sourceTree = BUILT_PRODUCTS_DIR; };
@@ -1354,6 +1360,8 @@
 				DE20425D24E21C2C00350E4F /* UIApplication+OneSignal.m */,
 				DE9877292591654600DE07D5 /* NSDateFormatter+OneSignal.h */,
 				DE98772A2591655800DE07D5 /* NSDateFormatter+OneSignal.m */,
+				DE3CD2FC270F9A8100A5BECD /* OSNotification+OneSignal.h */,
+				DE3CD2F8270F9A6D00A5BECD /* OSNotification+OneSignal.m */,
 			);
 			name = Categories;
 			sourceTree = "<group>";
@@ -1776,6 +1784,7 @@
 				DE9A5DAA25D1FD6B00FCEC21 /* OSPlayerTags.h in Headers */,
 				91B6EA451E86555200B5CF01 /* OSObservable.h in Headers */,
 				DE367CCA24EEF2C800165207 /* OSInAppMessagePage.h in Headers */,
+				DE3CD2FD270F9A8100A5BECD /* OSNotification+OneSignal.h in Headers */,
 				CACBAA9C218A6243000ACAA5 /* OSInAppMessageView.h in Headers */,
 				912412351E73342200E41FD7 /* OneSignalTrackIAP.h in Headers */,
 				7AECE59423674AA700537907 /* OSAttributedFocusTimeProcessor.h in Headers */,
@@ -2243,6 +2252,7 @@
 				7A42744225CDE98E00EE75FC /* OSSMSSubscription.m in Sources */,
 				7A5E726225A66EA400CB5605 /* OSStateSynchronizer.m in Sources */,
 				91B6EA411E85D38F00B5CF01 /* OSObservable.m in Sources */,
+				DE3CD2F9270F9A6D00A5BECD /* OSNotification+OneSignal.m in Sources */,
 				DE7D18EE2703B5B9002D3A5D /* OSInAppMessagingRequests.m in Sources */,
 				DE367CC724EEF2BE00165207 /* OSInAppMessagePage.m in Sources */,
 				7A676BE524981CEC003957CC /* OSDeviceState.m in Sources */,
@@ -2321,6 +2331,7 @@
 				912412271E73342200E41FD7 /* OneSignalMobileProvision.m in Sources */,
 				912412331E73342200E41FD7 /* OneSignalTracker.m in Sources */,
 				DE367CC824EEF2BE00165207 /* OSInAppMessagePage.m in Sources */,
+				DE3CD2FA270F9A6D00A5BECD /* OSNotification+OneSignal.m in Sources */,
 				DE7D18EF2703B5B9002D3A5D /* OSInAppMessagingRequests.m in Sources */,
 				91B6EA421E85D38F00B5CF01 /* OSObservable.m in Sources */,
 				A63E9E3C26742B5F00EA273E /* LanguageContext.m in Sources */,
@@ -2405,6 +2416,7 @@
 				CAB269E221B2038B00F8A43C /* OSInAppMessageBridgeEvent.m in Sources */,
 				9D1BD96A237A28FC00A064F7 /* OSCachedUniqueOutcome.m in Sources */,
 				CAA4ED0120646762005BD59B /* BadgeTests.m in Sources */,
+				DE3CD2FB270F9A6D00A5BECD /* OSNotification+OneSignal.m in Sources */,
 				7A5E726425A66EA400CB5605 /* OSStateSynchronizer.m in Sources */,
 				7AF9866C244975CF00C36EAE /* OSOutcomeSource.m in Sources */,
 				912412491E73369800E41FD7 /* OneSignalHelper.m in Sources */,
diff --git a/iOS_SDK/OneSignalSDK/OneSignalCore/Source/OSNotification+Internal.h b/iOS_SDK/OneSignalSDK/OneSignalCore/Source/OSNotification+Internal.h
@@ -34,7 +34,7 @@
 +(instancetype _Nonnull )parseWithApns:(nonnull NSDictionary *)message;
 - (void)setCompletionBlock:(OSNotificationDisplayResponse _Nonnull)completion;
 - (void)startTimeoutTimer;
-- (OSNotificationDisplayResponse _Nullable)getCompletionBlock;
+- (void)complete:(OSNotification *)notification;
 @end
 
 #endif /* OSNotification_Internal_h */
diff --git a/iOS_SDK/OneSignalSDK/OneSignalCore/Source/OSNotification.m b/iOS_SDK/OneSignalSDK/OneSignalCore/Source/OSNotification.m
@@ -306,22 +306,6 @@ - (void)setCompletionBlock:(OSNotificationDisplayResponse)completion {
     _completion = completion;
 }
 
- - (OSNotificationDisplayResponse)getCompletionBlock {
-     OSNotificationDisplayResponse block = ^(OSNotification *notification){
-         /*
-          If notification is null here then display was cancelled and we need to
-          reset the badge count to the value prior to receipt of this notif
-          */
-         if (!notification) {
-             // ECM TODO: We can't use sharedApplication in Core
-             //NSInteger previousBadgeCount = [UIApplication sharedApplication].applicationIconBadgeNumber;
-             [OneSignalUserDefaults.initShared saveIntegerForKey:ONESIGNAL_BADGE_KEY withValue:0];
-         }
-         [self complete:notification];
-     };
-     return block;
- }
-
  - (void)complete:(OSNotification *)notification {
      [_timeoutTimer invalidate];
      if (_completion) {
diff --git a/iOS_SDK/OneSignalSDK/Source/OSNotification+OneSignal.h b/iOS_SDK/OneSignalSDK/Source/OSNotification+OneSignal.h
@@ -0,0 +1,34 @@
+/**
+ * Modified MIT License
+ *
+ * Copyright 2021OneSignal
+ *
+ * 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>
+#import <OneSignalCore/OneSignalCore.h>
+
+@interface OSNotification (OneSignal)
+- (OSNotificationDisplayResponse _Nullable)getCompletionBlock;
+@end
diff --git a/iOS_SDK/OneSignalSDK/Source/OSNotification+OneSignal.m b/iOS_SDK/OneSignalSDK/Source/OSNotification+OneSignal.m
@@ -0,0 +1,46 @@
+/**
+ * Modified MIT License
+ *
+ * Copyright 2021OneSignal
+ *
+ * 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 "OSNotification+OneSignal.h"
+#import <UIKit/UIKit.h>
+@implementation OSNotification (OneSignal)
+ - (OSNotificationDisplayResponse)getCompletionBlock {
+     OSNotificationDisplayResponse block = ^(OSNotification *notification){
+         /*
+          If notification is null here then display was cancelled and we need to
+          reset the badge count to the value prior to receipt of this notif
+          */
+         if (!notification) {
+             NSInteger previousBadgeCount = [UIApplication sharedApplication].applicationIconBadgeNumber;
+             [OneSignalUserDefaults.initShared saveIntegerForKey:ONESIGNAL_BADGE_KEY withValue:previousBadgeCount];
+         }
+         [self complete:notification];
+     };
+     return block;
+ }
+@end
diff --git a/iOS_SDK/OneSignalSDK/Source/OneSignalHelper.m b/iOS_SDK/OneSignalSDK/Source/OneSignalHelper.m
@@ -40,6 +40,7 @@
 #import "OSMessagingController.h"
 #import "OneSignalNotificationCategoryController.h"
 #import "OneSignalReceiveReceiptsController.h"
+#import "OSNotification+OneSignal.h"
 
 #define NOTIFICATION_TYPE_ALL 7
 #pragma clang diagnostic push
