BREAKING CHANGE: add forgot password feature in the SupaEmailAuth widget #46

dshukertjr · 2023-03-16T07:21:07Z

What kind of change does this PR introduce?

This PR combines the forgot email flow, signIn, and signUp into a single widget so that the developer using this library does not have to separately implement it.

The aim for this PR is to make it more similar to how Supabase auth UI for react is implemented.

This PR adds the following

Add forgot password feature
Remove authAction parameter on SupaEmailAuth widget.
- Now there is a button to toggle between signIn and signUp in SupaEmailAuth widget, so that there is no need for developers to have two separate SupaEmailAuth in two different places.
Minor internal variable renaming for some cleanup

With this PR, you can have this code

SupaEmailAuth(
  onSignInComplete: (response) {
    // handle signIn
  },
  onSignUpComplete: (response) {
    // handle signUp
  },
),

To get this:

dshukertjr · 2023-03-16T07:25:45Z

@FatumaA @Csierram96
I wanted to create this PR as a proposal, and I would like to hear what you think about it. Obviously it is quite a huge change from the current limitation, and there are pros and cons about this implementation. Any comments is appreciated, and I don't intend to merge this if you think this is not a good idea, so please don't hesitate to let me know if you don't like it if you don't!

dshukertjr · 2023-03-16T07:34:36Z

Will do additional cleanup of example directory if we think this PR is a good idea.

FatumaA · 2023-03-16T09:54:18Z

Seems like the next logical step 🙂. I will take a closer look a little later today.

Thank you for continuing to maintain this while I could not!

Csierram96 · 2023-03-16T14:55:43Z

I'll also take a look by eod. But by looking at the description and the video looks like a nice change/feature

FatumaA

I think switching the '/' from SignIn to home is not necessary since it is an auth lib. I'm assuming that the sign in screen is what should be at the root?
If we keep that change we have to make minor changes on how the app switches screen

Otherwise it looks fine 👍🏽
I will add a commit to remove the forgot password text as it shows doubly

also, do we still need the update_password screen in the example?

I have noticed a bug on validation: fields stay in error even when you toggle between the screens in supaEmailAuth

Remove the forgot password and don't have account text buttons from the example

Csierram96 · 2023-03-17T02:33:46Z

lib/src/components/supa_email_auth.dart

  ///
-  /// Typically used to pass a DeepLink
-  final String? redirectUrl;
+  /// If email confirmation is turned on, the user is


Maybe I'm reading this wrong, but I dont get this description. The user is, is there something missing here?

This is very much a typo! Thanks for finding it, and I will fix it!

Csierram96 · 2023-03-17T02:38:38Z

lib/src/components/supa_email_auth.dart

-                                MapEntry(metaDataField.key, controller.text)),
-                  );
+                    )
+                  : Text(_isSigningIn ? 'Sign In' : 'Sign Up'),


not related to this PR but would be nice to be able to modify the text that shows up. This would be useful to handle intl

Yup, for sure! Certainly something we would want to do in the near future!

Csierram96 · 2023-03-17T02:43:06Z

It looks like a really good addition. Just curious, what are the cons that you see of adding this?

dshukertjr · 2023-03-18T01:36:09Z

Thanks for all the positive comments!

@FatumaA

I think switching the '/' from SignIn to home is not necessary since it is an auth lib. I'm assuming that the sign in screen is what should be at the root?
If we keep that change we have to make minor changes on how the app switches screen

Thanks for the feedback! Makes sense! Will put it back the way it used to be!

Otherwise it looks fine 👍🏽
I will add a commit to remove the forgot password text as it shows doubly

also, do we still need the update_password screen in the example?

I have noticed a bug on validation: fields stay in error even when you toggle between the screens in supaEmailAuth

Yup, I haven't actually checked the example app thoroughly yet. I just wanted to show this feature to you to get some feedback! I will do some cleanup of the example directory!

dshukertjr · 2023-03-18T01:42:25Z

Thanks for the positive feedback @Csierram96 !

It looks like a really good addition. Just curious, what are the cons that you see of adding this?

I guess I had two things:

We just had a fairly large breaking change, and this feature is another large breaking change. I know the library is still in v0.x, which means it's still in pre-release mode therefore breaking change is okay, but wanted to get a feel on how you felt about it.
Less flexibility. Before this update, developers were able to have login and sign-up page in two different routes, but now with this update, login and sign-up are in the same widget, so they have to be in the same page. There are some flexibility lost with this update. I guess though at the end, developers will use this supabase_auth_ui to get up and running quickly, so it might be a bad thing to have less flexibility and more to offer out of the box. If they want flexibility, they can always just create their own login and sign up form from scratch.

Csierram96 · 2023-03-22T03:07:47Z

Thanks for the positive feedback @Csierram96 !

It looks like a really good addition. Just curious, what are the cons that you see of adding this?

I guess I had two things:

We just had a fairly large breaking change, and this feature is another large breaking change. I know the library is still in v0.x, which means it's still in pre-release mode therefore breaking change is okay, but wanted to get a feel on how you felt about it.

Less flexibility. Before this update, developers were able to have login and sign-up page in two different routes, but now with this update, login and sign-up are in the same widget, so they have to be in the same page. There are some flexibility lost with this update. I guess though at the end, developers will use this supabase_auth_ui to get up and running quickly, so it might be a bad thing to have less flexibility and more to offer out of the box. If they want flexibility, they can always just create their own login and sign up form from scratch.

That makes sense. The braking change should be fine as you mentioned as this has not been released as stable. And regarding the flexibility that's actually a good point. Personally I prefer something that just works out of the box for this kinda stuff (firebase ui or supabase ui). And if you want more flexibility you can implement your own UI.

dshukertjr · 2023-03-26T09:37:08Z

Thanks @Csierram96 for the nice comment! It's nice to receive a sanity check from other developers! I will do some additional clean up on this PR and merge it in!

dshukertjr · 2023-05-22T02:30:22Z

I think this one is good to be reviewed!

dshukertjr added 3 commits March 16, 2023 13:38

added forgot password button

09e4af6

combine signin and signUp

bf26ea2

clean up the comments

32c1f7c

dshukertjr changed the title ~~Breaking: add forgot password feature in the SupaEmailAuth widget~~ [Proposed] Breaking: add forgot password feature in the SupaEmailAuth widget Mar 16, 2023

dshukertjr changed the title ~~[Proposed] Breaking: add forgot password feature in the SupaEmailAuth widget~~ Proposed Breaking: add forgot password feature in the SupaEmailAuth widget Mar 16, 2023

dshukertjr added 2 commits March 16, 2023 15:29

remove supa_send_email

a8a5965

example cleanup

b2bb9c0

FatumaA reviewed Mar 16, 2023

View reviewed changes

fix: remove duplicate text from sign_in in example

3b1471f

Remove the forgot password and don't have account text buttons from the example

Csierram96 reviewed Mar 17, 2023

View reviewed changes

dshukertjr mentioned this pull request May 22, 2023

Add docs for this under auth helpers? #16

Closed

dshukertjr changed the title ~~Proposed Breaking: add forgot password feature in the SupaEmailAuth widget~~ BREAKING CHANGE: add forgot password feature in the SupaEmailAuth widget May 22, 2023

dshukertjr added 6 commits May 22, 2023 10:37

update SDK constraints

cdf8776

updated comment docs of supa email auth

ff45211

cleaned up the example

c1967cc

update readme with updated code

8881aae

bump version to v0.2.0

750a7a0

add sdk update to changelog

479c60c

dshukertjr requested a review from FatumaA May 22, 2023 02:30

update deprecated flutter format command to dart format in ci

27cfcda

FatumaA approved these changes May 22, 2023

View reviewed changes

dshukertjr merged commit d388de6 into main May 22, 2023
1 check passed

dshukertjr deleted the BREAKING/forgot-password branch May 22, 2023 07:15

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

BREAKING CHANGE: add forgot password feature in the SupaEmailAuth widget #46

BREAKING CHANGE: add forgot password feature in the SupaEmailAuth widget #46

dshukertjr commented Mar 16, 2023 •

edited

dshukertjr commented Mar 16, 2023

dshukertjr commented Mar 16, 2023

FatumaA commented Mar 16, 2023

Csierram96 commented Mar 16, 2023

FatumaA left a comment •

edited

Csierram96 Mar 17, 2023

dshukertjr Mar 18, 2023

Csierram96 Mar 17, 2023

dshukertjr Mar 18, 2023

Csierram96 commented Mar 17, 2023

dshukertjr commented Mar 18, 2023

dshukertjr commented Mar 18, 2023

Csierram96 commented Mar 22, 2023

dshukertjr commented Mar 26, 2023

dshukertjr commented May 22, 2023 •

edited

BREAKING CHANGE: add forgot password feature in the SupaEmailAuth widget #46

BREAKING CHANGE: add forgot password feature in the SupaEmailAuth widget #46

Conversation

dshukertjr commented Mar 16, 2023 • edited

What kind of change does this PR introduce?

dshukertjr commented Mar 16, 2023

dshukertjr commented Mar 16, 2023

FatumaA commented Mar 16, 2023

Csierram96 commented Mar 16, 2023

FatumaA left a comment • edited

Choose a reason for hiding this comment

Csierram96 Mar 17, 2023

Choose a reason for hiding this comment

dshukertjr Mar 18, 2023

Choose a reason for hiding this comment

Csierram96 Mar 17, 2023

Choose a reason for hiding this comment

dshukertjr Mar 18, 2023

Choose a reason for hiding this comment

Csierram96 commented Mar 17, 2023

dshukertjr commented Mar 18, 2023

dshukertjr commented Mar 18, 2023

Csierram96 commented Mar 22, 2023

dshukertjr commented Mar 26, 2023

dshukertjr commented May 22, 2023 • edited

dshukertjr commented Mar 16, 2023 •

edited

FatumaA left a comment •

edited

dshukertjr commented May 22, 2023 •

edited