Update barcode scanning to use specific HIDBarcodeParserError type

- Change Result<String, Error> to Result<String, HIDBarcodeParserError> throughout barcode scanning chain
- Update GameControllerBarcodeParser.asResult to return specific error type
- Update scan tester to handle specific error type with error.barcode property
- Update tests to use HIDBarcodeParserError instead of generic TestError

Author: staskus

WooCommerce/Classes/POS/Models/PointOfSaleAggregateModel.swift

@@ -34,7 +34,7 @@ protocol PointOfSaleAggregateModelProtocol {
     var couponsSearchController: PointOfSaleSearchingItemsControllerProtocol { get }
 
     var cart: Cart { get }
-    func barcodeScanned(_ result: Result<String, Error>)
+    func barcodeScanned(_ result: Result<String, HIDBarcodeParserError>)
     func addToCart(_ item: POSItem)
     func remove(cartItem: CartItem)
     func removeAllItemsFromCart(types: [CartItemType])
@@ -185,7 +185,7 @@ extension PointOfSaleAggregateModel {
 // MARK: - Barcode Scanning
 @available(iOS 17.0, *)
 extension PointOfSaleAggregateModel {
-    func barcodeScanned(_ result: Result<String, Error>) {
+    func barcodeScanned(_ result: Result<String, HIDBarcodeParserError>) {
         Task { @MainActor [weak self] in
             guard let self else { return }
             switch result {

WooCommerce/Classes/POS/Presentation/Barcode Scanner Setup/PointOfSaleBarcodeScannerSetupScanTester.swift

@@ -20,18 +20,14 @@ struct PointOfSaleBarcodeScannerSetupScanTester {
         barcodeDefinition.barcodeAsset
     }
 
-    func handleScan(_ scanResult: Result<String, Error>) {
+    func handleScan(_ scanResult: Result<String, HIDBarcodeParserError>) {
         switch scanResult {
         case .success(barcodeDefinition.expectedValue):
             onTestPass()
         case .success(let scannedValue):
             onTestFailure(scannedValue)
-        case .failure(HIDBarcodeParserError.scanTooShort(barcode: let scannedValue)):
-            onTestFailure(scannedValue)
-        case .failure(HIDBarcodeParserError.timedOut(barcode: let scannedValue)):
-            onTestFailure(scannedValue)
-        case .failure:
-            onTestFailure("")
+        case .failure(let error):
+            onTestFailure(error.barcode)
         }
     }
 

WooCommerce/Classes/POS/Presentation/Barcode Scanning/BarcodeScannerContainer.swift

@@ -11,11 +11,11 @@ struct BarcodeScannerContainer: View {
     /// Configuration for the barcode scanner
     let configuration: HIDBarcodeParserConfiguration
     /// Callback that is triggered when a barcode scan completes (success or failure)
-    let onScan: (Result<String, Error>) -> Void
+    let onScan: (Result<String, HIDBarcodeParserError>) -> Void
 
     init(
         configuration: HIDBarcodeParserConfiguration = .default,
-        onScan: @escaping (Result<String, Error>) -> Void
+        onScan: @escaping (Result<String, HIDBarcodeParserError>) -> Void
     ) {
         self.configuration = configuration
         self.onScan = onScan
@@ -37,7 +37,7 @@ struct BarcodeScannerContainer: View {
 /// keyboard input for barcode scanning.
 struct BarcodeScannerContainerRepresentable: UIViewControllerRepresentable {
     let configuration: HIDBarcodeParserConfiguration
-    let onScan: (Result<String, Error>) -> Void
+    let onScan: (Result<String, HIDBarcodeParserError>) -> Void
 
     func makeUIViewController(context: Context) -> UIViewController {
         return GameControllerBarcodeScannerHostingController(
@@ -56,7 +56,7 @@ final class GameControllerBarcodeScannerHostingController: UIHostingController<E
 
     init(
         configuration: HIDBarcodeParserConfiguration,
-        onScan: @escaping (Result<String, Error>) -> Void
+        onScan: @escaping (Result<String, HIDBarcodeParserError>) -> Void
     ) {
         super.init(rootView: EmptyView())
 

WooCommerce/Classes/POS/Presentation/Barcode Scanning/BarcodeScanningModifier.swift

@@ -7,7 +7,7 @@ struct BarcodeScanningModifier: ViewModifier {
     /// Whether barcode scanning is enabled
     @Binding var enabled: Bool
     /// Callback that is triggered when a barcode is successfully scanned
-    let onScan: (Result<String, Error>) -> Void
+    let onScan: (Result<String, HIDBarcodeParserError>) -> Void
 
     private var isBarcodeScani1FeatureEnabled: Bool {
         ServiceLocator.featureFlagService.isFeatureFlagEnabled(.pointOfSaleBarcodeScanningi1)
@@ -32,7 +32,7 @@ extension View {
     ///   - onScan: Callback that is triggered when a barcode is successfully scanned.
     /// - Returns: A view with barcode scanning capability.
     func barcodeScanning(enabled: Binding<Bool> = .constant(true),
-                         onScan: @escaping (Result<String, Error>) -> Void) -> some View {
+                         onScan: @escaping (Result<String, HIDBarcodeParserError>) -> Void) -> some View {
         modifier(BarcodeScanningModifier(enabled: enabled, onScan: onScan))
     }
 }

WooCommerce/Classes/POS/Presentation/Barcode Scanning/GameControllerBarcodeObserver.swift

@@ -9,8 +9,8 @@ import GameController
 ///
 final class GameControllerBarcodeObserver {
     /// A closure that is called when a barcode scan is completed.
-    /// The result will be a `success` with the barcode string or a `failure` with an error.
-    let onScan: (Result<String, Error>) -> Void
+    /// The result will be a `success` with the barcode string or a `failure` with an HIDBarcodeParserError.
+    let onScan: (Result<String, HIDBarcodeParserError>) -> Void
 
     /// Track the coalesced keyboard and its parser
     /// According to Apple's documentation, all connected keyboards are coalesced into one keyboard object
@@ -27,7 +27,7 @@ final class GameControllerBarcodeObserver {
     /// - Parameters:
     ///   - configuration: The configuration to use for the barcode parser. Defaults to the standard configuration.
     ///   - onScan: The closure to be called when a scan is completed.
-    init(configuration: HIDBarcodeParserConfiguration = .default, onScan: @escaping (Result<String, Error>) -> Void) {
+    init(configuration: HIDBarcodeParserConfiguration = .default, onScan: @escaping (Result<String, HIDBarcodeParserError>) -> Void) {
         self.onScan = onScan
         self.configuration = configuration
         addObservers()

WooCommerce/Classes/POS/Presentation/Barcode Scanning/GameControllerBarcodeParser.swift

@@ -253,7 +253,7 @@ enum HIDBarcodeParserResult {
     case success(barcode: String, scanDurationMs: Int)
     case failure(error: HIDBarcodeParserError, scanDurationMs: Int)
 
-    var asResult: Result<String, Error> {
+    var asResult: Result<String, HIDBarcodeParserError> {
         switch self {
         case .success(let barcode, _):
             return .success(barcode)

WooCommerce/WooCommerceTests/POS/Mocks/MockPointOfSaleAggregateModel.swift

@@ -62,7 +62,7 @@ final class MockPointOfSaleAggregateModel: PointOfSaleAggregateModelProtocol {
 
     var cart: Cart = .init()
 
-    func barcodeScanned(_ result: Result<String, Error>) { }
+    func barcodeScanned(_ result: Result<String, HIDBarcodeParserError>) { }
 
     func addToCart(_ item: POSItem) { }
 

WooCommerce/WooCommerceTests/POS/Presentation/Barcode Scanner Setup/PointOfSaleBarcodeScannerSetupScanTesterTests.swift

@@ -70,18 +70,14 @@ struct PointOfSaleBarcodeScannerSetupScanTesterTests {
             onTestTimeout: { onTestTimeoutCalled = true },
             barcodeDefinition: expectedBarcode)
 
-        // When the scan fails
-        sut.handleScan(.failure(TestError.scanFailed))
+        // When the scan fails with scanTooShort error
+        sut.handleScan(.failure(HIDBarcodeParserError.scanTooShort(barcode: "short")))
 
         // Then it calls the failure closure
         #expect(onTestPassCalled == false)
         #expect(onTestFailureCalled == true)
         #expect(onTestTimeoutCalled == false)
-        #expect(receivedScanValue == "")
-    }
-
-    private enum TestError: Error {
-        case scanFailed
+        #expect(receivedScanValue == "short")
     }
 
     @Test func test_scanTester_provides_correct_barcode_asset() {