Merge pull request #887 from OneSignal/feature/iam_liquid_templating_support

IAM liquid templating support

Author: emawby

iOS_SDK/OneSignalDevApp/OneSignalDevApp/AppDelegate.m

@@ -81,7 +81,6 @@ - (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(
     [OneSignal setProvidesNotificationSettingsView:NO];
     [OneSignal setAppId:[AppDelegate getOneSignalAppId]];
     [OneSignal initWithLaunchOptions:launchOptions];
-
     [OneSignal addPermissionObserver:self];
     [OneSignal addSubscriptionObserver:self];
     [OneSignal addEmailSubscriptionObserver:self];

iOS_SDK/OneSignalSDK/OneSignal.xcodeproj/project.pbxproj

@@ -466,6 +466,10 @@
 		DE9877332591656200DE07D5 /* NSDateFormatter+OneSignal.m in Sources */ = {isa = PBXBuildFile; fileRef = DE98772A2591655800DE07D5 /* NSDateFormatter+OneSignal.m */; };
 		DE9877342591656300DE07D5 /* NSDateFormatter+OneSignal.m in Sources */ = {isa = PBXBuildFile; fileRef = DE98772A2591655800DE07D5 /* NSDateFormatter+OneSignal.m */; };
 		DE98773C2591656A00DE07D5 /* NSDateFormatter+OneSignal.h in Headers */ = {isa = PBXBuildFile; fileRef = DE9877292591654600DE07D5 /* NSDateFormatter+OneSignal.h */; };
+		DE9A5DAA25D1FD6B00FCEC21 /* OSPlayerTags.h in Headers */ = {isa = PBXBuildFile; fileRef = DE9A5DA925D1FD6B00FCEC21 /* OSPlayerTags.h */; };
+		DE9A5DB325D1FD8000FCEC21 /* OSPlayerTags.m in Sources */ = {isa = PBXBuildFile; fileRef = DE9A5DB225D1FD8000FCEC21 /* OSPlayerTags.m */; };
+		DE9A5DB425D1FD8000FCEC21 /* OSPlayerTags.m in Sources */ = {isa = PBXBuildFile; fileRef = DE9A5DB225D1FD8000FCEC21 /* OSPlayerTags.m */; };
+		DE9A5DB525D1FD8000FCEC21 /* OSPlayerTags.m in Sources */ = {isa = PBXBuildFile; fileRef = DE9A5DB225D1FD8000FCEC21 /* OSPlayerTags.m */; };
 		DEE8198D24E21DF000868CBA /* UIApplication+OneSignal.h in Headers */ = {isa = PBXBuildFile; fileRef = DE20425C24E21C1500350E4F /* UIApplication+OneSignal.h */; };
 		DEF5CCF52539321A0003E9CC /* AppDelegate.m in Sources */ = {isa = PBXBuildFile; fileRef = DEF5CCF42539321A0003E9CC /* AppDelegate.m */; };
 		DEF5CCFB2539321A0003E9CC /* ViewController.m in Sources */ = {isa = PBXBuildFile; fileRef = DEF5CCFA2539321A0003E9CC /* ViewController.m */; };
@@ -784,6 +788,8 @@
 		DE5EFECB24D8DC0E0032632D /* OSInAppMessageViewControllerOverrider.h */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.h; path = OSInAppMessageViewControllerOverrider.h; sourceTree = "<group>"; };
 		DE9877292591654600DE07D5 /* NSDateFormatter+OneSignal.h */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.h; path = "NSDateFormatter+OneSignal.h"; sourceTree = "<group>"; };
 		DE98772A2591655800DE07D5 /* NSDateFormatter+OneSignal.m */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.objc; path = "NSDateFormatter+OneSignal.m"; sourceTree = "<group>"; };
+		DE9A5DA925D1FD6B00FCEC21 /* OSPlayerTags.h */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.h; path = OSPlayerTags.h; sourceTree = "<group>"; };
+		DE9A5DB225D1FD8000FCEC21 /* OSPlayerTags.m */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.objc; path = OSPlayerTags.m; sourceTree = "<group>"; };
 		DEF5CCF12539321A0003E9CC /* UnitTestApp.app */ = {isa = PBXFileReference; explicitFileType = wrapper.application; includeInIndex = 0; path = UnitTestApp.app; sourceTree = BUILT_PRODUCTS_DIR; };
 		DEF5CCF32539321A0003E9CC /* AppDelegate.h */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.h; path = AppDelegate.h; sourceTree = "<group>"; };
 		DEF5CCF42539321A0003E9CC /* AppDelegate.m */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.objc; path = AppDelegate.m; sourceTree = "<group>"; };
@@ -1257,6 +1263,8 @@
 				7A93265025A8DD4300BBEC27 /* OSUserState.m */,
 				7A93266925AC985500BBEC27 /* OSLocationState.h */,
 				7A93267225AC986400BBEC27 /* OSLocationState.m */,
+				DE9A5DA925D1FD6B00FCEC21 /* OSPlayerTags.h */,
+				DE9A5DB225D1FD8000FCEC21 /* OSPlayerTags.m */,
 			);
 			name = State;
 			sourceTree = "<group>";
@@ -1464,6 +1472,7 @@
 				7A5E721B25A66E2900CB5605 /* OSUserStateEmailSynchronizer.h in Headers */,
 				7AF9865624452A8C00C36EAE /* OSInfluence.h in Headers */,
 				912412411E73342200E41FD7 /* UNUserNotificationCenter+OneSignal.h in Headers */,
+				DE9A5DAA25D1FD6B00FCEC21 /* OSPlayerTags.h in Headers */,
 				7AF98684244A32D900C36EAE /* OSOutcomeEventsV2Repository.h in Headers */,
 				CA8E18FC2193A1A5009DA223 /* NSTimerOverrider.h in Headers */,
 				91B6EA451E86555200B5CF01 /* OSObservable.h in Headers */,
@@ -1724,6 +1733,7 @@
 				DE98772B2591656200DE07D5 /* NSDateFormatter+OneSignal.m in Sources */,
 				7AD172382416D53B00A78B19 /* OSInAppMessageLocationPrompt.m in Sources */,
 				9124120E1E73342200E41FD7 /* OneSignal.m in Sources */,
+				DE9A5DB325D1FD8000FCEC21 /* OSPlayerTags.m in Sources */,
 				CACBAA97218A6243000ACAA5 /* OSMessagingController.m in Sources */,
 				CA36F35921C33A2500300C77 /* OSInAppMessageController.m in Sources */,
 				CA08FC731FE99AFD004C445F /* OneSignalClient.m in Sources */,
@@ -1824,6 +1834,7 @@
 				DE9877332591656200DE07D5 /* NSDateFormatter+OneSignal.m in Sources */,
 				7AD172392416D53B00A78B19 /* OSInAppMessageLocationPrompt.m in Sources */,
 				CACBAA98218A6243000ACAA5 /* OSMessagingController.m in Sources */,
+				DE9A5DB425D1FD8000FCEC21 /* OSPlayerTags.m in Sources */,
 				CA36F35A21C33A2500300C77 /* OSInAppMessageController.m in Sources */,
 				CA08FC741FE99AFF004C445F /* OneSignalClient.m in Sources */,
 				91F58D861E7C88250017D24D /* OneSignalNotificationSettingsIOS9.m in Sources */,
@@ -2030,6 +2041,7 @@
 				7AAA606A2485D0420004FADE /* OSMigrationController.m in Sources */,
 				CACBAA9F218A6243000ACAA5 /* OSInAppMessageView.m in Sources */,
 				CA4742E7218B8FF30020DC8C /* OSTriggerController.m in Sources */,
+				DE9A5DB525D1FD8000FCEC21 /* OSPlayerTags.m in Sources */,
 				4529DEEA1FA8360C00CEAB1D /* UIApplicationOverrider.m in Sources */,
 				912412281E73342200E41FD7 /* OneSignalMobileProvision.m in Sources */,
 				7A93269E25AF4F0300BBEC27 /* OSPendingCallbacks.m in Sources */,

iOS_SDK/OneSignalSDK/Source/OSInAppMessage.h

@@ -49,6 +49,7 @@ NS_ASSUME_NONNULL_BEGIN
 @property (nonatomic) BOOL dragToDismissDisabled;
 @property (nonatomic) NSNumber *height;
 @property (nonatomic, nullable) NSDate *endTime;
+@property (nonatomic) BOOL hasLiquid;
 
 - (BOOL)isBanner;
 - (BOOL)takeActionAsUnique;

iOS_SDK/OneSignalSDK/Source/OSInAppMessage.m

@@ -110,6 +110,10 @@ + (instancetype)instanceWithJson:(NSDictionary * _Nonnull)json {
         NSDate *endTime = [dateFormatter dateFromString:stringEndTime];
         message.endTime = endTime;
     }
+    
+    if (json[@"has_liquid"]) {
+        message.hasLiquid = YES;
+    }
 
     if (json[@"triggers"] && [json[@"triggers"] isKindOfClass:[NSArray class]]) {
         let triggers = [NSMutableArray new];
@@ -171,11 +175,15 @@ -(NSDictionary *)jsonRepresentation {
 
     json[@"end_time"] = [[NSDateFormatter iso8601DateFormatter] stringFromDate:self.endTime];
 
+    if (self.hasLiquid) {
+        json[@"has_liquid"] = @true;
+    }
+    
     return json;
 }
 
 - (NSString *)description {
-    return [NSString stringWithFormat:@"OSInAppMessage:  \nmessageId: %@  \ntriggers: %@ \ndisplayed_in_session: %@ \ndisplayStats: %@ \nendTime: %@", self.messageId, self.triggers, self.isDisplayedInSession ? @"YES" : @"NO", self.displayStats, self.endTime];
+    return [NSString stringWithFormat:@"OSInAppMessage:  \nmessageId: %@  \ntriggers: %@ \ndisplayed_in_session: %@ \ndisplayStats: %@ \nendTime: %@ \nhasLiquid: %@", self.messageId, self.triggers, self.isDisplayedInSession ? @"YES" : @"NO", self.displayStats, self.endTime, self.hasLiquid ? @"YES" : @"NO"];
 }
 
 - (BOOL)isEqual:(id)object {
@@ -204,6 +212,7 @@ - (void)encodeWithCoder:(NSCoder *)encoder {
     //TODO: This will need to be changed when we add core data or database to iOS, see android implementation for reference
     [encoder encodeBool:_isDisplayedInSession forKey:@"displayed_in_session"];
     [encoder encodeObject:_endTime forKey:@"endTime"];
+    [encoder encodeBool:_hasLiquid forKey:@"hasLiquid"];
 }
 
 - (id)initWithCoder:(NSCoder *)decoder {
@@ -215,6 +224,7 @@ - (id)initWithCoder:(NSCoder *)decoder {
         //TODO: This will need to be changed when we add core data or database to iOS, see android implementation for reference
         _isDisplayedInSession = [decoder decodeBoolForKey:@"displayed_in_session"];
         _endTime = [decoder decodeObjectForKey:@"endTime"];
+        _hasLiquid = [decoder decodeObjectForKey:@"hasLiquid"];
     }
     return self;
 }

iOS_SDK/OneSignalSDK/Source/OSInAppMessageView.m

@@ -30,6 +30,7 @@
 #import <WebKit/WebKit.h>
 #import "OSInAppMessageAction.h"
 #import "OneSignalViewHelper.h"
+#import "OSPlayerTags.h"
 
 
 @interface OSInAppMessageView () <UIScrollViewDelegate, WKUIDelegate, WKNavigationDelegate>
@@ -53,12 +54,45 @@ - (instancetype _Nonnull)initWithMessage:(OSInAppMessage *)inAppMessage withScri
     return self;
 }
 
+- (NSString *)getTagsString {
+    NSError *error;
+    OSPlayerTags *tags = [OneSignal getPlayerTags];
+    if (!tags.allTags) {
+        return nil;
+    }
+    NSData *jsonData = [NSJSONSerialization dataWithJSONObject:tags.allTags
+                                                       options:NSJSONWritingPrettyPrinted
+                                                         error:&error];
+    NSString *jsonString;
+    if (!jsonData) {
+        [OneSignal onesignalLog:ONE_S_LL_ERROR message:
+         [NSString stringWithFormat:@"Error parsing tag dictionary to json :%@",error.localizedDescription]];
+    } else {
+         jsonString = [[NSString alloc] initWithData:jsonData encoding:NSUTF8StringEncoding];
+    }
+    return jsonString;
+}
+
+- (NSString *)addTagsToHTML:(NSString *)html {
+    NSString *tags = [self getTagsString];
+    if (!tags) {
+        return html;
+    }
+    //Script to set the tags for liquid tag substitution
+    NSString *newHtml = [NSString stringWithFormat:@"%@ \n\n\
+                         <script> \
+                            setPlayerTags(%@);\
+                         </script>",html, tags];
+    return newHtml;
+}
+
 - (void)loadedHtmlContent:(NSString *)html withBaseURL:(NSURL *)url {
     // UI Update must be done on the main thread
     NSLog(@"11111 [self.webView loadHTMLString:html baseURL:url];");
     dispatch_sync(dispatch_get_main_queue(), ^{
         NSLog(@"222222 [self.webView loadHTMLString:html baseURL:url];");
-        [self.webView loadHTMLString:html baseURL:url];
+        NSString *taggedHTML = [self addTagsToHTML:html];
+        [self.webView loadHTMLString:taggedHTML baseURL:url];
     });
 }
 
@@ -160,7 +194,6 @@ - (void)webView:(WKWebView *)webView didFinishNavigation:(WKNavigation *)navigat
     // WebView finished loading
     if (self.loaded)
         return;
-    
     self.loaded = true;
 }
 

iOS_SDK/OneSignalSDK/Source/OSInAppMessageViewController.h

@@ -48,6 +48,7 @@ NS_ASSUME_NONNULL_BEGIN
 
 @property (weak, nonatomic, nullable) id<OSInAppMessageViewControllerDelegate> delegate;
 @property (strong, nonatomic, nonnull) OSInAppMessage *message;
+@property (nonatomic) BOOL waitForTags;
 
 - (instancetype _Nonnull)initWithMessage:(OSInAppMessage *)inAppMessage delegate:(id<OSInAppMessageViewControllerDelegate>)delegate;
 - (void)dismissCurrentInAppMessage;

iOS_SDK/OneSignalSDK/Source/OSInAppMessageViewController.m

@@ -90,6 +90,9 @@ @interface OSInAppMessageViewController ()
 // This is a fail safe for cases where global contraints are nil and we try to modify them on dismissal of an IAM
 @property (nonatomic) BOOL didPageRenderingComplete;
 
+// BOOL to track if the message content has loaded before tags have finished loading for liquid templating
+@property (nonatomic, nullable) NSString *pendingHTMLContent;
+
 @end
 
 @implementation OSInAppMessageViewController
@@ -229,13 +232,24 @@ - (OSResultSuccessBlock)messageContentOnSuccess {
             [[OneSignal sessionManager] onInAppMessageReceived:self.message.messageId];
 
         let baseUrl = [NSURL URLWithString:OS_IAM_WEBVIEW_BASE_URL];
-        NSString* htmlContent = data[@"html"];
-        [self.messageView loadedHtmlContent:htmlContent withBaseURL:baseUrl];
-        
+        self.pendingHTMLContent = data[@"html"];
         self.maxDisplayTime = [data[@"display_duration"] doubleValue];
+        if (self.waitForTags) {
+            return;
+        }
+        [self.messageView loadedHtmlContent:self.pendingHTMLContent withBaseURL:baseUrl];
+        self.pendingHTMLContent = nil;
     };
 }
 
+- (void)setWaitForTags:(BOOL)waitForTags {
+    _waitForTags = waitForTags;
+    if (!waitForTags && self.pendingHTMLContent) {
+        [self.messageView loadedHtmlContent:self.pendingHTMLContent withBaseURL:[NSURL URLWithString:OS_IAM_WEBVIEW_BASE_URL]];
+        self.pendingHTMLContent = nil;
+    }
+}
+
 - (void)loadMessageContent {
     [self.message loadMessageHTMLContentWithResult:[self messageContentOnSuccess] failure:^(NSError *error) {
         [self encounteredErrorLoadingMessageContent:error];

iOS_SDK/OneSignalSDK/Source/OSMessagingController.m

@@ -81,6 +81,8 @@ @interface OSMessagingController ()
 
 @property (nonatomic) BOOL isAppInactive;
 
+@property (nonatomic) BOOL calledLoadTags;
+
 @end
 
 @implementation OSMessagingController
@@ -171,6 +173,7 @@ - (void)updateInAppMessagesFromOnSession:(NSArray<OSInAppMessage *> *)newMessage
     if (self.messages)
         [OneSignalUserDefaults.initStandard saveCodeableDataForKey:OS_IAM_MESSAGES_ARRAY withValue:self.messages];
 
+    self.calledLoadTags = NO;
     [self resetRedisplayMessagesBySession];
     [self evaluateMessages];
     [self deleteOldRedisplayedInAppMessages];
@@ -277,13 +280,24 @@ - (void)displayMessage:(OSInAppMessage *)message {
 
 - (void)showAndImpressMessage:(OSInAppMessage *)message {
     self.viewController = [[OSInAppMessageViewController alloc] initWithMessage:message delegate:self];
-
+    if (message.hasLiquid && !self.calledLoadTags) {
+        self.viewController.waitForTags = YES;
+        [self loadTags];
+    }
     dispatch_async(dispatch_get_main_queue(), ^{
            [[self.viewController view] setNeedsLayout];
            [self messageViewImpressionRequest:message];
     });
 }
 
+- (void)loadTags {
+    self.calledLoadTags = YES;
+    [OneSignal getTags:^(NSDictionary *result) {
+        if (self.viewController) {
+            self.viewController.waitForTags = NO;
+        }
+    }];
+}
 - (void)messageViewPageImpressionRequest:(OSInAppMessage *)message withPageId:(NSString *)pageId {
     if (message.isPreview) {
         [OneSignal onesignal_Log:ONE_S_LL_VERBOSE message:[NSString stringWithFormat:@"Not sending page impression for preview message. ID: %@",pageId]];

iOS_SDK/OneSignalSDK/Source/OSPlayerTags.h

@@ -0,0 +1,48 @@
+/**
+Modified MIT License
+
+Copyright 2021 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.
+*/
+
+@interface OSPlayerTags : NSObject
+
+@property (nonatomic, strong, nullable, readwrite) NSMutableDictionary *tagsToSend;
+
+- (NSDictionary *) allTags;
+
+- (void)setTags:(NSDictionary *)tags;
+
+- (void)addTags:(NSDictionary *)tags;
+
+- (void)addTagValue:(NSString *)value forKey:(NSString *)key;
+
+- (void)deleteTags:(NSArray *)keys;
+
+- (NSString *)tagValueForKey:(NSString *)key;
+
+- (void)saveTagsToUserDefaults;
+
+- (NSDictionary *_Nonnull)toDictionary;
+
+@end