OnPageError V4

Signed-off-by: Hugo Olthof <[email protected]>

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');
           },
+          onPageError: (int statusCode) {
+            debugPrint('Error occured on page: $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) {},
+          onPageError: (int statusCode) {},
           onWebResourceError: (WebResourceError error) {},
           onNavigationRequest: (NavigationRequest request) {
             if (request.url.startsWith('https://www.youtube.com/')) {

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> setOnPageError(PageErrorCallback onPageStarted) async {}
+
   @override
   Future<void> setOnProgress(ProgressCallback onProgress) async {}
 

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

@@ -41,13 +41,15 @@ class NavigationDelegate {
         onNavigationRequest,
     void Function(String url)? onPageStarted,
     void Function(String url)? onPageFinished,
+    void Function(int statusCode)? onPageError,
     void Function(int progress)? onProgress,
     void Function(WebResourceError error)? onWebResourceError,
   }) : this.fromPlatformCreationParams(
           const PlatformNavigationDelegateCreationParams(),
           onNavigationRequest: onNavigationRequest,
           onPageStarted: onPageStarted,
           onPageFinished: onPageFinished,
+          onPageError: onPageError,
           onProgress: onProgress,
           onWebResourceError: onWebResourceError,
         );
@@ -87,13 +89,15 @@ class NavigationDelegate {
         onNavigationRequest,
     void Function(String url)? onPageStarted,
     void Function(String url)? onPageFinished,
+    void Function(int statusCode)? onPageError,
     void Function(int progress)? onProgress,
     void Function(WebResourceError error)? onWebResourceError,
   }) : this.fromPlatform(
           PlatformNavigationDelegate(params),
           onNavigationRequest: onNavigationRequest,
           onPageStarted: onPageStarted,
           onPageFinished: onPageFinished,
+          onPageError: onPageError,
           onProgress: onProgress,
           onWebResourceError: onWebResourceError,
         );
@@ -104,6 +108,7 @@ class NavigationDelegate {
     this.onNavigationRequest,
     this.onPageStarted,
     this.onPageFinished,
+    this.onPageError,
     this.onProgress,
     this.onWebResourceError,
   }) {
@@ -116,6 +121,9 @@ class NavigationDelegate {
     if (onPageFinished != null) {
       platform.setOnPageFinished(onPageFinished!);
     }
+    if (onPageError != null) {
+      platform.setOnPageError(onPageError!);
+    }
     if (onProgress != null) {
       platform.setOnProgress(onProgress!);
     }
@@ -145,6 +153,8 @@ class NavigationDelegate {
   /// Invoked when a page has finished loading.
   final PageEventCallback? onPageFinished;
 
+  final PageErrorCallback? onPageError;
+
   /// Invoked when a page is loading to report the progress.
   final ProgressCallback? onProgress;
 

packages/webview_flutter/webview_flutter/pubspec.yaml

@@ -19,9 +19,12 @@ flutter:
 dependencies:
   flutter:
     sdk: flutter
-  webview_flutter_android: ^3.0.0
-  webview_flutter_platform_interface: ^2.0.0
-  webview_flutter_wkwebview: ^3.0.0
+  webview_flutter_android:
+    path: ../webview_flutter_android
+  webview_flutter_platform_interface:
+    path: ../webview_flutter_platform_interface
+  webview_flutter_wkwebview:
+    path: ../webview_flutter_wkwebview
 
 dev_dependencies:
   build_runner: ^2.1.5

packages/webview_flutter/webview_flutter/test/navigation_delegate_test.dart

@@ -52,6 +52,18 @@ void main() {
       verify(delegate.platform.setOnPageFinished(onPageFinished));
     });
 
+    test('onPageError', () async {
+      WebViewPlatform.instance = TestWebViewPlatform();
+
+      void onPageError(int statusCode) {}
+
+      final NavigationDelegate delegate = NavigationDelegate(
+        onPageError: onPageError,
+      );
+
+      verify(delegate.platform.setOnPageError(onPageError));
+    });
+
     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> setOnPageError(_i3.PageErrorCallback? onPageError) =>
+      (super.noSuchMethod(
+        Invocation.method(
+          #setOnPageError,
+          [onPageError],
+        ),
+        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> setOnPageError(_i6.PageErrorCallback? onPageError) =>
+      (super.noSuchMethod(
+        Invocation.method(
+          #setOnPageError,
+          [onPageError],
+        ),
+        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/android/gradle/wrapper/gradle-wrapper.properties

@@ -0,0 +1,5 @@
+distributionBase=GRADLE_USER_HOME
+distributionPath=wrapper/dists
+distributionUrl=https\://services.gradle.org/distributions/gradle-7.4-bin.zip
+zipStoreBase=GRADLE_USER_HOME
+zipStorePath=wrapper/dists

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

@@ -99,6 +99,16 @@ public void onPageFinished(
     onPageFinished(getIdentifierForClient(webViewClient), webViewIdentifier, urlArg, callback);
   }
 
+  /** Passes arguments from {@link WebViewClient#onReceivedHttpError} to Dart. */
+  public void onPageError(
+          WebViewClient webViewClient, WebView webView, int statusCodeArg, Reply<Void> callback) {
+    final Long webViewIdentifier = instanceManager.getIdentifierForStrongReference(webView);
+    if (webViewIdentifier == null) {
+      throw new IllegalStateException("Could not find identifier for WebView.");
+    }
+    onPageError(getIdentifierForClient(webViewClient), webViewIdentifier, statusCodeArg, callback);
+  }
+
   /**
    * Passes arguments from {@link WebViewClient#onReceivedError(WebView, WebResourceRequest,
    * WebResourceError)} to Dart.

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

@@ -11,6 +11,7 @@
 import android.view.KeyEvent;
 import android.webkit.WebResourceError;
 import android.webkit.WebResourceRequest;
+import android.webkit.WebResourceResponse;
 import android.webkit.WebView;
 import android.webkit.WebViewClient;
 import androidx.annotation.NonNull;
@@ -54,6 +55,11 @@ public void onPageFinished(WebView view, String url) {
       flutterApi.onPageFinished(this, view, url, reply -> {});
     }
 
+    @Override
+    public void onReceivedHttpError(WebView view, WebResourceRequest request, WebResourceResponse errorResponse) {
+      flutterApi.onPageError(this, view, errorResponse.getStatusCode(), reply -> {});
+    }
+
     @Override
     public void onReceivedError(WebView view, WebResourceRequest request, WebResourceError error) {
       flutterApi.onReceivedRequestError(this, view, request, error, reply -> {});
@@ -117,6 +123,13 @@ public void onPageFinished(WebView view, String url) {
       flutterApi.onPageFinished(this, view, url, reply -> {});
     }
 
+    @Override
+    public void onReceivedHttpError(WebView view, WebResourceRequest request, WebResourceResponse errorResponse) {
+      if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.LOLLIPOP) {
+        flutterApi.onPageError(this, view, errorResponse.getStatusCode(), reply -> {});
+      }
+    }
+
     // This method is only called when the WebViewFeature.RECEIVE_WEB_RESOURCE_ERROR feature is
     // enabled. The deprecated method is called when a device doesn't support this.
     @RequiresApi(api = Build.VERSION_CODES.LOLLIPOP)

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

@@ -107,6 +107,9 @@ class _WebViewExampleState extends State<WebViewExample> {
           ..setOnPageFinished((String url) {
             debugPrint('Page finished loading: $url');
           })
+          ..setOnPageError((int statusCode) {
+            debugPrint('Error occured on page: $statusCode');
+          })
           ..setOnWebResourceError((WebResourceError error) {
             debugPrint('''
 Page resource error:

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

@@ -41,6 +41,7 @@ class AndroidWebViewProxy {
   final android_webview.WebViewClient Function({
     void Function(android_webview.WebView webView, String url)? onPageStarted,
     void Function(android_webview.WebView webView, String url)? onPageFinished,
+    void Function(android_webview.WebView webView, int statusCode)? onPageError,
     void Function(
       android_webview.WebView webView,
       android_webview.WebResourceRequest request,

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

@@ -673,6 +673,7 @@ class WebViewClient extends JavaObject {
   WebViewClient({
     this.onPageStarted,
     this.onPageFinished,
+    this.onPageError,
     this.onReceivedRequestError,
     @Deprecated('Only called on Android version < 23.') this.onReceivedError,
     this.requestLoading,
@@ -692,6 +693,7 @@ class WebViewClient extends JavaObject {
   WebViewClient.detached({
     this.onPageStarted,
     this.onPageFinished,
+    this.onPageError,
     this.onReceivedRequestError,
     @Deprecated('Only called on Android version < 23.') this.onReceivedError,
     this.requestLoading,
@@ -802,6 +804,12 @@ class WebViewClient extends JavaObject {
   /// reflect the state of the DOM at this point.
   final void Function(WebView webView, String url)? onPageFinished;
 
+  /// Notify the host application that an HTTP error has been received from the
+  /// server while loading a resource. HTTP errors have status codes >= 400.
+  /// This callback will be called for any resource (iframe, image, etc.), not just for the main page.
+  /// Thus, it is recommended to perform minimum required work in this callback.
+  final void Function(WebView webView, int statusCode)? onPageError;
+
   /// Report web resource loading error to the host application.
   ///
   /// These errors usually indicate inability to connect to the server. Note
@@ -863,6 +871,7 @@ class WebViewClient extends JavaObject {
     return WebViewClient.detached(
       onPageStarted: onPageStarted,
       onPageFinished: onPageFinished,
+      onPageError: onPageError,
       onReceivedRequestError: onReceivedRequestError,
       onReceivedError: onReceivedError,
       requestLoading: requestLoading,

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

@@ -647,6 +647,25 @@ class WebViewClientFlutterApiImpl extends WebViewClientFlutterApi {
     }
   }
 
+  @override
+  void onPageError(int instanceId, int webViewInstanceId, int statusCode) {
+    final WebViewClient? instance = instanceManager
+        .getInstanceWithWeakReference(instanceId) as WebViewClient?;
+    final WebView? webViewInstance = instanceManager
+        .getInstanceWithWeakReference(webViewInstanceId) as WebView?;
+    assert(
+      instance != null,
+      'InstanceManager does not contain an WebViewClient with instanceId: $instanceId',
+    );
+    assert(
+      webViewInstance != null,
+      'InstanceManager does not contain an WebView with instanceId: $webViewInstanceId',
+    );
+    if (instance!.onPageError != null) {
+      instance.onPageError!(webViewInstance!, statusCode);
+    }
+  }
+
   @override
   void onReceivedError(
     int instanceId,

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

@@ -729,6 +729,11 @@ class AndroidNavigationDelegate extends PlatformNavigationDelegate {
           weakThis.target!._onPageStarted!(url);
         }
       },
+      onPageError: (android_webview.WebView webView, int statusCode) {
+        if (weakThis.target?._onPageError != null) {
+          weakThis.target!._onPageError!(statusCode);
+        }
+      },
       onReceivedRequestError: (
         android_webview.WebView webView,
         android_webview.WebResourceRequest request,
@@ -829,6 +834,7 @@ class AndroidNavigationDelegate extends PlatformNavigationDelegate {
 
   PageEventCallback? _onPageFinished;
   PageEventCallback? _onPageStarted;
+  PageErrorCallback? _onPageError;
   ProgressCallback? _onProgress;
   WebResourceErrorCallback? _onWebResourceError;
   NavigationRequestCallback? _onNavigationRequest;
@@ -900,6 +906,13 @@ class AndroidNavigationDelegate extends PlatformNavigationDelegate {
     _onPageFinished = onPageFinished;
   }
 
+  @override
+  Future<void> setOnPageError(
+    PageErrorCallback onPageError,
+  ) async {
+    _onPageError = onPageError;
+  }
+
   @override
   Future<void> setOnProgress(
     ProgressCallback onProgress,

packages/webview_flutter/webview_flutter_android/pigeons/android_webview.dart

@@ -270,6 +270,8 @@ abstract class WebViewClientFlutterApi {
 
   void onPageFinished(int instanceId, int webViewInstanceId, String url);
 
+  void onPageError(int instanceId, int webViewInstanceId, int statusCode);
+
   void onReceivedRequestError(
     int instanceId,
     int webViewInstanceId,

packages/webview_flutter/webview_flutter_android/pubspec.yaml

@@ -20,7 +20,8 @@ flutter:
 dependencies:
   flutter:
     sdk: flutter
-  webview_flutter_platform_interface: ^2.0.0
+  webview_flutter_platform_interface:
+    path: ../webview_flutter_platform_interface
 
 dev_dependencies:
   build_runner: ^2.1.4

packages/webview_flutter/webview_flutter_android/test/android_navigation_delegate_test.dart

@@ -55,6 +55,22 @@ void main() {
       expect(callbackUrl, 'https://www.google.com');
     });
 
+    test('onPageError', () {
+      final AndroidNavigationDelegate androidNavigationDelegate =
+          AndroidNavigationDelegate(_buildCreationParams());
+
+      late final int statusCode;
+      androidNavigationDelegate
+          .setOnPageError((int code) => statusCode = code);
+
+      CapturingWebViewClient.lastCreatedDelegate.onPageError!(
+        android_webview.WebView.detached(),
+        401,
+      );
+
+      expect(statusCode, 401);
+    });
+
     test('onWebResourceError from onReceivedRequestError', () {
       final AndroidNavigationDelegate androidNavigationDelegate =
           AndroidNavigationDelegate(_buildCreationParams());
@@ -467,6 +483,7 @@ class CapturingWebViewClient extends android_webview.WebViewClient {
   CapturingWebViewClient({
     super.onPageFinished,
     super.onPageStarted,
+    super.onPageError,
     super.onReceivedError,
     super.onReceivedRequestError,
     super.requestLoading,

packages/webview_flutter/webview_flutter_android/test/android_webview_controller_test.dart

@@ -87,6 +87,8 @@ void main() {
                     onPageFinished,
                 void Function(android_webview.WebView webView, String url)?
                     onPageStarted,
+                void Function(android_webview.WebView webView, int statusCode)?
+                    onPageError,
                 @Deprecated('Only called on Android version < 23.')
                     void Function(
                   android_webview.WebView webView,