update collections APIs to use package identity

motivation: adoption of SE-0292 package registry

chnages:
* migrate APIs that take PackageRefernec to take PackageIdentity
* adjust and update tests

rdar://83073308
rdar://82954076

Author: tomerd

Sources/Commands/SwiftPackageCollectionsTool.swift

@@ -1,9 +1,9 @@
 /*
  This source file is part of the Swift.org open source project
-
+ 
  Copyright 2020-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
  */
@@ -67,22 +67,22 @@ public struct SwiftPackageCollectionsTool: ParsableCommand {
         ],
         helpNames: [.short, .long, .customLong("help", withSingleDash: true)]
     )
-
+    
     public init() {}
-
+    
     // MARK: Collections
-
+    
     struct List: ParsableCommand {
         static let configuration = CommandConfiguration(abstract: "List configured collections")
-
+        
         @OptionGroup
         var jsonOptions: JSONOptions
-
+        
         mutating func run() throws {
             let collections = try with { collections in
                 try tsc_await { collections.listCollections(identifiers: nil, callback: $0) }
             }
-
+            
             if self.jsonOptions.json {
                 try JSONEncoder.makeWithDefaults().print(collections)
             } else {
@@ -92,36 +92,36 @@ public struct SwiftPackageCollectionsTool: ParsableCommand {
             }
         }
     }
-
+    
     struct Refresh: ParsableCommand {
         static let configuration = CommandConfiguration(abstract: "Refresh configured collections")
-
+        
         mutating func run() throws {
             let collections = try with { collections in
                 try tsc_await { collections.refreshCollections(callback: $0) }
             }
             print("Refreshed \(collections.count) configured package collection\(collections.count == 1 ? "" : "s").")
         }
     }
-
+    
     struct Add: ParsableCommand {
         static let configuration = CommandConfiguration(abstract: "Add a new collection")
-
+        
         @Argument(help: "URL of the collection to add")
         var collectionURL: String
-
+        
         @Option(name: .long, help: "Sort order for the added collection")
         var order: Int?
-
+        
         @Flag(name: .long, help: "Trust the collection even if it is unsigned")
         var trustUnsigned: Bool = false
-
+        
         @Flag(name: .long, help: "Skip signature check if the collection is signed")
         var skipSignatureCheck: Bool = false
-
+        
         mutating func run() throws {
             let collectionURL = try url(self.collectionURL)
-
+            
             let source = PackageCollectionsModel.CollectionSource(type: .json, url: collectionURL, skipSignatureCheck: self.skipSignatureCheck)
             let collection: PackageCollectionsModel.Collection = try with { collections in
                 do {
@@ -144,20 +144,20 @@ public struct SwiftPackageCollectionsTool: ParsableCommand {
                     throw CollectionsError.missingSignature
                 }
             }
-
+            
             print("Added \"\(collection.name)\" to your package collections.")
         }
     }
-
+    
     struct Remove: ParsableCommand {
         static let configuration = CommandConfiguration(abstract: "Remove a configured collection")
-
+        
         @Argument(help: "URL of the collection to remove")
         var collectionURL: String
-
+        
         mutating func run() throws {
             let collectionURL = try url(self.collectionURL)
-
+            
             let source = PackageCollectionsModel.CollectionSource(type: .json, url: collectionURL)
             try with { collections in
                 let collection = try tsc_await { collections.getCollection(source, callback: $0) }
@@ -166,115 +166,115 @@ public struct SwiftPackageCollectionsTool: ParsableCommand {
             }
         }
     }
-
+    
     // MARK: Search
-
+    
     enum SearchMethod: String, EnumerableFlag {
         case keywords
         case module
     }
-
+    
     struct Search: ParsableCommand {
         static var configuration = CommandConfiguration(abstract: "Search for packages by keywords or module names")
-
+        
         @OptionGroup
         var jsonOptions: JSONOptions
-
+        
         @Flag(help: "Pick the method for searching")
         var searchMethod: SearchMethod
-
+        
         @Argument(help: "Search query")
         var searchQuery: String
-
+        
         mutating func run() throws {
             try with { collections in
                 switch searchMethod {
                 case .keywords:
                     let results = try tsc_await { collections.findPackages(searchQuery, collections: nil, callback: $0) }
-
+                    
                     if jsonOptions.json {
                         try JSONEncoder.makeWithDefaults().print(results.items)
                     } else {
                         results.items.forEach {
-                            print("\($0.package.repository.url): \($0.package.summary ?? "")")
+                            print("\($0.package.identity): \($0.package.summary ?? "")")
                         }
                     }
-
+                    
                 case .module:
                     let results = try tsc_await { collections.findTargets(searchQuery, searchType: .exactMatch, collections: nil, callback: $0) }
-
+                    
                     let packages = Set(results.items.flatMap { $0.packages })
                     if jsonOptions.json {
                         try JSONEncoder.makeWithDefaults().print(packages)
                     } else {
                         packages.forEach {
-                            print("\($0.repository.url): \($0.summary ?? "")")
+                            print("\($0.identity): \($0.summary ?? "")")
                         }
                     }
                 }
             }
         }
     }
-
+    
     // MARK: Packages
-
+    
     struct Describe: ParsableCommand {
         static var configuration = CommandConfiguration(abstract: "Get metadata for a collection or a package included in an imported collection")
-
+        
         @OptionGroup
         var jsonOptions: JSONOptions
-
+        
         @Argument(help: "URL of the package or collection to get information for")
         var packageURL: String
-
+        
         @Option(name: .long, help: "Version of the package to get information for")
         var version: String?
-
+        
         private func printVersion(_ version: PackageCollectionsModel.Package.Version?) -> String? {
             guard let version = version else {
                 return nil
             }
             guard let defaultManifest = version.defaultManifest else {
                 return nil
             }
-
+            
             let manifests = version.manifests.values.filter { $0.toolsVersion != version.defaultToolsVersion }.map { printManifest($0) }.joined(separator: "\n")
             let compatibility = optionalRow(
                 "Verified Compatibility (Platform, Swift Version)",
                 version.verifiedCompatibility?.map { "(\($0.platform.name), \($0.swiftVersion.rawValue))" }.joined(separator: ", ")
             )
             let license = optionalRow("License", version.license?.type.description)
-
+            
             return """
             \(version.version)
             \(self.printManifest(defaultManifest))\(manifests)\(compatibility)\(license)
             """
         }
-
+        
         private func printManifest(_ manifest: PackageCollectionsModel.Package.Version.Manifest) -> String {
             let modules = manifest.targets.compactMap { $0.moduleName }.joined(separator: ", ")
             let products = optionalRow("Products", manifest.products.isEmpty ? nil : manifest.products.compactMap { $0.name }.joined(separator: ", "), indentationLevel: 3)
-
+            
             return """
                     Tools Version: \(manifest.toolsVersion.description)
                         Package Name: \(manifest.packageName)
                         Modules: \(modules)\(products)
             """
         }
-
+        
         mutating func run() throws {
             try with { collections in
                 let identity = PackageIdentity(url: packageURL)
                 let reference = PackageReference.remote(identity: identity, location: packageURL)
-
+                
                 do { // assume URL is for a package in an imported collection
                     let result = try tsc_await { collections.getPackageMetadata(reference, callback: $0) }
-
+                    
                     if let versionString = version {
                         guard let version = TSCUtility.Version(versionString), let result = result.package.versions.first(where: { $0.version == version }), let printedResult = printVersion(result) else {
                             throw CollectionsError.invalidVersionString(versionString)
                         }
-
+                        
                         if jsonOptions.json {
                             try JSONEncoder.makeWithDefaults().print(result)
                         } else {
@@ -289,7 +289,7 @@ public struct SwiftPackageCollectionsTool: ParsableCommand {
                         let license =  optionalRow("License", result.package.license.map { "\($0.type) (\($0.url))" })
                         let languages = optionalRow("Languages", result.package.languages?.joined(separator: ", "))
                         let latestVersion = optionalRow("\(String(repeating: "-", count: 60))\n\(indent())Latest Version", printVersion(result.package.latestVersion))
-
+                        
                         if jsonOptions.json {
                             try JSONEncoder.makeWithDefaults().print(result.package)
                         } else {
@@ -304,23 +304,23 @@ public struct SwiftPackageCollectionsTool: ParsableCommand {
                     if version != nil {
                         throw error
                     }
-
+                    
                     let collectionURL = try url(self.packageURL)
-
+                    
                     do {
                         let source = PackageCollectionsModel.CollectionSource(type: .json, url: collectionURL)
                         let collection = try tsc_await { collections.getCollection(source, callback: $0) }
-
+                        
                         let description = optionalRow("Description", collection.overview)
                         let keywords = optionalRow("Keywords", collection.keywords?.joined(separator: ", "))
                         let createdAt = optionalRow("Created At", DateFormatter().string(from: collection.createdAt))
-                        let packages = collection.packages.map { "\($0.repository.url)" }.joined(separator: "\n\(indent(levels: 2))")
-
+                        let packages = collection.packages.map { "\($0.identity)" }.joined(separator: "\n\(indent(levels: 2))")
+                        
                         if jsonOptions.json {
                             try JSONEncoder.makeWithDefaults().print(collection)
                         } else {
                             let signature = optionalRow("Signed By", collection.signature.map { "\($0.certificate.subject.commonName ?? "Unspecified") (\($0.isVerified ? "" : "not ")verified)" })
-
+                            
                             print("""
                                 Name: \(collection.name)
                                 Source: \(collection.source.url)\(description)\(keywords)\(createdAt)
@@ -367,10 +367,10 @@ private extension ParsableCommand {
                 Self.exit(withError: error)
             }
         }
-
+        
         return try handler(collections)
     }
-
+    
     func url(_ urlString: String) throws -> Foundation.URL {
         guard let url = URL(string: urlString) else {
             let filePrefix = "file://"

Sources/PackageCollections/Model/Package.swift

@@ -17,11 +17,11 @@ import SourceControl
 extension PackageCollectionsModel {
     /// Package metadata
     public struct Package: Codable, Equatable {
-        /// Package reference
-        public let reference: PackageReference
+        /// Package identity
+        public let identity: PackageIdentity
 
-        /// Package's repository address
-        public let repository: RepositorySpecifier
+        /// Package location
+        public let location: String
 
         /// Package description
         public let summary: String?
@@ -85,7 +85,8 @@ extension PackageCollectionsModel {
 
         /// Initializes a `Package`
         init(
-            repository: RepositorySpecifier,
+            identity: PackageIdentity,
+            location: String,
             summary: String?,
             keywords: [String]?,
             versions: [Version],
@@ -95,8 +96,8 @@ extension PackageCollectionsModel {
             authors: [Author]?,
             languages: Set<String>?
         ) {
-            self.reference = .init(repository: repository)
-            self.repository = repository
+            self.identity = identity
+            self.location = location
             self.summary = summary
             self.keywords = keywords
             self.versions = versions
@@ -271,6 +272,6 @@ extension PackageCollectionsModel.Package.Version {
 
 extension Model.Package {
     var displayName: String {
-        self.latestVersion?.packageName ?? self.reference.identity.description
+        self.latestVersion?.packageName ?? self.identity.description
     }
 }

Sources/PackageCollections/Model/TargetListResult.swift

@@ -33,8 +33,11 @@ extension PackageCollectionsModel.TargetListResult {
     public struct Package: Hashable, Encodable {
         public typealias Version = PackageCollectionsModel.TargetListResult.PackageVersion
 
-        /// Package's repository address
-        public let repository: RepositorySpecifier
+        /// Package's identity
+        public let identity: PackageIdentity
+
+        /// Package's location
+        public let location: String
 
         /// Package description
         public let summary: String?