Send 'notification.errors' for all non-SDK files.

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/domain_analysis.dart';
 import 'package:analysis_server/src/protocol.dart';
 import 'package:analysis_server/src/resource.dart';
 import 'package:analyzer/src/generated/ast.dart';
 import 'package:analyzer/src/generated/engine.dart';
 import 'package:analyzer/src/generated/error.dart';
 import 'package:analyzer/src/generated/java_core.dart';
 import 'package:analyzer/src/generated/sdk.dart';
 import 'package:analyzer/src/generated/sdk_io.dart';
 import 'package:analyzer/src/generated/source_io.dart';
 
+
+/**
+ * An instance of [DirectoryBasedDartSdk] that is shared between
+ * [AnalysisServer] instances to improve performance.
+ */
+final DirectoryBasedDartSdk SHARED_SDK = DirectoryBasedDartSdk.defaultSdk;
+
 /**
  * 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';
-
-  /**
-   * The name of the contextId parameter.
-   */
-  static const String CONTEXT_ID_PARAM = 'contextId';
-
-  /**
    * The name of the parameter whose value is a list of errors.
    */
   static const String ERRORS_PARAM = 'errors';
 
   /**
-   * The name of the parameter whose value is a source.
+   * The name of the parameter whose value is a file path.
    */
-  static const String SOURCE_PARAM = 'source';
+  static const String FILE_PARAM = 'file';
 
   /**
    * The event name of the connected notification.
    */
   static const String CONNECTED_NOTIFICATION = 'server.connected';
 
   /**
    * The channel from which requests are received and to which responses should
    * be sent.
    */
@@ skipping 24 matching lines @@
 //  final Map<String, AnalysisContext> contextMap = new Map<String, AnalysisContext>();
 //
 //  /**
 //   * A table mapping analysis contexts to the context id's associated with them.
 //   */
 //  final Map<AnalysisContext, String> contextIdMap = new Map<AnalysisContext, String>();
 
   /**
    * The current default [DartSdk].
    */
-  DartSdk defaultSdk = DirectoryBasedDartSdk.defaultSdk;
+  DartSdk defaultSdk = SHARED_SDK;

[Brian Wilkerson, 2014/05/28 14:25:21]

For discussion: I'm not sure this is the behavior we want. It seems to me that
the client should be required to set the default SDK and that server should
return an error if there is no default when it tries to create a context.

[scheglov, 2014/05/28 15:46:37]

I agree.
This API is just not implemented yet.

 
   /**
    * A table mapping [Folder]s to the [PubFolder]s associated with them.
    */
   final Map<Folder, PubFolder> folderMap = <Folder, PubFolder>{};
 
   /**
    * A list of the analysis contexts for which analysis work needs to be
    * performed.
    *
@@ skipping 108 matching lines @@
         contextWorkQueue.removeAt(0);
       }
       //
       // Schedule this method to be run again if there is any more work to be
       // done.
       //
       if (!contextWorkQueue.isEmpty) {
         _scheduleTask();
       }
     }
-    // TODO(scheglov) implement for [PubFolder]
-//    if (notices != null) {
-//      sendNotices(contextId, notices);
-//    }
+    if (notices != null) {
+      sendNotices(notices);
+    }
   }
 
-  // TODO(scheglov) rewrite for the new API.
-//  /**
-//   * Send the information in the given list of notices back to the client.
-//   */
-//  void sendNotices(String contextId, List<ChangeNotice> notices) {
-//    for (int i = 0; i < notices.length; i++) {
-//      ChangeNotice notice = notices[i];
-//      Notification notification = new Notification(ERROR_NOTIFICATION_NAME);
-//      notification.setParameter(CONTEXT_ID_PARAM, contextId);
-//      notification.setParameter(SOURCE_PARAM, notice.source.encoding);
-//      notification.setParameter(ERRORS_PARAM, notice.errors.map(
-//          errorToJson).toList());
-//      sendNotification(notification);
-//    }
-//  }
+  /**
+   * 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];
+      Source source = notice.source;
+      // send "analysis.errors" notification
+      // TODO(scheglov) use subscriptions to determine if we should do this
+      if (!source.isInSystemLibrary) {
+        Notification notification = new Notification(AnalysisDomainHandler.ERRORS_NOTIFICATION);
+        notification.setParameter(FILE_PARAM, source.fullName);
+        notification.setParameter(ERRORS_PARAM, notice.errors.map(errorToJson).toList());
+        sendNotification(notification);
+      }
+    }
+  }
 
   /**
    * Implementation for `server.setAnalysisRoots`.
    *
    * TODO(scheglov) implement complete projects/contexts semantics.
    *
    * The current implementation is intentionally simplified and expected
    * that only folders are given each given folder corresponds to the exactly
    * one context.
    *
@@ skipping 71 matching lines @@
     File file = resourceProvider.getResource(path);
     Source unitSource = file.createSource(UriKind.FILE_URI);
     List<Source> librarySources = context.getLibrariesContaining(unitSource);
     if (librarySources.isEmpty) {
       return null;
     }
     // get a resolved unit
     return context.getResolvedCompilationUnit2(unitSource, librarySources[0]);
   }
 
+  /**
+   * Return `true` if all tasks are finished in this [AnalysisServer].
+   */
+  bool test_areTasksFinished() {
+    return contextWorkQueue.isEmpty;
+  }
+
   static Map<String, Object> errorToJson(AnalysisError analysisError) {
     // TODO(paulberry): move this function into the AnalysisError class.
-
-    // TODO(paulberry): we really shouldn't be exposing errorCode.ordinal
-    // outside the analyzer, since the ordinal numbers change whenever we
-    // regenerate the analysis engine.
+    ErrorCode errorCode = analysisError.errorCode;
     Map<String, Object> result = {
-      'source': analysisError.source.encoding,
-      'errorCode': (analysisError.errorCode as Enum).ordinal,
+      'file': analysisError.source.fullName,

[Brian Wilkerson, 2014/05/28 14:25:21]

These strings should be constants.

[scheglov, 2014/05/28 15:46:37]

Will extract them in a separate CL.

+      // TODO(scheglov) add Enum.fullName ?
+      'errorCode': '${errorCode.runtimeType}.${(errorCode as Enum).name}',
       'offset': analysisError.offset,
       'length': analysisError.length,
       'message': analysisError.message
     };
     if (analysisError.correction != null) {
       result['correction'] = analysisError.correction;
     }
     return result;
   }
 
@@ skipping 104 matching lines @@
 /**
  * An enumeration of the services provided by the server domain.
  */
 class ServerService extends Enum2<ServerService> {
   static const ServerService STATUS = const ServerService('STATUS', 0);
 
   static const List<ServerService> VALUES = const [STATUS];
 
   const ServerService(String name, int ordinal) : super(name, ordinal);
 }