Skip to content
This repository has been archived by the owner on Feb 22, 2023. It is now read-only.

[webview_flutter] Update webview packages for Android and iOS to implement runJavascript and runJavascriptReturningResult. #4402

Merged
merged 47 commits into from Nov 1, 2021
Merged
Show file tree
Hide file tree
Changes from 4 commits
Commits
Show all changes
47 commits
Select commit Hold shift + click to select a range
e25faa3
[webview_flutter_platform_interface] Update webview platform interfac…
BeMacized Oct 1, 2021
f19b5c3
Fix tests
BeMacized Oct 1, 2021
3a22d00
[webview_flutter] Implemented `runJavaScript` and `runJavaScriptForRe…
BeMacized Oct 1, 2021
2bcec1c
Remove accidental development team inclusion from project.pbxproj
BeMacized Oct 1, 2021
ff493a2
Implemented PR feedback
BeMacized Oct 1, 2021
6bf082f
Merge branch 'webview/js_eval_fix_platform' into webview/js_eval_fix_…
BeMacized Oct 1, 2021
ff125c9
Updated runJavaScriptForResult behaviour
BeMacized Oct 1, 2021
9f661e8
Implemented PR feedback partially
BeMacized Oct 4, 2021
cbc88e8
Implement PR feedback
BeMacized Oct 4, 2021
9f537c7
Merge branch 'webview/js_eval_fix_platform' into webview/js_eval_fix_…
BeMacized Oct 4, 2021
26004c3
Update changelog
BeMacized Oct 4, 2021
283f8a7
Merge branch 'webview/js_eval_fix_platform' into webview/js_eval_fix_…
BeMacized Oct 4, 2021
b95d986
Implement PR feedback from interface PR
BeMacized Oct 4, 2021
3d8b9ce
Update changelog
BeMacized Oct 4, 2021
0ecf641
Revert inclusion of development team
BeMacized Oct 4, 2021
02e1106
Implement PR feedback
BeMacized Oct 5, 2021
d7780dd
Merge branch 'webview/js_eval_fix_platform' into webview/js_eval_fix_…
BeMacized Oct 5, 2021
d8f51ed
Implemented platform interface PR feedback
BeMacized Oct 5, 2021
285c2cc
Merge branch 'master' into webview/js_eval_fix_platform
BeMacized Oct 6, 2021
90cb648
Merge branch 'webview/js_eval_fix_platform' into webview/js_eval_fix_…
BeMacized Oct 6, 2021
bfcacdc
Update pubspec dependency
BeMacized Oct 6, 2021
bcb368c
Merge branch 'master' into webview/js_eval_fix_native
BeMacized Oct 6, 2021
485ead3
Fixed capitalisation
BeMacized Oct 6, 2021
a7d10c0
Fixed capitalisation
BeMacized Oct 6, 2021
d98bc6a
Fix warning
BeMacized Oct 7, 2021
738a9ad
Partially implement PR feedback
BeMacized Oct 8, 2021
527bd67
Partially implement PR feedback
BeMacized Oct 8, 2021
acf5ff9
Format
BeMacized Oct 8, 2021
aed3830
Update podfile
BeMacized Oct 8, 2021
6967c4f
Update podfile
BeMacized Oct 8, 2021
37ba26e
Update podfiles
BeMacized Oct 8, 2021
13076ba
Update iOS project files
BeMacized Oct 8, 2021
0c87362
Update podspec
BeMacized Oct 8, 2021
28ac939
Merge remote-tracking branch 'origin/webview/js_eval_fix_native' into…
BeMacized Oct 8, 2021
962ad02
Remove unnecessary podfile configuration
BeMacized Oct 8, 2021
9184d48
Implemented PR feedback
BeMacized Oct 8, 2021
a111502
Merge branch 'master' into webview/js_eval_fix_native
BeMacized Oct 18, 2021
80cbe9b
Format
BeMacized Oct 18, 2021
9fdab9d
Revert podfile changes
BeMacized Oct 22, 2021
6e609d7
Implemented PR feedback
BeMacized Oct 22, 2021
f6d8cb4
Fix formatting
BeMacized Oct 22, 2021
b019d3c
Fix formatting
BeMacized Oct 22, 2021
2b0f490
Fixed test.
BeMacized Oct 22, 2021
fa9526c
Re-add integration tests for deprecated evaluateJavascript method.
BeMacized Oct 26, 2021
45e799b
Merge branch 'master' into webview/js_eval_fix_native
BeMacized Oct 28, 2021
40a6b38
Merge branch 'master' into webview/js_eval_fix_native
BeMacized Oct 28, 2021
e2f4710
Fix merge conflicts
BeMacized Oct 28, 2021
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
4 changes: 4 additions & 0 deletions packages/webview_flutter/webview_flutter_android/CHANGELOG.md
@@ -1,3 +1,7 @@
## 2.1.0

* Implemented new `runJavaScript` and `runJavaScriptForResult` methods in platform interface.

## 2.0.15

* Added Overrides in FlutterWebView.java
Expand Down
Expand Up @@ -54,4 +54,8 @@ android {
}
}
}
compileOptions {
sourceCompatibility JavaVersion.VERSION_1_8
targetCompatibility JavaVersion.VERSION_1_8
}
BeMacized marked this conversation as resolved.
Show resolved Hide resolved
}
Expand Up @@ -244,7 +244,11 @@ public void onMethodCall(MethodCall methodCall, Result result) {
currentUrl(result);
break;
case "evaluateJavascript":
evaluateJavaScript(methodCall, result);
case "runJavaScriptForResult":
evaluateJavaScript(methodCall, result, true);
break;
case "runJavaScript":
evaluateJavaScript(methodCall, result, false);
break;
case "addJavascriptChannels":
addJavaScriptChannels(methodCall, result);
Expand Down Expand Up @@ -325,7 +329,8 @@ private void updateSettings(MethodCall methodCall, Result result) {
}

@TargetApi(Build.VERSION_CODES.KITKAT)
private void evaluateJavaScript(MethodCall methodCall, final Result result) {
private void evaluateJavaScript(
MethodCall methodCall, final Result result, final boolean returnValue) {
String jsString = (String) methodCall.arguments;
if (jsString == null) {
throw new UnsupportedOperationException("JavaScript string cannot be null");
Expand All @@ -335,7 +340,11 @@ private void evaluateJavaScript(MethodCall methodCall, final Result result) {
new android.webkit.ValueCallback<String>() {
@Override
public void onReceiveValue(String value) {
result.success(value);
if (returnValue) {
result.success(value);
} else {
result.success(null);
}
}
});
}
Expand Down
Expand Up @@ -6,31 +6,46 @@

import static org.mockito.ArgumentMatchers.any;
import static org.mockito.ArgumentMatchers.anyBoolean;
import static org.mockito.ArgumentMatchers.eq;
import static org.mockito.ArgumentMatchers.isNull;
import static org.mockito.Mockito.doAnswer;
import static org.mockito.Mockito.mock;
import static org.mockito.Mockito.mockStatic;
import static org.mockito.Mockito.times;
import static org.mockito.Mockito.verify;
import static org.mockito.Mockito.when;

import android.content.Context;
import android.webkit.DownloadListener;
import android.webkit.WebChromeClient;
import android.webkit.WebView;
import io.flutter.plugin.common.MethodCall;
import io.flutter.plugin.common.MethodChannel;
import java.util.HashMap;
import java.util.Map;
import org.junit.Before;
import org.junit.Test;
import org.mockito.MockedStatic;

public class FlutterWebViewTest {
private WebChromeClient mockWebChromeClient;
private DownloadListener mockDownloadListener;
private WebViewBuilder mockWebViewBuilder;
private WebView mockWebView;
private MethodChannel.Result mockResult;
private Context mockContext;
private MethodChannel mockMethodChannel;

@Before
public void before() {

mockWebChromeClient = mock(WebChromeClient.class);
mockWebViewBuilder = mock(WebViewBuilder.class);
mockWebView = mock(WebView.class);
mockDownloadListener = mock(DownloadListener.class);
mockResult = mock(MethodChannel.Result.class);
mockContext = mock(Context.class);
mockMethodChannel = mock(MethodChannel.class);

when(mockWebViewBuilder.setDomStorageEnabled(anyBoolean())).thenReturn(mockWebViewBuilder);
when(mockWebViewBuilder.setJavaScriptCanOpenWindowsAutomatically(anyBoolean()))
Expand All @@ -41,12 +56,11 @@ public void before() {
.thenReturn(mockWebViewBuilder);
when(mockWebViewBuilder.setDownloadListener(any(DownloadListener.class)))
.thenReturn(mockWebViewBuilder);

when(mockWebViewBuilder.build()).thenReturn(mockWebView);
}

@Test
public void createWebView_should_create_webview_with_default_configuration() {
public void createWebView_shouldCreateWebViewWithDefaultConfiguration() {
FlutterWebView.createWebView(
mockWebViewBuilder, createParameterMap(false), mockWebChromeClient, mockDownloadListener);

Expand All @@ -57,6 +71,97 @@ public void createWebView_should_create_webview_with_default_configuration() {
verify(mockWebViewBuilder, times(1)).setWebChromeClient(mockWebChromeClient);
}

@Test(expected = UnsupportedOperationException.class)
public void evaluateJavaScript_shouldThrowForNullString() {
try (MockedStatic<FlutterWebView> mockedFlutterWebView = mockStatic(FlutterWebView.class)) {
// Setup
mockedFlutterWebView
.when(
new MockedStatic.Verification() {
@Override
public void apply() throws Throwable {
FlutterWebView.createWebView(
(WebViewBuilder) any(),
(Map<String, Object>) any(),
(WebChromeClient) any(),
(DownloadListener) any());
}
})
.thenReturn(mockWebView);
FlutterWebView flutterWebView =
new FlutterWebView(mockContext, mockMethodChannel, new HashMap<String, Object>(), null);

// Run
flutterWebView.onMethodCall(new MethodCall("runJavaScript", null), mockResult);
}
}

@Test
public void evaluateJavaScript_shouldReturnValueOnSuccessForReturnValue() {
try (MockedStatic<FlutterWebView> mockedFlutterWebView = mockStatic(FlutterWebView.class)) {
// Setup
mockedFlutterWebView
.when(
() ->
FlutterWebView.createWebView(
(WebViewBuilder) any(),
(Map<String, Object>) any(),
(WebChromeClient) any(),
(DownloadListener) any()))
.thenReturn(mockWebView);
doAnswer(
invocation -> {
android.webkit.ValueCallback<String> callback = invocation.getArgument(1);
callback.onReceiveValue("Test JavaScript Result");
return null;
})
.when(mockWebView)
.evaluateJavascript(eq("Test JavaScript String"), any());
FlutterWebView flutterWebView =
new FlutterWebView(mockContext, mockMethodChannel, new HashMap<String, Object>(), null);

// Run
flutterWebView.onMethodCall(
new MethodCall("runJavaScriptForResult", "Test JavaScript String"), mockResult);

// Verify
verify(mockResult, times(1)).success("Test JavaScript Result");
}
}

@Test
public void evaluateJavaScript_shouldReturnNilOnSuccessForNoReturnValue() {
try (MockedStatic<FlutterWebView> mockedFlutterWebView = mockStatic(FlutterWebView.class)) {
// Setup
mockedFlutterWebView
.when(
() ->
FlutterWebView.createWebView(
(WebViewBuilder) any(),
(Map<String, Object>) any(),
(WebChromeClient) any(),
(DownloadListener) any()))
.thenReturn(mockWebView);
doAnswer(
invocation -> {
android.webkit.ValueCallback<String> callback = invocation.getArgument(1);
callback.onReceiveValue("Test JavaScript Result");
return null;
})
.when(mockWebView)
.evaluateJavascript(eq("Test JavaScript String"), any());
FlutterWebView flutterWebView =
new FlutterWebView(mockContext, mockMethodChannel, new HashMap<String, Object>(), null);

// Run
flutterWebView.onMethodCall(
new MethodCall("runJavaScript", "Test JavaScript String"), mockResult);

// Verify
verify(mockResult, times(1)).success(isNull());
}
}

private Map<String, Object> createParameterMap(boolean usesHybridComposition) {
Map<String, Object> params = new HashMap<>();
params.put("usesHybridComposition", usesHybridComposition);
Expand Down