[TS migration] Migrate 'ValidateLogin' page to TypeScript #33839

pac-guerreiro · 2024-01-02T15:28:37Z

Details

Fixed Issues

$#25189
PROPOSAL: N/A

Tests

On web, navigate to https://dev.new.expensify.com:8082/v/1/222222
The first modal you should be seeing is the ValidateCodeModal. Otherwise, run window.Onyx.merge("session", {autoAuthState: "not-started"}); on the browser console. Confirm if everything is rendered correctly.
To see ExpiredValidateCodeModal, run window.Onyx.merge("session", {autoAuthState: "failed"}); on the browser console. Confirm if everything is rendered correctly.
To see JustSignedInModal, run window.Onyx.merge("session", {autoAuthState: "just-signed-in"}); on the browser console. Confirm if everything is rendered correctly.

Offline tests

N/A

QA Steps

On web, navigate to https://staging.new.expensify.com/v/1/222222
The modal you should be seeing is the ValidateCodeModal.

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

MacOS: Chrome / Safari

ValidateCodeModal

ExpiredValidateCodeModal

JustSignedInModal

src/libs/Navigation/Navigation.ts

src/pages/ValidateLoginPage/index.website.tsx

pasyukevich · 2024-01-03T10:13:26Z

The lint step is failing - prettier diff

…-to-typescript

pac-guerreiro · 2024-01-03T16:30:18Z

@pasyukevich @VickyStash @kubabutkiewicz all feedback addressed!

VickyStash

LGTM

blazejkustra · 2024-01-08T07:39:39Z

src/pages/ValidateLoginPage/index.tsx

+    session: OnyxEntry<SessionType>;
+};
+
+type ValidateLoginPageProps = ValidateLoginPageOnyxProps & StackScreenProps<AuthScreensParamList, typeof SCREENS.VALIDATE_LOGIN>;


ValidateLoginPage has platform specific implementations, create types.ts file with a shared type

blazejkustra · 2024-01-08T07:40:41Z

src/pages/ValidateLoginPage/index.tsx

+ValidateLoginPage.displayName = 'ValidateLoginPage';
+
+export default withOnyx<ValidateLoginPageProps, ValidateLoginPageOnyxProps>({
+    session: {key: ONYXKEYS.SESSION},


Credentials were removed, please test the component carefully on native

@blazejkustra Credentials was not being used

And honestly I don't know how to test this component on the native side because it seems this page is only used on web 🤷

…-to-typescript

blazejkustra · 2024-01-10T12:43:06Z

@pac-guerreiro Typecheck is failing 🤔

…-to-typescript

pac-guerreiro · 2024-01-11T18:08:34Z

@blazejkustra Resolved! 😄

melvin-bot · 2024-01-12T18:04:07Z

@rlinoz 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]

situchan · 2024-01-14T18:46:03Z

Seems like no C+ is assigned here. I can review and checklist if needed.

rlinoz · 2024-01-15T14:26:10Z

Thanks for offering @situchan

src/pages/ValidateLoginPage/index.website.tsx

situchan · 2024-01-17T10:56:28Z

src/pages/ValidateLoginPage/index.website.tsx

+    account,
+    credentials,
+    route: {
+        params: {accountID, validateCode},


please make sure that route.params always exists

@situchan It's expected to be defined every time the component is mounted 😄

situchan · 2024-01-24T12:09:21Z

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: mWeb Chrome

iOS: Native

iOS: mWeb Safari

MacOS: Chrome / Safari

Screen.Recording.2024-01-24.at.6.29.57.PM.mov

MacOS: Desktop

situchan · 2024-01-24T12:11:03Z

@pasyukevich please merge main (for safety) when you get a chance.

melvin-bot · 2024-01-24T12:34:15Z

🎯 @situchan, thanks for reviewing and testing this PR! 🎉

An E/App issue has been created to issue payment here: #35051.

situchan · 2024-01-24T12:35:06Z

@pac-guerreiro you wrote QA Steps same as Tests but I am not sure QA team will follow that. They're not developers and don't know ValidateCodeModal, ExpiredValidateCodeModal, JustSignedInModal

rlinoz · 2024-01-25T15:29:57Z

I agree with @situchan here @pac-guerreiro, it would be really nice to get the real steps to get this pages to show up, do you think we can do that?

pac-guerreiro · 2024-01-26T15:04:21Z

@situchan @rlinoz

Sorry, I forgot to write clear instructions for QA 😞

Sadly, QA team won't be able to test all the modals because it's not easy to replicate the states without directly manipulating the data (which it's not possible in staging and production).

I'll just write which page in staging you'll need to access in order to test this work. You can also check the visual representation of the modals by taking a look at the screenshots section of this PR 😄

OSBotify · 2024-01-29T12:22:14Z

✋ 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 · 2024-01-29T19:23:45Z

🚀 Deployed to staging by https://github.com/rlinoz in version: 1.4.33-0 🚀

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

OSBotify · 2024-01-31T02:30:36Z

🚀 Deployed to production by https://github.com/francoisl in version: 1.4.33-5 🚀

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

refactor(typescript): migrate validateloginpage

e5cd46f

kubabutkiewicz reviewed Jan 2, 2024

View reviewed changes

src/libs/Navigation/Navigation.ts Outdated Show resolved Hide resolved

VickyStash reviewed Jan 3, 2024

View reviewed changes

src/pages/ValidateLoginPage/index.website.tsx Outdated Show resolved Hide resolved

src/pages/ValidateLoginPage/index.website.tsx Outdated Show resolved Hide resolved

pac-guerreiro added 2 commits January 3, 2024 16:00

chore: apply pull request feedback

14f8bb5

Merge branch 'main' into pac-guerreiro/refactor/migrate-validatelogin…

e53425b

…-to-typescript

VickyStash approved these changes Jan 4, 2024

View reviewed changes

kubabutkiewicz approved these changes Jan 4, 2024

View reviewed changes

blazejkustra suggested changes Jan 8, 2024

View reviewed changes

pac-guerreiro added 2 commits January 9, 2024 15:23

Merge branch 'main' into pac-guerreiro/refactor/migrate-validatelogin…

1e9d72e

…-to-typescript

refactor(typescript): extract types to avoid repetition

670a3e1

pac-guerreiro added 2 commits January 11, 2024 17:38

Merge branch 'main' into pac-guerreiro/refactor/migrate-validatelogin…

9719184

…-to-typescript

chore(typescript): fix wrong prop types

51a21e5

blazejkustra approved these changes Jan 12, 2024

View reviewed changes

pac-guerreiro marked this pull request as ready for review January 12, 2024 18:03

pac-guerreiro requested a review from a team as a code owner January 12, 2024 18:03

melvin-bot bot removed the request for review from a team January 12, 2024 18:04

melvin-bot bot requested a review from rlinoz January 12, 2024 18:04

rlinoz requested a review from situchan January 15, 2024 14:25

situchan reviewed Jan 16, 2024

View reviewed changes

src/pages/ValidateLoginPage/index.website.tsx Outdated Show resolved Hide resolved

refactor(typescript): apply pull request feedback

2d65ac5

situchan reviewed Jan 17, 2024

View reviewed changes

situchan approved these changes Jan 24, 2024

View reviewed changes

melvin-bot bot mentioned this pull request Jan 24, 2024

[HOLD for Payment 2/5] Payment issue for E/App PR#33839 #35051

Closed

rlinoz approved these changes Jan 25, 2024

View reviewed changes

rlinoz merged commit d45ef12 into Expensify:main Jan 29, 2024
18 of 21 checks passed

github-actions bot mentioned this pull request Jan 29, 2024

Deploy Checklist: New Expensify 2024-01-29 #35328

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[TS migration] Migrate 'ValidateLogin' page to TypeScript #33839

[TS migration] Migrate 'ValidateLogin' page to TypeScript #33839

pac-guerreiro commented Jan 2, 2024 •

edited

Loading

pasyukevich commented Jan 3, 2024

pac-guerreiro commented Jan 3, 2024

VickyStash left a comment

blazejkustra Jan 8, 2024

pac-guerreiro Jan 9, 2024

blazejkustra Jan 8, 2024

pac-guerreiro Jan 9, 2024

pac-guerreiro Jan 9, 2024

blazejkustra commented Jan 10, 2024

pac-guerreiro commented Jan 11, 2024

melvin-bot bot commented Jan 12, 2024

situchan commented Jan 14, 2024

rlinoz commented Jan 15, 2024

situchan Jan 17, 2024

pac-guerreiro Jan 17, 2024

situchan commented Jan 24, 2024 •

edited

Loading

situchan commented Jan 24, 2024

melvin-bot bot commented Jan 24, 2024

situchan commented Jan 24, 2024 •

edited

Loading

rlinoz commented Jan 25, 2024

pac-guerreiro commented Jan 26, 2024

OSBotify commented Jan 29, 2024

OSBotify commented Jan 29, 2024

OSBotify commented Jan 31, 2024

[TS migration] Migrate 'ValidateLogin' page to TypeScript #33839

[TS migration] Migrate 'ValidateLogin' page to TypeScript #33839

Conversation

pac-guerreiro commented Jan 2, 2024 • edited Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

pasyukevich commented Jan 3, 2024

pac-guerreiro commented Jan 3, 2024

VickyStash left a comment

Choose a reason for hiding this comment

blazejkustra Jan 8, 2024

Choose a reason for hiding this comment

pac-guerreiro Jan 9, 2024

Choose a reason for hiding this comment

blazejkustra Jan 8, 2024

Choose a reason for hiding this comment

pac-guerreiro Jan 9, 2024

Choose a reason for hiding this comment

pac-guerreiro Jan 9, 2024

Choose a reason for hiding this comment

blazejkustra commented Jan 10, 2024

pac-guerreiro commented Jan 11, 2024

melvin-bot bot commented Jan 12, 2024

situchan commented Jan 14, 2024

rlinoz commented Jan 15, 2024

situchan Jan 17, 2024

Choose a reason for hiding this comment

pac-guerreiro Jan 17, 2024

Choose a reason for hiding this comment

situchan commented Jan 24, 2024 • edited Loading

Reviewer Checklist

Screenshots/Videos

situchan commented Jan 24, 2024

melvin-bot bot commented Jan 24, 2024

situchan commented Jan 24, 2024 • edited Loading

rlinoz commented Jan 25, 2024

pac-guerreiro commented Jan 26, 2024

OSBotify commented Jan 29, 2024

OSBotify commented Jan 29, 2024

OSBotify commented Jan 31, 2024

pac-guerreiro commented Jan 2, 2024 •

edited

Loading

situchan commented Jan 24, 2024 •

edited

Loading

situchan commented Jan 24, 2024 •

edited

Loading