fix(#401): update OIDC login handling to use custom tabs (#405)

Author: jkuester

build.gradle

@@ -475,6 +475,7 @@ android {
 dependencies {
   implementation fileTree(dir: 'libs', include: ['*.jar'])
   implementation platform('org.jetbrains.kotlin:kotlin-bom:1.9.24')
+  implementation 'androidx.browser:browser:1.8.0'
   implementation 'androidx.core:core:1.13.1'
   implementation 'androidx.activity:activity:1.9.0'
   implementation 'androidx.fragment:fragment:1.7.1'

src/main/AndroidManifest.xml

@@ -40,9 +40,18 @@
       </intent-filter>
     </activity>
     <activity android:name="EmbeddedBrowserActivity"
-        android:screenOrientation="portrait"
-        android:configChanges="orientation|screenSize"
-        tools:ignore="DiscouragedApi"/>
+      android:screenOrientation="portrait"
+      android:configChanges="orientation|screenSize"
+      android:launchMode="singleTask"
+      android:exported="true"
+      tools:ignore="DiscouragedApi">
+      <intent-filter android:autoVerify="true">
+        <action android:name="android.intent.action.VIEW" />
+        <category android:name="android.intent.category.DEFAULT" />
+        <category android:name="android.intent.category.BROWSABLE" />
+        <data android:scheme="@string/scheme" android:host="@string/app_host" android:pathPattern=".*"/>
+      </intent-filter>
+    </activity>
     <activity android:name="ConnectionErrorActivity"
         android:screenOrientation="portrait"
         android:configChanges="orientation|screenSize"
@@ -66,16 +75,6 @@
     <activity android:name="DomainVerificationActivity"
       android:screenOrientation="portrait"
       tools:ignore="DiscouragedApi" />
-    <activity android:name="AppUrlIntentActivity"
-        android:launchMode="singleInstance"
-        android:exported="true">
-      <intent-filter android:autoVerify="true">
-        <action android:name="android.intent.action.VIEW" />
-        <category android:name="android.intent.category.DEFAULT" />
-        <category android:name="android.intent.category.BROWSABLE" />
-        <data android:scheme="@string/scheme" android:host="@string/app_host" android:pathPattern=".*"/>
-      </intent-filter>
-    </activity>
     <activity android:name="UpgradingActivity"
       android:screenOrientation="portrait"
       android:configChanges="orientation|screenSize"

src/main/java/org/medicmobile/webapp/mobile/AppUrlIntentActivity.java

@@ -119,22 +119,33 @@ public void onReceiveValue(String result) {
 
 		enableUrlHandlers(container);
 
-		Intent appLinkIntent = getIntent();
-		Uri appLinkData = appLinkIntent.getData();
-		browseTo(appLinkData);
-
 		if (settings.allowsConfiguration()) {
 			toast(redactUrl(appUrl));
 		}
 
 		registerRetryConnectionBroadcastReceiver();
 
 		String recentNavigation = settings.getLastUrl();
-		if (isValidNavigationUrl(appUrl, recentNavigation)) {
+		Intent appLinkIntent = getIntent();
+		Uri appLinkData = appLinkIntent.getData();
+		if (appLinkData != null) {
+			// The app has been opened via an app link.
+			browseTo(appLinkData);
+		} else if (isValidNavigationUrl(appUrl, recentNavigation)) {
+			// The app has been opened normally, and the user can start where they left off.
 			container.loadUrl(recentNavigation);
+		} else {
+			// The app has been opened normally, but no previous URL is available. (Maybe it is the first time.)
+			browseTo(null);
 		}
 	}
 
+	@Override
+	protected void onNewIntent(Intent intent) {
+		Uri appLinkData = intent.getData();
+		browseTo(appLinkData);
+	}
+
 	@SuppressWarnings("PMD.CallSuperFirst")
 	@Override
 	protected void onStart() {

src/main/java/org/medicmobile/webapp/mobile/EmbeddedBrowserActivity.java

@@ -17,6 +17,8 @@
 import android.webkit.WebView;
 import android.webkit.WebViewClient;
 
+import androidx.browser.customtabs.CustomTabsIntent;
+
 public class UrlHandler extends WebViewClient {
 	EmbeddedBrowserActivity parentActivity;
 	SettingsStore settings;
@@ -31,10 +33,14 @@ public UrlHandler(EmbeddedBrowserActivity parentActivity, SettingsStore settings
 	@Override
 	public boolean shouldOverrideUrlLoading(WebView view, WebResourceRequest request) {
 		Uri uri = request.getUrl();
-		if (isUrlRelated(this.settings.getAppUrl(), uri) || isOidcProviderUrl(uri)) {
+		if (isUrlRelated(this.settings.getAppUrl(), uri)) {
 			// Load all related URLs in the WebView
 			return false;
 		}
+		if (isOidcProviderUrl(uri)) {
+			launchCustomTab(uri);
+			return true;
+		}
 
 		// Let Android decide what to do with unrelated URLs
 		// unrelated URLs include `tel:` and `sms:` uri schemes
@@ -43,6 +49,11 @@ public boolean shouldOverrideUrlLoading(WebView view, WebResourceRequest request
 		return true;
 	}
 
+	private void launchCustomTab(Uri uri) {
+		CustomTabsIntent customTabsIntent = new CustomTabsIntent.Builder().build();
+		customTabsIntent.launchUrl(this.parentActivity, uri);
+	}
+
 	/**
 	 * Support OIDC login flow by allowing any URL that contains the current app_url as the redirect_uri.
 	 */

src/main/java/org/medicmobile/webapp/mobile/UrlHandler.java

@@ -14,10 +14,13 @@
 import static org.mockito.Mockito.mock;
 import static org.mockito.Mockito.mockStatic;
 import static org.mockito.Mockito.never;
+import static org.mockito.Mockito.times;
+import static org.mockito.Mockito.verify;
 import static org.mockito.Mockito.when;
 import static org.robolectric.Shadows.shadowOf;
 
 import android.content.Intent;
+import android.net.Uri;
 
 import androidx.core.content.ContextCompat;
 import androidx.test.espresso.intent.Intents;
@@ -273,4 +276,25 @@ public void onActivityResult_unknownRequestCode_logRequestCode(){
 				});
 		}
 	}
+
+	@Test
+	public void onNewIntent() {
+		Intent intent = mock(Intent.class);
+		String url = "https://example.com";
+		when(intent.getData()).thenReturn(Uri.parse(url));
+		try(MockedStatic<MedicLog> medicLogMock = mockStatic(MedicLog.class)) {
+			scenarioRule
+				.getScenario()
+				.onActivity(embeddedBrowserActivity -> {
+					embeddedBrowserActivity.onNewIntent(intent);
+
+					verify(intent, times(1)).getData();
+					medicLogMock.verify(() -> MedicLog.trace(
+						eq(embeddedBrowserActivity),
+						eq("Pointing browser to: %s"),
+						eq(url)
+					));
+				});
+		}
+	}
 }

src/test/java/org/medicmobile/webapp/mobile/EmbeddedBrowserActivityTest.java

@@ -1,10 +1,12 @@
 package org.medicmobile.webapp.mobile;
 
+import static org.junit.Assert.assertEquals;
 import static org.junit.Assert.assertFalse;
 import static org.junit.Assert.assertTrue;
 import static org.mockito.ArgumentMatchers.any;
 import static org.mockito.Mockito.doNothing;
 import static org.mockito.Mockito.mock;
+import static org.mockito.Mockito.mockConstruction;
 import static org.mockito.Mockito.times;
 import static org.mockito.Mockito.verify;
 import static org.mockito.Mockito.when;
@@ -14,14 +16,18 @@
 import android.webkit.WebResourceRequest;
 import android.webkit.WebView;
 
+import androidx.browser.customtabs.CustomTabsIntent;
+
 import org.junit.Before;
 import org.junit.Test;
 import org.junit.runner.RunWith;
+import org.mockito.MockedConstruction;
 import org.robolectric.RobolectricTestRunner;
 
 @RunWith(RobolectricTestRunner.class)
 public class UrlHandlerTest {
 	private static final String APP_URL = "https://project-abc.medic.org";
+	private EmbeddedBrowserActivity parentActivity;
 	private SettingsStore settingsStore;
 	private WebView webView;
 	private WebResourceRequest webResourceRequest;
@@ -30,6 +36,7 @@ public class UrlHandlerTest {
 
 	@Before
 	public void setup() {
+		parentActivity = mock(EmbeddedBrowserActivity.class);
 		settingsStore = mock(SettingsStore.class);
 		when(settingsStore.getAppUrl()).thenReturn(APP_URL);
 		webView = mock(WebView.class);
@@ -38,7 +45,7 @@ public void setup() {
 		doNothing().when(context).startActivity(any());
 		webResourceRequest = mock(WebResourceRequest.class);
 
-		handler = new UrlHandler(null, settingsStore);
+		handler = new UrlHandler(parentActivity, settingsStore);
 	}
 
 	@Test
@@ -69,17 +76,26 @@ public void shouldOverrideUrlLoading_withExternalUrl() {
 
 	@Test
 	public void shouldOverrideUrlLoading_withExternalOidcProviderUrl() {
-		when(webResourceRequest.getUrl()).thenReturn(
-			Uri.parse("some-external-url.com?redirect_uri=" + Uri.encode(APP_URL + "/medic/login/oidc"))
-		);
-
-		boolean result = handler.shouldOverrideUrlLoading(webView, webResourceRequest);
-
-		assertFalse(result);
-		verify(settingsStore, times(2)).getAppUrl();
-		verify(webResourceRequest).getUrl();
-		verify(webView, times(0)).getContext();
-		verify(context, times(0)).startActivity(any());
+		CustomTabsIntent intent = mock(CustomTabsIntent.class);
+		Uri expectedUri = Uri.parse("some-external-url.com?redirect_uri=" + Uri.encode(APP_URL + "/medic/login/oidc"));
+		try (MockedConstruction<CustomTabsIntent.Builder> mocked = mockConstruction(
+			CustomTabsIntent.Builder.class,
+			(mock, context) -> when(mock.build()).thenReturn(intent)
+		)) {
+			doNothing().when(intent).launchUrl(any(), any());
+			when(webResourceRequest.getUrl()).thenReturn(expectedUri);
+
+			boolean result = handler.shouldOverrideUrlLoading(webView, webResourceRequest);
+
+			assertTrue(result);
+			verify(settingsStore, times(2)).getAppUrl();
+			verify(webResourceRequest).getUrl();
+			verify(webView, times(0)).getContext();
+			verify(context, times(0)).startActivity(any());
+			assertEquals(1, mocked.constructed().size());
+			verify(mocked.constructed().get(0), times(1)).build();
+			verify(intent, times(1)).launchUrl(parentActivity, expectedUri);
+		}
 	}
 
 	@Test