Merge pull request #1552 from OneSignal/feat/custom_events

[feat] Add new user-level custom events API to SDK

Author: nan-li

iOS_SDK/OneSignalDevApp/OneSignalDevApp/Base.lproj/Main.storyboard

@@ -28,9 +28,49 @@
 import Foundation
 import OneSignalFramework
 
+@objc
 class SwiftTest: NSObject {
     func testSwiftUserModel() {
         let token1 = OneSignal.User.pushSubscription.token
         let token = OneSignal.User.pushSubscription.token
     }
+
+    /**
+     Track multiple events with different properties.
+     Properties must pass `JSONSerialization.isValidJSONObject` to be accepted.
+     */
+    @objc
+    static func trackCustomEvents() {
+        print("Dev App: track an event with nil properties")
+        OneSignal.User.trackEvent(name: "null properties", properties: nil)
+
+        print("Dev App: track an event with empty properties")
+        OneSignal.User.trackEvent(name: "empty properties", properties: [:])
+
+        let formatter = DateFormatter()
+        formatter.dateStyle = .short
+
+        let mixedTypes = [
+            "string": "somestring",
+            "number": 5,
+            "bool": false,
+            "dateStr": formatter.string(from: Date())
+        ] as [String: Any]
+
+        let nestedDict = [
+            "someDict": mixedTypes,
+            "anotherDict": [
+                "foo": "bar",
+                "booleanVal": true,
+                "float": Float("3.14")!
+            ]
+        ]
+        let invalidProperties = ["date": Date()]
+
+        print("Dev App: track an event with a valid nested dictionary")
+        OneSignal.User.trackEvent(name: "nested dictionary", properties: nestedDict)
+
+        print("Dev App: track an event with invalid dictionary types")
+        OneSignal.User.trackEvent(name: "invalid dictionary", properties: invalidProperties)
+    }
 }

iOS_SDK/OneSignalDevApp/OneSignalDevApp/SwiftTest.swift

@@ -78,6 +78,7 @@
 @property (weak, nonatomic) IBOutlet UITextField *activityId;
 
 @property (weak, nonatomic) IBOutlet UITextField *languageTextField;
+@property (weak, nonatomic) IBOutlet UITextField *customEventsTextField;
 
 @end
 

iOS_SDK/OneSignalDevApp/OneSignalDevApp/ViewController.h

@@ -277,4 +277,21 @@ - (IBAction)dontRequireConsent:(id)sender {
     [OneSignal setConsentRequired:false];
 }
 
+- (IBAction)trackCustomEvents:(id)sender {    
+    NSLog(@"Dev App: tracking some preset custom events");
+    [OneSignal.User trackEventWithName:@"simple event" properties:@{@"foobarbaz": @"foobarbaz"}];
+    NSMutableDictionary *dict = [NSMutableDictionary new];
+    dict[@"dict"] = @{@"abc" : @"def"};
+    dict[@"false"] = false;
+    dict[@"int"] = @99;
+    [OneSignal.User trackEventWithName:@"complex event" properties:dict];
+    [SwiftTest trackCustomEvents];
+}
+
+- (IBAction)trackNamedCustomEvent:(id)sender {
+    NSString *name = self.customEventsTextField.text;
+    NSLog(@"Dev App: Tracking custom event with name: %@", name);
+    [OneSignal.User trackEventWithName:name properties:nil];
+}
+
 @end

iOS_SDK/OneSignalDevApp/OneSignalDevApp/ViewController.m

@@ -93,6 +93,8 @@
 		3C6299A92BEEA46C00649187 /* PrivacyInfo.xcprivacy in Resources */ = {isa = PBXBuildFile; fileRef = 3C6299A82BEEA46C00649187 /* PrivacyInfo.xcprivacy */; };
 		3C6299AB2BEEA4C000649187 /* PrivacyInfo.xcprivacy in Resources */ = {isa = PBXBuildFile; fileRef = 3C6299AA2BEEA4C000649187 /* PrivacyInfo.xcprivacy */; };
 		3C67F77A2BEB2B710085A0F0 /* SwitchUserIntegrationTests.swift in Sources */ = {isa = PBXBuildFile; fileRef = 3C67F7792BEB2B710085A0F0 /* SwitchUserIntegrationTests.swift */; };
+		3C68EFE52D93195E00F0896B /* OSCustomEventsExecutor.swift in Sources */ = {isa = PBXBuildFile; fileRef = 3C68EFE42D93195E00F0896B /* OSCustomEventsExecutor.swift */; };
+		3C68EFE72D931BA600F0896B /* OSRequestCustomEvents.swift in Sources */ = {isa = PBXBuildFile; fileRef = 3C68EFE62D931BA600F0896B /* OSRequestCustomEvents.swift */; };
 		3C70FA672D0B68A100031066 /* OneSignalClientError.h in Headers */ = {isa = PBXBuildFile; fileRef = 3C70FA652D0B68A100031066 /* OneSignalClientError.h */; settings = {ATTRIBUTES = (Public, ); }; };
 		3C70FA682D0B68A100031066 /* OneSignalClientError.m in Sources */ = {isa = PBXBuildFile; fileRef = 3C70FA662D0B68A100031066 /* OneSignalClientError.m */; };
 		3C789DBD293C2206004CF83D /* OSFocusInfluenceParam.m in Sources */ = {isa = PBXBuildFile; fileRef = 7A600B432453790700514A53 /* OSFocusInfluenceParam.m */; };
@@ -1269,6 +1271,8 @@
 		3C6299A82BEEA46C00649187 /* PrivacyInfo.xcprivacy */ = {isa = PBXFileReference; lastKnownFileType = text.xml; path = PrivacyInfo.xcprivacy; sourceTree = "<group>"; };
 		3C6299AA2BEEA4C000649187 /* PrivacyInfo.xcprivacy */ = {isa = PBXFileReference; lastKnownFileType = text.xml; path = PrivacyInfo.xcprivacy; sourceTree = "<group>"; };
 		3C67F7792BEB2B710085A0F0 /* SwitchUserIntegrationTests.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = SwitchUserIntegrationTests.swift; sourceTree = "<group>"; };
+		3C68EFE42D93195E00F0896B /* OSCustomEventsExecutor.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = OSCustomEventsExecutor.swift; sourceTree = "<group>"; };
+		3C68EFE62D931BA600F0896B /* OSRequestCustomEvents.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = OSRequestCustomEvents.swift; sourceTree = "<group>"; };
 		3C70FA652D0B68A100031066 /* OneSignalClientError.h */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.h; path = OneSignalClientError.h; sourceTree = "<group>"; };
 		3C70FA662D0B68A100031066 /* OneSignalClientError.m */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.objc; path = OneSignalClientError.m; sourceTree = "<group>"; };
 		3C7A39D42B7C18EE0082665E /* XCTest.framework */ = {isa = PBXFileReference; lastKnownFileType = wrapper.framework; name = XCTest.framework; path = Platforms/iPhoneOS.platform/Developer/Library/Frameworks/XCTest.framework; sourceTree = DEVELOPER_DIR; };
@@ -2144,6 +2148,7 @@
 			isa = PBXGroup;
 			children = (
 				3C8E6E0028AC0BA10031E48A /* OSIdentityOperationExecutor.swift */,
+				3C68EFE42D93195E00F0896B /* OSCustomEventsExecutor.swift */,
 				3C8E6DFE28AB09AE0031E48A /* OSPropertyOperationExecutor.swift */,
 				3CE795FA28DBDCE700736BD4 /* OSSubscriptionOperationExecutor.swift */,
 				3C9AD6BB2B2285FB00BC1540 /* OSUserExecutor.swift */,
@@ -2166,6 +2171,7 @@
 				3C9AD6C62B228A9800BC1540 /* OSRequestTransferSubscription.swift */,
 				3C9AD6C02B22886600BC1540 /* OSRequestUpdateSubscription.swift */,
 				3C9AD6C42B228A7300BC1540 /* OSRequestDeleteSubscription.swift */,
+				3C68EFE62D931BA600F0896B /* OSRequestCustomEvents.swift */,
 			);
 			path = Requests;
 			sourceTree = "<group>";
@@ -4401,8 +4407,10 @@
 				3C277D7E2BD76E0000857606 /* OSIdentityModelRepo.swift in Sources */,
 				3CEE90A72BFE6ABD00B0FB5B /* OSPropertiesSupportedProperty.swift in Sources */,
 				3C9AD6C12B22886600BC1540 /* OSRequestUpdateSubscription.swift in Sources */,
+				3C68EFE72D931BA600F0896B /* OSRequestCustomEvents.swift in Sources */,
 				3C0EF49E28A1DBCB00E5434B /* OSUserInternalImpl.swift in Sources */,
 				3C8E6DFF28AB09AE0031E48A /* OSPropertyOperationExecutor.swift in Sources */,
+				3C68EFE52D93195E00F0896B /* OSCustomEventsExecutor.swift in Sources */,
 				3C9AD6CB2B228B5200BC1540 /* OSRequestIdentifyUser.swift in Sources */,
 				3C9AD6BC2B2285FB00BC1540 /* OSUserExecutor.swift in Sources */,
 				3C9AD6C32B22887700BC1540 /* OSRequestCreateUser.swift in Sources */,

iOS_SDK/OneSignalSDK/OneSignal.xcodeproj/project.pbxproj

@@ -46,4 +46,8 @@ - (instancetype)initWithCode:(NSInteger)code message:(NSString* _Nonnull)message
     return self;
 }
 
+- (NSString *)description {
+    return [NSString stringWithFormat:@"<OneSignalClientError code: %ld, message: %@, response: %@, underlyingError: %@ >", (long)_code, _message, _response, _underlyingError];
+}
+
 @end

iOS_SDK/OneSignalSDK/OneSignalCore/Source/API/OneSignalClientError.m

@@ -205,6 +205,7 @@ typedef enum {ATTRIBUTED, NOT_ATTRIBUTED} FocusAttributionState;
 #define IDENTITY_EXECUTOR_BACKGROUND_TASK       @"IDENTITY_EXECUTOR_BACKGROUND_TASK_"
 #define PROPERTIES_EXECUTOR_BACKGROUND_TASK     @"PROPERTIES_EXECUTOR_BACKGROUND_TASK_"
 #define SUBSCRIPTION_EXECUTOR_BACKGROUND_TASK   @"SUBSCRIPTION_EXECUTOR_BACKGROUND_TASK_"
+#define CUSTOM_EVENTS_EXECUTOR_BACKGROUND_TASK  @"CUSTOM_EVENTS_EXECUTOR_BACKGROUND_TASK_"
 
 // OneSignal constants
 #define OS_PUSH @"push"
@@ -339,6 +340,8 @@ typedef enum {GET, POST, HEAD, PUT, DELETE, OPTIONS, CONNECT, TRACE, PATCH} HTTP
 #define OS_REMOVE_SUBSCRIPTION_DELTA                                        @"OS_REMOVE_SUBSCRIPTION_DELTA"
 #define OS_UPDATE_SUBSCRIPTION_DELTA                                        @"OS_UPDATE_SUBSCRIPTION_DELTA"
 
+#define OS_CUSTOM_EVENT_DELTA                                               @"OS_CUSTOM_EVENT_DELTA"
+
 // Operation Repo
 #define OS_OPERATION_REPO_DELTA_QUEUE_KEY                                   @"OS_OPERATION_REPO_DELTA_QUEUE_KEY"
 
@@ -361,6 +364,10 @@ typedef enum {GET, POST, HEAD, PUT, DELETE, OPTIONS, CONNECT, TRACE, PATCH} HTTP
 #define OS_SUBSCRIPTION_EXECUTOR_REMOVE_REQUEST_QUEUE_KEY                   @"OS_SUBSCRIPTION_EXECUTOR_REMOVE_REQUEST_QUEUE_KEY"
 #define OS_SUBSCRIPTION_EXECUTOR_UPDATE_REQUEST_QUEUE_KEY                   @"OS_SUBSCRIPTION_EXECUTOR_UPDATE_REQUEST_QUEUE_KEY"
 
+// Custom Events Executor
+#define OS_CUSTOM_EVENTS_EXECUTOR_DELTA_QUEUE_KEY                           @"OS_CUSTOM_EVENTS_EXECUTOR_DELTA_QUEUE_KEY"
+#define OS_CUSTOM_EVENTS_EXECUTOR_REQUEST_QUEUE_KEY                         @"OS_CUSTOM_EVENTS_EXECUTOR_REQUEST_QUEUE_KEY"
+
 // Live Activies Executor
 #define OS_LIVE_ACTIVITIES_EXECUTOR_UPDATE_TOKENS_KEY                       @"OS_LIVE_ACTIVITIES_EXECUTOR_UPDATE_TOKENS_KEY"
 #define OS_LIVE_ACTIVITIES_EXECUTOR_START_TOKENS_KEY                        @"OS_LIVE_ACTIVITIES_EXECUTOR_START_TOKENS_KEY"

iOS_SDK/OneSignalSDK/OneSignalCore/Source/OneSignalCommonDefines.h

@@ -32,11 +32,8 @@ import OneSignalCore
  */
 public protocol OSOperationExecutor {
     var supportedDeltas: [String] { get }
-    var deltaQueue: [OSDelta] { get }
 
     func enqueueDelta(_ delta: OSDelta)
     func cacheDeltaQueue()
     func processDeltaQueue(inBackground: Bool)
-
-    func processRequestQueue(inBackground: Bool)
 }