Fixes handleNavigationMessage in order (flutter#26596)

Author: chunhtai

lib/web_ui/lib/src/engine/window.dart

@@ -4,6 +4,8 @@
 
 part of engine;
 
+typedef _HandleMessageCallBack = Future<bool> Function();
+
 /// When set to true, all platform messages will be printed to the console.
 const bool /*!*/ _debugPrintPlatformMessages = false;
 
@@ -112,32 +114,50 @@ class EngineFlutterWindow extends ui.SingletonFlutterWindow {
     _customUrlStrategy = null;
   }
 
-  Future<bool> handleNavigationMessage(ByteData? data) async {
-    final MethodCall decoded = JSONMethodCodec().decodeMethodCall(data);
-    final Map<String, dynamic>? arguments = decoded.arguments;
-    switch (decoded.method) {
-      case 'selectMultiEntryHistory':
-        await _useMultiEntryBrowserHistory();
-        return true;
-      case 'selectSingleEntryHistory':
-        await _useSingleEntryBrowserHistory();
-        return true;
-      // the following cases assert that arguments are not null
-      case 'routeUpdated': // deprecated
-        assert(arguments != null);
-        await _useSingleEntryBrowserHistory();
-        browserHistory.setRouteName(arguments!['routeName']);
-        return true;
-      case 'routeInformationUpdated':
-        assert(arguments != null);
-        browserHistory.setRouteName(
-          arguments!['location'],
-          state: arguments['state'],
-          replace: arguments['replace'] ?? false,
-        );
-        return true;
+  Future<void> _endOfTheLine = Future<void>.value(null);
+
+  Future<bool> _waitInTheLine(_HandleMessageCallBack callback) async {
+    final Future<void> currentPosition = _endOfTheLine;
+    final Completer<void> completer = Completer<void>();
+    _endOfTheLine = completer.future;
+    await currentPosition;
+    bool result = false;
+    try {
+      result = await callback();
+    } finally {
+      completer.complete();
     }
-    return false;
+    return result;
+  }
+
+  Future<bool> handleNavigationMessage(ByteData? data) async {
+    return _waitInTheLine(() async {
+      final MethodCall decoded = JSONMethodCodec().decodeMethodCall(data);
+      final Map<String, dynamic>? arguments = decoded.arguments;
+      switch (decoded.method) {
+        case 'selectMultiEntryHistory':
+          await _useMultiEntryBrowserHistory();
+          return true;
+        case 'selectSingleEntryHistory':
+          await _useSingleEntryBrowserHistory();
+          return true;
+        // the following cases assert that arguments are not null
+        case 'routeUpdated': // deprecated
+          assert(arguments != null);
+          await _useSingleEntryBrowserHistory();
+          browserHistory.setRouteName(arguments!['routeName']);
+          return true;
+        case 'routeInformationUpdated':
+          assert(arguments != null);
+          browserHistory.setRouteName(
+            arguments!['location'],
+            state: arguments['state'],
+            replace: arguments['replace'] ?? false,
+          );
+          return true;
+      }
+      return false;
+    });
   }
 
   @override

lib/web_ui/test/window_test.dart

@@ -133,6 +133,57 @@ void testMain() {
     }, throwsAssertionError);
   });
 
+  test('handleNavigationMessage execute request in order.', () async {
+    // Start with multi entries.
+    await window.debugInitializeHistory(TestUrlStrategy.fromEntry(
+      TestHistoryEntry('initial state', null, '/initial'),
+    ), useSingle: false);
+    expect(window.browserHistory, isA<MultiEntriesBrowserHistory>());
+    final List<String> executionOrder = <String>[];
+    window.handleNavigationMessage(
+      JSONMethodCodec().encodeMethodCall(MethodCall(
+        'selectSingleEntryHistory',
+        null,
+      ))
+    ).then<void>((bool data) {
+      executionOrder.add('1');
+    });
+    window.handleNavigationMessage(
+      JSONMethodCodec().encodeMethodCall(MethodCall(
+        'selectMultiEntryHistory',
+        null,
+      ))
+    ).then<void>((bool data) {
+      executionOrder.add('2');
+    });
+    window.handleNavigationMessage(
+      JSONMethodCodec().encodeMethodCall(MethodCall(
+        'selectSingleEntryHistory',
+        null,
+      ))
+    ).then<void>((bool data) {
+      executionOrder.add('3');
+    });
+    await window.handleNavigationMessage(
+      JSONMethodCodec().encodeMethodCall(MethodCall(
+        'routeInformationUpdated',
+        <String, dynamic>{
+          'location': '/baz',
+          'state': null,
+        }, // boom
+      ))
+    ).then<void>((bool data) {
+      executionOrder.add('4');
+    });
+    // The routeInformationUpdated should finish after the browser history
+    // has been set to single entry.
+    expect(executionOrder.length, 4);
+    expect(executionOrder[0], '1');
+    expect(executionOrder[1], '2');
+    expect(executionOrder[2], '3');
+    expect(executionOrder[3], '4');
+  });
+
   test('should not throw when using nav1 and nav2 together',
       () async {
     await window.debugInitializeHistory(TestUrlStrategy.fromEntry(