Merge pull request #126 from amzn/identifiable_protocol_for_errors

Add and support the Identifiable protocol for errors.
amzn · Aug 15, 2023 · 00cbf01 · 00cbf01
2 parents 1890943 + 6d25b43
commit 00cbf01
Show file tree

Hide file tree

Showing 4 changed files with 56 additions and 23 deletions.
diff --git a/Package.resolved b/Package.resolved
@@ -6,17 +6,17 @@
         "repositoryURL": "https://github.com/swift-server/async-http-client.git",
         "state": {
           "branch": null,
-          "revision": "333e60cc90f52973f7ee29cd8e3a7f6adfe79f4e",
-          "version": "1.17.0"
+          "revision": "78db67e5bf4a8543075787f228e8920097319281",
+          "version": "1.18.0"
         }
       },
       {
         "package": "smoke-http",
         "repositoryURL": "https://github.com/amzn/smoke-http.git",
         "state": {
           "branch": null,
-          "revision": "f0a8debc8048afd30540ea3f2c80e3486530aa17",
-          "version": "2.19.1"
+          "revision": "84e6805ca07f9e4d7c39fbf61b7feff0484ee67f",
+          "version": "2.21.0"
         }
       },
       {
@@ -42,35 +42,35 @@
         "repositoryURL": "https://github.com/apple/swift-distributed-tracing.git",
         "state": {
           "branch": null,
-          "revision": "ba07967bb775ed8aa73c46ab731c85b9fb613305",
-          "version": "1.0.0"
+          "revision": "49b7617717a09f6b781c9a11e1628e3315d8d4fe",
+          "version": "1.0.1"
         }
       },
       {
         "package": "swift-log",
         "repositoryURL": "https://github.com/apple/swift-log.git",
         "state": {
           "branch": null,
-          "revision": "32e8d724467f8fe623624570367e3d50c5638e46",
-          "version": "1.5.2"
+          "revision": "532d8b529501fb73a2455b179e0bbb6d49b652ed",
+          "version": "1.5.3"
         }
       },
       {
         "package": "swift-metrics",
         "repositoryURL": "https://github.com/apple/swift-metrics.git",
         "state": {
           "branch": null,
-          "revision": "e8bced74bc6d747745935e469f45d03f048d6cbd",
-          "version": "2.3.4"
+          "revision": "971ba26378ab69c43737ee7ba967a896cb74c0d1",
+          "version": "2.4.1"
         }
       },
       {
         "package": "swift-nio",
         "repositoryURL": "https://github.com/apple/swift-nio.git",
         "state": {
           "branch": null,
-          "revision": "2d8e6ca36fe3e8ed74b0883f593757a45463c34d",
-          "version": "2.53.0"
+          "revision": "cf281631ff10ec6111f2761052aa81896a83a007",
+          "version": "2.58.0"
         }
       },
       {
@@ -87,8 +87,8 @@
         "repositoryURL": "https://github.com/apple/swift-nio-http2.git",
         "state": {
           "branch": null,
-          "revision": "6d021a48483dbb273a9be43f65234bdc9185b364",
-          "version": "1.26.0"
+          "revision": "a8ccf13fa62775277a5d56844878c828bbb3be1a",
+          "version": "1.27.0"
         }
       },
       {
@@ -105,8 +105,8 @@
         "repositoryURL": "https://github.com/apple/swift-nio-transport-services.git",
         "state": {
           "branch": null,
-          "revision": "41f4098903878418537020075a4d8a6e20a0b182",
-          "version": "1.17.0"
+          "revision": "e7403c35ca6bb539a7ca353b91cc2d8ec0362d58",
+          "version": "1.19.0"
         }
       },
       {

diff --git a/Sources/SmokeOperations/OperationHandlerExtensions.swift b/Sources/SmokeOperations/OperationHandlerExtensions.swift
@@ -53,13 +53,26 @@ public extension OperationHandler {
         error: SmokeReturnableError,
         allowedErrors: [(ShapeType, Int)])
         -> OperationFailure? where ShapeType: ErrorIdentifiableByDescription {
-            let requiredIdentity = error.description
+            let requiredIdentity: String
+            if let identifiableError = error as? Identifiable {
+                requiredIdentity = identifiableError.identity
+            } else {
+                requiredIdentity = error.description
+            }
 
             // get the code of the first entry in the allowedErrors array that has
             // the required identity.
-            let code = allowedErrors.filter { entry in entry.0.description == requiredIdentity }
-                .map { entry in entry.1 }
-                .first
+            let code = allowedErrors.filter { entry in
+                let identity: String
+                if let identifiableError = entry.0 as? Identifiable {
+                    identity = identifiableError.identity
+                } else {
+                    identity = entry.0.description
+                }
+
+                return identity == requiredIdentity
+            }.map { entry in entry.1 }
+            .first
 
             if let code = code {
                 return OperationFailure(code: code,

diff --git a/Sources/SmokeOperations/ReturnableErrorProtocols.swift b/Sources/SmokeOperations/ReturnableErrorProtocols.swift
@@ -18,6 +18,10 @@
 import Foundation
 import Logging
 
+public protocol Identifiable {
+    var identity: String { get }
+}
+
 /// Type alias for an error that also can be identified by its description
 public typealias ErrorIdentifiableByDescription =
     Swift.Error & CustomStringConvertible

diff --git a/Sources/SmokeOperationsHTTP1/GenericJSONPayloadHTTP1OperationDelegate.swift b/Sources/SmokeOperationsHTTP1/GenericJSONPayloadHTTP1OperationDelegate.swift
@@ -17,6 +17,7 @@
 
 import Foundation
 import SmokeOperations
+import NIOHTTP1
 import HTTPPathCoding
 import HTTPHeadersCoding
 import QueryCoding
@@ -28,8 +29,15 @@ internal struct MimeTypes {
 
 internal struct JSONErrorEncoder: ErrorEncoder {
     public func encode<InputType>(_ input: InputType, logger: Logger) throws -> Data where InputType: SmokeReturnableError {
+        let reason: String
+        if let identifiableError = input as? Identifiable {
+            reason = identifiableError.identity
+        } else {
+            reason = input.description
+        }
+
         return JSONEncoder.encodePayload(payload: input, logger: logger,
-                                         reason: input.description)
+                                         reason: reason)
     }
 }
 
@@ -254,8 +262,16 @@ public struct GenericJSONPayloadHTTP1OperationDelegate<ResponseHandlerType: HTTP
         let body = (contentType: MimeTypes.json, data: encodedOutput)
         let responseComponents = HTTP1ServerResponseComponents(additionalHeaders: [], body: body)
 
-        responseHandler.complete(invocationContext: invocationContext, status: .custom(code: UInt(operationFailure.code),
-                                                                                       reasonPhrase: operationFailure.error.description),
+        let status: HTTPResponseStatus
+        if let identifiableError = operationFailure.error as? Identifiable {
+            status = .custom(code: UInt(operationFailure.code),
+                             reasonPhrase: identifiableError.identity)
+        } else {
+            status = .custom(code: UInt(operationFailure.code),
+                             reasonPhrase: operationFailure.error.description)
+        }
+
+        responseHandler.complete(invocationContext: invocationContext, status: status,
                                  responseComponents: responseComponents)
     }