Create a SwiftUtilities module

ahoppen · ahoppen · commit 6996ee98179d · 2024-06-03T15:31:14.000-07:00
This allows us to share common Swift utility functions between SourceKit-LSP and LSPLogging.
diff --git a/Package.swift b/Package.swift
@@ -80,6 +80,7 @@ let package = Package(
         "SKSupport",
         "SourceKitD",
         "SourceKitLSP",
+        "SwiftUtilities",
         .product(name: "ArgumentParser", package: "swift-argument-parser"),
         .product(name: "SwiftIDEUtils", package: "swift-syntax"),
         .product(name: "SwiftSyntax", package: "swift-syntax"),
@@ -183,6 +184,7 @@ let package = Package(
         "LanguageServerProtocol",
         "LanguageServerProtocolJSONRPC",
         "SKSupport",
+        "SwiftUtilities",
       ]
     ),
 
@@ -195,6 +197,7 @@ let package = Package(
         "LanguageServerProtocol",
         "LSPLogging",
         "SKCore",
+        "SwiftUtilities",
         .product(name: "IndexStoreDB", package: "indexstore-db"),
       ],
       exclude: ["CMakeLists.txt"]
@@ -221,6 +224,7 @@ let package = Package(
         "LSPLogging",
         "SKSupport",
         "SourceKitD",
+        "SwiftUtilities",
         .product(name: "SwiftPMDataModel-auto", package: "swift-package-manager"),
         .product(name: "SwiftToolsSupport-auto", package: "swift-tools-support-core"),
       ],
@@ -246,6 +250,7 @@ let package = Package(
         .product(name: "SwiftToolsSupport-auto", package: "swift-tools-support-core"),
         "LanguageServerProtocol",
         "LSPLogging",
+        "SwiftUtilities",
       ],
       exclude: ["CMakeLists.txt"],
       swiftSettings: [.enableExperimentalFeature("StrictConcurrency")]
@@ -257,6 +262,7 @@ let package = Package(
         "LSPTestSupport",
         "SKSupport",
         "SKTestSupport",
+        "SwiftUtilities",
       ]
     ),
 
@@ -269,6 +275,7 @@ let package = Package(
         "LanguageServerProtocol",
         "LSPLogging",
         "SKCore",
+        "SwiftUtilities",
         .product(name: "SwiftPM-auto", package: "swift-package-manager"),
         .product(name: "SwiftToolsSupport-auto", package: "swift-tools-support-core"),
       ],
@@ -302,6 +309,7 @@ let package = Package(
         "LSPLogging",
         "SKCore",
         "SourceKitLSP",
+        "SwiftUtilities",
         .product(name: "ISDBTestSupport", package: "indexstore-db"),
         .product(name: "SwiftToolsSupport-auto", package: "swift-tools-support-core"),
       ],
@@ -319,6 +327,7 @@ let package = Package(
         "Csourcekitd",
         "LSPLogging",
         "SKSupport",
+        "SwiftUtilities",
         .product(name: "SwiftToolsSupport-auto", package: "swift-tools-support-core"),
       ],
       exclude: ["CMakeLists.txt", "sourcekitd_uids.swift.gyb"],
@@ -331,6 +340,7 @@ let package = Package(
         "SourceKitD",
         "SKCore",
         "SKTestSupport",
+        "SwiftUtilities",
       ]
     ),
 
@@ -349,6 +359,7 @@ let package = Package(
         "SKSupport",
         "SKSwiftPMWorkspace",
         "SourceKitD",
+        "SwiftUtilities",
         .product(name: "IndexStoreDB", package: "indexstore-db"),
         .product(name: "SwiftBasicFormat", package: "swift-syntax"),
         .product(name: "SwiftDiagnostics", package: "swift-syntax"),
@@ -387,6 +398,11 @@ let package = Package(
         .product(name: "SwiftSyntaxMacros", package: "swift-syntax"),
       ]
     ),
+
+    .target(
+      name: "SwiftUtilities",
+      exclude: ["CMakeLists.txt"]
+    ),
   ]
 )
 
diff --git a/Sources/CMakeLists.txt b/Sources/CMakeLists.txt
@@ -13,3 +13,4 @@ add_subdirectory(SKSwiftPMWorkspace)
 add_subdirectory(SourceKitLSP)
 add_subdirectory(SourceKitD)
 add_subdirectory(sourcekit-lsp)
+add_subdirectory(SwiftUtilities)
diff --git a/Sources/Diagnose/CMakeLists.txt b/Sources/Diagnose/CMakeLists.txt
@@ -29,6 +29,7 @@ target_link_libraries(Diagnose PUBLIC
   LSPLogging
   SKCore
   SourceKitD
+  SwiftUtilities
   ArgumentParser
   SwiftSyntax::SwiftIDEUtils
   SwiftSyntax::SwiftSyntax
diff --git a/Sources/Diagnose/IndexCommand.swift b/Sources/Diagnose/IndexCommand.swift
@@ -17,6 +17,7 @@ import LanguageServerProtocol
 import SKCore
 import SKSupport
 import SourceKitLSP
+import SwiftUtilities
 
 import struct TSCBasic.AbsolutePath
 import class TSCBasic.Process
diff --git a/Sources/LSPTestSupport/TestJSONRPCConnection.swift b/Sources/LSPTestSupport/TestJSONRPCConnection.swift
@@ -14,6 +14,7 @@ import InProcessClient
 import LanguageServerProtocol
 import LanguageServerProtocolJSONRPC
 import SKSupport
+import SwiftUtilities
 import XCTest
 
 import class Foundation.Pipe
diff --git a/Sources/SKCore/BuildServerBuildSystem.swift b/Sources/SKCore/BuildServerBuildSystem.swift
@@ -16,6 +16,7 @@ import LSPLogging
 import LanguageServerProtocol
 import LanguageServerProtocolJSONRPC
 import SKSupport
+import SwiftUtilities
 
 import struct TSCBasic.AbsolutePath
 import protocol TSCBasic.FileSystem
diff --git a/Sources/SKCore/CMakeLists.txt b/Sources/SKCore/CMakeLists.txt
@@ -28,5 +28,6 @@ target_link_libraries(SKCore PUBLIC
   LSPLogging
   SKSupport
   SourceKitD
+  SwiftUtilities
   PackageModel
   TSCBasic)
diff --git a/Sources/SKCore/TaskScheduler.swift b/Sources/SKCore/TaskScheduler.swift
@@ -14,6 +14,7 @@ import CAtomics
 import Foundation
 import LSPLogging
 import SKSupport
+import SwiftUtilities
 
 /// See comment on ``TaskDescriptionProtocol/dependencies(to:taskPriority:)``
 public enum TaskDependencyAction<TaskDescription: TaskDescriptionProtocol> {
diff --git a/Sources/SKCore/Toolchain.swift b/Sources/SKCore/Toolchain.swift
@@ -14,6 +14,7 @@ import LSPLogging
 import LanguageServerProtocol
 import RegexBuilder
 import SKSupport
+import SwiftUtilities
 
 import enum PackageLoading.Platform
 import struct TSCBasic.AbsolutePath
diff --git a/Sources/SKSupport/CMakeLists.txt b/Sources/SKSupport/CMakeLists.txt
@@ -1,11 +1,7 @@
 
 add_library(SKSupport STATIC
-  AsyncQueue.swift
-  AsyncUtils.swift
   BuildConfiguration.swift
   ByteString.swift
-  Collection+Only.swift
-  Collection+PartitionIntoBatches.swift
   Connection+Send.swift
   dlopen.swift
   DocumentURI+CustomLogStringConvertible.swift
@@ -15,16 +11,14 @@ add_library(SKSupport STATIC
   Process+WaitUntilExitWithCancellation.swift
   Random.swift
   Result.swift
-  Sequence+AsyncMap.swift
   SwitchableProcessResultExitStatus.swift
-  Task+WithPriorityChangedHandler.swift
-  ThreadSafeBox.swift
   WorkspaceType.swift
 )
 set_target_properties(SKSupport PROPERTIES
   INTERFACE_INCLUDE_DIRECTORIES ${CMAKE_Swift_MODULE_DIRECTORY})
 target_link_libraries(SKSupport PRIVATE
   LanguageServerProtocol
   LSPLogging
+  SwiftUtilities
   TSCBasic
   $<$<NOT:$<PLATFORM_ID:Darwin>>:Foundation>)
diff --git a/Sources/SKSupport/Connection+Send.swift b/Sources/SKSupport/Connection+Send.swift
@@ -11,6 +11,7 @@
 //===----------------------------------------------------------------------===//
 
 import LanguageServerProtocol
+import SwiftUtilities
 
 extension Connection {
   /// Send the given request to the connection and await its result.
diff --git a/Sources/SKSwiftPMWorkspace/CMakeLists.txt b/Sources/SKSwiftPMWorkspace/CMakeLists.txt
@@ -8,6 +8,7 @@ target_link_libraries(SKSwiftPMWorkspace PRIVATE
   LanguageServerProtocol
   LSPLogging
   SKCore
+  SwiftUtilities
   TSCBasic)
 target_link_libraries(SKSwiftPMWorkspace PUBLIC
   Build
diff --git a/Sources/SKSwiftPMWorkspace/SwiftPMBuildSystem.swift b/Sources/SKSwiftPMWorkspace/SwiftPMBuildSystem.swift
@@ -23,6 +23,7 @@ import SKCore
 import SKSupport
 import SourceControl
 import SourceKitLSPAPI
+import SwiftUtilities
 import Workspace
 
 import struct Basics.AbsolutePath
@@ -107,7 +108,9 @@ public actor SwiftPMBuildSystem {
   let fileSystem: FileSystem
   private let toolchainRegistry: ToolchainRegistry
 
-  private let swiftBuildSupportsPrepareForIndexingTask = SKSupport.ThreadSafeBox<Task<Bool, Never>?>(initialValue: nil)
+  private let swiftBuildSupportsPrepareForIndexingTask = SwiftUtilities.ThreadSafeBox<Task<Bool, Never>?>(
+    initialValue: nil
+  )
 
   #if compiler(>=6.1)
   #warning(
diff --git a/Sources/SKTestSupport/TestSourceKitLSPClient.swift b/Sources/SKTestSupport/TestSourceKitLSPClient.swift
@@ -20,6 +20,7 @@ import LanguageServerProtocolJSONRPC
 import SKSupport
 import SourceKitLSP
 import SwiftSyntax
+import SwiftUtilities
 import XCTest
 
 extension SourceKitLSPServer.Options {
diff --git a/Sources/SemanticIndex/CMakeLists.txt b/Sources/SemanticIndex/CMakeLists.txt
@@ -14,5 +14,6 @@ set_target_properties(SemanticIndex PROPERTIES
 target_link_libraries(SemanticIndex PRIVATE
   LSPLogging
   SKCore
+  SwiftUtilities
   IndexStoreDB
   $<$<NOT:$<PLATFORM_ID:Darwin>>:Foundation>)
diff --git a/Sources/SemanticIndex/UpdateIndexStoreTaskDescription.swift b/Sources/SemanticIndex/UpdateIndexStoreTaskDescription.swift
@@ -16,6 +16,7 @@ import LSPLogging
 import LanguageServerProtocol
 import SKCore
 import SKSupport
+import SwiftUtilities
 
 import struct TSCBasic.AbsolutePath
 import class TSCBasic.Process
diff --git a/Sources/SourceKitD/CMakeLists.txt b/Sources/SourceKitD/CMakeLists.txt
@@ -17,5 +17,6 @@ target_link_libraries(SourceKitD PUBLIC
 target_link_libraries(SourceKitD PRIVATE
   LSPLogging
   SKSupport
+  SwiftUtilities
   TSCBasic
   $<$<NOT:$<PLATFORM_ID:Darwin>>:Foundation>)
diff --git a/Sources/SourceKitD/DynamicallyLoadedSourceKitD.swift b/Sources/SourceKitD/DynamicallyLoadedSourceKitD.swift
@@ -13,6 +13,7 @@
 import Foundation
 import LSPLogging
 import SKSupport
+import SwiftUtilities
 
 import struct TSCBasic.AbsolutePath
 
diff --git a/Sources/SourceKitD/SourceKitD.swift b/Sources/SourceKitD/SourceKitD.swift
@@ -14,6 +14,7 @@
 import Dispatch
 import Foundation
 import SKSupport
+import SwiftUtilities
 
 #if compiler(>=6)
 extension sourcekitd_api_request_handle_t: @retroactive @unchecked Sendable {}
diff --git a/Sources/SourceKitLSP/CMakeLists.txt b/Sources/SourceKitLSP/CMakeLists.txt
@@ -75,6 +75,7 @@ target_link_libraries(SourceKitLSP PUBLIC
   SKSupport
   SKSwiftPMWorkspace
   SourceKitD
+  SwiftUtilities
   IndexStoreDB
   SwiftSyntax::SwiftBasicFormat
   SwiftSyntax::SwiftDiagnostics
diff --git a/Sources/SourceKitLSP/Clang/ClangLanguageService.swift b/Sources/SourceKitLSP/Clang/ClangLanguageService.swift
@@ -16,6 +16,7 @@ import LanguageServerProtocol
 import LanguageServerProtocolJSONRPC
 import SKCore
 import SKSupport
+import SwiftUtilities
 
 import struct TSCBasic.AbsolutePath
 
diff --git a/Sources/SourceKitLSP/IndexProgressManager.swift b/Sources/SourceKitLSP/IndexProgressManager.swift
@@ -15,6 +15,7 @@ import LanguageServerProtocol
 import SKCore
 import SKSupport
 import SemanticIndex
+import SwiftUtilities
 
 /// Listens for index status updates from `SemanticIndexManagers`. From that information, it manages a
 /// `WorkDoneProgress` that communicates the index progress to the editor.
diff --git a/Sources/SourceKitLSP/MessageHandlingDependencyTracker.swift b/Sources/SourceKitLSP/MessageHandlingDependencyTracker.swift
@@ -13,6 +13,7 @@
 import LSPLogging
 import LanguageServerProtocol
 import SKSupport
+import SwiftUtilities
 
 /// A lightweight way of describing tasks that are created from handling LSP
 /// requests or notifications for the purpose of dependency tracking.
diff --git a/Sources/SourceKitLSP/SourceKitIndexDelegate.swift b/Sources/SourceKitLSP/SourceKitIndexDelegate.swift
@@ -15,6 +15,7 @@ import IndexStoreDB
 import LSPLogging
 import SKCore
 import SKSupport
+import SwiftUtilities
 
 /// `IndexDelegate` for the SourceKit workspace.
 ///
diff --git a/Sources/SourceKitLSP/SourceKitLSPServer.swift b/Sources/SourceKitLSP/SourceKitLSPServer.swift
@@ -23,6 +23,7 @@ import SKSupport
 import SKSwiftPMWorkspace
 import SemanticIndex
 import SourceKitD
+import SwiftUtilities
 
 import struct PackageModel.BuildFlags
 import struct TSCBasic.AbsolutePath
diff --git a/Sources/SourceKitLSP/Swift/CodeCompletionSession.swift b/Sources/SourceKitLSP/Swift/CodeCompletionSession.swift
@@ -18,6 +18,7 @@ import SourceKitD
 import SwiftParser
 @_spi(SourceKitLSP) import SwiftRefactor
 import SwiftSyntax
+import SwiftUtilities
 
 /// Represents a code-completion session for a given source location that can be efficiently
 /// re-filtered by calling `update()`.
diff --git a/Sources/SourceKitLSP/Swift/DiagnosticReportManager.swift b/Sources/SourceKitLSP/Swift/DiagnosticReportManager.swift
@@ -15,6 +15,7 @@ import LanguageServerProtocol
 import SKSupport
 import SourceKitD
 import SwiftParserDiagnostics
+import SwiftUtilities
 
 actor DiagnosticReportManager {
   /// A task to produce diagnostics, either from a diagnostics request to `sourcektid` or by using the built-in swift-syntax.
diff --git a/Sources/SourceKitLSP/Swift/SwiftLanguageService.swift b/Sources/SourceKitLSP/Swift/SwiftLanguageService.swift
@@ -22,6 +22,7 @@ import SourceKitD
 import SwiftParser
 import SwiftParserDiagnostics
 import SwiftSyntax
+import SwiftUtilities
 
 import struct TSCBasic.AbsolutePath
 
diff --git a/Sources/SourceKitLSP/Swift/SyntacticTestIndex.swift b/Sources/SourceKitLSP/Swift/SyntacticTestIndex.swift
@@ -14,6 +14,7 @@ import Foundation
 import LSPLogging
 import LanguageServerProtocol
 import SKSupport
+import SwiftUtilities
 
 /// Task metadata for `SyntacticTestIndexer.indexingQueue`
 fileprivate enum TaskMetadata: DependencyTracker, Equatable {
diff --git a/Sources/SourceKitLSP/WorkDoneProgressManager.swift b/Sources/SourceKitLSP/WorkDoneProgressManager.swift
@@ -13,6 +13,7 @@
 import Foundation
 import LanguageServerProtocol
 import SKSupport
+import SwiftUtilities
 
 /// Represents a single `WorkDoneProgress` task that gets communicated with the client.
 ///
diff --git a/Sources/SourceKitLSP/WorkDoneProgressState.swift b/Sources/SourceKitLSP/WorkDoneProgressState.swift
@@ -13,6 +13,7 @@
 import LSPLogging
 import LanguageServerProtocol
 import SKSupport
+import SwiftUtilities
 
 /// Keeps track of the state to send work done progress updates to the client
 final actor WorkDoneProgressState {
diff --git a/Sources/SourceKitLSP/Workspace.swift b/Sources/SourceKitLSP/Workspace.swift
@@ -16,6 +16,7 @@ import LanguageServerProtocol
 import SKCore
 import SKSupport
 import SemanticIndex
+import SwiftUtilities
 
 import struct TSCBasic.AbsolutePath
 import struct TSCBasic.RelativePath
diff --git a/Sources/SwiftUtilities/AsyncQueue.swift b/Sources/SwiftUtilities/AsyncQueue.swift
diff --git a/Sources/SwiftUtilities/AsyncUtils.swift b/Sources/SwiftUtilities/AsyncUtils.swift
diff --git a/Sources/SwiftUtilities/CMakeLists.txt b/Sources/SwiftUtilities/CMakeLists.txt
@@ -0,0 +1,14 @@
+
+add_library(SwiftUtilities STATIC
+  AsyncQueue.swift
+  AsyncUtils.swift
+  Collection+Only.swift
+  Collection+PartitionIntoBatches.swift
+  Sequence+AsyncMap.swift
+  Task+WithPriorityChangedHandler.swift
+  ThreadSafeBox.swift
+)
+set_target_properties(SwiftUtilities PROPERTIES
+  INTERFACE_INCLUDE_DIRECTORIES ${CMAKE_Swift_MODULE_DIRECTORY})
+target_link_libraries(SwiftUtilities PRIVATE
+  $<$<NOT:$<PLATFORM_ID:Darwin>>:Foundation>)
diff --git a/Sources/SwiftUtilities/Collection+Only.swift b/Sources/SwiftUtilities/Collection+Only.swift
diff --git a/Sources/SwiftUtilities/Collection+PartitionIntoBatches.swift b/Sources/SwiftUtilities/Collection+PartitionIntoBatches.swift
diff --git a/Sources/SwiftUtilities/Sequence+AsyncMap.swift b/Sources/SwiftUtilities/Sequence+AsyncMap.swift
diff --git a/Sources/SwiftUtilities/Task+WithPriorityChangedHandler.swift b/Sources/SwiftUtilities/Task+WithPriorityChangedHandler.swift
diff --git a/Sources/SwiftUtilities/ThreadSafeBox.swift b/Sources/SwiftUtilities/ThreadSafeBox.swift
diff --git a/Tests/SKSupportTests/AsyncUtilsTests.swift b/Tests/SKSupportTests/AsyncUtilsTests.swift
@@ -12,6 +12,7 @@
 
 import LSPTestSupport
 import SKSupport
+import SwiftUtilities
 import XCTest
 
 final class AsyncUtilsTests: XCTestCase {
diff --git a/Tests/SourceKitDTests/CrashRecoveryTests.swift b/Tests/SourceKitDTests/CrashRecoveryTests.swift
