Add PackageRegistryManager (#3787)

* Add scopeAndName property to PackageIdentity
* Use PackageIdentity.Scope instead of String where applicable
* Add RegistryManager
* Add SourceArchiver that uses tar command
* Update Workspace initialization to configure registryManager
* Add and adapt tests

Author: mattt

Sources/Commands/SwiftPackageRegistryTool.swift

@@ -24,7 +24,7 @@ import Foundation
 import PackageRegistry
 
 private enum RegistryConfigurationError: Swift.Error {
-    case missingScope(String? = nil)
+    case missingScope(PackageIdentity.Scope? = nil)
     case invalidURL(String)
 }
 
@@ -90,6 +90,8 @@ public struct SwiftPackageRegistryTool: ParsableCommand {
                 throw RegistryConfigurationError.invalidURL(self.url)
             }
 
+            let scope = try scope.map(PackageIdentity.Scope.init(validating:))
+
             // TODO: Require login if password is specified
 
             let set: (inout RegistryConfiguration) throws -> Void = { configuration in
@@ -125,6 +127,8 @@ public struct SwiftPackageRegistryTool: ParsableCommand {
         var scope: String?
 
         func run(_ swiftTool: SwiftTool) throws {
+            let scope = try scope.map(PackageIdentity.Scope.init(validating:))
+
             let unset: (inout RegistryConfiguration) throws -> Void = { configuration in
                 if let scope = scope {
                     guard let _ = configuration.scopedRegistries[scope] else {
@@ -148,23 +152,3 @@ public struct SwiftPackageRegistryTool: ParsableCommand {
         }
     }
 }
-
-// MARK: -
-
-
-private extension SwiftTool {
-    func getRegistriesConfig() throws -> Workspace.Configuration.Registries {
-        let localRegistriesFile = try Workspace.DefaultLocations.registriesConfigurationFile(forRootPackage: self.getPackageRoot())
-
-        let workspace = try getActiveWorkspace()
-        let sharedRegistriesFile = workspace.location.sharedConfigurationDirectory.map {
-            Workspace.DefaultLocations.registriesConfigurationFile(at: $0)
-        }
-
-        return try .init(
-            localRegistriesFile: localRegistriesFile,
-            sharedRegistriesFile: sharedRegistriesFile,
-            fileSystem: localFileSystem
-        )
-    }
-}

Sources/Commands/SwiftTool.swift

@@ -495,6 +495,21 @@ public class SwiftTool {
         return newPath
     }
 
+    func getRegistriesConfig(sharedConfigurationDirectory: AbsolutePath? = nil) throws -> Workspace.Configuration.Registries {
+        let localRegistriesFile = try Workspace.DefaultLocations.registriesConfigurationFile(forRootPackage: self.getPackageRoot())
+
+        let sharedConfigurationDirectory = try sharedConfigurationDirectory ?? self.getSharedConfigurationDirectory()
+        let sharedRegistriesFile = sharedConfigurationDirectory.map {
+            Workspace.DefaultLocations.registriesConfigurationFile(at: $0)
+        }
+
+        return try .init(
+            localRegistriesFile: localRegistriesFile,
+            sharedRegistriesFile: sharedRegistriesFile,
+            fileSystem: localFileSystem
+        )
+    }
+
     func getAuthorizationProvider() throws -> AuthorizationProvider? {
         var providers = [AuthorizationProvider]()
 
@@ -609,6 +624,7 @@ public class SwiftTool {
                 sharedConfigurationDirectory: sharedConfigurationDirectory
             ),
             mirrors: self.getMirrorsConfig(sharedConfigurationDirectory: sharedConfigurationDirectory).mirrors,
+            registries: try self.getRegistriesConfig(sharedConfigurationDirectory: sharedConfigurationDirectory).configuration,
             authorizationProvider: self.getAuthorizationProvider(),
             customManifestLoader: self.getManifestLoader(), // FIXME: doe we really need to customize it?
             customRepositoryProvider: provider, // FIXME: doe we really need to customize it?

Sources/PackageDescription/PackageDependency.swift

@@ -8,6 +8,8 @@
  See http://swift.org/CONTRIBUTORS.txt for Swift project authors
  */
 
+import Foundation
+
 // MARK: - file system
 
 extension Package {
@@ -27,7 +29,7 @@ extension Package {
         public enum Kind {
             case fileSystem(name: String?, path: String)
             case sourceControl(name: String?, location: String, requirement: SourceControlRequirement)
-            case registry(identity: String, requirement: RegistryRequirement)
+            case registry(id: String, requirement: RegistryRequirement)
         }
 
         @available(_PackageDescription, introduced: 5.6)
@@ -81,7 +83,7 @@ extension Package {
                     case .revision(let revision):
                         return .revisionItem(revision)
                     }
-                case .registry(identity: _, requirement: let requirement):
+                case .registry(id: _, requirement: let requirement):
                     switch requirement {
                     case .exact(let version):
                         return .exactItem(version)
@@ -121,8 +123,8 @@ extension Package {
             self.init(kind: .sourceControl(name: name, location: location, requirement: requirement))
         }
 
-        convenience init(identity: String, requirement: RegistryRequirement) {
-            self.init(kind: .registry(identity: identity, requirement: requirement))
+        convenience init(id: String, requirement: RegistryRequirement) {
+            self.init(kind: .registry(id: id, requirement: requirement))
         }
     }
 }
@@ -459,17 +461,17 @@ extension Package.Dependency {
     /// The following example allows the Swift Package Manager to select a version
     /// like a  `1.2.3`, `1.2.4`, or `1.3.0`, but not `2.0.0`.
     ///
-    ///    .package(identity: "scope.name", from: "1.2.3"),
+    ///    .package(id: "scope.name", from: "1.2.3"),
     ///
     /// - Parameters:
-    ///     - identity: The identity of the package.
+    ///     - id: The identity of the package.
     ///     - version: The minimum version requirement.
     @available(_PackageDescription, introduced: 999)
     public static func package(
-        identity: String,
+        id: String,
         from version: Version
     ) -> Package.Dependency {
-        return .package(identity: identity, .upToNextMajor(from: version))
+        return .package(id: id, .upToNextMajor(from: version))
     }
 
     /// Adds a package dependency that uses the exact version requirement.
@@ -483,17 +485,17 @@ extension Package.Dependency {
     ///
     /// The following example instruct the Swift Package Manager to use version `1.2.3`.
     ///
-    ///    .package(identity: "scope.name", exact: "1.2.3"),
+    ///    .package(id: "scope.name", exact: "1.2.3"),
     ///
     /// - Parameters:
-    ///     - identity: The identity of the package.
+    ///     - id: The identity of the package.
     ///     - version: The minimum version requirement.
     @available(_PackageDescription, introduced: 999)
     public static func package(
-        identity: String,
+        id: String,
         exact version: Version
     ) -> Package.Dependency {
-        return .package(identity: identity, requirement: .exact(version))
+        return .package(id: id, requirement: .exact(version))
     }
 
     /// Adds a package dependency starting with a specific minimum version, up to
@@ -502,17 +504,17 @@ extension Package.Dependency {
     /// The following example allows the Swift Package Manager to pick
     /// versions `1.2.3`, `1.2.4`, `1.2.5`, but not `1.2.6`.
     ///
-    ///     .package(identity: "scope.name", "1.2.3"..<"1.2.6"),
+    ///     .package(id: "scope.name", "1.2.3"..<"1.2.6"),
     ///
     /// - Parameters:
-    ///     - identity: The identity of the package.
+    ///     - id: The identity of the package.
     ///     - range: The custom version range requirement.
     @available(_PackageDescription, introduced: 999)
     public static func package(
-        identity: String,
+        id: String,
         _ range: Range<Version>
     ) -> Package.Dependency {
-        return .package(identity: identity, requirement: .range(range))
+        return .package(id: id, requirement: .range(range))
     }
 
     /// Adds a package dependency starting with a specific minimum version, going
@@ -521,14 +523,14 @@ extension Package.Dependency {
     /// The following example allows the Swift Package Manager to pick
     /// versions 1.2.3, 1.2.4, 1.2.5, as well as 1.2.6.
     ///
-    ///     .package(identity: "scope.name", "1.2.3"..."1.2.6"),
+    ///     .package(id: "scope.name", "1.2.3"..."1.2.6"),
     ///
     /// - Parameters:
-    ///     - identity: The identity of the package.
+    ///     - id: The identity of the package.
     ///     - range: The closed version range requirement.
     @available(_PackageDescription, introduced: 999)
     public static func package(
-        identity: String,
+        id: String,
         _ range: ClosedRange<Version>
     ) -> Package.Dependency {
         // Increase upperbound's patch version by one.
@@ -537,16 +539,21 @@ extension Package.Dependency {
             upper.major, upper.minor, upper.patch + 1,
             prereleaseIdentifiers: upper.prereleaseIdentifiers,
             buildMetadataIdentifiers: upper.buildMetadataIdentifiers)
-        return .package(identity: identity, range.lowerBound ..< upperBound)
+        return .package(id: id, range.lowerBound ..< upperBound)
     }
 
     // intentionally private to hide enum detail
     @available(_PackageDescription, introduced: 999)
     private static func package(
-        identity: String,
+        id: String,
         requirement: Package.Dependency.RegistryRequirement
     ) -> Package.Dependency {
-        return .init(identity: identity, requirement: requirement)
+        let pattern = #"\A[a-zA-Z\d](?:[a-zA-Z\d]|-(?=[a-zA-Z\d])){0,38}\.[a-zA-Z0-9](?:[a-zA-Z0-9]|[-_](?=[a-zA-Z0-9])){0,99}\z"#
+        if id.range(of: pattern, options: .regularExpression) == nil {
+            errors.append("Invalid package identifier: \(id)")
+        }
+
+        return .init(id: id, requirement: requirement)
     }
 }
 

Sources/PackageModel/PackageIdentity.swift

@@ -63,6 +63,17 @@ public struct PackageIdentity: CustomStringConvertible {
     public static func plain(_ value: String) -> PackageIdentity {
         PackageIdentity(value)
     }
+
+    // TODO: formalize package registry identifier
+    public var scopeAndName: (Scope, Name)? {
+        let components = description.split(separator: ".", maxSplits: 1, omittingEmptySubsequences: true)
+        guard components.count == 2,
+              let scope = Scope(components.first),
+              let name = Name(components.last)
+        else { return nil }
+
+        return (scope, name)
+    }
 }
 
 extension PackageIdentity: Equatable, Comparable {
@@ -149,6 +160,11 @@ extension PackageIdentity {
             self = scope
         }
 
+        fileprivate init?(_ substring: String.SubSequence?) {
+            guard let substring = substring else { return nil }
+            self.init(String(substring))
+        }
+
         // MARK: - Equatable & Comparable
 
         private func compare(to other: Scope) -> ComparisonResult {
@@ -226,6 +242,11 @@ extension PackageIdentity {
             self = name
         }
 
+        fileprivate init?(_ substring: String.SubSequence?) {
+            guard let substring = substring else { return nil }
+            self.init(String(substring))
+        }
+
         // MARK: - Equatable & Comparable
 
         private func compare(to other: Name) -> ComparisonResult {

Sources/PackageRegistry/CMakeLists.txt

@@ -7,11 +7,15 @@
 # See http://swift.org/CONTRIBUTORS.txt for Swift project authors
 
 add_library(PackageRegistry
-  RegistryConfiguration.swift)
+  Registry.swift
+  RegistryConfiguration.swift
+  RegistryManager.swift
+  SourceArchiver.swift)
 target_link_libraries(PackageRegistry PUBLIC
-  TSCBasic
+  Basics
   PackageLoading
   PackageModel
+  TSCBasic
   TSCUtility)
 # NOTE(compnerd) workaround for CMake not setting up include flags yet
 set_target_properties(PackageRegistry PROPERTIES

Sources/PackageRegistry/Registry.swift

@@ -0,0 +1,19 @@
+/*
+ This source file is part of the Swift.org open source project
+
+ Copyright (c) 2021 Apple Inc. and the Swift project authors
+ Licensed under Apache License v2.0 with Runtime Library Exception
+
+ See http://swift.org/LICENSE.txt for license information
+ See http://swift.org/CONTRIBUTORS.txt for Swift project authors
+*/
+
+import struct Foundation.URL
+
+public struct Registry: Hashable, Codable {
+    public var url: Foundation.URL
+
+    public init(url: Foundation.URL) {
+        self.url = url
+    }
+}

Sources/PackageRegistry/RegistryConfiguration.swift

@@ -9,26 +9,17 @@
 */
 
 import Foundation
+import PackageModel
 
 public struct RegistryConfiguration: Hashable {
-    public typealias Scope = String
-
-    public struct Registry: Hashable {
-        public var url: Foundation.URL
-
-        public init(url: Foundation.URL) {
-            self.url = url
-        }
-    }
-
-    public enum Version: Int {
+    public enum Version: Int, Codable {
         case v1 = 1
     }
 
     public static let version: Version = .v1
 
     public var defaultRegistry: Registry?
-    public var scopedRegistries: [Scope: Registry]
+    public var scopedRegistries: [PackageIdentity.Scope: Registry]
 
     public init() {
         self.defaultRegistry = nil
@@ -48,6 +39,10 @@ public struct RegistryConfiguration: Hashable {
             self.scopedRegistries[scope] = registry
         }
     }
+    
+    public func registry(for scope: PackageIdentity.Scope) -> Registry? {
+        return scopedRegistries[scope] ?? defaultRegistry
+    }
 }
 
 // MARK: - Codable
@@ -83,9 +78,10 @@ extension RegistryConfiguration: Codable {
 
             self.defaultRegistry = try nestedContainer.decodeIfPresent(Registry.self, forKey: .default)
 
-            var scopedRegistries: [Scope: Registry] = [:]
+            var scopedRegistries: [PackageIdentity.Scope: Registry] = [:]
             for key in nestedContainer.allKeys where key != .default {
-                scopedRegistries[key.stringValue] = try nestedContainer.decode(Registry.self, forKey: key)
+                let scope = try PackageIdentity.Scope(validating: key.stringValue)
+                scopedRegistries[scope] = try nestedContainer.decode(Registry.self, forKey: key)
             }
             self.scopedRegistries = scopedRegistries
         case nil:
@@ -103,11 +99,8 @@ extension RegistryConfiguration: Codable {
         try nestedContainer.encodeIfPresent(defaultRegistry, forKey: .default)
 
         for (scope, registry) in scopedRegistries {
-            let key = ScopeCodingKey(stringValue: scope)
+            let key = ScopeCodingKey(stringValue: scope.description)
             try nestedContainer.encode(registry, forKey: key)
         }
     }
 }
-
-extension RegistryConfiguration.Version: Codable {}
-extension RegistryConfiguration.Registry: Codable {}