[webview_flutter] Platform implementations for getCookies #11037

packages/webview_flutter/webview_flutter_android/CHANGELOG.md

@@ -1,3 +1,7 @@
+## 4.12.0
+
+* Adds support for retrieving cookies with `PlatformWebViewCookieManager.getCookies`.
+
 ## 4.11.0
 
 * Adds support to opt out of Android inset changes. See

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.2.0), do not edit directly.
+// Autogenerated from Pigeon (v26.3.4), do not edit directly.
 // See also: https://pub.dev/packages/pigeon
 @file:Suppress("UNCHECKED_CAST", "ArrayInDataClass")
 
@@ -49,7 +49,7 @@ class AndroidWebKitError(
     val code: String,
     override val message: String? = null,
     val details: Any? = null
-) : Throwable()
+) : RuntimeException()
 /**
  * Maintains instances used to communicate with the corresponding objects in Dart.
  *
@@ -1568,6 +1568,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?) {
@@ -1670,6 +1682,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,20 @@ 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);
+  }
 }

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()) ?? '',
+    );
+    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,