Merge pull request #1930 from ahoppen/inject-indexstoredb

Add a hook to inject an `IndexStoreDB` instance into `SourceKitLSPServer`

Author: ahoppen

Sources/BuildSystemIntegration/BuildSystemTestHooks.swift renamed to Sources/BuildSystemIntegration/BuildSystemHooks.swift

@@ -1,10 +1,10 @@
 
 add_library(BuildSystemIntegration STATIC
   BuildSettingsLogger.swift
+  BuildSystemHooks.swift
   BuildSystemManager.swift
   BuildSystemManagerDelegate.swift
   BuildSystemMessageDependencyTracker.swift
-  BuildSystemTestHooks.swift
   BuildTargetIdentifierExtensions.swift
   BuiltInBuildSystem.swift
   BuiltInBuildSystemAdapter.swift
@@ -17,7 +17,6 @@ add_library(BuildSystemIntegration STATIC
   JSONCompilationDatabaseBuildSystem.swift
   LegacyBuildServerBuildSystem.swift
   MainFilesProvider.swift
-  PathPrefixMapping.swift
   PrefixMessageWithTaskEmoji.swift
   SplitShellCommand.swift
   SwiftPMBuildSystem.swift

Sources/BuildSystemIntegration/CMakeLists.txt

@@ -3,7 +3,7 @@ add_library(SemanticIndex STATIC
   CheckedIndex.swift
   CompilerCommandLineOption.swift
   IndexTaskDescription.swift
-  IndexTestHooks.swift
+  IndexHooks.swift
   PreparationTaskDescription.swift
   SemanticIndexManager.swift
   TaskScheduler.swift

Sources/BuildSystemIntegration/PathPrefixMapping.swift

@@ -10,8 +10,30 @@
 //
 //===----------------------------------------------------------------------===//
 
+#if compiler(>=6)
+package import IndexStoreDB
+package import Foundation
+#else
+import IndexStoreDB
+import Foundation
+#endif
+
+/// When running SourceKit-LSP in-process, allows the creator of `SourceKitLSPServer` to provide the `IndexStoreDB`
+/// instead of SourceKit-LSP creating the instance when needed.
+package protocol IndexInjector: Sendable {
+  func createIndex(
+    storePath: URL,
+    databasePath: URL,
+    indexStoreLibraryPath: URL,
+    delegate: IndexDelegate,
+    prefixMappings: [PathMapping]
+  ) async throws -> IndexStoreDB
+}
+
 /// Callbacks that allow inspection of internal state modifications during testing.
-package struct IndexTestHooks: Sendable {
+package struct IndexHooks: Sendable {
+  package var indexInjector: IndexInjector?
+
   package var buildGraphGenerationDidStart: (@Sendable () async -> Void)?
 
   package var buildGraphGenerationDidFinish: (@Sendable () async -> Void)?
@@ -26,13 +48,15 @@ package struct IndexTestHooks: Sendable {
   package var updateIndexStoreTaskDidFinish: (@Sendable (UpdateIndexStoreTaskDescription) async -> Void)?
 
   package init(
+    indexInjector: IndexInjector? = nil,
     buildGraphGenerationDidStart: (@Sendable () async -> Void)? = nil,
     buildGraphGenerationDidFinish: (@Sendable () async -> Void)? = nil,
     preparationTaskDidStart: (@Sendable (PreparationTaskDescription) async -> Void)? = nil,
     preparationTaskDidFinish: (@Sendable (PreparationTaskDescription) async -> Void)? = nil,
     updateIndexStoreTaskDidStart: (@Sendable (UpdateIndexStoreTaskDescription) async -> Void)? = nil,
     updateIndexStoreTaskDidFinish: (@Sendable (UpdateIndexStoreTaskDescription) async -> Void)? = nil
   ) {
+    self.indexInjector = indexInjector
     self.buildGraphGenerationDidStart = buildGraphGenerationDidStart
     self.buildGraphGenerationDidFinish = buildGraphGenerationDidFinish
     self.preparationTaskDidStart = preparationTaskDidStart

Sources/SemanticIndex/CMakeLists.txt

@@ -55,8 +55,8 @@ package struct PreparationTaskDescription: IndexTaskDescription {
   /// See `SemanticIndexManager.logMessageToIndexLog`.
   private let logMessageToIndexLog: @Sendable (_ taskID: String, _ message: String) -> Void
 
-  /// Test hooks that should be called when the preparation task finishes.
-  private let testHooks: IndexTestHooks
+  /// Hooks that should be called when the preparation task finishes.
+  private let hooks: IndexHooks
 
   /// The task is idempotent because preparing the same target twice produces the same result as preparing it once.
   package var isIdempotent: Bool { true }
@@ -76,13 +76,13 @@ package struct PreparationTaskDescription: IndexTaskDescription {
     buildSystemManager: BuildSystemManager,
     preparationUpToDateTracker: UpToDateTracker<BuildTargetIdentifier>,
     logMessageToIndexLog: @escaping @Sendable (_ taskID: String, _ message: String) -> Void,
-    testHooks: IndexTestHooks
+    hooks: IndexHooks
   ) {
     self.targetsToPrepare = targetsToPrepare
     self.buildSystemManager = buildSystemManager
     self.preparationUpToDateTracker = preparationUpToDateTracker
     self.logMessageToIndexLog = logMessageToIndexLog
-    self.testHooks = testHooks
+    self.hooks = hooks
   }
 
   package func execute() async {
@@ -96,7 +96,7 @@ package struct PreparationTaskDescription: IndexTaskDescription {
       if targetsToPrepare.isEmpty {
         return
       }
-      await testHooks.preparationTaskDidStart?(self)
+      await hooks.preparationTaskDidStart?(self)
 
       let targetsToPrepareDescription = targetsToPrepare.map(\.uri.stringValue).joined(separator: ", ")
       logger.log(
@@ -119,7 +119,7 @@ package struct PreparationTaskDescription: IndexTaskDescription {
           "Preparation failed: \(error.forLogging)"
         )
       }
-      await testHooks.preparationTaskDidFinish?(self)
+      await hooks.preparationTaskDidFinish?(self)
       if !Task.isCancelled {
         await preparationUpToDateTracker.markUpToDate(targetsToPrepare, updateOperationStartDate: startDate)
       }

Sources/SemanticIndex/IndexTestHooks.swift renamed to Sources/SemanticIndex/IndexHooks.swift

@@ -160,7 +160,7 @@ package final actor SemanticIndexManager {
   /// an expression for a long time.
   package var updateIndexStoreTimeout: Duration
 
-  private let testHooks: IndexTestHooks
+  private let hooks: IndexHooks
 
   /// The tasks to generate the build graph (resolving package dependencies, generating the build description,
   /// ...) and to schedule indexing of modified tasks.
@@ -237,7 +237,7 @@ package final actor SemanticIndexManager {
     index: UncheckedIndex,
     buildSystemManager: BuildSystemManager,
     updateIndexStoreTimeout: Duration,
-    testHooks: IndexTestHooks,
+    hooks: IndexHooks,
     indexTaskScheduler: TaskScheduler<AnyIndexTaskDescription>,
     logMessageToIndexLog: @escaping @Sendable (_ taskID: String, _ message: String) -> Void,
     indexTasksWereScheduled: @escaping @Sendable (Int) -> Void,
@@ -246,7 +246,7 @@ package final actor SemanticIndexManager {
     self.index = index
     self.buildSystemManager = buildSystemManager
     self.updateIndexStoreTimeout = updateIndexStoreTimeout
-    self.testHooks = testHooks
+    self.hooks = hooks
     self.indexTaskScheduler = indexTaskScheduler
     self.logMessageToIndexLog = logMessageToIndexLog
     self.indexTasksWereScheduled = indexTasksWereScheduled
@@ -278,12 +278,12 @@ package final actor SemanticIndexManager {
     let taskId = UUID()
     let generateBuildGraphTask = Task(priority: .low) {
       await withLoggingSubsystemAndScope(subsystem: indexLoggingSubsystem, scope: "build-graph-generation") {
-        await testHooks.buildGraphGenerationDidStart?()
+        await hooks.buildGraphGenerationDidStart?()
         await self.buildSystemManager.waitForUpToDateBuildGraph()
         // Ensure that we have an up-to-date indexstore-db. Waiting for the indexstore-db to be updated is cheaper than
         // potentially not knowing about unit files, which causes the corresponding source files to be re-indexed.
         index.pollForUnitChangesAndWait()
-        await testHooks.buildGraphGenerationDidFinish?()
+        await hooks.buildGraphGenerationDidFinish?()
         // TODO: Ideally this would be a type like any Collection<DocumentURI> & Sendable but that doesn't work due to
         // https://github.com/swiftlang/swift/issues/75602
         var filesToIndex: [DocumentURI] =
@@ -519,7 +519,7 @@ package final actor SemanticIndexManager {
         buildSystemManager: self.buildSystemManager,
         preparationUpToDateTracker: preparationUpToDateTracker,
         logMessageToIndexLog: logMessageToIndexLog,
-        testHooks: testHooks
+        hooks: hooks
       )
     )
     if Task.isCancelled {
@@ -581,7 +581,7 @@ package final actor SemanticIndexManager {
         indexFilesWithUpToDateUnit: indexFilesWithUpToDateUnit,
         logMessageToIndexLog: logMessageToIndexLog,
         timeout: updateIndexStoreTimeout,
-        testHooks: testHooks
+        hooks: hooks
       )
     )
 

Sources/SemanticIndex/PreparationTaskDescription.swift

@@ -146,7 +146,7 @@ package struct UpdateIndexStoreTaskDescription: IndexTaskDescription {
   private let timeout: Duration
 
   /// Test hooks that should be called when the index task finishes.
-  private let testHooks: IndexTestHooks
+  private let hooks: IndexHooks
 
   /// The task is idempotent because indexing the same file twice produces the same result as indexing it once.
   package var isIdempotent: Bool { true }
@@ -173,7 +173,7 @@ package struct UpdateIndexStoreTaskDescription: IndexTaskDescription {
     indexFilesWithUpToDateUnit: Bool,
     logMessageToIndexLog: @escaping @Sendable (_ taskID: String, _ message: String) -> Void,
     timeout: Duration,
-    testHooks: IndexTestHooks
+    hooks: IndexHooks
   ) {
     self.filesToIndex = filesToIndex
     self.buildSystemManager = buildSystemManager
@@ -182,7 +182,7 @@ package struct UpdateIndexStoreTaskDescription: IndexTaskDescription {
     self.indexFilesWithUpToDateUnit = indexFilesWithUpToDateUnit
     self.logMessageToIndexLog = logMessageToIndexLog
     self.timeout = timeout
-    self.testHooks = testHooks
+    self.hooks = hooks
   }
 
   package func execute() async {
@@ -192,7 +192,7 @@ package struct UpdateIndexStoreTaskDescription: IndexTaskDescription {
     await withLoggingSubsystemAndScope(subsystem: indexLoggingSubsystem, scope: "update-indexstore-\(id % 100)") {
       let startDate = Date()
 
-      await testHooks.updateIndexStoreTaskDidStart?(self)
+      await hooks.updateIndexStoreTaskDidStart?(self)
 
       let filesToIndexDescription = filesToIndex.map {
         $0.file.sourceFile.fileURL?.lastPathComponent ?? $0.file.sourceFile.stringValue
@@ -207,7 +207,7 @@ package struct UpdateIndexStoreTaskDescription: IndexTaskDescription {
       for file in filesToIndex {
         await updateIndexStore(forSingleFile: file.file, in: file.target)
       }
-      await testHooks.updateIndexStoreTaskDidFinish?(self)
+      await hooks.updateIndexStoreTaskDidFinish?(self)
       logger.log(
         "Finished updating index store in \(Date().timeIntervalSince(startDate) * 1000, privacy: .public)ms: \(filesToIndexDescription)"
       )

Sources/SemanticIndex/SemanticIndexManager.swift

@@ -3,6 +3,7 @@ add_library(SourceKitLSP STATIC
   CapabilityRegistry.swift
   DocumentManager.swift
   DocumentSnapshot+FromFileContents.swift
+  Hooks.swift
   IndexProgressManager.swift
   IndexStoreDB+MainFilesProvider.swift
   LanguageServerType.swift
@@ -16,7 +17,6 @@ add_library(SourceKitLSP STATIC
   SourceKitLSPServer.swift
   SymbolLocation+DocumentURI.swift
   TestDiscovery.swift
-  TestHooks.swift
   TextEdit+IsNoop.swift
   Workspace.swift
 )

Sources/SemanticIndex/UpdateIndexStoreTaskDescription.swift

@@ -32,7 +32,7 @@ import struct TSCBasic.RelativePath
 
 /// Closures can be used to inspect or modify internal behavior in SourceKit-LSP.
 public struct Hooks: Sendable {
-  package var indexTestHooks: IndexTestHooks
+  package var indexHooks: IndexHooks
 
   package var buildSystemHooks: BuildSystemHooks
 
@@ -42,15 +42,15 @@ public struct Hooks: Sendable {
   package var preHandleRequest: (@Sendable (any RequestType) async -> Void)?
 
   public init() {
-    self.init(indexTestHooks: IndexTestHooks(), buildSystemHooks: BuildSystemHooks())
+    self.init(indexHooks: IndexHooks(), buildSystemHooks: BuildSystemHooks())
   }
 
   package init(
-    indexTestHooks: IndexTestHooks = IndexTestHooks(),
+    indexHooks: IndexHooks = IndexHooks(),
     buildSystemHooks: BuildSystemHooks = BuildSystemHooks(),
     preHandleRequest: (@Sendable (any RequestType) async -> Void)? = nil
   ) {
-    self.indexTestHooks = indexTestHooks
+    self.indexHooks = indexHooks
     self.buildSystemHooks = buildSystemHooks
     self.preHandleRequest = preHandleRequest
   }