Makes sure CORSMiddleware always adds before ErrorMiddleware

vapor · Apr 16, 2020 · 54578f5 · 54578f5
1 parent 2698e2c
commit 54578f5
Show file tree

Hide file tree

Showing 3 changed files with 28 additions and 3 deletions.
diff --git a/Sources/Vapor/Middleware/CORSMiddleware.swift b/Sources/Vapor/Middleware/CORSMiddleware.swift
@@ -97,14 +97,14 @@ public final class CORSMiddleware: Middleware {
             allowedHeaders: [HTTPHeaders.Name],
             allowCredentials: Bool = false,
             cacheExpiration: Int? = 600,
-            exposedHeaders: [String]? = nil
+            exposedHeaders: [HTTPHeaders.Name]? = nil
         ) {
             self.allowedOrigin = allowedOrigin
             self.allowedMethods = allowedMethods.map({ "\($0)" }).joined(separator: ", ")
-            self.allowedHeaders = allowedHeaders.map({ $0.description }).joined(separator: ", ")
+            self.allowedHeaders = allowedHeaders.map({ String(describing: $0) }).joined(separator: ", ")
             self.allowCredentials = allowCredentials
             self.cacheExpiration = cacheExpiration
-            self.exposedHeaders = exposedHeaders?.joined(separator: ", ")
+            self.exposedHeaders = exposedHeaders?.map({ String(describing: $0) }).joined(separator: ", ")
         }
     }
 

diff --git a/Sources/Vapor/Middleware/MiddlewareConfiguration.swift b/Sources/Vapor/Middleware/MiddlewareConfiguration.swift
@@ -19,6 +19,15 @@ public struct Middlewares {
     ///            Otherwise, use the type-based method and register the `Middleware`
     ///            using factory method to `Services`.
     public mutating func use(_ middleware: Middleware) {
+        // CORS middleware must come before the ErrorMiddleware. While
+        // we could just always add cors first, that breaks people who want
+        // a specific order for other items.  So just find the ErrorMiddleare
+        // and add it before that
+        if let corsMiddleware = middleware as? CORSMiddleware,
+            let index = self.storage.firstIndex(where: { $0 is ErrorMiddleware }) {
+            self.storage.insert(corsMiddleware, at: index)
+        }
+
         self.storage.append(middleware)
     }
 

diff --git a/Tests/VaporTests/MiddlewareTests.swift b/Tests/VaporTests/MiddlewareTests.swift
@@ -1,3 +1,4 @@
+@testable import Vapor
 import XCTVapor
 
 final class MiddlewareTests: XCTestCase {
@@ -29,4 +30,19 @@ final class MiddlewareTests: XCTestCase {
             XCTAssertEqual(res.body.string, "done")
         }
     }
+
+    func testCorsPosition() throws {
+        let app = Application(.testing)
+        defer { app.shutdown() }
+
+        let cors = CORSMiddleware.init(configuration: .default())
+        app.middleware.use(cors)
+
+        let middlewares = app.middleware.resolve()
+
+        let errorMiddleware = try XCTUnwrap(middlewares.firstIndex(where: { $0 is ErrorMiddleware }))
+        let corsMiddleware = try XCTUnwrap(middlewares.firstIndex(where: { $0 is CORSMiddleware }))
+
+        XCTAssertLessThan(corsMiddleware, errorMiddleware)
+    }
 }