Initial implementation for 'analysis.setSubscriptions' API.

pkg/analysis_server/test/domain_analysis_test.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 test.domain.analysis;
 
 import 'dart:async';
 
 import 'package:analysis_server/src/analysis_server.dart';
 import 'package:analysis_server/src/constants.dart';
@@ skipping 16 matching lines @@
 
   setUp(() {
     serverChannel = new MockServerChannel();
     server = new AnalysisServer(serverChannel, resourceProvider);
     handler = new AnalysisDomainHandler(server);
   });
 
   group('notification.errors', testNotificationErrors);
   group('notification.highlights', testNotificationHighlights);
   group('updateContent', testUpdateContent);
+  group('setSubscriptions', test_setSubscriptions);
 
   group('AnalysisDomainHandler', () {
     test('getFixes', () {
       var request = new Request('0', METHOD_GET_FIXES);
       request.setParameter(ERRORS, []);
       var response = handler.handleRequest(request);
       // TODO(scheglov) implement
       expect(response, isNull);
     });
 
@@ skipping 46 matching lines @@
     test('setPriorityFiles', () {
       var request = new Request('0', METHOD_SET_PRIORITY_FILES);
       request.setParameter(
           FILES,
           ['projectA/aa.dart', 'projectB/ba.dart']);
       var response = handler.handleRequest(request);
       // TODO(scheglov) implement
       expect(response, isNull);
     });
 
-    test('setSubscriptions', () {
-      var request = new Request('0', METHOD_SET_SUBSCRIPTIONS);
-      request.setParameter(
-          SUBSCRIPTIONS,
-          {
-            AnalysisService.HIGHLIGHTS : ['project/a.dart', 'project/b.dart'],
-            AnalysisService.NAVIGATION : ['project/c.dart'],
-            AnalysisService.OUTLINE : ['project/d.dart', 'project/e.dart']
-          });
-      var response = handler.handleRequest(request);
-      // TODO(scheglov) implement
-      expect(response, isNull);
-    });
-
     test('updateOptions', () {
       var request = new Request('0', METHOD_UPDATE_OPTIONS);
       request.setParameter(
           OPTIONS,
           {
             'analyzeAngular' : true,
             'enableDeferredLoading': true,
             'enableEnums': false
           });
       var response = handler.handleRequest(request);
@@ skipping 49 matching lines @@
 
 /**
  * A helper to test 'analysis.*' requests.
  */
 class AnalysisTestHelper {
   MockServerChannel serverChannel;
   MemoryResourceProvider resourceProvider;
   AnalysisServer server;
   AnalysisDomainHandler handler;
 
+  Map<String, List<String>> analysisSubscriptions = {};
+
   Map<String, List<AnalysisError>> filesErrors = {};
   Map<String, List<Map<String, Object>>> filesHighlights = {};
 
   String testFile = '/project/bin/test.dart';
   String testCode;
 
   AnalysisTestHelper() {
     serverChannel = new MockServerChannel();
     resourceProvider = new MemoryResourceProvider();
     server = new AnalysisServer(serverChannel, resourceProvider);
     handler = new AnalysisDomainHandler(server);
     // listen for notifications
     Stream<Notification> notificationStream = serverChannel.notificationController.stream;
     notificationStream.listen((Notification notification) {
       if (notification.event == NOTIFICATION_ERRORS) {
         String file = notification.getParameter(FILE);
         List<Map<String, Object>> errorMaps = notification.getParameter(ERRORS);
         filesErrors[file] = errorMaps.map(jsonToAnalysisError).toList();
       }
       if (notification.event == NOTIFICATION_HIGHLIGHTS) {
         String file = notification.getParameter(FILE);
         filesHighlights[file] = notification.getParameter(REGIONS);
       }
     });
   }
 
+  void addAnalysisSubscriptionHighlight(String file) {
+    var service = AnalysisService.HIGHLIGHTS;
+    // add file to subscription
+    var files = analysisSubscriptions[service.name];
+    if (files == null) {
+      files = <String>[];
+      analysisSubscriptions[service.name] = files;
+    }
+    files.add(file);
+    // set subscriptions
+    Request request = new Request('0', METHOD_SET_SUBSCRIPTIONS);
+    request.setParameter(SUBSCRIPTIONS, analysisSubscriptions);
+    handleSuccessfulRequest(request);
+  }
+
   /**
    * Returns a [Future] that completes when this this helper finished all its
    * scheduled tasks.
    */
   Future waitForTasksFinished() {
     return waitForServerTasksFinished(server);
   }
 
   /**
    * Returns [AnalysisError]s recorded for the given [file].
@@ skipping 29 matching lines @@
 
   /**
    * Returns highlights recorded for the given [testFile].
    * May be empty, but not `null`.
    */
   List<Map<String, Object>> getTestHighlights() {
     return getHighlights(testFile);
   }
 
   /**
+   * Creates an empty project `/project/`.
+   */
+  void createEmptyProject() {
+    resourceProvider.newFolder('/project');
+    Request request = new Request('0', METHOD_SET_ANALYSIS_ROOTS);
+    request.setParameter(INCLUDED, ['/project']);
+    request.setParameter(EXCLUDED, []);
+    handleSuccessfulRequest(request);
+  }
+
+  /**
    * Creates a project with a single Dart file `/project/bin/test.dart` with
    * the given [code].
    */
   void createSingleFileProject(code) {
     this.testCode = _getCodeString(code);
     resourceProvider.newFolder('/project');
-    resourceProvider.newFile('/project/pubspec.yaml', 'name: project');
     resourceProvider.newFile(testFile, testCode);
     Request request = new Request('0', METHOD_SET_ANALYSIS_ROOTS);
     request.setParameter(INCLUDED, ['/project']);
     request.setParameter(EXCLUDED, []);
     handleSuccessfulRequest(request);
   }
 
   void setFileContent(String path, String content) {
     resourceProvider.newFile(path, content);
   }
@@ skipping 55 matching lines @@
       expect(error.errorCode, 'StaticWarningCode.UNDEFINED_IDENTIFIER');
     });
   });
 }
 
 
 class NotificationHighlightHelper extends AnalysisTestHelper {
   List<Map<String, Object>> regions;
 
   Future prepareRegions(then()) {
+    addAnalysisSubscriptionHighlight(testFile);
     return waitForTasksFinished().then((_) {
       regions = getTestHighlights();
       then();
     });
   }
 
   void assertHasRawRegion(HighlightType type, int offset, int length) {
     for (Map<String, Object> region in regions) {
       if (region['offset'] == offset && region['length'] == length
           && region['type'] == type.name) {
@@ skipping 765 matching lines @@
         helper.handleSuccessfulRequest(request);
       }
       // wait, there is an error
       helper.waitForTasksFinished().then((_) {
         List<AnalysisError> errors = helper.getTestErrors();
         expect(errors, hasLength(1));
       });
     });
   });
 }
+
+
+void test_setSubscriptions() {
+  test('before analysis', () {
+    AnalysisTestHelper helper = new AnalysisTestHelper();
+    // subscribe
+    {
+      var request = new Request('0', METHOD_SET_SUBSCRIPTIONS);
+      request.setParameter(
+          SUBSCRIPTIONS,
+          {
+            AnalysisService.HIGHLIGHTS.name : [helper.testFile],
+          });
+      helper.handleSuccessfulRequest(request);
+    }
+    // create project
+    helper.createSingleFileProject('int V = 42;');
+    // wait, there are highlight regions
+    helper.waitForTasksFinished().then((_) {
+      var highlights = helper.getHighlights(helper.testFile);
+      expect(highlights, isNot(isEmpty));
+    });
+  });
+
+  test('after analysis', () {
+    AnalysisTestHelper helper = new AnalysisTestHelper();
+    // create project
+    helper.createSingleFileProject('int V = 42;');
+    // wait, no regions initially
+    return helper.waitForTasksFinished().then((_) {
+      var highlights = helper.getHighlights(helper.testFile);
+      expect(highlights, isEmpty);
+      // subscribe
+      {
+        var request = new Request('0', METHOD_SET_SUBSCRIPTIONS);
+        request.setParameter(
+            SUBSCRIPTIONS,
+            {
+              AnalysisService.HIGHLIGHTS.name : [helper.testFile],
+            });
+        helper.handleSuccessfulRequest(request);
+      }
+      // wait, has regions
+      return helper.waitForTasksFinished().then((_) {
+        var highlights = helper.getHighlights(helper.testFile);
+        expect(highlights, isNot(isEmpty));
+      });
+    });
+  });
+}