[Collections] Sort packages by name instead of identity (#3599)

* [Collections] Sort packages by name instead of identity

Sorting by package identity is not very intuitive and gets confusing for users.

rdar://80351736

* Use package identity as default instead of 'unknown'

Author: yim-lee

Sources/PackageCollections/Model/Package.swift

@@ -268,3 +268,9 @@ extension PackageCollectionsModel.Package.Version {
         self.manifests[self.defaultToolsVersion]
     }
 }
+
+extension Model.Package {
+    var displayName: String {
+        self.latestVersion?.packageName ?? self.reference.identity.description
+    }
+}

Sources/PackageCollections/PackageCollections.swift

@@ -331,7 +331,7 @@ public struct PackageCollections: PackageCollectionsProtocol {
                 }
 
                 let result = PackageCollectionsModel.PackageSearchResult(
-                    items: packageCollections.sorted { $0.key.identity < $1.key.identity }
+                    items: packageCollections.sorted { $0.value.package.displayName < $1.value.package.displayName }
                         .map { entry in
                             .init(package: entry.value.package, collections: Array(entry.value.collections))
                         }

Sources/PackageCollections/Storage/SQLitePackageCollectionsStorage.swift

@@ -352,8 +352,8 @@ final class SQLitePackageCollectionsStorage: PackageCollectionsStorage, Closable
                         }
 
                     // FTS results are not sorted by relevance at all (FTS5 supports ORDER BY rank but FTS4 requires additional SQL function)
-                    // Sort by package identity for consistent ordering in results
-                    let result = Model.PackageSearchResult(items: packageCollections.sorted { $0.key < $1.key }.map { entry in
+                    // Sort by package name for consistent ordering in results
+                    let result = Model.PackageSearchResult(items: packageCollections.sorted { $0.value.package.displayName < $1.value.package.displayName }.map { entry in
                         .init(package: entry.value.package, collections: Array(entry.value.collections))
                     })
                     callback(.success(result))
@@ -393,8 +393,8 @@ final class SQLitePackageCollectionsStorage: PackageCollectionsStorage, Closable
                         }
                     }
 
-                    // Sort by package identity for consistent ordering in results
-                    let result = Model.PackageSearchResult(items: packageCollections.sorted { $0.key.identity < $1.key.identity }.map { entry in
+                    // Sort by package name for consistent ordering in results
+                    let result = Model.PackageSearchResult(items: packageCollections.sorted { $0.value.package.displayName < $1.value.package.displayName }.map { entry in
                         .init(package: entry.value.package, collections: Array(entry.value.collections))
                     })
                     callback(.success(result))