Refactor auth to pass handler object to Dart

Author: JeroenWeener

packages/webview_flutter/webview_flutter_android/android/src/main/java/io/flutter/plugins/webviewflutter/GeneratedAndroidWebView.java

@@ -0,0 +1,51 @@
+// Copyright 2013 The Flutter Authors. All rights reserved.
+// Use of this source code is governed by a BSD-style license that can be
+// found in the LICENSE file.
+
+package io.flutter.plugins.webviewflutter;
+
+import android.webkit.HttpAuthHandler;
+import androidx.annotation.NonNull;
+import io.flutter.plugin.common.BinaryMessenger;
+import io.flutter.plugins.webviewflutter.GeneratedAndroidWebView.HttpAuthHandlerFlutterApi;
+
+/**
+ * Flutter API implementation for {@link HttpAuthHandler}.
+ *
+ * <p>This class may handle adding native instances that are attached to a Dart instance or passing
+ * arguments of callbacks methods to a Dart instance.
+ */
+public class HttpAuthHandlerFlutterApiImpl {
+  // To ease adding additional methods, this value is added prematurely.
+  @SuppressWarnings({"unused", "FieldCanBeLocal"})
+  private final BinaryMessenger binaryMessenger;
+
+  private final InstanceManager instanceManager;
+
+  private final HttpAuthHandlerFlutterApi api;
+
+  /**
+   * Constructs a {@link HttpAuthHandlerFlutterApiImpl}.
+   *
+   * @param binaryMessenger used to communicate with Dart over asynchronous messages
+   * @param instanceManager maintains instances stored to communicate with attached Dart objects
+   */
+  public HttpAuthHandlerFlutterApiImpl(
+      @NonNull BinaryMessenger binaryMessenger, @NonNull InstanceManager instanceManager) {
+    this.binaryMessenger = binaryMessenger;
+    this.instanceManager = instanceManager;
+    api = new HttpAuthHandlerFlutterApi(binaryMessenger);
+  }
+
+  /**
+   * Stores the `HttpAuthHandler` instance and notifies Dart to create and store a new
+   * `HttpAuthHandler` instance that is attached to this one. If `instance` has already been added,
+   * this method does nothing.
+   */
+  public void create(
+      @NonNull HttpAuthHandler instance, @NonNull HttpAuthHandlerFlutterApi.Reply<Void> callback) {
+    if (!instanceManager.containsInstance(instance)) {
+      api.create(instanceManager.addHostCreatedInstance(instance), callback);
+    }
+  }
+}

packages/webview_flutter/webview_flutter_android/android/src/main/java/io/flutter/plugins/webviewflutter/HttpAuthHandlerFlutterApiImpl.java

@@ -0,0 +1,57 @@
+// Copyright 2013 The Flutter Authors. All rights reserved.
+// Use of this source code is governed by a BSD-style license that can be
+// found in the LICENSE file.
+
+package io.flutter.plugins.webviewflutter;
+
+import android.webkit.HttpAuthHandler;
+import androidx.annotation.NonNull;
+import io.flutter.plugin.common.BinaryMessenger;
+import io.flutter.plugins.webviewflutter.GeneratedAndroidWebView.HttpAuthHandlerHostApi;
+import java.util.Objects;
+
+/**
+ * Host api implementation for {@link HttpAuthHandler}.
+ *
+ * <p>Handles creating {@link HttpAuthHandler}s that intercommunicate with a paired Dart object.
+ */
+public class HttpAuthHandlerHostApiImpl implements HttpAuthHandlerHostApi {
+  // To ease adding additional methods, this value is added prematurely.
+  @SuppressWarnings({"unused", "FieldCanBeLocal"})
+  private final BinaryMessenger binaryMessenger;
+
+  private final InstanceManager instanceManager;
+
+  /**
+   * Constructs a {@link HttpAuthHandlerHostApiImpl}.
+   *
+   * @param binaryMessenger used to communicate with Dart over asynchronous messages
+   * @param instanceManager maintains instances stored to communicate with attached Dart objects
+   */
+  public HttpAuthHandlerHostApiImpl(
+      @NonNull BinaryMessenger binaryMessenger, @NonNull InstanceManager instanceManager) {
+    this.binaryMessenger = binaryMessenger;
+    this.instanceManager = instanceManager;
+  }
+
+  @NonNull
+  @Override
+  public Boolean useHttpAuthUsernamePassword(@NonNull Long instanceId) {
+    return getHttpAuthHandlerInstance(instanceId).useHttpAuthUsernamePassword();
+  }
+
+  @Override
+  public void cancel(@NonNull Long instanceId) {
+    getHttpAuthHandlerInstance(instanceId).cancel();
+  }
+
+  @Override
+  public void proceed(
+      @NonNull Long instanceId, @NonNull String username, @NonNull String password) {
+    getHttpAuthHandlerInstance(instanceId).proceed(username, password);
+  }
+
+  private HttpAuthHandler getHttpAuthHandlerInstance(@NonNull Long instanceId) {
+    return Objects.requireNonNull(instanceManager.getInstance(instanceId));
+  }
+}

packages/webview_flutter/webview_flutter_android/android/src/main/java/io/flutter/plugins/webviewflutter/HttpAuthHandlerHostApiImpl.java

@@ -12,7 +12,6 @@
 import android.webkit.WebView;
 import android.webkit.WebViewClient;
 import androidx.annotation.NonNull;
-import androidx.annotation.Nullable;
 import androidx.annotation.RequiresApi;
 import androidx.webkit.WebResourceErrorCompat;
 import io.flutter.plugin.common.BinaryMessenger;
@@ -236,16 +235,20 @@ public void doUpdateVisitedHistory(
   public void onReceivedHttpAuthRequest(
       @NonNull WebViewClient webViewClient,
       @NonNull WebView webview,
-      @Nullable HttpAuthHandler handler,
+      @NonNull HttpAuthHandler httpAuthHandler,
       @NonNull String host,
       @NonNull String realm,
       @NonNull Reply<Void> callback) {
-    webViewFlutterApi.create(webview, reply -> {});
-    final Long webViewIdentifier =
-        Objects.requireNonNull(instanceManager.getIdentifierForStrongReference(webview));
+    new HttpAuthHandlerFlutterApiImpl(binaryMessenger, instanceManager)
+        .create(httpAuthHandler, reply -> {});
 
     onReceivedHttpAuthRequest(
-        getIdentifierForClient(webViewClient), webViewIdentifier, host, realm, callback);
+        Objects.requireNonNull(instanceManager.getIdentifierForStrongReference(webViewClient)),
+        Objects.requireNonNull(instanceManager.getIdentifierForStrongReference(webview)),
+        Objects.requireNonNull(instanceManager.getIdentifierForStrongReference(httpAuthHandler)),
+        host,
+        realm,
+        callback);
   }
 
   private long getIdentifierForClient(WebViewClient webViewClient) {

packages/webview_flutter/webview_flutter_android/android/src/main/java/io/flutter/plugins/webviewflutter/WebViewClientFlutterApiImpl.java

@@ -30,8 +30,6 @@ public class WebViewClientHostApiImpl implements GeneratedAndroidWebView.WebView
   private final WebViewClientCreator webViewClientCreator;
   private final WebViewClientFlutterApiImpl flutterApi;
 
-  static HttpAuthHandler httpAuthHandler;
-
   /** Implementation of {@link WebViewClient} that passes arguments of callback methods to Dart. */
   @RequiresApi(Build.VERSION_CODES.N)
   public static class WebViewClientImpl extends WebViewClient {
@@ -41,7 +39,7 @@ public static class WebViewClientImpl extends WebViewClient {
     /**
      * Creates a {@link WebViewClient} that passes arguments of callbacks methods to Dart.
      *
-     * @param flutterApi handles sending messages to Dart
+     * @param flutterApi handles sending messages to Dart.
      */
     public WebViewClientImpl(@NonNull WebViewClientFlutterApiImpl flutterApi) {
       this.flutterApi = flutterApi;
@@ -100,8 +98,10 @@ public void doUpdateVisitedHistory(
 
     @Override
     public void onReceivedHttpAuthRequest(
-        @NonNull WebView view, HttpAuthHandler handler, String host, String realm) {
-      httpAuthHandler = handler;
+        @NonNull WebView view,
+        @NonNull HttpAuthHandler handler,
+        @NonNull String host,
+        @NonNull String realm) {
       flutterApi.onReceivedHttpAuthRequest(this, view, handler, host, realm, reply -> {});
     }
 
@@ -272,18 +272,4 @@ public void setSynchronousReturnValueForShouldOverrideUrlLoading(
           "This WebViewClient doesn't support setting the returnValueForShouldOverrideUrlLoading.");
     }
   }
-
-  @Override
-  public void setAuthCredentials(
-      @NonNull Long instanceId,
-      @NonNull String host,
-      @NonNull String realm,
-      @NonNull String username,
-      @NonNull String password,
-      @NonNull GeneratedAndroidWebView.Result<Void> callBack) {
-    WebView webView = Objects.requireNonNull(instanceManager.getInstance(instanceId));
-
-    httpAuthHandler.proceed(username, password);
-    callBack.success(null);
-  }
 }

packages/webview_flutter/webview_flutter_android/android/src/main/java/io/flutter/plugins/webviewflutter/WebViewClientHostApiImpl.java

@@ -18,6 +18,7 @@
 import io.flutter.plugins.webviewflutter.GeneratedAndroidWebView.DownloadListenerHostApi;
 import io.flutter.plugins.webviewflutter.GeneratedAndroidWebView.FlutterAssetManagerHostApi;
 import io.flutter.plugins.webviewflutter.GeneratedAndroidWebView.GeolocationPermissionsCallbackHostApi;
+import io.flutter.plugins.webviewflutter.GeneratedAndroidWebView.HttpAuthHandlerHostApi;
 import io.flutter.plugins.webviewflutter.GeneratedAndroidWebView.InstanceManagerHostApi;
 import io.flutter.plugins.webviewflutter.GeneratedAndroidWebView.JavaObjectHostApi;
 import io.flutter.plugins.webviewflutter.GeneratedAndroidWebView.JavaScriptChannelHostApi;
@@ -141,6 +142,8 @@ private void setUp(
     GeolocationPermissionsCallbackHostApi.setup(
         binaryMessenger,
         new GeolocationPermissionsCallbackHostApiImpl(binaryMessenger, instanceManager));
+    HttpAuthHandlerHostApi.setup(
+        binaryMessenger, new HttpAuthHandlerHostApiImpl(binaryMessenger, instanceManager));
   }
 
   @Override

packages/webview_flutter/webview_flutter_android/android/src/main/java/io/flutter/plugins/webviewflutter/WebViewFlutterPlugin.java

@@ -79,6 +79,8 @@ Future<void> main() async {
 
     final Completer<String> hostCompleter = Completer<String>();
     final Completer<String> realmCompleter = Completer<String>();
+    final Completer<void Function(String, String)> onProceedCompleter =
+        Completer<void Function(String, String)>();
     final Completer<void> pageFinishedCompleter = Completer<void>();
 
     final PlatformWebViewController controller = PlatformWebViewController(
@@ -87,9 +89,10 @@ Future<void> main() async {
       ..setPlatformNavigationDelegate(PlatformNavigationDelegate(
         const PlatformNavigationDelegateCreationParams(),
       )
-        ..setOnReceiveHttpAuthRequest((String h, String r) {
-          hostCompleter.complete(h);
-          realmCompleter.complete(r);
+        ..setOnHttpAuthRequest((HttpAuthRequest request) {
+          hostCompleter.complete(request.host);
+          realmCompleter.complete(request.realm);
+          onProceedCompleter.complete(request.onProceed);
         })
         ..setOnPageFinished((_) => pageFinishedCompleter.complete()))
       ..setJavaScriptMode(JavaScriptMode.unrestricted)
@@ -110,7 +113,9 @@ Future<void> main() async {
     expect(host, equals('jigsaw.w3.org'));
     expect(realm, equals('test'));
 
-    await controller.setHttpAuthCredentials(host, realm, username, password);
+    final void Function(String, String) onProceed =
+        await onProceedCompleter.future;
+    onProceed(username, password);
     await pageFinishedCompleter.future;
 
     final String content = await controller.runJavaScriptReturningResult(

packages/webview_flutter/webview_flutter_android/example/integration_test/webview_flutter_test.dart

@@ -87,11 +87,12 @@ class _WebViewExampleState extends State<WebViewExample> {
   late TextEditingController usernameTextController;
   late TextEditingController passwordTextController;
 
-  Future<dynamic> openDialog(String host, String realm) async {
+  Future<dynamic> openDialog(HttpAuthRequest httpRequest) async {
     await showDialog(
         context: context,
         builder: (BuildContext context) => AlertDialog(
-              title: const Text('Authentication'),
+              title: Text(
+                  'Authentication request from ${httpRequest.host}, ${httpRequest.realm}'),
               content: Column(
                 mainAxisSize: MainAxisSize.min,
                 children: <Widget>[
@@ -110,11 +111,10 @@ class _WebViewExampleState extends State<WebViewExample> {
               actions: <Widget>[
                 TextButton(
                     onPressed: () {
-                      _controller.setHttpAuthCredentials(
-                          host,
-                          realm,
-                          usernameTextController.text,
-                          passwordTextController.text);
+                      httpRequest.onProceed(
+                        usernameTextController.text,
+                        passwordTextController.text,
+                      );
                       Navigator.of(context).pop();
                     },
                     child: const Text('Login')),
@@ -156,9 +156,6 @@ Page resource error:
   isForMainFrame: ${error.isForMainFrame}
           ''');
           })
-          ..setOnReceiveHttpAuthRequest((String host, String realm) async {
-            await openDialog(host, realm);
-          })
           ..setOnNavigationRequest((NavigationRequest request) {
             if (request.url.startsWith('https://www.youtube.com/')) {
               debugPrint('blocking navigation to ${request.url}');
@@ -191,7 +188,8 @@ Page resource error:
         LoadRequestParams(
           uri: Uri.parse('https://flutter.dev'),
         ),
-      );
+      )
+      ..setOnHttpAuthRequest(openDialog);
   }
 
   // https://authenticationtest.com/simpleFormAuth/

packages/webview_flutter/webview_flutter_android/example/lib/main.dart

@@ -68,8 +68,12 @@ class AndroidWebViewProxy {
     void Function(android_webview.WebView webView, String url)? urlLoading,
     void Function(android_webview.WebView webView, String url, bool isReload)?
         doUpdateVisitedHistory,
-    void Function(android_webview.WebView webView, String host, String realm)?
-        onReceivedHttpAuthRequest,
+    void Function(
+      android_webview.WebView webView,
+      android_webview.HttpAuthHandler handler,
+      String host,
+      String realm,
+    )? onReceivedHttpAuthRequest,
   }) createAndroidWebViewClient;
 
   /// Constructs a [android_webview.FlutterAssetManager].

packages/webview_flutter/webview_flutter_android/lib/src/android_proxy.dart

@@ -934,8 +934,12 @@ class WebViewClient extends JavaObject {
       doUpdateVisitedHistory;
 
   /// This callback is only called for requests that require HTTP authentication.
-  final void Function(WebView webView, String host, String realm)?
-      onReceivedHttpAuthRequest;
+  final void Function(
+    WebView webView,
+    HttpAuthHandler handler,
+    String host,
+    String realm,
+  )? onReceivedHttpAuthRequest;
 
   /// Sets the required synchronous return value for the Java method,
   /// `WebViewClient.shouldOverrideUrlLoading(...)`.
@@ -955,18 +959,6 @@ class WebViewClient extends JavaObject {
     return api.setShouldOverrideUrlLoadingReturnValueFromInstance(this, value);
   }
 
-  /// Sets the authentication credentials for the basic authentication request.
-  static Future<void> setHttpAuthCredentials(
-    WebView webView,
-    String host,
-    String realm,
-    String username,
-    String password,
-  ) {
-    return api.setHttpAuthCredentialsInstance(
-        webView, host, realm, username, password);
-  }
-
   @override
   WebViewClient copy() {
     return WebViewClient.detached(
@@ -1389,3 +1381,32 @@ class WebStorage extends JavaObject {
     );
   }
 }
+
+/// Represents a request for HTTP authentication.
+///
+/// Instances of this class are created by the [WebView] and passed to
+/// [WebViewClient.onReceivedHttpAuthRequest]. The host application must call
+/// either [HttpAuthHandler.proceed] or [HttpAuthHandler.cancel] to set the
+/// WebView's response to the request.
+class HttpAuthHandler extends JavaObject {
+  /// Constructs a [HttpAuthHandler].
+  HttpAuthHandler({
+    super.binaryMessenger,
+    super.instanceManager,
+  }) : super.detached();
+
+  /// Pigeon Host Api implementation for [HttpAuthHandler].
+  @visibleForTesting
+  static HttpAuthHandlerHostApiImpl api = HttpAuthHandlerHostApiImpl();
+
+  /// Instructs the WebView to cancel the authentication request.
+  Future<void> cancel() {
+    return api.cancelFromInstance(this);
+  }
+
+  /// Instructs the WebView to proceed with the authentication with the provided
+  /// credentials.
+  Future<void> proceed(String username, String password) {
+    return api.proceedFromInstance(this, username, password);
+  }
+}