Skip to content

[webview_flutter_wkwebview] Change callback methods with a non-null return type to non-null #8564

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 13 commits into from
Feb 13, 2025
Merged

[webview_flutter_wkwebview] Change callback methods with a non-null return type to non-null #8564

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
13 commits
Select commit Hold shift + click to select a range
beb7539
fix maybe
bparrishMines Feb 4, 2025
cf27f9d
bump pigeon
bparrishMines Feb 4, 2025
0910d57
Merge branch 'main' of github.com:flutter/packages into wkwebview_imp…
bparrishMines Feb 10, 2025
9442ba7
update pigeon
bparrishMines Feb 10, 2025
5353741
add other method
bparrishMines Feb 11, 2025
f9e6b6d
Merge branch 'main' of github.com:flutter/packages into wkwebview_imp…
bparrishMines Feb 11, 2025
a072e89
add dart tests
bparrishMines Feb 11, 2025
fe2784a
changelog
bparrishMines Feb 11, 2025
cd912dc
fix unit tests
bparrishMines Feb 11, 2025
1654755
Merge branch 'main' of github.com:flutter/packages into wkwebview_imp…
bparrishMines Feb 13, 2025
dbe3fee
formatting
bparrishMines Feb 13, 2025
2ea1d4c
unavailable is not
bparrishMines Feb 13, 2025
d989135
comment and changelog
bparrishMines Feb 13, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions packages/webview_flutter/webview_flutter_wkwebview/CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
## 3.18.1

* Updates internal API wrapper to make all Flutter methods with a non-null return value be required
Copy link
Collaborator

@stuartmorgan-g stuartmorgan-g Feb 11, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would mention that this fixes a crash, since that's the client-visible effect of the change.

to implement.

## 3.18.0

* Updates internal API wrapper to use ProxyApis.
Expand Down
56 changes: 9 additions & 47 deletions .../darwin/webview_flutter_wkwebview/Sources/webview_flutter_wkwebview/WebKitLibrary.g.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
// 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.
// Autogenerated from Pigeon (v22.7.2), do not edit directly.
// Autogenerated from Pigeon (v24.0.0), do not edit directly.
// See also: https://pub.dev/packages/pigeon

import Foundation
Expand All @@ -23,9 +23,9 @@ import WebKit
final class PigeonError: Error {
let code: String
let message: String?
let details: Any?
let details: Sendable?

init(code: String, message: String?, details: Any?) {
init(code: String, message: String?, details: Sendable?) {
self.code = code
self.message = message
self.details = details
Expand Down Expand Up @@ -4025,28 +4025,9 @@ final class PigeonApiWKNavigationDelegate: PigeonApiProtocolWKNavigationDelegate
completion(.success(Void()))
return
}
let pigeonIdentifierArg = pigeonRegistrar.instanceManager.addHostCreatedInstance(
pigeonInstance as AnyObject)
let binaryMessenger = pigeonRegistrar.binaryMessenger
let codec = pigeonRegistrar.codec
let channelName: String =
"dev.flutter.pigeon.webview_flutter_wkwebview.WKNavigationDelegate.pigeon_newInstance"
let channel = FlutterBasicMessageChannel(
name: channelName, binaryMessenger: binaryMessenger, codec: codec)
channel.sendMessage([pigeonIdentifierArg] as [Any?]) { response in
guard let listResponse = response as? [Any?] else {
completion(.failure(createConnectionError(withChannelName: channelName)))
return
}
if listResponse.count > 1 {
let code: String = listResponse[0] as! String
let message: String? = nilOrValue(listResponse[1])
let details: String? = nilOrValue(listResponse[2])
completion(.failure(PigeonError(code: code, message: message, details: details)))
} else {
completion(.success(Void()))
}
}
print(
"Error: Attempting to create a new Dart instance of WKNavigationDelegate, but the class has a nonnull callback method."
)
}
/// Tells the delegate that navigation is complete.
func didFinishNavigation(
Expand Down Expand Up @@ -5978,28 +5959,9 @@ final class PigeonApiWKUIDelegate: PigeonApiProtocolWKUIDelegate {
completion(.success(Void()))
return
}
let pigeonIdentifierArg = pigeonRegistrar.instanceManager.addHostCreatedInstance(
pigeonInstance as AnyObject)
let binaryMessenger = pigeonRegistrar.binaryMessenger
let codec = pigeonRegistrar.codec
let channelName: String =
"dev.flutter.pigeon.webview_flutter_wkwebview.WKUIDelegate.pigeon_newInstance"
let channel = FlutterBasicMessageChannel(
name: channelName, binaryMessenger: binaryMessenger, codec: codec)
channel.sendMessage([pigeonIdentifierArg] as [Any?]) { response in
guard let listResponse = response as? [Any?] else {
completion(.failure(createConnectionError(withChannelName: channelName)))
return
}
if listResponse.count > 1 {
let code: String = listResponse[0] as! String
let message: String? = nilOrValue(listResponse[1])
let details: String? = nilOrValue(listResponse[2])
completion(.failure(PigeonError(code: code, message: message, details: details)))
} else {
completion(.success(Void()))
}
}
print(
Copy link
Collaborator

@stuartmorgan-g stuartmorgan-g Feb 5, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This codepath prints an error to the console but never calls completion, which seems like a bug. Doesn't the proxy API generator need to call completion(.failure(...)) in this path?

Copy link
Contributor Author

@bparrishMines bparrishMines Feb 5, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thats a really good catch. I'll add this fix to #8567. It looks like Kotlin needs this too.

"Error: Attempting to create a new Dart instance of WKUIDelegate, but the class has a nonnull callback method."
)
}
/// Creates a new web view.
func onCreateWebView(
Expand Down
130 changes: 26 additions & 104 deletions packages/webview_flutter/webview_flutter_wkwebview/lib/src/common/web_kit.g.dart
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
// 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.
// Autogenerated from Pigeon (v22.7.2), do not edit directly.
// Autogenerated from Pigeon (v24.0.0), do not edit directly.
// See also: https://pub.dev/packages/pigeon
// ignore_for_file: public_member_api_docs, non_constant_identifier_names, avoid_as, unused_import, unnecessary_parenthesis, prefer_null_aware_operators, omit_local_variable_types, unused_shown_name, unnecessary_import, no_leading_underscores_for_local_identifiers

Expand Down Expand Up @@ -3963,12 +3963,12 @@ class WKNavigationDelegate extends NSObject {
super.observeValue,
this.didFinishNavigation,
this.didStartProvisionalNavigation,
this.decidePolicyForNavigationAction,
this.decidePolicyForNavigationResponse,
required this.decidePolicyForNavigationAction,
required this.decidePolicyForNavigationResponse,
this.didFailNavigation,
this.didFailProvisionalNavigation,
this.webViewWebContentProcessDidTerminate,
this.didReceiveAuthenticationChallenge,
required this.didReceiveAuthenticationChallenge,
}) : super.pigeon_detached() {
final int pigeonVar_instanceIdentifier =
pigeon_instanceManager.addDartCreatedInstance(this);
Expand Down Expand Up @@ -4011,12 +4011,12 @@ class WKNavigationDelegate extends NSObject {
super.observeValue,
this.didFinishNavigation,
this.didStartProvisionalNavigation,
this.decidePolicyForNavigationAction,
this.decidePolicyForNavigationResponse,
required this.decidePolicyForNavigationAction,
required this.decidePolicyForNavigationResponse,
this.didFailNavigation,
this.didFailProvisionalNavigation,
this.webViewWebContentProcessDidTerminate,
this.didReceiveAuthenticationChallenge,
required this.didReceiveAuthenticationChallenge,
}) : super.pigeon_detached();

late final _PigeonInternalProxyApiBaseCodec
Expand Down Expand Up @@ -4097,7 +4097,7 @@ class WKNavigationDelegate extends NSObject {
WKNavigationDelegate pigeon_instance,
WKWebView webView,
WKNavigationAction navigationAction,
)? decidePolicyForNavigationAction;
) decidePolicyForNavigationAction;

/// Asks the delegate for permission to navigate to new content after the
/// response to the navigation request is known.
Expand All @@ -4123,7 +4123,7 @@ class WKNavigationDelegate extends NSObject {
WKNavigationDelegate pigeon_instance,
WKWebView webView,
WKNavigationResponse navigationResponse,
)? decidePolicyForNavigationResponse;
) decidePolicyForNavigationResponse;

/// Tells the delegate that an error occurred during navigation.
///
Expand Down Expand Up @@ -4223,13 +4223,12 @@ class WKNavigationDelegate extends NSObject {
WKNavigationDelegate pigeon_instance,
WKWebView webView,
URLAuthenticationChallenge challenge,
)? didReceiveAuthenticationChallenge;
) didReceiveAuthenticationChallenge;

static void pigeon_setUpMessageHandlers({
bool pigeon_clearHandlers = false,
BinaryMessenger? pigeon_binaryMessenger,
PigeonInstanceManager? pigeon_instanceManager,
WKNavigationDelegate Function()? pigeon_newInstance,
void Function(
WKNavigationDelegate pigeon_instance,
WKWebView webView,
Expand Down Expand Up @@ -4274,44 +4273,6 @@ class WKNavigationDelegate extends NSObject {
_PigeonInternalProxyApiBaseCodec(
pigeon_instanceManager ?? PigeonInstanceManager.instance);
final BinaryMessenger? binaryMessenger = pigeon_binaryMessenger;
{
final BasicMessageChannel<
Object?> pigeonVar_channel = BasicMessageChannel<
Object?>(
'dev.flutter.pigeon.webview_flutter_wkwebview.WKNavigationDelegate.pigeon_newInstance',
pigeonChannelCodec,
binaryMessenger: binaryMessenger);
if (pigeon_clearHandlers) {
pigeonVar_channel.setMessageHandler(null);
} else {
pigeonVar_channel.setMessageHandler((Object? message) async {
assert(message != null,
'Argument for dev.flutter.pigeon.webview_flutter_wkwebview.WKNavigationDelegate.pigeon_newInstance was null.');
final List<Object?> args = (message as List<Object?>?)!;
final int? arg_pigeon_instanceIdentifier = (args[0] as int?);
assert(arg_pigeon_instanceIdentifier != null,
'Argument for dev.flutter.pigeon.webview_flutter_wkwebview.WKNavigationDelegate.pigeon_newInstance was null, expected non-null int.');
try {
(pigeon_instanceManager ?? PigeonInstanceManager.instance)
.addHostCreatedInstance(
pigeon_newInstance?.call() ??
WKNavigationDelegate.pigeon_detached(
pigeon_binaryMessenger: pigeon_binaryMessenger,
pigeon_instanceManager: pigeon_instanceManager,
),
arg_pigeon_instanceIdentifier!,
);
return wrapResponse(empty: true);
} on PlatformException catch (e) {
return wrapResponse(error: e);
} catch (e) {
return wrapResponse(
error: PlatformException(code: 'error', message: e.toString()));
}
});
}
}

{
final BasicMessageChannel<
Object?> pigeonVar_channel = BasicMessageChannel<
Expand Down Expand Up @@ -4411,10 +4372,10 @@ class WKNavigationDelegate extends NSObject {
assert(arg_navigationAction != null,
'Argument for dev.flutter.pigeon.webview_flutter_wkwebview.WKNavigationDelegate.decidePolicyForNavigationAction was null, expected non-null WKNavigationAction.');
try {
final NavigationActionPolicy? output =
final NavigationActionPolicy output =
await (decidePolicyForNavigationAction ??
arg_pigeon_instance!.decidePolicyForNavigationAction)
?.call(arg_pigeon_instance!, arg_webView!,
.call(arg_pigeon_instance!, arg_webView!,
arg_navigationAction!);
return wrapResponse(result: output);
} on PlatformException catch (e) {
Expand Down Expand Up @@ -4453,10 +4414,10 @@ class WKNavigationDelegate extends NSObject {
assert(arg_navigationResponse != null,
'Argument for dev.flutter.pigeon.webview_flutter_wkwebview.WKNavigationDelegate.decidePolicyForNavigationResponse was null, expected non-null WKNavigationResponse.');
try {
final NavigationResponsePolicy? output =
final NavigationResponsePolicy output =
await (decidePolicyForNavigationResponse ??
arg_pigeon_instance!.decidePolicyForNavigationResponse)
?.call(arg_pigeon_instance!, arg_webView!,
.call(arg_pigeon_instance!, arg_webView!,
arg_navigationResponse!);
return wrapResponse(result: output);
} on PlatformException catch (e) {
Expand Down Expand Up @@ -4608,10 +4569,10 @@ class WKNavigationDelegate extends NSObject {
assert(arg_challenge != null,
'Argument for dev.flutter.pigeon.webview_flutter_wkwebview.WKNavigationDelegate.didReceiveAuthenticationChallenge was null, expected non-null URLAuthenticationChallenge.');
try {
final AuthenticationChallengeResponse? output =
final AuthenticationChallengeResponse output =
await (didReceiveAuthenticationChallenge ??
arg_pigeon_instance!.didReceiveAuthenticationChallenge)
?.call(arg_pigeon_instance!, arg_webView!, arg_challenge!);
.call(arg_pigeon_instance!, arg_webView!, arg_challenge!);
return wrapResponse(result: output);
} on PlatformException catch (e) {
return wrapResponse(error: e);
Expand Down Expand Up @@ -6447,9 +6408,9 @@ class WKUIDelegate extends NSObject {
super.pigeon_instanceManager,
super.observeValue,
this.onCreateWebView,
this.requestMediaCapturePermission,
required this.requestMediaCapturePermission,
this.runJavaScriptAlertPanel,
this.runJavaScriptConfirmPanel,
required this.runJavaScriptConfirmPanel,
this.runJavaScriptTextInputPanel,
}) : super.pigeon_detached() {
final int pigeonVar_instanceIdentifier =
Expand Down Expand Up @@ -6492,9 +6453,9 @@ class WKUIDelegate extends NSObject {
super.pigeon_instanceManager,
super.observeValue,
this.onCreateWebView,
this.requestMediaCapturePermission,
required this.requestMediaCapturePermission,
this.runJavaScriptAlertPanel,
this.runJavaScriptConfirmPanel,
required this.runJavaScriptConfirmPanel,
this.runJavaScriptTextInputPanel,
}) : super.pigeon_detached();

Expand Down Expand Up @@ -6553,7 +6514,7 @@ class WKUIDelegate extends NSObject {
WKSecurityOrigin origin,
WKFrameInfo frame,
MediaCaptureType type,
)? requestMediaCapturePermission;
) requestMediaCapturePermission;

/// Displays a JavaScript alert panel.
///
Expand Down Expand Up @@ -6605,7 +6566,7 @@ class WKUIDelegate extends NSObject {
WKWebView webView,
String message,
WKFrameInfo frame,
)? runJavaScriptConfirmPanel;
) runJavaScriptConfirmPanel;

/// Displays a JavaScript text input panel.
///
Expand Down Expand Up @@ -6638,7 +6599,6 @@ class WKUIDelegate extends NSObject {
bool pigeon_clearHandlers = false,
BinaryMessenger? pigeon_binaryMessenger,
PigeonInstanceManager? pigeon_instanceManager,
WKUIDelegate Function()? pigeon_newInstance,
void Function(
WKUIDelegate pigeon_instance,
WKWebView webView,
Expand Down Expand Up @@ -6676,44 +6636,6 @@ class WKUIDelegate extends NSObject {
_PigeonInternalProxyApiBaseCodec(
pigeon_instanceManager ?? PigeonInstanceManager.instance);
final BinaryMessenger? binaryMessenger = pigeon_binaryMessenger;
{
final BasicMessageChannel<
Object?> pigeonVar_channel = BasicMessageChannel<
Object?>(
'dev.flutter.pigeon.webview_flutter_wkwebview.WKUIDelegate.pigeon_newInstance',
pigeonChannelCodec,
binaryMessenger: binaryMessenger);
if (pigeon_clearHandlers) {
pigeonVar_channel.setMessageHandler(null);
} else {
pigeonVar_channel.setMessageHandler((Object? message) async {
assert(message != null,
'Argument for dev.flutter.pigeon.webview_flutter_wkwebview.WKUIDelegate.pigeon_newInstance was null.');
final List<Object?> args = (message as List<Object?>?)!;
final int? arg_pigeon_instanceIdentifier = (args[0] as int?);
assert(arg_pigeon_instanceIdentifier != null,
'Argument for dev.flutter.pigeon.webview_flutter_wkwebview.WKUIDelegate.pigeon_newInstance was null, expected non-null int.');
try {
(pigeon_instanceManager ?? PigeonInstanceManager.instance)
.addHostCreatedInstance(
pigeon_newInstance?.call() ??
WKUIDelegate.pigeon_detached(
pigeon_binaryMessenger: pigeon_binaryMessenger,
pigeon_instanceManager: pigeon_instanceManager,
),
arg_pigeon_instanceIdentifier!,
);
return wrapResponse(empty: true);
} on PlatformException catch (e) {
return wrapResponse(error: e);
} catch (e) {
return wrapResponse(
error: PlatformException(code: 'error', message: e.toString()));
}
});
}
}

{
final BasicMessageChannel<
Object?> pigeonVar_channel = BasicMessageChannel<
Expand Down Expand Up @@ -6789,10 +6711,10 @@ class WKUIDelegate extends NSObject {
assert(arg_type != null,
'Argument for dev.flutter.pigeon.webview_flutter_wkwebview.WKUIDelegate.requestMediaCapturePermission was null, expected non-null MediaCaptureType.');
try {
final PermissionDecision? output =
final PermissionDecision output =
await (requestMediaCapturePermission ??
arg_pigeon_instance!.requestMediaCapturePermission)
?.call(arg_pigeon_instance!, arg_webView!, arg_origin!,
.call(arg_pigeon_instance!, arg_webView!, arg_origin!,
arg_frame!, arg_type!);
return wrapResponse(result: output);
} on PlatformException catch (e) {
Expand Down Expand Up @@ -6874,9 +6796,9 @@ class WKUIDelegate extends NSObject {
assert(arg_frame != null,
'Argument for dev.flutter.pigeon.webview_flutter_wkwebview.WKUIDelegate.runJavaScriptConfirmPanel was null, expected non-null WKFrameInfo.');
try {
final bool? output = await (runJavaScriptConfirmPanel ??
final bool output = await (runJavaScriptConfirmPanel ??
arg_pigeon_instance!.runJavaScriptConfirmPanel)
?.call(arg_pigeon_instance!, arg_webView!, arg_message!,
.call(arg_pigeon_instance!, arg_webView!, arg_message!,
arg_frame!);
return wrapResponse(result: output);
} on PlatformException catch (e) {
Expand Down
10 changes: 9 additions & 1 deletion ...ages/webview_flutter/webview_flutter_wkwebview/lib/src/legacy/web_kit_webview_widget.dart
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -699,7 +699,15 @@ class WebViewWidgetProxy {
WKNavigationAction navigationAction,
)? onCreateWebView,
}) {
return WKUIDelegate(onCreateWebView: onCreateWebView);
return WKUIDelegate(
onCreateWebView: onCreateWebView,
requestMediaCapturePermission: (_, __, ___, ____, _____) async {
return PermissionDecision.deny;
},
runJavaScriptConfirmPanel: (_, __, ___, ____) async {
return false;
},
);
}

/// Constructs a [WKNavigationDelegate].
Expand Down
Loading