Wait for analysis in search domain. Rewrite with async/await.

pkg/analysis_server/lib/src/search/search_domain.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 search.domain;
 
+import 'dart:async';
+
 import 'package:analysis_server/src/analysis_server.dart';
 import 'package:analysis_server/src/constants.dart';
 import 'package:analysis_server/src/protocol_server.dart' as protocol;
 import 'package:analysis_server/src/search/element_references.dart';
 import 'package:analysis_server/src/search/type_hierarchy.dart';
 import 'package:analysis_server/src/services/search/search_engine.dart';
 import 'package:analyzer/src/generated/element.dart';
 
 /**
  * Instances of the class [SearchDomainHandler] implement a [RequestHandler]
@@ skipping 15 matching lines @@
    */
   int _nextSearchId = 0;
 
   /**
    * Initialize a newly created handler to handle requests for the given [server].
    */
   SearchDomainHandler(this.server) {
     searchEngine = server.searchEngine;
   }
 
-  protocol.Response findElementReferences(protocol.Request request) {
+  Future findElementReferences(protocol.Request request) async {
     var params =
         new protocol.SearchFindElementReferencesParams.fromRequest(request);
+    await server.onAnalysisComplete;

[Brian Wilkerson, 2015/02/03 21:49:20]

Do we also need to wait for indexing to be complete?

[scheglov, 2015/02/03 21:51:19]

We wait for all analysis operations, including analysis itself, indexing and (if
subscribed) notifications.

     // prepare elements
     List<Element> elements =
         server.getElementsAtOffset(params.file, params.offset);
     elements = elements.map((Element element) {
       if (element is ImportElement) {
         return element.prefix;
       }
       if (element is FieldFormalParameterElement) {
         return element.field;
       }
       if (element is PropertyAccessorElement) {
         return element.variable;
       }
       return element;
     }).where((Element element) {
       return element != null;
     }).toList();
-    // schedule search
+    // search
     String searchId = (_nextSearchId++).toString();
-    elements.forEach((Element element) {
+    elements.forEach((Element element) async {
       var computer = new ElementReferencesComputer(searchEngine);
-      var future = computer.compute(element, params.includePotential);
-      future.then((List<protocol.SearchResult> results) {
-        bool isLast = identical(element, elements.last);
-        _sendSearchNotification(searchId, isLast, results);
-      });
+      List<protocol.SearchResult> results =
+          await computer.compute(element, params.includePotential);
+      bool isLast = identical(element, elements.last);
+      _sendSearchNotification(searchId, isLast, results);
     });
     // respond
     var result = new protocol.SearchFindElementReferencesResult();
     if (elements.isNotEmpty) {
       result.id = searchId;
       result.element = protocol.newElement_fromEngine(elements[0]);
     }
-    return result.toResponse(request.id);
+    _sendSearchResult(request, result);
   }
 
-  protocol.Response findMemberDeclarations(protocol.Request request) {
+  Future findMemberDeclarations(protocol.Request request) async {
     var params =
         new protocol.SearchFindMemberDeclarationsParams.fromRequest(request);
-    // schedule search
+    await server.onAnalysisComplete;
+    // respond
     String searchId = (_nextSearchId++).toString();
-    {
-      var matchesFuture = searchEngine.searchMemberDeclarations(params.name);
-      matchesFuture.then((List<SearchMatch> matches) {
-        _sendSearchNotification(searchId, true, matches.map(toResult));
-      });
-    }
-    // respond
-    return new protocol.SearchFindMemberDeclarationsResult(
-        searchId).toResponse(request.id);
+    _sendSearchResult(
+        request,
+        new protocol.SearchFindMemberDeclarationsResult(searchId));
+    // search
+    List<SearchMatch> matches =
+        await searchEngine.searchMemberDeclarations(params.name);
+    _sendSearchNotification(searchId, true, matches.map(toResult));
   }
 
-  protocol.Response findMemberReferences(protocol.Request request) {
+  Future findMemberReferences(protocol.Request request) async {
     var params =
         new protocol.SearchFindMemberReferencesParams.fromRequest(request);
-    // schedule search
+    await server.onAnalysisComplete;
+    // respond
     String searchId = (_nextSearchId++).toString();
-    {
-      var matchesFuture = searchEngine.searchMemberReferences(params.name);
-      matchesFuture.then((List<SearchMatch> matches) {
-        _sendSearchNotification(searchId, true, matches.map(toResult));
-      });
-    }
-    // respond
-    return new protocol.SearchFindMemberReferencesResult(
-        searchId).toResponse(request.id);
+    _sendSearchResult(
+        request,
+        new protocol.SearchFindMemberReferencesResult(searchId));
+    // search
+    List<SearchMatch> matches =
+        await searchEngine.searchMemberReferences(params.name);
+    _sendSearchNotification(searchId, true, matches.map(toResult));
   }
 
-  protocol.Response findTopLevelDeclarations(protocol.Request request) {
+  Future findTopLevelDeclarations(protocol.Request request) async {
     var params =
         new protocol.SearchFindTopLevelDeclarationsParams.fromRequest(request);
-    // schedule search
+    await server.onAnalysisComplete;
+    // respond
     String searchId = (_nextSearchId++).toString();
-    {
-      var matchesFuture =
-          searchEngine.searchTopLevelDeclarations(params.pattern);
-      matchesFuture.then((List<SearchMatch> matches) {
-        _sendSearchNotification(searchId, true, matches.map(toResult));
-      });
-    }
-    // respond
-    return new protocol.SearchFindTopLevelDeclarationsResult(
-        searchId).toResponse(request.id);
+    _sendSearchResult(
+        request,
+        new protocol.SearchFindTopLevelDeclarationsResult(searchId));
+    // search
+    List<SearchMatch> matches =
+        await searchEngine.searchTopLevelDeclarations(params.pattern);
+    _sendSearchNotification(searchId, true, matches.map(toResult));
   }
 
   /**
    * Implement the `search.getTypeHierarchy` request.
    */
-  protocol.Response getTypeHierarchy(protocol.Request request) {
+  Future getTypeHierarchy(protocol.Request request) async {
     var params = new protocol.SearchGetTypeHierarchyParams.fromRequest(request);
+    await server.onAnalysisComplete;
     // prepare parameters
-    // prepare Element
     List<Element> elements =
         server.getElementsAtOffset(params.file, params.offset);
     if (elements.isEmpty) {
       protocol.Response response =
           new protocol.SearchGetTypeHierarchyResult().toResponse(request.id);
-      return response;
+      server.sendResponse(response);
     }
     Element element = elements.first;
     // prepare type hierarchy
     TypeHierarchyComputer computer = new TypeHierarchyComputer(searchEngine);
-    computer.compute(element).then((List<protocol.TypeHierarchyItem> items) {
-      protocol.Response response = new protocol.SearchGetTypeHierarchyResult(
-          hierarchyItems: items).toResponse(request.id);
-      server.sendResponse(response);
-    });
-    // delay response
-    return protocol.Response.DELAYED_RESPONSE;
+    List<protocol.TypeHierarchyItem> items = await computer.compute(element);
+    protocol.Response response = new protocol.SearchGetTypeHierarchyResult(
+        hierarchyItems: items).toResponse(request.id);
+    server.sendResponse(response);
   }
 
   @override
   protocol.Response handleRequest(protocol.Request request) {
     try {
       String requestName = request.method;
       if (requestName == SEARCH_FIND_ELEMENT_REFERENCES) {
-        return findElementReferences(request);
+        findElementReferences(request);
+        return protocol.Response.DELAYED_RESPONSE;
       } else if (requestName == SEARCH_FIND_MEMBER_DECLARATIONS) {
-        return findMemberDeclarations(request);
+        findMemberDeclarations(request);
+        return protocol.Response.DELAYED_RESPONSE;
       } else if (requestName == SEARCH_FIND_MEMBER_REFERENCES) {
-        return findMemberReferences(request);
+        findMemberReferences(request);
+        return protocol.Response.DELAYED_RESPONSE;
       } else if (requestName == SEARCH_FIND_TOP_LEVEL_DECLARATIONS) {
-        return findTopLevelDeclarations(request);
+        findTopLevelDeclarations(request);
+        return protocol.Response.DELAYED_RESPONSE;
       } else if (requestName == SEARCH_GET_TYPE_HIERARCHY) {
-        return getTypeHierarchy(request);
+        getTypeHierarchy(request);
+        return protocol.Response.DELAYED_RESPONSE;
       }
     } on protocol.RequestFailure catch (exception) {
       return exception.response;
     }
     return null;
   }
 
   void _sendSearchNotification(String searchId, bool isLast,
       Iterable<protocol.SearchResult> results) {
     server.sendNotification(
         new protocol.SearchResultsParams(
             searchId,
             results.toList(),
             isLast).toNotification());
   }
 
+  /**
+   * Send a search response with the given [result] to the given [request].
+   */
+  void _sendSearchResult(protocol.Request request, result) {
+    protocol.Response response = result.toResponse(request.id);
+    server.sendResponse(response);
+  }
+
   static protocol.SearchResult toResult(SearchMatch match) {
     return protocol.newSearchResult_fromMatch(match);
   }
 }