Only log the URL follow event in messageClicked:withAction: if there's a URL to follow (#5564)

* Only log the URL follow event in messageClicked:withAction: if there's a URL to follow

* Add test case for empty action URL

Author: christibbs

FirebaseInAppMessaging/Sources/Flows/FIRIAMDisplayExecutor.m

@@ -105,16 +105,18 @@ - (void)messageClicked:(FIRInAppMessagingDisplayMessage *)inAppMessage
     [self recordValidImpression:_currentMsgBeingDisplayed.renderData.messageID
                 withMessageName:_currentMsgBeingDisplayed.renderData.name];
 
-    [self.analyticsEventLogger
-        logAnalyticsEventForType:FIRIAMAnalyticsEventActionURLFollow
-                   forCampaignID:_currentMsgBeingDisplayed.renderData.messageID
-                withCampaignName:_currentMsgBeingDisplayed.renderData.name
-                   eventTimeInMs:nil
-                      completion:^(BOOL success) {
-                        FIRLogDebug(kFIRLoggerInAppMessaging, @"I-IAM400032",
-                                    @"Logging analytics event for url following %@",
-                                    success ? @"succeeded" : @"failed");
-                      }];
+    if (action.actionURL) {
+      [self.analyticsEventLogger
+          logAnalyticsEventForType:FIRIAMAnalyticsEventActionURLFollow
+                     forCampaignID:_currentMsgBeingDisplayed.renderData.messageID
+                  withCampaignName:_currentMsgBeingDisplayed.renderData.name
+                     eventTimeInMs:nil
+                        completion:^(BOOL success) {
+                          FIRLogDebug(kFIRLoggerInAppMessaging, @"I-IAM400032",
+                                      @"Logging analytics event for url following %@",
+                                      success ? @"succeeded" : @"failed");
+                        }];
+    }
   }
 
   NSURL *actionURL = action.actionURL;

FirebaseInAppMessaging/Tests/Unit/FIRIAMDisplayExecutorTests.m

@@ -206,7 +206,7 @@ @interface FIRIAMDisplayExecutorTests : XCTestCase
 @property id<FIRInAppMessagingDisplay> mockMessageDisplayComponent;
 
 // four pre-defined messages
-@property FIRIAMMessageDefinition *m1, *m2, *m3, *m4;
+@property FIRIAMMessageDefinition *m1, *m2, *m3, *m4, *m5;
 @end
 
 @implementation FIRIAMDisplayExecutorTests
@@ -220,7 +220,7 @@ - (void)setupMessageTexture {
   FIRIAMDisplayTriggerDefinition *contextualTriggerDefinition =
       [[FIRIAMDisplayTriggerDefinition alloc] initWithFirebaseAnalyticEvent:@"test_event"];
 
-  // m2 and m4 will be of app open trigger
+  // m2, m4, and m5 will be of app open trigger
   FIRIAMDisplayTriggerDefinition *appOpentriggerDefinition =
       [[FIRIAMDisplayTriggerDefinition alloc] initForAppForegroundTrigger];
 
@@ -338,6 +338,35 @@ - (void)setupMessageTexture {
                                                         appData:@{@"a" : @"b", @"up" : @"dog"}
                                               experimentPayload:experimentPayload
                                                   isTestMessage:NO];
+
+  FIRIAMMessageContentDataForTesting *m5ContentData = [[FIRIAMMessageContentDataForTesting alloc]
+           initWithMessageTitle:nil
+                    messageBody:nil
+               actionButtonText:nil
+      secondaryActionButtonText:nil
+                      actionURL:nil
+             secondaryActionURL:nil
+                       imageURL:[NSURL URLWithString:@"https://google.com/image"]
+              landscapeImageURL:nil
+                  hasImageError:NO];
+
+  FIRIAMRenderingEffectSetting *renderSetting5 =
+      [FIRIAMRenderingEffectSetting getDefaultRenderingEffectSetting];
+  renderSetting5.viewMode = FIRIAMRenderAsImageOnlyView;
+
+  FIRIAMMessageRenderData *renderData5 =
+      [[FIRIAMMessageRenderData alloc] initWithMessageID:@"m5"
+                                             messageName:@"name"
+                                             contentData:m5ContentData
+                                         renderingEffect:renderSetting5];
+
+  self.m5 = [[FIRIAMMessageDefinition alloc] initWithRenderData:renderData5
+                                                      startTime:activeStartTime
+                                                        endTime:activeEndTime
+                                              triggerDefinition:@[ appOpentriggerDefinition ]
+                                                        appData:nil
+                                              experimentPayload:nil
+                                                  isTestMessage:NO];
 }
 
 NSTimeInterval DISPLAY_MIN_INTERVALS = 1;
@@ -599,8 +628,37 @@ - (void)testAnalyticsTrackingOnMessageClickCase {
 
   [self.clientMessageCache setMessageData:@[ self.m2 ]];
 
+  FIRInAppMessagingAction *m2Action = [[FIRInAppMessagingAction alloc]
+      initWithActionText:self.m2.renderData.contentData.actionButtonText
+               actionURL:self.m2.renderData.contentData.actionURL];
   FIRIAMMessageDisplayForTesting *display = [[FIRIAMMessageDisplayForTesting alloc]
-      initWithDelegateInteraction:FIRInAppMessagingDelegateInteractionClick];
+      initWithDelegateInteraction:FIRInAppMessagingDelegateInteractionClick
+                           action:m2Action];
+  self.displayExecutor.messageDisplayComponent = display;
+
+  [self.displayExecutor checkAndDisplayNextAppForegroundMessage];
+  OCMVerifyAll((id)self.mockAnalyticsEventLogger);
+}
+
+- (void)testAnalyticsTrackingOnMessageClickCaseWithNoActionURL {
+  // This setup allows next message to be displayed from display interval perspective.
+  OCMStub([self.mockTimeFetcher currentTimestampInSeconds])
+      .andReturn(DISPLAY_MIN_INTERVALS * 60 + 100);
+
+  // We expect two analytics events for a click action:
+  // An impression event and an action URL follow event
+  OCMExpect([self.mockAnalyticsEventLogger
+      logAnalyticsEventForType:FIRIAMAnalyticsEventMessageImpression
+                 forCampaignID:[OCMArg isEqual:self.m5.renderData.messageID]
+              withCampaignName:[OCMArg any]
+                 eventTimeInMs:[OCMArg any]
+                    completion:[OCMArg any]]);
+
+  [self.clientMessageCache setMessageData:@[ self.m5 ]];
+
+  FIRIAMMessageDisplayForTesting *display = [[FIRIAMMessageDisplayForTesting alloc]
+      initWithDelegateInteraction:FIRInAppMessagingDelegateInteractionClick
+                           action:nil];
   self.displayExecutor.messageDisplayComponent = display;
 
   [self.displayExecutor checkAndDisplayNextAppForegroundMessage];