Serialize AnalysisErrors to JSON in the analysis server.

pkg/analysis_server/lib/src/analysis_server.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 analysis.server;
 
 import 'dart:async';
 
 import 'package:analysis_server/src/analysis_logger.dart';
 import 'package:analysis_server/src/channel.dart';
 import 'package:analysis_server/src/protocol.dart';
 import 'package:analyzer/src/generated/engine.dart';
+import 'package:analyzer/src/generated/error.dart';
 
 /**
  * Instances of the class [AnalysisServer] implement a server that listens on a
  * [CommunicationChannel] for analysis requests and process them.
  */
 class AnalysisServer {
   /**
    * The name of the notification of new errors associated with a source.
    */
   static const String ERROR_NOTIFICATION_NAME = 'context.errors';
@@ skipping 158 matching lines @@
   }
 
   /**
    * Send the information in the given list of notices back to the client.
    */
   void sendNotices(List<ChangeNotice> notices) {
     for (int i = 0; i < notices.length; i++) {
       ChangeNotice notice = notices[i];
       Notification notification = new Notification(ERROR_NOTIFICATION_NAME);
       notification.setParameter(SOURCE_PARAM, notice.source.encoding);
-      notification.setParameter(ERRORS_PARAM, notice.errors);
+      notification.setParameter(ERRORS_PARAM, new List.from(notice.errors.map(

[scheglov, 2014/04/23 19:20:56]

You could use .map(f).toList().

[Paul Berry, 2014/04/23 20:36:26]

Done.

+          errorToJson)));
       sendNotification(notification);
     }
   }
 
+  static Map<String, Object> errorToJson(AnalysisError analysisError) {
+    // TODO(paulberry): move this function into the AnalysisError class.
+
+    // TODO(paulberry): add "ordinal" to errorCode interface so that this trick
+    // with dynamic is unnecessary.

[scheglov, 2014/04/23 19:20:56]

You could probably cast it to Enum.
(errorCode as Enum).ordinal

[Paul Berry, 2014/04/23 20:36:26]

Done.

+    dynamic errorCode = analysisError.errorCode;
+    Map<String, Object> result = {
+      'source': analysisError.source.encoding,
+      'errorCode': errorCode.ordinal,

[scheglov, 2014/04/23 19:20:56]

I don't think that using "ordinal" is valid at all.
It changes every time when we regenerate Engine.
I'd say it is valid only inside of a running Engine, but shouldn't be ever
exposed outside.

We need some stable presentation of an error.
I think it should class name + error/enum name (not message).
Still requires a change in ErrorCode though.

[Paul Berry, 2014/04/23 20:36:26]

Good point.  I've updated the TODO comment accordingly, and we can revisit in a
future CL.

[Brian Wilkerson, 2014/04/24 15:44:05]

There has been some discussion in the past about creating a list of error
numbers that can be shared across all of the tools. I think that would be the
better choice. Perhaps we should use this need as a forcing function.

+      'offset': analysisError.offset,
+      'length': analysisError.length,
+      'message': analysisError.message
+    };
+    if (analysisError.correction != null) {
+      result['correction'] = analysisError.correction;
+    }
+    return result;
+  }
+
   /**
    * Send the given [notification] to the client.
    */
   void sendNotification(Notification notification) {
     channel.sendNotification(notification);
   }
 
   void _scheduleTask() {
     new Future(performTask).catchError((ex, st) {
       AnalysisEngine.instance.logger.logError("${ex}\n${st}");
     });
   }
 }