Merge pull request #106 from braintree/v3-into-main

Merge v3 into main

.github/actions/setup_java/action.yml

@@ -6,5 +6,5 @@ runs:
     - name: Set up Java
       uses: actions/setup-java@v3
       with:
-        java-version: '11'
+        java-version: '17'
         distribution: zulu

.github/workflows/release_snapshot.yml

@@ -4,6 +4,7 @@ on:
   push:
     branches:
       - main
+      - v3
 env:
   SIGNING_KEY_FILE: /home/runner/secretKey.gpg
 jobs:

.github/workflows/static_analysis.yml

@@ -10,10 +10,10 @@ jobs:
     steps:
       - name: Checkout Repository
         uses: actions/checkout@v2
-      - name: Set up Java 11
+      - name: Set up Java 17
         uses: actions/setup-java@v3
         with:
-          java-version: '11'
+          java-version: '17'
           distribution: 'microsoft'
       - name: Lint
         run: ./ci android_lint

.github/workflows/tests.yml

@@ -7,10 +7,10 @@ jobs:
     steps:
       - name: Checkout Repository
         uses: actions/checkout@v2
-      - name: Set up Java 11
+      - name: Set up Java 17
         uses: actions/setup-java@v3
         with:
-          java-version: '11'
+          java-version: '17'
           distribution: 'zulu'
       - name: Unit Tests
         run: ./ci unit_tests

CHANGELOG.md

@@ -1,5 +1,21 @@
 # browser-switch-android Release Notes
 
+## unreleased
+
+* Make `BrowserSwitchClient.assertCanPerformBrowserSwitch()` public
+* Breaking Changes
+  * Bump `minSdkVersion` to API 23
+  * Bump target Java version to Java 11
+  * Upgrade Kotlin version to 1.9.10
+  * Upgrade to Android Gradle Plugin 8
+  * Change `BrowserSwitchClient#start` parameters and return type
+  * Change `BrowserSwitchClient#parseResult` parameters
+  * Remove `deliverResult`, `getResult`, `captureResult`, `clearActiveRequests`, `getResultFromCache`, and `deliverResultFromCache` from `BrowserSwitchClient`
+  * Add `BrowserSwitchRequest` and `BrowserSwitchPendingRequest`
+  * Convert `BrowserSwitchResult` to sealed class and add `BrowserSwitchResultInfo`
+  * Remove `BrowserSwitchStatus`
+  * Rename `parseResult()` to `completeRequest()`
+
 ## 2.7.0
 
 * Add `appLinkUri` to `BrowserSwitchOptions` for Android App Link support

README.md

@@ -20,7 +20,7 @@ To preview the latest work in progress builds, add the following SNAPSHOT depend
 
 ```groovy
 dependencies {
-  implementation 'com.braintreepayments.api:browser-switch:2.7.1-SNAPSHOT'
+  implementation 'com.braintreepayments.api:browser-switch:3.0.0-beta1-SNAPSHOT'
 }
 ```
 
@@ -42,7 +42,6 @@ Declare an activity that you own as a deep link target in your `AndroidManifest.
 
 ```xml
 <activity android:name="com.myapp.MyDeepLinkTargetActivity"
-    android:launchMode="singleTask"
     android:exported="true">
     <intent-filter>
         <action android:name="android.intent.action.VIEW"/>
@@ -62,29 +61,42 @@ If these requirements are not met, an error will be returned and no browser swit
 A browser switch can be initiated by calling `BrowserSwitchClient#start()`. Use `BrowserSwitchOptions` to configure options for browser switching:
 
 ```kotlin
-val browserSwitchOptions = BrowserSwitchOptions()
-    .requestCode(MY_REQUEST_CODE)
-    .url("https://site-to-load.com?callbackURL=my-custom-url-scheme%3A%2F%2Fsuccess")
-    .returnUrlScheme("my-custom-url-scheme")
-browserSwitchClient.start(activity, browserSwitchOptions)
+val browserSwitchOptions = BrowserSwitchOptions().apply {
+    requestCode = MY_REQUEST_CODE
+    url = "https://site-to-load.com?callbackURL=my-custom-url-scheme%3A%2F%2Fsuccess"
+    returnUrlScheme = "my-custom-url-scheme"
+}
+
+when (val pendingRequest = browserSwitchClient.start(this, browserSwitchOptions)) {
+    is BrowserSwitchPendingRequest.Started -> {
+        // store pending request
+    }
+    is BrowserSwitchPendingRequest.Failure -> {
+        // browser was unable to be launched, handle failure
+    }
+}
 ```
 
 In the above example, notice the encoded `callbackURL` parameter is forwarded to the website that will be loaded. The callback url must have the same custom scheme set in `BrowserSwitchOptions`. When this URL is loaded by the site, the Android OS will re-direct the user to the deep link destination `Activity` defined in the `AndroidManifest.xml`.
 
 To capture a browser switch result, override your deep link target `Activity` with the following code snippet:
 
 ```kotlin
-override fun onCreate(savedInstanceState: Bundle?) {
-    super.onCreate(savedInstanceState)
-    browserSwitchClient.deliverResult(this)?.let { result ->
-        when (result) {
-            BrowserSwitchStatus.OK -> {
-                // the browser switch returned data in the return uri
-                // TODO: handle success
+override fun onResume() {
+    handleReturnToAppFromBrowser(intent) 
+}
+
+fun handleReturnToAppFromBrowser(intent: Intent) {
+    // fetch stored pending request
+    fetchPendingRequestFromPersistentStorage()?.let { startedRequest ->
+        when (val browserSwitchResult = browserSwitchClient.parseResult(startedRequest, intent)) {
+            is BrowserSwitchResult.Success -> {
+                // handle successful browser switch result
+                // clear stored pending request
             }
-            BrowserSwitchStatus.CANCEL -> {
-                // the user canceled and returned to your app return uri is null
-                // TODO: handle cancelation
+            is BrowserSwitchResult.NoResult -> {
+                // user did not complete browser switch
+                // allow user to complete browser switch, or clear stored pending request
             }
         }
     }
@@ -93,23 +105,24 @@ override fun onCreate(savedInstanceState: Bundle?) {
 
 ## Launch Modes
 
-If your deep link target `Activity` has `android:launchMode="singleTop"`, `android:launchMode="singleTask"`, or `android:launchMode="singleInstance"`, add the following code snippet to your deep link target `Activity`:
+If your deep link target `Activity` has `android:launchMode="singleTop"`, `android:launchMode="singleTask"`, or `android:launchMode="singleInstance"`, add the following code snippet to your deep link target `Activity` in the `onNewIntent` method instead of `onResume`:
 
 ```kotlin
 override fun onNewIntent(newIntent: Intent?) {
     super.onNewIntent(intent)
-    intent = newIntent
+    handleReturnToAppFromBrowser(intent) 
 }
 ```
 
 ## Versions
 
 This SDK abides by our Client SDK Deprecation Policy. For more information on the potential statuses of an SDK check our [developer docs](https://developer.paypal.com/braintree/docs/guides/client-sdk/deprecation-policy/android/v4).
 
-| Major version number | Status | Released | Deprecated | Unsupported |
-| -------------------- | ------ | -------- | ---------- | ----------- |
-| 2.x.x | Active | February 2021 | TBA | TBA |
-| 1.x.x | Inactive | June 2020 | April 2022 | April 2023 |
+| Major version number | Status   | Released      | Deprecated | Unsupported |
+|----------------------|----------|---------------| ---------- | ----------- |
+| 3.x.x                | Beta     | TBA           | TBA | TBA |
+| 2.x.x                | Active   | February 2021 | TBA | TBA |
+| 1.x.x                | Inactive | June 2020     | April 2022 | April 2023 |
 
 ## Help
 

browser-switch/build.gradle

@@ -5,7 +5,8 @@ plugins {
 }
 
 android {
-    compileSdkVersion rootProject.compileSdkVersion
+    namespace "com.braintreepayments.api.browserswitch"
+    compileSdk rootProject.compileSdkVersion
 
     defaultConfig {
         minSdkVersion rootProject.minSdkVersion
@@ -15,8 +16,11 @@ android {
     }
 
     compileOptions {
-        sourceCompatibility = 1.8
-        targetCompatibility = 1.8
+        sourceCompatibility versions.javaSourceCompatibility
+        targetCompatibility versions.javaTargetCompatibility
+    }
+    kotlinOptions {
+        jvmTarget = "11"
     }
 
     // robolectric

browser-switch/src/main/AndroidManifest.xml

@@ -1,5 +1,4 @@
-<manifest xmlns:android="http://schemas.android.com/apk/res/android"
-    package="com.braintreepayments.api.browserswitch">
+<manifest xmlns:android="http://schemas.android.com/apk/res/android">
 
     <queries>
         <intent>