build: fix dependencies (#599)

compnerd · gwynne · web-flow · commit b279723892d8 · 2023-05-30T09:03:36.000-07:00
* build: fix dependencies

We need this to use the new initialiser `init(url:exact:)` for updating
the standalone build to match the CI build.

When building in CI, we would build against swift-crypto 2.5.0 as per
update-checkout-config.json in apple/swift.  Adjust the standalone
builds to match.

When building on CI, we would build against swift-argument-parser 1.2.2
as per update-checkout-config.json in apple/swift.  Make the standalone
builds match.

* - Update Package.swift for Swift 5.6 minimum (as already required by NIO).
- Remove deprecated usages and bump the dependency version requirements for NIO, ArgumentParser, and SwiftCrypto (most especially the latter so that updates in the 2.x series are available).
- Remove old #if swift conditionals no longer required
- Package.resolved now uses the version 2 format

* The platform-specific handling for conforming Array to LMDBData is still required.

---------

Co-authored-by: Gwynne Raskind &lt;gwynne@vapor.codes&gt;
diff --git a/Package.resolved b/Package.resolved
diff --git a/Package.swift b/Package.swift
@@ -1,4 +1,4 @@
-// swift-tools-version:5.5
+// swift-tools-version:5.6
 /*
  This source file is part of the Swift.org open source project
 
@@ -42,17 +42,17 @@ let package = Package(
             name: "SwiftDocC",
             dependencies: [
                 .product(name: "Markdown", package: "swift-markdown"),
-                "SymbolKit",
-                "CLMDB",
+                .product(name: "SymbolKit", package: "swift-docc-symbolkit"),
+                .product(name: "CLMDB", package: "swift-lmdb"),
                 .product(name: "Crypto", package: "swift-crypto"),
             ],
             swiftSettings: swiftSettings
         ),
         .testTarget(
             name: "SwiftDocCTests",
             dependencies: [
-                "SwiftDocC",
-                "SwiftDocCTestUtilities",
+                .target(name: "SwiftDocC"),
+                .target(name: "SwiftDocCTestUtilities"),
             ],
             resources: [
                 .copy("Test Resources"),
@@ -67,7 +67,7 @@ let package = Package(
         .target(
             name: "SwiftDocCUtilities",
             dependencies: [
-                "SwiftDocC",
+                .target(name: "SwiftDocC"),
                 .product(name: "NIOHTTP1", package: "swift-nio"),
                 .product(name: "ArgumentParser", package: "swift-argument-parser")
             ],
@@ -76,9 +76,9 @@ let package = Package(
         .testTarget(
             name: "SwiftDocCUtilitiesTests",
             dependencies: [
-                "SwiftDocCUtilities",
-                "SwiftDocC",
-                "SwiftDocCTestUtilities",
+                .target(name: "SwiftDocCUtilities"),
+                .target(name: "SwiftDocC"),
+                .target(name: "SwiftDocCTestUtilities"),
             ],
             resources: [
                 .copy("Test Resources"),
@@ -90,7 +90,7 @@ let package = Package(
         .target(
             name: "SwiftDocCTestUtilities",
             dependencies: [
-                "SymbolKit"
+                .product(name: "SymbolKit", package: "swift-docc-symbolkit"),
             ],
             swiftSettings: swiftSettings
         ),
@@ -99,7 +99,7 @@ let package = Package(
         .executableTarget(
             name: "docc",
             dependencies: [
-                "SwiftDocCUtilities",
+                .target(name: "SwiftDocCUtilities"),
             ],
             swiftSettings: swiftSettings
         ),
@@ -108,7 +108,7 @@ let package = Package(
         .executableTarget(
             name: "signal-test-app",
             dependencies: [
-                "SwiftDocCUtilities",
+                .target(name: "SwiftDocCUtilities"),
             ],
             path: "Tests/signal-test-app",
             swiftSettings: swiftSettings
@@ -117,8 +117,8 @@ let package = Package(
         .executableTarget(
             name: "generate-symbol-graph",
             dependencies: [
-                "SwiftDocC",
-                "SymbolKit",
+                .target(name: "SwiftDocC"),
+                .product(name: "SymbolKit", package: "swift-docc-symbolkit"),
             ],
             swiftSettings: swiftSettings
         ),
@@ -132,28 +132,22 @@ let package = Package(
 if ProcessInfo.processInfo.environment["SWIFTCI_USE_LOCAL_DEPS"] == nil {
     // Building standalone, so fetch all dependencies remotely.
     package.dependencies += [
-        .package(url: "https://github.com/apple/swift-nio.git", .upToNextMinor(from: "2.31.2")),
-        .package(name: "swift-markdown", url: "https://github.com/apple/swift-markdown.git", .branch("main")),
-        .package(name: "CLMDB", url: "https://github.com/apple/swift-lmdb.git", .branch("main")),
-        .package(url: "https://github.com/apple/swift-argument-parser", .upToNextMinor(from: "1.0.1")),
-        .package(name: "SymbolKit", url: "https://github.com/apple/swift-docc-symbolkit", .branch("main")),
-        .package(url: "https://github.com/apple/swift-crypto.git", .upToNextMinor(from: "1.1.2")),
-    ]
-    
-    // SwiftPM command plugins are only supported by Swift version 5.6 and later.
-    #if swift(>=5.6)
-    package.dependencies += [
+        .package(url: "https://github.com/apple/swift-nio.git", from: "2.53.0"),
+        .package(url: "https://github.com/apple/swift-markdown.git", branch: "main"),
+        .package(url: "https://github.com/apple/swift-lmdb.git", branch: "main"),
+        .package(url: "https://github.com/apple/swift-argument-parser", from: "1.2.2"),
+        .package(url: "https://github.com/apple/swift-docc-symbolkit", branch: "main"),
+        .package(url: "https://github.com/apple/swift-crypto.git", from: "2.5.0"),
         .package(url: "https://github.com/apple/swift-docc-plugin", from: "1.0.0"),
     ]
-    #endif
 } else {
     // Building in the Swift.org CI system, so rely on local versions of dependencies.
     package.dependencies += [
         .package(path: "../swift-nio"),
         .package(path: "../swift-markdown"),
-        .package(name: "CLMDB", path: "../swift-lmdb"),
+        .package(path: "../swift-lmdb"),
         .package(path: "../swift-argument-parser"),
-        .package(name: "SymbolKit", path: "../swift-docc-symbolkit"),
+        .package(path: "../swift-docc-symbolkit"),
         .package(path: "../swift-crypto"),
     ]
 }
diff --git a/Sources/SwiftDocC/Utility/LMDB/LMDB.swift b/Sources/SwiftDocC/Utility/LMDB/LMDB.swift
@@ -81,19 +81,11 @@ extension Data: LMDBData {
         self = Data.init(bytes: data.baseAddress!, count: data.count)
     }
 
-#if swift(>=5.0)
     public func read<R>(_ body: (UnsafeRawBufferPointer) throws -> R) rethrows -> R{
         return try self.withUnsafeBytes({ (ptr) -> R in
             return try body(ptr)
         })
     }
-#else
-    public func read<R>(_ body: (UnsafeRawBufferPointer) throws -> R) rethrows -> R{
-        return try self.withUnsafeBytes({ (ptr) -> R in
-            return try body(UnsafeRawBufferPointer(start: ptr, count: self.count))
-        })
-    }
-#endif
 }
 
 extension String: LMDBData {
@@ -106,10 +98,10 @@ extension String: LMDBData {
     }
 }
 
-#if !os(Linux) && !os(Android)
-// This is required for macOS and Swift 4.2, for Linux the default implementation works as expected.
+// This is required for macOS, for Linux the default implementation works as expected.
 extension Array: LMDBData where Element: FixedWidthInteger {
     
+#if os(macOS) || os(iOS) || os(tvOS) || os(watchOS)
     public init?(data: UnsafeRawBufferPointer) {
         var array = Array<Element>(repeating: 0, count: data.count / MemoryLayout<Element>.stride)
         _ = array.withUnsafeMutableBytes { data.copyBytes(to: $0) }
@@ -120,11 +112,9 @@ extension Array: LMDBData where Element: FixedWidthInteger {
         let data = self.withUnsafeBufferPointer { Data(buffer: $0) }
         return try data.read(body)
     }
+#endif
 
 }
-#else
-extension Array: LMDBData where Element: FixedWidthInteger {}
-#endif
 
 extension Bool: LMDBData {}
 extension Int: LMDBData {}

Original file line number	Diff line number	Diff line change
`@@ -81,19 +81,11 @@ extension Data: LMDBData {`
`81`	`81`	`self = Data.init(bytes: data.baseAddress!, count: data.count)`
`82`	`82`	`}`
`83`	`83`
`84`		`-#if swift(>=5.0)`
`85`	`84`	`public func read<R>(_ body: (UnsafeRawBufferPointer) throws -> R) rethrows -> R{`
`86`	`85`	`return try self.withUnsafeBytes({ (ptr) -> R in`
`87`	`86`	`return try body(ptr)`
`88`	`87`	`})`
`89`	`88`	`}`
`90`		`-#else`
`91`		`- public func read<R>(_ body: (UnsafeRawBufferPointer) throws -> R) rethrows -> R{`
`92`		`- return try self.withUnsafeBytes({ (ptr) -> R in`
`93`		`- return try body(UnsafeRawBufferPointer(start: ptr, count: self.count))`
`94`		`- })`
`95`		`- }`
`96`		`-#endif`
`97`	`89`	`}`
`98`	`90`
`99`	`91`	`extension String: LMDBData {`
`@@ -106,10 +98,10 @@ extension String: LMDBData {`
`106`	`98`	`}`
`107`	`99`	`}`
`108`	`100`
`109`		`-#if !os(Linux) && !os(Android)`
`110`		`-// This is required for macOS and Swift 4.2, for Linux the default implementation works as expected.`
	`101`	`+// This is required for macOS, for Linux the default implementation works as expected.`
`111`	`102`	`extension Array: LMDBData where Element: FixedWidthInteger {`
`112`	`103`
	`104`	`+#if os(macOS) \|\| os(iOS) \|\| os(tvOS) \|\| os(watchOS)`
`113`	`105`	`public init?(data: UnsafeRawBufferPointer) {`
`114`	`106`	`var array = Array<Element>(repeating: 0, count: data.count / MemoryLayout<Element>.stride)`
`115`	`107`	`_ = array.withUnsafeMutableBytes { data.copyBytes(to: $0) }`
`@@ -120,11 +112,9 @@ extension Array: LMDBData where Element: FixedWidthInteger {`
`120`	`112`	`let data = self.withUnsafeBufferPointer { Data(buffer: $0) }`
`121`	`113`	`return try data.read(body)`
`122`	`114`	`}`
	`115`	`+#endif`
`123`	`116`
`124`	`117`	`}`
`125`		`-#else`
`126`		`-extension Array: LMDBData where Element: FixedWidthInteger {}`
`127`		`-#endif`
`128`	`118`
`129`	`119`	`extension Bool: LMDBData {}`
`130`	`120`	`extension Int: LMDBData {}`