Added v4 implementation of AndroidWebViewCookieManager

This PR adds the Android implementation of the new v4
PlatformWebViewCookieManager interface.

This commit should be a complete implementation including
the required tests.

Author: mvanbeusekom

packages/webview_flutter/webview_flutter_android/CHANGELOG.md

@@ -1,3 +1,7 @@
+## 2.9.0
+
+* Adds Android implementation of the new webview_flutter_platform_interface (v4).
+
 ## 2.8.8
 
 * Minor fixes for new analysis options.

packages/webview_flutter/webview_flutter_android/lib/src/v4/android_webview_cookie_manager.dart

@@ -0,0 +1,59 @@
+// 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.
+
+import 'package:flutter/foundation.dart';
+import 'package:webview_flutter_platform_interface/v4/webview_flutter_platform_interface.dart';
+
+import '../android_webview.dart';
+import 'types/android_webview_cookie_manager_creation_params.dart';
+
+/// Handles all cookie operations for the Android platform.
+class AndroidWebViewCookieManager extends PlatformWebViewCookieManager {
+  /// Creates a new [AndroidWebViewCookieManager].
+  AndroidWebViewCookieManager(AndroidWebViewCookieManagerCreationParams params)
+      : this.fromNativeApi(
+          params,
+          cookieManager: CookieManager.instance,
+        );
+
+  /// Creates a new [AndroidWebViewCookieManager] using the Android native [CookieManager] implementation.
+  ///
+  /// This constructor is only used for testing. An instance should be obtained
+  /// with the default [AndroidWebViewCookieManager] constructor.
+  @visibleForTesting
+  AndroidWebViewCookieManager.fromNativeApi(
+    AndroidWebViewCookieManagerCreationParams params, {
+    required CookieManager cookieManager,
+  })  : _cookieManager = cookieManager,
+        super.implementation(params);
+
+  final CookieManager _cookieManager;
+
+  @override
+  Future<bool> clearCookies() {
+    return _cookieManager.clearCookies();
+  }
+
+  @override
+  Future<void> setCookie(WebViewCookie cookie) {
+    if (!_isValidPath(cookie.path)) {
+      throw ArgumentError(
+          'The path property for the provided cookie was not given a legal value.');
+    }
+    return _cookieManager.setCookie(
+      cookie.domain,
+      '${Uri.encodeComponent(cookie.name)}=${Uri.encodeComponent(cookie.value)}; path=${cookie.path}',
+    );
+  }
+
+  bool _isValidPath(String path) {
+    // Permitted ranges based on RFC6265bis: https://datatracker.ietf.org/doc/html/draft-ietf-httpbis-rfc6265bis-02#section-4.1.1
+    for (final int char in path.codeUnits) {
+      if ((char < 0x20 || char > 0x3A) && (char < 0x3C || char > 0x7E)) {
+        return false;
+      }
+    }
+    return true;
+  }
+}

packages/webview_flutter/webview_flutter_android/lib/src/v4/android_webview_platform.dart

@@ -0,0 +1,24 @@
+// 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.
+
+import 'package:webview_flutter_platform_interface/v4/webview_flutter_platform_interface.dart';
+
+import 'android_webview_cookie_manager.dart';
+import 'types/android_webview_cookie_manager_creation_params.dart';
+
+/// Provides Android specific implementations of a webview.
+class AndroidWebViewPlatform extends WebViewPlatform {
+  @override
+  PlatformWebViewCookieManager createPlatformCookieManager(
+      PlatformWebViewCookieManagerCreationParams params) {
+    if (params is AndroidWebViewCookieManagerCreationParams) {
+      return AndroidWebViewCookieManager(params);
+    }
+
+    return AndroidWebViewCookieManager(
+      AndroidWebViewCookieManagerCreationParams
+          .fromPlatformWebViewCookieManagerCreationParams(params),
+    );
+  }
+}

packages/webview_flutter/webview_flutter_android/lib/src/v4/types/android_webview_cookie_manager_creation_params.dart

@@ -0,0 +1,28 @@
+// 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.
+
+import 'package:flutter/material.dart';
+import 'package:webview_flutter_platform_interface/v4/src/types/types.dart';
+
+/// Object specifying creation parameters for creating a [AndroidWebViewCookieManager].
+///
+/// When adding additional fields make sure they can be null or have a default
+/// value to avoid breaking changes. See [PlatformWebViewCookieManagerCreationParams] for
+/// more information.
+@immutable
+class AndroidWebViewCookieManagerCreationParams
+    extends PlatformWebViewCookieManagerCreationParams {
+  /// Creates a new [AndroidWebViewCookieManagerCreationParams] instance.
+  const AndroidWebViewCookieManagerCreationParams._(
+    // This parameter prevents breaking changes later.
+    // ignore: avoid_unused_constructor_parameters
+    PlatformWebViewCookieManagerCreationParams params,
+  ) : super();
+
+  /// Creates a [AndroidWebViewCookieManagerCreationParams] instance based on [PlatformWebViewCookieManagerCreationParams].
+  factory AndroidWebViewCookieManagerCreationParams.fromPlatformWebViewCookieManagerCreationParams(
+      PlatformWebViewCookieManagerCreationParams params) {
+    return AndroidWebViewCookieManagerCreationParams._(params);
+  }
+}

packages/webview_flutter/webview_flutter_android/pubspec.yaml

@@ -2,7 +2,7 @@ name: webview_flutter_android
 description: A Flutter plugin that provides a WebView widget on Android.
 repository: https://github.com/flutter/plugins/tree/main/packages/webview_flutter/webview_flutter_android
 issue_tracker: https://github.com/flutter/flutter/issues?q=is%3Aissue+is%3Aopen+label%3A%22p%3A+webview%22
-version: 2.8.8
+version: 2.9.0
 
 environment:
   sdk: ">=2.14.0 <3.0.0"
@@ -19,7 +19,7 @@ flutter:
 dependencies:
   flutter:
     sdk: flutter
-  webview_flutter_platform_interface: ^1.8.0
+  webview_flutter_platform_interface: ^1.9.0
 
 dev_dependencies:
   build_runner: ^2.1.4

packages/webview_flutter/webview_flutter_android/test/v4/android_webview_cookie_manager_test.dart

@@ -0,0 +1,80 @@
+// 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.
+
+import 'package:flutter_test/flutter_test.dart';
+import 'package:mockito/annotations.dart';
+import 'package:mockito/mockito.dart';
+import 'package:webview_flutter_android/src/android_webview.dart'
+    as android_webview;
+import 'package:webview_flutter_android/src/v4/android_webview_cookie_manager.dart';
+import 'package:webview_flutter_android/src/v4/types/android_webview_cookie_manager_creation_params.dart';
+import 'package:webview_flutter_platform_interface/v4/src/webview_platform.dart';
+
+import 'android_webview_cookie_manager_test.mocks.dart';
+
+@GenerateMocks(<Type>[android_webview.CookieManager])
+void main() {
+  TestWidgetsFlutterBinding.ensureInitialized();
+
+  test('clearCookies should call android_webview.clearCookies', () {
+    final android_webview.CookieManager mockCookieManager = MockCookieManager();
+
+    when(mockCookieManager.clearCookies())
+        .thenAnswer((_) => Future<bool>.value(true));
+
+    final AndroidWebViewCookieManagerCreationParams params =
+        AndroidWebViewCookieManagerCreationParams
+            .fromPlatformWebViewCookieManagerCreationParams(
+                const PlatformWebViewCookieManagerCreationParams());
+
+    AndroidWebViewCookieManager.fromNativeApi(params,
+            cookieManager: mockCookieManager)
+        .clearCookies();
+    verify(mockCookieManager.clearCookies());
+  });
+
+  test('setCookie should throw ArgumentError for cookie with invalid path', () {
+    final AndroidWebViewCookieManagerCreationParams params =
+        AndroidWebViewCookieManagerCreationParams
+            .fromPlatformWebViewCookieManagerCreationParams(
+                const PlatformWebViewCookieManagerCreationParams());
+
+    final AndroidWebViewCookieManager androidCookieManager =
+        AndroidWebViewCookieManager.fromNativeApi(params,
+            cookieManager: MockCookieManager());
+
+    expect(
+      () => androidCookieManager.setCookie(const WebViewCookie(
+        name: 'foo',
+        value: 'bar',
+        domain: 'flutter.dev',
+        path: 'invalid;path',
+      )),
+      throwsA(const TypeMatcher<ArgumentError>()),
+    );
+  });
+
+  test(
+      'setCookie should call android_webview.csetCookie with properly formatted cookie value',
+      () {
+    final android_webview.CookieManager mockCookieManager = MockCookieManager();
+    final AndroidWebViewCookieManagerCreationParams params =
+        AndroidWebViewCookieManagerCreationParams
+            .fromPlatformWebViewCookieManagerCreationParams(
+                const PlatformWebViewCookieManagerCreationParams());
+
+    AndroidWebViewCookieManager.fromNativeApi(params,
+            cookieManager: mockCookieManager)
+        .setCookie(const WebViewCookie(
+      name: 'foo&',
+      value: 'bar@',
+      domain: 'flutter.dev',
+    ));
+
+    verify(mockCookieManager.setCookie(
+      'flutter.dev',
+      'foo%26=bar%40; path=/',
+    ));
+  });
+}

packages/webview_flutter/webview_flutter_android/test/v4/android_webview_cookie_manager_test.mocks.dart

@@ -0,0 +1,37 @@
+// Mocks generated by Mockito 5.1.0 from annotations
+// in webview_flutter_android/test/v4/android_webview_cookie_manager_test.dart.
+// Do not manually edit this file.
+
+import 'dart:async' as _i3;
+
+import 'package:mockito/mockito.dart' as _i1;
+import 'package:webview_flutter_android/src/android_webview.dart' as _i2;
+
+// ignore_for_file: type=lint
+// ignore_for_file: avoid_redundant_argument_values
+// ignore_for_file: avoid_setters_without_getters
+// ignore_for_file: comment_references
+// ignore_for_file: implementation_imports
+// ignore_for_file: invalid_use_of_visible_for_testing_member
+// ignore_for_file: prefer_const_constructors
+// ignore_for_file: unnecessary_parenthesis
+// ignore_for_file: camel_case_types
+
+/// A class which mocks [CookieManager].
+///
+/// See the documentation for Mockito's code generation for more information.
+class MockCookieManager extends _i1.Mock implements _i2.CookieManager {
+  MockCookieManager() {
+    _i1.throwOnMissingStub(this);
+  }
+
+  @override
+  _i3.Future<void> setCookie(String? url, String? value) =>
+      (super.noSuchMethod(Invocation.method(#setCookie, [url, value]),
+          returnValue: Future<void>.value(),
+          returnValueForMissingStub: Future<void>.value()) as _i3.Future<void>);
+  @override
+  _i3.Future<bool> clearCookies() =>
+      (super.noSuchMethod(Invocation.method(#clearCookies, []),
+          returnValue: Future<bool>.value(false)) as _i3.Future<bool>);
+}