fix(aws-android-sdk-cognitoauth): custom tabs app crash when chrome not available (#2529)

div5yesh · web-flow · commit 58ad144e8758 · 2021-07-20T16:02:01.000-07:00
* fix custom tabs app crash
 - add support for launching intent chooser for custom tabs
 - fix app crash if chrome not available by choosing availalbe browser

* use supported browser for signout instead of default Chrome

* launch intent chooser by dafault
- do not force browsers, app should handle this logic

* remove unused imports

* call failure callback if no browsers installed on device

* call failure callback if custom tabs not supported

* cache result of resolved browser activites

* return generic collection and fix whitespaces

* add exception classes for no browser and no custom tabs
diff --git a/aws-android-sdk-cognitoauth/src/main/java/com/amazonaws/mobileconnectors/cognitoauth/AuthClient.java b/aws-android-sdk-cognitoauth/src/main/java/com/amazonaws/mobileconnectors/cognitoauth/AuthClient.java
@@ -24,6 +24,7 @@
 import android.content.pm.ActivityInfo;
 import android.content.pm.PackageInfo;
 import android.content.pm.PackageManager;
+import android.content.pm.ResolveInfo;
 import android.net.Uri;
 import android.os.Handler;
 import androidx.browser.customtabs.CustomTabsClient;
@@ -39,6 +40,8 @@
 import com.amazonaws.mobileconnectors.cognitoauth.exceptions.AuthInvalidGrantException;
 import com.amazonaws.mobileconnectors.cognitoauth.exceptions.AuthNavigationException;
 import com.amazonaws.mobileconnectors.cognitoauth.exceptions.AuthServiceException;
+import com.amazonaws.mobileconnectors.cognitoauth.exceptions.BrowserNotInstalledException;
+import com.amazonaws.mobileconnectors.cognitoauth.exceptions.CustomTabsNotSupportedException;
 import com.amazonaws.mobileconnectors.cognitoauth.util.AuthHttpResponseParser;
 import com.amazonaws.mobileconnectors.cognitoauth.handlers.AuthHandler;
 import com.amazonaws.mobileconnectors.cognitoauth.util.ClientConstants;
@@ -48,13 +51,17 @@
 
 import java.net.URL;
 import java.security.InvalidParameterException;
+import java.util.ArrayList;
+import java.util.Collection;
 import java.util.HashMap;
 import java.util.List;
 import java.util.Map;
 import java.util.Set;
 import java.util.concurrent.CountDownLatch;
 import java.util.concurrent.TimeUnit;
 
+import static androidx.browser.customtabs.CustomTabsService.ACTION_CUSTOM_TABS_CONNECTION;
+
 /**
  * Local client for {@link Auth}.
  * <p>
@@ -132,6 +139,16 @@ public class AuthClient {
      */
     private boolean isRedirectActivityDeclared;
 
+    /**
+     * Cache whether browser is installed on the device.
+     */
+    private boolean isBrowserInstalled;
+
+    /**
+     * Cache whether there is browser that supports custom tabs on the device.
+     */
+    private boolean isCustomTabSupported;
+
 
     // - Chrome Custom Tabs Controls
     private CustomTabsClient mCustomTabsClient;
@@ -161,6 +178,8 @@ protected AuthClient(final Context context, final Auth pool, final String userna
         this.pool = pool;
         this.userId = username;
         this.isRedirectActivityDeclared = false;
+        this.isBrowserInstalled = false;
+        this.isCustomTabSupported = false;
         preWarmChrome();
     }
 
@@ -199,7 +218,7 @@ protected void setUsername(final String username) {
      *                 This must not be null when showSignInIfExpired is true.
      */
     protected void getSession(final boolean showSignInIfExpired, final Activity activity) {
-        getSession(showSignInIfExpired, activity, DEFAULT_BROWSER_PACKAGE);
+        getSession(showSignInIfExpired, activity, null);
     }
 
     /**
@@ -269,7 +288,7 @@ protected String getUsername() {
      * </p>
      */
     public void signOut() {
-        signOut(DEFAULT_BROWSER_PACKAGE);
+        signOut(null);
     }
 
     /**
@@ -296,7 +315,7 @@ public void signOut(String browserPackage) {
      *                             but the session may still be alive from the browser.
      */
     public void signOut(final boolean clearLocalTokensOnly) {
-        signOut(clearLocalTokensOnly, DEFAULT_BROWSER_PACKAGE);
+        signOut(clearLocalTokensOnly, null);
     }
 
     /**
@@ -709,21 +728,90 @@ private void launchSignOut(final String redirectUri, final String browserPackage
         launchCustomTabs(fqdn, null, browserPackage);
     }
 
+    /***
+     * Check if a browser is installed on the device to launch HostedUI.
+     * @return true if a browser exists else false.
+     */
+    private boolean isBrowserInstalled() {
+        if (isBrowserInstalled) {
+            return true;
+        }
+        String url = "https://docs.amplify.aws/";
+        Uri webAddress = Uri.parse(url);
+        Intent intentWeb = new Intent(Intent.ACTION_VIEW, webAddress);
+        if (intentWeb.resolveActivity(context.getPackageManager()) != null) {
+            isBrowserInstalled = true;
+            return true;
+        }
+        return false;
+    }
+
+    /**
+     * Get list of browser packages that support Custom Tabs Service.
+     * @return list of package names that support Custom Tabs.
+     */
+    private Collection<String> getSupportedBrowserPackage(){
+        PackageManager packageManager = context.getPackageManager();
+        // Get default VIEW intent handler.
+        Intent activityIntent = new Intent()
+                .setAction(Intent.ACTION_VIEW)
+                .addCategory(Intent.CATEGORY_BROWSABLE)
+                .setData(Uri.fromParts("http", "", null));
+
+        // Get all apps that can handle VIEW intents.
+        List<ResolveInfo> resolvedActivityList = packageManager.queryIntentActivities(activityIntent, 0);
+        List<String> packageNamesSupportingCustomTabs = new ArrayList<>();
+        for (ResolveInfo info : resolvedActivityList) {
+            Intent serviceIntent = new Intent()
+                    .setAction(ACTION_CUSTOM_TABS_CONNECTION)
+                    .setPackage(info.activityInfo.packageName);
+            // Check if this package also resolves the Custom Tabs service.
+            if(packageManager.resolveService(serviceIntent, 0) != null) {
+                packageNamesSupportingCustomTabs.add(info.activityInfo.packageName);
+            }
+        }
+        return packageNamesSupportingCustomTabs;
+    }
+
+    /***
+     * Check if there are any browsers on the deivce that support custom tabs.
+     * @return true if custom tabs is supported by any browsers on the device else false.
+     */
+    private boolean isCustomTabSupported() {
+        if (isCustomTabSupported) {
+            return true;
+        }
+        if (getSupportedBrowserPackage().size() > 0) {
+            isCustomTabSupported = true;
+            return true;
+        }
+        return false;
+    }
+
     /**
      * Launches the HostedUI webpage on a Custom Tab.
      * @param uri Required: {@link Uri}.
      * @param activity Activity to launch custom tabs from and which will listen for the intent completion.
      * @param browserPackage Optional string specifying the browser package to launch the specified url.
-     *                       Defaults to Chrome if null.
+     *                       Launches intent chooser if set to null.
      */
     private void launchCustomTabs(final Uri uri, final Activity activity, final String browserPackage) {
     	try {
-	        CustomTabsIntent.Builder builder = new CustomTabsIntent.Builder(mCustomTabsSession);
-	        mCustomTabsIntent = builder.build();
-	        if(pool.getCustomTabExtras() != null)
-	            mCustomTabsIntent.intent.putExtras(pool.getCustomTabExtras());
-	        mCustomTabsIntent.intent.setPackage(
-	                browserPackage != null ? browserPackage : DEFAULT_BROWSER_PACKAGE);
+            if(!isBrowserInstalled()) {
+                userHandler.onFailure(new BrowserNotInstalledException("No browsers installed."));
+                return;
+            }
+            if(!isCustomTabSupported()) {
+                userHandler.onFailure(new CustomTabsNotSupportedException("Browser with custom tabs support not found."));
+                return;
+            }
+            CustomTabsIntent.Builder builder = new CustomTabsIntent.Builder(mCustomTabsSession);
+            mCustomTabsIntent = builder.build();
+            if(pool.getCustomTabExtras() != null)
+                mCustomTabsIntent.intent.putExtras(pool.getCustomTabExtras());
+            if(browserPackage != null) {
+                mCustomTabsIntent.intent.setPackage(browserPackage);
+            }
             mCustomTabsIntent.intent.setData(uri);
             if (activity != null) {
                 activity.startActivityForResult(
@@ -736,8 +824,8 @@ private void launchCustomTabs(final Uri uri, final Activity activity, final Stri
                 context.startActivity(startIntent);
             }
     	} catch (final Exception e) {
-    		userHandler.onFailure(e);
-    	}
+            userHandler.onFailure(e);
+        }
     }
 
     private String getUserContextData() {
diff --git a/aws-android-sdk-cognitoauth/src/main/java/com/amazonaws/mobileconnectors/cognitoauth/exceptions/BrowserNotInstalledException.java b/aws-android-sdk-cognitoauth/src/main/java/com/amazonaws/mobileconnectors/cognitoauth/exceptions/BrowserNotInstalledException.java
@@ -0,0 +1,48 @@
+/*
+ * Copyright 2021 Amazon.com, Inc. or its affiliates.
+ * All Rights Reserved.
+ *
+ * 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.amazonaws.mobileconnectors.cognitoauth.exceptions;
+
+/**
+ * Thrown when no browser packages found on device to launch custom tabs required for sign in/out flow.
+ */
+public class BrowserNotInstalledException extends RuntimeException {
+    /**
+     * Exception unique id.
+     */
+    private static final long serialVersionUID = -3978803758693478385L;
+
+    /**
+     * Creates a new BrowserNotInstalledException with the specified message, and root
+     * cause.
+     *
+     * @param message An error message describing why this exception was thrown.
+     * @param t The underlying cause of this exception.
+     */
+    public BrowserNotInstalledException(String message, Throwable t) {
+        super(message, t);
+    }
+
+    /**
+     * Creates a new BrowserNotInstalledException with the specified message.
+     *
+     * @param message An error message describing why this exception was thrown.
+     */
+    public BrowserNotInstalledException(String message) {
+        super(message);
+    }
+}
diff --git a/aws-android-sdk-cognitoauth/src/main/java/com/amazonaws/mobileconnectors/cognitoauth/exceptions/CustomTabsNotSupportedException.java b/aws-android-sdk-cognitoauth/src/main/java/com/amazonaws/mobileconnectors/cognitoauth/exceptions/CustomTabsNotSupportedException.java
@@ -0,0 +1,48 @@
+/*
+ * Copyright 2021 Amazon.com, Inc. or its affiliates.
+ * All Rights Reserved.
+ *
+ * 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.amazonaws.mobileconnectors.cognitoauth.exceptions;
+
+/**
+ * Thrown when no browser packages on device supports custom tabs required for sign in/out flow.
+ */
+public class CustomTabsNotSupportedException extends RuntimeException {
+    /**
+     * Exception unique id.
+     */
+    private static final long serialVersionUID = -5288976815741183128L;
+
+    /**
+     * Creates a new CustomTabsNotSupportedException with the specified message, and root
+     * cause.
+     *
+     * @param message An error message describing why this exception was thrown.
+     * @param t The underlying cause of this exception.
+     */
+    public CustomTabsNotSupportedException(String message, Throwable t) {
+        super(message, t);
+    }
+
+    /**
+     * Creates a new CustomTabsNotSupportedException with the specified message.
+     *
+     * @param message An error message describing why this exception was thrown.
+     */
+    public CustomTabsNotSupportedException(String message) {
+        super(message);
+    }
+}
