Validation, & lifecycle methods

Author: tib

Chapter 13/myProject/Sources/App/Framework/Controllers/CreateController.swift

@@ -8,10 +8,22 @@
 import Vapor
 
 protocol CreateController: ModelController {
+    func beforeCreate(_ req: Request, _ model: DatabaseModel) async throws
+    func afterCreate(_ req: Request, _ model: DatabaseModel) async throws
 
+    func create(_ req: Request, _ model: DatabaseModel) async throws
 }
 
 extension CreateController {
 
+    func beforeCreate(_ req: Request, _ model: DatabaseModel) async throws {}
+    
+    func afterCreate(_ req: Request, _ model: DatabaseModel) async throws {}
+
+    func create(_ req: Request, _ model: DatabaseModel) async throws {
+        try await beforeCreate(req, model)
+        try await model.create(on: req.db)
+        try await afterCreate(req, model)
+    }
 }
 

Chapter 13/myProject/Sources/App/Framework/Controllers/DeleteController.swift

@@ -8,9 +8,19 @@
 import Vapor
 
 protocol DeleteController: ModelController {
-    
+    func beforeDelete(_ req: Request, _ model: DatabaseModel) async throws
+    func afterDelete(_ req: Request, _ model: DatabaseModel) async throws
+    func delete(_ req: Request, _ model: DatabaseModel) async throws
 }
 
 extension DeleteController {
 
+    func beforeDelete(_ req: Request, _ model: DatabaseModel) async throws {}
+    func afterDelete(_ req: Request, _ model: DatabaseModel) async throws {}
+    
+    func delete(_ req: Request, _ model: DatabaseModel) async throws {
+        try await beforeDelete(req, model)
+        try await model.delete(on: req.db)
+        try await afterDelete(req, model)
+    }
 }

Chapter 13/myProject/Sources/App/Framework/Controllers/DetailController.swift

@@ -6,11 +6,32 @@
 //
 
 import Vapor
+import Fluent
 
 protocol DetailController: ModelController {
-
+    
+    func beforeDetail(_ req: Request, _ queryBuilder: QueryBuilder<DatabaseModel>) async throws -> QueryBuilder<DatabaseModel>
+    func afterDetail(_ req: Request, _ model: DatabaseModel) async throws -> DatabaseModel
+    func detail(_ req: Request) async throws -> DatabaseModel
 }
 
 extension DetailController {
 
+    func beforeDetail(_ req: Request, _ queryBuilder: QueryBuilder<DatabaseModel>) async throws -> QueryBuilder<DatabaseModel> {
+        queryBuilder
+    }
+    
+    func afterDetail(_ req: Request, _ model: DatabaseModel) async throws -> DatabaseModel {
+        model
+    }
+    
+    func detail(_ req: Request) async throws -> DatabaseModel {
+        let queryBuilder = DatabaseModel.query(on: req.db)
+        let model = try await beforeDetail(req, queryBuilder).filter(\._$id == identifier(req)).first()
+        guard let model = model else {
+            throw Abort(.notFound)
+        }
+        return try await afterDetail(req, model)
+    }
+
 }

Chapter 13/myProject/Sources/App/Framework/Controllers/ListController.swift

@@ -6,15 +6,28 @@
 //
 
 import Vapor
+import Fluent
 
 protocol ListController: ModelController {
 
     func list(_ req: Request) async throws -> [DatabaseModel]
+    func beforeList(_ req: Request, _ queryBuilder: QueryBuilder<DatabaseModel>) async throws -> QueryBuilder<DatabaseModel>
+    func afterList(_ req: Request, _ models: [DatabaseModel]) async throws -> [DatabaseModel]
 }
 
 extension ListController {
+    
+    func beforeList(_ req: Request, _ queryBuilder: QueryBuilder<DatabaseModel>) async throws -> QueryBuilder<DatabaseModel> {
+        queryBuilder
+    }
+
+    func afterList(_ req: Request, _ models: [DatabaseModel]) async throws -> [DatabaseModel] {
+        models
+    }
 
     func list(_ req: Request) async throws -> [DatabaseModel] {
-        try await DatabaseModel.query(on: req.db).all()
+        let queryBuilder = DatabaseModel.query(on: req.db)
+        let list = try await beforeList(req, queryBuilder).all()
+        return try await afterList(req, list)
     }
 }

Chapter 13/myProject/Sources/App/Framework/Controllers/PatchController.swift

@@ -8,9 +8,18 @@
 import Vapor
 
 protocol PatchController: ModelController {
-    
+    func beforePatch(_ req: Request, _ model: DatabaseModel) async throws
+    func afterPatch(_ req: Request, _ model: DatabaseModel) async throws
+    func patch(_ req: Request, _ model: DatabaseModel) async throws
 }
 
 extension PatchController {
-        
+    func beforePatch(_ req: Request, _ model: DatabaseModel) async throws {}
+    func afterPatch(_ req: Request, _ model: DatabaseModel) async throws {}
+    
+    func patch(_ req: Request, _ model: DatabaseModel) async throws {
+        try await beforePatch(req, model)
+        try await model.update(on: req.db)
+        try await afterPatch(req, model)
+    }
 }

Chapter 13/myProject/Sources/App/Framework/Controllers/UpdateController.swift

@@ -8,9 +8,20 @@
 import Vapor
 
 protocol UpdateController: ModelController {
-
+    func beforeUpdate(_ req: Request, _ model: DatabaseModel) async throws
+    func afterUpdate(_ req: Request, _ model: DatabaseModel) async throws
+    func update(_ req: Request, _ model: DatabaseModel) async throws
 }
 
 extension UpdateController {
 
+    func beforeUpdate(_ req: Request, _ model: DatabaseModel) async throws {}
+    
+    func afterUpdate(_ req: Request, _ model: DatabaseModel) async throws {}
+    
+    func update(_ req: Request, _ model: DatabaseModel) async throws {
+        try await beforeUpdate(req, model)
+        try await model.update(on: req.db)
+        try await afterUpdate(req, model)
+    }
 }

Chapter 13/myProject/Sources/App/Framework/Validation/KeyedContentValidator+Validations.swift

@@ -0,0 +1,57 @@
+//
+//  File.swift
+//  
+//
+//  Created by Tibor Bodecs on 2022. 01. 07..
+//
+
+import Vapor
+
+public extension KeyedContentValidator where T == String {
+
+    static func required(_ key: String, _ message: String? = nil, optional: Bool = false) -> KeyedContentValidator<T> {
+        .init(key, message ?? "\(key.capitalized) is required", optional: optional) { value, _ in !value.isEmpty }
+    }
+        
+    static func min(_ key: String, _ length: Int, _ message: String? = nil, optional: Bool = false) -> KeyedContentValidator<T> {
+        .init(key, message ?? "\(key.capitalized) is too short (min: \(length) characters)", optional: optional) { value, _ in value.count >= length }
+    }
+    
+    static func max(_ key: String, _ length: Int, _ message: String? = nil, optional: Bool = false) -> KeyedContentValidator<T> {
+        .init(key, message ?? "\(key.capitalized) is too long (max: \(length) characters)", optional: optional) { value, _ in value.count <= length }
+    }
+
+    static func alphanumeric(_ key: String, _ message: String? = nil, _ optional: Bool = false) -> KeyedContentValidator<T> {
+        .init(key, message ?? "\(key.capitalized) should be only alphanumeric characters", optional: optional) { value, _ in
+            !Validator.characterSet(.alphanumerics).validate(value).isFailure
+        }
+    }
+
+    static func email(_ key: String, _ message: String? = nil, _ optional: Bool = false) -> KeyedContentValidator<T> {
+        .init(key, message ?? "\(key.capitalized) should be a valid email address", optional: optional) { value, _ in
+            !Validator.email.validate(value).isFailure
+        }
+    }
+}
+
+public extension KeyedContentValidator where T == Int {
+
+    static func min(_ key: String, _ length: Int, _ message: String? = nil, optional: Bool = false) -> KeyedContentValidator<T> {
+        .init(key, message ?? "\(key.capitalized) is too short (min: \(length) characters)", optional: optional) { value, _ in value >= length }
+    }
+    
+    static func max(_ key: String, _ length: Int, _ message: String? = nil, optional: Bool = false) -> KeyedContentValidator<T> {
+        .init(key, message ?? "\(key.capitalized) is too long (max: \(length) characters)", optional: optional) { value, _ in value <= length }
+    }
+
+    static func contains(_ key: String, _ values: [Int], _ message: String? = nil, optional: Bool = false) -> KeyedContentValidator<T> {
+        .init(key, message ?? "\(key.capitalized) is an invalid value", optional: optional) { value, _ in values.contains(value) }
+    }
+}
+
+public extension KeyedContentValidator where T == UUID {
+
+    static func required(_ key: String, _ message: String? = nil, optional: Bool = false) -> KeyedContentValidator<T> {
+        .init(key, message ?? "\(key.capitalized) is required", optional: optional) { _, _ in true }
+    }
+}

Chapter 13/myProject/Sources/App/Framework/Validation/KeyedContentValidator.swift

@@ -0,0 +1,34 @@
+//
+//  File.swift
+//  
+//
+//  Created by Tibor Bodecs on 2022. 01. 07..
+//
+
+import Vapor
+
+public struct KeyedContentValidator<T: Codable>: AsyncValidator {
+
+    public let key: String
+    public let message: String
+    public let optional: Bool
+    public let validation: (T, Request) async throws -> Bool
+    
+    public init(_ key: String,
+                _ message: String,
+                optional: Bool = false,
+                _ validation: @escaping (T, Request) async throws -> Bool) {
+        self.key = key
+        self.message = message
+        self.optional = optional
+        self.validation = validation
+    }
+
+    public func validate(_ req: Request) async throws -> ValidationErrorDetail? {
+        let optionalValue = try? req.content.get(T.self, at: key)
+        if let value = optionalValue {
+            return try await validation(value, req) ? nil : error
+        }
+        return optional ? nil : error
+    }
+}

Chapter 13/myProject/Sources/App/Framework/Validation/ValidationError.swift

@@ -0,0 +1,21 @@
+//
+//  File.swift
+//  
+//
+//  Created by Tibor Bodecs on 2022. 01. 07..
+//
+
+import Vapor
+
+struct ValidationError: Codable {
+
+    let message: String?
+    let details: [ValidationErrorDetail]
+    
+    init(message: String?, details: [ValidationErrorDetail]) {
+        self.message = message
+        self.details = details
+    }
+}
+
+extension ValidationError: Content {}

Chapter 13/myProject/Sources/App/Modules/Admin/Controllers/AdminCreateController.swift

@@ -42,7 +42,7 @@ extension AdminCreateController {
             return render(req, editor: editor)
         }
         try await editor.write(req: req)
-        try await editor.model.create(on: req.db)
+        try await create(req, editor.model as! DatabaseModel)
         try await editor.save(req: req)
         var components = req.url.path.pathComponents.dropLast()
         components += editor.model.id!.uuidString.pathComponents