IAM liquid templating support #887

emawby · 2021-02-19T23:05:11Z

This PR adds support for IAM liquid templating tag substitution
The liquid rendering is handled by a javascript library added to the IAM by the dashboard. The SDKs just need to inject the tags for the player into the IAM html.

Injects tags into the IAM via the iamInfo.tags object in the IAM. I had to add it into the HTML before it was loaded into the webview to get it to render properly. This takes place in OSInAppMessageView
This PR also adds OSPlayerTags to cache tags in NSUserDefaults on the device
Tags are retrieved in parallel with the IAM HTML if a new property has_liquid is true in the IAM json. Tags will only be retrieved once per session.
currently is targeting local host for testing. This will be removed before merging

This change is

using player tags fixing player tags Fixing playerTags Fixing playerTags

Loading the tags in parallel to the HTML content and only loading once per session.

jkasten2

Reviewed 3 of 3 files at r1, 7 of 7 files at r2, 1 of 3 files at r3, 1 of 2 files at r4, 1 of 6 files at r5, 1 of 3 files at r6, 1 of 3 files at r7, 3 of 4 files at r8, 3 of 6 files at r9, 6 of 6 files at r10.
Reviewable status: all files reviewed, 7 unresolved discussions (waiting on @emawby)

iOS_SDK/OneSignalDevApp/OneSignalDevApp/AppDelegate.m, line 99 at r1 (raw file):

}

#define ONESIGNAL_APP_ID_KEY_FOR_TESTING @"1bcc4195-2039-4b18-83d7-2ab5b98daf76"

This is only a dev project but I recommend we don't change the app_id in a feature PR

iOS_SDK/OneSignalDevApp/OneSignalDevApp/AppDelegate.m, line 82 at r10 (raw file):

    [OneSignal setLaunchURLsInApp:YES];
    [OneSignal setProvidesNotificationSettingsView:NO];
    //[OneSignal sendTag:@"player_name" value:@"cached tag works!"];

Remove commented out code

iOS_SDK/OneSignalSDK/Source/OneSignal.m, line 422 at r2 (raw file):

+ (NSDictionary *)getPlayerTags {
    NSLog(@"ECM player tags: %@", playerTags);

Remove NSLog

iOS_SDK/OneSignalSDK/Source/OneSignalCommonDefines.h, line 36 at r10 (raw file):

#define OS_API_VERSION @"1"
#define OS_API_ACCEPT_HEADER @"application/vnd.onesignal.v" OS_API_VERSION @"+json"
#define OS_API_SERVER_URL @"http://192.168.1.86:3000/api/v1/"

URL needs to be put back

iOS_SDK/OneSignalSDK/Source/OSInAppMessage.m, line 179 at r10 (raw file):

    
    if (self.hasLiquid) {
        json[@"has_liquid"] = @"1";

I would expect this to be a boolean in JSON.

iOS_SDK/OneSignalSDK/Source/OSMessagingController.m, line 294 at r10 (raw file):

- (void)loadTags {
    self.loadedTags = YES;

Shouldn't loadedTags be set to true in the getTags callback below instead of here?

iOS_SDK/OneSignalSDK/UnitTests/InAppMessagingTests.m, line 217 at r10 (raw file):

}

- (void)testCorrectlyParsedHasLiquid {

Not sure I understand this test. Why do we want hasLiquid to be true on the message but not the redisplay?

The intent of the boolean is to ensure we only make the server call once per session.

emawby

Reviewable status: 9 of 16 files reviewed, 7 unresolved discussions (waiting on @emawby and @jkasten2)

iOS_SDK/OneSignalDevApp/OneSignalDevApp/AppDelegate.m, line 99 at r1 (raw file):