Swift 6 Fixes (#37)

### Goals ⚽
This PR upgrades dependencies and fixes `Sendable` issues to allow the
project to build with the Swift 6 compiler.

Author: jshier

.github/workflows/ci.yml

@@ -25,7 +25,7 @@ jobs:
     name: macOS
     runs-on: firebreak
     env:
-      DEVELOPER_DIR: /Applications/Xcode_15.2.app/Contents/Developer
+      DEVELOPER_DIR: /Applications/Xcode_16.0.app/Contents/Developer
     timeout-minutes: 10
     steps:
       - uses: actions/checkout@v4
@@ -35,7 +35,7 @@ jobs:
     name: Linux
     runs-on: ubuntu-latest
     container:
-      image: swift:5.9.0-jammy
+      image: swift:6.0-jammy
     timeout-minutes: 10
     steps:
       - uses: actions/checkout@v4

.github/workflows/release.yml

@@ -9,7 +9,7 @@ jobs:
     name: Upload Release Artifact
     runs-on: firebreak
     env:
-      DEVELOPER_DIR: /Applications/Xcode_15.2.app/Contents/Developer
+      DEVELOPER_DIR: /Applications/Xcode_16.0.app/Contents/Developer
     steps:
       - name: Checkout
         uses: actions/checkout@v4

.swiftformat

@@ -1,12 +1,7 @@
 # file options
 
 --symlinks ignore
---swiftversion 5.9
-
-# rules
---enable isEmpty
---disable andOperator
---disable wrapMultilineStatementBraces
+--swiftversion 6
 
 # format options
 
@@ -22,7 +17,15 @@
 --operatorfunc no-space
 --nospaceoperators ..<, ...
 --selfrequired validate
+--someAny false
 --stripunusedargs closure-only
 --wraparguments preserve
 --wrapcollections preserve
 --wrapparameters preserve
+
+# rules
+
+--enable isEmpty
+--disable andOperator
+--disable opaqueGenericParameters
+--disable wrapMultilineStatementBraces

CHANGELOG.md

@@ -12,6 +12,17 @@ All notable changes to this project will be documented in this file.
 
 ---
 
+## [0.11.0](https://github.com/Alamofire/Firewalk/releases/tag/0.11.0)
+
+Released on 2024-09-28.
+
+#### Updated
+
+- Swift 6 compatibility and dependencies.
+  - Updated by [Jon Shier](https://github.com/jshier) in PR [#37](https://github.com/Alamofire/Firewalk/pull/37).
+
+---
+
 ## [0.10.4](https://github.com/Alamofire/Firewalk/releases/tag/0.10.4)
 
 Released on 2023-01-27.

Package.resolved

@@ -1,8 +1,8 @@
-// swift-tools-version:5.8
+// swift-tools-version:6.0
 //
 //  Package.swift
 //
-//  Copyright (c) 2020-2022 Alamofire Software Foundation (http://alamofire.org/)
+//  Copyright (c) 2020-2024 Alamofire Software Foundation (http://alamofire.org/)
 //
 //  Permission is hereby granted, free of charge, to any person obtaining a copy
 //  of this software and associated documentation files (the "Software"), to deal
@@ -35,7 +35,7 @@ swiftSettings = []
 let package = Package(name: "Firewalk",
                       platforms: [.macOS(.v10_15)],
                       products: [.executable(name: "firewalk", targets: ["firewalk"])],
-                      dependencies: [.package(url: "https://github.com/vapor/vapor.git", from: "4.92.0")],
+                      dependencies: [.package(url: "https://github.com/vapor/vapor.git", from: "4.105.2")],
                       targets: [.executableTarget(name: "firewalk",
                                                   dependencies: [.product(name: "Vapor", package: "vapor")],
                                                   path: "Sources",

Package.swift

@@ -81,12 +81,12 @@ func createDataRoutes(for app: Application) throws {
         }
 
         let response = Response(body: .init(stream: { writer in
-            var bytesToSend = count
+            let bytesToSend = Protected(count)
             request.eventLoop.scheduleRepeatedTask(initialDelay: .seconds(0), delay: .milliseconds(20)) { task in
-                guard bytesToSend > 0 else { task.cancel(); _ = writer.write(.end); return }
+                guard bytesToSend.value > 0 else { task.cancel(); _ = writer.write(.end); return }
 
-                _ = writer.write(.buffer(.init(integer: UInt8(bytesToSend))))
-                bytesToSend -= 1
+                _ = writer.write(.buffer(.init(integer: UInt8(bytesToSend.value))))
+                bytesToSend.write { $0 -= 1 }
             }
         }))
 
@@ -103,12 +103,12 @@ func createDataRoutes(for app: Application) throws {
         let reply = try Reply(to: request)
         let encodedReply = try encoder.encodeAsByteBuffer(reply, allocator: app.allocator)
         let response = Response(body: .init(stream: { writer in
-            var payloadsToSend = count
+            let payloadsToSend = Protected(count)
             request.eventLoop.scheduleRepeatedTask(initialDelay: .seconds(0), delay: .milliseconds(20)) { task in
-                guard payloadsToSend > 0 else { task.cancel(); _ = writer.write(.end); return }
+                guard payloadsToSend.value > 0 else { task.cancel(); _ = writer.write(.end); return }
 
                 _ = writer.write(.buffer(encodedReply))
-                payloadsToSend -= 1
+                payloadsToSend.write { $0 -= 1 }
             }
         }))
 
@@ -120,6 +120,7 @@ func createDataRoutes(for app: Application) throws {
         Response(body: .init(stream: { writer in
             let buffer = request.application.allocator.buffer(repeating: 1, count: 100_000_000)
 
+            @Sendable
             func writeBuffer() {
                 writer.write(.buffer(buffer)).whenComplete { result in
                     switch result {

Sources/Data.swift

@@ -59,26 +59,26 @@ func createDownloadRoutes(for app: Application) throws {
             response.headers.contentRange = .init(unit: .bytes, range: .within(start: totalCount - byteCount, end: totalCount))
         } else {
             response = Response(body: .init(stream: { writer in
-                var buffer = request.application.allocator.buffer(repeating: UInt8.random(), count: totalCount)
-                var bytesToSend = totalCount
+                let buffer = Protected(request.application.allocator.buffer(repeating: UInt8.random(), count: totalCount))
+                let bytesToSend = Protected(totalCount)
                 let segment = (totalCount / 10)
                 request.eventLoop.scheduleRepeatedTask(initialDelay: .seconds(0), delay: .milliseconds(1)) { task in
-                    guard bytesToSend > 0 else { task.cancel(); _ = writer.write(.end); return }
+                    guard bytesToSend.value > 0 else { task.cancel(); _ = writer.write(.end); return }
 
-                    if shouldProduceError, bytesToSend < (totalCount / 2) {
+                    if shouldProduceError, bytesToSend.value < (totalCount / 2) {
                         task.cancel()
                         _ = writer.write(.error(URLError(.networkConnectionLost)))
                         return
                     }
 
-                    guard let bytes = buffer.readSlice(length: segment) else {
+                    guard let bytes = buffer.write({ $0.readSlice(length: segment) }) else {
                         request.logger.info("Failed to read \(segment) bytes from buffer with \(buffer.readableBytes) bytes, ending write.")
                         task.cancel()
                         return
                     }
 
                     _ = writer.write(.buffer(bytes))
-                    bytesToSend -= segment
+                    bytesToSend.write { $0 -= segment }
                 }
             }))
             response.headers.add(name: .acceptRanges, value: "bytes")

Sources/Download.swift

@@ -24,7 +24,7 @@
 
 import Vapor
 
-extension Request: Authenticatable {}
+extension Vapor.Request: Vapor.Authenticatable {}
 
 extension Request {
     var isAuthenticated: Bool {
@@ -37,14 +37,14 @@ extension Application {
     func on(_ methods: [HTTPMethod],
             _ path: PathComponent...,
             body: HTTPBodyStreamStrategy = .collect,
-            use closure: @escaping (Request) throws -> some ResponseEncodable) -> [Route] {
+            use closure: @escaping @Sendable (Request) throws -> some ResponseEncodable) -> [Route] {
         methods.map { on($0, path, body: body, use: closure) }
     }
 
     @discardableResult
     func onMethods(_ methods: [HTTPMethod],
                    body: HTTPBodyStreamStrategy = .collect,
-                   use closure: @escaping (Request) throws -> some ResponseEncodable) -> [Route] {
+                   use closure: @escaping @Sendable (Request) throws -> some ResponseEncodable) -> [Route] {
         methods.map { on($0, .constant($0.rawValue.lowercased()), body: body, use: closure) }
     }
 }
@@ -54,7 +54,7 @@ extension RoutesBuilder {
     func on(_ methods: [HTTPMethod],
             _ path: PathComponent...,
             body: HTTPBodyStreamStrategy = .collect,
-            use closure: @escaping (Request) throws -> some ResponseEncodable) -> [Route] {
+            use closure: @escaping @Sendable (Request) throws -> some ResponseEncodable) -> [Route] {
         methods.map { on($0, path, body: body, use: closure) }
     }
 }