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

[TS migration] Migrate Signin to TypeScript #35294

Merged
merged 75 commits into from
Feb 14, 2024

Conversation

fedirjh
Copy link
Contributor

@fedirjh fedirjh commented Jan 29, 2024

Details

Fixed Issues

$ #25224
PROPOSAL: #25224 (comment)

Tests

Test 1: SAML enabled but not required

  1. Create an account with a validated domain on expensify.com
  2. Configure your account to have SAML enabled but not required
  3. Enter the email for your account in New Expensify
  4. Confirm you see the option to choose to sign in with SAML or with a magic code
  5. Choose the Go Back option and confirm you're dropped back on the sign-in page with your email pre-filled
  6. Press Continue
  7. Choose the Use Magic Code option and confirm you get a magic code sent to your email
  8. Press Go Back and confirm you're back on the sign-in page with your email pre-filled
  9. Press Continue
  10. Choose Use Single Sign On option
  11. Confirm you briefly see an interstitial page about launching your SSO provider's login portal

Test 2: SAML enabled and required

  1. Create an account with a validated domain on expensify.com
  2. Configure your account to have SAML enabled and required
  3. Enter the email for your account in New Expensify
  4. Press Continue
  5. Confirm you're automatically redirected to your SSO providers login page (with the interstitial page being briefly shown)

Test 3: Login / Signup

  1. Open App and navigate to the sign in page.
  2. Enter your email address and press Continue.
  3. Verify Enter magic code screen appears
  4. Enter wrong magic code
  5. Verify an error message appears.
  6. Click Go back and confirm you're dropped back on the sign-in page with your email pre-filled
  7. Click continue and enter the correct magic code
  8. Verify you're signed in successfully.

Test 4: Email delivery failure

  1. Login into your account on oldDot and add the email delivery failed NVP by pasting the following in the JS console: NVP.set('expensify_emailDeliveryFailure', {'lastSMTPErrorDatetime': moment.now().addDays(1).toString()});
  2. In an incognito window, try to log into your account in newDot
  3. Confirm you see the email delivery failure screen.
  4. Click Back and confirm it takes you back to the login view to enter an email/sms number
  5. In your original window run NVP.set('expensify_emailDeliveryFailure', null); in the JS console to unblock your account
  6. Click continue and confirm the magic code screen is displayed.

Test 5: Web Only

  1. Open the Login page.
  2. Open a new Login page in a new window or tab.
  3. Check if Another Login Page is Open view is shown in the first window/tab.

Test 6: Footer Links

  1. Open App and navigate to the sign in page.
  2. Scroll to the footer
  3. Verify links works as expected.
  • Verify that the design of the sign in page matches the production version.
  • Verify that no errors appear in the JS console

Offline tests

  1. Navigate to the login page for New Expensify and enter your email
  2. Disable your wifi or disable your network connections
  3. Confirm you see the offline indicator

QA Steps

Same as the Tests section above + :

  1. Go to sign in page
  2. Click the Google/Apple sign-in buttons
  3. Verify that buttons works as expected
  • 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: mWeb Chrome
    • iOS: Native
    • iOS: mWeb 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 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(theme.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 the PR modifies a component or page that can be accessed by a direct deeplink, I verified that the code functions as expected when the deeplink is used - from a logged in and logged out account.
  • If the PR modifies the form input styles:
    • I verified that all the inputs inside a form are aligned with each other.
    • I added Design label so the design team can review the changes.
  • 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.

Screenshots/Videos

Android: Native
Screen.Recording.2024-02-07.at.4.35.47.PM.mov
Screen.Recording.2024-02-07.at.4.37.56.PM.mov
Screen.Recording.2024-02-07.at.4.41.12.PM.mov
Screenshot 2024-02-07 at 4 40 40 PM
Android: mWeb Chrome
Screen.Recording.2024-02-07.at.4.28.14.PM.mov
Screen.Recording.2024-02-07.at.4.31.35.PM.mov
Screen.Recording.2024-02-07.at.4.32.25.PM.mov
Screenshot 2024-02-07 at 4 30 42 PM
iOS: Native
Screen.Recording.2024-02-07.at.3.54.29.PM.mov
Screen.Recording.2024-02-07.at.3.55.49.PM.mov
Screenshot 2024-02-07 at 3 56 47 PM
Simulator.Screen.Recording.-.iPhone.15.Pro.-.2024-02-07.at.15.50.43.mp4
iOS: mWeb Safari
Screen.Recording.2024-02-07.at.4.02.31.PM.mov
Screen.Recording.2024-02-07.at.4.05.19.PM.mov
Screen.Recording.2024-02-07.at.4.06.20.PM.mov
Screenshot 2024-02-07 at 4 09 45 PM
MacOS: Chrome / Safari
CleanShot.2024-02-07.at.14.58.00.mp4
CleanShot.2024-02-07.at.14.59.49.mp4
CleanShot.2024-02-07.at.15.04.59.mp4
Screenshot 2024-02-07 at 3 13 51 PM
Screen.Recording.2024-02-07.at.5.10.54.PM.mov
Screen.Recording.2024-02-07.at.5.18.42.PM.mov
MacOS: Desktop Screenshot 2024-02-07 at 3 23 43 PM
CleanShot.2024-02-07.at.15.22.52.mp4
Screen.Recording.2024-02-07.at.3.24.42.PM.mov
Screen.Recording.2024-02-07.at.3.32.07.PM.mov

@fedirjh fedirjh force-pushed the ts-migration-signin branch 2 times, most recently from 37c3af9 to 76bd80e Compare February 6, 2024 21:46
@fedirjh fedirjh marked this pull request as ready for review February 7, 2024 16:22
@fedirjh fedirjh requested a review from a team as a code owner February 7, 2024 16:22
@melvin-bot melvin-bot bot requested review from s77rt and removed request for a team February 7, 2024 16:22
Copy link

melvin-bot bot commented Feb 7, 2024

@s77rt Please 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]

@fedirjh fedirjh changed the title Migrate Signin to TypeScript [TS migration] Migrate Signin to TypeScript Feb 8, 2024
Copy link
Contributor

@s77rt s77rt left a comment

Choose a reason for hiding this comment

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

Partial review

src/components/TextLink.tsx Outdated Show resolved Hide resolved
/** Whether the content is visible. */
isVisible: boolean;
isVisible?: boolean;
Copy link
Contributor

Choose a reason for hiding this comment

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

This should be kept as required. There is another PR dealing with this rn #35404 (comment). Writing a comment so I don't forgot to check again

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 actually used the same props as that PR for this component.

src/pages/signin/ChooseSSOOrMagicCode.tsx Outdated Show resolved Hide resolved
src/pages/signin/EmailDeliveryFailurePage.tsx Outdated Show resolved Hide resolved
src/pages/signin/EmailDeliveryFailurePage.tsx Outdated Show resolved Hide resolved
src/pages/signin/LoginForm/BaseLoginForm.tsx Outdated Show resolved Hide resolved
src/pages/signin/LoginForm/BaseLoginForm.tsx Outdated Show resolved Hide resolved
src/pages/signin/LoginForm/BaseLoginForm.tsx Show resolved Hide resolved
src/pages/signin/LoginForm/BaseLoginForm.tsx Outdated Show resolved Hide resolved
src/pages/signin/LoginForm/BaseLoginForm.tsx Outdated Show resolved Hide resolved
Reorganized code by introducing shared types in `SignInPageLayoutProps`, which streamlined the props of all components in the SignInPageLayout. The shared types are now used in Footer, SignInPageContent, SignInPageLayout, SignInHeroCopy, SignInPageHero, and SignInHeroImage components. Files have been moved to the SignInPageLayout directory for better organization.
@fedirjh fedirjh requested a review from s77rt February 10, 2024 16:14
src/pages/signin/SignInPageLayout/SignInHeroCopy.tsx Outdated Show resolved Hide resolved
src/pages/signin/SAMLSignInPage/types.ts Outdated Show resolved Hide resolved
src/pages/signin/Socials.tsx Outdated Show resolved Hide resolved
src/pages/signin/Socials.tsx Outdated Show resolved Hide resolved
src/pages/signin/Terms.tsx Outdated Show resolved Hide resolved
src/pages/signin/SignInPage.tsx Show resolved Hide resolved
src/pages/signin/SignInPage.tsx Outdated Show resolved Hide resolved
src/pages/signin/SignInPage.tsx Outdated Show resolved Hide resolved
src/pages/signin/SignInPage.tsx Outdated Show resolved Hide resolved
src/pages/signin/SignInPage.tsx Outdated Show resolved Hide resolved
@fedirjh fedirjh requested a review from s77rt February 11, 2024 18:56
src/pages/signin/UnlinkLoginForm.tsx Outdated Show resolved Hide resolved
src/pages/signin/UnlinkLoginForm.tsx Outdated Show resolved Hide resolved
Copy link
Contributor

@blazejkustra blazejkustra left a comment

Choose a reason for hiding this comment

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

Huge effort! Looks good typescript-wise 😄

@fedirjh fedirjh requested a review from s77rt February 12, 2024 15:50
@s77rt
Copy link
Contributor

s77rt commented Feb 12, 2024

Code looks good! Will test this asap!

@s77rt
Copy link
Contributor

s77rt commented Feb 13, 2024

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: mWeb Chrome
    • iOS: Native
    • iOS: mWeb 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(theme.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 the PR modifies a component or page that can be accessed by a direct deeplink, I verified that the code functions as expected when the deeplink is used - from a logged in and logged out account.
  • If the PR modifies the form input styles:
    • I verified that all the inputs inside a form are aligned with each other.
    • I added Design label so the design team can review the changes.
  • 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

Android: Native
android.mov
Android: mWeb Chrome
mweb-chrome.mov
iOS: Native
ios.mov
iOS: mWeb Safari
mweb-safari.mov
MacOS: Chrome / Safari
web.mov
MacOS: Desktop desktop

Copy link

melvin-bot bot commented Feb 13, 2024

We did not find an internal engineer to review this PR, trying to assign a random engineer to #25224 as well as to this PR... Please reach out for help on Slack if no one gets assigned!

@s77rt
Copy link
Contributor

s77rt commented Feb 13, 2024

cc @puneetlath

@puneetlath puneetlath self-requested a review February 13, 2024 20:55
@puneetlath
Copy link
Contributor

Is this waiting on me to review? Weird that I didn't get assigned.

In any case, looks like there are a bunch of conflicts. @fedirjh can you address them and then I'll review.

# Conflicts:
#	src/pages/signin/LoginForm/BaseLoginForm.tsx
#	src/pages/signin/SignInHeroImage.js
#	src/pages/signin/SignInPage.tsx
#	src/pages/signin/SignInPageLayout/BackgroundImage/index.ios.js
#	src/pages/signin/SignInPageLayout/Footer.tsx
#	src/pages/signin/SignInPageLayout/SignInPageContent.tsx
#	src/pages/signin/SignInPageLayout/index.tsx
#	src/types/onyx/Form.ts
@fedirjh
Copy link
Contributor Author

fedirjh commented Feb 14, 2024

@puneetlath @s77rt Merged main and resolved all the conflicts. Ready for review.

@puneetlath puneetlath merged commit 0b5446b into Expensify:main Feb 14, 2024
15 checks passed
@puneetlath
Copy link
Contributor

Good job, but man that was a big PR 😅. Any way we could break this sort of thing up more in the future?

@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/puneetlath in version: 1.4.42-0 🚀

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

@OSBotify
Copy link
Contributor

🚀 Deployed to production by https://github.com/chiragsalian in version: 1.4.42-5 🚀

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

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.

5 participants