Use @mainactor for accessing migrations

hummingbird-project · Dec 25, 2023 · 30ef912 · 30ef912
1 parent 568da4b
commit 30ef912
Show file tree

Hide file tree

Showing 4 changed files with 21 additions and 7 deletions.
diff --git a/Sources/HummingbirdFluent/Fluent.swift b/Sources/HummingbirdFluent/Fluent.swift
@@ -16,20 +16,31 @@ import FluentKit
 import Hummingbird
 import ServiceLifecycle
 
+@MainActor
+public struct MainActorBox<Value>: Sendable {
+    let value: Value
+}
+
+extension Databases: @unchecked Sendable {}
+extension DatabaseID: @unchecked Sendable {}
+
 /// Manage fluent databases and migrations
 ///
 /// You can either create this separate from `HBApplication` or add it to your application
 /// using `HBApplication.addFluent`.
-public struct HBFluent: @unchecked Sendable, Service {
+public struct HBFluent: Sendable, Service {
     /// Databases attached
     public let databases: Databases
     /// List of migrations
-    public let migrations: Migrations
+    let _migrations: MainActorBox<Migrations>
     /// Event loop group
     public let eventLoopGroup: EventLoopGroup
     /// Logger
     public let logger: Logger
 
+    @MainActor
+    public var migrations: Migrations { self._migrations.value }
+
     /// Initialize HBFluent
     /// - Parameters:
     ///   - eventLoopGroup: EventLoopGroup used by databases
@@ -42,7 +53,7 @@ public struct HBFluent: @unchecked Sendable, Service {
     ) {
         let eventLoopGroup = eventLoopGroupProvider.eventLoopGroup
         self.databases = Databases(threadPool: threadPool, on: eventLoopGroup)
-        self.migrations = .init()
+        self._migrations = .init(value: .init())
         self.eventLoopGroup = eventLoopGroup
         self.logger = logger
     }
@@ -53,6 +64,7 @@ public struct HBFluent: @unchecked Sendable, Service {
     }
 
     /// fluent migrator
+    @MainActor
     public var migrator: Migrator {
         Migrator(
             databases: self.databases,
@@ -63,12 +75,14 @@ public struct HBFluent: @unchecked Sendable, Service {
     }
 
     /// Run migration if needed
+    @MainActor
     public func migrate() async throws {
         try await self.migrator.setupIfNeeded().get()
         try await self.migrator.prepareBatch().get()
     }
 
     /// Run revert if needed
+    @MainActor
     public func revert() async throws {
         try await self.migrator.setupIfNeeded().get()
         try await self.migrator.revertAllBatches().get()

diff --git a/Sources/HummingbirdFluent/Persist+fluent.swift b/Sources/HummingbirdFluent/Persist+fluent.swift
@@ -26,10 +26,10 @@ public final class HBFluentPersistDriver: HBPersistDriver {
     /// - Parameters:
     ///   - fluent: Fluent setup
     ///   - databaseID: ID of database to use
-    public init(fluent: HBFluent, databaseID: DatabaseID? = nil) {
+    public init(fluent: HBFluent, databaseID: DatabaseID? = nil) async {
         self.fluent = fluent
         self.databaseID = databaseID
-        self.fluent.migrations.add(CreatePersistModel())
+        await self.fluent.migrations.add(CreatePersistModel())
         self.tidy()
     }
 

diff --git a/Tests/HummingbirdFluentTests/FluentTests.swift b/Tests/HummingbirdFluentTests/FluentTests.swift
@@ -75,7 +75,7 @@ final class FluentTests: XCTestCase {
         fluent.databases.use(.sqlite(.memory), as: .sqlite)
         // fluent.databases.use(.postgres(hostname: "localhost", username: "postgres", password: "vapor", database: "vapor"), as: .psql)
         // add migration
-        fluent.migrations.add(CreatePlanet())
+        await fluent.migrations.add(CreatePlanet())
         // run migrations
         try await fluent.migrate()
 

diff --git a/Tests/HummingbirdFluentTests/PersistTests.swift b/Tests/HummingbirdFluentTests/PersistTests.swift
@@ -25,7 +25,7 @@ final class PersistTests: XCTestCase {
         // add sqlite database
         fluent.databases.use(.sqlite(.memory), as: .sqlite)
         // fluent.databases.use(.postgres(hostname: "localhost", username: "postgres", password: "vapor", database: "vapor"), as: .psql)
-        let persist = HBFluentPersistDriver(fluent: fluent)
+        let persist = await HBFluentPersistDriver(fluent: fluent)
         // run migrations
         try await fluent.migrate()