pass appData for In-App Messaging's test message (#9134)

fumito-ito · leotianlizhan · commit d88da006689b · 2022-02-01T12:40:59.000-08:00
* add test to check appData parsing

* parse appData for test message

* fix by formatter
diff --git a/FirebaseInAppMessaging/Sources/Data/FIRIAMFetchResponseParser.m b/FirebaseInAppMessaging/Sources/Data/FIRIAMFetchResponseParser.m
@@ -356,6 +356,7 @@ - (FIRIAMMessageDefinition *)convertToMessageDefinitionWithMessageDict:(NSDictio
     }
     if (isTestMessage) {
       return [[FIRIAMMessageDefinition alloc] initTestMessageWithRenderData:renderData
+                                                                    appData:dataBundle
                                                           experimentPayload:experimentPayload];
     } else {
       return [[FIRIAMMessageDefinition alloc] initWithRenderData:renderData
diff --git a/FirebaseInAppMessaging/Sources/Data/FIRIAMMessageDefinition.m b/FirebaseInAppMessaging/Sources/Data/FIRIAMMessageDefinition.m
@@ -70,12 +70,13 @@ - (instancetype)initWithRenderData:(FIRIAMMessageRenderData *)renderData
 }
 
 - (instancetype)initTestMessageWithRenderData:(FIRIAMMessageRenderData *)renderData
+                                      appData:(nullable NSDictionary *)appData
                             experimentPayload:(nullable ABTExperimentPayload *)experimentPayload {
   return [self initWithRenderData:renderData
                         startTime:0
                           endTime:0
                 triggerDefinition:@[]
-                          appData:nil
+                          appData:appData
                 experimentPayload:experimentPayload
                     isTestMessage:YES];
 }
diff --git a/FirebaseInAppMessaging/Sources/Private/Data/FIRIAMMessageDefinition.h b/FirebaseInAppMessaging/Sources/Private/Data/FIRIAMMessageDefinition.h
@@ -65,6 +65,7 @@ NS_ASSUME_NONNULL_BEGIN
  * Create a test message definition.
  */
 - (instancetype)initTestMessageWithRenderData:(FIRIAMMessageRenderData *)renderData
+                                      appData:(nullable NSDictionary *)appData
                             experimentPayload:(nullable ABTExperimentPayload *)experimentPayload;
 
 - (BOOL)messageHasExpired;
diff --git a/FirebaseInAppMessaging/Tests/Unit/FIRIAMDisplayExecutorTests.m b/FirebaseInAppMessaging/Tests/Unit/FIRIAMDisplayExecutorTests.m
@@ -519,6 +519,7 @@ - (void)testFollowingActionURLForTestMessage {
 
   FIRIAMMessageDefinition *testMessage =
       [[FIRIAMMessageDefinition alloc] initTestMessageWithRenderData:self.m1.renderData
+                                                             appData:nil
                                                    experimentPayload:nil];
 
   FIRInAppMessagingAction *testAction = [[FIRInAppMessagingAction alloc]
@@ -548,6 +549,7 @@ - (void)testClientTestMessageAvailableCase {
   OCMStub([self.mockTimeFetcher currentTimestampInSeconds]).andReturn(10);
   FIRIAMMessageDefinition *testMessage =
       [[FIRIAMMessageDefinition alloc] initTestMessageWithRenderData:self.m1.renderData
+                                                             appData:nil
                                                    experimentPayload:nil];
 
   [self.clientMessageCache setMessageData:@[ self.m2, testMessage, self.m4 ]];
@@ -756,6 +758,7 @@ - (void)testAnalyticsTrackingOnTestMessageClickCase {
 
   FIRIAMMessageDefinition *testMessage =
       [[FIRIAMMessageDefinition alloc] initTestMessageWithRenderData:self.m2.renderData
+                                                             appData:nil
                                                    experimentPayload:nil];
 
   [self.clientMessageCache setMessageData:@[ testMessage ]];
@@ -790,6 +793,7 @@ - (void)testAnalyticsTrackingOnTestMessageDismissCase {
 
   FIRIAMMessageDefinition *testMessage =
       [[FIRIAMMessageDefinition alloc] initTestMessageWithRenderData:self.m2.renderData
+                                                             appData:nil
                                                    experimentPayload:nil];
 
   [self.clientMessageCache setMessageData:@[ testMessage ]];
@@ -865,6 +869,7 @@ - (void)testNoAnalyticsTrackingOnTestMessage {
 
   FIRIAMMessageDefinition *testMessage =
       [[FIRIAMMessageDefinition alloc] initTestMessageWithRenderData:self.m1.renderData
+                                                             appData:nil
                                                    experimentPayload:nil];
 
   // not expecting triggering analytics recording
diff --git a/FirebaseInAppMessaging/Tests/Unit/FIRIAMFetchFlowTests.m b/FirebaseInAppMessaging/Tests/Unit/FIRIAMFetchFlowTests.m
@@ -315,6 +315,7 @@ - (void)testTurnIntoTestigModeOnSeeingTestMessage {
 
   FIRIAMMessageDefinition *testMessage =
       [[FIRIAMMessageDefinition alloc] initTestMessageWithRenderData:self.m2.renderData
+                                                             appData:nil
                                                    experimentPayload:nil];
 
   OCMStub([self.mockMessageFetcher
@@ -338,6 +339,7 @@ - (void)testNotTurningIntoTestingModeIfAlreadyInTestingMode {
 
   FIRIAMMessageDefinition *testMessage =
       [[FIRIAMMessageDefinition alloc] initTestMessageWithRenderData:self.m2.renderData
+                                                             appData:nil
                                                    experimentPayload:nil];
 
   OCMStub([self.mockMessageFetcher
diff --git a/FirebaseInAppMessaging/Tests/Unit/FIRIAMFetchResponseParserTests.m b/FirebaseInAppMessaging/Tests/Unit/FIRIAMFetchResponseParserTests.m
@@ -182,15 +182,22 @@ - (void)testParsingTestMessage {
   // In our fixture file used in this test, there is no fetch expiration time
   XCTAssertNil(fetchWaitTime);
 
-  XCTAssertEqual(2, [results count]);
+  XCTAssertEqual(3, [results count]);
   XCTAssertEqual(0, discardCount);
 
   // First is a test message and the second one is not.
   XCTAssertTrue(results[0].isTestMessage);
   XCTAssertTrue(results[0].renderData.renderingEffectSettings.isTestMessage);
+  XCTAssertNil(results[0].appData);
 
   XCTAssertFalse(results[1].isTestMessage);
   XCTAssertFalse(results[1].renderData.renderingEffectSettings.isTestMessage);
+
+  XCTAssertTrue(results[2].isTestMessage);
+  XCTAssertTrue(results[2].renderData.renderingEffectSettings.isTestMessage);
+  XCTAssertEqual(results[2].appData.count, 2);
+  XCTAssertEqualObjects(results[2].appData[@"a"], @"b");
+  XCTAssertEqualObjects(results[2].appData[@"c"], @"d");
 }
 
 - (void)testParsingInvalidTestMessageNodes {
diff --git a/FirebaseInAppMessaging/Tests/Unit/FIRIAMMessageClientCacheTests.m b/FirebaseInAppMessaging/Tests/Unit/FIRIAMMessageClientCacheTests.m
@@ -370,6 +370,7 @@ - (void)testFetchTestMessageFirstOnNextOnAppOpenDisplayMsg_ok {
 
   FIRIAMMessageDefinition *testMessage =
       [[FIRIAMMessageDefinition alloc] initTestMessageWithRenderData:m2.renderData
+                                                             appData:nil
                                                    experimentPayload:nil];
 
   // m1 and m3 are messages rendered on app open
diff --git a/FirebaseInAppMessaging/Tests/Unit/TestJsonDataWithTestMessageFromFetch.txt b/FirebaseInAppMessaging/Tests/Unit/TestJsonDataWithTestMessageFromFetch.txt
@@ -66,6 +66,33 @@
           }
         }
       ]
+    },
+    {
+      "vanillaPayload": {
+        "campaignId": "2108810525516234752"
+      },
+      "content": {
+        "modal": {
+          "title": {
+            "text": "FAST",
+            "hexColor": "#000000"
+          },
+          "body": {
+            "hexColor": "#000000"
+          },
+          "backgroundHexColor": "#ffffff"
+        }
+      },
+      "triggeringConditions": [
+        {
+          "fiamTrigger": "ON_FOREGROUND"
+        }
+      ],
+      "dataBundle": {
+        "a":"b",
+        "c":"d"
+      },
+      "isTestCampaign": true
     }
   ]
 }

Original file line number	Diff line number	Diff line change
`@@ -356,6 +356,7 @@ - (FIRIAMMessageDefinition *)convertToMessageDefinitionWithMessageDict:(NSDictio`
`356`	`356`	`}`
`357`	`357`	`if (isTestMessage) {`
`358`	`358`	`return [[FIRIAMMessageDefinition alloc] initTestMessageWithRenderData:renderData`
	`359`	`+ appData:dataBundle`
`359`	`360`	`experimentPayload:experimentPayload];`
`360`	`361`	`} else {`
`361`	`362`	`return [[FIRIAMMessageDefinition alloc] initWithRenderData:renderData`
Original file line number	Diff line number	Diff line change
`@@ -70,12 +70,13 @@ - (instancetype)initWithRenderData:(FIRIAMMessageRenderData *)renderData`
`70`	`70`	`}`
`71`	`71`
`72`	`72`	`- (instancetype)initTestMessageWithRenderData:(FIRIAMMessageRenderData *)renderData`
	`73`	`+ appData:(nullable NSDictionary *)appData`
`73`	`74`	`experimentPayload:(nullable ABTExperimentPayload *)experimentPayload {`
`74`	`75`	`return [self initWithRenderData:renderData`
`75`	`76`	`startTime:0`
`76`	`77`	`endTime:0`
`77`	`78`	`triggerDefinition:@[]`
`78`		`- appData:nil`
	`79`	`+ appData:appData`
`79`	`80`	`experimentPayload:experimentPayload`
`80`	`81`	`isTestMessage:YES];`
`81`	`82`	`}`
Original file line number	Diff line number	Diff line change
`@@ -66,6 +66,33 @@`
`66`	`66`	`}`
`67`	`67`	`}`
`68`	`68`	`]`
	`69`	`+ },`
	`70`	`+ {`
	`71`	`+ "vanillaPayload": {`
	`72`	`+ "campaignId": "2108810525516234752"`
	`73`	`+ },`
	`74`	`+ "content": {`
	`75`	`+ "modal": {`
	`76`	`+ "title": {`
	`77`	`+ "text": "FAST",`
	`78`	`+ "hexColor": "#000000"`
	`79`	`+ },`
	`80`	`+ "body": {`
	`81`	`+ "hexColor": "#000000"`
	`82`	`+ },`
	`83`	`+ "backgroundHexColor": "#ffffff"`
	`84`	`+ }`
	`85`	`+ },`
	`86`	`+ "triggeringConditions": [`
	`87`	`+ {`
	`88`	`+ "fiamTrigger": "ON_FOREGROUND"`
	`89`	`+ }`
	`90`	`+ ],`
	`91`	`+ "dataBundle": {`
	`92`	`+ "a":"b",`
	`93`	`+ "c":"d"`
	`94`	`+ },`
	`95`	`+ "isTestCampaign": true`
`69`	`96`	`}`
`70`	`97`	`]`
`71`	`98`	`}`