Let connect() method wait until there is an actual connection

Author: Dennis Trautwein

lib/src/remote_devtools_middleware.dart

@@ -55,6 +55,7 @@ class RemoteDevToolsMiddleware extends MiddlewareClass {
     this._channel = await this._login();
     _setStatus(RemoteDevToolsStatus.starting);
     this._relay('START');
+    await this._waitForStart();
     this.socket.on(_channel, (String name, dynamic data) {
       this.handleEventFromRemote(data as Map<String, dynamic>);
     });
@@ -63,6 +64,19 @@ class RemoteDevToolsMiddleware extends MiddlewareClass {
     }
   }
 
+  Future<dynamic> _waitForStart() {
+    final c = Completer();
+    this.socket.on(_channel, (String name, dynamic data) {
+      if (data['type'] == "START") {
+        _setStatus(RemoteDevToolsStatus.started);
+        c.complete();
+      } else {
+        c.completeError(data);
+      }
+    });
+    return c.future;
+  }
+
   Future<String> _login() {
     Completer<String> c = new Completer<String>();
     this.socket.emit('login', 'master', (String name, dynamic error, dynamic data) {

test/remote_devtools_middleware_test.dart

@@ -42,6 +42,10 @@ void main() {
       test('it sends the login message', () async {
         when(socket.connect()).thenAnswer((_) => new Future.value());
         when(socket.id).thenReturn('testId');
+        when(socket.on("data", captureAny)).thenAnswer((Invocation i) {
+          Function fn = i.positionalArguments[1];
+          fn("name", {'type': 'START'});
+        });
         when(socket.emit("login", "master", captureAny)).thenAnswer((Invocation i) {
           Function fn = i.positionalArguments[2];
           fn('testChannel', 'err', 'data');
@@ -55,15 +59,37 @@ void main() {
           fn('testChannel', 'err', 'data');
         });
         when(socket.id).thenReturn('testId');
+        when(socket.on("data", captureAny)).thenAnswer((Invocation i) {
+          Function fn = i.positionalArguments[1];
+          fn("name", {'type': 'START'});
+        });
         connectResponse = await devtools.connect();
-        verify(
-            socket.emit("log", {'type': "START", 'id': 'testId', 'name': 'flutter'}, captureAny));
+        verify(socket.emit("log", {'type': "START", 'id': 'testId', 'name': 'flutter'}, captureAny));
+      });
+      test('it is in STARTED state', () async {
+        when(socket.connect()).thenAnswer((_) => new Future.value());
+        when(socket.id).thenReturn('testId');
+        when(socket.on("data", captureAny)).thenAnswer((Invocation i) {
+          Function fn = i.positionalArguments[1];
+          fn("name", {'type': 'START'});
+        });
+        when(socket.emit("login", "master", captureAny))
+            .thenAnswer((Invocation i) {
+          Function fn = i.positionalArguments[2];
+          fn('testChannel', 'err', 'data');
+        });
+        await devtools.connect();
+        expect(devtools.status, RemoteDevToolsStatus.started);
       });
       test('it sends the state', () async {
         when(socket.emit("login", "master", captureAny)).thenAnswer((Invocation i) {
           Function fn = i.positionalArguments[2];
           fn('testChannel', 'err', 'data');
         });
+        when(socket.on("data", captureAny)).thenAnswer((Invocation i) {
+          Function fn = i.positionalArguments[1];
+          fn("name", {'type': 'START'});
+        });
         when(socket.id).thenReturn('testId');
         var store = MockStore();
         when(store.state).thenReturn('TEST STATE');
@@ -97,12 +123,17 @@ void main() {
           Function fn = i.positionalArguments[2];
           fn('testChannel', 'err', 'data');
         });
+        when(socket.on("data", captureAny)).thenAnswer((Invocation i) {
+          Function fn = i.positionalArguments[1];
+          return fn("name", {'type': 'START'});
+        });
         when(socket.id).thenReturn('testId');
         when(socket.connect()).thenAnswer((_) => new Future.value());
         devtools = RemoteDevToolsMiddleware('example.com', socket: socket);
         await devtools.connect();
       });
       test('nothing sent if status is not started', () {
+        devtools.status = RemoteDevToolsStatus.starting;
         devtools.call(store, TestActions.SomeAction, next.next);
         verifyNever(socket.emit(
             'log',
@@ -148,20 +179,16 @@ void main() {
           Function fn = i.positionalArguments[2];
           fn('testChannel', 'err', 'data');
         });
+        when(socket.on("data", captureAny)).thenAnswer((Invocation i) {
+          Function fn = i.positionalArguments[1];
+          return fn("name", {'type': 'START'});
+        });
         when(socket.id).thenReturn('testId');
         when(socket.connect()).thenAnswer((_) => new Future.value());
         devtools = RemoteDevToolsMiddleware('example.com', socket: socket);
         devtools.store = store;
         await devtools.connect();
       });
-      test('START response sets status to STARTED', () {
-        var remoteData = {
-          'type': 'START',
-        };
-        expect(devtools.status, RemoteDevToolsStatus.starting);
-        devtools.handleEventFromRemote(remoteData);
-        expect(devtools.status, RemoteDevToolsStatus.started);
-      });
       test('handles time travel', () {
         var remoteData = {
           'type': 'DISPATCH',