feat: Implements common database interactions as dependencies.

Sources/App/Controllers/DB/PurchaseOrderDB.swift

@@ -1,56 +1,72 @@
+import Dependencies
+import DependenciesMacros
 import Fluent
 import Vapor
 
-// An intermediate between our api and view controllers that interacts with the
-// database.
-struct PurchaseOrderDB {
+extension DependencyValues {
+  // An intermediate between our api and view controllers that interacts with the
+  // database.
+  var purchaseOrders: PurchaseOrdersDB {
+    get { self[PurchaseOrdersDB.self] }
+    set { self[PurchaseOrdersDB.self] = newValue }
+  }
+}
 
-  func create(
-    _ model: PurchaseOrder.Create,
-    createdById: User.IDValue,
-    on db: any Database
-  ) async throws -> PurchaseOrder.DTO {
-    guard let employee = try await Employee.find(model.createdForID, on: db) else {
-      throw Abort(.notFound, reason: "Employee not found.")
-    }
+@DependencyClient
+struct PurchaseOrdersDB: Sendable {
+  var create: @Sendable (PurchaseOrder.Create, User.IDValue) async throws -> PurchaseOrder.DTO
+  var fetchAll: @Sendable () async throws -> [PurchaseOrder.DTO]
+  var fetchPage: @Sendable (PageRequest) async throws -> Page<PurchaseOrder.DTO>
+  var get: @Sendable (PurchaseOrder.IDValue) async throws -> PurchaseOrder.DTO?
+  // var update: @Sendable (PurchaseOrder.IDValue, PurchaseOrder.Update) async throws -> PurchaseOrder.DTO
+  var delete: @Sendable (PurchaseOrder.IDValue) async throws -> Void
+}
 
-    guard employee.active else {
-      throw Abort(.badRequest, reason: "Employee is not active, unable to generate a PO for in-active employees")
-    }
+extension PurchaseOrdersDB: TestDependencyKey {
+  static let testValue: PurchaseOrdersDB = Self()
 
-    let purchaseOrder = model.toModel(createdByID: createdById)
-    try await purchaseOrder.save(on: db)
-    guard let loaded = try await get(id: purchaseOrder.requireID(), on: db) else {
-      return purchaseOrder.toDTO()
-    }
-    return loaded
+  static func live(database db: any Database) -> Self {
+    .init(
+      create: { model, createdById in
+        guard let employee = try await Employee.find(model.createdForID, on: db) else {
+          throw Abort(.notFound, reason: "Employee not found.")
+        }
+
+        guard employee.active else {
+          throw Abort(.badRequest, reason: "Employee is not active, unable to generate a PO for in-active employees")
+        }
+
+        let purchaseOrder = model.toModel(createdByID: createdById)
+        try await purchaseOrder.save(on: db)
+        guard let loaded = try await PurchaseOrder.get(purchaseOrder.requireID(), on: db) else {
+          return purchaseOrder.toDTO()
+        }
+        return loaded
+
+      },
+      fetchAll: {
+        try await PurchaseOrder.allQuery(on: db)
+          .sort(\.$id, .descending)
+          .all().map { $0.toDTO() }
+      },
+      fetchPage: { request in
+        try await PurchaseOrder.allQuery(on: db)
+          .sort(\.$id, .descending)
+          .paginate(request)
+          .map { $0.toDTO() }
+      },
+      get: { id in
+        try await PurchaseOrder.get(id, on: db)
+      },
+      delete: { id in
+        guard let purchaseOrder = try await PurchaseOrder.find(id, on: db) else {
+          throw Abort(.notFound)
+        }
+        try await purchaseOrder.delete(on: db)
+      }
+    )
   }
 
-  func fetchAll(on db: any Database) async throws -> [PurchaseOrder.DTO] {
-    try await PurchaseOrder.allQuery(on: db)
-      .sort(\.$id, .descending)
-      .all().map { $0.toDTO() }
-  }
-
-  func fetchPage(_ page: Int, limit: Int, on db: any Database) async throws -> Page<PurchaseOrder.DTO> {
-    try await PurchaseOrder.allQuery(on: db)
-      .sort(\.$id, .descending)
-      .paginate(PageRequest(page: page, per: limit))
-      .map { $0.toDTO() }
-  }
-
-  func get(id: PurchaseOrder.IDValue, on db: any Database) async throws -> PurchaseOrder.DTO? {
-    try await PurchaseOrder.allQuery(on: db)
-      .filter(\.$id == id)
-      .first()?.toDTO()
-  }
-
-  func delete(id: PurchaseOrder.IDValue, on db: any Database) async throws {
-    guard let purchaseOrder = try await PurchaseOrder.find(id, on: db) else {
-      throw Abort(.notFound)
-    }
-    try await purchaseOrder.delete(on: db)
-  }
 }
 
 private extension PurchaseOrder {
@@ -62,4 +78,10 @@ private extension PurchaseOrder {
         branch.with(\.$vendor)
       }
   }
+
+  static func get(_ id: PurchaseOrder.IDValue, on db: any Database) async throws -> PurchaseOrder.DTO? {
+    try await PurchaseOrder.allQuery(on: db)
+      .filter(\.$id == id)
+      .first()?.toDTO()
+  }
 }

Sources/App/Controllers/DB/UserDB.swift

@@ -1,36 +1,56 @@
+import Dependencies
+import DependenciesMacros
 import Fluent
 import Vapor
 
-struct UserDB {
-
-  func create(_ model: User.Create, on db: any Database) async throws -> User.DTO {
-    guard model.password == model.confirmPassword else {
-      throw Abort(.badRequest, reason: "Passwords did not match.")
-    }
-    let user = try User(
-      username: model.username,
-      email: model.email,
-      passwordHash: Bcrypt.hash(model.password)
-    )
-    try await user.save(on: db)
-    return user.toDTO()
+extension DependencyValues {
+  var users: UserDB {
+    get { self[UserDB.self] }
+    set { self[UserDB.self] = newValue }
+  }
+}
+
+@DependencyClient
+struct UserDB: Sendable {
+  var create: @Sendable (User.Create) async throws -> User.DTO
+  var delete: @Sendable (User.IDValue) async throws -> Void
+  var fetchAll: @Sendable () async throws -> [User.DTO]
+  var login: @Sendable (User) async throws -> UserToken
+}
+
+extension UserDB: TestDependencyKey {
+  static let testValue: UserDB = Self()
+
+  static func live(database db: any Database) -> Self {
+    self.init(
+      create: { model in
+        guard model.password == model.confirmPassword else {
+          throw Abort(.badRequest, reason: "Passwords did not match.")
+        }
+        let user = try User(
+          username: model.username,
+          email: model.email,
+          passwordHash: Bcrypt.hash(model.password)
+        )
+        try await user.save(on: db)
+        return user.toDTO()
+
+      },
+      delete: { id in
+        guard let user = try await User.find(id, on: db) else {
+          throw Abort(.notFound)
+        }
+        try await user.delete(on: db)
+
+      },
+      fetchAll: {
+        try await User.query(on: db).all().map { $0.toDTO() }
+      },
+      login: { user in
+        let token = try user.generateToken()
+        try await token.save(on: db)
+        return token
+      }
+    )
   }
-
-  func login(user: User, on db: any Database) async throws -> UserToken {
-    let token = try user.generateToken()
-    try await token.save(on: db)
-    return token
-  }
-
-  func fetchAll(on db: any Database) async throws -> [User.DTO] {
-    try await User.query(on: db).all().map { $0.toDTO() }
-  }
-
-  func delete(id: User.IDValue, on db: any Database) async throws {
-    guard let user = try await User.find(id, on: db) else {
-      throw Abort(.notFound)
-    }
-    try await user.delete(on: db)
-  }
-
 }

Sources/App/Controllers/DB/VendorBranchDB.swift

@@ -1,62 +1,80 @@
+import Dependencies
+import DependenciesMacros
 import Fluent
 import Vapor
 
-struct VendorBranchDB {
-
-  func create(
-    _ model: VendorBranch.Create,
-    for vendorID: Vendor.IDValue,
-    on db: any Database
-  ) async throws -> VendorBranch.DTO {
-    let branch = model.toModel()
-    guard let vendor = try await Vendor.find(vendorID, on: db) else {
-      throw Abort(.badRequest, reason: "Vendor does not exist.")
-    }
-    try await vendor.$branches.create(branch, on: db)
-    return branch.toDTO()
-  }
-
-  func fetchAll(withVendor: Bool? = nil, on db: any Database) async throws -> [VendorBranch.DTO] {
-    var query = VendorBranch.query(on: db)
-    if withVendor == true {
-      query = query.with(\.$vendor)
-    }
-    return try await query.all().map { $0.toDTO() }
-  }
-
-  func fetch(for vendorID: Vendor.IDValue, on db: any Database) async throws -> [VendorBranch.DTO] {
-    guard let vendor = try await Vendor.query(on: db)
-      .filter(\.$id == vendorID)
-      .with(\.$branches)
-      .first()
-    else {
-      throw Abort(.notFound)
-    }
-
-    return vendor.branches.map { $0.toDTO() }
-  }
-
-  func get(id: VendorBranch.IDValue, on db: any Database) async throws -> VendorBranch.DTO? {
-    try await VendorBranch.find(id, on: db).map { $0.toDTO() }
-  }
-
-  func update(
-    id: VendorBranch.IDValue,
-    with updates: VendorBranch.Update,
-    on db: any Database
-  ) async throws -> VendorBranch.DTO {
-    guard let branch = try await VendorBranch.find(id, on: db) else {
-      throw Abort(.notFound)
-    }
-    branch.applyUpdates(updates)
-    try await branch.save(on: db)
-    return branch.toDTO()
-  }
-
-  func delete(id: VendorBranch.IDValue, on db: any Database) async throws {
-    guard let branch = try await VendorBranch.find(id, on: db) else {
-      throw Abort(.notFound)
-    }
-    try await branch.delete(on: db)
+public extension DependencyValues {
+  var vendorBranches: VendorBranchDB {
+    get { self[VendorBranchDB.self] }
+    set { self[VendorBranchDB.self] = newValue }
+  }
+}
+
+@DependencyClient
+public struct VendorBranchDB: Sendable {
+  var create: @Sendable (VendorBranch.Create, Vendor.IDValue) async throws -> VendorBranch.DTO
+  var delete: @Sendable (VendorBranch.IDValue) async throws -> Void
+  var fetchAll: @Sendable (Bool) async throws -> [VendorBranch.DTO]
+  var fetchForVendor: @Sendable (Vendor.IDValue) async throws -> [VendorBranch.DTO]
+  var get: @Sendable (VendorBranch.IDValue) async throws -> VendorBranch.DTO?
+  var update: @Sendable (VendorBranch.IDValue, VendorBranch.Update) async throws -> VendorBranch.DTO
+
+  func fetchAll() async throws -> [VendorBranch.DTO] {
+    try await fetchAll(false)
+  }
+}
+
+extension VendorBranchDB: TestDependencyKey {
+  public static let testValue: VendorBranchDB = Self()
+
+  static func live(database db: any Database) -> Self {
+    .init(
+      create: { model, vendorID in
+        let branch = model.toModel()
+        guard let vendor = try await Vendor.find(vendorID, on: db) else {
+          throw Abort(.badRequest, reason: "Vendor does not exist.")
+        }
+        try await vendor.$branches.create(branch, on: db)
+        return branch.toDTO()
+      },
+      delete: { id in
+        guard let branch = try await VendorBranch.find(id, on: db) else {
+          throw Abort(.notFound)
+        }
+        try await branch.delete(on: db)
+      },
+      fetchAll: { withVendor in
+        var query = VendorBranch.query(on: db)
+        if withVendor == true {
+          query = query.with(\.$vendor)
+        }
+        return try await query.all().map { $0.toDTO() }
+
+      },
+      fetchForVendor: { vendorID in
+        guard let vendor = try await Vendor.query(on: db)
+          .filter(\.$id == vendorID)
+          .with(\.$branches)
+          .first()
+        else {
+          throw Abort(.notFound)
+        }
+
+        return vendor.branches.map { $0.toDTO() }
+
+      },
+      get: { id in
+
+        try await VendorBranch.find(id, on: db).map { $0.toDTO() }
+      },
+      update: { id, updates in
+        guard let branch = try await VendorBranch.find(id, on: db) else {
+          throw Abort(.notFound)
+        }
+        branch.applyUpdates(updates)
+        try await branch.save(on: db)
+        return branch.toDTO()
+      }
+    )
   }
 }

Sources/App/Controllers/DB/VendorDB.swift

@@ -1,47 +1,85 @@
+import Dependencies
+import DependenciesMacros
 import Fluent
 import Vapor
 
-struct VendorDB {
-  func create(_ model: Vendor.Create, on db: any Database) async throws -> Vendor.DTO {
-    let model = model.toModel()
-    try await model.save(on: db)
-    return model.toDTO()
+public extension DependencyValues {
+  var vendors: VendorDB {
+    get { self[VendorDB.self] }
+    set { self[VendorDB.self] = newValue }
+  }
+}
+
+@DependencyClient
+public struct VendorDB: Sendable {
+  var create: @Sendable (Vendor.Create) async throws -> Vendor.DTO
+  var delete: @Sendable (Vendor.IDValue) async throws -> Void
+  var fetchAll: @Sendable (FetchRequest) async throws -> [Vendor.DTO]
+  var get: @Sendable (Vendor.IDValue, GetRequest) async throws -> Vendor.DTO?
+  var update: @Sendable (Vendor.IDValue, Vendor.Update) async throws -> Vendor.DTO
+
+  enum FetchRequest {
+    case `default`
+    case withBranches
+  }
+
+  enum GetRequest {
+    case `default`
+    case withBranches
+  }
+
+  func fetchAll() async throws -> [Vendor.DTO] {
+    try await fetchAll(.default)
+  }
+
+  func get(_ id: Vendor.IDValue) async throws -> Vendor.DTO? {
+    try await get(id, .default)
+  }
+}
+
+extension VendorDB: TestDependencyKey {
+  public static let testValue: VendorDB = Self()
+
+  static func live(database db: any Database) -> Self {
+    .init(
+      create: { model in
+        let model = model.toModel()
+        try await model.save(on: db)
+        return model.toDTO()
+
+      },
+      delete: { id in
+        guard let vendor = try await Vendor.find(id, on: db) else {
+          throw Abort(.notFound)
+        }
+        try await vendor.delete(on: db)
+
+      },
+      fetchAll: { request in
+        var query = Vendor.query(on: db).sort(\.$name, .ascending)
+        let withBranches = request == .withBranches
+        if withBranches {
+          query = query.with(\.$branches)
+        }
+        return try await query.all().map { $0.toDTO(includeBranches: withBranches) }
+
+      },
+      get: { id, request in
+        var query = Vendor.query(on: db).filter(\.$id == id)
+        let withBranches = request == .withBranches
+        if withBranches {
+          query = query.with(\.$branches)
+        }
+        return try await query.first().map { $0.toDTO(includeBranches: withBranches) }
+
+      },
+      update: { id, updates in
+        guard let vendor = try await Vendor.find(id, on: db) else {
+          throw Abort(.notFound)
+        }
+        vendor.applyUpdates(updates)
+        return vendor.toDTO()
+      }
+    )
   }
-
-  func fetchAll(withBranches: Bool? = nil, on db: any Database) async throws -> [Vendor.DTO] {
-    var query = Vendor.query(on: db).sort(\.$name, .ascending)
-    if withBranches == true {
-      query = query.with(\.$branches)
-    }
-    return try await query.all().map { $0.toDTO(includeBranches: withBranches) }
-  }
-
-  func get(id: Vendor.IDValue, withBranches: Bool? = nil, on db: any Database) async throws -> Vendor.DTO? {
-    var query = Vendor.query(on: db).filter(\.$id == id)
-
-    if withBranches == true {
-      query = query.with(\.$branches)
-    }
-    return try await query.first().map { $0.toDTO(includeBranches: withBranches) }
-  }
-
-  func update(
-    id: Vendor.IDValue,
-    with updates: Vendor.Update,
-    on db: any Database
-  ) async throws -> Vendor.DTO {
-    guard let vendor = try await Vendor.find(id, on: db) else {
-      throw Abort(.notFound)
-    }
-    vendor.applyUpdates(updates)
-    return vendor.toDTO()
-  }
-
-  func delete(id: Vendor.IDValue, on db: any Database) async throws {
-    guard let vendor = try await Vendor.find(id, on: db) else {
-      throw Abort(.notFound)
-    }
-    try await vendor.delete(on: db)
-  }
-
 }