Change analysis server protocol to omit empty lists when optional.

pkg/analysis_server/test/integration/integration_test_methods.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.
 //
 // This file has been automatically generated.  Please do not edit it manually.
 // To regenerate the file, use the script
 // "pkg/analysis_server/spec/generate_files".
 
 /**
  * Convenience methods for running integration tests
@@ skipping 53 matching lines @@
   /**
    * Subscribe for services. All previous subscriptions are replaced by the
    * given set of services.
    *
    * It is an error if any of the elements in the list are not valid services.
    * If there is an error, then the current subscriptions will remain
    * unchanged.
    *
    * Parameters
    *
-   * subscriptions ( List<ServerService> )
+   * subscriptions ( optional List<ServerService> )
    *
    *   A list of the services being subscribed to.
    */
-  Future sendServerSetSubscriptions(List<String> subscriptions, {bool checkTypes: true}) {
+  Future sendServerSetSubscriptions({List<String> subscriptions, bool checkTypes: true}) {
     Map<String, dynamic> params = {};
-    params["subscriptions"] = subscriptions;
+    if (subscriptions != null) {
+      params["subscriptions"] = subscriptions;
+    }
     if (checkTypes) {
       expect(params, isServerSetSubscriptionsParams);
     }
     return server.send("server.setSubscriptions", params)
         .then((result) {
       if (checkTypes) {
         expect(result, isServerSetSubscriptionsResult);
       }
       return result;
     });
@@ skipping 82 matching lines @@
    * 'analysis.errors' notification.
    *
    * Parameters
    *
    * file ( FilePath )
    *
    *   The file for which errors are being requested.
    *
    * Returns
    *
-   * errors ( List<AnalysisError> )
+   * errors ( optional List<AnalysisError> )
    *
    *   The errors associated with the file.
    */
   Future sendAnalysisGetErrors(String file, {bool checkTypes: true}) {
     Map<String, dynamic> params = {};
     params["file"] = file;
     if (checkTypes) {
       expect(params, isAnalysisGetErrorsParams);
     }
     return server.send("analysis.getErrors", params)
@@ skipping 15 matching lines @@
    * file ( FilePath )
    *
    *   The file in which hover information is being requested.
    *
    * offset ( int )
    *
    *   The offset for which hover information is being requested.
    *
    * Returns
    *
-   * hovers ( List<HoverInformation> )
+   * hovers ( optional List<HoverInformation> )
    *
    *   The hover information associated with the location. The list will be
-   *   empty if no information could be determined for the location. The list
+   *   omitted if no information could be determined for the location. The list
    *   can contain multiple items if the file is being analyzed in multiple
    *   contexts in conflicting ways (such as a part that is included in
    *   multiple libraries).
    */
   Future sendAnalysisGetHover(String file, int offset, {bool checkTypes: true}) {
     Map<String, dynamic> params = {};
     params["file"] = file;
     params["offset"] = offset;
     if (checkTypes) {
       expect(params, isAnalysisGetHoverParams);
@@ skipping 40 matching lines @@
    * system but they will remain in the set of requested roots.
    *
    * If an included path represents a file, then server will look in the
    * directory containing the file for a pubspec.yaml file. If none is found,
    * then the parents of the directory will be searched until such a file is
    * found or the root of the file system is reached. If such a file is found,
    * it will be used to resolve package: URI’s within the file.
    *
    * Parameters
    *
-   * included ( List<FilePath> )
+   * included ( optional List<FilePath> )
    *
    *   A list of the files and directories that should be analyzed.
    *
-   * excluded ( List<FilePath> )
+   * excluded ( optional List<FilePath> )
    *
    *   A list of the files and directories within the included directories that
    *   should not be analyzed.
    */
-  Future sendAnalysisSetAnalysisRoots(List<String> included, List<String> excluded, {bool checkTypes: true}) {
+  Future sendAnalysisSetAnalysisRoots({List<String> included, List<String> excluded, bool checkTypes: true}) {
     Map<String, dynamic> params = {};
-    params["included"] = included;
-    params["excluded"] = excluded;
+    if (included != null) {
+      params["included"] = included;
+    }
+    if (excluded != null) {
+      params["excluded"] = excluded;
+    }
     if (checkTypes) {
       expect(params, isAnalysisSetAnalysisRootsParams);
     }
     return server.send("analysis.setAnalysisRoots", params)
         .then((result) {
       if (checkTypes) {
         expect(result, isAnalysisSetAnalysisRootsResult);
       }
       return result;
     });
@@ skipping 13 matching lines @@
    * priority files with the set of files currently subject to analysis. (See
    * analysis.setSubscriptions for a description of files that are subject to
    * analysis.)
    *
    * If a requested priority file is a directory it is ignored, but remains in
    * the set of requested priority files so that if it later becomes a file it
    * can be included in the set of actual priority files.
    *
    * Parameters
    *
-   * files ( List<FilePath> )
+   * files ( optional List<FilePath> )
    *
    *   The files that are to be a priority for analysis.
    */
-  Future sendAnalysisSetPriorityFiles(List<String> files, {bool checkTypes: true}) {
+  Future sendAnalysisSetPriorityFiles({List<String> files, bool checkTypes: true}) {
     Map<String, dynamic> params = {};
-    params["files"] = files;
+    if (files != null) {
+      params["files"] = files;
+    }
     if (checkTypes) {
       expect(params, isAnalysisSetPriorityFilesParams);
     }
     return server.send("analysis.setPriorityFiles", params)
         .then((result) {
       if (checkTypes) {
         expect(result, isAnalysisSetPriorityFilesResult);
       }
       return result;
     });
@@ skipping 111 matching lines @@
    *
    * It is only possible to unsubscribe from this notification by using the
    * command-line flag --no-error-notification.
    *
    * Parameters
    *
    * file ( FilePath )
    *
    *   The file containing the errors.
    *
-   * errors ( List<AnalysisError> )
+   * errors ( optional List<AnalysisError> )
    *
    *   The errors contained in the file.
    */
   Stream onAnalysisErrors;
 
   /**
    * Stream controller for [onAnalysisErrors].
    */
   StreamController _onAnalysisErrors;
 
   /**
    * Reports that any analysis results that were previously associated with the
    * given files should be considered to be invalid because those files are no
    * longer being analyzed, either because the analysis root that contained it
    * is no longer being analyzed or because the file no longer exists.
    *
    * If a file is included in this notification and at some later time a
    * notification with results for the file is received, clients should assume
    * that the file is once again being analyzed and the information should be
    * processed.
    *
    * It is not possible to subscribe to or unsubscribe from this notification.
    *
    * Parameters
    *
-   * files ( List<FilePath> )
+   * files ( optional List<FilePath> )
    *
    *   The files that are no longer being analyzed.
    */
   Stream onAnalysisFlushResults;
 
   /**
    * Stream controller for [onAnalysisFlushResults].
    */
   StreamController _onAnalysisFlushResults;
 
   /**
    * Reports the folding regions associated with a given file. Folding regions
    * can be nested, but will not be overlapping. Nesting occurs when a foldable
    * element, such as a method, is nested inside another foldable element such
    * as a class.
    *
    * This notification is not subscribed to by default. Clients can subscribe
    * by including the value "FOLDING" in the list of services passed in an
    * analysis.setSubscriptions request.
    *
    * Parameters
    *
    * file ( FilePath )
    *
    *   The file containing the folding regions.
    *
-   * regions ( List<FoldingRegion> )
+   * regions ( optional List<FoldingRegion> )
    *
    *   The folding regions contained in the file.
    */
   Stream onAnalysisFolding;
 
   /**
    * Stream controller for [onAnalysisFolding].
    */
   StreamController _onAnalysisFolding;
 
   /**
    * Reports the highlight regions associated with a given file.
    *
    * This notification is not subscribed to by default. Clients can subscribe
    * by including the value "HIGHLIGHTS" in the list of services passed in an
    * analysis.setSubscriptions request.
    *
    * Parameters
    *
    * file ( FilePath )
    *
    *   The file containing the highlight regions.
    *
-   * regions ( List<HighlightRegion> )
+   * regions ( optional List<HighlightRegion> )
    *
    *   The highlight regions contained in the file. Each highlight region
    *   represents a particular syntactic or semantic meaning associated with
    *   some range. Note that the highlight regions that are returned can
    *   overlap other highlight regions if there is more than one meaning
    *   associated with a particular region.
    */
   Stream onAnalysisHighlights;
 
   /**
    * Stream controller for [onAnalysisHighlights].
    */
   StreamController _onAnalysisHighlights;
 
   /**
    * Reports the navigation targets associated with a given file.
    *
    * This notification is not subscribed to by default. Clients can subscribe
    * by including the value "NAVIGATION" in the list of services passed in an
    * analysis.setSubscriptions request.
    *
    * Parameters
    *
    * file ( FilePath )
    *
    *   The file containing the navigation regions.
    *
-   * regions ( List<NavigationRegion> )
+   * regions ( optional List<NavigationRegion> )
    *
    *   The navigation regions contained in the file. Each navigation region
    *   represents a list of targets associated with some range. The lists will
    *   usually contain a single target, but can contain more in the case of a
    *   part that is included in multiple libraries or in Dart code that is
    *   compiled against multiple versions of a package. Note that the
    *   navigation regions that are returned do not overlap other navigation
    *   regions.
    */
   Stream onAnalysisNavigation;
 
   /**
    * Stream controller for [onAnalysisNavigation].
    */
   StreamController _onAnalysisNavigation;
 
   /**
    * Reports the occurrences of references to elements within a single file.
    *
    * This notification is not subscribed to by default. Clients can subscribe
    * by including the value "OCCURRENCES" in the list of services passed in an
    * analysis.setSubscriptions request.
    *
    * Parameters
    *
    * file ( FilePath )
    *
    *   The file in which the references occur.
    *
-   * occurrences ( List<Occurrences> )
+   * occurrences ( optional List<Occurrences> )
    *
    *   The occurrences of references to elements within the file.
    */
   Stream onAnalysisOccurrences;
 
   /**
    * Stream controller for [onAnalysisOccurrences].
    */
   StreamController _onAnalysisOccurrences;
 
@@ skipping 27 matching lines @@
    * This notification is not subscribed to by default. Clients can subscribe
    * by including the value "OVERRIDES" in the list of services passed in an
    * analysis.setSubscriptions request.
    *
    * Parameters
    *
    * file ( FilePath )
    *
    *   The file with which the overrides are associated.
    *
-   * overrides ( List<Override> )
+   * overrides ( optional List<Override> )
    *
    *   The overrides associated with the file.
    */
   Stream onAnalysisOverrides;
 
   /**
    * Stream controller for [onAnalysisOverrides].
    */
   StreamController _onAnalysisOverrides;
 
@@ skipping 51 matching lines @@
    *   there was a portion of an identifier before the original offset. In
    *   particular, the replacementOffset will be the offset of the beginning of
    *   said identifier.
    *
    * replacementLength ( int )
    *
    *   The length of the text to be replaced if the remainder of the identifier
    *   containing the cursor is to be replaced when the suggestion is applied
    *   (that is, the number of characters in the existing identifier).
    *
-   * results ( List<CompletionSuggestion> )
+   * results ( optional List<CompletionSuggestion> )
    *
    *   The completion suggestions being reported. The notification contains all
    *   possible completions at the requested cursor position, even those that
    *   do not match the characters the user has already typed. This allows the
    *   client to respond to further keystrokes from the user without having to
    *   make additional requests.
    *
    * last ( bool )
    *
    *   True if this is that last set of results that will be returned for the
@@ skipping 216 matching lines @@
    * Unlike other notifications, this notification contains search results that
    * should be added to any previously received search results associated with
    * the same search id.
    *
    * Parameters
    *
    * id ( SearchId )
    *
    *   The id associated with the search.
    *
-   * results ( List<SearchResult> )
+   * results ( optional List<SearchResult> )
    *
    *   The search results being reported.
    *
    * last ( bool )
    *
    *   True if this is that last set of results that will be returned for the
    *   indicated search.
    */
   Stream onSearchResults;
 
@@ skipping 17 matching lines @@
    * offset ( int )
    *
    *   The offset of the code for which assists are being requested.
    *
    * length ( int )
    *
    *   The length of the code for which assists are being requested.
    *
    * Returns
    *
-   * assists ( List<SourceChange> )
+   * assists ( optional List<SourceChange> )
    *
    *   The assists that are available at the given location.
    */
   Future sendEditGetAssists(String file, int offset, int length, {bool checkTypes: true}) {
     Map<String, dynamic> params = {};
     params["file"] = file;
     params["offset"] = offset;
     params["length"] = length;
     if (checkTypes) {
       expect(params, isEditGetAssistsParams);
@@ skipping 20 matching lines @@
    * offset ( int )
    *
    *   The offset of the code on which the refactoring would be based.
    *
    * length ( int )
    *
    *   The length of the code on which the refactoring would be based.
    *
    * Returns
    *
-   * kinds ( List<RefactoringKind> )
+   * kinds ( optional List<RefactoringKind> )
    *
    *   The kinds of refactorings that are valid for the given selection.
    */
   Future sendEditGetAvailableRefactorings(String file, int offset, int length, {bool checkTypes: true}) {
     Map<String, dynamic> params = {};
     params["file"] = file;
     params["offset"] = offset;
     params["length"] = length;
     if (checkTypes) {
       expect(params, isEditGetAvailableRefactoringsParams);
@@ skipping 16 matching lines @@
    * file ( FilePath )
    *
    *   The file containing the errors for which fixes are being requested.
    *
    * offset ( int )
    *
    *   The offset used to select the errors for which fixes will be returned.
    *
    * Returns
    *
-   * fixes ( List<ErrorFixes> )
+   * fixes ( optional List<ErrorFixes> )
    *
    *   The fixes that are available for each of the analysis errors. There is a
    *   one-to-one correspondence between the analysis errors in the request and
    *   the lists of changes in the response. In particular, it is always the
    *   case that errors.length == fixes.length and that fixes[i] is the list of
    *   fixes for the error in errors[i]. The list of changes corresponding to
    *   an error can be empty if there are no fixes available for that error.
    */
   Future sendEditGetFixes(String file, int offset, {bool checkTypes: true}) {
     Map<String, dynamic> params = {};
@@ skipping 40 matching lines @@
    * options ( optional object )
    *
    *   Data used to provide values provided by the user. The structure of the
    *   data is dependent on the kind of refactoring being performed. The data
    *   that is expected is documented in the section titled Refactorings,
    *   labeled as “Options”. This field can be omitted if the refactoring does
    *   not require any options or if the values of those options are not known.
    *
    * Returns
    *
-   * status ( List<RefactoringProblem> )
+   * status ( optional List<RefactoringProblem> )
    *
    *   The status of the refactoring. The array will be empty if there are no
    *   known problems.
    *
    * feedback ( optional object )
    *
    *   Data used to provide feedback to the user. The structure of the data is
    *   dependent on the kind of refactoring being created. The data that is
    *   returned is documented in the section titled Refactorings, labeled as
    *   “Feedback”.
@@ skipping 153 matching lines @@
   /**
    * Subscribe for services. All previous subscriptions are replaced by the
    * given set of services.
    *
    * It is an error if any of the elements in the list are not valid services.
    * If there is an error, then the current subscriptions will remain
    * unchanged.
    *
    * Parameters
    *
-   * subscriptions ( List<DebugService> )
+   * subscriptions ( optional List<DebugService> )
    *
    *   A list of the services being subscribed to.
    */
-  Future sendDebugSetSubscriptions(List<String> subscriptions, {bool checkTypes: true}) {
+  Future sendDebugSetSubscriptions({List<String> subscriptions, bool checkTypes: true}) {
     Map<String, dynamic> params = {};
-    params["subscriptions"] = subscriptions;
+    if (subscriptions != null) {
+      params["subscriptions"] = subscriptions;
+    }
     if (checkTypes) {
       expect(params, isDebugSetSubscriptionsParams);
     }
     return server.send("debug.setSubscriptions", params)
         .then((result) {
       if (checkTypes) {
         expect(result, isDebugSetSubscriptionsResult);
       }
       return result;
     });
   }
 
   /**
    * Reports information needed to allow applications within the given context
    * to be launched.
    *
    * This notification is not subscribed to by default. Clients can subscribe
    * by including the value "LAUNCH_DATA" in the list of services passed in a
    * debug.setSubscriptions request.
    *
    * Parameters
    *
-   * executables ( List<ExecutableFile> )
+   * executables ( optional List<ExecutableFile> )
    *
    *   A list of the files that are executable in the given context. This list
    *   replaces any previous list provided for the given context.
    *
    * dartToHtml ( Map<FilePath, List<FilePath>> )
    *
    *   A mapping from the paths of Dart files that are referenced by HTML files
    *   to a list of the HTML files that reference the Dart files.
    *
    * htmlToDart ( Map<FilePath, List<FilePath>> )
@@ skipping 104 matching lines @@
       case "debug.launchData":
         expect(params, isDebugLaunchDataParams);
         _onDebugLaunchData.add(params);
         break;
       default:
         fail('Unexpected notification: $event');
         break;
     }
   }
 }