Convert ManualMainFilesProvider to be an actor

Author: joehsieh

Sources/SKCore/BuildSystemManager.swift

@@ -151,7 +151,7 @@ extension BuildSystemManager {
     for document: DocumentURI,
     language: Language
   ) async -> FileBuildSettings? {
-    let mainFile = mainFile(for: document)
+    let mainFile = await mainFile(for: document)
     guard var settings = await buildSettings(for: mainFile, language: language) else {
       return nil
     }
@@ -182,7 +182,7 @@ extension BuildSystemManager {
 
   public func registerForChangeNotifications(for uri: DocumentURI, language: Language) async {
     logger.debug("registerForChangeNotifications(\(uri.forLogging))")
-    let mainFile = mainFile(for: uri)
+    let mainFile = await mainFile(for: uri)
     self.watchedFiles[uri] = (mainFile, language)
 
     // Register for change notifications of the main file in the underlying build
@@ -274,7 +274,7 @@ extension BuildSystemManager: MainFilesDelegate {
   public func mainFilesChanged() async {
     var changedMainFileAssociations: Set<DocumentURI> = []
     for (file, (oldMainFile, language)) in self.watchedFiles {
-      let newMainFile = self.mainFile(for: file, useCache: false)
+      let newMainFile = await self.mainFile(for: file, useCache: false)
       if newMainFile != oldMainFile {
         self.watchedFiles[file] = (newMainFile, language)
         changedMainFileAssociations.insert(file)
@@ -303,7 +303,7 @@ extension BuildSystemManager: MainFilesDelegate {
   /// For Swift or normal C files, this will be the file itself. For header
   /// files, we pick a main file that includes the header since header files
   /// don't have build settings by themselves.
-  private func mainFile(for uri: DocumentURI, useCache: Bool = true) -> DocumentURI {
+  private func mainFile(for uri: DocumentURI, useCache: Bool = true) async -> DocumentURI {
     if useCache, let mainFile = self.watchedFiles[uri]?.mainFile {
       // Performance optimization: We did already compute the main file and have
       // it cached. We can just return it.
@@ -313,7 +313,7 @@ extension BuildSystemManager: MainFilesDelegate {
       return uri
     }
 
-    let mainFiles = mainFilesProvider.mainFilesContainingFile(uri)
+    let mainFiles = await mainFilesProvider.mainFilesContainingFile(uri)
     if mainFiles.contains(uri) {
       // If the main files contain the file itself, prefer to use that one
       return uri

Sources/SKCore/MainFilesProvider.swift

@@ -23,7 +23,7 @@ public protocol MainFilesProvider: AnyObject {
   /// mainFilesContainingFile("foo.cpp") == Set(["foo.cpp"])
   /// mainFilesContainingFile("foo.h") == Set(["foo.cpp", "bar.cpp"])
   /// ```
-  func mainFilesContainingFile(_: DocumentURI) -> Set<DocumentURI>
+  func mainFilesContainingFile(_: DocumentURI) async -> Set<DocumentURI>
 }
 
 /// Delegate that responds to possible main file changes.

Tests/SKCoreTests/BuildSystemManagerTests.swift

@@ -25,13 +25,14 @@ final class BuildSystemManagerTests: XCTestCase {
     let c = DocumentURI(string: "bsm:c")
     let d = DocumentURI(string: "bsm:d")
 
-    let mainFiles = ManualMainFilesProvider()
-    mainFiles.mainFiles = [
-      a: Set([c]),
-      b: Set([c, d]),
-      c: Set([c]),
-      d: Set([d]),
-    ]
+    let mainFiles = ManualMainFilesProvider(
+      mainFiles:[
+        a: Set([c]),
+        b: Set([c, d]),
+        c: Set([c]),
+        d: Set([d]),
+      ]
+    )
 
     let bsm = await BuildSystemManager(
       buildSystem: nil,
@@ -55,13 +56,15 @@ final class BuildSystemManagerTests: XCTestCase {
     await assertEqual(bsm._cachedMainFile(for: c), c)
     await assertEqual(bsm._cachedMainFile(for: d), d)
 
-    mainFiles.mainFiles = [
-      a: Set([a]),
-      b: Set([c, d, a]),
-      c: Set([c]),
-      d: Set([d]),
-    ]
-
+    await mainFiles.setMainFiles(
+      mainFiles: [
+        a: Set([a]),
+        b: Set([c, d, a]),
+        c: Set([c]),
+        d: Set([d]),
+      ]
+    )
+  
     await assertEqual(bsm._cachedMainFile(for: a), c)
     await assertEqual(bsm._cachedMainFile(for: b), bMain)
     await assertEqual(bsm._cachedMainFile(for: c), c)
@@ -92,8 +95,7 @@ final class BuildSystemManagerTests: XCTestCase {
 
   func testSettingsMainFile() async throws {
     let a = DocumentURI(string: "bsm:a.swift")
-    let mainFiles = ManualMainFilesProvider()
-    mainFiles.mainFiles = [a: Set([a])]
+    let mainFiles = ManualMainFilesProvider(mainFiles: [a: Set([a])])
     let bs = ManualBuildSystem()
     let bsm = await BuildSystemManager(
       buildSystem: bs,
@@ -116,8 +118,7 @@ final class BuildSystemManagerTests: XCTestCase {
 
   func testSettingsMainFileInitialNil() async throws {
     let a = DocumentURI(string: "bsm:a.swift")
-    let mainFiles = ManualMainFilesProvider()
-    mainFiles.mainFiles = [a: Set([a])]
+    let mainFiles = ManualMainFilesProvider(mainFiles: [a: Set([a])])
     let bs = ManualBuildSystem()
     let bsm = await BuildSystemManager(
       buildSystem: bs,
@@ -138,8 +139,7 @@ final class BuildSystemManagerTests: XCTestCase {
 
   func testSettingsMainFileWithFallback() async throws {
     let a = DocumentURI(string: "bsm:a.swift")
-    let mainFiles = ManualMainFilesProvider()
-    mainFiles.mainFiles = [a: Set([a])]
+    let mainFiles = ManualMainFilesProvider(mainFiles: [a: Set([a])])
     let bs = ManualBuildSystem()
     let fallback = FallbackBuildSystem(buildSetup: .default)
     let bsm = await BuildSystemManager(
@@ -169,8 +169,7 @@ final class BuildSystemManagerTests: XCTestCase {
   func testSettingsMainFileInitialIntersect() async throws {
     let a = DocumentURI(string: "bsm:a.swift")
     let b = DocumentURI(string: "bsm:b.swift")
-    let mainFiles = ManualMainFilesProvider()
-    mainFiles.mainFiles = [a: Set([a]), b: Set([b])]
+    let mainFiles = ManualMainFilesProvider(mainFiles: [a: Set([a]), b: Set([b])])
     let bs = ManualBuildSystem()
     let bsm = await BuildSystemManager(
       buildSystem: bs,
@@ -210,8 +209,7 @@ final class BuildSystemManagerTests: XCTestCase {
   func testSettingsMainFileUnchanged() async throws {
     let a = DocumentURI(string: "bsm:a.swift")
     let b = DocumentURI(string: "bsm:b.swift")
-    let mainFiles = ManualMainFilesProvider()
-    mainFiles.mainFiles = [a: Set([a]), b: Set([b])]
+    let mainFiles = ManualMainFilesProvider(mainFiles: [a: Set([a]), b: Set([b])])
     let bs = ManualBuildSystem()
     let bsm = await BuildSystemManager(
       buildSystem: bs,
@@ -242,12 +240,13 @@ final class BuildSystemManagerTests: XCTestCase {
     let h = DocumentURI(string: "bsm:header.h")
     let cpp1 = DocumentURI(string: "bsm:main.cpp")
     let cpp2 = DocumentURI(string: "bsm:other.cpp")
-    let mainFiles = ManualMainFilesProvider()
-    mainFiles.mainFiles = [
+    let mainFiles = ManualMainFilesProvider(
+      mainFiles: [
       h: Set([cpp1]),
-      cpp1: Set([cpp1]),
-      cpp2: Set([cpp2]),
-    ]
+        cpp1: Set([cpp1]),
+        cpp2: Set([cpp2]),
+      ]
+    )
 
     let bs = ManualBuildSystem()
     let bsm = await BuildSystemManager(
@@ -264,7 +263,13 @@ final class BuildSystemManagerTests: XCTestCase {
     await bsm.registerForChangeNotifications(for: h, language: .c)
     assertEqual(await bsm.buildSettingsInferredFromMainFile(for: h, language: .c), bs.map[cpp1]!)
 
-    mainFiles.mainFiles[h] = Set([cpp2])
+    await mainFiles.setMainFiles(
+      mainFiles: [
+        h: Set([cpp2]),
+        cpp1: Set([cpp1]),
+        cpp2: Set([cpp2]),
+      ]
+    )
 
     let changed = expectation(description: "changed settings to cpp2")
     await del.setExpected([(h, .c, bs.map[cpp2]!, changed, #file, #line)])
@@ -277,14 +282,26 @@ final class BuildSystemManagerTests: XCTestCase {
     await bsm.mainFilesChanged()
     try await fulfillmentOfOrThrow([changed2], timeout: 1)
 
-    mainFiles.mainFiles[h] = Set([cpp1, cpp2])
+    await mainFiles.setMainFiles(
+      mainFiles: [
+        h: Set([cpp1, cpp2]),
+        cpp1: Set([cpp1]),
+        cpp2: Set([cpp2]),
+      ]
+    )
 
     let changed3 = expectation(description: "added lexicographically earlier main file")
     await del.setExpected([(h, .c, bs.map[cpp1]!, changed3, #file, #line)])
     await bsm.mainFilesChanged()
     try await fulfillmentOfOrThrow([changed3], timeout: 1)
 
-    mainFiles.mainFiles[h] = Set([])
+    await mainFiles.setMainFiles(
+      mainFiles: [
+        h: Set([]),
+        cpp1: Set([cpp1]),
+        cpp2: Set([cpp2]),
+      ]
+    )
 
     let changed4 = expectation(description: "changed settings to []")
     await del.setExpected([(h, .c, nil, changed4, #file, #line)])
@@ -296,11 +313,12 @@ final class BuildSystemManagerTests: XCTestCase {
     let h1 = DocumentURI(string: "bsm:header1.h")
     let h2 = DocumentURI(string: "bsm:header2.h")
     let cpp = DocumentURI(string: "bsm:main.cpp")
-    let mainFiles = ManualMainFilesProvider()
-    mainFiles.mainFiles = [
-      h1: Set([cpp]),
-      h2: Set([cpp]),
-    ]
+    let mainFiles = ManualMainFilesProvider(
+      mainFiles: [
+        h1: Set([cpp]),
+        h2: Set([cpp]),
+      ]
+    )
 
     let bs = ManualBuildSystem()
     let bsm = await BuildSystemManager(
@@ -342,8 +360,7 @@ final class BuildSystemManagerTests: XCTestCase {
     let a = DocumentURI(string: "bsm:a.swift")
     let b = DocumentURI(string: "bsm:b.swift")
     let c = DocumentURI(string: "bsm:c.swift")
-    let mainFiles = ManualMainFilesProvider()
-    mainFiles.mainFiles = [a: Set([a]), b: Set([b]), c: Set([c])]
+    let mainFiles = ManualMainFilesProvider(mainFiles: [a: Set([a]), b: Set([b]), c: Set([c])])
     let bs = ManualBuildSystem()
     let bsm = await BuildSystemManager(
       buildSystem: bs,
@@ -384,8 +401,7 @@ final class BuildSystemManagerTests: XCTestCase {
 
   func testDependenciesUpdated() async throws {
     let a = DocumentURI(string: "bsm:a.swift")
-    let mainFiles = ManualMainFilesProvider()
-    mainFiles.mainFiles = [a: Set([a])]
+    let mainFiles = ManualMainFilesProvider(mainFiles: [a: Set([a])])
 
     let bs = ManualBuildSystem()
     let bsm = await BuildSystemManager(
@@ -412,15 +428,18 @@ final class BuildSystemManagerTests: XCTestCase {
 // MARK: Helper Classes for Testing
 
 /// A simple `MainFilesProvider` that wraps a dictionary, for testing.
-private final class ManualMainFilesProvider: MainFilesProvider {
-  let lock: DispatchQueue = DispatchQueue(label: "\(ManualMainFilesProvider.self)-lock")
-  private var _mainFiles: [DocumentURI: Set<DocumentURI>] = [:]
-  var mainFiles: [DocumentURI: Set<DocumentURI>] {
-    get { lock.sync { _mainFiles } }
-    set { lock.sync { _mainFiles = newValue } }
+private final actor ManualMainFilesProvider: MainFilesProvider {
+  private var mainFiles: [DocumentURI: Set<DocumentURI>]
+
+  init(mainFiles: [DocumentURI: Set<DocumentURI>]) {
+    self.mainFiles = mainFiles
+  }
+
+  func setMainFiles(mainFiles: [DocumentURI: Set<DocumentURI>]) async {
+    self.mainFiles = mainFiles
   }
 
-  func mainFilesContainingFile(_ file: DocumentURI) -> Set<DocumentURI> {
+  func mainFilesContainingFile(_ file: DocumentURI) async -> Set<DocumentURI> {
     if let result = mainFiles[file] {
       return result
     }