Improve action click browser handling for FIAM and implement dismiss listener (firebase#1781)

Author: JasonAHeron

firebase-inappmessaging-display/firebase-inappmessaging-display.gradle

@@ -68,7 +68,7 @@ dependencies {
  exclude group: 'com.google.firebase', module: 'firebase-common'
  }
 
- implementation 'com.google.android.gms:play-services-tasks:17.0.2'
+ implementation 'com.google.android.gms:play-services-tasks:17.1.0'
  implementation 'androidx.appcompat:appcompat:1.1.0'
  implementation 'androidx.cardview:cardview:1.0.0'
  implementation 'androidx.legacy:legacy-support-v4:1.0.0'
@@ -88,6 +88,7 @@ dependencies {
  testImplementation "junit:junit:4.12"
  testImplementation "org.mockito:mockito-core:2.25.0"
  testImplementation "com.google.truth:truth:1.0"
+ testImplementation 'androidx.test:core:1.2.0'
  testImplementation 'com.google.guava:guava:27.1-android'
 
  androidTestImplementation "org.mockito:mockito-core:2.25.0"

firebase-inappmessaging-display/src/main/java/com/google/firebase/inappmessaging/display/FirebaseInAppMessagingDisplay.java

@@ -19,6 +19,8 @@
 import android.annotation.SuppressLint;
 import android.app.Activity;
 import android.app.Application;
+import android.content.Intent;
+import android.content.pm.ResolveInfo;
 import android.content.res.Configuration;
 import android.net.Uri;
 import android.text.TextUtils;
@@ -305,25 +307,20 @@ public void onClick(View v) {
  };
 
  Map<Action, View.OnClickListener> actionListeners = new HashMap<>();
- // If the message has an action, but not an action url, we dismiss when the action
- // button is clicked
  for (Action action : extractActions(inAppMessage)) {
-
  final View.OnClickListener actionListener;
-
  // TODO: need an onclick listener per action
+ // If the message has an action and an action url, set up an intent to handle the url
  if (action != null && !TextUtils.isEmpty(action.getActionUrl())) {
  actionListener =
  new View.OnClickListener() {
  @Override
  public void onClick(View v) {
  if (callbacks != null) {
+ Logging.logi("Calling callback for click action");
  callbacks.messageClicked(action);
  }
- final CustomTabsIntent i =
- new CustomTabsIntent.Builder().setShowTitle(true).build();
-
- i.launchUrl(activity, Uri.parse(action.getActionUrl()));
+ launchUriIntent(activity, Uri.parse(action.getActionUrl()));
  notifyFiamClick();
  // Ensure that we remove the displayed FIAM, and ensure that on re-load, the message
  // isn't re-displayed
@@ -333,7 +330,7 @@ public void onClick(View v) {
  }
  };
  } else {
- Logging.loge("No action url found for action.");
+ Logging.logi("No action url found for action. Treating as dismiss.");
  actionListener = dismissListener;
  }
  actionListeners.put(action, actionListener);
@@ -535,4 +532,35 @@ private void notifyFiamDismiss() {
  fiamListener.onFiamDismiss();
  }
  }
+
+ private void launchUriIntent(Activity activity, Uri uri) {
+ if (supportsCustomTabs(activity)) {
+ // If we can launch a chrome view, try that.
+ CustomTabsIntent customTabsIntent = new CustomTabsIntent.Builder().build();
+ Intent intent = customTabsIntent.intent;
+ intent.addFlags(Intent.FLAG_ACTIVITY_NO_HISTORY);
+ intent.addFlags(Intent.FLAG_ACTIVITY_NEW_TASK);
+ customTabsIntent.launchUrl(activity, uri);
+ } else {
+ // If we can't launch a chrome view try to launch anything that can handle a URL.
+ Intent browserIntent = new Intent(Intent.ACTION_VIEW, uri);
+ ResolveInfo info = activity.getPackageManager().resolveActivity(browserIntent, 0);
+ browserIntent.addFlags(Intent.FLAG_ACTIVITY_NO_HISTORY);
+ browserIntent.addFlags(Intent.FLAG_ACTIVITY_NEW_TASK);
+ if (info != null) {
+ activity.startActivity(browserIntent);
+ } else {
+ // If the device can't resolve a url then log, but don't crash.
+ Logging.loge("Device cannot resolve intent for: " + Intent.ACTION_VIEW);
+ }
+ }
+ }
+
+ private boolean supportsCustomTabs(Activity activity) {
+ Intent customTabIntent = new Intent("android.support.customtabs.action.CustomTabsService");
+ customTabIntent.setPackage("com.android.chrome");
+ List<ResolveInfo> resolveInfos =
+ activity.getPackageManager().queryIntentServices(customTabIntent, 0);
+ return !resolveInfos.isEmpty();
+ }
 }

firebase-inappmessaging-display/src/test/java/com/google/firebase/inappmessaging/display/FirebaseInAppMessagingDisplayTest.java

@@ -37,6 +37,8 @@
 import static org.robolectric.Shadows.shadowOf;
 
 import android.app.Activity;
+import android.content.Intent;
+import android.content.pm.ResolveInfo;
 import android.content.res.Configuration;
 import android.net.Uri;
 import android.util.DisplayMetrics;
@@ -47,6 +49,7 @@
 import android.view.ViewTreeObserver;
 import android.widget.Button;
 import android.widget.ImageView;
+import androidx.test.core.app.ApplicationProvider;
 import com.google.firebase.inappmessaging.FirebaseInAppMessaging;
 import com.google.firebase.inappmessaging.FirebaseInAppMessagingDisplay;
 import com.google.firebase.inappmessaging.FirebaseInAppMessagingDisplayCallbacks;
@@ -83,6 +86,7 @@
 import org.robolectric.RobolectricTestRunner;
 import org.robolectric.annotation.Config;
 import org.robolectric.shadows.ShadowActivity;
+import org.robolectric.shadows.ShadowPackageManager;
 
 @RunWith(RobolectricTestRunner.class)
 @Config(sdk = 21, qualifiers = "port")
@@ -126,6 +130,7 @@ public class FirebaseInAppMessagingDisplayTest {
  private TestActivity activity;
  private TestSecondActivity activityTwo;
  private ShadowActivity shadowActivity;
+ private ShadowPackageManager shadowPackageManager;
  private FirebaseInAppMessagingDisplay listener;
  private FiamImageRequestCreator fakeRequestCreator = spy(new FakeRequestCreater(null));
 
@@ -174,6 +179,8 @@ public InAppMessageLayoutConfig get() {
  }
  });
 
+ shadowPackageManager =
+ shadowOf(ApplicationProvider.getApplicationContext().getPackageManager());
  activity = Robolectric.buildActivity(TestActivity.class).create().get();
  activityTwo = Robolectric.buildActivity(TestSecondActivity.class).create().get();
  shadowActivity = shadowOf(activity);
@@ -571,13 +578,33 @@ public void dismissTimer_onComplete_dismissesFiam() {
  }
 
  @Test
- public void fiamClickListener_whenActionUrlProvided_opensCustomTab() {
+ public void fiamClickListener_whenActionUrlProvided_andChromeAvailable_opensCustomTab() {
+ final ResolveInfo resolveInfo = new ResolveInfo();
+ resolveInfo.resolvePackageName = "garbage";
+ final Intent customTabIntent =
+ new Intent("android.support.customtabs.action.CustomTabsService");
+ customTabIntent.setPackage("com.android.chrome");
+ shadowPackageManager.addResolveInfoForIntent(customTabIntent, resolveInfo);
  resumeActivity(activity);
  listener.displayMessage(IMAGE_MESSAGE_MODEL, callbacks);
  verify(imageBindingWrapper)
  .inflate(onClickListenerArgCaptor.capture(), any(OnClickListener.class));
  onClickListenerArgCaptor.getValue().get(IMAGE_MESSAGE_MODEL.getAction()).onClick(null);
+ assertThat(shadowActivity.getNextStartedActivity().getData())
+ .isEqualTo(Uri.parse(ACTION_URL_STRING));
+ }
 
+ @Test
+ public void fiamClickListener_whenActionUrlProvided_andBrowserAvailable_opensBrowserIntent() {
+ final ResolveInfo resolveInfo = new ResolveInfo();
+ resolveInfo.resolvePackageName = "garbage";
+ final Intent browserIntent = new Intent(Intent.ACTION_VIEW, Uri.parse(ACTION_URL_STRING));
+ shadowPackageManager.addResolveInfoForIntent(browserIntent, resolveInfo);
+ resumeActivity(activity);
+ listener.displayMessage(IMAGE_MESSAGE_MODEL, callbacks);
+ verify(imageBindingWrapper)
+ .inflate(onClickListenerArgCaptor.capture(), any(OnClickListener.class));
+ onClickListenerArgCaptor.getValue().get(IMAGE_MESSAGE_MODEL.getAction()).onClick(null);
  assertThat(shadowActivity.getNextStartedActivity().getData())
  .isEqualTo(Uri.parse(ACTION_URL_STRING));
  }

firebase-inappmessaging/src/main/java/com/google/firebase/inappmessaging/FirebaseInAppMessaging.java

@@ -237,6 +237,15 @@ public void addClickListener(@NonNull FirebaseInAppMessagingClickListener clickL
  developerListenerManager.addClickListener(clickListener);
  }
 
+ /**
+ * Registers a dismiss listener with FIAM, which will be notified on every FIAM dismiss
+ *
+ * @param dismissListener
+ */
+ public void addDismissListener(@NonNull FirebaseInAppMessagingDismissListener dismissListener) {
+ developerListenerManager.addDismissListener(dismissListener);
+ }
+
  /**
  * Registers a display error listener with FIAM, which will be notified on every FIAM display
  * error
@@ -275,6 +284,18 @@ public void addClickListener(
  developerListenerManager.addClickListener(clickListener, executor);
  }
 
+ /**
+ * Registers a dismiss listener with FIAM, which will be notified on every FIAM dismiss, and
+ * triggered on the provided executor
+ *
+ * @param dismissListener
+ * @param executor
+ */
+ public void addDismissListener(
+ @NonNull FirebaseInAppMessagingDismissListener dismissListener, @NonNull Executor executor) {
+ developerListenerManager.addDismissListener(dismissListener, executor);
+ }
+
  /**
  * Registers a display error listener with FIAM, which will be notified on every FIAM display
  * error, and triggered on the provided executor

firebase-inappmessaging/src/main/java/com/google/firebase/inappmessaging/FirebaseInAppMessagingDismissListener.java

@@ -0,0 +1,24 @@
+// Copyright 2020 Google LLC
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+// http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+package com.google.firebase.inappmessaging;
+
+import androidx.annotation.NonNull;
+import com.google.firebase.inappmessaging.model.InAppMessage;
+
+public interface FirebaseInAppMessagingDismissListener {
+
+ // Triggered when a message is dismissed (eg: "x" button, in the modal view)
+ void messageDismissed(@NonNull InAppMessage inAppMessage);
+}

firebase-inappmessaging/src/main/java/com/google/firebase/inappmessaging/internal/DeveloperListenerManager.java

@@ -16,6 +16,7 @@
 
 import androidx.annotation.NonNull;
 import com.google.firebase.inappmessaging.FirebaseInAppMessagingClickListener;
+import com.google.firebase.inappmessaging.FirebaseInAppMessagingDismissListener;
 import com.google.firebase.inappmessaging.FirebaseInAppMessagingDisplayCallbacks;
 import com.google.firebase.inappmessaging.FirebaseInAppMessagingDisplayErrorListener;
 import com.google.firebase.inappmessaging.FirebaseInAppMessagingImpressionListener;
@@ -47,6 +48,8 @@ public class DeveloperListenerManager {
  public static DeveloperListenerManager instance = new DeveloperListenerManager();
  private Map<FirebaseInAppMessagingClickListener, ClicksExecutorAndListener>
  registeredClickListeners = new HashMap<>();
+ private Map<FirebaseInAppMessagingDismissListener, DismissExecutorAndListener>
+ registeredDismissListeners = new HashMap<>();
  private Map<FirebaseInAppMessagingDisplayErrorListener, ErrorsExecutorAndListener>
  registeredErrorListeners = new HashMap<>();;
  private Map<FirebaseInAppMessagingImpressionListener, ImpressionExecutorAndListener>
@@ -93,6 +96,14 @@ public void messageClicked(InAppMessage inAppMessage, Action action) {
  }
  }
 
+ public void messageDismissed(InAppMessage inAppMessage) {
+ for (DismissExecutorAndListener listener : registeredDismissListeners.values()) {
+ listener
+ .withExecutor(CALLBACK_QUEUE_EXECUTOR)
+ .execute(() -> listener.getListener().messageDismissed(inAppMessage));
+ }
+ }
+
  // pass through from FirebaseInAppMessaging public api
  public void addImpressionListener(FirebaseInAppMessagingImpressionListener impressionListener) {
  registeredImpressionListeners.put(
@@ -103,6 +114,11 @@ public void addClickListener(FirebaseInAppMessagingClickListener clickListener)
  registeredClickListeners.put(clickListener, new ClicksExecutorAndListener(clickListener));
  }
 
+ public void addDismissListener(FirebaseInAppMessagingDismissListener dismissListener) {
+ registeredDismissListeners.put(
+ dismissListener, new DismissExecutorAndListener(dismissListener));
+ }
+
  public void addDisplayErrorListener(
  FirebaseInAppMessagingDisplayErrorListener displayErrorListener) {
  registeredErrorListeners.put(
@@ -122,6 +138,12 @@ public void addClickListener(
  clickListener, new ClicksExecutorAndListener(clickListener, executor));
  }
 
+ public void addDismissListener(
+ FirebaseInAppMessagingDismissListener dismissListener, Executor executor) {
+ registeredDismissListeners.put(
+ dismissListener, new DismissExecutorAndListener(dismissListener, executor));
+ }
+
  public void addDisplayErrorListener(
  FirebaseInAppMessagingDisplayErrorListener displayErrorListener, Executor executor) {
  registeredErrorListeners.put(
@@ -229,6 +251,26 @@ public FirebaseInAppMessagingClickListener getListener() {
  }
  }
 
+ private static class DismissExecutorAndListener
+ extends ExecutorAndListener<FirebaseInAppMessagingDismissListener> {
+ FirebaseInAppMessagingDismissListener listener;
+
+ public DismissExecutorAndListener(FirebaseInAppMessagingDismissListener listener, Executor e) {
+ super(e);
+ this.listener = listener;
+ }
+
+ public DismissExecutorAndListener(FirebaseInAppMessagingDismissListener listener) {
+ super(null);
+ this.listener = listener;
+ }
+
+ @Override
+ public FirebaseInAppMessagingDismissListener getListener() {
+ return listener;
+ }
+ }
+
  private static class ErrorsExecutorAndListener
  extends ExecutorAndListener<FirebaseInAppMessagingDisplayErrorListener> {
  FirebaseInAppMessagingDisplayErrorListener listener;

firebase-inappmessaging/src/main/java/com/google/firebase/inappmessaging/internal/MetricsLoggerClient.java

@@ -161,6 +161,8 @@ void logDismiss(InAppMessage message, InAppMessagingDismissType dismissType) {
  // For dismiss log to analytics as well
  logEventAsync(message, AnalyticsConstants.ANALYTICS_DISMISS_EVENT, false);
  }
+ // No matter what, always trigger developer callbacks
+ developerListenerManager.messageDismissed(message);
  }
 
  private CampaignAnalytics createEventEntry(