Merge pull request #1017 from OneSignal/feat/OSInAppMessage-jsonRepresentation

Add `jsonRepresentation` to OSInAppMessage

Author: nan-li

iOS_SDK/OneSignalSDK/Source/OSInAppMessageInternal.m

@@ -30,6 +30,13 @@
 #import "OneSignalCommonDefines.h"
 
 @implementation OSInAppMessage
+
+- (NSDictionary *)jsonRepresentation {
+    NSMutableDictionary *json = [NSMutableDictionary new];
+    json[@"messageId"] = self.messageId;
+    return json;
+}
+
 @end
 
 @interface OSInAppMessageInternal ()
@@ -92,6 +99,7 @@ + (instancetype)instanceWithData:(NSData *)data {
 + (instancetype)instanceWithJson:(NSDictionary * _Nonnull)json {
     let message = [OSInAppMessageInternal new];
 
+    // "id" is expected instead of "messageId" when parsing JSON from the backend
     if (json[@"id"] && [json[@"id"] isKindOfClass:[NSString class]])
         message.messageId = json[@"id"];
     else
@@ -156,7 +164,7 @@ + (instancetype)instancePreviewFromNotification:(OSNotification *)notification {
 -(NSDictionary *)jsonRepresentation {
     let json = [NSMutableDictionary new];
 
-    json[@"id"] = self.messageId;
+    json[@"messageId"] = self.messageId;
     json[@"variants"] = self.variants;
 
     let triggers = [NSMutableArray new];

iOS_SDK/OneSignalSDK/Source/OneSignal.h

@@ -166,6 +166,9 @@ typedef NS_ENUM(NSUInteger, OSNotificationActionType)  {
 
 @property (strong, nonatomic, nonnull) NSString *messageId;
 
+// Convert the object into a NSDictionary
+- (NSDictionary *_Nonnull)jsonRepresentation;
+
 @end
 
 @interface OSInAppMessageOutcome : NSObject

iOS_SDK/OneSignalSDK/UnitTests/InAppMessagingIntegrationTests.m

@@ -490,7 +490,8 @@ - (void)testIAMClickLaunchesAPIRequestMultipleTimes_Redisplay {
     let firstTrigger = [OSTrigger customTriggerWithProperty:@"prop1" withOperator:OSTriggerOperatorTypeExists withValue:nil];
 
     let message = [OSInAppMessageTestHelper testMessageWithTriggers:@[@[firstTrigger]] withRedisplayLimit:limit delay:@(delay)];
-    let registrationResponse = [OSInAppMessageTestHelper testRegistrationJsonWithMessages:@[message.jsonRepresentation]];
+    NSDictionary* json = [OSInAppMessageTestHelper convertIAMtoJson:message];
+    let registrationResponse = [OSInAppMessageTestHelper testRegistrationJsonWithMessages:@[json]];
 
     [OneSignalClientOverrider setMockResponseForRequest:NSStringFromClass([OSRequestRegisterUser class]) withResponse:registrationResponse];
 
@@ -1525,7 +1526,8 @@ - (void)testInAppMessageDisplayMultipleTimesSessionDurationTrigger {
     [OneSignal pauseInAppMessages:NO];
     let trigger = [OSTrigger dynamicTriggerWithKind:OS_DYNAMIC_TRIGGER_KIND_SESSION_TIME withOperator:OSTriggerOperatorTypeGreaterThanOrEqualTo withValue:@0];
     let message = [OSInAppMessageTestHelper testMessageWithTriggers:@[@[trigger]] withRedisplayLimit:5 delay:@30];
-    let registrationJson = [OSInAppMessageTestHelper testRegistrationJsonWithMessages:@[message.jsonRepresentation]];
+    NSDictionary* json = [OSInAppMessageTestHelper convertIAMtoJson:message];
+    let registrationJson = [OSInAppMessageTestHelper testRegistrationJsonWithMessages:@[json]];
 
     //Time interval mock
     NSDateComponents* comps = [[NSDateComponents alloc]init];
@@ -1642,7 +1644,8 @@ - (void)testIAMLifecyleEventsFired {
  Mock response JSON and initializes the OneSignal SDK
  */
 - (void)initOneSignalWithInAppMessage:(OSInAppMessageInternal *)message {
-    let registrationJson = [OSInAppMessageTestHelper testRegistrationJsonWithMessages:@[message.jsonRepresentation]];
+    NSDictionary* json = [OSInAppMessageTestHelper convertIAMtoJson:message];
+    let registrationJson = [OSInAppMessageTestHelper testRegistrationJsonWithMessages:@[json]];
     [self initOneSignalWithRegistrationJSON:registrationJson];
 }
 

iOS_SDK/OneSignalSDK/UnitTests/OSInAppMessagingHelpers.h

@@ -61,6 +61,7 @@ NS_ASSUME_NONNULL_BEGIN
 + (OSInAppMessageInternal *)testMessageWithTriggers:(NSArray <NSArray<OSTrigger *> *> *)triggers;
 + (OSInAppMessageInternal *)testMessageWithTriggers:(NSArray <NSArray<OSTrigger *> *> *)triggers withRedisplayLimit:(NSInteger)limit delay:(NSNumber *)delay;
 + (OSInAppMessageInternal *)testMessageWithPastEndTime:(BOOL)pastEndTime;
++ (NSDictionary *)convertIAMtoJson:(OSInAppMessageInternal *)message;
 + (NSDictionary *)testRegistrationJsonWithMessages:(NSArray<NSDictionary *> *)messages;
 + (NSDictionary *)testMessageJsonWithTriggerPropertyName:(NSString *)property withId:(NSString *)triggerId withOperator:(OSTriggerOperatorType)type withValue:(id)value;
 + (NSDictionary*)testInAppMessageGetContainsWithHTML:(NSString *)html;

iOS_SDK/OneSignalSDK/UnitTests/OSInAppMessagingHelpers.m

@@ -245,6 +245,14 @@ + (OSInAppMessageInternal *)testMessageWithTriggers:(NSArray <NSArray<OSTrigger
     return message;
 }
 
+// jsonRepresentation uses key of "messageId" but we need to use key of "id" for creating IAM, etc.
++ (NSDictionary *)convertIAMtoJson:(OSInAppMessageInternal *)message {
+    NSMutableDictionary *json = [message.jsonRepresentation mutableCopy];
+    json[@"id"] = message.messageId;
+    [json removeObjectForKey:@"messageId"];
+    return json;
+}
+
 + (NSDictionary *)testRegistrationJsonWithMessages:(NSArray<NSDictionary *> *)messages {
     return @{
         @"id" : @"1234",

iOS_SDK/OneSignalSDK/UnitTests/UnitTests.m

@@ -3265,6 +3265,32 @@ - (void)testNotificationJson {
     XCTAssertEqualObjects(json[@"templateName"], @"Template name");
 }
 
+- (void)testInAppMessageInternalJson {
+    NSDictionary *messageJson = @{
+        @"id" : OS_TEST_MESSAGE_ID,
+        @"variants" : @{
+            @"ios" : @{
+                @"default" : OS_TEST_MESSAGE_VARIANT_ID,
+                @"en" : OS_TEST_ENGLISH_VARIANT_ID
+            },
+            @"all" : @{
+                @"default" : @"some_message_id"
+            }
+        },
+        @"triggers" : @[],
+        @"has_liquid" : @true,
+    };
+    OSInAppMessageInternal *message = [OSInAppMessageInternal instanceWithJson:messageJson];
+    NSDictionary *json = [message jsonRepresentation];
+    
+    XCTAssertEqualObjects(json[@"messageId"], OS_TEST_MESSAGE_ID);
+    XCTAssertNil(json[@"id"]);
+    XCTAssertEqualObjects(json[@"variants"][@"ios"][@"default"], OS_TEST_MESSAGE_VARIANT_ID);
+    XCTAssertEqualObjects(json[@"variants"][@"all"][@"default"], @"some_message_id");
+    XCTAssertEqualObjects(json[@"triggers"], @[]);
+    XCTAssertTrue(json[@"has_liquid"]);
+}
+
 - (void)testLaunchURL {
 
     // 1. Init OneSignal with app start