Add requestTime to responses

pkg/analyzer_plugin/lib/protocol/protocol.dart

 // Copyright (c) 2017, 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.
 
 import 'package:analyzer_plugin/protocol/protocol_generated.dart';
 import 'package:analyzer_plugin/src/protocol/protocol_internal.dart';
 
 /**
  * An interface for enumerated types in the protocol.
  *
@@ skipping 322 matching lines @@
   RequestFailure(this.error);
 }
 
 /**
  * A response to the server.
  *
  * Clients may not extend, implement or mix-in this class.
  */
 class Response {
   /**
-   * The [Response] instance that is returned when a real [Response] cannot
-   * be provided at the moment.
-   */
-  static final Response DELAYED_RESPONSE = new Response('DELAYED_RESPONSE');
-
-  /**
    * The name of the JSON attribute containing the id of the request for which
    * this is a response.
    */
   static const String ID = 'id';
 
   /**
    * The name of the JSON attribute containing the error message.
    */
   static const String ERROR = 'error';
 
   /**
+   * The name of the JSON attribute containing the time at which the request was
+   * handled by the plugin.
+   */
+  static const String REQUEST_TIME = 'requestTime';
+
+  /**
    * The name of the JSON attribute containing the result values.
    */
   static const String RESULT = 'result';
 
   /**
    * The unique identifier used to identify the request that this response is
    * associated with.
    */
   final String id;
 
   /**
    * The error that was caused by attempting to handle the request, or `null` if
    * there was no error.
    */
   final RequestError error;
 
   /**
+   * The time at which the request was handled by the plugin.
+   */
+  final int requestTime;
+
+  /**
    * A table mapping the names of result fields to their values.  Should be
    * `null` if there is no result to send.
    */
   Map<String, Object> result;
 
   /**
    * Initialize a newly created instance to represent a response to a request
    * with the given [id].  If [_result] is provided, it will be used as the
    * result; otherwise an empty result will be used.  If an [error] is provided
    * then the response will represent an error condition.
    */
-  Response(this.id, {Map<String, Object> result, this.error}) : result = result;
-
-//  /**
-//   * Initialize a newly created instance to represent the FILE_NOT_ANALYZED
-//   * error condition.
-//   */
-//  Response.fileNotAnalyzed(Request request, String file)
-//      : this(request.id,
-//      error: new RequestError(RequestErrorCode.FILE_NOT_ANALYZED,
-//          'File is not analyzed: $file.'));
-//
-//  /**
-//   * Initialize a newly created instance to represent the FORMAT_INVALID_FILE
-//   * error condition.
-//   */
-//  Response.formatInvalidFile(Request request)
-//      : this(request.id,
-//      error: new RequestError(RequestErrorCode.FORMAT_INVALID_FILE,
-//          'Error during `edit.format`: invalid file.'));
-//
-//  /**
-//   * Initialize a newly created instance to represent the FORMAT_WITH_ERROR
-//   * error condition.
-//   */
-//  Response.formatWithErrors(Request request)
-//      : this(request.id,
-//      error: new RequestError(RequestErrorCode.FORMAT_WITH_ERRORS,
-//          'Error during `edit.format`: source contains syntax errors.'));
+  Response(this.id, this.requestTime, {this.error, Map<String, Object> result})
+      : result = result;
 
   /**
    * Initialize a newly created instance based on the given JSON data.
    */
   factory Response.fromJson(Map json) {
     try {
-      Object id = json[Response.ID];
+      Object id = json[ID];
       if (id is! String) {
         return null;
       }
-      Object error = json[Response.ERROR];
+      Object error = json[ERROR];
       RequestError decodedError;
       if (error is Map) {
         decodedError = new RequestError.fromJson(
             new ResponseDecoder(null), '.error', error);
       }
-      Object result = json[Response.RESULT];
+      Object requestTime = json[REQUEST_TIME];
+      if (requestTime is! int) {
+        return null;
+      }
+      Object result = json[RESULT];
       Map<String, Object> decodedResult;
       if (result is Map) {
         decodedResult = result as Map<String, Object>;
       }
-      return new Response(id, error: decodedError, result: decodedResult);
+      return new Response(id, requestTime,
+          error: decodedError, result: decodedResult);
     } catch (exception) {
       return null;
     }
   }
 
   /**
    * 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 = <String, Object>{};
     jsonObject[ID] = id;
     if (error != null) {
       jsonObject[ERROR] = error.toJson();
     }
+    jsonObject[REQUEST_TIME] = requestTime;
     if (result != null) {
       jsonObject[RESULT] = result;
     }
     return jsonObject;
   }
 }