Merge pull request #1016 from aciidb0mb3r/reloadable-pinsstore

[Workspace] Use reloadable result on pinsstore

Author: aciidgh

Sources/Commands/SwiftPackageTool.swift

@@ -69,8 +69,9 @@ public class SwiftPackageTool: SwiftTool<PackageToolOptions> {
 
         case .update:
             let workspace = try getActiveWorkspace()
+            let pinsStore = try workspace.pinsStore.dematerialize()
             // We repin either on explicit repin option or if autopin is enabled.
-            let repin = options.repin || workspace.pinsStore.autoPin
+            let repin = options.repin || pinsStore.autoPin
             try workspace.updateDependencies(repin: repin)
 
         case .fetch:
@@ -181,7 +182,7 @@ public class SwiftPackageTool: SwiftTool<PackageToolOptions> {
             // Toggle enable auto pinning if requested.
             if let enableAutoPin = options.pinOptions.enableAutoPin {
                 let workspace = try getActiveWorkspace()
-                return try workspace.pinsStore.setAutoPin(on: enableAutoPin)
+                return try workspace.pinsStore.dematerialize().setAutoPin(on: enableAutoPin)
             }
 
             // Get the pin options.
@@ -226,7 +227,7 @@ public class SwiftPackageTool: SwiftTool<PackageToolOptions> {
                 fatalError("Expected package name from parser")
             }
             let workspace = try getActiveWorkspace()
-            try workspace.pinsStore.unpin(package: packageName)
+            try workspace.pinsStore.dematerialize().unpin(package: packageName)
         }
     }
 

Sources/Workspace/Workspace.swift

@@ -211,7 +211,7 @@ public class Workspace {
     private var fileSystem: FileSystem
 
     /// The Pins store. The pins file will be created when first pin is added to pins store.
-    public let pinsStore: PinsStore
+    public let pinsStore: ReloadableResult<PinsStore, AnyError>
 
     /// The manifest loader to use.
     let manifestLoader: ManifestLoaderProtocol
@@ -277,7 +277,9 @@ public class Workspace {
             repositoryManager: repositoryManager, manifestLoader: manifestLoader, toolsVersionLoader: toolsVersionLoader)
         self.fileSystem = fileSystem
 
-        self.pinsStore = try PinsStore(pinsFile: pinsFile, fileSystem: self.fileSystem)
+        self.pinsStore = ReloadableResult {
+            try PinsStore(pinsFile: pinsFile, fileSystem: fileSystem)
+        }
         self.managedDependencies = ReloadableResult{
             try ManagedDependencies(dataPath: dataPath, fileSystem: fileSystem)
         }
@@ -531,6 +533,8 @@ public class Workspace {
             requirement = currentState.requirement()
         }
 
+        let pinsStore = try self.pinsStore.dematerialize()
+
         // Compute constraints with the new pin and try to resolve
         // dependencies. We only commit the pin if the dependencies can be
         // resolved with new constraints.
@@ -573,6 +577,7 @@ public class Workspace {
     ///   - reset: Remove all current pins before pinning dependencies.
     public func pinAll(reason: String? = nil, reset: Bool = false) throws {
         if reset {
+            let pinsStore = try self.pinsStore.dematerialize()
             try pinsStore.unpinAll()
         }
         // Load the dependencies.
@@ -602,6 +607,7 @@ public class Workspace {
                 return delegate.warning(message: "not pinning \(package). It is being edited but is no longer needed.")
             }
         }
+        let pinsStore = try self.pinsStore.dematerialize()
         // Commit the pin.
         try pinsStore.pin(
             package: package,
@@ -759,6 +765,7 @@ public class Workspace {
     /// This methods pins all packages if auto pinning is on.
     /// Otherwise, only currently pinned packages are repinned.
     private func repinPackages() throws {
+        let pinsStore = try self.pinsStore.dematerialize()
         // If autopin is on, pin everything and return.
         if pinsStore.autoPin {
             return try pinAll(reset: true)
@@ -817,6 +824,7 @@ public class Workspace {
         resolvedDependencies: [(RepositorySpecifier, BoundVersion)],
         updateBranches: Bool
     ) throws -> [RepositorySpecifier: PackageStateChange] {
+        let pinsStore = try self.pinsStore.dematerialize()
         var packageStateChanges = [RepositorySpecifier: PackageStateChange]()
         let managedDependencies = try self.managedDependencies.dematerialize()
         // Set the states from resolved dependencies results.
@@ -887,9 +895,10 @@ public class Workspace {
     ///   - includePins: If the constraints from pins should be included.
     /// - Returns: Array of constraints.
     private func computeRootPackagesConstraints(_ rootManifests: [Manifest], includePins: Bool) -> [RepositoryPackageConstraint] {
+        // FIXME: Need to get rid of bang here.
         return rootManifests.flatMap{ 
             $0.package.dependencyConstraints() 
-        } + (includePins ? pinsStore.createConstraints() : [])
+        } + (includePins ? try! pinsStore.dematerialize().createConstraints() : [])
     }
 
     /// Runs the dependency resolver based on constraints provided and returns the results.
@@ -1032,7 +1041,9 @@ public class Workspace {
         // delegate of what is happening.
         delegate.fetchingMissingRepositories(missingURLs)
 
+        let pinsStore = try! self.pinsStore.dematerialize()
         // Add constraints from the root packages and the current manifests.
+        // FIXME: Fix bang here.
         let constraints = computeRootPackagesConstraints(currentManifests.roots, includePins: true)
                         + currentManifests.createConstraints(pinsStore: pinsStore)
 
@@ -1171,25 +1182,25 @@ extension Collection {
 ///
 /// It is useful for objects that holds a state on disk and needs to be
 /// reloaded frequently.
-final class ReloadableResult<Value, ErrorType: Swift.Error> {
+public final class ReloadableResult<Value, ErrorType: Swift.Error> {
 
     /// The constructor closure for the value.
     private let construct: () throws -> Value
 
     /// Create a reloadable result.
-    init(_ construct: @escaping () throws -> Value) {
+    public init(_ construct: @escaping () throws -> Value) {
         self.construct = construct
     }
 
     /// Load and return the result.
-    func result() -> Result<Value, ErrorType> {
+    public func result() -> Result<Value, ErrorType> {
         return try! Result {
             try self.construct()
         }
     }
 
     /// Load and return the value.
-    func dematerialize() throws -> Value {
+    public func dematerialize() throws -> Value {
         return try result().dematerialize()
     }
 }

Tests/WorkspaceTests/WorkspaceTests.swift

@@ -363,7 +363,7 @@ final class WorkspaceTests: XCTestCase {
                 let workspace = try createWorkspace()
 
                 // Turn off auto pinning.
-                try workspace.pinsStore.setAutoPin(on: false)
+                try workspace.pinsStore.dematerialize().setAutoPin(on: false)
                 // Ensure delegates haven't been called yet.
                 XCTAssert(delegate.fetched.isEmpty)
                 XCTAssert(delegate.cloned.isEmpty)
@@ -714,17 +714,17 @@ final class WorkspaceTests: XCTestCase {
             XCTAssert(graph.lookup("A").version == "1.0.1")
             XCTAssert(graph.lookup("AA").version == v1)
             // We should have pin for AA automatically.
-            XCTAssertNotNil(workspace.pinsStore.pinsMap["A"])
-            XCTAssertNotNil(workspace.pinsStore.pinsMap["AA"])
+            XCTAssertNotNil(try workspace.pinsStore.dematerialize().pinsMap["A"])
+            XCTAssertNotNil(try workspace.pinsStore.dematerialize().pinsMap["AA"])
         }
 
         // Unpin all of the dependencies.
         do {
             let workspace = newWorkspace()
-            try workspace.pinsStore.unpinAll()
+            try workspace.pinsStore.dematerialize().unpinAll()
             // Reset so we have a clean workspace.
             try workspace.reset()
-            try workspace.pinsStore.setAutoPin(on: false)
+            try workspace.pinsStore.dematerialize().setAutoPin(on: false)
         }
 
         // Pin at A at v1.
@@ -749,9 +749,9 @@ final class WorkspaceTests: XCTestCase {
             XCTAssertTrue(graph.errors.isEmpty)
             XCTAssert(graph.lookup("A").version == "1.0.1")
             XCTAssert(graph.lookup("AA").version == v1)
-            XCTAssertNotNil(workspace.pinsStore.pinsMap["A"])
+            XCTAssertNotNil(try workspace.pinsStore.dematerialize().pinsMap["A"])
             // We should not have pinned AA.
-            XCTAssertNil(workspace.pinsStore.pinsMap["AA"])
+            XCTAssertNil(try workspace.pinsStore.dematerialize().pinsMap["AA"])
         }
     }
 
@@ -791,15 +791,15 @@ final class WorkspaceTests: XCTestCase {
             }
             // Try unpinning something which is not pinned.
             XCTAssertThrows(PinOperationError.notPinned) {
-                try workspace.pinsStore.unpin(package: "A")
+                try workspace.pinsStore.dematerialize().unpin(package: "A")
             }
             try workspace.pin(dependency: dep, packageName: "A", version: v1)
         }
 
         // Turn off autopin.
         do {
             let workspace = newWorkspace()
-            try workspace.pinsStore.setAutoPin(on: false)
+            try workspace.pinsStore.dematerialize().setAutoPin(on: false)
         }
 
         // Package graph should load 1.0.1.
@@ -824,7 +824,7 @@ final class WorkspaceTests: XCTestCase {
         // Unpin package.
         do {
             let workspace = newWorkspace()
-            try workspace.pinsStore.unpin(package: "A")
+            try workspace.pinsStore.dematerialize().unpin(package: "A")
             try workspace.reset()
         }
 
@@ -928,7 +928,7 @@ final class WorkspaceTests: XCTestCase {
         // Unpin all of the dependencies.
         do {
             let workspace = newWorkspace()
-            try workspace.pinsStore.unpinAll()
+            try workspace.pinsStore.dematerialize().unpinAll()
             // Reset so we have a clean workspace.
             try workspace.reset()
         }
@@ -1062,7 +1062,7 @@ final class WorkspaceTests: XCTestCase {
             // But we should still be able to repin at v1.
             try pin(at: v1)
             // And also after unpinning.
-            try workspace.pinsStore.unpinAll()
+            try workspace.pinsStore.dematerialize().unpinAll()
             try pin(at: v1)
 
         }
@@ -1134,7 +1134,7 @@ final class WorkspaceTests: XCTestCase {
 
         do {
             let workspace = newWorkspace()
-            try workspace.pinsStore.setAutoPin(on: false)
+            try workspace.pinsStore.dematerialize().setAutoPin(on: false)
             _ = workspace.loadPackageGraph()
             let manifests = try workspace.loadDependencyManifests()
             guard let (_, dep) = manifests.lookup(package: "B") else {
@@ -1266,10 +1266,10 @@ final class WorkspaceTests: XCTestCase {
             // Check pins.
             do {
                 let workspace = getWorkspace()
-                let dep1Pin = workspace.pinsStore.pinsMap["dep"]!
+                let dep1Pin = try workspace.pinsStore.dematerialize().pinsMap["dep"]!
                 XCTAssertEqual(dep1Pin.state, CheckoutState(revision: dep1Revision, branch: "develop"))
 
-                let dep2Pin = workspace.pinsStore.pinsMap["dep2"]!
+                let dep2Pin = try workspace.pinsStore.dematerialize().pinsMap["dep2"]!
                 XCTAssertEqual(dep2Pin.state, CheckoutState(revision: dep2Revision))
             }
 
@@ -1384,7 +1384,7 @@ final class WorkspaceTests: XCTestCase {
             // Set auto pinning off.
             do {
                 let workspace = try createWorkspace()
-                try workspace.pinsStore.setAutoPin(on: false)
+                try workspace.pinsStore.dematerialize().setAutoPin(on: false)
             }
 
             // Throw if we have not registered any packages but want to load things.
@@ -1488,7 +1488,7 @@ final class WorkspaceTests: XCTestCase {
 
             // We should retain the original pin for a package which is in edit mode.
             try workspace.pinAll(reset: true)
-            XCTAssertEqual(workspace.pinsStore.pinsMap["A"]?.state.version, v1)
+            XCTAssertEqual(try workspace.pinsStore.dematerialize().pinsMap["A"]?.state.version, v1)
 
             // Remove edited checkout.
             try removeFileTree(workspace.editablesPath)
@@ -1527,8 +1527,8 @@ final class WorkspaceTests: XCTestCase {
                 try workspace.edit(dependency: bDependency, packageName: "B", revision: bDependency.checkoutState!.revision)
 
                 XCTAssertEqual(manifests.lookup(package: "A")!.dependency.checkoutState?.version, v1)
-                XCTAssertEqual(workspace.pinsStore.pinsMap["A"]?.state.version, v1)
-                XCTAssertEqual(workspace.pinsStore.pinsMap["B"]?.state.version, v1)
+                XCTAssertEqual(try workspace.pinsStore.dematerialize().pinsMap["A"]?.state.version, v1)
+                XCTAssertEqual(try workspace.pinsStore.dematerialize().pinsMap["B"]?.state.version, v1)
 
                 // Create update.
                 let repoPath = AbsolutePath(manifestGraph.repo("A").url)
@@ -1546,9 +1546,9 @@ final class WorkspaceTests: XCTestCase {
                 let manifests = try workspace.loadDependencyManifests()
 
                 XCTAssertEqual(manifests.lookup(package: "A")!.dependency.checkoutState?.version, "1.0.1")
-                XCTAssertEqual(workspace.pinsStore.pinsMap["A"]?.state.version, "1.0.1")
+                XCTAssertEqual(try workspace.pinsStore.dematerialize().pinsMap["A"]?.state.version, "1.0.1")
                 XCTAssertTrue(manifests.lookup(package: "B")!.dependency.state == .edited)
-                XCTAssertEqual(workspace.pinsStore.pinsMap["B"]?.state.version, v1)
+                XCTAssertEqual(try workspace.pinsStore.dematerialize().pinsMap["B"]?.state.version, v1)
             }
         }
     }