Merge pull request swiftlang#31830 from DavidGoldman/compileopkind

[SourceKit] Include operation kind in compile notifications

Author: benlangmuir

test/SourceKit/CompileNotifications/arg-parsing.swift

@@ -4,6 +4,7 @@
 // ARG_PARSE_0:  key.notification: source.notification.compile-will-start
 // ARG_PARSE_0:  key.compileid: [[CID1:".*"]]
 // ARG_PARSE_0:  key.compilerargs-string: "{{.*}}.swift -no-such-arg"
+// ARG_PARSE_0:  key.compile_operation: source.compile.operation.code-completion
 // ARG_PARSE_0: }
 // ARG_PARSE_0: {
 // ARG_PARSE_0:   key.notification: source.notification.compile-did-finish
@@ -15,6 +16,7 @@
 // ARG_PARSE_0:     }
 // ARG_PARSE_0:   ]
 // ARG_PARSE_0:   key.compileid: [[CID1]]
+// ARG_PARSE_0:   key.compile_operation: source.compile.operation.code-completion
 // ARG_PARSE_0: }
 // ARG_PARSE_0-NOT: compile-will-start
 // ARG_PARSE_0-NOT: compile-did-finish

test/SourceKit/CompileNotifications/code-completion.swift

@@ -3,10 +3,12 @@
 // COMPILE_1:  key.notification: source.notification.compile-will-start,
 // COMPILE_1:  key.filepath: "{{.*}}SOURCE_DIR{{.*}}code-completion.swift",
 // COMPILE_1:  key.compileid: [[CID1:".*"]]
+// COMPILE_1:  key.compile_operation: source.compile.operation.code-completion
 // COMPILE_1: }
 // COMPILE_1: {
 // COMPILE_1:   key.notification: source.notification.compile-did-finish,
 // COMPILE_1:   key.compileid: [[CID1]]
+// COMPILE_1:   key.compile_operation: source.compile.operation.code-completion
 // COMPILE_1: }
 // COMPILE_1-NOT: compile-will-start
 // COMPILE_1-NOT: compile-did-finish

tools/SourceKit/tools/sourcekitd/lib/API/Requests.cpp

@@ -3181,6 +3181,21 @@ class CompileTrackingConsumer final : public trace::TraceConsumer {
 };
 } // end anonymous namespace
 
+static Optional<UIdent> getUIDForOperationKind(trace::OperationKind OpKind) {
+  static UIdent CompileOperationIndexSource("source.compile.operation.index-source");
+  static UIdent CompileOperationCodeCompletion("source.compile.operation.code-completion");
+  switch (OpKind) {
+    case trace::OperationKind::PerformSema:
+      return None;
+    case trace::OperationKind::IndexSource:
+      return CompileOperationIndexSource;
+    case trace::OperationKind::CodeCompletion:
+      return CompileOperationCodeCompletion;
+    default:
+      llvm_unreachable("Unknown operation kind");
+  }
+}
+
 void CompileTrackingConsumer::operationStarted(
     uint64_t OpId, trace::OperationKind OpKind,
     const trace::SwiftInvocation &Inv, const trace::StringPairs &OpArgs) {
@@ -3193,7 +3208,9 @@ void CompileTrackingConsumer::operationStarted(
   Dict.set(KeyNotification, CompileWillStartUID);
   Dict.set(KeyCompileID, std::to_string(OpId));
   Dict.set(KeyFilePath, Inv.Args.PrimaryFile);
-  // FIXME: OperationKind
+  if (auto OperationUID = getUIDForOperationKind(OpKind)) {
+    Dict.set(KeyCompileOperation, OperationUID.getValue());
+  }
   Dict.set(KeyCompilerArgsString, Inv.Args.Arguments);
   sourcekitd::postNotification(RespBuilder.createResponse());
 }
@@ -3209,6 +3226,9 @@ void CompileTrackingConsumer::operationFinished(
   auto Dict = RespBuilder.getDictionary();
   Dict.set(KeyNotification, CompileDidFinishUID);
   Dict.set(KeyCompileID, std::to_string(OpId));
+  if (auto OperationUID = getUIDForOperationKind(OpKind)) {
+    Dict.set(KeyCompileOperation, OperationUID.getValue());
+  }
   auto DiagArray = Dict.setArray(KeyDiagnostics);
   for (const auto &DiagInfo : Diagnostics) {
     fillDictionaryForDiagnosticInfo(DiagArray.appendDictionary(), DiagInfo);

utils/gyb_sourcekit_support/UIDs.py

@@ -182,6 +182,7 @@ def __init__(self, internal_name, external_name):
     KEY('CompletionCheckDependencyInterval',
         'key.completion_check_dependency_interval'),
     KEY('AnnotatedTypename', 'key.annotated.typename'),
+    KEY('CompileOperation', 'key.compile_operation'),
 ]