[webview_flutter] Implement getCookies

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

@@ -428,9 +428,17 @@ class SampleMenu extends StatelessWidget {
   }
 
   Future<void> _onListCookies(BuildContext context) async {
-    final cookies =
-        await webViewController.runJavaScriptReturningResult('document.cookie')
-            as String;
+    final Uri? domain = Uri.tryParse(
+      (await webViewController.currentUrl()) ?? '',
+    );
+
+    late final List<WebViewCookie> cookies;
+    if (domain == null) {
+      cookies = [];
+    } else {
+      cookies = await cookieManager.getCookies(domain: domain);
+    }
+
     if (context.mounted) {
       ScaffoldMessenger.of(context).showSnackBar(
         SnackBar(
@@ -536,13 +544,12 @@ class SampleMenu extends StatelessWidget {
     return webViewController.loadHtmlString(kTransparentBackgroundPage);
   }
 
-  Widget _getCookieList(String cookies) {
-    if (cookies == '""') {
+  Widget _getCookieList(List<WebViewCookie> cookies) {
+    if (cookies.isEmpty) {
       return Container();
     }
-    final List<String> cookieList = cookies.split(';');
-    final Iterable<Text> cookieWidgets = cookieList.map(
-      (String cookie) => Text(cookie),
+    final Iterable<Text> cookieWidgets = cookies.map(
+      (WebViewCookie cookie) => Text(cookie.toString()),
     );
     return Column(
       mainAxisAlignment: MainAxisAlignment.end,

packages/webview_flutter/webview_flutter/example/pubspec.yaml

@@ -36,3 +36,9 @@ flutter:
     - assets/sample_video.mp4
     - assets/www/index.html
     - assets/www/styles/style.css
+# FOR TESTING AND INITIAL REVIEW ONLY. DO NOT MERGE.
+# See https://github.com/flutter/flutter/blob/master/docs/ecosystem/contributing/README.md#changing-federated-plugins
+dependency_overrides:
+  webview_flutter_android: {path: ../../../../packages/webview_flutter/webview_flutter_android}
+  webview_flutter_platform_interface: {path: ../../../../packages/webview_flutter/webview_flutter_platform_interface}
+  webview_flutter_wkwebview: {path: ../../../../packages/webview_flutter/webview_flutter_wkwebview}

packages/webview_flutter/webview_flutter/lib/src/webview_cookie_manager.dart

@@ -86,4 +86,12 @@ class WebViewCookieManager {
   ///
   /// This is a no op on iOS versions below 11.
   Future<void> setCookie(WebViewCookie cookie) => platform.setCookie(cookie);
+
+  /// Gets a list of existing cookie for specified domain from all
+  /// WebView instances of the application.
+  ///
+  /// Each platform can have different url requirements. Please check individual
+  /// platform implementation for details
+  Future<List<WebViewCookie>> getCookies({required Uri domain}) =>
+      platform.getCookies(domain);
 }

packages/webview_flutter/webview_flutter/pubspec.yaml

@@ -36,3 +36,9 @@ topics:
   - html
   - webview
   - webview-flutter
+# FOR TESTING AND INITIAL REVIEW ONLY. DO NOT MERGE.
+# See https://github.com/flutter/flutter/blob/master/docs/ecosystem/contributing/README.md#changing-federated-plugins
+dependency_overrides:
+  webview_flutter_android: {path: ../../../packages/webview_flutter/webview_flutter_android}
+  webview_flutter_platform_interface: {path: ../../../packages/webview_flutter/webview_flutter_platform_interface}
+  webview_flutter_wkwebview: {path: ../../../packages/webview_flutter/webview_flutter_wkwebview}

packages/webview_flutter/webview_flutter/test/legacy/webview_flutter_test.mocks.dart

@@ -1,4 +1,4 @@
-// Mocks generated by Mockito 5.4.5 from annotations
+// Mocks generated by Mockito 5.4.6 from annotations
 // in webview_flutter/test/legacy/webview_flutter_test.dart.
 // Do not manually edit this file.
 
@@ -34,6 +34,7 @@ import 'package:webview_flutter_platform_interface/src/legacy/types/types.dart'
 // ignore_for_file: unnecessary_parenthesis
 // ignore_for_file: camel_case_types
 // ignore_for_file: subtype_of_sealed_class
+// ignore_for_file: invalid_use_of_internal_member
 
 class _FakeWidget_0 extends _i1.SmartFake implements _i2.Widget {
   _FakeWidget_0(Object parent, Invocation parentInvocation)

packages/webview_flutter/webview_flutter/test/navigation_delegate_test.mocks.dart

@@ -1,4 +1,4 @@
-// Mocks generated by Mockito 5.4.5 from annotations
+// Mocks generated by Mockito 5.4.6 from annotations
 // in webview_flutter/test/navigation_delegate_test.dart.
 // Do not manually edit this file.
 
@@ -34,6 +34,7 @@ import 'package:webview_flutter_platform_interface/src/webview_platform.dart'
 // ignore_for_file: unnecessary_parenthesis
 // ignore_for_file: camel_case_types
 // ignore_for_file: subtype_of_sealed_class
+// ignore_for_file: invalid_use_of_internal_member
 
 class _FakePlatformWebViewCookieManager_0 extends _i1.SmartFake
     implements _i2.PlatformWebViewCookieManager {

packages/webview_flutter/webview_flutter/test/webview_controller_test.mocks.dart

@@ -1,4 +1,4 @@
-// Mocks generated by Mockito 5.4.5 from annotations
+// Mocks generated by Mockito 5.4.6 from annotations
 // in webview_flutter/test/webview_controller_test.dart.
 // Do not manually edit this file.
 
@@ -26,6 +26,7 @@ import 'package:webview_flutter_platform_interface/src/types/types.dart' as _i2;
 // ignore_for_file: unnecessary_parenthesis
 // ignore_for_file: camel_case_types
 // ignore_for_file: subtype_of_sealed_class
+// ignore_for_file: invalid_use_of_internal_member
 
 class _FakePlatformWebViewControllerCreationParams_0 extends _i1.SmartFake
     implements _i2.PlatformWebViewControllerCreationParams {
@@ -82,6 +83,15 @@ class MockPlatformWebViewController extends _i1.Mock
           )
           as _i5.Future<void>);
 
+  @override
+  _i5.Future<void> loadFileWithParams(_i2.LoadFileParams? params) =>
+      (super.noSuchMethod(
+            Invocation.method(#loadFileWithParams, [params]),
+            returnValue: _i5.Future<void>.value(),
+            returnValueForMissingStub: _i5.Future<void>.value(),
+          )
+          as _i5.Future<void>);
+
   @override
   _i5.Future<void> loadFlutterAsset(String? key) =>
       (super.noSuchMethod(

packages/webview_flutter/webview_flutter/test/webview_cookie_manager_test.dart

@@ -50,5 +50,43 @@ void main() {
               as WebViewCookie;
       expect(capturedCookie, cookie);
     });
+
+    test('getCookies', () async {
+      final mockPlatformWebViewCookieManager =
+          MockPlatformWebViewCookieManager();
+      final cookieManager = WebViewCookieManager.fromPlatform(
+        mockPlatformWebViewCookieManager,
+      );
+
+      when(
+        mockPlatformWebViewCookieManager.getCookies(Uri(host: 'flutter.dev')),
+      ).thenAnswer((_) async => []);
+
+      final List<WebViewCookie> cookies = await cookieManager.getCookies(
+        domain: Uri(host: 'flutter.dev'),
+      );
+
+      expect(cookies, isEmpty);
+
+      verify(
+        mockPlatformWebViewCookieManager.getCookies(Uri(host: 'flutter.dev')),
+      ).called(1);
+
+      const cookie = WebViewCookie(
+        name: 'name',
+        value: 'value',
+        domain: 'domain',
+      );
+
+      when(
+        mockPlatformWebViewCookieManager.getCookies(Uri(host: 'domain')),
+      ).thenAnswer((_) => Future.value([cookie]));
+
+      await cookieManager.getCookies(domain: Uri(host: 'domain'));
+
+      verify(
+        mockPlatformWebViewCookieManager.getCookies(Uri(host: 'domain')),
+      ).called(1);
+    });
   });
 }

packages/webview_flutter/webview_flutter/test/webview_cookie_manager_test.mocks.dart

@@ -1,4 +1,4 @@
-// Mocks generated by Mockito 5.4.5 from annotations
+// Mocks generated by Mockito 5.4.6 from annotations
 // in webview_flutter/test/webview_cookie_manager_test.dart.
 // Do not manually edit this file.
 
@@ -23,6 +23,7 @@ import 'package:webview_flutter_platform_interface/src/types/types.dart' as _i2;
 // ignore_for_file: unnecessary_parenthesis
 // ignore_for_file: camel_case_types
 // ignore_for_file: subtype_of_sealed_class
+// ignore_for_file: invalid_use_of_internal_member
 
 class _FakePlatformWebViewCookieManagerCreationParams_0 extends _i1.SmartFake
     implements _i2.PlatformWebViewCookieManagerCreationParams {
@@ -68,4 +69,14 @@ class MockPlatformWebViewCookieManager extends _i1.Mock
             returnValueForMissingStub: _i4.Future<void>.value(),
           )
           as _i4.Future<void>);
+
+  @override
+  _i4.Future<List<_i2.WebViewCookie>> getCookies(Uri? domain) =>
+      (super.noSuchMethod(
+            Invocation.method(#getCookies, [domain]),
+            returnValue: _i4.Future<List<_i2.WebViewCookie>>.value(
+              <_i2.WebViewCookie>[],
+            ),
+          )
+          as _i4.Future<List<_i2.WebViewCookie>>);
 }

packages/webview_flutter/webview_flutter/test/webview_widget_test.mocks.dart

@@ -1,4 +1,4 @@
-// Mocks generated by Mockito 5.4.5 from annotations
+// Mocks generated by Mockito 5.4.6 from annotations
 // in webview_flutter/test/webview_widget_test.dart.
 // Do not manually edit this file.
 
@@ -30,6 +30,7 @@ import 'package:webview_flutter_platform_interface/src/types/types.dart' as _i2;
 // ignore_for_file: unnecessary_parenthesis
 // ignore_for_file: camel_case_types
 // ignore_for_file: subtype_of_sealed_class
+// ignore_for_file: invalid_use_of_internal_member
 
 class _FakePlatformWebViewControllerCreationParams_0 extends _i1.SmartFake
     implements _i2.PlatformWebViewControllerCreationParams {
@@ -95,6 +96,15 @@ class MockPlatformWebViewController extends _i1.Mock
           )
           as _i7.Future<void>);
 
+  @override
+  _i7.Future<void> loadFileWithParams(_i2.LoadFileParams? params) =>
+      (super.noSuchMethod(
+            Invocation.method(#loadFileWithParams, [params]),
+            returnValue: _i7.Future<void>.value(),
+            returnValueForMissingStub: _i7.Future<void>.value(),
+          )
+          as _i7.Future<void>);
+
   @override
   _i7.Future<void> loadFlutterAsset(String? key) =>
       (super.noSuchMethod(

packages/webview_flutter/webview_flutter_android/android/src/main/java/io/flutter/plugins/webviewflutter/AndroidWebkitLibrary.g.kt

@@ -1,7 +1,7 @@
 // Copyright 2013 The Flutter Authors
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.
-// Autogenerated from Pigeon (v26.1.4), do not edit directly.
+// Autogenerated from Pigeon (v26.1.5), do not edit directly.
 // See also: https://pub.dev/packages/pigeon
 @file:Suppress("UNCHECKED_CAST", "ArrayInDataClass")
 
@@ -155,10 +155,6 @@ class AndroidWebkitLibraryPigeonInstanceManager(
    */
   fun <T> remove(identifier: Long): T? {
     logWarningIfFinalizationListenerHasStopped()
-    val instance: Any? = getInstance(identifier)
-    if (instance is WebViewProxyApi.WebViewPlatformView) {
-      instance.destroy()
-    }
     return strongInstances.remove(identifier) as T?
   }
 
@@ -1519,6 +1515,18 @@ abstract class PigeonApiCookieManager(
       accept: Boolean
   )
 
+  /**
+   * Gets all the cookies for the given URL.
+   *
+   * This may return multiple key-value pairs if multiple cookies are associated with this URL, in
+   * which case each cookie will be delimited by "; " characters (semicolon followed by a space).
+   * Each key-value pair will be of the form "key=value".
+   *
+   * Note: Any cookies set with the "Partitioned" attribute will only be returned for the top-level
+   * partition of url.
+   */
+  abstract fun getCookies(pigeon_instance: android.webkit.CookieManager, url: String): String?
+
   companion object {
     @Suppress("LocalVariableName")
     fun setUpMessageHandlers(binaryMessenger: BinaryMessenger, api: PigeonApiCookieManager?) {
@@ -1621,6 +1629,29 @@ abstract class PigeonApiCookieManager(
           channel.setMessageHandler(null)
         }
       }
+      run {
+        val channel =
+            BasicMessageChannel<Any?>(
+                binaryMessenger,
+                "dev.flutter.pigeon.webview_flutter_android.CookieManager.getCookies",
+                codec)
+        if (api != null) {
+          channel.setMessageHandler { message, reply ->
+            val args = message as List<Any?>
+            val pigeon_instanceArg = args[0] as android.webkit.CookieManager
+            val urlArg = args[1] as String
+            val wrapped: List<Any?> =
+                try {
+                  listOf(api.getCookies(pigeon_instanceArg, urlArg))
+                } catch (exception: Throwable) {
+                  AndroidWebkitLibraryPigeonUtils.wrapError(exception)
+                }
+            reply.reply(wrapped)
+          }
+        } else {
+          channel.setMessageHandler(null)
+        }
+      }
     }
   }
 

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

@@ -52,4 +52,9 @@ public void setAcceptThirdPartyCookies(
       @NonNull CookieManager pigeon_instance, @NonNull WebView webView, boolean accept) {
     pigeon_instance.setAcceptThirdPartyCookies(webView, accept);
   }
+
+  @Override
+  public @NonNull String getCookies(@NonNull CookieManager pigeon_instance, @NonNull String url) {
+    return pigeon_instance.getCookie(url);
+  }
 }

packages/webview_flutter/webview_flutter_android/android/src/test/java/io/flutter/plugins/webviewflutter/CookieManagerTest.java

@@ -7,6 +7,7 @@
 import static org.junit.Assert.assertEquals;
 import static org.mockito.Mockito.mock;
 import static org.mockito.Mockito.verify;
+import static org.mockito.Mockito.when;
 
 import android.webkit.CookieManager;
 import android.webkit.ValueCallback;
@@ -64,4 +65,35 @@ public void setAcceptThirdPartyCookies() {
 
     verify(instance).setAcceptThirdPartyCookies(webView, accept);
   }
+
+  @Test
+  public void getCookies_returnsCookieString() {
+    final PigeonApiCookieManager api = new TestProxyApiRegistrar().getPigeonApiCookieManager();
+
+    final CookieManager instance = mock(CookieManager.class);
+    final String domain = "https://flutter.dev";
+    final String cookieValue = "session=12345";
+
+    // Mock the CookieManager to return the cookie string
+    when(instance.getCookie(domain)).thenReturn(cookieValue);
+
+    final String result = api.getCookies(instance, domain);
+
+    assertEquals(cookieValue, result);
+  }
+
+  @Test
+  public void getCookies_returnsEmptyStringIfNull() {
+    final PigeonApiCookieManager api = new TestProxyApiRegistrar().getPigeonApiCookieManager();
+
+    final CookieManager instance = mock(CookieManager.class);
+    final String domain = "https://flutter.dev";
+
+    // Mock the CookieManager to return null
+    when(instance.getCookie(domain)).thenReturn(null);
+
+    final String result = api.getCookies(instance, domain);
+
+    assertEquals("", result);
+  }
 }

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

@@ -496,9 +496,17 @@ class SampleMenu extends StatelessWidget {
   }
 
   Future<void> _onListCookies(BuildContext context) async {
-    final cookies =
-        await webViewController.runJavaScriptReturningResult('document.cookie')
-            as String;
+    final Uri? domain = Uri.tryParse(
+      (await webViewController.currentUrl()) ?? '',
+    );
+    late final List<WebViewCookie> cookies;
+
+    if (domain == null) {
+      cookies = [];
+    } else {
+      cookies = await cookieManager.getCookies(domain);
+    }
+
     if (context.mounted) {
       ScaffoldMessenger.of(context).showSnackBar(
         SnackBar(
@@ -662,13 +670,12 @@ class SampleMenu extends StatelessWidget {
     return webViewController.loadHtmlString(kAlertTestPage);
   }
 
-  Widget _getCookieList(String cookies) {
-    if (cookies == '""') {
+  Widget _getCookieList(List<WebViewCookie> cookies) {
+    if (cookies.isEmpty) {
       return Container();
     }
-    final List<String> cookieList = cookies.split(';');
-    final Iterable<Text> cookieWidgets = cookieList.map(
-      (String cookie) => Text(cookie),
+    final Iterable<Text> cookieWidgets = cookies.map(
+      (WebViewCookie cookie) => Text(cookie.toString()),
     );
     return Column(
       mainAxisAlignment: MainAxisAlignment.end,