From 4e4b9bd0b1ae094d4c837c8cd6d318d15be7fe40 Mon Sep 17 00:00:00 2001 From: adazh <46544665+adazh@users.noreply.github.com> Date: Thu, 18 Jul 2019 22:16:57 -0700 Subject: [PATCH] Renamed the Driver API waitUntilFrameSync to waitUntilNoPendingFrame. (#36512) --- packages/flutter_driver/lib/src/common/find.dart | 8 ++++---- packages/flutter_driver/lib/src/extension/extension.dart | 8 ++++---- packages/flutter_driver/test/src/extension_test.dart | 6 +++--- 3 files changed, 11 insertions(+), 11 deletions(-) diff --git a/packages/flutter_driver/lib/src/common/find.dart b/packages/flutter_driver/lib/src/common/find.dart index 6bbb58b27e4..c9b40455c9b 100644 --- a/packages/flutter_driver/lib/src/common/find.dart +++ b/packages/flutter_driver/lib/src/common/find.dart @@ -120,16 +120,16 @@ class WaitUntilNoTransientCallbacks extends Command { } /// A Flutter Driver command that waits until the frame is synced. -class WaitUntilFrameSync extends Command { +class WaitUntilNoPendingFrame extends Command { /// Creates a command that waits until there's no pending frame scheduled. - const WaitUntilFrameSync({ Duration timeout }) : super(timeout: timeout); + const WaitUntilNoPendingFrame({ Duration timeout }) : super(timeout: timeout); /// Deserializes this command from the value generated by [serialize]. - WaitUntilFrameSync.deserialize(Map json) + WaitUntilNoPendingFrame.deserialize(Map json) : super.deserialize(json); @override - String get kind => 'waitUntilFrameSync'; + String get kind => 'waitUntilNoPendingFrame'; } /// Base class for Flutter Driver finders, objects that describe how the driver diff --git a/packages/flutter_driver/lib/src/extension/extension.dart b/packages/flutter_driver/lib/src/extension/extension.dart index bf9eeeaa7ae..397f9003edd 100644 --- a/packages/flutter_driver/lib/src/extension/extension.dart +++ b/packages/flutter_driver/lib/src/extension/extension.dart @@ -113,7 +113,7 @@ class FlutterDriverExtension { 'waitFor': _waitFor, 'waitForAbsent': _waitForAbsent, 'waitUntilNoTransientCallbacks': _waitUntilNoTransientCallbacks, - 'waitUntilFrameSync': _waitUntilFrameSync, + 'waitUntilNoPendingFrame': _waitUntilNoPendingFrame, 'get_semantics_id': _getSemanticsId, 'get_offset': _getOffset, 'get_diagnostics_tree': _getDiagnosticsTree, @@ -134,7 +134,7 @@ class FlutterDriverExtension { 'waitFor': (Map params) => WaitFor.deserialize(params), 'waitForAbsent': (Map params) => WaitForAbsent.deserialize(params), 'waitUntilNoTransientCallbacks': (Map params) => WaitUntilNoTransientCallbacks.deserialize(params), - 'waitUntilFrameSync': (Map params) => WaitUntilFrameSync.deserialize(params), + 'waitUntilNoPendingFrame': (Map params) => WaitUntilNoPendingFrame.deserialize(params), 'get_semantics_id': (Map params) => GetSemanticsId.deserialize(params), 'get_offset': (Map params) => GetOffset.deserialize(params), 'get_diagnostics_tree': (Map params) => GetDiagnosticsTree.deserialize(params), @@ -371,7 +371,7 @@ class FlutterDriverExtension { return null; } - /// Returns a future that waits until frame is synced. + /// Returns a future that waits until no pending frame is scheduled (frame is synced). /// /// Specifically, it checks: /// * Whether the count of transient callbacks is zero. @@ -388,7 +388,7 @@ class FlutterDriverExtension { /// `set_frame_sync` method. See [FlutterDriver.runUnsynchronized] for more /// details on how to do this. Note, disabling frame sync will require the /// test author to use some other method to avoid flakiness. - Future _waitUntilFrameSync(Command command) async { + Future _waitUntilNoPendingFrame(Command command) async { await _waitUntilFrame(() { return SchedulerBinding.instance.transientCallbackCount == 0 && !SchedulerBinding.instance.hasScheduledFrame; diff --git a/packages/flutter_driver/test/src/extension_test.dart b/packages/flutter_driver/test/src/extension_test.dart index 70d4b121b93..9b54d954f1d 100644 --- a/packages/flutter_driver/test/src/extension_test.dart +++ b/packages/flutter_driver/test/src/extension_test.dart @@ -345,7 +345,7 @@ void main() { testWidgets('returns immediately when frame is synced', ( WidgetTester tester) async { - extension.call(const WaitUntilFrameSync().serialize()) + extension.call(const WaitUntilNoPendingFrame().serialize()) .then(expectAsync1((Map r) { result = r; })); @@ -366,7 +366,7 @@ void main() { // Intentionally blank. We only care about existence of a callback. }); - extension.call(const WaitUntilFrameSync().serialize()) + extension.call(const WaitUntilNoPendingFrame().serialize()) .then(expectAsync1((Map r) { result = r; })); @@ -390,7 +390,7 @@ void main() { 'waits until no pending scheduled frame', (WidgetTester tester) async { SchedulerBinding.instance.scheduleFrame(); - extension.call(const WaitUntilFrameSync().serialize()) + extension.call(const WaitUntilNoPendingFrame().serialize()) .then(expectAsync1((Map r) { result = r; }));