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.

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

Revert "[webview_flutter] Improve flaky scroll tests" #7652

Merged
merged 1 commit into from
Sep 17, 2024
Merged

Revert "[webview_flutter] Improve flaky scroll tests" #7652

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
125 changes: 39 additions & 86 deletions packages/webview_flutter/webview_flutter/example/integration_test/webview_flutter_test.dart
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -491,7 +491,7 @@ Future<void> main() async {
});

group('Programmatic Scroll', () {
Future<WebViewController> pumpScrollTestPage(WidgetTester tester) async {
testWidgets('setAndGetScrollPosition', (WidgetTester tester) async {
const String scrollTestPage = '''
<!DOCTYPE html>
<html>
Expand All @@ -518,105 +518,58 @@ Future<void> main() async {

final Completer<void> pageLoaded = Completer<void>();
final WebViewController controller = WebViewController();
ScrollPositionChange? recordedPosition;
await controller.setJavaScriptMode(JavaScriptMode.unrestricted);
await controller.setNavigationDelegate(NavigationDelegate(
onPageFinished: (_) => pageLoaded.complete(),
));
await controller.setOnScrollPositionChange(
(ScrollPositionChange contentOffsetChange) {
recordedPosition = contentOffsetChange;
});

await controller.loadRequest(Uri.parse(
'data:text/html;charset=utf-8;base64,$scrollTestPageBase64',
));

await tester.pumpWidget(WebViewWidget(controller: controller));
await pageLoaded.future;

return controller;
}

testWidgets('getScrollPosition', (WidgetTester tester) async {
final WebViewController controller = await pumpScrollTestPage(tester);
await controller.setJavaScriptMode(JavaScriptMode.unrestricted);

const Offset testScrollPosition = Offset(123, 321);

// Ensure the start scroll position is not equal to the test position.
expect(await controller.getScrollPosition(), isNot(testScrollPosition));

final Completer<void> testScrollPositionCompleter = Completer<void>();
await controller.setOnScrollPositionChange(
(ScrollPositionChange contentOffsetChange) {
if (Offset(contentOffsetChange.x, contentOffsetChange.y) ==
testScrollPosition) {
testScrollPositionCompleter.complete();
}
},
);

await controller.scrollTo(
testScrollPosition.dx.toInt(),
testScrollPosition.dy.toInt(),
);
await testScrollPositionCompleter.future;

expect(await controller.getScrollPosition(), testScrollPosition);
});

testWidgets('scrollTo', (WidgetTester tester) async {
final WebViewController controller = await pumpScrollTestPage(tester);

const Offset testScrollPosition = Offset(123, 321);

// Ensure the start scroll position is not equal to the test position.
expect(await controller.getScrollPosition(), isNot(testScrollPosition));

late ScrollPositionChange lastPositionChange;
await controller.setOnScrollPositionChange(
expectAsyncUntil1(
(ScrollPositionChange contentOffsetChange) {
lastPositionChange = contentOffsetChange;
},
() {
return Offset(lastPositionChange.x, lastPositionChange.y) ==
testScrollPosition;
},
),
);

await controller.scrollTo(
testScrollPosition.dx.toInt(),
testScrollPosition.dy.toInt(),
);
});

testWidgets('scrollBy', (WidgetTester tester) async {
final WebViewController controller = await pumpScrollTestPage(tester);

const Offset testScrollPosition = Offset(123, 321);

// Ensure the start scroll position is not equal to the test position.
expect(await controller.getScrollPosition(), isNot(testScrollPosition));

late ScrollPositionChange lastPositionChange;
await controller.setOnScrollPositionChange(
expectAsyncUntil1(
(ScrollPositionChange contentOffsetChange) {
lastPositionChange = contentOffsetChange;
},
() {
return Offset(lastPositionChange.x, lastPositionChange.y) ==
testScrollPosition;
},
),
);
await pageLoaded.future;

await controller.scrollTo(0, 0);
await controller.scrollBy(
testScrollPosition.dx.toInt(),
testScrollPosition.dy.toInt(),
);
await tester.pumpAndSettle(const Duration(seconds: 3));

Offset scrollPos = await controller.getScrollPosition();

// Check scrollTo()
const int X_SCROLL = 123;
const int Y_SCROLL = 321;
// Get the initial position; this ensures that scrollTo is actually
// changing something, but also gives the native view's scroll position
// time to settle.
expect(scrollPos.dx, isNot(X_SCROLL));
expect(scrollPos.dy, isNot(Y_SCROLL));
expect(recordedPosition?.x, isNot(X_SCROLL));
expect(recordedPosition?.y, isNot(Y_SCROLL));

await controller.scrollTo(X_SCROLL, Y_SCROLL);
scrollPos = await controller.getScrollPosition();
expect(scrollPos.dx, X_SCROLL);
expect(scrollPos.dy, Y_SCROLL);
expect(recordedPosition?.x, X_SCROLL);
expect(recordedPosition?.y, Y_SCROLL);

// Check scrollBy() (on top of scrollTo())
await controller.scrollBy(X_SCROLL, Y_SCROLL);
scrollPos = await controller.getScrollPosition();
expect(scrollPos.dx, X_SCROLL * 2);
expect(scrollPos.dy, Y_SCROLL * 2);
expect(recordedPosition?.x, X_SCROLL * 2);
expect(recordedPosition?.y, Y_SCROLL * 2);
});
},
// Scroll position is currently not implemented for macOS.
skip: Platform.isMacOS);
// Flakes on iOS: https://github.com/flutter/flutter/issues/154826
skip: Platform.isMacOS || Platform.isIOS);

group('NavigationDelegate', () {
const String blankPage = '<!DOCTYPE html><head></head><body></body></html>';
Expand Down
137 changes: 43 additions & 94 deletions ...ebview_flutter/webview_flutter_android/example/integration_test/webview_flutter_test.dart
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -758,9 +758,8 @@ Future<void> main() async {
});

group('Programmatic Scroll', () {
Future<PlatformWebViewController> pumpScrollTestPage(
WidgetTester tester,
) async {
testWidgets('setAndGetAndListenScrollPosition',
(WidgetTester tester) async {
const String scrollTestPage = '''
<!DOCTYPE html>
<html>
Expand All @@ -786,20 +785,28 @@ Future<void> main() async {
base64Encode(const Utf8Encoder().convert(scrollTestPage));

final Completer<void> pageLoaded = Completer<void>();
ScrollPositionChange? recordedPosition;
final PlatformWebViewController controller = PlatformWebViewController(
const PlatformWebViewControllerCreationParams(),
);
await controller.setJavaScriptMode(JavaScriptMode.unrestricted);
final PlatformNavigationDelegate delegate = PlatformNavigationDelegate(
const PlatformNavigationDelegateCreationParams(),
);
await delegate.setOnPageFinished((_) => pageLoaded.complete());
await controller.setPlatformNavigationDelegate(delegate);
await controller.setOnScrollPositionChange(
(ScrollPositionChange contentOffsetChange) {
recordedPosition = contentOffsetChange;
});

await controller.loadRequest(LoadRequestParams(
uri: Uri.parse(
'data:text/html;charset=utf-8;base64,$scrollTestPageBase64',
await controller.loadRequest(
LoadRequestParams(
uri: Uri.parse(
'data:text/html;charset=utf-8;base64,$scrollTestPageBase64',
),
),
));
);

await tester.pumpWidget(Builder(
builder: (BuildContext context) {
Expand All @@ -808,95 +815,37 @@ Future<void> main() async {
).build(context);
},
));
await pageLoaded.future;

return controller;
}

testWidgets('getScrollPosition', (WidgetTester tester) async {
final PlatformWebViewController controller =
await pumpScrollTestPage(tester);
await controller.setJavaScriptMode(JavaScriptMode.unrestricted);

const Offset testScrollPosition = Offset(123, 321);

// Ensure the start scroll position is not equal to the test position.
expect(await controller.getScrollPosition(), isNot(testScrollPosition));

final Completer<void> testScrollPositionCompleter = Completer<void>();
await controller.setOnScrollPositionChange(
(ScrollPositionChange contentOffsetChange) {
if (Offset(contentOffsetChange.x, contentOffsetChange.y) ==
testScrollPosition) {
testScrollPositionCompleter.complete();
}
},
);

await controller.scrollTo(
testScrollPosition.dx.toInt(),
testScrollPosition.dy.toInt(),
);
await testScrollPositionCompleter.future;

expect(await controller.getScrollPosition(), testScrollPosition);
});

testWidgets('scrollTo', (WidgetTester tester) async {
final PlatformWebViewController controller =
await pumpScrollTestPage(tester);

const Offset testScrollPosition = Offset(123, 321);

// Ensure the start scroll position is not equal to the test position.
expect(await controller.getScrollPosition(), isNot(testScrollPosition));

late ScrollPositionChange lastPositionChange;
await controller.setOnScrollPositionChange(
expectAsyncUntil1(
(ScrollPositionChange contentOffsetChange) {
lastPositionChange = contentOffsetChange;
},
() {
return Offset(lastPositionChange.x, lastPositionChange.y) ==
testScrollPosition;
},
),
);

await controller.scrollTo(
testScrollPosition.dx.toInt(),
testScrollPosition.dy.toInt(),
);
});

testWidgets('scrollBy', (WidgetTester tester) async {
final PlatformWebViewController controller =
await pumpScrollTestPage(tester);

const Offset testScrollPosition = Offset(123, 321);

// Ensure the start scroll position is not equal to the test position.
expect(await controller.getScrollPosition(), isNot(testScrollPosition));

late ScrollPositionChange lastPositionChange;
await controller.setOnScrollPositionChange(
expectAsyncUntil1(
(ScrollPositionChange contentOffsetChange) {
lastPositionChange = contentOffsetChange;
},
() {
return Offset(lastPositionChange.x, lastPositionChange.y) ==
testScrollPosition;
},
),
);
await pageLoaded.future;

await controller.scrollTo(0, 0);
await controller.scrollBy(
testScrollPosition.dx.toInt(),
testScrollPosition.dy.toInt(),
);
await tester.pumpAndSettle(const Duration(seconds: 3));

Offset scrollPos = await controller.getScrollPosition();

// Check scrollTo()
const int X_SCROLL = 123;
const int Y_SCROLL = 321;
// Get the initial position; this ensures that scrollTo is actually
// changing something, but also gives the native view's scroll position
// time to settle.
expect(scrollPos.dx, isNot(X_SCROLL));
expect(scrollPos.dy, isNot(Y_SCROLL));
expect(recordedPosition, null);

await controller.scrollTo(X_SCROLL, Y_SCROLL);
scrollPos = await controller.getScrollPosition();
expect(scrollPos.dx, X_SCROLL);
expect(scrollPos.dy, Y_SCROLL);
expect(recordedPosition?.x, X_SCROLL);
expect(recordedPosition?.y, Y_SCROLL);

// Check scrollBy() (on top of scrollTo())
await controller.scrollBy(X_SCROLL, Y_SCROLL);
scrollPos = await controller.getScrollPosition();
expect(scrollPos.dx, X_SCROLL * 2);
expect(scrollPos.dy, Y_SCROLL * 2);
expect(recordedPosition?.x, X_SCROLL * 2);
expect(recordedPosition?.y, Y_SCROLL * 2);
});
});

Expand Down
Loading