Change integration test send...() methods to return structured objects.

pkg/analysis_server/lib/src/protocol.dart

 // Copyright (c) 2014, the Dart project authors.  Please see the AUTHORS 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 protocol;
 
 import 'dart:collection';
 import 'dart:convert';
 
 import 'package:analysis_server/src/computer/element.dart' show
@@ skipping 51 matching lines @@
   while (index < edits.length && edits[index].offset > sourceEdit.offset) {
     index++;
   }
   edits.insert(index, sourceEdit);
 }
 
 /**
  * Adds [edit] to the [FileEdit] for the given [file].
  */
 void _addEditToSourceChange(SourceChange change, String file, int fileStamp,
-                            SourceEdit edit) {
+    SourceEdit edit) {
   SourceFileEdit fileEdit = change.getFileEdit(file);
   if (fileEdit == null) {
     fileEdit = new SourceFileEdit(file, fileStamp);
     change.addFileEdit(fileEdit);
   }
   fileEdit.add(edit);
 }
 
 
 void _addElementEditToSourceChange(SourceChange change, engine.Element element,
@@ skipping 80 matching lines @@
 String _applySequence(String code, Iterable<SourceEdit> edits) {
   edits.forEach((SourceEdit edit) {
     code = edit.apply(code);
   });
   return code;
 }
 
 /**
  * Map an element kind from the analyzer engine to a [CompletionSuggestionKind].
  */
-CompletionSuggestionKind _completionSuggestionKindFromElementKind(engine.ElementKind kind) {
+CompletionSuggestionKind
+    _completionSuggestionKindFromElementKind(engine.ElementKind kind) {
   //    ElementKind.ANGULAR_FORMATTER,
   //    ElementKind.ANGULAR_COMPONENT,
   //    ElementKind.ANGULAR_CONTROLLER,
   //    ElementKind.ANGULAR_DIRECTIVE,
   //    ElementKind.ANGULAR_PROPERTY,
   //    ElementKind.ANGULAR_SCOPE_PROPERTY,
   //    ElementKind.ANGULAR_SELECTOR,
   //    ElementKind.ANGULAR_VIEW,
   if (kind == engine.ElementKind.CLASS) return CompletionSuggestionKind.CLASS;
   //    ElementKind.COMPILATION_UNIT,
-  if (kind == engine.ElementKind.CONSTRUCTOR) return CompletionSuggestionKind.CONSTRUCTOR;
+  if (kind ==
+      engine.ElementKind.CONSTRUCTOR) return CompletionSuggestionKind.CONSTRUCTOR;
   //    ElementKind.DYNAMIC,
   //    ElementKind.EMBEDDED_HTML_SCRIPT,
   //    ElementKind.ERROR,
   //    ElementKind.EXPORT,
   //    ElementKind.EXTERNAL_HTML_SCRIPT,
   if (kind == engine.ElementKind.FIELD) return CompletionSuggestionKind.FIELD;
-  if (kind == engine.ElementKind.FUNCTION) return CompletionSuggestionKind.FUNCTION;
-  if (kind == engine.ElementKind.FUNCTION_TYPE_ALIAS) return CompletionSuggestionKind.FUNCTION_TYPE_ALIAS;
+  if (kind ==
+      engine.ElementKind.FUNCTION) return CompletionSuggestionKind.FUNCTION;
+  if (kind ==
+      engine.ElementKind.FUNCTION_TYPE_ALIAS) return
+          CompletionSuggestionKind.FUNCTION_TYPE_ALIAS;
   if (kind == engine.ElementKind.GETTER) return CompletionSuggestionKind.GETTER;
   //    ElementKind.HTML,
   if (kind == engine.ElementKind.IMPORT) return CompletionSuggestionKind.IMPORT;
   //    ElementKind.LABEL,
   //    ElementKind.LIBRARY,
-  if (kind == engine.ElementKind.LOCAL_VARIABLE) return CompletionSuggestionKind.LOCAL_VARIABLE;
+  if (kind ==
+      engine.ElementKind.LOCAL_VARIABLE) return
+          CompletionSuggestionKind.LOCAL_VARIABLE;
   if (kind == engine.ElementKind.METHOD) return CompletionSuggestionKind.METHOD;
   //    ElementKind.NAME,
-  if (kind == engine.ElementKind.PARAMETER) return CompletionSuggestionKind.PARAMETER;
+  if (kind ==
+      engine.ElementKind.PARAMETER) return CompletionSuggestionKind.PARAMETER;
   //    ElementKind.POLYMER_ATTRIBUTE,
   //    ElementKind.POLYMER_TAG_DART,
   //    ElementKind.POLYMER_TAG_HTML,
   //    ElementKind.PREFIX,
   if (kind == engine.ElementKind.SETTER) return CompletionSuggestionKind.SETTER;
-  if (kind == engine.ElementKind.TOP_LEVEL_VARIABLE) return CompletionSuggestionKind.TOP_LEVEL_VARIABLE;
+  if (kind ==
+      engine.ElementKind.TOP_LEVEL_VARIABLE) return
+          CompletionSuggestionKind.TOP_LEVEL_VARIABLE;
   //    ElementKind.TYPE_PARAMETER,
   //    ElementKind.UNIVERSE
   throw new ArgumentError('Unknown CompletionSuggestionKind for: $kind');
 }
 
 /**
  * Create an ElementKind based on a value from the analyzer engine.  Access
  * this function via new ElementKind.fromEngine().
  */
 ElementKind _elementKindFromEngine(engine.ElementKind kind) {
@@ skipping 205 matching lines @@
   String className = member.enclosingElement.displayName;
   return new OverriddenMember(element, className);
 }
 
 
 /**
  * Create a [RefactoringFeedback] corresponding the given [kind].
  */
 RefactoringFeedback _refactoringFeedbackFromJson(JsonDecoder jsonDecoder,
     String jsonPath, Object json, Map feedbackJson) {
-  String requestId;
-  if (jsonDecoder is ResponseDecoder) {
-    requestId = jsonDecoder.response.id;
-  }
-  RefactoringKind kind = REQUEST_ID_REFACTORING_KINDS.remove(requestId);
+  RefactoringKind kind = jsonDecoder.refactoringKind;
   if (kind == RefactoringKind.EXTRACT_LOCAL_VARIABLE) {
-    return new ExtractLocalVariableFeedback.fromJson(jsonDecoder, jsonPath, json);
+    return new ExtractLocalVariableFeedback.fromJson(
+        jsonDecoder,
+        jsonPath,
+        json);
   }
   if (kind == RefactoringKind.EXTRACT_METHOD) {
     return new ExtractMethodFeedback.fromJson(jsonDecoder, jsonPath, json);
   }
   if (kind == RefactoringKind.INLINE_LOCAL_VARIABLE) {
-    return new InlineLocalVariableFeedback.fromJson(jsonDecoder, jsonPath, json);
+    return new InlineLocalVariableFeedback.fromJson(
+        jsonDecoder,
+        jsonPath,
+        json);
   }
   if (kind == RefactoringKind.INLINE_METHOD) {
     return new InlineMethodFeedback.fromJson(jsonDecoder, jsonPath, json);
   }
   if (kind == RefactoringKind.RENAME) {
     return new RenameFeedback.fromJson(jsonDecoder, jsonPath, json);
   }
   return null;
 }
 
 
 /**
  * Create a [RefactoringOptions] corresponding the given [kind].
  */
 RefactoringOptions _refactoringOptionsFromJson(JsonDecoder jsonDecoder,
     String jsonPath, Object json, RefactoringKind kind) {
   if (kind == RefactoringKind.EXTRACT_LOCAL_VARIABLE) {
-    return new ExtractLocalVariableOptions.fromJson(jsonDecoder, jsonPath, json);
+    return new ExtractLocalVariableOptions.fromJson(
+        jsonDecoder,
+        jsonPath,
+        json);
   }
   if (kind == RefactoringKind.EXTRACT_METHOD) {
     return new ExtractMethodOptions.fromJson(jsonDecoder, jsonPath, json);
   }
   if (kind == RefactoringKind.INLINE_METHOD) {
     return new InlineMethodOptions.fromJson(jsonDecoder, jsonPath, json);
   }
   if (kind == RefactoringKind.MOVE_FILE) {
     return new MoveFileOptions.fromJson(jsonDecoder, jsonPath, json);
   }
@@ skipping 48 matching lines @@
    */
   dynamic mismatch(String jsonPath, String expected);
 
   /**
    * Create an exception to throw if the JSON object at [jsonPath] is missing
    * the key [key].
    */
   dynamic missingKey(String jsonPath, String key);
 
   /**
+   * Retrieve the RefactoringKind that should be assumed when decoding
+   * refactoring feedback objects, or null if no refactoring feedback object is
+   * expected to be encountered.
+   */
+  RefactoringKind get refactoringKind;
+
+  /**
    * Decode a JSON object that is expected to be a boolean.  The strings "true"
    * and "false" are also accepted.
    */
   bool _decodeBool(String jsonPath, Object json) {
     if (json is bool) {
       return json;
     } else if (json == 'true') {
       return true;
     } else if (json == 'false') {
       return false;
@@ skipping 130 matching lines @@
    * Initialize a newly created [Notification] to have the given [event] name.
    * If [_params] is provided, it will be used as the params; otherwise no
    * params will be used.
    */
   Notification(this.event, [this._params]);
 
   /**
    * Initialize a newly created instance based upon the given JSON data
    */
   factory Notification.fromJson(Map<String, Object> json) {
-    return new Notification(json[Notification.EVENT],
+    return new Notification(
+        json[Notification.EVENT],
         json[Notification.PARAMS]);
   }
 
   /**
    * Return a table representing the structure of the Json object that will be
    * sent to the client to represent this response.
    */
   Map<String, Object> toJson() {
     Map<String, Object> jsonObject = {};
     jsonObject[EVENT] = event;
@@ skipping 119 matching lines @@
   }
 
   @override
   dynamic missingKey(String jsonPath, String key) {
     return new RequestFailure(
         new Response.invalidParameter(
             _request,
             jsonPath,
             'contain key ${JSON.encode(key)}'));
   }
+
+  RefactoringKind get refactoringKind {
+    // Refactoring feedback objects should never appear in requests.
+    return null;
+  }
 }
 
 
 /**
  * Instances of the class [RequestFailure] represent an exception that occurred
  * during the handling of a request that requires that an error be returned to
  * the client.
  */
 class RequestFailure implements Exception {
   /**
@@ skipping 79 matching lines @@
    */
   factory Response.fromJson(Map<String, Object> json) {
     try {
       Object id = json[Response.ID];
       if (id is! String) {
         return null;
       }
       Object error = json[Response.ERROR];
       RequestError decodedError;
       if (error is Map) {
-        decodedError = new RequestError.fromJson(new ResponseDecoder(null),
-            '.error', error);
+        decodedError =
+            new RequestError.fromJson(new ResponseDecoder(null), '.error', error);
       }
       Object result = json[Response.RESULT];
       Map<String, Object> decodedResult;
       if (result is Map) {
         decodedResult = result;
       }
-      return new Response(id, error: decodedError,
-          result: decodedResult);
+      return new Response(id, error: decodedError, result: decodedResult);
     } catch (exception) {
       return null;
     }
   }
 
   /**
    * Initialize a newly created instance to represent the
    * GET_ERRORS_INVALID_FILE error condition.
    */
   Response.getErrorsInvalidFile(Request request)
-    : this(
-        request.id,
-        error: new RequestError(RequestErrorCode.GET_ERRORS_INVALID_FILE,
-            'Error during `analysis.getErrors`: invalid file.'));
+      : this(
+          request.id,
+          error: new RequestError(
+              RequestErrorCode.GET_ERRORS_INVALID_FILE,
+              'Error during `analysis.getErrors`: invalid file.'));
 
   /**
    * Initialize a newly created instance to represent an error condition caused
    * by a [request] that had invalid parameter.  [path] is the path to the
    * invalid parameter, in Javascript notation (e.g. "foo.bar" means that the
    * parameter "foo" contained a key "bar" whose value was the wrong type).
    * [expectation] is a description of the type of data that was expected.
    */
   Response.invalidParameter(Request request, String path, String expectation)
-      : this(request.id, error: new RequestError(RequestErrorCode.INVALID_PARAMETER,
-          "Expected parameter $path to $expectation"));
+      : this(
+          request.id,
+          error: new RequestError(
+              RequestErrorCode.INVALID_PARAMETER,
+              "Expected parameter $path to $expectation"));
 
   /**
    * Initialize a newly created instance to represent an error condition caused
    * by a malformed request.
    */
   Response.invalidRequestFormat()
-    : this('', error: new RequestError(RequestErrorCode.INVALID_REQUEST, 'Invalid request'));
+      : this(
+          '',
+          error: new RequestError(RequestErrorCode.INVALID_REQUEST, 'Invalid request'));
 
   /**
    * Initialize a newly created instance to represent the
    * SORT_MEMBERS_INVALID_FILE error condition.
    */
   Response.sortMembersInvalidFile(Request request)
-    : this(
-        request.id,
-        error: new RequestError(RequestErrorCode.SORT_MEMBERS_INVALID_FILE,
-            'Error during `edit.sortMembers`: invalid file.'));
+      : this(
+          request.id,
+          error: new RequestError(
+              RequestErrorCode.SORT_MEMBERS_INVALID_FILE,
+              'Error during `edit.sortMembers`: invalid file.'));
 
   /**
    * Initialize a newly created instance to represent the
    * SORT_MEMBERS_PARSE_ERRORS error condition.
    */
   Response.sortMembersParseErrors(Request request, int numErrors)
-    : this(
-        request.id,
-        error: new RequestError(RequestErrorCode.SORT_MEMBERS_PARSE_ERRORS,
-            'Error during `edit.sortMembers`: file has $numErrors scan/parse errors.'));
+      : this(
+          request.id,
+          error: new RequestError(
+              RequestErrorCode.SORT_MEMBERS_PARSE_ERRORS,
+              'Error during `edit.sortMembers`: file has $numErrors scan/parse errors.'));
 
   /**
    * Initialize a newly created instance to represent an error condition caused
    * by a `analysis.setPriorityFiles` [request] that includes one or more files
    * that are not being analyzed.
    */
   Response.unanalyzedPriorityFiles(Request request, String fileNames)
-    : this(request.id, error: new RequestError(RequestErrorCode.UNANALYZED_PRIORITY_FILES, "Unanalyzed files cannot be a priority: '$fileNames'"));
+      : this(
+          request.id,
+          error: new RequestError(
+              RequestErrorCode.UNANALYZED_PRIORITY_FILES,
+              "Unanalyzed files cannot be a priority: '$fileNames'"));
 
   /**
    * Initialize a newly created instance to represent an error condition caused
    * by a [request] that cannot be handled by any known handlers.
    */
   Response.unknownRequest(Request request)
-    : this(request.id, error: new RequestError(RequestErrorCode.UNKNOWN_REQUEST, 'Unknown request'));
+      : this(
+          request.id,
+          error: new RequestError(RequestErrorCode.UNKNOWN_REQUEST, 'Unknown request'));
 
   Response.unsupportedFeature(String requestId, String message)
-    : this(requestId, error: new RequestError(RequestErrorCode.UNSUPPORTED_FEATURE, message));
+      : this(
+          requestId,
+          error: new RequestError(RequestErrorCode.UNSUPPORTED_FEATURE, message));
 
   /**
    * Return a table representing the structure of the Json object that will be
    * sent to the client to represent this response.
    */
   Map<String, Object> toJson() {
     Map<String, Object> jsonObject = new HashMap<String, Object>();
     jsonObject[ID] = id;
     if (error != null) {
       jsonObject[ERROR] = error.toJson();
     }
     if (_result != null) {
       jsonObject[RESULT] = _result;
     }
     return jsonObject;
   }
 }
 
 /**
  * JsonDecoder for decoding responses from the server.  This is intended to be
  * used only for testing.  Errors are reported using bare [Exception] objects.
  */
 class ResponseDecoder extends JsonDecoder {
-  final Response response;
+  final RefactoringKind refactoringKind;
 
-  ResponseDecoder(this.response);
+  ResponseDecoder(this.refactoringKind);
 
   @override
   dynamic mismatch(String jsonPath, String expected) {
     return new Exception('Expected $expected at $jsonPath');
   }
 
   @override
   dynamic missingKey(String jsonPath, String key) {
     return new Exception('Missing key $key at $jsonPath');
   }
@@ skipping 16 matching lines @@
     hash = 0x1fffffff & (hash + ((0x03ffffff & hash) << 3));
     hash = hash ^ (hash >> 11);
     return 0x1fffffff & (hash + ((0x00003fff & hash) << 15));
   }
 
   static int hash2(a, b) => finish(combine(combine(0, a), b));
 
   static int hash4(a, b, c, d) =>
       finish(combine(combine(combine(combine(0, a), b), c), d));
 }