Async hooks

tib · tib · commit 4adae5dff25f · 2022-01-08T20:33:25.000+01:00
diff --git a/Chapter 15/myProject/Sources/App/Framework/Hooks/Application+HookStorage.swift b/Chapter 15/myProject/Sources/App/Framework/Hooks/Application+HookStorage.swift
@@ -27,16 +27,3 @@ extension Application {
         }
     }
 }
-
-extension Application {
-
-    func invoke<ReturnType>(_ name: String, args: HookArguments = [:]) -> ReturnType? {
-        let ctxArgs = args.merging(["app": self]) { (_, new) in new }
-        return hooks.invoke(name, args: ctxArgs)
-    }
-
-    func invokeAll<ReturnType>(_ name: String, args: HookArguments = [:]) -> [ReturnType] {
-        let ctxArgs = args.merging(["app": self]) { (_, new) in new }
-        return hooks.invokeAll(name, args: ctxArgs)
-    }
-}
diff --git a/Chapter 15/myProject/Sources/App/Framework/Hooks/Async/Application+AsyncHooks.swift b/Chapter 15/myProject/Sources/App/Framework/Hooks/Async/Application+AsyncHooks.swift
@@ -0,0 +1,21 @@
+//
+//  File.swift
+//  
+//
+//  Created by Tibor Bodecs on 2022. 01. 08..
+//
+
+import Vapor
+
+extension Application {
+
+    func invokeAsync<ReturnType>(_ name: String, args: HookArguments = [:]) async throws -> ReturnType? {
+        let ctxArgs = args.merging(["app": self]) { (_, new) in new }
+        return try await hooks.invokeAsync(name, args: ctxArgs)
+    }
+
+    func invokeAllAsync<ReturnType>(_ name: String, args: HookArguments = [:]) async throws -> [ReturnType] {
+        let ctxArgs = args.merging(["app": self]) { (_, new) in new }
+        return try await hooks.invokeAllAsync(name, args: ctxArgs)
+    }
+}
diff --git a/Chapter 15/myProject/Sources/App/Framework/Hooks/Async/AsyncAnyHookFunction.swift b/Chapter 15/myProject/Sources/App/Framework/Hooks/Async/AsyncAnyHookFunction.swift
@@ -0,0 +1,19 @@
+//
+//  File.swift
+//  
+//
+//  Created by Tibor Bodecs on 2022. 01. 08..
+//
+
+struct AsyncAnyHookFunction: AsyncHookFunction {
+
+    private let functionBlock: AsyncHookFunctionSignature<Any>
+
+    init(_ functionBlock: @escaping AsyncHookFunctionSignature<Any>) {
+        self.functionBlock = functionBlock
+    }
+
+    func invokeAsync(_ args: HookArguments) async throws -> Any {
+        try await functionBlock(args)
+    }
+}
diff --git a/Chapter 15/myProject/Sources/App/Framework/Hooks/Async/AsyncHookFunction.swift b/Chapter 15/myProject/Sources/App/Framework/Hooks/Async/AsyncHookFunction.swift
@@ -0,0 +1,12 @@
+//
+//  File.swift
+//  
+//
+//  Created by Tibor Bodecs on 2022. 01. 08..
+//
+
+protocol AsyncHookFunction {
+    func invokeAsync(_: HookArguments) async throws -> Any
+}
+
+typealias AsyncHookFunctionSignature<T> = (HookArguments) async throws -> T
diff --git a/Chapter 15/myProject/Sources/App/Framework/Hooks/Async/HookStorage+AsyncHooks.swift b/Chapter 15/myProject/Sources/App/Framework/Hooks/Async/HookStorage+AsyncHooks.swift
@@ -0,0 +1,32 @@
+//
+//  File.swift
+//  
+//
+//  Created by Tibor Bodecs on 2022. 01. 08..
+//
+
+extension HookStorage {
+
+    func registerAsync<ReturnType>(_ name: String, use block: @escaping AsyncHookFunctionSignature<ReturnType>) {
+        let function = AsyncAnyHookFunction { args -> Any in
+            try await block(args)
+        }
+        let pointer = HookFunctionPointer<AsyncHookFunction>(name: name, function: function, returnType: ReturnType.self)
+        asyncPointers.append(pointer)
+    }
+    
+    func invokeAsync<ReturnType>(_ name: String, args: HookArguments = [:]) async throws -> ReturnType? {
+        try await asyncPointers.first { $0.name == name && $0.returnType == ReturnType.self }?.pointer.invokeAsync(args) as? ReturnType
+    }
+
+    func invokeAllAsync<ReturnType>(_ name: String, args: HookArguments = [:]) async throws -> [ReturnType] {
+        let fns = asyncPointers.filter { $0.name == name && $0.returnType == ReturnType.self }
+        var result: [ReturnType] = []
+        for fn in fns {
+            if let res = try await fn.pointer.invokeAsync(args) as? ReturnType {
+                result.append(res)
+            }
+        }
+        return result
+    }
+}
diff --git a/Chapter 15/myProject/Sources/App/Framework/Hooks/Async/Request+AsyncHooks.swift b/Chapter 15/myProject/Sources/App/Framework/Hooks/Async/Request+AsyncHooks.swift
@@ -0,0 +1,22 @@
+//
+//  File.swift
+//  
+//
+//  Created by Tibor Bodecs on 2022. 01. 08..
+//
+
+import Vapor
+
+extension Request {
+
+    func invokeAsync<ReturnType>(_ name: String, args: HookArguments = [:]) async throws -> ReturnType? {
+        let ctxArgs = args.merging(["req": self]) { (_, new) in new }
+        return try await application.invokeAsync(name, args: ctxArgs)
+    }
+
+    func invokeAllAsync<ReturnType>(_ name: String, args: HookArguments = [:]) async throws -> [ReturnType] {
+        let ctxArgs = args.merging(["req": self]) { (_, new) in new }
+        return try await application.invokeAllAsync(name, args: ctxArgs)
+    }
+}
+
diff --git a/Chapter 15/myProject/Sources/App/Framework/Hooks/HookArguments.swift b/Chapter 15/myProject/Sources/App/Framework/Hooks/HookArguments.swift
@@ -0,0 +1,8 @@
+//
+//  File.swift
+//  
+//
+//  Created by Tibor Bodecs on 2022. 01. 08..
+//
+
+typealias HookArguments = [String: Any]
diff --git a/Chapter 15/myProject/Sources/App/Framework/Hooks/HookStorage.swift b/Chapter 15/myProject/Sources/App/Framework/Hooks/HookStorage.swift
@@ -7,27 +7,12 @@
 
 final class HookStorage {
 
-    private var pointers: [HookFunctionPointer<HookFunction>]
-    
+    var pointers: [HookFunctionPointer<HookFunction>]
+    var asyncPointers: [HookFunctionPointer<AsyncHookFunction>]
+
     init() {
         self.pointers = []
-    }
-
-    func register<ReturnType>(_ name: String, use block: @escaping HookFunctionSignature<ReturnType>) {
-        let function = AnyHookFunction { args -> Any in
-            block(args)
-        }
-        let pointer = HookFunctionPointer<HookFunction>(name: name, function: function, returnType: ReturnType.self)
-        pointers.append(pointer)
-    }
-
-    func invoke<ReturnType>(_ name: String, args: HookArguments = [:]) -> ReturnType? {
-        pointers.first { $0.name == name && $0.returnType == ReturnType.self }?.pointer.invoke(args) as? ReturnType
-    }
- 
-    func invokeAll<ReturnType>(_ name: String, args: HookArguments = [:]) -> [ReturnType] {
-        let fn = pointers.filter { $0.name == name && $0.returnType == ReturnType.self }
-        return fn.compactMap { $0.pointer.invoke(args) as? ReturnType }
-    }
+        self.asyncPointers = []
+    }    
 }
 
diff --git a/Chapter 15/myProject/Sources/App/Framework/Hooks/Sync/AnyHookFunction.swift b/Chapter 15/myProject/Sources/App/Framework/Hooks/Sync/AnyHookFunction.swift
@@ -9,12 +9,10 @@ struct AnyHookFunction: HookFunction {
 
     private let functionBlock: HookFunctionSignature<Any>
 
-    /// anonymous hooks can be initialized using a function block
     init(_ functionBlock: @escaping HookFunctionSignature<Any>) {
         self.functionBlock = functionBlock
     }
 
-    /// since they are hook functions they can be invoked with a given argument
     func invoke(_ args: HookArguments) -> Any {
         functionBlock(args)
     }
diff --git a/Chapter 15/myProject/Sources/App/Framework/Hooks/Sync/Application+Hooks.swift b/Chapter 15/myProject/Sources/App/Framework/Hooks/Sync/Application+Hooks.swift
@@ -0,0 +1,21 @@
+//
+//  File.swift
+//  
+//
+//  Created by Tibor Bodecs on 2022. 01. 08..
+//
+
+import Vapor
+
+extension Application {
+
+    func invoke<ReturnType>(_ name: String, args: HookArguments = [:]) -> ReturnType? {
+        let ctxArgs = args.merging(["app": self]) { (_, new) in new }
+        return hooks.invoke(name, args: ctxArgs)
+    }
+
+    func invokeAll<ReturnType>(_ name: String, args: HookArguments = [:]) -> [ReturnType] {
+        let ctxArgs = args.merging(["app": self]) { (_, new) in new }
+        return hooks.invokeAll(name, args: ctxArgs)
+    }
+}
diff --git a/Chapter 15/myProject/Sources/App/Framework/Hooks/Sync/HookFunction.swift b/Chapter 15/myProject/Sources/App/Framework/Hooks/Sync/HookFunction.swift
@@ -5,7 +5,6 @@
 //  Created by Tibor Bodecs on 2022. 01. 08..
 //
 
-typealias HookArguments = [String: Any]
 
 protocol HookFunction {
     func invoke(_: HookArguments) -> Any
diff --git a/Chapter 15/myProject/Sources/App/Framework/Hooks/Sync/HookStorage+Hooks.swift b/Chapter 15/myProject/Sources/App/Framework/Hooks/Sync/HookStorage+Hooks.swift
@@ -0,0 +1,26 @@
+//
+//  File.swift
+//  
+//
+//  Created by Tibor Bodecs on 2022. 01. 08..
+//
+
+extension HookStorage {
+
+    func register<ReturnType>(_ name: String, use block: @escaping HookFunctionSignature<ReturnType>) {
+        let function = AnyHookFunction { args -> Any in
+            block(args)
+        }
+        let pointer = HookFunctionPointer<HookFunction>(name: name, function: function, returnType: ReturnType.self)
+        pointers.append(pointer)
+    }
+
+    func invoke<ReturnType>(_ name: String, args: HookArguments = [:]) -> ReturnType? {
+        pointers.first { $0.name == name && $0.returnType == ReturnType.self }?.pointer.invoke(args) as? ReturnType
+    }
+ 
+    func invokeAll<ReturnType>(_ name: String, args: HookArguments = [:]) -> [ReturnType] {
+        let fn = pointers.filter { $0.name == name && $0.returnType == ReturnType.self }
+        return fn.compactMap { $0.pointer.invoke(args) as? ReturnType }
+    }
+}
diff --git a/Chapter 15/myProject/Sources/App/Framework/Hooks/Sync/Request+Hooks.swift b/Chapter 15/myProject/Sources/App/Framework/Hooks/Sync/Request+Hooks.swift
diff --git a/Chapter 15/myProject/Sources/App/Modules/Blog/BlogModule.swift b/Chapter 15/myProject/Sources/App/Modules/Blog/BlogModule.swift
@@ -19,6 +19,8 @@ struct BlogModule: ModuleInterface {
         app.hooks.register("admin-routes", use: router.adminRoutesHook)
         app.hooks.register("api-routes", use: router.apiRoutesHook)
         
+        app.hooks.registerAsync("response", use: router.responseHook)
+
         try router.boot(routes: app.routes)
     }
     
diff --git a/Chapter 15/myProject/Sources/App/Modules/Blog/BlogRouter.swift b/Chapter 15/myProject/Sources/App/Modules/Blog/BlogRouter.swift
@@ -19,7 +19,6 @@ struct BlogRouter: RouteCollection {
     
     func boot(routes: RoutesBuilder) throws {
         routes.get("blog", use: frontendController.blogView)
-        routes.get(.anything, use: frontendController.postView)
     }
     
     func adminRoutesHook(_ args: HookArguments) -> Void {
@@ -35,4 +34,10 @@ struct BlogRouter: RouteCollection {
         postApiController.setupRoutes(routes)
         categoryApiController.setupRoutes(routes)
     }
+    
+    func responseHook(_ args: HookArguments) async throws -> Response? {
+        let req = args["req"] as! Request
+        return try await frontendController.postView(req: req)
+    }
+    
 }
diff --git a/Chapter 15/myProject/Sources/App/Modules/Blog/Controllers/BlogFrontendController.swift b/Chapter 15/myProject/Sources/App/Modules/Blog/Controllers/BlogFrontendController.swift
@@ -26,16 +26,15 @@ struct BlogFrontendController {
         return req.templates.renderHtml(BlogPostsTemplate(ctx))
     }
 
-    func postView(req: Request) async throws -> Response {
+    func postView(req: Request) async throws -> Response? {
         let slug = req.url.path.trimmingCharacters(in: .init(charactersIn: "/"))
         guard
             let post = try await BlogPostModel
                 .query(on: req.db)
                 .filter(\.$slug == slug)
-//                .with(\.$category)
                 .first()
         else {
-            return req.redirect(to: "/")
+            return nil
         }
         let model = try await BlogPostApiController().detailOutput(req, post)
         let context = BlogPostContext(post: model)
diff --git a/Chapter 15/myProject/Sources/App/Modules/Web/Controllers/WebFrontendController.swift b/Chapter 15/myProject/Sources/App/Modules/Web/Controllers/WebFrontendController.swift
@@ -23,4 +23,12 @@ struct WebFrontendController {
 
         return req.templates.renderHtml(WebHomeTemplate(ctx))
     }
+    
+    func anyResponse(req: Request) async throws -> Response {
+        let result: [Response?] = try await req.invokeAllAsync("response")
+        guard let response = result.compactMap({ $0 }).first else {
+            throw Abort(.notFound)
+        }
+        return response
+    }
 }
diff --git a/Chapter 15/myProject/Sources/App/Modules/Web/WebModule.swift b/Chapter 15/myProject/Sources/App/Modules/Web/WebModule.swift
@@ -14,4 +14,8 @@ struct WebModule: ModuleInterface {
     func boot(_ app: Application) throws {
         try router.boot(routes: app.routes)
     }
+    
+    func setUp(_ app: Application) throws {
+        try router.setUpRoutesHooks(app: app)
+    }
 }
diff --git a/Chapter 15/myProject/Sources/App/Modules/Web/WebRouter.swift b/Chapter 15/myProject/Sources/App/Modules/Web/WebRouter.swift
@@ -14,4 +14,8 @@ struct WebRouter: RouteCollection {
     func boot(routes: RoutesBuilder) throws {
         routes.get(use: controller.homeView)
     }
+    
+    func setUpRoutesHooks(app: Application) throws {
+        app.routes.get(.anything, use: controller.anyResponse)
+    }
 }

Original file line number	Diff line number	Diff line change
`@@ -27,16 +27,3 @@ extension Application {`
`27`	`27`	`}`
`28`	`28`	`}`
`29`	`29`	`}`
`30`		`-`
`31`		`-extension Application {`
`32`		`-`
`33`		`- func invoke<ReturnType>(_ name: String, args: HookArguments = [:]) -> ReturnType? {`
`34`		`- let ctxArgs = args.merging(["app": self]) { (_, new) in new }`
`35`		`- return hooks.invoke(name, args: ctxArgs)`
`36`		`- }`
`37`		`-`
`38`		`- func invokeAll<ReturnType>(_ name: String, args: HookArguments = [:]) -> [ReturnType] {`
`39`		`- let ctxArgs = args.merging(["app": self]) { (_, new) in new }`
`40`		`- return hooks.invokeAll(name, args: ctxArgs)`
`41`		`- }`
`42`		`-}`
Original file line number	Diff line number	Diff line change
`@@ -9,12 +9,10 @@ struct AnyHookFunction: HookFunction {`
`9`	`9`
`10`	`10`	`private let functionBlock: HookFunctionSignature<Any>`
`11`	`11`
`12`		`- /// anonymous hooks can be initialized using a function block`
`13`	`12`	`init(_ functionBlock: @escaping HookFunctionSignature<Any>) {`
`14`	`13`	`self.functionBlock = functionBlock`
`15`	`14`	`}`
`16`	`15`
`17`		`- /// since they are hook functions they can be invoked with a given argument`
`18`	`16`	`func invoke(_ args: HookArguments) -> Any {`
`19`	`17`	`functionBlock(args)`
`20`	`18`	`}`