feat: Adds signInFeature type and validation for form fields in EmailPassword Recipe #976
Conversation
✅ Deploy Preview for precious-marshmallow-968a81 canceled.
|
✅ Deploy Preview for astounding-pegasus-21c111 canceled.
|
| @@ -12,7 +12,7 @@ | |||
| * License for the specific language governing permissions and limitations | |||
| * under the License. | |||
| */ | |||
| export const version = "21.1.0"; | |||
| export const version = "21.1.1"; | |||
There was a problem hiding this comment.
This will be a minor (not patch) level change.
| validate: field.id === FORM_FIELD_EMAIL_ID ? field.validate : defaultValidator, | ||
| optional: false, | ||
| }; | ||
| function normaliseSignInFormFields(formFields?: TypeInputFormField[]) { |
There was a problem hiding this comment.
If done this way, it'd be a breaking change: if someone added an override for their email validators in the sign up config, they'd expect it to be applied here. I'd prefer if we kept it that way as well.
| if (field.id === FORM_FIELD_PASSWORD_ID) { | ||
| normalisedFormFields.push({ | ||
| id: field.id, | ||
| validate: field.validate === undefined ? defaultPasswordValidator : field.validate, |
There was a problem hiding this comment.
In general, you shouldn't have a validator for the password field during sign-in, since we'd want to check the DB in most cases anyway to prevent cases where a password validation change is preventing people from logging in. I don't mind giving people the option to define this specifically, but by default it should let everything pass.
| validate: field.validate === undefined ? defaultPasswordValidator : field.validate, | |
| validate: field.validate === undefined ? defaultValidator : field.validate, |
| }); | ||
| } | ||
| if (normalisedFormFields.filter((field) => field.id === FORM_FIELD_PASSWORD_ID).length === 0) { |
There was a problem hiding this comment.
| if (normalisedFormFields.filter((field) => field.id === FORM_FIELD_PASSWORD_ID).length === 0) { | |
| if (!normalisedFormFields.some((field) => field.id === FORM_FIELD_PASSWORD_ID)) { |
| optional: false, | ||
| }); | ||
| } | ||
| if (normalisedFormFields.filter((field) => field.id === FORM_FIELD_EMAIL_ID).length === 0) { |
There was a problem hiding this comment.
| if (normalisedFormFields.filter((field) => field.id === FORM_FIELD_EMAIL_ID).length === 0) { | |
| if (!normalisedFormFields.some((field) => field.id === FORM_FIELD_EMAIL_ID)) { |
| // no password field give by user | ||
| normalisedFormFields.push({ | ||
| id: FORM_FIELD_PASSWORD_ID, | ||
| validate: defaultPasswordValidator, |
There was a problem hiding this comment.
| validate: defaultPasswordValidator, | |
| validate: defaultValidator, |
| // no email field give by user | ||
| normalisedFormFields.push({ | ||
| id: FORM_FIELD_EMAIL_ID, | ||
| validate: defaultEmailValidator, |
There was a problem hiding this comment.
This should fall back to the (normalized) email field validator for sign-up to avoid breaking apps.
|
Hi, thanks for your contribution. I think we should be able to get this merged and released next week :) |
Summary of change
Introduce a new
signInFeaturetype with validation for form fields, ensuring proper handling of email and password fields. Update related functions to accommodate the new feature. Why? Because my use case needs to send additional data to the SignIn POST endpoint and that made things complicated for the only way to achieve this was to override the SignInPost.Related issues
Test Plan
npm run test. All tests have passed.
Documentation changes
Checklist for important updates
coreDriverInterfaceSupported.jsonfile has been updated (if needed)lib/ts/version.tsfrontendDriverInterfaceSupported.jsonfile has been updated (if needed)package.jsonpackage-lock.jsonlib/ts/version.tsnpm run build-prettyrecipe/thirdparty/providers/configUtils.tsfile,createProviderfunction.git tag) in the formatvX.Y.Z, and then find the latest branch (git branch --all) whoseX.Yis greater than the latest released tag.add-ts-no-check.jsfile to include thatsomeFunc: function () {..}).exportsinpackage.jsonRemaining TODOs for this PR