Skip to content
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.

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

[webview_flutter_wkwebview] Webkit webview controller multiple registration fix #8078

Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
## 3.16.3

* Fixes re-registering existing channels while removing Javascript channels.

## 3.16.2

* Updates README to remove contributor-focused documentation.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -742,12 +742,16 @@ window.addEventListener("error", function(e) {
_javaScriptChannelParams.keys.forEach(
_webView.configuration.userContentController.removeScriptMessageHandler,
);

_javaScriptChannelParams.remove(removedJavaScriptChannel);
final Map<String, WebKitJavaScriptChannelParams> remainingChannelParams =
Map<String, WebKitJavaScriptChannelParams>.from(
_javaScriptChannelParams,
);
remainingChannelParams.remove(removedJavaScriptChannel);
_javaScriptChannelParams.clear();

await Future.wait(<Future<void>>[
for (final JavaScriptChannelParams params
in _javaScriptChannelParams.values)
in remainingChannelParams.values)
addJavaScriptChannel(params),
// Zoom is disabled with a WKUserScript, so this adds it back if it was
// removed above.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ name: webview_flutter_wkwebview
description: A Flutter plugin that provides a WebView widget based on Apple's WKWebView control.
repository: https://github.com/flutter/packages/tree/main/packages/webview_flutter/webview_flutter_wkwebview
issue_tracker: https://github.com/flutter/flutter/issues?q=is%3Aissue+is%3Aopen+label%3A%22p%3A+webview%22
version: 3.16.2
version: 3.16.3

environment:
sdk: ^3.5.0
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -860,6 +860,72 @@ void main() {
verifyNoMoreInteractions(mockUserContentController);
});

test('removeJavaScriptChannel multiple times', () async {
final WebKitProxy webKitProxy = WebKitProxy(
createScriptMessageHandler: ({
required void Function(
WKUserContentController userContentController,
WKScriptMessage message,
) didReceiveScriptMessage,
}) {
return WKScriptMessageHandler.detached(
didReceiveScriptMessage: didReceiveScriptMessage,
);
},
);

final WebKitJavaScriptChannelParams javaScriptChannelParams1 =
WebKitJavaScriptChannelParams(
name: 'name1',
onMessageReceived: (JavaScriptMessage message) {},
webKitProxy: webKitProxy,
);

final WebKitJavaScriptChannelParams javaScriptChannelParams2 =
WebKitJavaScriptChannelParams(
name: 'name2',
onMessageReceived: (JavaScriptMessage message) {},
webKitProxy: webKitProxy,
);

final MockWKUserContentController mockUserContentController =
MockWKUserContentController();

final WebKitWebViewController controller = createControllerWithMocks(
mockUserContentController: mockUserContentController,
);

await controller.addJavaScriptChannel(javaScriptChannelParams1);
await controller.addJavaScriptChannel(javaScriptChannelParams2);
reset(mockUserContentController);

await controller.removeJavaScriptChannel('name1');

verify(mockUserContentController.removeAllUserScripts());
verify(mockUserContentController.removeScriptMessageHandler('name1'));
verify(mockUserContentController.removeScriptMessageHandler('name2'));

verify(mockUserContentController.addScriptMessageHandler(
argThat(isA<WKScriptMessageHandler>()),
'name2',
));

final WKUserScript userScript =
verify(mockUserContentController.addUserScript(captureAny))
.captured
.single as WKUserScript;
expect(userScript.source, 'window.name2 = webkit.messageHandlers.name2;');
expect(
userScript.injectionTime,
WKUserScriptInjectionTime.atDocumentStart,
);

await controller.removeJavaScriptChannel('name2');
verify(mockUserContentController.removeAllUserScripts());
verify(mockUserContentController.removeScriptMessageHandler('name2'));
verifyNoMoreInteractions(mockUserContentController);
});

test('removeJavaScriptChannel with zoom disabled', () async {
final WebKitProxy webKitProxy = WebKitProxy(
createScriptMessageHandler: ({
Expand Down