adopt swift-collections

motivation: replace TSC versions of ordered collections with the new ones from swift-collections

changes:

pull in swift-collections as a dependency
update bootstrap script
adapt call-sites to swift-collections

Author: tomerd

CMakeLists.txt

@@ -37,7 +37,7 @@ string(COMPARE EQUAL ${CMAKE_SYSTEM_NAME} Windows CMAKE_INSTALL_DEFAULT)
 option(USE_CMAKE_INSTALL
   "Install build products using cmake's install() instead of the bootstrap script's install()"
   ${CMAKE_INSTALL_DEFAULT})
-  
+
 if(BUILD_SHARED_LIBS)
   set(CMAKE_POSITION_INDEPENDENT_CODE YES)
 endif()
@@ -53,6 +53,7 @@ if(FIND_PM_DEPS)
   find_package(ArgumentParser CONFIG REQUIRED)
   find_package(SwiftCrypto CONFIG REQUIRED)
   find_package(SwiftDriver CONFIG REQUIRED)
+  find_package(SwiftCollections CONFIG REQUIRED)
 endif()
 
 find_package(dispatch QUIET)

CONTRIBUTING.md

@@ -132,7 +132,7 @@ Please refer to the [_Get Started_ guide](https://github.com/apple/swift/blob/ma
 Clone the following repositories beside the SwiftPM directory:
 
 1. [swift-argument-parser] and check out tag with the [latest version](https://github.com/apple/swift-argument-parser/tags).
-   
+
    For example, if the latest tag is 0.4.3:
    ```sh
    $> git clone https://github.com/apple/swift-argument-parser --branch 0.4.3
@@ -150,7 +150,7 @@ Clone the following repositories beside the SwiftPM directory:
    ```
 
 4. [Yams] and checkout tag with the [latest version](https://github.com/jpsim/Yams.git/tags) before 5.0.0.
-   
+
    For example, if the latest tag is 4.0.6:
    ```sh
    $> git clone https://github.com/jpsim/yams --branch 4.0.6
@@ -162,13 +162,21 @@ Clone the following repositories beside the SwiftPM directory:
    ```
 
 6. [swift-crypto] and check out tag with the [latest version](https://github.com/apple/swift-crypto/tags).
-   
+
    For example, if the latest tag is 1.1.6:
    ```sh
    $> git clone https://github.com/apple/swift-crypto --branch 1.1.6
    ```
 
+7. [swift-collections] and check out tag with the [latest version](https://github.com/apple/swift-collections/tags).
+
+    For example, if the latest tag is 1.0.1:
+    ```sh
+    $> git clone https://github.com/apple/swift-collections --branch 1.0.1
+    ```
+
 [swift-argument-parser]: https://github.com/apple/swift-argument-parser
+[swift-collections]: https://github.com/apple/swift-collections
 [swift-crypto]: https://github.com/apple/swift-crypto
 [swift-driver]: https://github.com/apple/swift-driver
 [swift-llbuild]: https://github.com/apple/swift-llbuild
@@ -385,4 +393,3 @@ $> swift package update
 ```
 Alternatively, if you are using Xcode, you can update to the latest version of all packages:  
 **Xcode App** > *File* > *Swift Packages* > *Update to Latest Package Versions*
-

Package.swift

@@ -133,7 +133,10 @@ let package = Package(
 
         .target(
             name: "Basics",
-            dependencies: ["SwiftToolsSupport-auto"]),
+            dependencies: [
+                .product(name: "OrderedCollections", package: "swift-collections"),
+                "SwiftToolsSupport-auto"
+            ]),
 
         .target(
             /** The llbuild manifest model */
@@ -378,12 +381,14 @@ if ProcessInfo.processInfo.environment["SWIFTCI_USE_LOCAL_DEPS"] == nil {
         .package(url: "https://github.com/apple/swift-argument-parser.git", .upToNextMinor(from: "0.4.3")),
         .package(url: "https://github.com/apple/swift-driver.git", .branch(relatedDependenciesBranch)),
         .package(url: "https://github.com/apple/swift-crypto.git", .upToNextMinor(from: minimumCryptoVersion)),
+        .package(url: "https://github.com/apple/swift-collections.git", .upToNextMinor(from: "1.0.1")),
     ]
 } else {
     package.dependencies += [
         .package(path: "../swift-tools-support-core"),
         .package(path: "../swift-argument-parser"),
         .package(path: "../swift-driver"),
         .package(path: "../swift-crypto"),
+        .package(path: "../swift-collections"),
     ]
 }

Sources/Basics/CMakeLists.txt

@@ -14,6 +14,7 @@ add_library(Basics
   DispatchTimeInterval+Extensions.swift
   EnvironmentVariables.swift
   Errors.swift
+  Exports.swift
   FileSystem+Extensions.swift
   HTPClient+URLSession.swift
   HTTPClient.swift
@@ -25,6 +26,7 @@ add_library(Basics
   SQLiteBackedCache.swift
   Version+Extensions.swift)
 target_link_libraries(Basics PUBLIC
+  SwiftCollections::OrderedCollections
   TSCBasic
   TSCUtility)
 target_link_libraries(Basics PRIVATE

Sources/Build/BuildPlan.swift

@@ -9,14 +9,15 @@
 */
 
 import Basics
-import TSCBasic
-import TSCUtility
-import PackageModel
+import Foundation
+import OrderedCollections
 import PackageGraph
 import PackageLoading
-import Foundation
+import PackageModel
 import SPMBuildCore
 @_implementationOnly import SwiftDriver
+import TSCBasic
+import TSCUtility
 
 extension String {
     fileprivate var asSwiftStringLiteralConstant: String {
@@ -1992,7 +1993,7 @@ public class BuildPlan {
         }
 
         // Build cache
-        var cflagsCache: OrderedSet<String> = []
+        var cflagsCache: OrderedCollections.OrderedSet<String> = []
         var libsCache: [String] = []
         for tuple in ret {
             for cFlag in tuple.cFlags {

Sources/PackageGraph/PackageGraph+Loading.swift

@@ -9,6 +9,7 @@
  */
 
 import Basics
+import OrderedCollections
 import PackageLoading
 import PackageModel
 import TSCBasic
@@ -20,7 +21,7 @@ extension PackageGraph {
         root: PackageGraphRoot,
         identityResolver: IdentityResolver,
         additionalFileRules: [FileRuleDescription] = [],
-        externalManifests: OrderedDictionary<PackageIdentity, Manifest>,
+        externalManifests: OrderedCollections.OrderedDictionary<PackageIdentity, Manifest>,
         requiredDependencies: Set<PackageReference> = [],
         unsafeAllowedPackages: Set<PackageReference> = [],
         binaryArtifacts: [BinaryArtifact] = [],
@@ -636,7 +637,7 @@ fileprivate func findCycle(
     successors: (GraphLoadingNode) throws -> [GraphLoadingNode]
 ) rethrows -> (path: [Manifest], cycle: [Manifest])? {
     // Ordered set to hold the current traversed path.
-    var path = OrderedSet<Manifest>()
+    var path = OrderedCollections.OrderedSet<Manifest>()
 
     // Function to visit nodes recursively.
     // FIXME: Convert to stack.
@@ -645,7 +646,7 @@ fileprivate func findCycle(
       _ successors: (GraphLoadingNode) throws -> [GraphLoadingNode]
     ) rethrows -> (path: [Manifest], cycle: [Manifest])? {
         // If this node is already in the current path then we have found a cycle.
-        if !path.append(node.manifest) {
+        if !path.append(node.manifest).inserted {
             let index = path.firstIndex(of: node.manifest)! // forced unwrap safe
             return (Array(path[path.startIndex..<index]), Array(path[index..<path.endIndex]))
         }

Sources/PackageGraph/Pubgrub/Incompatibility.swift

@@ -9,27 +9,28 @@
  */
 
 import Basics
+import OrderedCollections
 import TSCBasic
 import PackageModel
 
 /// A set of terms that are incompatible with each other and can therefore not
 /// all be true at the same time. In dependency resolution, these are derived
 /// from version requirements and when running into unresolvable situations.
 public struct Incompatibility: Equatable, Hashable {
-    public let terms: OrderedSet<Term>
+    public let terms: OrderedCollections.OrderedSet<Term>
     public let cause: Cause
 
-    public init(terms: OrderedSet<Term>, cause: Cause) {
+    public init(terms: OrderedCollections.OrderedSet<Term>, cause: Cause) {
         self.terms = terms
         self.cause = cause
     }
 
     public init(_ terms: Term..., root: DependencyResolutionNode, cause: Cause = .root) throws {
-        let termSet = OrderedSet(terms)
+        let termSet = OrderedCollections.OrderedSet(terms)
         try self.init(termSet, root: root, cause: cause)
     }
 
-    public init(_ terms: OrderedSet<Term>, root: DependencyResolutionNode, cause: Cause) throws {
+    public init(_ terms: OrderedCollections.OrderedSet<Term>, root: DependencyResolutionNode, cause: Cause) throws {
         if terms.isEmpty {
             self.init(terms: terms, cause: cause)
             return
@@ -43,7 +44,7 @@ public struct Incompatibility: Equatable, Hashable {
             terms = OrderedSet(terms.filter { !$0.isPositive || $0.node != root })
         }
 
-        let normalizedTerms = try normalize(terms: terms.contents)
+        let normalizedTerms = try normalize(terms: terms.elements)
         assert(normalizedTerms.count > 0,
                "An incompatibility must contain at least one term after normalization.")
         self.init(terms: OrderedSet(normalizedTerms), cause: cause)
@@ -134,7 +135,7 @@ extension Incompatibility {
 /// requirements to a^1.5.0.
 fileprivate func normalize(terms: [Term]) throws -> [Term] {
 
-    let dict = try terms.reduce(into: OrderedDictionary<DependencyResolutionNode, (req: VersionSetSpecifier, polarity: Bool)>()) {
+    let dict = try terms.reduce(into: OrderedCollections.OrderedDictionary<DependencyResolutionNode, (req: VersionSetSpecifier, polarity: Bool)>()) {
         res, term in
         // Don't try to intersect if this is the first time we're seeing this package.
         guard let previous = res[term.node] else {

Sources/PackageGraph/Pubgrub/PartialSolution.swift

@@ -9,6 +9,7 @@
  */
 
 import Basics
+import OrderedCollections
 import TSCBasic
 import struct TSCUtility.Version
 
@@ -25,7 +26,7 @@ public struct PartialSolution {
 
     /// The intersection of all positive assignments for each package, minus any
     /// negative assignments that refer to that package.
-    public private(set) var _positive: OrderedDictionary<DependencyResolutionNode, Term> = [:]
+    public private(set) var _positive: OrderedCollections.OrderedDictionary<DependencyResolutionNode, Term> = [:]
 
     /// Union of all negative assignments for a package.
     ///

Sources/PackageGraph/Pubgrub/PubgrubDependencyResolver.swift

@@ -10,6 +10,7 @@
 
 import Basics
 import Dispatch
+import OrderedCollections
 import PackageModel
 import TSCBasic
 import TSCUtility
@@ -443,7 +444,7 @@ public struct PubgrubDependencyResolver {
     /// If a conflict is found, the conflicting incompatibility is returned to
     /// resolve the conflict on.
     internal func propagate(state: State, node: DependencyResolutionNode) throws {
-        var changed: OrderedSet<DependencyResolutionNode> = [node]
+        var changed: OrderedCollections.OrderedSet<DependencyResolutionNode> = [node]
 
         while !changed.isEmpty {
             let package = changed.removeFirst()
@@ -1212,7 +1213,7 @@ private final class PubGrubPackageContainer {
                     throw InternalError("Unexpected unversioned requirement: \(constraint)")
                 }
                 return try constraint.nodes().map { dependencyNode in
-                    var terms: OrderedSet<Term> = []
+                    var terms: OrderedCollections.OrderedSet<Term> = []
                     terms.append(Term(node, .exact(version)))
                     terms.append(Term(not: dependencyNode, vs))
                     return try Incompatibility(terms, root: root, cause: .dependency(node: node))
@@ -1226,7 +1227,7 @@ private final class PubGrubPackageContainer {
                                                                 products: node.productFilter)
 
         return try constraints.map { constraint in
-            var terms: OrderedSet<Term> = []
+            var terms: OrderedCollections.OrderedSet<Term> = []
             let lowerBound = lowerBounds[constraint.package] ?? "0.0.0"
             let upperBound = upperBounds[constraint.package] ?? Version(version.major + 1, 0, 0)
             assert(lowerBound < upperBound)

Sources/PackageLoading/PackageBuilder.swift

@@ -10,6 +10,7 @@
 
 import Basics
 import Dispatch
+import OrderedCollections
 import PackageModel
 import TSCBasic
 
@@ -1160,11 +1161,11 @@ public final class PackageBuilder {
 
     /// Collects the products defined by a package.
     private func constructProducts(_ targets: [Target]) throws -> [Product] {
-        var products = OrderedSet<KeyedPair<Product, String>>()
+        var products = OrderedCollections.OrderedSet<KeyedPair<Product, String>>()
 
         /// Helper method to append to products array.
         func append(_ product: Product) {
-            let inserted = products.append(KeyedPair(product, key: product.name))
+            let inserted = products.append(KeyedPair(product, key: product.name)).inserted
             if !inserted {
                 self.observabilityScope.emit(.duplicateProduct(product: product))
             }