feat(liveness): Remove countdown (#56)

tylerjroach · web-flow · commit d4fb0c3e2052 · 2023-07-11T00:16:45.000Z
diff --git a/liveness/src/main/java/com/amplifyframework/ui/liveness/camera/LivenessCoordinator.kt b/liveness/src/main/java/com/amplifyframework/ui/liveness/camera/LivenessCoordinator.kt
@@ -217,10 +217,6 @@ internal class LivenessCoordinator(
         onChallengeFailed.accept(faceLivenessException)
     }
 
-    fun processCountdownComplete() {
-        livenessState.onCountdownComplete()
-    }
-
     fun processColorDisplayed(
         currentColor: RgbColor,
         previousColor: RgbColor,
diff --git a/liveness/src/main/java/com/amplifyframework/ui/liveness/ml/FaceDetector.kt b/liveness/src/main/java/com/amplifyframework/ui/liveness/ml/FaceDetector.kt
@@ -426,7 +426,6 @@ internal class FaceDetector(private val livenessState: LivenessState) {
          */
         const val NUM_COORDS = 16
         const val INITIAL_FACE_DISTANCE_THRESHOLD = 0.32f
-        const val FACE_DISTANCE_THRESHOLD_COUNTDOWN = 0.37f
 
         fun loadModel(context: Context): Interpreter {
             val modelFileDescriptor =
diff --git a/liveness/src/main/java/com/amplifyframework/ui/liveness/model/LivenessCheckState.kt b/liveness/src/main/java/com/amplifyframework/ui/liveness/model/LivenessCheckState.kt
@@ -20,15 +20,12 @@ import com.amplifyframework.ui.liveness.R
 import com.amplifyframework.ui.liveness.ml.FaceDetector
 
 internal sealed class LivenessCheckState(val instructionId: Int? = null) {
-    class Initial(instructionId: Int) : LivenessCheckState(instructionId) {
+    class Initial(instructionId: Int? = null) : LivenessCheckState(instructionId) {
         companion object {
             fun withMoveFaceMessage() =
                 Initial(R.string.amplify_ui_liveness_challenge_instruction_move_face)
             fun withMultipleFaceMessage() =
                 Initial(R.string.amplify_ui_liveness_challenge_instruction_multiple_faces_detected)
-            fun withHoldFaceMessage() = Initial(
-                R.string.amplify_ui_liveness_challenge_instruction_hold_face_during_countdown
-            )
             fun withMoveFaceFurtherAwayMessage() =
                 Initial(R.string.amplify_ui_liveness_challenge_instruction_move_face_further)
             fun withConnectingMessage() =
diff --git a/liveness/src/main/java/com/amplifyframework/ui/liveness/state/LivenessState.kt b/liveness/src/main/java/com/amplifyframework/ui/liveness/state/LivenessState.kt
@@ -50,12 +50,11 @@ internal data class LivenessState(
 ) {
     var videoViewportSize: VideoViewportSize? by mutableStateOf(null)
     var livenessCheckState = mutableStateOf<LivenessCheckState>(
-        LivenessCheckState.Initial.withHoldFaceMessage()
+        LivenessCheckState.Initial()
     )
     var runningFreshness by mutableStateOf(false)
     var faceGuideRect: RectF? by mutableStateOf(null)
     var faceMatchPercentage: Float by mutableStateOf(0.25f)
-    var countdownRunning by mutableStateOf(false)
     var initialFaceDistanceCheckPassed by mutableStateOf(false)
     var initialLocalFaceFound by mutableStateOf(false)
 
@@ -84,12 +83,6 @@ internal data class LivenessState(
         }
     }
 
-    fun onCountdownComplete() {
-        livenessCheckState.value = LivenessCheckState.Running()
-        countdownRunning = false
-        readyForOval = true
-    }
-
     fun onError(stopLivenessSession: Boolean) {
         livenessCheckState.value = LivenessCheckState.Error
         readyForOval = false
@@ -101,13 +94,13 @@ internal data class LivenessState(
     }
 
     fun onLivenessSessionReady(faceLivenessSession: FaceLivenessSession) {
-        livenessCheckState.value = LivenessCheckState.Initial.withHoldFaceMessage()
         livenessSessionInfo = faceLivenessSession
         faceTargetChallenge = faceLivenessSession.challenges
             .filterIsInstance<FaceTargetChallenge>().firstOrNull()
         colorChallenge = faceLivenessSession.challenges
             .filterIsInstance<ColorChallenge>().firstOrNull()
-        countdownRunning = true
+        livenessCheckState.value = LivenessCheckState.Running()
+        readyForOval = true
     }
 
     fun onFullChallengeComplete() {
@@ -164,18 +157,8 @@ internal data class LivenessState(
         }
         when (faceCount) {
             0 -> {
-                if (!initialLocalFaceFound ||
-                    (!countdownRunning && livenessCheckState.value is LivenessCheckState.Initial)
-                ) {
+                if (!initialLocalFaceFound || livenessCheckState.value is LivenessCheckState.Initial) {
                     livenessCheckState.value = LivenessCheckState.Initial.withMoveFaceMessage()
-                } else if (
-                    countdownRunning && livenessCheckState.value is LivenessCheckState.Initial
-                ) {
-                    val error = FaceLivenessDetectionException(
-                        message = "Check failed during countdown.",
-                        recoverySuggestion = "No face detected during the countdown."
-                    )
-                    onSessionError(error, true)
                 } else if (livenessCheckState.value is LivenessCheckState.Running) {
                     livenessCheckState.value = LivenessCheckState.Running.withMoveFaceMessage()
                 }
@@ -186,18 +169,8 @@ internal data class LivenessState(
                 }
             }
             else -> {
-                if (!initialLocalFaceFound ||
-                    (!countdownRunning && livenessCheckState.value is LivenessCheckState.Initial)
-                ) {
+                if (!initialLocalFaceFound || livenessCheckState.value is LivenessCheckState.Initial) {
                     livenessCheckState.value = LivenessCheckState.Initial.withMultipleFaceMessage()
-                } else if (countdownRunning &&
-                    livenessCheckState.value is LivenessCheckState.Initial
-                ) {
-                    val error = FaceLivenessDetectionException(
-                        message = "Check failed during countdown.",
-                        recoverySuggestion = "Multiple faces detected during the countdown."
-                    )
-                    onSessionError(error, true)
                 } else if (livenessCheckState.value is LivenessCheckState.Running) {
                     livenessCheckState.value = LivenessCheckState.Running.withMultipleFaceMessage()
                 }
@@ -211,7 +184,7 @@ internal data class LivenessState(
         rightEye: FaceDetector.Landmark,
         mouth: FaceDetector.Landmark
     ) {
-        if (!countdownRunning && !initialFaceDistanceCheckPassed) {
+        if (!initialFaceDistanceCheckPassed) {
             val faceDistance = FaceDetector.calculateFaceDistance(
                 leftEye, rightEye, mouth,
                 LivenessCoordinator.TARGET_WIDTH, LivenessCoordinator.TARGET_HEIGHT
@@ -225,20 +198,6 @@ internal data class LivenessState(
             }
         }
 
-        if (countdownRunning && livenessCheckState.value is LivenessCheckState.Initial) {
-            val faceDistance = FaceDetector.calculateFaceDistance(
-                leftEye, rightEye, mouth,
-                LivenessCoordinator.TARGET_WIDTH, LivenessCoordinator.TARGET_HEIGHT
-            )
-            if (faceDistance >= FaceDetector.FACE_DISTANCE_THRESHOLD_COUNTDOWN) {
-                val error = FaceLivenessDetectionException(
-                    message = "Check failed during countdown.",
-                    recoverySuggestion = "User should not move closer during the countdown."
-                )
-                onSessionError(error, true)
-            }
-        }
-
         if (readyForOval) {
             if (initialStreamFace == null) {
                 val face = InitialStreamFace(faceRect, System.currentTimeMillis())
diff --git a/liveness/src/main/java/com/amplifyframework/ui/liveness/ui/CountdownView.kt b/liveness/src/main/java/com/amplifyframework/ui/liveness/ui/CountdownView.kt
diff --git a/liveness/src/main/java/com/amplifyframework/ui/liveness/ui/FaceLivenessDetector.kt b/liveness/src/main/java/com/amplifyframework/ui/liveness/ui/FaceLivenessDetector.kt
@@ -56,7 +56,6 @@ import com.amplifyframework.ui.liveness.camera.LivenessCoordinator
 import com.amplifyframework.ui.liveness.camera.OnChallengeComplete
 import com.amplifyframework.ui.liveness.ml.FaceDetector
 import com.amplifyframework.ui.liveness.model.FaceLivenessDetectionException
-import com.amplifyframework.ui.liveness.model.LivenessCheckState
 import com.amplifyframework.ui.liveness.ui.helper.VideoViewportSize
 import com.amplifyframework.ui.liveness.util.hasCameraPermission
 import kotlinx.coroutines.launch
@@ -309,16 +308,6 @@ internal fun ChallengeView(
                             horizontalAlignment = Alignment.CenterHorizontally
                         ) {
                             InstructionMessage(livenessState.livenessCheckState.value)
-                            if (livenessState.livenessCheckState.value is
-                                LivenessCheckState.Initial && livenessState.countdownRunning
-                            ) {
-                                CountdownView(
-                                    key = key,
-                                    durationInSeconds = 3f
-                                ) {
-                                    livenessCoordinator.processCountdownComplete()
-                                }
-                            }
                         }
                     }
                 }
diff --git a/liveness/src/main/res/values/strings.xml b/liveness/src/main/res/values/strings.xml
@@ -34,7 +34,6 @@
     <string name="amplify_ui_liveness_get_ready_step_3">Move to a well-lit place that is not in direct sunlight.</string>
     <string name="amplify_ui_liveness_get_ready_begin_check">Begin check</string>
     <string name="amplify_ui_liveness_challenge_recording_indicator_label">REC</string>
-    <string name="amplify_ui_liveness_challenge_instruction_hold_face_during_countdown">Hold face position during countdown</string>
     <string name="amplify_ui_liveness_challenge_instruction_hold_face_during_freshness">Hold still</string>
     <string name="amplify_ui_liveness_challenge_instruction_move_face_further">Move back</string>
     <string name="amplify_ui_liveness_challenge_instruction_move_face_closer">Move closer</string>
diff --git a/liveness/src/test/java/com/amplifyframework/ui/liveness/state/LivenessStateTest.kt b/liveness/src/test/java/com/amplifyframework/ui/liveness/state/LivenessStateTest.kt
