Skip to content

[webview_flutter_wkwebview] Webkit webview controller multiple registration fix #8078

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
auto-submit merged 4 commits into from
Nov 22, 2024
Merged

[webview_flutter_wkwebview] Webkit webview controller multiple registration fix #8078

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
f4c0269
Fix re-registering js bridges
meliksahcakirr Nov 14, 2024
0caf8f4
Update release info
meliksahcakirr Nov 14, 2024
56b23ab
Merge branch 'main' into webkit-webview-controller-multiple-registrat…
meliksahcakirr Nov 15, 2024
96bdade
Merge branch 'main' into webkit-webview-controller-multiple-registrat…
meliksahcakirr Nov 16, 2024
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
Next Next commit
Fix re-registering js bridges
  • Loading branch information
@meliksahcakirr
meliksahcakirr committed Nov 14, 2024
commit f4c0269c746c07274b17de82d34eba68998d2d52
10 changes: 7 additions & 3 deletions packages/webview_flutter/webview_flutter_wkwebview/lib/src/webkit_webview_controller.dart
View file
Open in desktop
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
66 changes: 66 additions & 0 deletions packages/webview_flutter/webview_flutter_wkwebview/test/webkit_webview_controller_test.dart
View file
Open in desktop
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