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

Migrate SignInPage to functional component #19498

Merged
merged 19 commits into from
Jun 8, 2023
Merged

Conversation

roryabraham
Copy link
Contributor

@roryabraham roryabraham commented May 23, 2023

Details

Migrating SignInPage to functional component.

Fixed Issues

$ #16301

Tests

  1. Sign in to NewDot with an account that does not require 2FA by copy/pasting the magic code.
  2. Sign in to NewDot with an account that does not require 2FA by clicking on the magic code.
  3. Sign in to NewDot with an account that requires 2FA by copy/pasting the magic code.
  4. Sign in to NewDot with an account that requires 2FA by clicking on the magic code.
  • Verify that no errors appear in the JS console

Offline tests

n/a – sign in flows are online-only.

QA Steps

Same as tests.

  • 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
web.mov
Mobile Web - Chrome
screen-20230601-151350.mp4
Mobile Web - Safari
iOSWeb.MP4
Desktop
desktop.mov
iOS

Full iOS testing blocked by unrelated bug.

Android
screen-20230601-152134.mp4

@roryabraham roryabraham self-assigned this May 23, 2023
@roryabraham roryabraham changed the title [WIP] Migrate SignInPage to functional component Migrate SignInPage to functional component Jun 1, 2023
@roryabraham roryabraham marked this pull request as ready for review June 1, 2023 22:37
@roryabraham roryabraham requested a review from a team as a code owner June 1, 2023 22:37
@melvin-bot melvin-bot bot requested review from jasperhuangg and sobitneupane and removed request for a team June 1, 2023 22:37
@melvin-bot
Copy link

melvin-bot bot commented Jun 1, 2023

@sobitneupane @jasperhuangg 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]

Copy link
Contributor

@sobitneupane sobitneupane left a comment

Choose a reason for hiding this comment

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

Screenshots/Videos

Web
Screen.Recording.2023-06-05.at.17.05.34.mov
Screen.Recording.2023-06-05.at.17.02.38.mov
clipped.mov
Screen.Recording.2023-06-05.at.17.18.57.mov
Mobile Web - Chrome
Screen.Recording.2023-06-05.at.17.48.23.mov
Screen.Recording.2023-06-05.at.17.45.24.mov
Screen.Recording.2023-06-05.at.17.52.29.mov
Mobile Web - Safari
Screen.Recording.2023-06-05.at.17.39.06.mov
Screen.Recording.2023-06-05.at.17.43.19.mov
Desktop
Screen.Recording.2023-06-05.at.17.27.31.mov
Screen.Recording.2023-06-05.at.17.25.28.mov
Screen.Recording.2023-06-05.at.17.24.02.mov
iOS
Screen.Recording.2023-06-05.at.17.35.52.mov
Screen.Recording.2023-06-05.at.17.32.24.mov
Android
Screen.Recording.2023-06-05.at.18.05.06.mov
Screen.Recording.2023-06-05.at.18.02.08.mov

Comment on lines +10 to +18
_.reduce(
Permissions,
(memo, checkerFunction, beta) => {
// eslint-disable-next-line no-param-reassign
memo[beta] = checkerFunction(betas);
return memo;
},
{},
),
Copy link
Member

Choose a reason for hiding this comment

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

IMO, it will be cleaner to break this into statements.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I thought about that, but it would be a lot more verbose, and anyone adding or removing betas would also have to remember to update the hook. This way, you just have to add a new function to libs/Permissions and the hook will automatically handle that. This seems more robust to me.

Copy link
Member

@parasharrajat parasharrajat Jun 8, 2023

Choose a reason for hiding this comment

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

Yeah, that is fine. I was just saying to break this nested logic into multiple statements. It is hard to read.

@roryabraham roryabraham requested a review from a team June 8, 2023 07:37
@roryabraham
Copy link
Contributor Author

Using PullerBear to get another Expensify reviewer since @jasperhuangg is OOO until next week.

@melvin-bot melvin-bot bot requested review from arosiclair and rushatgabhane and removed request for a team June 8, 2023 07:38
@melvin-bot

This comment was marked as resolved.

@roryabraham roryabraham removed the request for review from rushatgabhane June 8, 2023 07:38
Copy link
Contributor

@arosiclair arosiclair left a comment

Choose a reason for hiding this comment

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

LGTM just questioning useMemo usage

src/pages/signin/SignInPage.js Outdated Show resolved Hide resolved
@arosiclair arosiclair merged commit 38ba7c8 into main Jun 8, 2023
@arosiclair arosiclair deleted the Rory-HookySignInPage branch June 8, 2023 19:03
@OSBotify
Copy link
Contributor

OSBotify commented Jun 8, 2023

✋ 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/arosiclair in version: 1.3.27-0 🚀

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

@OSBotify
Copy link
Contributor

🚀 Deployed to staging by https://github.com/arosiclair in version: 1.3.27-0 🚀

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

@mountiny
Copy link
Contributor

This has introduced a regression where its not possible to log into NewDot with unvalidated accounts (new accounts) #20676

since its quite a big PR but there shouldnt be conflicts I am going to create a revert to get this out sooner to increase chances of daily deploy

// - AND the login is not the primary login
// - AND the login is not validated
const showUnlinkLoginForm =
Boolean(this.props.credentials.login && this.props.account.primaryLogin) && this.props.account.primaryLogin !== this.props.credentials.login && !this.props.account.validated;
Copy link
Contributor

Choose a reason for hiding this comment

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

here we also check for the this.props.account.primaryLogin

shouldShowWelcomeHeader,
shouldShowWelcomeText,
} = getRenderOptions({
hasLogin: Boolean(credentials.login),
Copy link
Contributor

Choose a reason for hiding this comment

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

but here we dont have it, I have tried changing this to Boolean(credentials.login && account.primaryLogin), but it did not fix the issue on its own and because its a deploy blocker and there is couple more I have went with revert.

hasLogin: Boolean(credentials.login),
hasPassword: Boolean(credentials.password),
hasValidateCode: Boolean(credentials.validateCode),
isPrimaryLogin: account.primaryLogin && account.primaryLogin === credentials.login,
Copy link
Contributor

@Pujan92 Pujan92 Jun 13, 2023

Choose a reason for hiding this comment

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

Suggestion

isPrimaryLogin: !account.primaryLogin ||  account.primaryLogin === credentials.login,

@OSBotify
Copy link
Contributor

🚀 Deployed to production by https://github.com/AndrewGable in version: 1.3.27-7 🚀

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

Comment on lines +115 to +116
let welcomeHeader;
let welcomeText;
Copy link
Contributor

@MonilBhavsar MonilBhavsar Jul 24, 2023

Choose a reason for hiding this comment

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

Seems like this has caused a console warning #22923. welcomeHeader and welcomeText are required props in SigninPage layout, and not initialzing them as empty string displays an error. Yes, in unlinklogin form case, it is also not initialized in the condition below

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.

9 participants