Update to account for Sendable-correct FluentKit

vapor · Apr 27, 2024 · 8817739 · 8817739
1 parent 16412ed
commit 8817739
Show file tree

Hide file tree

Showing 16 changed files with 38 additions and 39 deletions.
diff --git a/Sources/Fluent/Concurrency/FluentProvider+Concurrency.swift b/Sources/Fluent/Concurrency/FluentProvider+Concurrency.swift
@@ -1,4 +1,3 @@
-
 import Vapor
 import FluentKit
 

diff --git a/Sources/Fluent/Concurrency/ModelCredentialsAuthenticatable+Concurrency.swift b/Sources/Fluent/Concurrency/ModelCredentialsAuthenticatable+Concurrency.swift
@@ -1,6 +1,6 @@
 import NIOCore
 import Vapor
-@preconcurrency import FluentKit
+import FluentKit
 
 extension ModelCredentialsAuthenticatable {
     public static func asyncCredentialsAuthenticator(

diff --git a/Sources/Fluent/Concurrency/Sessions+Concurrency.swift b/Sources/Fluent/Concurrency/Sessions+Concurrency.swift
@@ -1,6 +1,6 @@
 import NIOCore
 import Vapor
-@preconcurrency import FluentKit
+import FluentKit
 
 extension Model where Self: SessionAuthenticatable, Self.SessionID == Self.IDValue {
     public static func asyncSessionAuthenticator(

diff --git a/Sources/Fluent/Fluent+Cache.swift b/Sources/Fluent/Fluent+Cache.swift
@@ -1,7 +1,7 @@
 import NIOCore
 import Foundation
 import Vapor
-@preconcurrency import FluentKit
+import FluentKit
 
 extension Application.Caches {
     public var fluent: any Cache {
@@ -49,10 +49,7 @@ private struct FluentCache: Cache {
             }
     }
 
-    func set<T>(_ key: String, to value: T?) -> EventLoopFuture<Void>
-        where T: Encodable
-
-    {
+    func set(_ key: String, to value: (some Encodable)?) -> EventLoopFuture<Void> {
         if let value = value {
             do {
                 let data = try JSONEncoder().encode(value)
@@ -74,7 +71,7 @@ private struct FluentCache: Cache {
     }
 }
 
-public final class CacheEntry: Model {
+public final class CacheEntry: Model, @unchecked Sendable {
     public static let schema: String = "_fluent_cache"
 
     struct Create: Migration {

diff --git a/Sources/Fluent/Fluent+History.swift b/Sources/Fluent/Fluent+History.swift
@@ -1,5 +1,5 @@
 import Vapor
-@preconcurrency import FluentKit
+import FluentKit
 
 struct RequestQueryHistory: StorageKey {
     typealias Value = QueryHistory
@@ -42,12 +42,12 @@ extension Application.Fluent.History {
     }
 
     var history: QueryHistory? {
-        return storage[RequestQueryHistory.self]
+        storage[RequestQueryHistory.self]
     }
 
     /// The queries stored in this lifecycle history
     public var queries: [DatabaseQuery] {
-        return history?.queries ?? []
+        history?.queries ?? []
     }
 
     /// Start recording the query history
@@ -82,12 +82,12 @@ extension Request.Fluent.History {
     }
 
     var history: QueryHistory? {
-        return storage[RequestQueryHistory.self]
+        storage[RequestQueryHistory.self]
     }
 
     /// The queries stored in this lifecycle history
     public var queries: [DatabaseQuery] {
-        return history?.queries ?? []
+        history?.queries ?? []
     }
 
     /// Start recording the query history

diff --git a/Sources/Fluent/Fluent+Sessions.swift b/Sources/Fluent/Fluent+Sessions.swift
@@ -1,7 +1,7 @@
 import Foundation
 import NIOCore
 import Vapor
-@preconcurrency import FluentKit
+import FluentKit
 
 extension Application.Fluent {
     public var sessions: Sessions {
@@ -42,7 +42,7 @@ extension Application.Fluent.Sessions {
 
 extension Application.Sessions.Provider {
     public static var fluent: Self {
-        return .fluent(nil)
+        .fluent(nil)
     }
 
     public static func fluent(_ databaseID: DatabaseID?) -> Self {
@@ -110,7 +110,7 @@ private struct DatabaseSessionAuthenticator<User>: SessionAuthenticator
     }
 }
 
-public final class SessionRecord: Model {
+public final class SessionRecord: Model, @unchecked Sendable {
     public static let schema = "_fluent_sessions"
 
     struct Create: Migration {

diff --git a/Sources/Fluent/FluentProvider.swift b/Sources/Fluent/FluentProvider.swift
@@ -4,7 +4,7 @@ import NIOPosix
 import NIOConcurrencyHelpers
 import Logging
 import Vapor
-@preconcurrency import FluentKit
+import FluentKit
 
 extension Request {
     public var db: any Database {

diff --git a/Sources/Fluent/ModelAuthenticatable.swift b/Sources/Fluent/ModelAuthenticatable.swift
@@ -1,6 +1,6 @@
 import Vapor
 import NIOCore
-@preconcurrency import FluentKit
+import FluentKit
 
 public protocol ModelAuthenticatable: Model, Authenticatable {
     static var usernameKey: KeyPath<Self, Field<String>> { get }

diff --git a/Sources/Fluent/ModelCredentialsAuthenticatable.swift b/Sources/Fluent/ModelCredentialsAuthenticatable.swift
@@ -1,6 +1,6 @@
 import Vapor
 import NIOCore
-@preconcurrency import FluentKit
+import FluentKit
 
 public protocol ModelCredentialsAuthenticatable: Model, Authenticatable {
     static var usernameKey: KeyPath<Self, Field<String>> { get }

diff --git a/Sources/Fluent/ModelTokenAuthenticatable.swift b/Sources/Fluent/ModelTokenAuthenticatable.swift
@@ -1,6 +1,6 @@
 import Vapor
 import NIOCore
-@preconcurrency import FluentKit
+import FluentKit
 
 public protocol ModelTokenAuthenticatable: Model, Authenticatable {
     associatedtype User: Model & Authenticatable

diff --git a/Tests/FluentTests/CredentialTests.swift b/Tests/FluentTests/CredentialTests.swift
@@ -123,7 +123,7 @@ final class CredentialTests: XCTestCase {
     }
 }
 
-final class CredentialsUser: Model {
+final class CredentialsUser: Model, @unchecked Sendable {
     static let schema = "users"
 
     @ID(key: .id)

diff --git a/Tests/FluentTests/OperatorTests.swift b/Tests/FluentTests/OperatorTests.swift
@@ -30,7 +30,7 @@ final class OperatorTests: XCTestCase {
             .filter(\.$name !~ ["Earth", "Mars"])
     }
 }
-private final class Planet: Model {
+private final class Planet: Model, @unchecked Sendable {
     static let schema = "planets"
 
     @ID(custom: .id)
@@ -49,7 +49,7 @@ private struct DummyDatabase: Database {
         fatalError()
     }
 
-    func execute(query: DatabaseQuery, onOutput: @escaping (any DatabaseOutput) -> ()) -> EventLoopFuture<Void> {
+    func execute(query: DatabaseQuery, onOutput: @escaping @Sendable (any DatabaseOutput) -> ()) -> EventLoopFuture<Void> {
         fatalError()
     }
 
@@ -61,11 +61,11 @@ private struct DummyDatabase: Database {
         fatalError()
     }
 
-    func withConnection<T>(_ closure: @escaping (any Database) -> EventLoopFuture<T>) -> EventLoopFuture<T> {
+    func withConnection<T>(_ closure: @escaping @Sendable (any Database) -> EventLoopFuture<T>) -> EventLoopFuture<T> {
         fatalError()
     }
 
-    func transaction<T>(_ closure: @escaping (any Database) -> EventLoopFuture<T>) -> EventLoopFuture<T> {
+    func transaction<T>(_ closure: @escaping @Sendable (any Database) -> EventLoopFuture<T>) -> EventLoopFuture<T> {
         fatalError()
     }
 }
diff --git a/Tests/FluentTests/PaginationTests.swift b/Tests/FluentTests/PaginationTests.swift
@@ -3,31 +3,34 @@ import Vapor
 import XCTVapor
 import XCTFluent
 import FluentKit
+import NIOConcurrencyHelpers
 
 final class PaginationTests: XCTestCase {
     func testPagination() throws {
         let app = Application(.testing)
         defer { app.shutdown() }
 
-        var rows: [TestOutput] = []
+        let rows: NIOLockedValueBox<[TestOutput]> = .init([])
         for i in 1...1_000 {
-            rows.append(TestOutput([
+            rows.withLockedValue { $0.append(TestOutput([
                 "id": i,
                 "title": "Todo #\(i)"
-            ]))
+            ])) }
         }
         let test = CallbackTestDatabase { query in
             XCTAssertEqual(query.schema, "todos")
-            let result: [TestOutput]
-            if let limit = query.limits.first?.value, let offset = query.offsets.first?.value {
-                result = [TestOutput](rows[min(offset, rows.count - 1)..<min(offset + limit, rows.count)])
-            } else {
-                result = rows
+            var result: [TestOutput] = []
+            rows.withLockedValue {
+                if let limit = query.limits.first?.value, let offset = query.offsets.first?.value {
+                    result = [TestOutput]($0[min(offset, $0.count - 1)..<min(offset + limit, $0.count)])
+                } else {
+                    result = $0
+                }
             }
 
             switch query.action {
             case .aggregate(_):
-                return [TestOutput([.aggregate: rows.count])]
+                return [TestOutput([.aggregate: rows.withLockedValue { $0.count }])]
             default:
                 return result
             }
@@ -161,7 +164,7 @@ private extension DatabaseQuery.Offset {
     }
 }
 
-private final class Todo: Model, Content {
+private final class Todo: Model, Content, @unchecked Sendable {
     static let schema = "todos"
 
     @ID(custom: .id)

diff --git a/Tests/FluentTests/QueryHistoryTests.swift b/Tests/FluentTests/QueryHistoryTests.swift
@@ -121,7 +121,7 @@ final class QueryHistoryTests: XCTestCase {
     }
 }
 
-private final class Post: Model, Content, Equatable {
+private final class Post: Model, Content, Equatable, @unchecked Sendable {
     static func == (lhs: Post, rhs: Post) -> Bool {
         lhs.id == rhs.id && lhs.content == rhs.content
     }

diff --git a/Tests/FluentTests/RepositoryTests.swift b/Tests/FluentTests/RepositoryTests.swift
@@ -100,7 +100,7 @@ private struct PostRepositoryFactory: @unchecked Sendable { // not actually Send
     }
 }
 
-private final class Post: Model, Content, Equatable {
+private final class Post: Model, Content, Equatable, @unchecked Sendable {
     static func == (lhs: Post, rhs: Post) -> Bool {
         lhs.id == rhs.id && lhs.content == rhs.content
     }

diff --git a/Tests/FluentTests/SessionTests.swift b/Tests/FluentTests/SessionTests.swift
@@ -65,7 +65,7 @@ final class SessionTests: XCTestCase {
     }
 }
 
-final class User: Model {
+final class User: Model, @unchecked Sendable {
     static let schema = "users"
 
     @ID(key: .id)