[webview_flutter] Adds support to listen to url changes

packages/webview_flutter/webview_flutter/CHANGELOG.md

@@ -1,3 +1,7 @@
+## 4.1.0
+
+* Adds support to track URL changes. See `NavigationDelegate(onUrlChange)`.
+
 ## 4.0.5
 
 * Updates links for the merge of flutter/plugins into flutter/packages.

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

@@ -706,6 +706,32 @@ Future<void> main() async {
       final String? currentUrl = await controller.currentUrl();
       expect(currentUrl, secondaryUrl);
     });
+
+    testWidgets('can receive url changes', (WidgetTester tester) async {
+      final Completer<void> pageLoaded = Completer<void>();
+
+      final WebViewController controller = WebViewController()
+        ..setJavaScriptMode(JavaScriptMode.unrestricted)
+        ..setNavigationDelegate(NavigationDelegate(
+          onPageFinished: (_) => pageLoaded.complete(),
+        ))
+        ..loadRequest(Uri.parse(blankPageEncoded));
+
+      await tester.pumpWidget(WebViewWidget(controller: controller));
+
+      await pageLoaded.future;
+
+      final Completer<String> urlChangeCompleter = Completer<String>();
+      await controller.setNavigationDelegate(NavigationDelegate(
+        onUrlChange: (UrlChange change) {
+          urlChangeCompleter.complete(change.url);
+        },
+      ));
+
+      await controller.runJavaScript('location.href = "$primaryUrl"');
+
+      await expectLater(urlChangeCompleter.future, completion(primaryUrl));
+    });
   });
 
   testWidgets('target _blank opens in same window',

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

@@ -136,6 +136,9 @@ Page resource error:
             debugPrint('allowing navigation to ${request.url}');
             return NavigationDecision.navigate;
           },
+          onUrlChange: (UrlChange change) {
+            debugPrint('url change to ${change.url}');
+          },
         ),
       )
       ..addJavaScriptChannel(

packages/webview_flutter/webview_flutter/example/pubspec.yaml

@@ -38,3 +38,12 @@ flutter:
     - assets/sample_video.mp4
     - assets/www/index.html
     - assets/www/styles/style.css
+
+# FOR TESTING ONLY. DO NOT MERGE.
+dependency_overrides:
+  webview_flutter_android:
+    path: ../../../webview_flutter/webview_flutter_android
+  webview_flutter_platform_interface:
+    path: ../../../webview_flutter/webview_flutter_platform_interface
+  webview_flutter_wkwebview:
+    path: ../../../webview_flutter/webview_flutter_wkwebview

packages/webview_flutter/webview_flutter/example/test/main_test.dart

@@ -113,4 +113,7 @@ class FakeNavigationDelegate extends PlatformNavigationDelegate {
   Future<void> setOnWebResourceError(
     WebResourceErrorCallback onWebResourceError,
   ) async {}
+
+  @override
+  Future<void> setOnUrlChange(UrlChangeCallback onUrlChange) async {}
 }

packages/webview_flutter/webview_flutter/lib/src/navigation_delegate.dart

@@ -36,20 +36,26 @@ import 'webview_controller.dart';
 /// ```
 class NavigationDelegate {
   /// Constructs a [NavigationDelegate].
+  ///
+  /// {@template webview_fluttter.navigation_delegate}
+  /// `onUrlChange`: invoked when the underlying web view changes to a new url.
+  /// {@endtemplate}
   NavigationDelegate({
     FutureOr<NavigationDecision> Function(NavigationRequest request)?
         onNavigationRequest,
     void Function(String url)? onPageStarted,
     void Function(String url)? onPageFinished,
     void Function(int progress)? onProgress,
     void Function(WebResourceError error)? onWebResourceError,
+    void Function(UrlChange change)? onUrlChange,
   }) : this.fromPlatformCreationParams(
           const PlatformNavigationDelegateCreationParams(),
           onNavigationRequest: onNavigationRequest,
           onPageStarted: onPageStarted,
           onPageFinished: onPageFinished,
           onProgress: onProgress,
           onWebResourceError: onWebResourceError,
+          onUrlChange: onUrlChange,
         );
 
   /// Constructs a [NavigationDelegate] from creation params for a specific
@@ -81,6 +87,8 @@ class NavigationDelegate {
   /// );
   /// ```
   /// {@endtemplate}
+  ///
+  /// {@macro webview_fluttter.navigation_delegate}
   NavigationDelegate.fromPlatformCreationParams(
     PlatformNavigationDelegateCreationParams params, {
     FutureOr<NavigationDecision> Function(NavigationRequest request)?
@@ -89,23 +97,28 @@ class NavigationDelegate {
     void Function(String url)? onPageFinished,
     void Function(int progress)? onProgress,
     void Function(WebResourceError error)? onWebResourceError,
+    void Function(UrlChange change)? onUrlChange,
   }) : this.fromPlatform(
           PlatformNavigationDelegate(params),
           onNavigationRequest: onNavigationRequest,
           onPageStarted: onPageStarted,
           onPageFinished: onPageFinished,
           onProgress: onProgress,
           onWebResourceError: onWebResourceError,
+          onUrlChange: onUrlChange,
         );
 
   /// Constructs a [NavigationDelegate] from a specific platform implementation.
+  ///
+  /// {@macro webview_fluttter.navigation_delegate}
   NavigationDelegate.fromPlatform(
     this.platform, {
     this.onNavigationRequest,
     this.onPageStarted,
     this.onPageFinished,
     this.onProgress,
     this.onWebResourceError,
+    void Function(UrlChange change)? onUrlChange,
   }) {
     if (onNavigationRequest != null) {
       platform.setOnNavigationRequest(onNavigationRequest!);
@@ -122,6 +135,9 @@ class NavigationDelegate {
     if (onWebResourceError != null) {
       platform.setOnWebResourceError(onWebResourceError!);
     }
+    if (onUrlChange != null) {
+      platform.setOnUrlChange(onUrlChange);
+    }
   }
 
   /// Implementation of [PlatformNavigationDelegate] for the current platform.

packages/webview_flutter/webview_flutter/lib/webview_flutter.dart

@@ -18,6 +18,7 @@ export 'package:webview_flutter_platform_interface/webview_flutter_platform_inte
         PlatformWebViewCookieManagerCreationParams,
         PlatformWebViewWidgetCreationParams,
         ProgressCallback,
+        UrlChange,
         WebResourceError,
         WebResourceErrorCallback,
         WebResourceErrorType,

packages/webview_flutter/webview_flutter/pubspec.yaml

@@ -2,7 +2,7 @@ name: webview_flutter
 description: A Flutter plugin that provides a WebView widget on Android and iOS.
 repository: https://github.com/flutter/packages/tree/main/packages/webview_flutter/webview_flutter
 issue_tracker: https://github.com/flutter/flutter/issues?q=is%3Aissue+is%3Aopen+label%3A%22p%3A+webview%22
-version: 4.0.5
+version: 4.1.0
 
 environment:
   sdk: ">=2.17.0 <3.0.0"
@@ -31,3 +31,12 @@ dev_dependencies:
     sdk: flutter
   mockito: ^5.3.2
   plugin_platform_interface: ^2.1.3
+
+# FOR TESTING ONLY. DO NOT MERGE.
+dependency_overrides:
+  webview_flutter_android:
+    path: ../../webview_flutter/webview_flutter_android
+  webview_flutter_platform_interface:
+    path: ../../webview_flutter/webview_flutter_platform_interface
+  webview_flutter_wkwebview:
+    path: ../../webview_flutter/webview_flutter_wkwebview

packages/webview_flutter/webview_flutter/test/navigation_delegate_test.dart

@@ -75,6 +75,18 @@ void main() {
 
       verify(delegate.platform.setOnWebResourceError(onWebResourceError));
     });
+
+    test('onUrlChange', () async {
+      WebViewPlatform.instance = TestWebViewPlatform();
+
+      void onUrlChange(UrlChange change) {}
+
+      final NavigationDelegate delegate = NavigationDelegate(
+        onUrlChange: onUrlChange,
+      );
+
+      verify(delegate.platform.setOnUrlChange(onUrlChange));
+    });
   });
 }
 

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

@@ -228,4 +228,14 @@ class MockPlatformNavigationDelegate extends _i1.Mock
         returnValue: _i8.Future<void>.value(),
         returnValueForMissingStub: _i8.Future<void>.value(),
       ) as _i8.Future<void>);
+  @override
+  _i8.Future<void> setOnUrlChange(_i3.UrlChangeCallback? onUrlChange) =>
+      (super.noSuchMethod(
+        Invocation.method(
+          #setOnUrlChange,
+          [onUrlChange],
+        ),
+        returnValue: _i8.Future<void>.value(),
+        returnValueForMissingStub: _i8.Future<void>.value(),
+      ) as _i8.Future<void>);
 }

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

@@ -414,4 +414,14 @@ class MockPlatformNavigationDelegate extends _i1.Mock
         returnValue: _i5.Future<void>.value(),
         returnValueForMissingStub: _i5.Future<void>.value(),
       ) as _i5.Future<void>);
+  @override
+  _i5.Future<void> setOnUrlChange(_i6.UrlChangeCallback? onUrlChange) =>
+      (super.noSuchMethod(
+        Invocation.method(
+          #setOnUrlChange,
+          [onUrlChange],
+        ),
+        returnValue: _i5.Future<void>.value(),
+        returnValueForMissingStub: _i5.Future<void>.value(),
+      ) as _i5.Future<void>);
 }

packages/webview_flutter/webview_flutter/test/webview_flutter_test.dart

@@ -41,6 +41,8 @@ void main() {
       main_file.WebViewCookie;
       // ignore: unnecessary_statements
       main_file.WebResourceErrorType;
+      // ignore: unnecessary_statements
+      main_file.UrlChange;
     });
   });
 }

packages/webview_flutter/webview_flutter_android/CHANGELOG.md

@@ -1,3 +1,7 @@
+## 3.4.0
+
+* Adds support for `PlatformNavigationDelegate.onUrlChange`.
+
 ## 3.3.1
 
 * Updates links for the merge of flutter/plugins into flutter/packages.

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

@@ -2352,6 +2352,25 @@ public void urlLoading(
             callback.reply(null);
           });
     }
+
+    public void doUpdateVisitedHistory(
+        @NonNull Long instanceIdArg,
+        @NonNull Long webViewInstanceIdArg,
+        @NonNull String urlArg,
+        @NonNull Boolean isReloadArg,
+        Reply<Void> callback) {
+      BasicMessageChannel<Object> channel =
+          new BasicMessageChannel<>(
+              binaryMessenger,
+              "dev.flutter.pigeon.WebViewClientFlutterApi.doUpdateVisitedHistory",
+              getCodec());
+      channel.send(
+          new ArrayList<Object>(
+              Arrays.asList(instanceIdArg, webViewInstanceIdArg, urlArg, isReloadArg)),
+          channelReply -> {
+            callback.reply(null);
+          });
+    }
   }
   /** Generated interface from Pigeon that represents a handler of messages from Flutter. */
   public interface DownloadListenerHostApi {

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

@@ -78,6 +78,11 @@ public boolean shouldOverrideUrlLoading(WebView view, String url) {
       return returnValueForShouldOverrideUrlLoading;
     }
 
+    @Override
+    public void doUpdateVisitedHistory(WebView view, String url, boolean isReload) {
+      flutterApi.doUpdateVisitedHistory(this, view, url, isReload, reply -> {});
+    }
+
     @Override
     public void onUnhandledKeyEvent(WebView view, KeyEvent event) {
       // Deliberately empty. Occasionally the webview will mark events as having failed to be
@@ -146,6 +151,11 @@ public boolean shouldOverrideUrlLoading(WebView view, String url) {
       return returnValueForShouldOverrideUrlLoading;
     }
 
+    @Override
+    public void doUpdateVisitedHistory(WebView view, String url, boolean isReload) {
+      flutterApi.doUpdateVisitedHistory(this, view, url, isReload, reply -> {});
+    }
+
     @Override
     public void onUnhandledKeyEvent(WebView view, KeyEvent event) {
       // Deliberately empty. Occasionally the webview will mark events as having failed to be

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

@@ -125,4 +125,12 @@ public WebViewClient createWebViewClient(WebViewClientFlutterApiImpl flutterApi)
 
     verify(mockWebViewClient).setReturnValueForShouldOverrideUrlLoading(false);
   }
+
+  @Test
+  public void doUpdateVisitedHistory() {
+    webViewClient.doUpdateVisitedHistory(mockWebView, "https://www.google.com", true);
+    verify(mockFlutterApi)
+        .doUpdateVisitedHistory(
+            eq(webViewClient), eq(mockWebView), eq("https://www.google.com"), eq(true), any());
+  }
 }

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

@@ -936,6 +936,42 @@ Future<void> main() async {
       final String? currentUrl = await controller.currentUrl();
       expect(currentUrl, secondaryUrl);
     });
+
+    testWidgets('can receive url changes', (WidgetTester tester) async {
+      final Completer<void> pageLoaded = Completer<void>();
+
+      final PlatformNavigationDelegate navigationDelegate =
+          PlatformNavigationDelegate(
+        const PlatformNavigationDelegateCreationParams(),
+      )..setOnPageFinished((_) => pageLoaded.complete());
+
+      final PlatformWebViewController controller = PlatformWebViewController(
+        const PlatformWebViewControllerCreationParams(),
+      )
+        ..setJavaScriptMode(JavaScriptMode.unrestricted)
+        ..setPlatformNavigationDelegate(navigationDelegate)
+        ..loadRequest(LoadRequestParams(uri: Uri.parse(blankPageEncoded)));
+
+      await tester.pumpWidget(Builder(
+        builder: (BuildContext context) {
+          return PlatformWebViewWidget(
+            PlatformWebViewWidgetCreationParams(controller: controller),
+          ).build(context);
+        },
+      ));
+
+      await pageLoaded.future;
+      await navigationDelegate.setOnPageFinished((_) {});
+
+      final Completer<String> urlChangeCompleter = Completer<String>();
+      await navigationDelegate.setOnUrlChange((UrlChange change) {
+        urlChangeCompleter.complete(change.url);
+      });
+
+      await controller.runJavaScript('location.href = "$primaryUrl"');
+
+      await expectLater(urlChangeCompleter.future, completion(primaryUrl));
+    });
   });
 
   testWidgets('target _blank opens in same window',

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

@@ -123,6 +123,9 @@ Page resource error:
             }
             debugPrint('allowing navigation to ${request.url}');
             return NavigationDecision.navigate;
+          })
+          ..setOnUrlChange((UrlChange change) {
+            debugPrint('url change to ${change.url}');
           }),
       )
       ..addJavaScriptChannel(JavaScriptChannelParams(

packages/webview_flutter/webview_flutter_android/example/pubspec.yaml

@@ -35,3 +35,11 @@ flutter:
     - assets/sample_video.mp4
     - assets/www/index.html
     - assets/www/styles/style.css
+
+
+# FOR TESTING ONLY. DO NOT MERGE.
+dependency_overrides:
+  webview_flutter_android:
+    path: ../../../webview_flutter/webview_flutter_android
+  webview_flutter_platform_interface:
+    path: ../../../webview_flutter/webview_flutter_platform_interface

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

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