In-app Browser Experience (#1267)

* upgrade gradle

* Implement browser experience

* Update Branch-SDK-TestBed/src/main/java/io/branch/branchandroidtestbed/MainActivity.java

Co-authored-by: matter-code-review[bot] <150888575+matter-code-review[bot]@users.noreply.github.com>

* Update Branch-SDK/src/main/java/io/branch/referral/Branch.java

Co-authored-by: matter-code-review[bot] <150888575+matter-code-review[bot]@users.noreply.github.com>

* ai committed an extra brace

* Update Branch-SDK/src/main/java/io/branch/referral/Branch.java

Co-authored-by: matter-code-review[bot] <150888575+matter-code-review[bot]@users.noreply.github.com>

---------

Co-authored-by: matter-code-review[bot] <150888575+matter-code-review[bot]@users.noreply.github.com>

Author: gdeluna-branch

Branch-SDK-TestBed/build.gradle.kts

@@ -15,6 +15,8 @@ dependencies {
     implementation("store.galaxy.samsung.installreferrer:samsung_galaxystore_install_referrer:4.0.0")
     implementation("com.miui.referrer:homereferrer:1.0.0.7")
 
+    implementation("androidx.browser:browser:1.8.0")
+
     androidTestImplementation("androidx.test.ext:junit:1.1.5")
     androidTestImplementation("androidx.test:runner:1.5.2")
     androidTestImplementation("androidx.test:rules:1.5.0")

Branch-SDK-TestBed/src/main/java/io/branch/branchandroidtestbed/CustomBranchApp.java

@@ -1,8 +1,12 @@
 package io.branch.branchandroidtestbed;
 
+import static androidx.browser.customtabs.CustomTabsIntent.COLOR_SCHEME_DARK;
+
 import android.app.Application;
 import android.util.Log;
 
+import androidx.browser.customtabs.CustomTabsIntent;
+
 import java.io.File;
 import java.io.FileOutputStream;
 import java.io.OutputStreamWriter;
@@ -22,8 +26,11 @@ public void onCreate() {
 //            saveLogToFile(message);
 //        };
         Branch.enableLogging(BranchLogger.BranchLogLevel.VERBOSE);
-
         Branch.getAutoInstance(this);
+        CustomTabsIntent customTabsIntent = new CustomTabsIntent.Builder()
+                .setColorScheme(COLOR_SCHEME_DARK)
+                .build();
+        Branch.getInstance().setCustomTabsIntent(customTabsIntent);
     }
 
     private void saveLogToFile(String logMessage) {

Branch-SDK-TestBed/src/main/java/io/branch/branchandroidtestbed/MainActivity.java

@@ -30,6 +30,8 @@
 import com.android.billingclient.api.Purchase;
 import com.android.billingclient.api.QueryProductDetailsParams;
 
+import org.json.JSONArray;
+import org.json.JSONException;
 import org.json.JSONObject;
 
 import java.io.IOException;
@@ -54,7 +56,6 @@
 import io.branch.referral.util.LinkProperties;
 import io.branch.referral.util.ProductCategory;
 import io.branch.referral.util.ShareSheetStyle;
-import io.branch.referral.validators.IntegrationValidator;
 
 public class MainActivity extends Activity {
     private EditText txtShortUrl;
@@ -659,6 +660,21 @@ public void onClick(View v) {
                 Branch.notifyNativeToInit();
             }
         });
+
+        findViewById(R.id.openInAppBrowser).setOnClickListener(new OnClickListener() {
+            @Override
+            public void onClick(View v) {
+                try {
+                    JSONObject invokeFeatures = new JSONObject();
+                    invokeFeatures.put("enhanced_web_link_ux", "IN_APP_WEBVIEW");
+                    invokeFeatures.put("web_link_redirect_url", "https://branch.io");
+
+                    Branch.getInstance().openBrowserExperience(invokeFeatures);
+                } catch (JSONException e) {
+                    throw new RuntimeException(e);
+                }
+            }
+        });
     }
 
     private void createNotificationChannel() {

Branch-SDK-TestBed/src/main/res/layout/main_activity.xml

@@ -133,6 +133,12 @@
                 android:text="Misc."
                 />
 
+            <Button
+                android:id="@+id/openInAppBrowser"
+                style="@style/testbed_button_style"
+                android:drawableStart="@drawable/baseline_document_scanner_24"
+                android:text="Browser Test" />
+
             <Button
                 android:id="@+id/viewLogsButton"
                 style="@style/testbed_button_style"

Branch-SDK/build.gradle.kts

@@ -42,6 +42,10 @@ dependencies {
     // Google Play Billing library
     compileOnly("com.android.billingclient:billing:6.0.1")
 
+    // In app browser experience
+    compileOnly("androidx.browser:browser:1.8.0")
+
+
     androidTestImplementation("androidx.test.ext:junit:1.1.5")
     androidTestImplementation("androidx.test:runner:1.5.2")
     androidTestImplementation("androidx.test:rules:1.5.0")
@@ -74,7 +78,6 @@ fun isReleaseBuild(): Boolean {
 
 android {
     compileSdk = ANDROID_BUILD_SDK_VERSION_COMPILE.toInt()
-    buildToolsVersion = ANDROID_BUILD_TOOLS_VERSION
     defaultConfig {
         minSdk = ANDROID_BUILD_SDK_VERSION_MINIMUM.toInt()
         testInstrumentationRunner = "androidx.test.runner.AndroidJUnitRunner"

Branch-SDK/src/main/java/io/branch/referral/Branch.java

@@ -3,6 +3,10 @@
 import static io.branch.referral.BranchError.ERR_IMPROPER_REINITIALIZATION;
 import static io.branch.referral.BranchPreinstall.getPreinstallSystemData;
 import static io.branch.referral.BranchUtil.isTestModeEnabled;
+import static io.branch.referral.Defines.Jsonkey.EXTERNAL_BROWSER;
+import static io.branch.referral.Defines.Jsonkey.IN_APP_WEBVIEW;
+import static io.branch.referral.PrefHelper.KEY_ENHANCED_WEB_LINK_UX_USED;
+import static io.branch.referral.PrefHelper.KEY_URL_LOAD_MS;
 import static io.branch.referral.PrefHelper.isValidBranchKey;
 import static io.branch.referral.util.DependencyUtilsKt.billingGooglePlayClass;
 import static io.branch.referral.util.DependencyUtilsKt.classExists;
@@ -25,6 +29,7 @@
 import androidx.annotation.NonNull;
 import androidx.annotation.Nullable;
 import androidx.annotation.RequiresApi;
+import androidx.browser.customtabs.CustomTabsIntent;
 import androidx.core.app.ActivityCompat;
 
 import com.android.billingclient.api.Purchase;
@@ -54,6 +59,7 @@
 import io.branch.referral.network.BranchRemoteInterfaceUrlConnection;
 import io.branch.referral.util.BRANCH_STANDARD_EVENT;
 import io.branch.referral.util.BranchEvent;
+import io.branch.referral.util.DependencyUtilsKt;
 import io.branch.referral.util.LinkProperties;
 
 /**
@@ -87,87 +93,87 @@ public class Branch {
      * The redirect URL provided when the link is handled by a desktop client.
      */
     public static final String REDIRECT_DESKTOP_URL = "$desktop_url";
-    
+
     /**
      * The redirect URL provided when the link is handled by an Android device.
      */
     public static final String REDIRECT_ANDROID_URL = "$android_url";
-    
+
     /**
      * The redirect URL provided when the link is handled by an iOS device.
      */
     public static final String REDIRECT_IOS_URL = "$ios_url";
-    
+
     /**
      * The redirect URL provided when the link is handled by a large form-factor iOS device such as
      * an iPad.
      */
     public static final String REDIRECT_IPAD_URL = "$ipad_url";
-    
+
     /**
      * The redirect URL provided when the link is handled by an Amazon Fire device.
      */
     public static final String REDIRECT_FIRE_URL = "$fire_url";
-    
+
     /**
      * The redirect URL provided when the link is handled by a Blackberry device.
      */
     public static final String REDIRECT_BLACKBERRY_URL = "$blackberry_url";
-    
+
     /**
      * The redirect URL provided when the link is handled by a Windows Phone device.
      */
     public static final String REDIRECT_WINDOWS_PHONE_URL = "$windows_phone_url";
-    
+
     /**
      * Open Graph: The title of your object as it should appear within the graph, e.g., "The Rock".
      *
      * @see <a href="http://ogp.me/#metadata">Open Graph - Basic Metadata</a>
      */
     public static final String OG_TITLE = "$og_title";
-    
+
     /**
      * The description of the object to appear in social media feeds that use
      * Facebook's Open Graph specification.
      *
      * @see <a href="http://ogp.me/#metadata">Open Graph - Basic Metadata</a>
      */
     public static final String OG_DESC = "$og_description";
-    
+
     /**
      * An image URL which should represent your object to appear in social media feeds that use
      * Facebook's Open Graph specification.
      *
      * @see <a href="http://ogp.me/#metadata">Open Graph - Basic Metadata</a>
      */
     public static final String OG_IMAGE_URL = "$og_image_url";
-    
+
     /**
      * A URL to a video file that complements this object.
      *
      * @see <a href="http://ogp.me/#metadata">Open Graph - Basic Metadata</a>
      */
     public static final String OG_VIDEO = "$og_video";
-    
+
     /**
      * The canonical URL of your object that will be used as its permanent ID in the graph.
      *
      * @see <a href="http://ogp.me/#metadata">Open Graph - Basic Metadata</a>
      */
     public static final String OG_URL = "$og_url";
-    
+
     /**
      * Unique identifier for the app in use.
      */
     public static final String OG_APP_ID = "$og_app_id";
-    
+
     /**
      * {@link String} value denoting the deep link path to override Branch's default one. By
      * default, Branch will use yourapp://open?link_click_id=12345. If you specify this key/value,
      * Branch will use yourapp://'$deeplink_path'?link_click_id=12345
      */
     public static final String DEEPLINK_PATH = "$deeplink_path";
-    
+
     /**
      * {@link String} value indicating whether the link should always initiate a deep link action.
      * By default, unless overridden on the dashboard, Branch will only open the app if they are
@@ -181,7 +187,7 @@ public class Branch {
      * unlimited number of times.
      */
     public static final int LINK_TYPE_UNLIMITED_USE = 0;
-    
+
     /**
      * An {@link Integer} value indicating the link type. In this case, the link can be used only
      * once. After initial use, subsequent attempts will not validate.
@@ -200,17 +206,17 @@ public class Branch {
 
     /* Json object containing key-value pairs for debugging deep linking */
     private JSONObject deeplinkDebugParams_;
-    
+
     private static boolean disableDeviceIDFetch_;
 
     static boolean bypassWaitingForIntent_ = false;
-    
+
     private static boolean bypassCurrentActivityIntentState_ = false;
 
     static boolean disableAutoSessionInitialization;
 
     static boolean referringLinkAttributionForPreinstalledAppsEnabled = false;
-    
+
     /**
      * <p>A {@link Branch} object that is instantiated on init and holds the singleton instance of
      * the class during application runtime.</p>
@@ -231,7 +237,7 @@ public class Branch {
 
     /* Set to true when {@link Activity} life cycle callbacks are registered. */
     private static boolean isActivityLifeCycleCallbackRegistered_ = false;
-
+    private CustomTabsIntent customTabsIntentOverride;
 
     /* Enumeration for defining session initialisation state. */
     enum SESSION_STATE {
@@ -2654,4 +2660,112 @@ public void setConsumerProtectionAttributionLevel(Defines.BranchAttributionLevel
         }
     }
 
+    /**
+     * Internal method to display an in app web browser.
+     * Launches default browser that supports CustomTabs.
+     */
+    public void openBrowserExperience(JSONObject jsonObject) {
+        BranchLogger.v("openBrowserExperience JSONObject: " + String.valueOf(jsonObject));
+        try {
+            if (jsonObject == null) {
+                BranchLogger.e("openBrowserExperience: jsonObject is null");
+                return;
+            }
+            
+            String experienceType = null;
+            String weblinkUrl = null;
+
+            if(jsonObject.has(Defines.Jsonkey.Enhanced_Web_Link_UX.getKey())){
+                experienceType = jsonObject.optString(Defines.Jsonkey.Enhanced_Web_Link_UX.getKey(), null);
+            }
+
+            if(jsonObject.has(Defines.Jsonkey.Web_Link_Redirect_URL.getKey())){
+                weblinkUrl = jsonObject.optString(Defines.Jsonkey.Web_Link_Redirect_URL.getKey(), null);
+            }
+
+            if(weblinkUrl == null || weblinkUrl.isEmpty()){
+                BranchLogger.e("openBrowserExperience: weblinkUrl is null or empty");
+                return;
+            }
+
+            boolean customTabsImported = classExists(DependencyUtilsKt.androidBrowserClass);
+
+            if (IN_APP_WEBVIEW.getKey().equals(experienceType) && customTabsImported) {
+                // If developer passed their own, use that
+                if(customTabsIntentOverride != null){
+                    BranchLogger.v("Using developer specified CustomTabs");
+                    launchCustomTabBrowser(customTabsIntentOverride, weblinkUrl, getCurrentActivity());
+                }
+                else{
+                    BranchLogger.v("Using default CustomTabs");
+                    launchCustomTabBrowser(weblinkUrl, getCurrentActivity());
+                }
+            }
+            // This would be executed if either experienceType.equals("EXTERNAL_BROWSER")
+            // Or if the androidx.browser:browser is not imported
+            else {
+                BranchLogger.v("customTabsImported " + customTabsImported);
+                BranchLogger.v("Opening in external browser.");
+                launchExternalBrowser(weblinkUrl);
+            }
+        }
+        catch (Exception ex){
+            BranchLogger.e("openBrowserExperience caught exception: " + ex);
+        }
+    }
+
+    private void launchCustomTabBrowser(String url, Activity activity) {
+        androidx.browser.customtabs.CustomTabsIntent customTabsIntent =
+                new androidx.browser.customtabs.CustomTabsIntent.Builder()
+                        .build();
+        launchCustomTabBrowser(customTabsIntent, url, activity);
+    }
+
+    /**
+     * Set a CustomTabsIntent to open web urls through an in-app browser experience.
+     * This allows customization of the in-app browser appearance and behavior.
+     * 
+     * <p>
+     * Example usage:
+     * <pre>
+     * CustomTabsIntent customTabsIntent = new CustomTabsIntent.Builder()
+     *     .setColorScheme(COLOR_SCHEME_DARK)
+     *     .setShowTitle(true)
+     *     .build();
+     * Branch.getInstance().setCustomTabsIntent(customTabsIntent);
+     * </pre>
+     * </p>
+     * 
+     * @param customTabsIntent A configured CustomTabsIntent instance that will be used
+     *                         when opening web links in-app. If null, the default CustomTabsIntent
+     *                         will be used.
+     */
+    public void setCustomTabsIntent(CustomTabsIntent customTabsIntent){
+        this.customTabsIntentOverride = customTabsIntent;
+    }
+
+    private void launchCustomTabBrowser(CustomTabsIntent customTabsIntent, String url, Activity activity) {
+        try {
+            prefHelper_.setWebLinkUxTypeUsed(IN_APP_WEBVIEW.getKey());
+            prefHelper_.setWebLinkLoadTime(System.currentTimeMillis());
+            customTabsIntent.launchUrl(activity, Uri.parse(url));
+        }
+        catch (Exception ex){
+            BranchLogger.e("launchCustomTabBrowser caught exception: " + ex);
+        }
+    }
+
+    private void launchExternalBrowser(String url) {
+        try {
+            prefHelper_.setWebLinkUxTypeUsed(EXTERNAL_BROWSER.getKey());
+            prefHelper_.setWebLinkLoadTime(System.currentTimeMillis());
+
+            Intent intent = new Intent(Intent.ACTION_VIEW, Uri.parse(url));
+            intent.addFlags(Intent.FLAG_ACTIVITY_NEW_TASK);
+            context_.startActivity(intent);
+        }
+        catch (Exception ex){
+            BranchLogger.e("launchExternalBrowser caught exception: " + ex);
+        }
+    }
 }