Unify error types

vapor-community · Dec 1, 2024 · 1ea069c · 1ea069c
1 parent bb90049
commit 1ea069c
Show file tree

Hide file tree

Showing 8 changed files with 22 additions and 95 deletions.
diff --git a/Sources/Orders/Orders.docc/Orders.md b/Sources/Orders/Orders.docc/Orders.md
@@ -34,7 +34,3 @@ For information on Apple Wallet orders, see the [Apple Developer Documentation](
 - ``OrderModel``
 - ``OrdersRegistrationModel``
 - ``OrderDataModel``
-
-### Errors
-
-- ``OrdersError``
diff --git a/Sources/Orders/OrdersError.swift b/Sources/Orders/OrdersError.swift
diff --git a/Sources/Orders/OrdersServiceCustom.swift b/Sources/Orders/OrdersServiceCustom.swift
@@ -404,7 +404,7 @@ extension OrdersServiceCustom {
         // Swift Crypto doesn't support encrypted PEM private keys, so we have to use OpenSSL for that.
         if let pemPrivateKeyPassword {
             guard FileManager.default.fileExists(atPath: self.openSSLURL.path) else {
-                throw OrdersError.noOpenSSLExecutable
+                throw WalletError.noOpenSSLExecutable
             }
 
             let dir = FileManager.default.temporaryDirectory.appendingPathComponent(UUID().uuidString, isDirectory: true)
@@ -460,7 +460,7 @@ extension OrdersServiceCustom {
         guard
             (try? filesDirectory.resourceValues(forKeys: [.isDirectoryKey]).isDirectory) ?? false
         else {
-            throw OrdersError.noSourceFiles
+            throw WalletError.noSourceFiles
         }
 
         let tempDir = FileManager.default.temporaryDirectory.appendingPathComponent(UUID().uuidString, isDirectory: true)

diff --git a/Sources/Passes/PassesError.swift → Sources/PassKit/WalletError.swift b/Sources/Passes/PassesError.swift → Sources/PassKit/WalletError.swift
@@ -1,13 +1,13 @@
 //
-//  PassesError.swift
+//  WalletError.swift
 //  PassKit
 //
 //  Created by Francesco Paolo Severino on 04/07/24.
 //
 
-/// Errors that can be thrown by PassKit passes.
-public struct PassesError: Error, Sendable, Equatable {
-    /// The type of the errors that can be thrown by PassKit passes.
+/// Errors that can be thrown by Apple Wallet passes and orders.
+public struct WalletError: Error, Sendable, Equatable {
+    /// The type of the errors that can be thrown by Apple Wallet passes and orders.
     public struct ErrorType: Sendable, Hashable, CustomStringConvertible, Equatable {
         enum Base: String, Sendable, Equatable {
             case noSourceFiles
@@ -41,7 +41,7 @@ public struct PassesError: Error, Sendable, Equatable {
             self.errorType = errorType
         }
 
-        static func == (lhs: PassesError.Backing, rhs: PassesError.Backing) -> Bool {
+        static func == (lhs: WalletError.Backing, rhs: WalletError.Backing) -> Bool {
             lhs.errorType == rhs.errorType
         }
     }
@@ -64,13 +64,13 @@ public struct PassesError: Error, Sendable, Equatable {
     /// The number of passes to bundle is invalid.
     public static let invalidNumberOfPasses = Self(errorType: .invalidNumberOfPasses)
 
-    public static func == (lhs: PassesError, rhs: PassesError) -> Bool {
+    public static func == (lhs: WalletError, rhs: WalletError) -> Bool {
         lhs.backing == rhs.backing
     }
 }
 
-extension PassesError: CustomStringConvertible {
+extension WalletError: CustomStringConvertible {
     public var description: String {
-        "PassesError(errorType: \(self.errorType))"
+        "WalletError(errorType: \(self.errorType))"
     }
 }
diff --git a/Sources/Passes/Passes.docc/Passes.md b/Sources/Passes/Passes.docc/Passes.md
@@ -43,10 +43,6 @@ For information on Apple Wallet passes, see the [Apple Developer Documentation](
 - ``PassesRegistrationModel``
 - ``PassDataModel``
 
-### Errors
-
-- ``PassesError``
-
 ### Personalized Passes (⚠️ WIP)
 
 - <doc:Personalization>

diff --git a/Sources/Passes/PassesServiceCustom.swift b/Sources/Passes/PassesServiceCustom.swift
@@ -450,7 +450,7 @@ extension PassesServiceCustom {
         // Swift Crypto doesn't support encrypted PEM private keys, so we have to use OpenSSL for that.
         if let pemPrivateKeyPassword {
             guard FileManager.default.fileExists(atPath: self.openSSLURL.path) else {
-                throw PassesError.noOpenSSLExecutable
+                throw WalletError.noOpenSSLExecutable
             }
 
             let dir = FileManager.default.temporaryDirectory.appendingPathComponent(UUID().uuidString, isDirectory: true)
@@ -506,7 +506,7 @@ extension PassesServiceCustom {
         guard
             (try? filesDirectory.resourceValues(forKeys: [.isDirectoryKey]).isDirectory) ?? false
         else {
-            throw PassesError.noSourceFiles
+            throw WalletError.noSourceFiles
         }
 
         let tempDir = FileManager.default.temporaryDirectory.appendingPathComponent(UUID().uuidString, isDirectory: true)
@@ -558,7 +558,7 @@ extension PassesServiceCustom {
     /// - Returns: The bundle of passes as `Data`.
     public func build(passes: [P], on db: any Database) async throws -> Data {
         guard passes.count > 1 && passes.count <= 10 else {
-            throw PassesError.invalidNumberOfPasses
+            throw WalletError.invalidNumberOfPasses
         }
 
         var files: [ArchiveFile] = []

diff --git a/Tests/OrdersTests/OrdersTests.swift b/Tests/OrdersTests/OrdersTests.swift
@@ -393,10 +393,4 @@ struct OrdersTests {
             }
         }
     }
-
-    @Test("OrdersError")
-    func ordersError() {
-        #expect(OrdersError.noSourceFiles.description == "OrdersError(errorType: noSourceFiles)")
-        #expect(OrdersError.noOpenSSLExecutable.description == "OrdersError(errorType: noOpenSSLExecutable)")
-    }
 }
diff --git a/Tests/PassesTests/PassesTests.swift b/Tests/PassesTests/PassesTests.swift
@@ -66,7 +66,7 @@ struct PassesTests {
             do {
                 let data = try await passesService.build(passes: [pass1], on: app.db)
                 Issue.record("Expected error, got \(data)")
-            } catch let error as PassesError {
+            } catch let error as WalletError {
                 #expect(error == .invalidNumberOfPasses)
             }
         }
@@ -532,11 +532,14 @@ struct PassesTests {
         }
     }
 
-    @Test("PassesError")
-    func passesError() {
-        #expect(PassesError.noSourceFiles.description == "PassesError(errorType: noSourceFiles)")
-        #expect(PassesError.noOpenSSLExecutable.description == "PassesError(errorType: noOpenSSLExecutable)")
-        #expect(PassesError.invalidNumberOfPasses.description == "PassesError(errorType: invalidNumberOfPasses)")
+    @Test("WalletError")
+    func walletError() {
+        #expect(WalletError.noSourceFiles.description == "WalletError(errorType: noSourceFiles)")
+        #expect(WalletError.noOpenSSLExecutable.description == "WalletError(errorType: noOpenSSLExecutable)")
+        #expect(WalletError.invalidNumberOfPasses.description == "WalletError(errorType: invalidNumberOfPasses)")
+
+        #expect(WalletError.noSourceFiles == WalletError.noSourceFiles)
+        #expect(WalletError.noOpenSSLExecutable != WalletError.invalidNumberOfPasses)
     }
 
     @Test("Default PassesDelegate Properties")