Additional refactoring of ManagedDependencies (#3750)

* Convert ManagedDependency from class to structure
* Make ManagedDependency.State an indirect enumeration
* Remove unnecessary ManagedDependency computed property packageIdentity
* Consolidate dependency path determination into dedicated APIs

Author: mattt

Sources/Workspace/ManagedDependency.swift

@@ -19,9 +19,9 @@ extension Workspace {
     ///
     /// Each dependency will have a checkout containing the sources at a
     /// particular revision, and may have an associated version.
-    final public class ManagedDependency {
+    public struct ManagedDependency: Equatable {
         /// Represents the state of the managed dependency.
-        public enum State: Equatable {
+        public indirect enum State: Equatable {
             /// The dependency is a managed checkout.
             case checkout(CheckoutState)
 
@@ -34,19 +34,6 @@ extension Workspace {
 
             // The dependency is a local package.
             case local
-
-            public static func == (lhs: Workspace.ManagedDependency.State, rhs: Workspace.ManagedDependency.State) -> Bool {
-                switch (lhs, rhs) {
-                case (.local, .local):
-                    return true
-                case (.checkout(let lState), .checkout(let rState)):
-                    return lState == rState
-                case (.edited(let lBasedOn, let lUnmanagedPath), .edited(let rBasedOn, let rUnmanagedPath)):
-                    return lBasedOn?.packageRef == rBasedOn?.packageRef && lUnmanagedPath == rUnmanagedPath
-                default:
-                    return false
-                }
-            }
         }
 
         /// The package reference.
@@ -70,10 +57,6 @@ extension Workspace {
         /// The checked out path of the dependency on disk, relative to the workspace checkouts path.
         public let subpath: RelativePath
 
-        public var packageIdentity: PackageIdentity {
-            self.packageRef.identity
-        }
-
         internal init(
             packageRef: PackageReference,
             state: State,

Sources/Workspace/Workspace.swift

@@ -1158,7 +1158,7 @@ extension Workspace {
 
         // Remove the existing checkout.
         do {
-            let oldCheckoutPath = self.location.repositoriesCheckoutsDirectory.appending(dependency.subpath)
+            let oldCheckoutPath = self.location.repositoriesCheckoutSubdirectory(for: dependency)
             try fileSystem.chmod(.userWritable, path: oldCheckoutPath, options: [.recursive, .onlyFiles])
             try fileSystem.removeFileTree(oldCheckoutPath)
         }
@@ -1196,7 +1196,7 @@ extension Workspace {
         }
 
         // Form the edit working repo path.
-        let path = self.location.editsDirectory.appending(dependency.subpath)
+        let path = self.location.editsSubdirectory(for: dependency)
         // Check for uncommited and unpushed changes if force removal is off.
         if !forceRemove {
             let workingCopy = try repositoryManager.openWorkingCopy(at: path)
@@ -1314,7 +1314,7 @@ extension Workspace {
         /// Returns all manifests contained in DependencyManifests.
         public func allDependencyManifests() -> OrderedDictionary<PackageIdentity, Manifest> {
             return self.dependencies.reduce(into: OrderedDictionary<PackageIdentity, Manifest>()) { partial, item in
-                partial[item.dependency.packageIdentity] = item.manifest
+                partial[item.dependency.packageRef.identity] = item.manifest
             }
         }
 
@@ -1350,7 +1350,7 @@ extension Workspace {
         func computePackageURLs() -> (required: Set<PackageReference>, missing: Set<PackageReference>) {
             let manifestsMap: [PackageIdentity: Manifest] = Dictionary(uniqueKeysWithValues:
                 self.root.packages.map { ($0.key, $0.value.manifest) } +
-                self.dependencies.map { ($0.dependency.packageIdentity, $0.manifest) }
+                self.dependencies.map { ($0.dependency.packageRef.identity, $0.manifest) }
             )
 
             var inputIdentities: Set<PackageReference> = []
@@ -1486,9 +1486,9 @@ extension Workspace {
     public func path(to dependency: Workspace.ManagedDependency) -> AbsolutePath {
         switch dependency.state {
         case .checkout:
-            return self.location.repositoriesCheckoutsDirectory.appending(dependency.subpath)
+            return self.location.repositoriesCheckoutSubdirectory(for: dependency)
         case .edited(_, let path):
-            return path ?? self.location.editsDirectory.appending(dependency.subpath)
+            return path ?? self.location.editsSubdirectory(for: dependency)
         case .local:
             return AbsolutePath(dependency.packageRef.location)
         }
@@ -3046,7 +3046,7 @@ extension Workspace {
     /// Removes the clone and checkout of the provided specifier.
     fileprivate func removeRepository(dependency: ManagedDependency) throws {
         // Remove the checkout.
-        let dependencyPath = self.location.repositoriesCheckoutsDirectory.appending(dependency.subpath)
+        let dependencyPath = self.location.repositoriesCheckoutSubdirectory(for: dependency)
         let workingCopy = try self.repositoryManager.openWorkingCopy(at: dependencyPath)
         guard !workingCopy.hasUncommittedChanges() else {
             throw WorkspaceDiagnostics.UncommitedChanges(repositoryPath: dependencyPath)

Sources/Workspace/WorkspaceConfiguration.swift

@@ -42,11 +42,21 @@ extension Workspace {
             self.workingDirectory.appending(component: "repositories")
         }
 
+        /// Returns the path to the repository checkout directory for a package.
+        public func editsSubdirectory(for dependency: ManagedDependency) -> AbsolutePath {
+            self.editsDirectory.appending(dependency.subpath)
+        }
+
         /// Path to the repository checkouts.
         public var repositoriesCheckoutsDirectory: AbsolutePath {
             self.workingDirectory.appending(component: "checkouts")
         }
 
+        /// Returns the path to the repository checkout directory for a package.
+        public func repositoriesCheckoutSubdirectory(for dependency: ManagedDependency) -> AbsolutePath {
+            self.repositoriesCheckoutsDirectory.appending(dependency.subpath)
+        }
+
         /// Path to the downloaded binary artifacts.
         public var artifactsDirectory: AbsolutePath {
             self.workingDirectory.appending(component: "artifacts")

Sources/Workspace/WorkspaceState.swift

@@ -374,7 +374,7 @@ fileprivate struct WorkspaceStateStorage {
 }
 
 extension Workspace.ManagedDependency {
-    fileprivate convenience init(_ dependency: WorkspaceStateStorage.V4.Dependency) throws {
+    fileprivate init(_ dependency: WorkspaceStateStorage.V4.Dependency) throws {
         try self.init(
             packageRef: .init(dependency.packageRef),
             state: dependency.state.underlying,