fix: service exception handling (#21)

Author: atierian

Package.resolved

@@ -13,7 +13,7 @@ let package = Package(
             targets: ["FaceLiveness"]),
     ],
     dependencies: [
-        .package(url: "https://github.com/aws-amplify/amplify-swift", from: "2.8.0")
+        .package(url: "https://github.com/aws-amplify/amplify-swift", from: "2.11.0")
     ],
     targets: [
         .target(

Package.swift

@@ -57,7 +57,7 @@ struct UserAgentValues {
             swiftVersion: Swift().version(),
             unameMachine: Device.current.machine.replacingOccurrences(of: ",", with: "_"),
             locale: Locale.current.identifier,
-            lib: "lib/amplify-ui-swift-face-liveness/0.1.16",
+            lib: "lib/amplify-ui-swift-face-liveness/1.0.1",
             additionalMetadata: additionalMetadata
         )
     }

Sources/FaceLiveness/Utilities/UserAgent.swift

@@ -12,6 +12,12 @@ public struct FaceLivenessDetectionError: Error, Equatable {
     public let message: String
     public let recoverySuggestion: String
 
+    public static let unknown = FaceLivenessDetectionError(
+        code: 0,
+        message: "An unknown error occurred.",
+        recoverySuggestion: "Please open an issue...."
+    )
+
     public static let sessionNotFound = FaceLivenessDetectionError(
         code: 1,
         message: "Session not found.",
@@ -78,10 +84,42 @@ public struct FaceLivenessDetectionError: Error, Equatable {
         recoverySuggestion: "Confirm that you are using a valid `region` and try again."
     )
 
-    public static let unknown = FaceLivenessDetectionError(
+    public static let validation = FaceLivenessDetectionError(
         code: 12,
-        message: "An unknown error occurred.",
-        recoverySuggestion: "Please open an issue...."
+        message: "The input fails to satisfy the constraints specified by the service.",
+        recoverySuggestion: """
+        Potential reasons inlcude: video quality or size is invalid, video container format not supported,
+        video does not have enough information - no person detected in video, request couldn't be parsed or is invalid,
+        session has expired or is invalid, S3 bucket is invalid/in another AWS region, KMS Key is invalid."
+        """
+    )
+
+    public static let internalServer = FaceLivenessDetectionError(
+        code: 13,
+        message: "Unexpected error during processing of request.",
+        recoverySuggestion: ""
+    )
+
+    public static let throttling = FaceLivenessDetectionError(
+        code: 14,
+        message: "A request was denied due to request throttling.",
+        recoverySuggestion: """
+        Occurs when too many requests were made by a user (exceeding their service quota),
+        the service isn't able to scale, or a service-wide throttling was done to
+        recover from an operational event.
+        """
+    )
+
+    public static let serviceQuotaExceeded = FaceLivenessDetectionError(
+        code: 15,
+        message: "Occurs when a request would cause a service quota to be exceeded.",
+        recoverySuggestion: ""
+    )
+
+    public static let serviceUnavailable = FaceLivenessDetectionError(
+        code: 16,
+        message: "Service-wide throttling to recover from an operational event or service is not able to scale.",
+        recoverySuggestion: ""
     )
 
     public static func == (lhs: FaceLivenessDetectionError, rhs: FaceLivenessDetectionError) -> Bool {

Sources/FaceLiveness/Views/Liveness/FaceLivenessDetectionError.swift

@@ -78,7 +78,7 @@ public struct FaceLivenessDetectorView: View {
                 faceInOvalMatching: faceInOvalStateMatching,
                 captureSession: captureSession,
                 videoChunker: videoChunker,
-                closeButtonAction: {},
+                closeButtonAction: { onCompletion(.failure(.userCancelled)) },
                 sessionID: sessionID
             )
         )
@@ -213,6 +213,18 @@ fileprivate func map(detectionCompletion: @escaping (Result<Void, FaceLivenessDe
             detectionCompletion(.failure(.invalidRegion))
         case .failure(.accessDenied):
             detectionCompletion(.failure(.accessDenied))
+        case .failure(.validation):
+            detectionCompletion(.failure(.validation))
+        case .failure(.internalServer):
+            detectionCompletion(.failure(.internalServer))
+        case .failure(.throttling):
+            detectionCompletion(.failure(.throttling))
+        case .failure(.serviceQuotaExceeded):
+            detectionCompletion(.failure(.serviceQuotaExceeded))
+        case .failure(.serviceUnavailable):
+            detectionCompletion(.failure(.serviceUnavailable))
+        case .failure(.sessionNotFound):
+            detectionCompletion(.failure(.sessionNotFound))
         default:
             detectionCompletion(.failure(.unknown))
         }

Sources/FaceLiveness/Views/Liveness/FaceLivenessDetectionView.swift

@@ -82,10 +82,10 @@ class FaceLivenessDetectionViewModel: ObservableObject {
 
     func registerServiceEvents() {
         livenessService.register(onComplete: { [weak self] reason in
+            self?.stopRecording()
+
             switch reason {
             case .disconnectionEvent:
-                self?.captureSession.stopRunning()
-
                 DispatchQueue.main.async {
                     self?.livenessState.complete()
                 }

Sources/FaceLiveness/Views/Liveness/FaceLivenessDetectionViewModel.swift

@@ -19,6 +19,7 @@ class MockLivenessService {
     var onFreshnessEvent: (LivenessEvent<FreshnessEvent>, Date) -> Void = { _, _ in }
     var onVideoEvent: (LivenessEvent<VideoEvent>, Date) -> Void = { _, _ in }
     var onInitializeLivenessStream: (String, String) -> Void = { _, _ in }
+    var onServiceException: (FaceLivenessSessionError) -> Void = { _ in }
 }
 
 extension MockLivenessService: LivenessService {