Move pub's web socket API over to use JSON RPC 2.0.

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';
 
@@ skipping 39 matching lines @@
 
   Future apply(Transform transform) {
     return transform.primaryInput.readAsString().then((contents) {
       var id = transform.primaryInput.id.changeExtension(".out");
       transform.addOutput(new Asset.fromString(id, "\$contents.out"));
     });
   }
 }
 """;
 
+/// The web socket error code for a directory not being served.
+const NOT_SERVED = 1;
+
 /// Returns the source code for a Dart library defining a Transformer that
 /// rewrites Dart files.
 ///
 /// The transformer defines a constant named TOKEN whose value is [id]. When the
 /// transformer transforms another Dart file, it will look for a "TOKEN"
 /// constant definition there and modify it to include *this* transformer's
 /// TOKEN value as well.
 ///
 /// If [import] is passed, it should be the name of a package that defines its
 /// own TOKEN constant. The primary library of that package will be imported
@@ skipping 217 matching lines @@
   expect(_pubServer, isNotNull);
   expect(_adminPort, isNotNull);
 
   return WebSocket.connect("ws://127.0.0.1:$_adminPort").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 is
-/// either equal to [replyEquals] or matches [replyMatches].
+/// Sends a JSON RPC 2.0 request to the running pub serve's web socket
+/// connection, waits for a reply, then verifies the result.
 ///
-/// Only one of [replyEquals] or [replyMatches] may be provided.
+/// This calls a method named [method] with the given [params]. [params] may
+/// contain Futures, in which case this will wait until they've completed before
+/// sending the request.
 ///
-/// [request], [replyEquals], and [replyMatches] may contain futures, in which
-/// case this will wait until they've completed before matching.
+/// The result is validated using [result], which may be a [Matcher] or a [Map]
+/// containing [Matcher]s and [Future]s. This will wait until any futures are
+/// completed before sending the request.
 ///
-/// If [encodeRequest] is `false`, then [request] will be sent as-is over the
-/// socket. It omitted, request is JSON encoded to a string first.
-///
-/// Returns a [Future] that completes to the call's response.
-Future<Map> expectWebSocketCall(request, {Map replyEquals, replyMatches,
-    bool encodeRequest: true}) {
-  assert((replyEquals == null) != (replyMatches == null));
+/// Returns a [Future] that completes to the call's result.
+Future<Map> expectWebSocketResult(String method, Map params, result) {
+  return schedule(() {
+    return Future.wait([
+      _ensureWebSocket(),
+      awaitObject(params),
+      awaitObject(result)
+    ]).then((results) {
+      var resolvedParams = results[1];
+      var resolvedResult = results[2];
 
-  return schedule(() => _ensureWebSocket().then((_) {
-    var matcherFuture;
-    if (replyMatches != null) {
-      matcherFuture = awaitObject(replyMatches);
-    } else {
-      matcherFuture = awaitObject(replyEquals).then((reply) => equals(reply));
-    }
-
-    return matcherFuture.then((matcher) {
-      return awaitObject(request).then((completeRequest) {
-        if (encodeRequest) completeRequest = JSON.encode(completeRequest);
-        _webSocket.add(completeRequest);
-
-        return _webSocketBroadcastStream.first.then((value) {
-          value = JSON.decode(value);
-          expect(value, matcher);
-          return value;
-        });
+      return _jsonRpcRequest(method, resolvedParams).then((response) {
+        expect(response["result"], resolvedResult);
+        return response["result"];
       });
     });
-  }), "send $request to web socket and expect reply $replyEquals");
+  }, "send $method with $params to web socket and expect $result");
+}
+
+/// Sends a JSON RPC 2.0 request to the running pub serve's web socket
+/// connection, waits for a reply, then verifies the error response.
+///
+/// This calls a method named [method] with the given [params]. [params] may
+/// contain Futures, in which case this will wait until they've completed before
+/// sending the request.
+///
+/// The error response is validated using [errorCode] and [errorMessage]. Both
+/// of these must be provided. The error code is checked against [errorCode] and
+/// the error message is checked against [errorMessage]. Either of these may be
+/// matchers.
+///
+/// Returns a [Future] that completes to the error's [data] field.
+Future expectWebSocketError(String method, Map params, errorCode,
+    errorMessage) {
+  return schedule(() {
+    return Future.wait([
+      _ensureWebSocket(),
+      awaitObject(params)
+    ]).then((results) {
+      var resolvedParams = results[1];
+      return _jsonRpcRequest(method, resolvedParams);
+    }).then((response) {
+      expect(response["error"]["code"], errorCode);
+      expect(response["error"]["message"], errorMessage);
+
+      return response["error"]["data"];
+    });
+  }, "send $method with $params to web socket and expect error $errorCode");
+}
+
+/// The next id to use for a JSON-RPC 2.0 request.
+var _rpcId = 0;
+
+/// Sends a JSON-RPC 2.0 request calling [method] with [params].
+///
+/// Returns the response object.
+Future<Map> _jsonRpcRequest(String method, Map params) {
+  var id = _rpcId++;
+  _webSocket.add(JSON.encode({
+    "jsonrpc": "2.0",
+    "method": method,
+    "params": params,
+    "id": id
+  }));
+
+  return _webSocketBroadcastStream.first.then((value) {
+    value = JSON.decode(value);
+    currentSchedule.addDebugInfo(
+        "Web Socket request $method with params $params\n"
+        "Result: $value");
+
+    expect(value["id"], equals(id));
+    return value;
+  });
 }
 
 /// Returns a [Future] that completes to a URL string for the server serving
 /// [path] from [root].
 ///
 /// If [root] is omitted, defaults to "web". If [path] is omitted, no path is
 /// included. The Future will complete once the server is up and running and
 /// the bound ports are known.
 Future<String> getServerUrl([String root, String path]) =>
     _portsCompleter.future.then((_) => _getServerUrlSync(root, path));
@@ skipping 12 matching lines @@
 /// included. Unlike [getServerUrl], this should only be called after the ports
 /// are known.
 String _getServerUrlSync([String root, String path]) {
   if (root == null) root = 'web';
   expect(_ports, contains(root));
   var url = "http://127.0.0.1:${_ports[root]}";
   if (path != null) url = "$url/$path";
   return url;
 }