chore: Add attempt count changes (#137)

thisisabhash · web-flow · commit 3073bf168341 · 2024-05-06T10:14:55.000-07:00
* chore: Add attempt count changes

* Fix unit tests

* add unit tests

* Update region for example liveness view

* Update amplify-swift dependency
diff --git a/HostApp/HostApp.xcodeproj/project.xcworkspace/xcshareddata/swiftpm/Package.resolved b/HostApp/HostApp.xcodeproj/project.xcworkspace/xcshareddata/swiftpm/Package.resolved
@@ -6,7 +6,7 @@
       "location" : "https://github.com/aws-amplify/amplify-swift",
       "state" : {
         "branch" : "feat/no-light-support",
-        "revision" : "7c1fa2f7a766208f5af69ca8dce5fd02e6de4db6"
+        "revision" : "22e02fa21399122aac1d8b4f6ab23c242c79dae6"
       }
     },
     {
diff --git a/HostApp/HostApp/Model/LivenessResult.swift b/HostApp/HostApp/Model/LivenessResult.swift
@@ -6,11 +6,13 @@
 //
 
 import Foundation
+@_spi(PredictionsFaceLiveness) import AWSPredictionsPlugin
 
 struct LivenessResult: Codable {
     let auditImageBytes: String?
     let confidenceScore: Double
     let isLive: Bool
+    let challenge: Challenge?
 }
 
 extension LivenessResult: CustomDebugStringConvertible {
@@ -20,6 +22,8 @@ extension LivenessResult: CustomDebugStringConvertible {
             - confidenceScore: \(confidenceScore)
             - isLive: \(isLive)
             - auditImageBytes: \(auditImageBytes == nil ? "nil" : "<placeholder>")
+            - challengeType: \(String(describing: challenge?.type))
+            - challengeVersion: \(String(describing: challenge?.version))
         """
     }
 }
diff --git a/HostApp/HostApp/Views/ExampleLivenessView.swift b/HostApp/HostApp/Views/ExampleLivenessView.swift
@@ -22,8 +22,7 @@ struct ExampleLivenessView: View {
         case .liveness:
             FaceLivenessDetectorView(
                 sessionID: viewModel.sessionID,
-                // TODO: Change before merging to main
-                region: "us-west-2",
+                region: "us-east-1",
                 isPresented:  Binding(
                     get: { viewModel.presentationState == .liveness },
                     set: { _ in }
diff --git a/HostApp/HostApp/Views/LivenessResultContentView+Result.swift b/HostApp/HostApp/Views/LivenessResultContentView+Result.swift
@@ -6,6 +6,7 @@
 //
 
 import SwiftUI
+@_spi(PredictionsFaceLiveness) import AWSPredictionsPlugin
 
 extension LivenessResultContentView {
     struct Result {
@@ -15,6 +16,7 @@ extension LivenessResultContentView {
         let valueBackgroundColor: Color
         let auditImage: Data?
         let isLive: Bool
+        let challenge: Challenge?
         
         init(livenessResult: LivenessResult) {
             guard livenessResult.confidenceScore > 0 else {
@@ -24,6 +26,7 @@ extension LivenessResultContentView {
                 valueBackgroundColor = .clear
                 auditImage = nil
                 isLive = false
+                challenge = nil
                 return
             }
             isLive = livenessResult.isLive
@@ -41,6 +44,7 @@ extension LivenessResultContentView {
             auditImage = livenessResult.auditImageBytes.flatMap{
                 Data(base64Encoded: $0)
             }
+            challenge = livenessResult.challenge
         }
     }
 
diff --git a/HostApp/HostApp/Views/LivenessResultContentView.swift b/HostApp/HostApp/Views/LivenessResultContentView.swift
@@ -6,9 +6,10 @@
 //
 
 import SwiftUI
+@_spi(PredictionsFaceLiveness) import AWSPredictionsPlugin
 
 struct LivenessResultContentView: View {
-    @State var result: Result = .init(livenessResult: .init(auditImageBytes: nil, confidenceScore: -1, isLive: false))
+    @State var result: Result = .init(livenessResult: .init(auditImageBytes: nil, confidenceScore: -1, isLive: false, challenge: nil))
     let fetchResults: () async throws -> Result
 
     var body: some View {
@@ -67,26 +68,48 @@ struct LivenessResultContentView: View {
         }
     }
     
+    func step(number: Int, text: String) -> some View {
+        HStack(alignment: .top) {
+            Text("\(number).")
+            Text(text)
+        }
+    }
+    
+    @ViewBuilder
     private func steps() -> some View {
-        func step(number: Int, text: String) -> some View {
-            HStack(alignment: .top) {
-                Text("\(number).")
-                Text(text)
+        switch result.challenge?.type {
+        case .faceMovementChallenge:
+            VStack(
+                alignment: .leading,
+                spacing: 8
+            ) {
+                Text("Tips to pass the video check:")
+                    .fontWeight(.semibold)
+                
+                Text("Remove sunglasses, mask, hat, or anything blocking your face.")
+                    .accessibilityElement(children: .combine)
+            }
+        case .faceMovementAndLightChallenge:
+            VStack(
+                alignment: .leading,
+                spacing: 8
+            ) {
+                Text("Tips to pass the video check:")
+                    .fontWeight(.semibold)
+                
+                step(number: 1, text: "Avoid very bright lighting conditions, such as direct sunlight.")
+                    .accessibilityElement(children: .combine)
+                
+                step(number: 2, text: "Remove sunglasses, mask, hat, or anything blocking your face.")
+                    .accessibilityElement(children: .combine)
+            }
+        case .none:
+            VStack(
+                alignment: .leading,
+                spacing: 8
+            ) {
+                EmptyView()
             }
-        }
-
-        return VStack(
-            alignment: .leading,
-            spacing: 8
-        ) {
-            Text("Tips to pass the video check:")
-                .fontWeight(.semibold)
-
-            step(number: 1, text: "Avoid very bright lighting conditions, such as direct sunlight.")
-                .accessibilityElement(children: .combine)
-
-            step(number: 2, text: "Remove sunglasses, mask, hat, or anything blocking your face.")
-                .accessibilityElement(children: .combine)
         }
     }
 }
@@ -99,7 +122,8 @@ extension LivenessResultContentView {
                 livenessResult: .init(
                     auditImageBytes: nil,
                     confidenceScore: 99.8329,
-                    isLive: true
+                    isLive: true,
+                    challenge: nil
                 )
             )
         }
diff --git a/Package.resolved b/Package.resolved
@@ -6,7 +6,7 @@
       "location" : "https://github.com/aws-amplify/amplify-swift",
       "state" : {
         "branch" : "feat/no-light-support",
-        "revision" : "7c1fa2f7a766208f5af69ca8dce5fd02e6de4db6"
+        "revision" : "22e02fa21399122aac1d8b4f6ab23c242c79dae6"
       }
     },
     {
diff --git a/Sources/FaceLiveness/Views/GetReadyPage/GetReadyPageView.swift b/Sources/FaceLiveness/Views/GetReadyPage/GetReadyPageView.swift
@@ -27,28 +27,19 @@ struct GetReadyPageView: View {
         VStack {
             ZStack {
                 CameraPreviewView()
-                switch self.challenge.type {
-                case .faceMovementChallenge:
-                    VStack {
-                        Text(LocalizedStrings.preview_center_your_face_text)
-                            .font(.title)
-                            .multilineTextAlignment(.center)
-                        Spacer()
-                    }.padding()
-                case . faceMovementAndLightChallenge:
-                    VStack {
-                        WarningBox(
-                            titleText: LocalizedStrings.get_ready_photosensitivity_title,
-                            bodyText: LocalizedStrings.get_ready_photosensitivity_description,
-                            popoverContent: { photosensitivityWarningPopoverContent }
-                        )
-                        .accessibilityElement(children: .combine)
-                        Text(LocalizedStrings.preview_center_your_face_text)
-                            .font(.title)
-                            .multilineTextAlignment(.center)
-                        Spacer()
-                    }.padding()
-                }
+                VStack {
+                    WarningBox(
+                        titleText: LocalizedStrings.get_ready_photosensitivity_title,
+                        bodyText: LocalizedStrings.get_ready_photosensitivity_description,
+                        popoverContent: { photosensitivityWarningPopoverContent }
+                    )
+                    .accessibilityElement(children: .combine)
+                    .opacity(challenge.type == .faceMovementAndLightChallenge ? 1.0 : 0.0)
+                    Text(LocalizedStrings.preview_center_your_face_text)
+                        .font(.title)
+                        .multilineTextAlignment(.center)
+                    Spacer()
+                }.padding()
             }
             beginCheckButton
         }
diff --git a/Sources/FaceLiveness/Views/Liveness/FaceLivenessDetectionView.swift b/Sources/FaceLiveness/Views/Liveness/FaceLivenessDetectionView.swift
@@ -20,7 +20,6 @@ public struct FaceLivenessDetectorView: View {
     @State var displayingCameraPermissionsNeededAlert = false
 
     let disableStartView: Bool
-    let facelivenessDetectorViewId: String
     let onCompletion: (Result<Void, FaceLivenessDetectionError>) -> Void
 
     let sessionTask: Task<FaceLivenessSession, Error>
@@ -32,9 +31,7 @@ public struct FaceLivenessDetectorView: View {
         disableStartView: Bool = false,
         isPresented: Binding<Bool>,
         onCompletion: @escaping (Result<Void, FaceLivenessDetectionError>) -> Void
-    ) {
-        let viewId = UUID().uuidString
-        self.facelivenessDetectorViewId = viewId
+    ) {        
         self.disableStartView = disableStartView
         self._isPresented = isPresented
         self.onCompletion = onCompletion
@@ -44,8 +41,6 @@ public struct FaceLivenessDetectorView: View {
                 withID: sessionID,
                 credentialsProvider: credentialsProvider,
                 region: region,
-                options: .init(faceLivenessDetectorViewId: viewId,
-                               preCheckViewEnabled: !disableStartView),
                 completion: map(detectionCompletion: onCompletion)
             )
             return session
@@ -83,7 +78,8 @@ public struct FaceLivenessDetectorView: View {
                 captureSession: captureSession,
                 videoChunker: videoChunker,
                 closeButtonAction: { onCompletion(.failure(.userCancelled)) },
-                sessionID: sessionID
+                sessionID: sessionID,
+                isPreviewScreenEnabled: !disableStartView
             )
         )
         
@@ -99,8 +95,6 @@ public struct FaceLivenessDetectorView: View {
         onCompletion: @escaping (Result<Void, FaceLivenessDetectionError>) -> Void,
         captureSession: LivenessCaptureSession
     ) {
-        let viewId = UUID().uuidString
-        self.facelivenessDetectorViewId = viewId
         self.disableStartView = disableStartView
         self._isPresented = isPresented
         self.onCompletion = onCompletion
@@ -110,8 +104,6 @@ public struct FaceLivenessDetectorView: View {
                 withID: sessionID,
                 credentialsProvider: credentialsProvider,
                 region: region,
-                options: .init(faceLivenessDetectorViewId: viewId,
-                               preCheckViewEnabled: !disableStartView),
                 completion: map(detectionCompletion: onCompletion)
             )
             return session
@@ -128,7 +120,8 @@ public struct FaceLivenessDetectorView: View {
                 captureSession: captureSession,
                 videoChunker: captureSession.outputSampleBufferCapturer!.videoChunker,
                 closeButtonAction: { onCompletion(.failure(.userCancelled)) },
-                sessionID: sessionID
+                sessionID: sessionID,
+                isPreviewScreenEnabled: !disableStartView
             )
         )
     }
diff --git a/Sources/FaceLiveness/Views/Liveness/FaceLivenessDetectionViewModel+FaceDetectionResultHandler.swift b/Sources/FaceLiveness/Views/Liveness/FaceLivenessDetectionViewModel+FaceDetectionResultHandler.swift
@@ -121,9 +121,7 @@ extension FaceLivenessDetectionViewModel: FaceDetectionResultHandler {
                         }
                     }
                 case .faceMovementChallenge:
-                    DispatchQueue.main.asyncAfter(deadline: .now() + 1.0) {
-                        self.livenessViewControllerDelegate?.completeNoLightCheck()
-                    }
+                    self.livenessViewControllerDelegate?.completeNoLightCheck()
                 default:
                     break
                 }
diff --git a/Sources/FaceLiveness/Views/Liveness/FaceLivenessDetectionViewModel.swift b/Sources/FaceLiveness/Views/Liveness/FaceLivenessDetectionViewModel.swift
@@ -12,6 +12,7 @@ import AVFoundation
 
 fileprivate let videoSize: CGSize = .init(width: 480, height: 640)
 fileprivate let defaultNoFitTimeoutInterval: TimeInterval = 7
+fileprivate let defaultAttemptCountResetInterval: TimeInterval = 300.0
 
 @MainActor
 class FaceLivenessDetectionViewModel: ObservableObject {
@@ -28,6 +29,7 @@ class FaceLivenessDetectionViewModel: ObservableObject {
     let faceDetector: FaceDetector
     let faceInOvalMatching: FaceInOvalMatching
     let challengeID: String = UUID().uuidString
+    let isPreviewScreenEnabled : Bool
     var colorSequences: [ColorSequence] = []
     var hasSentFinalVideoEvent = false
     var hasSentFirstVideo = false
@@ -43,6 +45,9 @@ class FaceLivenessDetectionViewModel: ObservableObject {
     var faceMatchedTimestamp: UInt64?
     var noFitStartTime: Date?
     
+    static var attemptCount: Int = 0
+    static var attemptIdTimeStamp: Date = Date()
+    
     var noFitTimeoutInterval: TimeInterval {
         if let sessionTimeoutMilliSec = sessionConfiguration?.ovalMatchChallenge.oval.ovalFitTimeout {
             return TimeInterval(sessionTimeoutMilliSec/1_000)
@@ -58,7 +63,8 @@ class FaceLivenessDetectionViewModel: ObservableObject {
         videoChunker: VideoChunker,
         stateMachine: LivenessStateMachine = .init(state: .initial),
         closeButtonAction: @escaping () -> Void,
-        sessionID: String
+        sessionID: String,
+        isPreviewScreenEnabled: Bool
     ) {
         self.closeButtonAction = closeButtonAction
         self.videoChunker = videoChunker
@@ -67,6 +73,7 @@ class FaceLivenessDetectionViewModel: ObservableObject {
         self.captureSession = captureSession
         self.faceDetector = faceDetector
         self.faceInOvalMatching = faceInOvalMatching
+        self.isPreviewScreenEnabled = isPreviewScreenEnabled
 
         self.closeButtonAction = { [weak self] in
             guard let self else { return }
@@ -186,13 +193,20 @@ class FaceLivenessDetectionViewModel: ObservableObject {
 
     func initializeLivenessStream() {
         do {
-            guard let livenessSession = livenessService as? FaceLivenessSession else {
-                throw FaceLivenessDetectionError.unknown
+            if (abs(Self.attemptIdTimeStamp.timeIntervalSinceNow) > defaultAttemptCountResetInterval) {
+                Self.attemptCount = 1
+            } else {
+                Self.attemptCount += 1
             }
+            Self.attemptIdTimeStamp = Date()
             
-            try livenessSession.initializeLivenessStream(
+            try livenessService?.initializeLivenessStream(
                 withSessionID: sessionID,
-                userAgent: UserAgentValues.standard().userAgentString
+                userAgent: UserAgentValues.standard().userAgentString,
+                challenges: FaceLivenessSession.supportedChallenges,
+                options: .init(
+                    attemptCount: Self.attemptCount,
+                    preCheckViewEnabled: isPreviewScreenEnabled)
             )
         } catch {
             DispatchQueue.main.async {
diff --git a/Tests/FaceLivenessTests/CredentialsProviderTestCase.swift b/Tests/FaceLivenessTests/CredentialsProviderTestCase.swift
@@ -41,7 +41,8 @@ final class CredentialsProviderTestCase: XCTestCase {
             captureSession: captureSession,
             videoChunker: videoChunker,
             closeButtonAction: {},
-            sessionID: UUID().uuidString
+            sessionID: UUID().uuidString,
+            isPreviewScreenEnabled: false
         )
 
         self.videoChunker = videoChunker
diff --git a/Tests/FaceLivenessTests/LivenessTests.swift b/Tests/FaceLivenessTests/LivenessTests.swift
diff --git a/Tests/FaceLivenessTests/MockLivenessService.swift b/Tests/FaceLivenessTests/MockLivenessService.swift

Original file line number	Diff line number	Diff line change
`@@ -6,7 +6,7 @@`
`6`	`6`	`"location" : "https://github.com/aws-amplify/amplify-swift",`
`7`	`7`	`"state" : {`
`8`	`8`	`"branch" : "feat/no-light-support",`
`9`		`- "revision" : "7c1fa2f7a766208f5af69ca8dce5fd02e6de4db6"`
	`9`	`+ "revision" : "22e02fa21399122aac1d8b4f6ab23c242c79dae6"`
`10`	`10`	`}`
`11`	`11`	`},`
`12`	`12`	`{`
Original file line number	Diff line number	Diff line change
`@@ -6,11 +6,13 @@`
`6`	`6`	`//`
`7`	`7`
`8`	`8`	`import Foundation`
	`9`	`+@_spi(PredictionsFaceLiveness) import AWSPredictionsPlugin`
`9`	`10`
`10`	`11`	`struct LivenessResult: Codable {`
`11`	`12`	`let auditImageBytes: String?`
`12`	`13`	`let confidenceScore: Double`
`13`	`14`	`let isLive: Bool`
	`15`	`+ let challenge: Challenge?`
`14`	`16`	`}`
`15`	`17`
`16`	`18`	`extension LivenessResult: CustomDebugStringConvertible {`
`@@ -20,6 +22,8 @@ extension LivenessResult: CustomDebugStringConvertible {`
`20`	`22`	`- confidenceScore: \(confidenceScore)`
`21`	`23`	`- isLive: \(isLive)`
`22`	`24`	`- auditImageBytes: \(auditImageBytes == nil ? "nil" : "<placeholder>")`
	`25`	`+ - challengeType: \(String(describing: challenge?.type))`
	`26`	`+ - challengeVersion: \(String(describing: challenge?.version))`
`23`	`27`	`"""`
`24`	`28`	`}`
`25`	`29`	`}`
Original file line number	Diff line number	Diff line change
`@@ -121,9 +121,7 @@ extension FaceLivenessDetectionViewModel: FaceDetectionResultHandler {`
`121`	`121`	`}`
`122`	`122`	`}`
`123`	`123`	`case .faceMovementChallenge:`
`124`		`- DispatchQueue.main.asyncAfter(deadline: .now() + 1.0) {`
`125`		`- self.livenessViewControllerDelegate?.completeNoLightCheck()`
`126`		`- }`
	`124`	`+ self.livenessViewControllerDelegate?.completeNoLightCheck()`
`127`	`125`	`default:`
`128`	`126`	`break`
`129`	`127`	`}`
Original file line number	Diff line number	Diff line change
`@@ -41,7 +41,8 @@ final class CredentialsProviderTestCase: XCTestCase {`
`41`	`41`	`captureSession: captureSession,`
`42`	`42`	`videoChunker: videoChunker,`
`43`	`43`	`closeButtonAction: {},`
`44`		`- sessionID: UUID().uuidString`
	`44`	`+ sessionID: UUID().uuidString,`
	`45`	`+ isPreviewScreenEnabled: false`
`45`	`46`	`)`
`46`	`47`
`47`	`48`	`self.videoChunker = videoChunker`