Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

PasswordForm Function Migration #20515

Merged
merged 5 commits into from
Jun 15, 2023

Conversation

esh-g
Copy link
Contributor

@esh-g esh-g commented Jun 9, 2023

Details

Fixed Issues

$ #16300
PROPOSAL: #16300 (comment)

Tests

For Local Testing

  1. Disable Passwordless login by returning false from the function canUsePasswordlessLogin in Permissions.js.
  2. Sign-out of your account.
  3. Enter email of an account having a password set previously.
  4. In the password screen, verify that we can see errors, all buttons work correctly and we are able to login.
  • Verify that no errors appear in the JS console

Offline tests

QA Steps

  1. Sign-out of your account.
  2. Enter email of an account having a password set previously and having passwordless login disabled.
  3. In the password screen, verify that we can see errors, all buttons work correctly and we are able to login.
  • Verify that no errors appear in the JS console

PR Author Checklist

  • I linked the correct issue in the ### Fixed Issues section above
  • I wrote clear testing steps that cover the changes made in this PR
    • I added steps for local testing in the Tests section
    • I added steps for the expected offline behavior in the Offline steps section
    • I added steps for Staging and/or Production testing in the QA steps section
    • I added steps to cover failure scenarios (i.e. verify an input displays the correct error message if the entered data is not correct)
    • I turned off my network connection and tested it while offline to ensure it matches the expected behavior (i.e. verify the default avatar icon is displayed if app is offline)
    • I tested this PR with a High Traffic account against the staging or production API to ensure there are no regressions (e.g. long loading states that impact usability).
  • I included screenshots or videos for tests on all platforms
  • I ran the tests on all platforms & verified they passed on:
    • Android / native
    • Android / Chrome
    • iOS / native
    • iOS / Safari
    • MacOS / Chrome / Safari
    • MacOS / Desktop
  • I verified there are no console errors (if there's a console error not related to the PR, report it or open an issue for it to be fixed)
  • I followed proper code patterns (see Reviewing the code)
    • I verified that any callback methods that were added or modified are named for what the method does and never what callback they handle (i.e. toggleReport and not onIconClick)
    • I verified that the left part of a conditional rendering a React component is a boolean and NOT a string, e.g. myBool && <MyComponent />.
    • I verified that comments were added to code that is not self explanatory
    • I verified that any new or modified comments were clear, correct English, and explained "why" the code was doing something instead of only explaining "what" the code was doing.
    • I verified any copy / text shown in the product is localized by adding it to src/languages/* files and using the translation method
      • If any non-english text was added/modified, I verified the translation was requested/reviewed in #expensify-open-source and it was approved by an internal Expensify engineer. Link to Slack message:
    • I verified all numbers, amounts, dates and phone numbers shown in the product are using the localization methods
    • I verified any copy / text that was added to the app is grammatically correct in English. It adheres to proper capitalization guidelines (note: only the first word of header/labels should be capitalized), and is approved by marketing by adding the Waiting for Copy label for a copy review on the original GH to get the correct copy.
    • I verified proper file naming conventions were followed for any new files or renamed files. All non-platform specific files are named after what they export and are not named "index.js". All platform-specific files are named for the platform the code supports as outlined in the README.
    • I verified the JSDocs style guidelines (in STYLE.md) were followed
  • If a new code pattern is added I verified it was agreed to be used by multiple Expensify engineers
  • I followed the guidelines as stated in the Review Guidelines
  • I tested other components that can be impacted by my changes (i.e. if the PR modifies a shared library or component like Avatar, I verified the components using Avatar are working as expected)
  • I verified all code is DRY (the PR doesn't include any logic written more than once, with the exception of tests)
  • I verified any variables that can be defined as constants (ie. in CONST.js or at the top of the file that uses the constant) are defined as such
  • I verified that if a function's arguments changed that all usages have also been updated correctly
  • If a new component is created I verified that:
    • A similar component doesn't exist in the codebase
    • All props are defined accurately and each prop has a /** comment above it */
    • The file is named correctly
    • The component has a clear name that is non-ambiguous and the purpose of the component can be inferred from the name alone
    • The only data being stored in the state is data necessary for rendering and nothing else
    • For Class Components, any internal methods passed to components event handlers are bound to this properly so there are no scoping issues (i.e. for onClick={this.submit} the method this.submit should be bound to this in the constructor)
    • Any internal methods bound to this are necessary to be bound (i.e. avoid this.submit = this.submit.bind(this); if this.submit is never passed to a component event handler like onClick)
    • All JSX used for rendering exists in the render method
    • The component has the minimum amount of code necessary for its purpose, and it is broken down into smaller components in order to separate concerns and functions
  • If any new file was added I verified that:
    • The file has a description of what it does and/or why is needed at the top of the file if the code is not self explanatory
  • If a new CSS style is added I verified that:
    • A similar style doesn't already exist
    • The style can't be created with an existing StyleUtils function (i.e. StyleUtils.getBackgroundAndBorderStyle(themeColors.componentBG))
  • If the PR modifies code that runs when editing or sending messages, I tested and verified there is no unexpected behavior for all supported markdown - URLs, single line code, code blocks, quotes, headings, bold, strikethrough, and italic.
  • If the PR modifies a generic component, I tested and verified that those changes do not break usages of that component in the rest of the App (i.e. if a shared library or component like Avatar is modified, I verified that Avatar is working as expected in all cases)
  • If the PR modifies a component related to any of the existing Storybook stories, I tested and verified all stories for that component are still working as expected.
  • If a new page is added, I verified it's using the ScrollView component to make it scrollable when more elements are added to the page.
  • If the main branch was merged into this PR after a review, I tested again and verified the outcome was still expected according to the Test steps.
  • I have checked off every checkbox in the PR author checklist, including those that don't apply to this PR.

Screenshots/Videos

Web
Screen.Recording.2023-06-09.at.6.31.51.PM.mov
Mobile Web - Chrome
Screen.Recording.2023-06-10.at.8.42.40.AM.mov
Screen.Recording.2023-06-10.at.8.28.09.AM.mov
Mobile Web - Safari
Screen.Recording.2023-06-10.at.8.12.51.AM.mov
Desktop
Screen.Recording.2023-06-10.at.8.19.28.AM-1.mov
iOS
Screen.Recording.2023-06-10.at.8.11.36.AM.mov
Android
Screen.Recording.2023-06-10.at.8.26.22.AM.mov

@esh-g esh-g requested a review from a team as a code owner June 9, 2023 13:03
@melvin-bot melvin-bot bot requested review from fedirjh and yuwenmemon and removed request for a team June 9, 2023 13:03
@melvin-bot
Copy link

melvin-bot bot commented Jun 9, 2023

@yuwenmemon @fedirjh One of you needs to copy/paste the Reviewer Checklist from here into a new comment on this PR and complete it. If you have the K2 extension, you can simply click: [this button]

@esh-g
Copy link
Contributor Author

esh-g commented Jun 9, 2023

@yuwenmemon @fedirjh I have been testing this by setting canUsePasswordless to false in Permissions.js... I'm not sure what to enter in the QA steps.. Could you please discuss that? I'll edit the steps once we finalize them.

@fedirjh
Copy link
Contributor

fedirjh commented Jun 9, 2023

@esh-g Can you please include all screenshots.

I have been testing this by setting canUsePasswordless to false in Permissions.js

As for testing steps , for local dev testing we can include that. For QA, I think we can just require an account with passwordless disabled (not sure if this is still valid case).

@esh-g
Copy link
Contributor Author

esh-g commented Jun 10, 2023

@esh-g Can you please include all screenshots.

Yes, just wanted to make sure I had the right steps... I'll edit and add the steps

@esh-g
Copy link
Contributor Author

esh-g commented Jun 10, 2023

@fedirjh Updated the steps and added videos for each platform.

@esh-g
Copy link
Contributor Author

esh-g commented Jun 13, 2023

@fedirjh @yuwenmemon Is there something else that needs to be done on my end?

@yuwenmemon
Copy link
Contributor

@fedirjh will be doing a first-pass review. @fedirjh bump!

@fedirjh
Copy link
Contributor

fedirjh commented Jun 13, 2023

@esh-g Can you please take a look at this console error, It happen when we click Forgot?

Screenshot 2023-06-13 at 8 27 47 PM

Copy link
Contributor

@fedirjh fedirjh left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code looks good , left few comments about eslint and little bug , maybe caused by disabling eslint.

clearPassword();
}
// We cannot add password to the dependency list because it will clear every time it updates
// eslint-disable-next-line react-hooks/exhaustive-deps
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@esh-g We shouldn’t disable eslint for react-hooks/exhaustive-deps . Actually, since password is not included in the deps array this hook will always run with the initial password's value. Finally, the autofill feature is broken, when you select a saved login with password , both login and password should be filled.

return;
}
validateAndSubmitForm();
// eslint-disable-next-line react-hooks/exhaustive-deps -- We don't need to call this when the function changes.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We shouldn’t disable eslint here as well ,

We don't need to call this when the function changes.

can you please explain this comment ? what happens if we call the hook when the function changes ?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Well it was more of an optimisation tweak to make sure that we are not running this on any unintentional changes, but I don't think it will matter if we include it or not. So anyway, I'll include it.

@esh-g
Copy link
Contributor Author

esh-g commented Jun 14, 2023

@fedirjh This error is occurring in the SignInPageLayout

let welcomeText = '';

Here first it was not set to empty string and was undefined. In the latest main, it will not occur

@esh-g
Copy link
Contributor Author

esh-g commented Jun 14, 2023

Autofill I think is working on my end...

Screen.Recording.2023-06-14.at.1.27.01.PM.mov

@fedirjh
Copy link
Contributor

fedirjh commented Jun 14, 2023

Autofill I think is working on my end...

@esh-g I am referring to the password manager , the saved password should be filled. the video you shared is password autosuggestion, here is expected behaviour

pass.mov

@esh-g
Copy link
Contributor Author

esh-g commented Jun 14, 2023

@fedirjh Strange.. It seems to add it only on clicking.. Are you aware of any reason that it should happen?

Screen.Recording.2023-06-14.at.2.29.13.PM.mov

@esh-g
Copy link
Contributor Author

esh-g commented Jun 14, 2023

Okay, I figured it out.. It happens because of the clear form code.. TBH, I too don't understand why this code is required. I just put it in because it was in the previous design. Should I remove these three lines?

Screenshot 2023-06-14 at 2 33 09 PM

@fedirjh
Copy link
Contributor

fedirjh commented Jun 14, 2023

Should I remove these three lines?

Before we remove it, we need to determine the reason behind its addition. Additionally, I have noticed a slight difference between the old implementation and the new one. Previously, we were checking both prevProps and props. However, in this refactor, we have eliminated the check for prevProps, which means there has been a change in the code. We should either fix it or refactor it accordingly.

// old check
        if (prevProps.isVisible && !this.props.isVisible && this.state.password) {

// actual check
        if (!props.isVisible && password) {

@esh-g
Copy link
Contributor Author

esh-g commented Jun 14, 2023

@fedirjh I don't think we can access previous props in functional components unless we create a new hook ourselves.

function usePrevious(value) {
  const ref = useRef();
  useEffect(() => {
    ref.current = value;
  });
  return ref.current;
}

Moreover, this code is running when props.isVisible is changed, which automatically means that the previous value was different from the current one and since props.isVisible is a bool, we can easily say that it was the opposite of current value.

@esh-g
Copy link
Contributor Author

esh-g commented Jun 14, 2023

@fedirjh Added your suggestion! 👍

@esh-g esh-g requested a review from fedirjh June 14, 2023 20:01
@fedirjh
Copy link
Contributor

fedirjh commented Jun 15, 2023

@esh-g Can you please merge main

@esh-g
Copy link
Contributor Author

esh-g commented Jun 15, 2023

@fedirjh Done!

@fedirjh
Copy link
Contributor

fedirjh commented Jun 15, 2023

Reviewer Checklist

  • I have verified the author checklist is complete (all boxes are checked off).
  • I verified the correct issue is linked in the ### Fixed Issues section above
  • I verified testing steps are clear and they cover the changes made in this PR
    • I verified the steps for local testing are in the Tests section
    • I verified the steps for Staging and/or Production testing are in the QA steps section
    • I verified the steps cover any possible failure scenarios (i.e. verify an input displays the correct error message if the entered data is not correct)
    • I turned off my network connection and tested it while offline to ensure it matches the expected behavior (i.e. verify the default avatar icon is displayed if app is offline)
  • I checked that screenshots or videos are included for tests on all platforms
  • I included screenshots or videos for tests on all platforms
  • I verified tests pass on all platforms & I tested again on:
    • Android / native
    • Android / Chrome
    • iOS / native
    • iOS / Safari
    • MacOS / Chrome / Safari
    • MacOS / Desktop
  • If there are any errors in the console that are unrelated to this PR, I either fixed them (preferred) or linked to where I reported them in Slack
  • I verified proper code patterns were followed (see Reviewing the code)
    • I verified that any callback methods that were added or modified are named for what the method does and never what callback they handle (i.e. toggleReport and not onIconClick).
    • I verified that the left part of a conditional rendering a React component is a boolean and NOT a string, e.g. myBool && <MyComponent />.
    • I verified that comments were added to code that is not self explanatory
    • I verified that any new or modified comments were clear, correct English, and explained "why" the code was doing something instead of only explaining "what" the code was doing.
    • I verified any copy / text shown in the product is localized by adding it to src/languages/* files and using the translation method
    • I verified all numbers, amounts, dates and phone numbers shown in the product are using the localization methods
    • I verified any copy / text that was added to the app is grammatically correct in English. It adheres to proper capitalization guidelines (note: only the first word of header/labels should be capitalized), and is approved by marketing by adding the Waiting for Copy label for a copy review on the original GH to get the correct copy.
    • I verified proper file naming conventions were followed for any new files or renamed files. All non-platform specific files are named after what they export and are not named "index.js". All platform-specific files are named for the platform the code supports as outlined in the README.
    • I verified the JSDocs style guidelines (in STYLE.md) were followed
  • If a new code pattern is added I verified it was agreed to be used by multiple Expensify engineers
  • I verified that this PR follows the guidelines as stated in the Review Guidelines
  • I verified other components that can be impacted by these changes have been tested, and I retested again (i.e. if the PR modifies a shared library or component like Avatar, I verified the components using Avatar have been tested & I retested again)
  • I verified all code is DRY (the PR doesn't include any logic written more than once, with the exception of tests)
  • I verified any variables that can be defined as constants (ie. in CONST.js or at the top of the file that uses the constant) are defined as such
  • If a new component is created I verified that:
    • A similar component doesn't exist in the codebase
    • All props are defined accurately and each prop has a /** comment above it */
    • The file is named correctly
    • The component has a clear name that is non-ambiguous and the purpose of the component can be inferred from the name alone
    • The only data being stored in the state is data necessary for rendering and nothing else
    • For Class Components, any internal methods passed to components event handlers are bound to this properly so there are no scoping issues (i.e. for onClick={this.submit} the method this.submit should be bound to this in the constructor)
    • Any internal methods bound to this are necessary to be bound (i.e. avoid this.submit = this.submit.bind(this); if this.submit is never passed to a component event handler like onClick)
    • All JSX used for rendering exists in the render method
    • The component has the minimum amount of code necessary for its purpose, and it is broken down into smaller components in order to separate concerns and functions
  • If any new file was added I verified that:
    • The file has a description of what it does and/or why is needed at the top of the file if the code is not self explanatory
  • If a new CSS style is added I verified that:
    • A similar style doesn't already exist
    • The style can't be created with an existing StyleUtils function (i.e. StyleUtils.getBackgroundAndBorderStyle(themeColors.componentBG)
  • If the PR modifies code that runs when editing or sending messages, I tested and verified there is no unexpected behavior for all supported markdown - URLs, single line code, code blocks, quotes, headings, bold, strikethrough, and italic.
  • If the PR modifies a generic component, I tested and verified that those changes do not break usages of that component in the rest of the App (i.e. if a shared library or component like Avatar is modified, I verified that Avatar is working as expected in all cases)
  • If the PR modifies a component related to any of the existing Storybook stories, I tested and verified all stories for that component are still working as expected.
  • If a new page is added, I verified it's using the ScrollView component to make it scrollable when more elements are added to the page.
  • If the main branch was merged into this PR after a review, I tested again and verified the outcome was still expected according to the Test steps.
  • I have checked off every checkbox in the PR reviewer checklist, including those that don't apply to this PR.

Screenshots/Videos

Web Screenshot 2023-06-15 at 8 36 27 AM Screenshot 2023-06-15 at 8 36 47 AM Screenshot 2023-06-15 at 8 37 00 AM Screenshot 2023-06-15 at 8 52 35 AM
Web.mov
Mobile Web - Chrome
Chrome.mov
Mobile Web - Safari
Safari.mov
Desktop
Desktop.mov
iOS
IOS.mov
Android
Screen.Recording.2023-06-15.at.8.43.15.AM.mov
Screen.Recording.2023-06-15.at.8.43.47.AM.mov

Copy link
Contributor

@fedirjh fedirjh left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM and tests well

cc @yuwenmemon

@yuwenmemon yuwenmemon merged commit 9727956 into Expensify:main Jun 15, 2023
@OSBotify
Copy link
Contributor

✋ This PR was not deployed to staging yet because QA is ongoing. It will be automatically deployed to staging after the next production release.

@OSBotify
Copy link
Contributor

🚀 Deployed to staging by https://github.com/yuwenmemon in version: 1.3.29-0 🚀

platform result
🤖 android 🤖 success ✅
🖥 desktop 🖥 success ✅
🍎 iOS 🍎 success ✅
🕸 web 🕸 success ✅

@kavimuru
Copy link

@yuwenmemon @fedirjh We don't have account with passwordless disabled. How to run this PR?

@fedirjh
Copy link
Contributor

fedirjh commented Jun 19, 2023

@kavimuru We can't test this page without disabling passwordless.

@yuwenmemon
Copy link
Contributor

@kavimuru just make sure the 2FA flow works and we should be good.

@OSBotify
Copy link
Contributor

🚀 Deployed to production by https://github.com/luacmartins in version: 1.3.29-11 🚀

platform result
🤖 android 🤖 success ✅
🖥 desktop 🖥 success ✅
🍎 iOS 🍎 success ✅
🕸 web 🕸 success ✅

@rayane-djouah
Copy link
Contributor

Hi @esh-g @fedirjh !
could you help me please? I need an account with a previously set password to test this PR

@fedirjh
Copy link
Contributor

fedirjh commented Jul 18, 2023

@rayane-djouah You can enable disable PasswordlessLogins in permissions file.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants