Web Socket API for talking to Editor.

sdk/lib/_internal/pub/test/serve/utils.dart

 // Copyright (c) 2013, the Dart project authors.  Please see the AUTHORS d.file
 // for details. All rights reserved. Use of this source code is governed by a
 // BSD-style license that can be found in the LICENSE file.
 
 library pub_tests;
 
 import 'dart:async';
+import 'dart:convert';
+import 'dart:io';
 
 import 'package:http/http.dart' as http;
 import 'package:scheduled_test/scheduled_process.dart';
 import 'package:scheduled_test/scheduled_test.dart';
 
 import '../test_pub.dart';
 
 /// The pub process running "pub serve".
 ScheduledProcess _pubServer;
 
 /// The ephemeral port assigned to the running server.
 int _port;
 
+/// The web socket connection to the running pub process, or `null` if no
+/// connection has been made.
+WebSocket _webSocket;
+Stream _webSocketBroadcastStream;
+
 /// The code for a transformer that renames ".txt" files to ".out" and adds a
 /// ".out" suffix.
 const REWRITE_TRANSFORMER = """
 import 'dart:async';
 
 import 'package:barback/barback.dart';
 
 class RewriteTransformer extends Transformer {
   RewriteTransformer.asPlugin();
 
@@ skipping 69 matching lines @@
   if (!dart2js) args.add("--no-dart2js");
 
   // Dart2js can take a long time to compile dart code, so we increase the
   // timeout to cope with that.
   if (dart2js) {
     currentSchedule.timeout = new Duration(seconds: 15);
   }
 
   _pubServer = startPub(args: args);
 
+  currentSchedule.onComplete.schedule(() {
+    if (_webSocket != null) {
+      _webSocket.close();
+      _webSocket = null;
+      _webSocketBroadcastStream = null;
+    }
+  });
+
   if (shouldGetFirst) {
     expect(_pubServer.nextLine(),
         completion(anyOf(
              startsWith("Your pubspec has changed"),
              startsWith("You don't have a lockfile"))));
     expect(_pubServer.nextLine(),
         completion(startsWith("Resolving dependencies...")));
     expect(_pubServer.nextLine(),
         completion(equals("Got dependencies!")));
   }
@@ skipping 56 matching lines @@
     return _pubServer.nextLine().then((line) {
       if (line.contains("successfully")) return;
 
       // This line wasn't it, so ignore it and keep trying.
       return nextLine();
     });
   }
 
   schedule(nextLine);
 }
+
+/// Schedules opening a web socket connection to the currently running pub
+/// serve.
+Future _ensureWebSocket() {
+  // Use the existing one if already connected.
+  if (_webSocket != null) return new Future.value();
+
+  // Server should already be running.
+  assert(_pubServer != null);
+  assert(_port != null);
+
+  return WebSocket.connect("ws://127.0.0.1:$_port").then((socket) {
+    _webSocket = socket;
+    // TODO(rnystrom): Works around #13913.
+    _webSocketBroadcastStream = _webSocket.asBroadcastStream();
+  });
+}
+
+/// Sends [request] (an arbitrary JSON object) to the running pub serve's web
+/// socket connection, waits for a reply, then verifies that the reply matches
+/// [expectation].
+void webSocketShouldReply(request, expectation, {bool encodeRequest: true}) {

[nweiz, 2013/10/09 19:16:37]

Document the [encodeRequest] parameter.

[Bob Nystrom, 2013/10/11 20:50:10]

Done.

+  schedule(() => _ensureWebSocket().then((_) {
+    if (encodeRequest) request = JSON.encode(request);
+    _webSocket.add(request);
+    return _webSocketBroadcastStream.first.then((value) {
+      expect(JSON.decode(value), expectation);
+    });
+  }), "web socket should reply");

[nweiz, 2013/10/09 19:16:37]

I'd prefer a more descriptive description here. At least it should be phrased as
a description (e.g. "waiting for web socket to reply"), but it would also be
nice if it included the request and expected response as well.

[Bob Nystrom, 2013/10/11 20:50:10]

Done.

+}