[webview_flutter] Adds onHttpError callback to NavigationDelegate to catch HTTP error status codes

packages/webview_flutter/webview_flutter/CHANGELOG.md

@@ -2,6 +2,7 @@
 
 * Updates minimum Flutter version to 3.3.
 * Fixes common typos in tests and documentation.
+* Adds onHttpError callback to NavigationDelegate to catch HTTP error status codes.
 
 ## 4.0.7
 

packages/webview_flutter/webview_flutter/README.md

@@ -32,6 +32,7 @@ controller = WebViewController()
       },
       onPageStarted: (String url) {},
       onPageFinished: (String url) {},
+      onHttpError: (HttpResponseError error) {},
       onWebResourceError: (WebResourceError error) {},
       onNavigationRequest: (NavigationRequest request) {
         if (request.url.startsWith('https://www.youtube.com/')) {

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

@@ -646,6 +646,52 @@ Future<void> main() async {
       await pageFinishCompleter.future;
     });
 
+    testWidgets('onHttpError', (WidgetTester tester) async {
+      final Completer<HttpResponseError> errorCompleter =
+          Completer<HttpResponseError>();
+
+      final WebViewController controller = WebViewController()
+        ..setJavaScriptMode(JavaScriptMode.unrestricted)
+        ..setNavigationDelegate(
+            NavigationDelegate(onHttpError: (HttpResponseError error) {
+          errorCompleter.complete(error);
+        }))
+        ..loadRequest(
+          Uri.parse('$prefixUrl/favicon.ico'),
+        );
+
+      await tester.pumpWidget(WebViewWidget(controller: controller));
+
+      final HttpResponseError error = await errorCompleter.future;
+
+      expect(error, isNotNull);
+      expect(error.statusCode, 404);
+    });
+
+    testWidgets('onHttpError is not called when no HTTP error is received',
+        (WidgetTester tester) async {
+      final Completer<HttpResponseError> errorCompleter =
+          Completer<HttpResponseError>();
+      final Completer<void> pageFinishCompleter = Completer<void>();
+
+      final WebViewController controller = WebViewController()
+        ..setJavaScriptMode(JavaScriptMode.unrestricted)
+        ..setNavigationDelegate(NavigationDelegate(
+          onPageFinished: (_) => pageFinishCompleter.complete(),
+          onHttpError: (HttpResponseError error) {
+            errorCompleter.complete(error);
+          },
+        ))
+        ..loadRequest(
+          Uri.parse('https://www.google.com'),
+        );
+
+      await tester.pumpWidget(WebViewWidget(controller: controller));
+
+      expect(errorCompleter.future, doesNotComplete);
+      await pageFinishCompleter.future;
+    });
+
     testWidgets('can block requests', (WidgetTester tester) async {
       Completer<void> pageLoaded = Completer<void>();
 

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

@@ -119,6 +119,9 @@ class _WebViewExampleState extends State<WebViewExample> {
           onPageFinished: (String url) {
             debugPrint('Page finished loading: $url');
           },
+          onHttpError: (HttpResponseError error) {
+            debugPrint('Error occured on page: ${error.statusCode}');
+          },
           onWebResourceError: (WebResourceError error) {
             debugPrint('''
 Page resource error:

packages/webview_flutter/webview_flutter/example/lib/simple_example.dart

@@ -34,6 +34,7 @@ class _WebViewExampleState extends State<WebViewExample> {
           },
           onPageStarted: (String url) {},
           onPageFinished: (String url) {},
+          onHttpError: (HttpResponseError error) {},
           onWebResourceError: (WebResourceError error) {},
           onNavigationRequest: (NavigationRequest request) {
             if (request.url.startsWith('https://www.youtube.com/')) {

packages/webview_flutter/webview_flutter/example/pubspec.yaml

@@ -29,7 +29,7 @@ dev_dependencies:
     sdk: flutter
   integration_test:
     sdk: flutter
-  webview_flutter_platform_interface: ^2.0.0
+  webview_flutter_platform_interface: ^2.2.0
 
 flutter:
   uses-material-design: true
@@ -38,3 +38,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_wkwebview:
+    path: ../../../webview_flutter/webview_flutter_wkwebview

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

@@ -106,6 +106,9 @@ class FakeNavigationDelegate extends PlatformNavigationDelegate {
   @override
   Future<void> setOnPageStarted(PageEventCallback onPageStarted) async {}
 
+  @override
+  Future<void> setOnHttpError(HttpResponseErrorCallback onHttpError) async {}
+
   @override
   Future<void> setOnProgress(ProgressCallback onProgress) async {}
 

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

@@ -42,12 +42,14 @@ class NavigationDelegate {
     void Function(String url)? onPageStarted,
     void Function(String url)? onPageFinished,
     void Function(int progress)? onProgress,
+    void Function(HttpResponseError error)? onHttpError,
     void Function(WebResourceError error)? onWebResourceError,
   }) : this.fromPlatformCreationParams(
           const PlatformNavigationDelegateCreationParams(),
           onNavigationRequest: onNavigationRequest,
           onPageStarted: onPageStarted,
           onPageFinished: onPageFinished,
+          onHttpError: onHttpError,
           onProgress: onProgress,
           onWebResourceError: onWebResourceError,
         );
@@ -88,12 +90,14 @@ class NavigationDelegate {
     void Function(String url)? onPageStarted,
     void Function(String url)? onPageFinished,
     void Function(int progress)? onProgress,
+    void Function(HttpResponseError error)? onHttpError,
     void Function(WebResourceError error)? onWebResourceError,
   }) : this.fromPlatform(
           PlatformNavigationDelegate(params),
           onNavigationRequest: onNavigationRequest,
           onPageStarted: onPageStarted,
           onPageFinished: onPageFinished,
+          onHttpError: onHttpError,
           onProgress: onProgress,
           onWebResourceError: onWebResourceError,
         );
@@ -105,6 +109,7 @@ class NavigationDelegate {
     this.onPageStarted,
     this.onPageFinished,
     this.onProgress,
+    void Function(HttpResponseError error)? onHttpError,
     this.onWebResourceError,
   }) {
     if (onNavigationRequest != null) {
@@ -116,6 +121,9 @@ class NavigationDelegate {
     if (onPageFinished != null) {
       platform.setOnPageFinished(onPageFinished!);
     }
+    if (onHttpError != null) {
+      platform.setOnHttpError(onHttpError);
+    }
     if (onProgress != null) {
       platform.setOnProgress(onProgress!);
     }

packages/webview_flutter/webview_flutter/lib/webview_flutter.dart

@@ -6,6 +6,8 @@ library webview_flutter;
 
 export 'package:webview_flutter_platform_interface/webview_flutter_platform_interface.dart'
     show
+        HttpResponseError,
+        HttpResponseErrorCallback,
         JavaScriptMessage,
         JavaScriptMode,
         LoadRequestMethod,

packages/webview_flutter/webview_flutter/pubspec.yaml

@@ -20,7 +20,7 @@ dependencies:
   flutter:
     sdk: flutter
   webview_flutter_android: ^3.0.0
-  webview_flutter_platform_interface: ^2.0.0
+  webview_flutter_platform_interface: ^2.2.0
   webview_flutter_wkwebview: ^3.0.0
 
 dev_dependencies:
@@ -31,3 +31,11 @@ dev_dependencies:
     sdk: flutter
   mockito: 5.4.0
   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_wkwebview:
+    path: ../../webview_flutter/webview_flutter_wkwebview

packages/webview_flutter/webview_flutter/test/navigation_delegate_test.dart

@@ -52,6 +52,18 @@ void main() {
       verify(delegate.platform.setOnPageFinished(onPageFinished));
     });
 
+    test('onHttpError', () async {
+      WebViewPlatform.instance = TestWebViewPlatform();
+
+      void onHttpError(HttpResponseError error) {}
+
+      final NavigationDelegate delegate = NavigationDelegate(
+        onHttpError: onHttpError,
+      );
+
+      verify(delegate.platform.setOnHttpError(onHttpError));
+    });
+
     test('onProgress', () async {
       WebViewPlatform.instance = TestWebViewPlatform();
 

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

@@ -208,6 +208,16 @@ class MockPlatformNavigationDelegate extends _i1.Mock
         returnValueForMissingStub: _i8.Future<void>.value(),
       ) as _i8.Future<void>);
   @override
+  _i8.Future<void> setOnHttpError(_i3.HttpResponseErrorCallback? onHttpError) =>
+      (super.noSuchMethod(
+        Invocation.method(
+          #setOnHttpError,
+          [onHttpError],
+        ),
+        returnValue: _i8.Future<void>.value(),
+        returnValueForMissingStub: _i8.Future<void>.value(),
+      ) as _i8.Future<void>);
+  @override
   _i8.Future<void> setOnProgress(_i3.ProgressCallback? onProgress) =>
       (super.noSuchMethod(
         Invocation.method(

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

@@ -394,6 +394,16 @@ class MockPlatformNavigationDelegate extends _i1.Mock
         returnValueForMissingStub: _i5.Future<void>.value(),
       ) as _i5.Future<void>);
   @override
+  _i5.Future<void> setOnHttpError(_i6.HttpResponseErrorCallback? onHttpError) =>
+      (super.noSuchMethod(
+        Invocation.method(
+          #setOnHttpError,
+          [onHttpError],
+        ),
+        returnValue: _i5.Future<void>.value(),
+        returnValueForMissingStub: _i5.Future<void>.value(),
+      ) as _i5.Future<void>);
+  @override
   _i5.Future<void> setOnProgress(_i6.ProgressCallback? onProgress) =>
       (super.noSuchMethod(
         Invocation.method(

packages/webview_flutter/webview_flutter_android/CHANGELOG.md

@@ -11,6 +11,7 @@
 
 * Fixes a bug where the native `WebView` wouldn't be traversed for autofill automatically.
 * Updates minimum Flutter version to 3.3.
+* Adds onReceivedHttpError WebViewClient callback to support the onHttpError callback.
 
 ## 3.4.3