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

@@ -131,38 +131,45 @@ Please refer to the [_Get Started_ guide](https://github.com/apple/swift/blob/ma
 
 1. Clone [llbuild](https://github.com/apple/swift-llbuild) beside the SwiftPM directory.
 
-```bash
-$> git clone https://github.com/apple/swift-llbuild llbuild
-```
+   ```bash
+   $> git clone https://github.com/apple/swift-llbuild llbuild
+   ```
 
 Note: Make sure the directory for llbuild is called "llbuild" and not
     "swift-llbuild".
 
 2. Clone [Yams](https://github.com/jpsim/yams) beside the SwiftPM directory.
 
-```bash
-$> git clone https://github.com/jpsim/yams
-```
+   ```bash
+   $> git clone https://github.com/jpsim/yams
+   ```
 
 3. Clone [swift-driver](https://github.com/apple/swift-driver) beside the SwiftPM directory.
 
-```bash
-$> git clone https://github.com/apple/swift-driver
-```
+   ```bash
+   $> git clone https://github.com/apple/swift-driver
+   ```
 
 4. Clone [swift-argument-parser](https://github.com/apple/swift-argument-parser) beside the SwiftPM directory and check out tag with the [latest version](https://github.com/apple/swift-argument-parser/tags).
 
-For example, if the latest tag is 0.3.1:
-```bash
-$> git clone https://github.com/apple/swift-argument-parser --branch 0.3.1
-```
+   For example, if the latest tag is 0.4.3:
+   ```bash
+   $> git clone https://github.com/apple/swift-argument-parser --branch 0.4.3
+   ```
 
 5. Clone [swift-crypto](https://github.com/apple/swift-crypto) beside the SwiftPM directory and check out tag with the [latest version](https://github.com/apple/swift-crypto/tags).
-
-For example, if the latest tag is 1.1.3:
-```bash
-$> git clone https://github.com/apple/swift-crypto --branch 1.1.3
-```
+   
+   For example, if the latest tag is 1.1.4:
+   ```bash
+   $> git clone https://github.com/apple/swift-crypto --branch 1.1.4
+   ```
+
+6. Clone [swift-collections](https://github.com/apple/swift-collections) beside the SwiftPM directory and check out tag with the [latest version](https://github.com/apple/swift-collections/tags).
+
+   For example, if the latest tag is 0.0.3:
+   ```bash
+   $> git clone https://github.com/apple/swift-collections --branch 0.0.3
+   ```
 
 #### Building
 

Package.swift

@@ -15,7 +15,7 @@ import class Foundation.ProcessInfo
 
 
 /** SwiftPMDataModel is the subset of SwiftPM product that includes just its data model.
-This allowis some clients (such as IDEs) that use SwiftPM's data model but not its build system
+This allows some clients (such as IDEs) that use SwiftPM's data model but not its build system
 to not have to depend on SwiftDriver, SwiftLLBuild, etc. We should probably have better names here,
 though that could break some clients.
 */
@@ -33,7 +33,7 @@ let swiftPMDataModelProduct = (
     ]
 )
 
-/** The `libSwiftPM` set of interfaces to programatically work with Swift
+/** The `libSwiftPM` set of interfaces to programmatically work with Swift
  packages.  `libSwiftPM` includes all of the SwiftPM code except the
  command line tools, while `libSwiftPMDataModel` includes only the data model.
 
@@ -126,7 +126,10 @@ let package = Package(
 
         .target(
             name: "Basics",
-            dependencies: ["SwiftToolsSupport-auto"]),
+            dependencies: [
+                .product(name: "OrderedCollections", package: "swift-collections"),
+                "SwiftToolsSupport-auto"
+            ]),
 
         .target(
             /** The llbuild manifest model */
@@ -356,12 +359,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: "1.1.4")),
+        .package(url: "https://github.com/apple/swift-collections.git", .upToNextMinor(from: "0.0.3")),
     ]
 } 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

@@ -12,6 +12,7 @@ add_library(Basics
   Dictionary+Extensions.swift
   DispatchTimeInterval+Extensions.swift
   Errors.swift
+  Exports.swift
   FileSystem+Extensions.swift
   HTPClient+URLSession.swift
   HTTPClient.swift
@@ -21,6 +22,7 @@ add_library(Basics
   SQLiteBackedCache.swift
   Version+Extensions.swift)
 target_link_libraries(Basics PUBLIC
+  OrderedCollections
   TSCBasic
   TSCUtility)
 target_link_libraries(Basics PRIVATE

Sources/Basics/Exports.swift

@@ -0,0 +1,14 @@
+/*
+ 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 OrderedCollections
+
+public typealias OrderedDictionary = OrderedCollections.OrderedDictionary
+public typealias OrderedSet = OrderedCollections.OrderedSet

Sources/Build/BuildPlan.swift

@@ -1987,7 +1987,7 @@ public class BuildPlan {
         }
 
         // Build cache
-        var cflagsCache: OrderedSet<String> = []
+        var cflagsCache: Basics.OrderedSet<String> = []
         var libsCache: [String] = []
         for tuple in ret {
             for cFlag in tuple.cFlags {

Sources/PackageGraph/PackageGraph+Loading.swift

@@ -603,7 +603,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 = Basics.OrderedSet<Manifest>()
 
     // Function to visit nodes recursively.
     // FIXME: Convert to stack.
@@ -612,7 +612,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

@@ -16,20 +16,20 @@ import PackageModel
 /// 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: Basics.OrderedSet<Term>
     public let cause: Cause
 
-    public init(terms: OrderedSet<Term>, cause: Cause) {
+    public init(terms: Basics.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 = Basics.OrderedSet(terms)
         try self.init(termSet, root: root, cause: cause)
     }
 
-    public init(_ terms: OrderedSet<Term>, root: DependencyResolutionNode, cause: Cause) throws {
+    public init(_ terms: Basics.OrderedSet<Term>, root: DependencyResolutionNode, cause: Cause) throws {
         if terms.isEmpty {
             self.init(terms: terms, cause: cause)
             return
@@ -43,7 +43,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 +134,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: Basics.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

@@ -25,7 +25,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: Basics.OrderedDictionary<DependencyResolutionNode, Term> = [:]
 
     /// Union of all negative assignments for a package.
     ///

Sources/PackageGraph/Pubgrub/PubgrubDependencyResolver.swift

@@ -445,7 +445,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: Basics.OrderedSet<DependencyResolutionNode> = [node]
 
         while !changed.isEmpty {
             let package = changed.removeFirst()
@@ -1209,7 +1209,7 @@ private final class PubGrubPackageContainer {
                     throw InternalError("Unexpected unversioned requirement: \(constraint)")
                 }
                 return try constraint.nodes().map { dependencyNode in
-                    var terms: OrderedSet<Term> = []
+                    var terms: Basics.OrderedSet<Term> = []
                     terms.append(Term(node, .exact(version)))
                     terms.append(Term(not: dependencyNode, vs))
                     return try Incompatibility(terms, root: root, cause: .dependency(node: node))
@@ -1223,7 +1223,7 @@ private final class PubGrubPackageContainer {
                                                                 products: node.productFilter)
 
         return try constraints.map { constraint in
-            var terms: OrderedSet<Term> = []
+            var terms: Basics.OrderedSet<Term> = []
             let lowerBound = lowerBounds[constraint.package] ?? "0.0.0"
             let upperBound = upperBounds[constraint.package] ?? Version(version.major + 1, 0, 0)
             assert(lowerBound < upperBound)