fix custom routes

Author: sebsto

Examples/quoteapi/Sources/QuoteAPI/QuoteService.swift

@@ -14,7 +14,6 @@
 //===----------------------------------------------------------------------===//
 
 import Foundation
-import HTTPTypes
 import Logging
 import OpenAPIRuntime
 import OpenAPILambda
@@ -25,18 +24,16 @@ struct QuoteServiceImpl: APIProtocol, OpenAPILambdaHttpApi {
 
     let logger: Logger
 
-    func register(transport: OpenAPILambdaTransport) throws {
-
-
-        let loggingMiddleware = LoggingMiddleware(logger: logger)
-        try self.registerHandlers(on: transport, middlewares: [loggingMiddleware])
-
+    func register(transport: OpenAPILambdaTransport, middlewares: [ServerMiddleware]) throws {
         // you have a chance here to customize the routes, for example
         try transport.router.get("/health") { _, _ in
             "OK"
         }
 
-        print(transport.router) 
+        let loggingMiddleware = LoggingMiddleware(logger: logger)
+        try self.registerHandlers(on: transport, middlewares: middlewares + [loggingMiddleware])
+
+        logger.trace("Available Routes\n\(transport.router)")  // print the router tree (for debugging purposes)
     }
 
     static func main() async throws {

Examples/quoteapi/events/HealthCheck.json

@@ -0,0 +1,34 @@
+{
+  "rawQueryString": "",
+  "headers": {
+    "host": "b2k1t8fon7.execute-api.us-east-1.amazonaws.com",
+    "x-forwarded-port": "443",
+    "content-length": "0",
+    "x-amzn-trace-id": "Root=1-6571d134-63dbe8ee21efa87555d59265",
+    "x-forwarded-for": "191.95.148.219",
+    "x-forwarded-proto": "https",
+    "accept": "*/*",
+    "user-agent": "curl/8.1.2"
+  },
+  "requestContext": {
+    "apiId": "b2k1t8fon7",
+    "http": {
+      "sourceIp": "191.95.148.219",
+      "userAgent": "curl/8.1.2",
+      "method": "GET",
+      "path": "/health",
+      "protocol": "HTTP/1.1"
+    },
+    "timeEpoch": 1701957940365,
+    "domainPrefix": "b2k1t8fon7",
+    "accountId": "486652066693",
+    "time": "07/Dec/2023:14:05:40 +0000",
+    "stage": "$default",
+    "domainName": "b2k1t8fon7.execute-api.us-east-1.amazonaws.com",
+    "requestId": "Pk2gOia2IAMEPOw="
+  },
+  "isBase64Encoded": false,
+  "version": "2.0",
+  "routeKey": "$default",
+  "rawPath": "/health"
+}

Sources/OpenAPILambdaHandler.swift

@@ -20,7 +20,6 @@ import HTTPTypes
 /// Specialization of LambdaHandler which runs an OpenAPILambda
 public struct OpenAPILambdaHandler<OALS: OpenAPILambdaService>: LambdaHandler, Sendable {
 
-    private let router: OpenAPILambdaRouter
     private let transport: OpenAPILambdaTransport
     private let openAPIService: OALS
 
@@ -38,11 +37,9 @@ public struct OpenAPILambdaHandler<OALS: OpenAPILambdaService>: LambdaHandler, S
     /// - Parameters
     ///   - withService: The OpenAPI Lambda service to bind to this Lambda handler function
     public init(withService openAPILambdaService: OALS) throws {
-        self.router = TrieRouter()
-        self.transport = OpenAPILambdaTransport(router: self.router)
-
         self.openAPIService = openAPILambdaService
-        try self.openAPIService.register(transport: self.transport)
+        self.transport = OpenAPILambdaTransport(router: TrieRouter())
+        try self.openAPIService.register(transport: self.transport, middlewares: [])
     }
 
     /// The Lambda handling method.
@@ -63,7 +60,7 @@ public struct OpenAPILambdaHandler<OALS: OpenAPILambdaService>: LambdaHandler, S
             let request = try openAPIService.request(context: context, from: event)
 
             // route the request to find the handlers and extract the paramaters
-            let (handler, parameters) = try router.route(method: request.0.method, path: request.0.path!)
+            let (handler, parameters) = try self.transport.router.route(method: request.0.method, path: request.0.path!)
 
             // call the request handler (and extract the HTTPRequest and HTTPBody)
             let httpRequest = request.0
@@ -91,10 +88,10 @@ public struct OpenAPILambdaHandler<OALS: OpenAPILambdaService>: LambdaHandler, S
             lambdaResponse = (HTTPResponse(status: .notFound), "There is no route registered for the method \(method)")
 
         }
-        catch OpenAPILambdaRouterError.noRouteForPath(let path) {
+        catch OpenAPILambdaRouterError.noRouteForPath(let method, let path) {
 
             // There is no hadler registered for this path. This is a programming error.
-            lambdaResponse = (HTTPResponse(status: .notFound), "There is no route registered for the path \(path)")
+            lambdaResponse = (HTTPResponse(status: .notFound), "There is no route registered for the path \(method) \(path)")
 
         }
         catch OpenAPILambdaHttpError.invalidMethod(let method) {

Sources/OpenAPILambdaService.swift

@@ -27,7 +27,7 @@ public protocol OpenAPILambdaService: Sendable {
     /// Injects the transport.
     ///
     /// This is where your OpenAPILambdaService implementation must register the transport
-    func register(transport: OpenAPILambdaTransport, middleware: [ServerMiddleware]) throws
+    func register(transport: OpenAPILambdaTransport, middlewares: [ServerMiddleware]) throws
 
     /// Convert from `Event` type to `OpenAPILambdaRequest`
     /// - Parameters:
@@ -55,13 +55,13 @@ extension OpenAPILambdaService {
     }
 }
 
-extension OpenAPILambdaService {
+// extension OpenAPILambdaService {
 
-    /// Injects the transport.
-    /// This is a convenience method that provides an empty middleware list by default
-    ///
-    /// This is where your OpenAPILambdaService implementation must register the transport
-    public func register(transport: OpenAPILambdaTransport, middleware: [ServerMiddleware] = []) throws {
-        try register(transport: transport, middleware: middleware)
-    }
-}
+//     /// Injects the transport.
+//     /// This is a convenience method that provides an empty middleware list by default
+//     ///
+//     /// This is where your OpenAPILambdaService implementation must register the transport
+//     public func register(transport: OpenAPILambdaTransport, middleware: [ServerMiddleware] = []) throws {
+//         try register(transport: transport, middleware: middleware)
+//     }
+// }

Sources/Router/OpenAPILambdaRouter+SimplifiedAPI.swift

@@ -49,7 +49,7 @@ extension OpenAPILambdaRouter {
         _ path: String,
         handler: @escaping @Sendable (HTTPRequest, HTTPBody?) async throws -> String
     ) throws {
-        try generic(method: .post, path: path, handler: handler)
+        try generic(method: .get, path: path, handler: handler)
     }
 
     /// Adds a POST route to the router for the given path.

Sources/Router/OpenAPILambdaRouter.swift

@@ -18,7 +18,7 @@ import HTTPTypes
 
 /// Errors returned by the router
 public enum OpenAPILambdaRouterError: Error {
-    case noRouteForPath(String)
+    case noRouteForPath(HTTPRequest.Method, String)
     case noHandlerForPath(String)
     case noRouteForMethod(HTTPRequest.Method)
 }

Sources/Router/OpenAPILambdaRouterTrie.swift

@@ -163,7 +163,7 @@ struct URIPath: URIPathCollection {
                     currentNode = child
                 }
                 else {
-                    throw OpenAPILambdaRouterError.noRouteForPath(path)
+                    throw OpenAPILambdaRouterError.noRouteForPath(method, path)
                 }
             }
         }