make finger print auth action flatter (#529)

chamini2 · sashei · commit bee02417102d · 2019-03-25T08:51:37.000-07:00
* change FingerprintAuthAction to have flatter structure

* update usage of FingerprintAuthAction

* rename OnAuthSuccess to OnSuccess and OnAuthError to OnError

* styling
diff --git a/app/src/main/java/mozilla/lockbox/action/FingerprintAuthAction.kt b/app/src/main/java/mozilla/lockbox/action/FingerprintAuthAction.kt
@@ -7,9 +7,9 @@
 package mozilla.lockbox.action
 
 import mozilla.lockbox.flux.Action
-import mozilla.lockbox.model.FingerprintAuthCallback
 
 sealed class FingerprintAuthAction : Action {
-    data class OnAuthentication(val authCallback: FingerprintAuthCallback) : FingerprintAuthAction()
+    object OnSuccess : FingerprintAuthAction()
+    object OnError : FingerprintAuthAction()
     object OnCancel : FingerprintAuthAction()
 }
diff --git a/app/src/main/java/mozilla/lockbox/model/FingerprintAuthCallback.kt b/app/src/main/java/mozilla/lockbox/model/FingerprintAuthCallback.kt
diff --git a/app/src/main/java/mozilla/lockbox/presenter/AutofillLockedPresenter.kt b/app/src/main/java/mozilla/lockbox/presenter/AutofillLockedPresenter.kt
@@ -15,7 +15,6 @@ import mozilla.lockbox.action.FingerprintAuthAction
 import mozilla.lockbox.action.RouteAction
 import mozilla.lockbox.flux.Dispatcher
 import mozilla.lockbox.flux.Presenter
-import mozilla.lockbox.model.FingerprintAuthCallback
 import mozilla.lockbox.store.FingerprintStore
 import mozilla.lockbox.store.LockedStore
 import mozilla.lockbox.store.SettingStore
@@ -49,12 +48,8 @@ class AutofillLockedPresenter(
         lockedStore.onAuthentication
             .subscribe {
                 when (it) {
-                    is FingerprintAuthAction.OnAuthentication -> {
-                        when (it.authCallback) {
-                            is FingerprintAuthCallback.OnAuth -> unlock()
-                            is FingerprintAuthCallback.OnError -> unlockFallback()
-                        }
-                    }
+                    is FingerprintAuthAction.OnSuccess -> unlock()
+                    is FingerprintAuthAction.OnError -> unlockFallback()
                     is FingerprintAuthAction.OnCancel -> dispatcher.dispatch(AutofillAction.Cancel)
                 }
             }
diff --git a/app/src/main/java/mozilla/lockbox/presenter/FingerprintDialogPresenter.kt b/app/src/main/java/mozilla/lockbox/presenter/FingerprintDialogPresenter.kt
@@ -9,19 +9,17 @@ package mozilla.lockbox.presenter
 import io.reactivex.Observable
 import io.reactivex.rxkotlin.addTo
 import mozilla.lockbox.action.FingerprintAuthAction
-import mozilla.lockbox.action.FingerprintAuthAction.OnAuthentication
 import mozilla.lockbox.action.FingerprintSensorAction
 import mozilla.lockbox.flux.Dispatcher
 import mozilla.lockbox.flux.Presenter
-import mozilla.lockbox.model.FingerprintAuthCallback
 import mozilla.lockbox.store.FingerprintStore
 import mozilla.lockbox.store.FingerprintStore.AuthenticationState
 
 interface FingerprintDialogView {
     fun onSucceeded()
     fun onFailed(error: String?)
     fun onError(error: String?)
-    val authCallback: Observable<FingerprintAuthCallback>
+    val authCallback: Observable<FingerprintAuthAction>
     val onDismiss: Observable<Unit>
 }
 
@@ -37,7 +35,7 @@ class FingerprintDialogPresenter(
             .addTo(compositeDisposable)
 
         view.authCallback
-            .subscribe { dispatcher.dispatch(OnAuthentication(it)) }
+            .subscribe(dispatcher::dispatch)
             .addTo(compositeDisposable)
 
         view.onDismiss
diff --git a/app/src/main/java/mozilla/lockbox/presenter/FingerprintOnboardingPresenter.kt b/app/src/main/java/mozilla/lockbox/presenter/FingerprintOnboardingPresenter.kt
@@ -17,17 +17,16 @@ import mozilla.lockbox.action.SettingAction
 import mozilla.lockbox.flux.Dispatcher
 import mozilla.lockbox.flux.Presenter
 import mozilla.lockbox.log
-import mozilla.lockbox.model.FingerprintAuthCallback
-import mozilla.lockbox.store.SettingStore
 import mozilla.lockbox.store.FingerprintStore
 import mozilla.lockbox.store.FingerprintStore.AuthenticationState
+import mozilla.lockbox.store.SettingStore
 
 interface FingerprintOnboardingView {
     fun onSucceeded()
     fun onFailed(error: String?)
     fun onError(error: String?)
     val onSkipClick: Observable<Unit>
-    val authCallback: Observable<FingerprintAuthCallback>
+    val authCallback: Observable<FingerprintAuthAction>
 }
 
 @ExperimentalCoroutinesApi
@@ -44,9 +43,9 @@ class FingerprintOnboardingPresenter(
 
         view.authCallback
             .subscribe {
-                dispatcher.dispatch(FingerprintAuthAction.OnAuthentication(it))
+                dispatcher.dispatch(it)
                 val unlock = when (it) {
-                    is FingerprintAuthCallback.OnAuth -> true
+                    is FingerprintAuthAction.OnSuccess -> true
                     else -> false
                 }
                 dispatcher.dispatch(SettingAction.UnlockWithFingerprint(unlock))
diff --git a/app/src/main/java/mozilla/lockbox/presenter/LockedPresenter.kt b/app/src/main/java/mozilla/lockbox/presenter/LockedPresenter.kt
@@ -15,7 +15,6 @@ import mozilla.lockbox.action.RouteAction
 import mozilla.lockbox.action.UnlockingAction
 import mozilla.lockbox.flux.Dispatcher
 import mozilla.lockbox.flux.Presenter
-import mozilla.lockbox.model.FingerprintAuthCallback
 import mozilla.lockbox.store.FingerprintStore
 import mozilla.lockbox.store.LockedStore
 import mozilla.lockbox.store.SettingStore
@@ -68,11 +67,9 @@ class LockedPresenter(
 
         lockedStore.onAuthentication
             .subscribe {
-                if (it is FingerprintAuthAction.OnAuthentication) {
-                    when (it.authCallback) {
-                        is FingerprintAuthCallback.OnAuth -> unlock()
-                        is FingerprintAuthCallback.OnError -> unlockFallback()
-                    }
+                when (it) {
+                    is FingerprintAuthAction.OnSuccess -> unlock()
+                    is FingerprintAuthAction.OnError -> unlockFallback()
                 }
             }
             .addTo(compositeDisposable)
diff --git a/app/src/main/java/mozilla/lockbox/presenter/SettingPresenter.kt b/app/src/main/java/mozilla/lockbox/presenter/SettingPresenter.kt
@@ -27,7 +27,6 @@ import mozilla.lockbox.adapter.TextSettingConfiguration
 import mozilla.lockbox.adapter.ToggleSettingConfiguration
 import mozilla.lockbox.flux.Dispatcher
 import mozilla.lockbox.flux.Presenter
-import mozilla.lockbox.model.FingerprintAuthCallback
 import mozilla.lockbox.store.FingerprintStore
 import mozilla.lockbox.store.SettingStore
 
@@ -94,20 +93,13 @@ class SettingPresenter(
     override fun onViewReady() {
         settingStore.onEnablingFingerprint
             .subscribe {
-                if (it is FingerprintAuthAction.OnAuthentication) {
-                    when (it.authCallback) {
-                        is FingerprintAuthCallback.OnAuth ->
-                            dispatcher.dispatch(
-                                SettingAction.UnlockWithFingerprint(true)
-                            )
-                        is FingerprintAuthCallback.OnError -> {
-                            dispatcher.dispatch(
-                                SettingAction.UnlockWithFingerprint(false)
-                            )
-                        }
-                    }
-                } else {
-                    dispatcher.dispatch(SettingAction.UnlockWithFingerprint(false))
+                when (it) {
+                    is FingerprintAuthAction.OnSuccess ->
+                        dispatcher.dispatch(SettingAction.UnlockWithFingerprint(true))
+                    is FingerprintAuthAction.OnError ->
+                        dispatcher.dispatch(SettingAction.UnlockWithFingerprint(false))
+                    is FingerprintAuthAction.OnCancel ->
+                        dispatcher.dispatch(SettingAction.UnlockWithFingerprint(false))
                 }
 
                 dispatcher.dispatch(SettingAction.UnlockWithFingerprintPendingAuth(false))
diff --git a/app/src/main/java/mozilla/lockbox/view/FingerprintAuthDialogFragment.kt b/app/src/main/java/mozilla/lockbox/view/FingerprintAuthDialogFragment.kt
@@ -7,26 +7,26 @@
 package mozilla.lockbox.view
 
 import android.os.Bundle
-import androidx.annotation.StringRes
 import android.view.LayoutInflater
 import android.view.View
 import android.view.ViewGroup
+import androidx.annotation.StringRes
 import com.jakewharton.rxbinding2.view.clicks
 import io.reactivex.Observable
 import io.reactivex.disposables.CompositeDisposable
 import io.reactivex.rxkotlin.addTo
 import io.reactivex.subjects.PublishSubject
 import kotlinx.android.synthetic.main.fragment_fingerprint_dialog.view.*
 import mozilla.lockbox.R
-import mozilla.lockbox.model.FingerprintAuthCallback
+import mozilla.lockbox.action.FingerprintAuthAction
 import mozilla.lockbox.presenter.FingerprintDialogPresenter
 import mozilla.lockbox.presenter.FingerprintDialogView
 import mozilla.lockbox.support.Constant
 
 class FingerprintAuthDialogFragment : DialogFragment(), FingerprintDialogView {
     private val compositeDisposable = CompositeDisposable()
-    private val _authCallback = PublishSubject.create<FingerprintAuthCallback>()
-    override val authCallback: Observable<FingerprintAuthCallback> get() = _authCallback
+    private val _authCallback = PublishSubject.create<FingerprintAuthAction>()
+    override val authCallback: Observable<FingerprintAuthAction> get() = _authCallback
     private val _dismiss = PublishSubject.create<Unit>()
     override val onDismiss: Observable<Unit> get() = _dismiss
     private var isEnablingDismissed: Boolean = true
@@ -67,7 +67,7 @@ class FingerprintAuthDialogFragment : DialogFragment(), FingerprintDialogView {
         view!!.imageView.run {
             setImageResource(R.drawable.ic_fingerprint_success)
             postDelayed({
-                _authCallback.onNext(FingerprintAuthCallback.OnAuth)
+                _authCallback.onNext(FingerprintAuthAction.OnSuccess)
                 isEnablingDismissed = false
                 dismissAllowingStateLoss()
             }, Constant.FingerprintTimeout.successDelayMillis)
@@ -82,7 +82,7 @@ class FingerprintAuthDialogFragment : DialogFragment(), FingerprintDialogView {
     override fun onError(error: String?) {
         showError(error ?: getString(R.string.fingerprint_sensor_error))
         view!!.imageView.postDelayed({
-            _authCallback.onNext(FingerprintAuthCallback.OnError)
+            _authCallback.onNext(FingerprintAuthAction.OnError)
             dismiss()
         }, Constant.FingerprintTimeout.errorTimeoutMillis)
     }
diff --git a/app/src/main/java/mozilla/lockbox/view/FingerprintOnboardingFragment.kt b/app/src/main/java/mozilla/lockbox/view/FingerprintOnboardingFragment.kt
@@ -10,15 +10,15 @@ import io.reactivex.subjects.PublishSubject
 import kotlinx.android.synthetic.main.fragment_fingerprint_onboarding.view.*
 import kotlinx.coroutines.ExperimentalCoroutinesApi
 import mozilla.lockbox.R
+import mozilla.lockbox.action.FingerprintAuthAction
 import mozilla.lockbox.presenter.FingerprintOnboardingPresenter
 import mozilla.lockbox.presenter.FingerprintOnboardingView
-import mozilla.lockbox.model.FingerprintAuthCallback
 import mozilla.lockbox.support.Constant
 
 @ExperimentalCoroutinesApi
 class FingerprintOnboardingFragment : Fragment(), FingerprintOnboardingView {
-    private val _authCallback = PublishSubject.create<FingerprintAuthCallback>()
-    override val authCallback: Observable<FingerprintAuthCallback> get() = _authCallback
+    private val _authCallback = PublishSubject.create<FingerprintAuthAction>()
+    override val authCallback: Observable<FingerprintAuthAction> get() = _authCallback
 
     override val onSkipClick: Observable<Unit>
         get() = view!!.skipButton.clicks()
@@ -41,7 +41,7 @@ class FingerprintOnboardingFragment : Fragment(), FingerprintOnboardingView {
 
         view!!.sensorDescription.removeCallbacks(resetErrorTextRunnable)
         view!!.iconFingerprint.postDelayed({
-            _authCallback.onNext(FingerprintAuthCallback.OnAuth)
+            _authCallback.onNext(FingerprintAuthAction.OnSuccess)
             isEnablingDismissed = false
         }, Constant.FingerprintTimeout.successDelayMillis)
     }
@@ -53,7 +53,7 @@ class FingerprintOnboardingFragment : Fragment(), FingerprintOnboardingView {
     override fun onError(error: String?) {
         showError(error ?: getString(R.string.fingerprint_sensor_error))
         view!!.postDelayed(
-            { _authCallback.onNext(FingerprintAuthCallback.OnError) },
+            { _authCallback.onNext(FingerprintAuthAction.OnError) },
             Constant.FingerprintTimeout.errorTimeoutMillis
         )
     }
diff --git a/app/src/test/java/mozilla/lockbox/presenter/AutofillLockedPresenterTest.kt b/app/src/test/java/mozilla/lockbox/presenter/AutofillLockedPresenterTest.kt
@@ -20,7 +20,6 @@ import mozilla.lockbox.action.RouteAction
 import mozilla.lockbox.extensions.assertLastValue
 import mozilla.lockbox.flux.Action
 import mozilla.lockbox.flux.Dispatcher
-import mozilla.lockbox.model.FingerprintAuthCallback
 import mozilla.lockbox.store.FingerprintStore
 import mozilla.lockbox.store.LockedStore
 import mozilla.lockbox.store.SettingStore
@@ -102,21 +101,21 @@ class AutofillLockedPresenterTest : DisposingTest() {
 
     @Test
     fun `on successful fingerprint authentication`() {
-        lockedStore.authenticationStub.onNext(FingerprintAuthAction.OnAuthentication(FingerprintAuthCallback.OnAuth))
+        lockedStore.authenticationStub.onNext(FingerprintAuthAction.OnSuccess)
         dispatcherObserver.assertLastValue(DataStoreAction.Unlock)
     }
 
     @Test
     fun `on unsuccessful fingerprint authentication when there is no other security`() {
         fingerprintStore.keyguardDeviceSecureStub = false
-        lockedStore.authenticationStub.onNext(FingerprintAuthAction.OnAuthentication(FingerprintAuthCallback.OnError))
+        lockedStore.authenticationStub.onNext(FingerprintAuthAction.OnError)
         dispatcherObserver.assertLastValue(DataStoreAction.Unlock)
     }
 
     @Test
     fun `on unsuccessful fingerprint authentication when there is other security`() {
         fingerprintStore.keyguardDeviceSecureStub = true
-        lockedStore.authenticationStub.onNext(FingerprintAuthAction.OnAuthentication(FingerprintAuthCallback.OnError))
+        lockedStore.authenticationStub.onNext(FingerprintAuthAction.OnError)
         assertTrue(view.unlockFallbackCalled)
     }
 
diff --git a/app/src/test/java/mozilla/lockbox/presenter/FingerprintDialogPresenterTest.kt b/app/src/test/java/mozilla/lockbox/presenter/FingerprintDialogPresenterTest.kt
@@ -8,9 +8,8 @@ import mozilla.lockbox.action.FingerprintSensorAction
 import mozilla.lockbox.extensions.assertLastValue
 import mozilla.lockbox.flux.Action
 import mozilla.lockbox.flux.Dispatcher
-import mozilla.lockbox.model.FingerprintAuthCallback
 import mozilla.lockbox.store.FingerprintStore
-import mozilla.lockbox.store.FingerprintStore.AuthenticationState as AuthenticationState
+import mozilla.lockbox.store.FingerprintStore.AuthenticationState
 import org.junit.Before
 import org.junit.Test
 import org.junit.runner.RunWith
@@ -33,8 +32,8 @@ class FingerprintDialogPresenterTest {
         override fun onError(error: String?) {
         }
 
-        val authCallbackStub = PublishSubject.create<FingerprintAuthCallback>()
-        override val authCallback: Observable<FingerprintAuthCallback>
+        val authCallbackStub = PublishSubject.create<FingerprintAuthAction>()
+        override val authCallback: Observable<FingerprintAuthAction>
             get() = authCallbackStub
 
         override val onDismiss = PublishSubject.create<Unit>()
@@ -78,8 +77,8 @@ class FingerprintDialogPresenterTest {
 
     @Test
     fun `dispatch authentication status for routing`() {
-        view.authCallbackStub.onNext(FingerprintAuthCallback.OnAuth)
-        dispatcherObserver.assertLastValue(FingerprintAuthAction.OnAuthentication(FingerprintAuthCallback.OnAuth))
+        view.authCallbackStub.onNext(FingerprintAuthAction.OnSuccess)
+        dispatcherObserver.assertLastValue(FingerprintAuthAction.OnSuccess)
     }
 
     @Test
diff --git a/app/src/test/java/mozilla/lockbox/presenter/FingerprintOnboardingPresenterTest.kt b/app/src/test/java/mozilla/lockbox/presenter/FingerprintOnboardingPresenterTest.kt
@@ -5,12 +5,12 @@ import android.view.autofill.AutofillManager
 import io.reactivex.Observable
 import io.reactivex.observers.TestObserver
 import io.reactivex.subjects.PublishSubject
+import mozilla.lockbox.action.FingerprintAuthAction
 import mozilla.lockbox.action.FingerprintSensorAction
 import mozilla.lockbox.action.SettingAction
 import mozilla.lockbox.extensions.assertLastValue
 import mozilla.lockbox.flux.Action
 import mozilla.lockbox.flux.Dispatcher
-import mozilla.lockbox.model.FingerprintAuthCallback
 import mozilla.lockbox.store.FingerprintStore
 import org.junit.Assert
 import org.junit.Before
@@ -43,8 +43,8 @@ class FingerprintOnboardingPresenterTest {
             errors = true
         }
 
-        private var authCallbackStub = PublishSubject.create<FingerprintAuthCallback>()
-        override val authCallback: Observable<FingerprintAuthCallback>
+        private var authCallbackStub = PublishSubject.create<FingerprintAuthAction>()
+        override val authCallback: Observable<FingerprintAuthAction>
             get() = authCallbackStub
 
         override val onSkipClick = PublishSubject.create<Unit>()
diff --git a/app/src/test/java/mozilla/lockbox/presenter/LockedPresenterTest.kt b/app/src/test/java/mozilla/lockbox/presenter/LockedPresenterTest.kt
@@ -14,7 +14,6 @@ import mozilla.lockbox.action.FingerprintAuthAction
 import mozilla.lockbox.action.RouteAction
 import mozilla.lockbox.action.UnlockingAction
 import mozilla.lockbox.flux.Dispatcher
-import mozilla.lockbox.model.FingerprintAuthCallback
 import mozilla.lockbox.store.FingerprintStore
 import mozilla.lockbox.store.LockedStore
 import mozilla.lockbox.store.SettingStore
@@ -106,7 +105,7 @@ class LockedPresenterTest {
         val dispatchIterator = dispatcher.register.blockingIterable().iterator()
         `when`(fingerprintStore.isFingerprintAuthAvailable).thenReturn(true)
         `when`(fingerprintStore.isKeyguardDeviceSecure).thenReturn(true)
-        lockedStore.onAuth.onNext(FingerprintAuthAction.OnAuthentication(FingerprintAuthCallback.OnError))
+        lockedStore.onAuth.onNext(FingerprintAuthAction.OnError)
         assertEquals(RouteAction.UnlockFallbackDialog, dispatchIterator.next())
     }
 
@@ -140,14 +139,14 @@ class LockedPresenterTest {
         val dispatchIterator = dispatcher.register.blockingIterable().iterator()
         `when`(fingerprintStore.isFingerprintAuthAvailable).thenReturn(true)
         `when`(fingerprintStore.isKeyguardDeviceSecure).thenReturn(true)
-        lockedStore.onAuth.onNext(FingerprintAuthAction.OnAuthentication(FingerprintAuthCallback.OnError))
+        lockedStore.onAuth.onNext(FingerprintAuthAction.OnError)
         assertEquals(RouteAction.UnlockFallbackDialog, dispatchIterator.next())
     }
 
     @Test
     fun `handle success authentication callback`() {
         val dispatchIterator = dispatcher.register.blockingIterable().iterator()
-        lockedStore.onAuth.onNext(FingerprintAuthAction.OnAuthentication(FingerprintAuthCallback.OnAuth))
+        lockedStore.onAuth.onNext(FingerprintAuthAction.OnSuccess)
 
         assertEquals(DataStoreAction.Unlock, dispatchIterator.next())
         val unlockingAction = dispatchIterator.next() as UnlockingAction
@@ -158,7 +157,7 @@ class LockedPresenterTest {
     fun `handle error authentication callback when the device has no other security`() {
         val dispatchIterator = dispatcher.register.blockingIterable().iterator()
         `when`(fingerprintStore.isKeyguardDeviceSecure).thenReturn(false)
-        lockedStore.onAuth.onNext(FingerprintAuthAction.OnAuthentication(FingerprintAuthCallback.OnError))
+        lockedStore.onAuth.onNext(FingerprintAuthAction.OnError)
 
         assertEquals(DataStoreAction.Unlock, dispatchIterator.next())
         val unlockingAction = dispatchIterator.next() as UnlockingAction
@@ -174,4 +173,4 @@ class LockedPresenterTest {
         val unlockingAction = dispatchIterator.next() as UnlockingAction
         assertFalse(unlockingAction.currently)
     }
-}
+}
diff --git a/app/src/test/java/mozilla/lockbox/presenter/SettingPresenterTest.kt b/app/src/test/java/mozilla/lockbox/presenter/SettingPresenterTest.kt
diff --git a/app/src/test/java/mozilla/lockbox/store/LockedStoreTest.kt b/app/src/test/java/mozilla/lockbox/store/LockedStoreTest.kt
diff --git a/app/src/test/java/mozilla/lockbox/store/SettingStoreTest.kt b/app/src/test/java/mozilla/lockbox/store/SettingStoreTest.kt
