Auto close on success event behaviour and customization #370

cocojoe · 2017-01-12T18:42:18Z

Dismiss Lock on .Signup when .Login not present
Dismiss Lock on .ResetPassword when .Login not present
Added ForgetPassword event handling to Dispatcher
Added Dispatch/Dismiss tests to Database Password Interactor

cocojoe · 2017-01-12T19:00:12Z

I spoke to Victor regarding default behaviours and real life necessity of options, we both agreed on.

Current Behaviour:

Login Success - Lock Closes Instantly
Signup Success - Auto Login or Switches to .Login (if available) or nothing.
Reset Success - Switches to .Login (If available) or nothing.
Signup Screen (with no .Login, No Auto Login) - Nothing
Reset Password Screen (with no .Login) - Nothing

PR Behaviour

No Change
No Change
No Change
Lock Closes
Lock Closes

UPDATE:
Auto Close puts emphasis onto developer to use their own presentation solution so this removes any issues as per following comment. Therefore options are needed to opt-out of auto-close, if there is no auto-close we need to ensure/document that closeable is true.

cocojoe · 2017-01-12T19:07:12Z

One Ux issue is the lack of time to inform the user after a successful Signup / ResetPassword as the closure is instant.
This is currently the default behaviour for Login. It feels okay in this situation not to see a banner message. However for the other events, there is no means of confirmation.

This is not in the PR but I tried adding a simple delay to event dismiss. Which I think looks okay, it's enough time to see it.

cocojoe · 2017-01-13T11:26:56Z

Debated the consistently of disabling auto close on Login, started adding it then it seemed weird, even more so for other connection types. If really wanted it can be done of course, just doesn't feel right.

hzalaz · 2017-01-13T15:56:17Z

Lock/Options.swift

@@ -35,6 +35,7 @@ public protocol Options {
    var scope: String { get }
    var parameters: [String: Any] { get }
    var allow: DatabaseMode { get }
+    var autoClose: DatabaseMode { get }


Why not a boolean I expect Lock to close on action?. This makes trickier figure out how to make lock close itself since I need to figure out what modes I want it to close. Also if I allow all actions and I set autoclose for signup I will close lock before the login? or for reset password ?

It would certainly be simpler if it was just a flag, I was aiming for flexibility but agree sometimes we have too much and it can possibly be confusing. If we made this a Bool it would mean, only auto close .Signup or .Reset if there is no .Login.

In your scenario, by default all allow modes are set and all autoClose modes are set. Auto Close will only close .Signup or .ResetPassword if there is no .Login allowed.

Possibly should be autoCloseSingleScreens: Bool or a smaller name ;)

Let's use autoclose and it's meant to close lock if the user logs in or any other action if it's the only one allowed. For consistency I'd avoid closing on auth if autoclose is false and show the same banner message we do for the rest.

hzalaz · 2017-01-13T15:58:05Z

Lock/ObserverStore.swift

@@ -28,24 +28,26 @@ struct ObserverStore: Dispatcher {
    var onFailure: (Error) -> () = { _ in }
    var onCancel: () -> () = {  }
    var onSignUp: (String, [String: Any]) -> () = { _ in }
+    var onForgetPassword: (String) -> () = { _ in }


Should it be onForgotPassword?

Yeah, typo.

hzalaz · 2017-01-13T15:59:16Z

Lock/ObserverStore.swift


    weak var controller: UIViewController?

-    func dispatch(result: Result) {
+    func dispatch(result: Result, dismissLock: Bool) {


I don't by the extra parameter. This object should be able to decide for itself if it should dismiss or not using the options

cocojoe · 2017-01-16T12:19:43Z

I'll squash these commits after review.

hzalaz · 2017-01-16T14:51:19Z

Lock/DatabasePasswordInteractor.swift

    let connections: Connections
    let emailValidator: InputValidator = EmailValidator()

-    init(connections: Connections, authentication: Authentication, user: DatabaseUser) {
+    init(connections: Connections, authentication: Authentication, user: DatabaseUser, options: Options, dispatcher: Dispatcher) {


We need Options for?

hzalaz · 2017-01-16T14:53:34Z

Lock/ObserverStore.swift


    weak var controller: UIViewController?

+    init(options: Options = LockOptions()) {


Do we really need to pass all the options?

hzalaz · 2017-01-16T14:54:03Z

Lock/ObserverStore.swift

@@ -28,24 +28,37 @@ struct ObserverStore: Dispatcher {
    var onFailure: (Error) -> () = { _ in }
    var onCancel: () -> () = {  }
    var onSignUp: (String, [String: Any]) -> () = { _ in }
+    var onForgotPassword: (String) -> () = { _ in }
+    var options: Options


If we have this mutable can't we just have the flag to tell lock to close itself after an action?

You need to know two things, Options.autoClose and are we in a single action mode. Currently determined with Options.allow.

We can either pass them independently of Options like 2 attributes or call a method to set them from Options. My main issue is passing it in the init since it provides no value let's just default to a sensible default and allow mutating the observerstore

hzalaz · 2017-01-16T14:56:15Z

Lock/ObserverStore.swift

    func dispatch(result: Result) {
+        let dismissLock: Bool


I don't see the need of this flag, we are making the decision of dismissing twice, one in the case and another after the switch. It's better to do it in the case and leave the closure to execute whether it has the dismiss or just calls the callback.

hzalaz · 2017-01-16T14:59:21Z

Lock/Options.swift

@@ -35,6 +35,7 @@ public protocol Options {
    var scope: String { get }
    var parameters: [String: Any] { get }
    var allow: DatabaseMode { get }
+    var autoClose: DatabaseMode { get }


Let's use autoclose and it's meant to close lock if the user logs in or any other action if it's the only one allowed. For consistency I'd avoid closing on auth if autoclose is false and show the same banner message we do for the rest.

Dismiss Lock on .ResetPassword when .Login not present Added ForgetPassword event handling to Dispatcher Added Dispatch/Dismiss tests to Database Password Interactor

Remove success banner display when auto closing Added autoClose to options for specifying mode auto closing Added validation for 'impossible to close Lock' miss configurations Added more dispatch tests in DatabaseInteractor and DatabasePasswordInteractor Login will always auto close for all connection types

Updated Tests

Changed autoClose flag to Bool Updated Tests Removed Options from DatabasePasswordInteractor Login now follows autoClose rules Login success message added DatabaseInteractor tests Added Dispatcher related tests unified into ObserverStore tests

cocojoe changed the title ~~Auto dismiss Lock on .Signup, .ResetPassword single screens~~ Auto close on success event behaviour and customization Jan 13, 2017

hzalaz suggested changes Jan 13, 2017

View reviewed changes

hzalaz added the CH: Added label Jan 13, 2017

hzalaz modified the milestone: v2-Next Jan 13, 2017

cocojoe force-pushed the feature_autoclose_signup_forgot branch from 23a8946 to 267103a Compare January 16, 2017 11:16

hzalaz reviewed Jan 16, 2017

View reviewed changes

cocojoe added 5 commits January 16, 2017 18:43

Dismiss Lock on .Signup when .Login not present

a38db6b

Dismiss Lock on .ResetPassword when .Login not present Added ForgetPassword event handling to Dispatcher Added Dispatch/Dismiss tests to Database Password Interactor

Dispatch Timeout Travis Test

0db93b5

Refactored ObserverStore dismissLock management

c0706e8

Updated Tests

cocojoe force-pushed the feature_autoclose_signup_forgot branch from 267103a to 8c75bce Compare January 16, 2017 21:51

hzalaz approved these changes Jan 17, 2017

View reviewed changes

hzalaz merged commit 3b3631e into v2 Jan 17, 2017

hzalaz deleted the feature_autoclose_signup_forgot branch January 17, 2017 00:28

hzalaz modified the milestones: v2-Next, 2.0.0 Feb 16, 2017

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Auto close on success event behaviour and customization #370

Auto close on success event behaviour and customization #370

cocojoe commented Jan 12, 2017

cocojoe commented Jan 12, 2017 •

edited

Loading

cocojoe commented Jan 12, 2017

cocojoe commented Jan 13, 2017

hzalaz Jan 13, 2017

cocojoe Jan 16, 2017 •

edited

Loading

cocojoe Jan 16, 2017

hzalaz Jan 16, 2017

hzalaz Jan 13, 2017

cocojoe Jan 16, 2017

hzalaz Jan 13, 2017

cocojoe commented Jan 16, 2017

hzalaz Jan 16, 2017

hzalaz Jan 16, 2017

hzalaz Jan 16, 2017

cocojoe Jan 16, 2017 •

edited

Loading

hzalaz Jan 16, 2017

hzalaz Jan 16, 2017

hzalaz Jan 16, 2017


		weak var controller: UIViewController?

		init(options: Options = LockOptions()) {

Auto close on success event behaviour and customization #370

Auto close on success event behaviour and customization #370

Conversation

cocojoe commented Jan 12, 2017

cocojoe commented Jan 12, 2017 • edited Loading

cocojoe commented Jan 12, 2017

cocojoe commented Jan 13, 2017

Choose a reason for hiding this comment

cocojoe Jan 16, 2017 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

cocojoe commented Jan 16, 2017

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

cocojoe Jan 16, 2017 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

cocojoe commented Jan 12, 2017 •

edited

Loading

cocojoe Jan 16, 2017 •

edited

Loading

cocojoe Jan 16, 2017 •

edited

Loading