Merge pull request swiftlang#39585 from ahoppen/pr/explicit-diags-request

[SourceKit] Add a dedicated request to retrieve the diagnostics of a file

Author: ahoppen

test/SourceKit/CompileNotifications/cursor-info.swift

@@ -1,4 +1,5 @@
 // RUN: %sourcekitd-test -req=track-compiles == -req=cursor %s -offset=0 -- %s | %FileCheck %s -check-prefix=COMPILE_1 --enable-yaml-compatibility
+// COMPILE_1: <empty cursor info; internal diagnostic: "Unable to resolve cursor info.">
 // COMPILE_1: {
 // COMPILE_1:  key.notification: source.notification.compile-will-start,
 // COMPILE_1:  key.filepath: "SOURCE_DIR{{.*}}cursor-info.swift",
@@ -8,6 +9,5 @@
 // COMPILE_1:   key.notification: source.notification.compile-did-finish,
 // COMPILE_1:   key.compileid: [[CID1]]
 // COMPILE_1: }
-// COMPILE_1: <empty cursor info; internal diagnostic: "Unable to resolve cursor info.">
 // COMPILE_1-NOT: compile-will-start
 // COMPILE_1-NOT: compile-did-finish

test/SourceKit/Diagnostics/diags.swift

@@ -0,0 +1,49 @@
+// Use -print-raw-response on the first request so we don't wait for semantic info which will never come.
+// RUN: %sourcekitd-test -req=open %s -req-opts=syntactic_only=1 -print-raw-response -- %s == \
+// RUN: -req=stats == \
+// RUN: -req=diags %s -print-raw-response -- %s == \
+// RUN: -req=stats == \
+// RUN: -req=diags %s -print-raw-response -- %s == \
+// RUN: -req=stats | %FileCheck %s
+
+func foo(y: String) {
+  foo(y: 1)
+}
+
+// We shouldn't build an AST for the syntactic open
+// CHECK: 0 {{.*}} source.statistic.num-ast-builds
+
+// Retrieving diagnostics should workd
+// CHECK: {
+// CHECK:   key.diagnostics: [
+// CHECK:     {
+// CHECK:       key.line: 10,
+// CHECK:       key.column: 10,
+// CHECK:       key.filepath: "{{.*}}",
+// CHECK:       key.severity: source.diagnostic.severity.error,
+// CHECK:       key.id: "cannot_convert_argument_value",
+// CHECK:       key.description: "cannot convert value of type 'Int' to expected argument type 'String'"
+// CHECK:     }
+// CHECK:   ]
+// CHECK: }
+
+// ... and we should have built an AST for it
+// CHECK: 1 {{.*}} source.statistic.num-ast-builds
+
+// Retrieving diagnostics again should workd
+// CHECK: {
+// CHECK:   key.diagnostics: [
+// CHECK:     {
+// CHECK:       key.line: 10,
+// CHECK:       key.column: 10,
+// CHECK:       key.filepath: "{{.*}}",
+// CHECK:       key.severity: source.diagnostic.severity.error,
+// CHECK:       key.id: "cannot_convert_argument_value",
+// CHECK:       key.description: "cannot convert value of type 'Int' to expected argument type 'String'"
+// CHECK:     }
+// CHECK:   ]
+// CHECK: }
+
+// ... but we shouldn't rebuild an AST
+// CHECK: 1 {{.*}} source.statistic.num-ast-builds
+// CHECK: 1 {{.*}} source.statistic.num-ast-cache-hits

tools/SourceKit/include/SourceKit/Core/LangSupport.h

@@ -500,6 +500,9 @@ struct CursorInfoData {
   llvm::ArrayRef<RefactoringInfo> AvailableActions;
 };
 
+/// The result type of `LangSupport::getDiagnostics`
+typedef ArrayRef<DiagnosticEntryInfo> DiagnosticsResult;
+
 struct RangeInfo {
   UIdent RangeKind;
   StringRef ExprType;
@@ -832,6 +835,13 @@ class LangSupport {
       SourceKitCancellationToken CancellationToken,
       std::function<void(const RequestResult<CursorInfoData> &)> Receiver) = 0;
 
+  virtual void
+  getDiagnostics(StringRef InputFile, ArrayRef<const char *> Args,
+                 Optional<VFSOptions> VfsOptions,
+                 SourceKitCancellationToken CancellationToken,
+                 std::function<void(const RequestResult<DiagnosticsResult> &)>
+                     Receiver) = 0;
+
   virtual void
   getNameInfo(StringRef Filename, unsigned Offset, NameTranslatingInfo &Input,
               ArrayRef<const char *> Args,

tools/SourceKit/include/SourceKit/Support/FileSystemProvider.h

@@ -13,6 +13,7 @@
 #ifndef LLVM_SOURCEKIT_SUPPORT_FILESYSTEMPROVIDER_H
 #define LLVM_SOURCEKIT_SUPPORT_FILESYSTEMPROVIDER_H
 
+#include "SourceKit/Core/LangSupport.h"
 #include "llvm/ADT/IntrusiveRefCntPtr.h"
 #include "llvm/ADT/SmallVector.h"
 #include "llvm/ADT/StringMap.h"

tools/SourceKit/lib/SwiftLang/SwiftLangSupport.h

@@ -569,6 +569,13 @@ class SwiftLangSupport : public LangSupport {
                      std::function<void(const RequestResult<CursorInfoData> &)>
                          Receiver) override;
 
+  void
+  getDiagnostics(StringRef InputFile, ArrayRef<const char *> Args,
+                 Optional<VFSOptions> VfsOptions,
+                 SourceKitCancellationToken CancellationToken,
+                 std::function<void(const RequestResult<DiagnosticsResult> &)>
+                     Receiver) override;
+
   void getNameInfo(
       StringRef Filename, unsigned Offset, NameTranslatingInfo &Input,
       ArrayRef<const char *> Args, SourceKitCancellationToken CancellationToken,

tools/SourceKit/lib/SwiftLang/SwiftSourceDocInfo.cpp

@@ -10,12 +10,13 @@
 //
 //===----------------------------------------------------------------------===//
 
-#include "SwiftASTManager.h"
-#include "SwiftLangSupport.h"
 #include "SourceKit/Support/FileSystemProvider.h"
 #include "SourceKit/Support/ImmutableTextBuffer.h"
 #include "SourceKit/Support/Logging.h"
 #include "SourceKit/Support/UIdent.h"
+#include "SwiftASTManager.h"
+#include "SwiftEditorDiagConsumer.h"
+#include "SwiftLangSupport.h"
 
 #include "swift/AST/ASTDemangler.h"
 #include "swift/AST/ASTPrinter.h"
@@ -1588,6 +1589,36 @@ static void resolveCursor(
                                         CancellationToken, fileSystem);
 }
 
+static void computeDiagnostics(
+    SwiftLangSupport &Lang, StringRef InputFile, SwiftInvocationRef Invok,
+    llvm::IntrusiveRefCntPtr<llvm::vfs::FileSystem> FileSystem,
+    SourceKitCancellationToken CancellationToken,
+    std::function<void(const RequestResult<DiagnosticsResult> &)> Receiver) {
+
+  class DiagnosticsConsumer : public SwiftASTConsumer {
+    std::function<void(const RequestResult<DiagnosticsResult> &)> Receiver;
+
+  public:
+    DiagnosticsConsumer(
+        std::function<void(const RequestResult<DiagnosticsResult> &)> Receiver)
+        : Receiver(Receiver) {}
+
+    void handlePrimaryAST(ASTUnitRef AstUnit) override {
+      unsigned BufferID =
+          AstUnit->getPrimarySourceFile().getBufferID().getValue();
+      auto &DiagConsumer = AstUnit->getEditorDiagConsumer();
+      auto Diagnostics = DiagConsumer.getDiagnosticsForBuffer(BufferID);
+      Receiver(RequestResult<DiagnosticsResult>::fromResult(Diagnostics));
+    }
+  };
+
+  auto Consumer = std::make_shared<DiagnosticsConsumer>(std::move(Receiver));
+
+  Lang.getASTManager()->processASTAsync(Invok, std::move(Consumer),
+                                        /*OncePerASTToken=*/nullptr,
+                                        CancellationToken, FileSystem);
+}
+
 static void resolveName(
     SwiftLangSupport &Lang, StringRef InputFile, unsigned Offset,
     SwiftInvocationRef Invok, bool TryExistingAST, NameTranslatingInfo &Input,
@@ -1846,6 +1877,33 @@ void SwiftLangSupport::getCursorInfo(
                 fileSystem, CancellationToken, Receiver);
 }
 
+void SwiftLangSupport::getDiagnostics(
+    StringRef InputFile, ArrayRef<const char *> Args,
+    Optional<VFSOptions> VfsOptions,
+    SourceKitCancellationToken CancellationToken,
+    std::function<void(const RequestResult<DiagnosticsResult> &)> Receiver) {
+  std::string FileSystemError;
+  auto FileSystem = getFileSystem(VfsOptions, InputFile, FileSystemError);
+  if (!FileSystem) {
+    Receiver(RequestResult<DiagnosticsResult>::fromError(FileSystemError));
+    return;
+  }
+
+  std::string InvocationError;
+  SwiftInvocationRef Invok =
+      ASTMgr->getInvocation(Args, InputFile, FileSystem, InvocationError);
+  if (!InvocationError.empty()) {
+    LOG_WARN_FUNC("error creating ASTInvocation: " << InvocationError);
+  }
+  if (!Invok) {
+    Receiver(RequestResult<DiagnosticsResult>::fromError(InvocationError));
+    return;
+  }
+
+  computeDiagnostics(*this, InputFile, Invok, FileSystem, CancellationToken,
+                     Receiver);
+}
+
 void SwiftLangSupport::getRangeInfo(
     StringRef InputFile, unsigned Offset, unsigned Length,
     bool CancelOnSubsequentRequest, ArrayRef<const char *> Args,

tools/SourceKit/tools/complete-test/complete-test.cpp

@@ -568,6 +568,7 @@ class ResponsePrinter {
 static void printResponse(sourcekitd_response_t resp, bool raw, bool structure,
                           unsigned indentation) {
   if (raw) {
+    llvm::outs().flush();
     sourcekitd_response_description_dump_filedesc(resp, STDOUT_FILENO);
     return;
   }

tools/SourceKit/tools/sourcekitd-test/TestOptions.cpp

@@ -150,6 +150,7 @@ bool TestOptions::parseArgs(llvm::ArrayRef<const char *> Args) {
         .Case("collect-var-type", SourceKitRequest::CollectVariableType)
         .Case("global-config", SourceKitRequest::GlobalConfiguration)
         .Case("dependency-updated", SourceKitRequest::DependencyUpdated)
+        .Case("diags", SourceKitRequest::Diagnostics)
 #define SEMANTIC_REFACTORING(KIND, NAME, ID) .Case("refactoring." #ID, SourceKitRequest::KIND)
 #include "swift/IDE/RefactoringKinds.def"
         .Default(SourceKitRequest::None);

tools/SourceKit/tools/sourcekitd-test/TestOptions.h

@@ -67,6 +67,7 @@ enum class SourceKitRequest {
   CollectVariableType,
   GlobalConfiguration,
   DependencyUpdated,
+  Diagnostics,
 #define SEMANTIC_REFACTORING(KIND, NAME, ID) KIND,
 #include "swift/IDE/RefactoringKinds.def"
 };