[TS migration] Migrate 'ValidateCodeForm' component to TypeScript by JKobrynski · Pull Request #35404 · Expensify/App

JKobrynski · 2024-01-30T14:26:08Z

Details

Fixed Issues

$ #31978
PROPOSAL: N/A

Tests

Make sure you are logged out of the app
Start logging into the app
Stop on the magic code step and make sure it works properly (paste, delete, change focused digit etc.)

Verify that no errors appear in the JS console

Offline tests

N/A

QA Steps

Same as Tests section above

Verify that no errors appear in the JS console

PR Author Checklist

Screenshots/Videos

Android: Native

android-compressed.webm

Android: mWeb Chrome

chrome-compressed.webm

iOS: Native

ios-compressed.mp4

iOS: mWeb Safari

safari-compressed.mp4

MacOS: Chrome / Safari

web-compresseed.mov

MacOS: Desktop

desktop-compressed.mov

melvin-bot · 2024-02-06T12:38:54Z

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

s77rt · 2024-02-06T17:47:55Z

+type WithToggleVisibilityViewProps = {
    /** Whether the content is visible. */
-    isVisible: boolean;
+    isVisible?: boolean;


Any reason this is made optional?

Yes, it's used in BaseValidateCodeForm.tsx and if not optional, it will cause type errors in ValidateCodeForm/ as the component expects isVisible prop which actually comes from a HOC.

BaseValidateCodeForm expects isVisible to have type boolean since we always set it in withToggleVisibilityView

ValidateCodeForm expects isVisible to have type boolean | undefined

So I think we should revert the change here to make the prop required and modify ValidateCodeFormProps to make it accept an optional isVisible prop.

We pass isVisible to ValidateCodeForm in SignInPage

App/src/pages/signin/SignInPage.js

Line 282 in a839310

isVisible={!shouldShowAnotherLoginPageOpenedMessage}

JKobrynski · 2024-02-07T11:17:28Z

@s77rt I updated the PR, thanks for your comments!

s77rt · 2024-02-09T12:57:02Z

@JKobrynski Did you get a chance to check #35404 (comment)?

fabioh8010 · 2024-02-13T09:20:36Z

FYI @JKobrynski is OOO from Feb 12th to Feb 16th.

s77rt · 2024-02-13T18:50:34Z

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-1.mov

MacOS: Desktop

desktop.mov

JKobrynski · 2024-02-20T13:22:33Z

@s77rt PR updated!

s77rt

Forgot to submit those two non-blockers comments

s77rt · 2024-02-08T08:50:47Z

    const timerRef = useRef<NodeJS.Timeout>();

-    const hasError = Boolean(account) && !isEmptyObject(account?.errors) && !needToClearError;
+    const hasError = !isEmptyObject(account) && !isEmptyObject(account?.errors) && !needToClearError;


Suggested change

const hasError = !isEmptyObject(account) && !isEmptyObject(account?.errors) && !needToClearError;

const hasError = !!account && !isEmptyObject(account.errors) && !needToClearError;

NAB. Truthy check is enough as we. have the empty object check on errors

s77rt · 2024-02-08T08:54:24Z

    return (
        <View style={[styles.changeExpensifyLoginLinkContainer, styles.mt3]}>
-            {!isEmptyObject(credentials?.login) && <Text style={styles.mr1}>{translate('loginForm.notYou', {user: formatPhoneNumber(credentials?.login)})}</Text>}
+            {!!credentials?.login && <Text style={styles.mr1}>{translate('loginForm.notYou', {user: credentials?.login ? formatPhoneNumber(credentials.login) : ''})}</Text>}


Suggested change

{!!credentials?.login && <Text style={styles.mr1}>{translate('loginForm.notYou', {user: credentials?.login ? formatPhoneNumber(credentials.login) : ''})}</Text>}

{!!credentials?.login && <Text style={styles.mr1}>{translate('loginForm.notYou', {user: formatPhoneNumber(credentials.login)})}</Text>}

credentials.login is guaranteed to be a string at this point

s77rt · 2024-02-20T17:19:56Z

Can you also check the failing typescript tests (one is related to this PR. for the other try merge main)

JKobrynski · 2024-02-21T07:23:02Z

@s77rt updated!

melvin-bot · 2024-02-21T07:28:36Z

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

s77rt · 2024-02-21T07:30:56Z

cc @tylerkaraszewski

OSBotify · 2024-02-26T21:05:23Z

🚀 Deployed to staging by https://github.com/tylerkaraszewski in version: 1.4.44-0 🚀

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

OSBotify · 2024-02-28T23:53:59Z

🚀 Deployed to production by https://github.com/puneetlath in version: 1.4.44-13 🚀

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

JKobrynski added 3 commits January 30, 2024 15:11

migrate BaseValidateCodeForm to TypeScript

e47f246

migrate ValidateCodeForm to TypeScript

32e8322

improve code structure

be04e4f

VickyStash reviewed Jan 30, 2024

View reviewed changes

JKobrynski added 2 commits January 31, 2024 08:13

apply suggested changes

9cd4355

apply suggested changes

97d9c2e

JKobrynski requested a review from VickyStash January 31, 2024 07:58

fabioh8010 reviewed Jan 31, 2024

View reviewed changes

Comment thread src/pages/signin/ChangeExpensifyLoginLink.tsx Resolved

Comment thread src/pages/signin/ValidateCodeForm/BaseValidateCodeForm.tsx Resolved

Comment thread src/pages/signin/ValidateCodeForm/BaseValidateCodeForm.tsx Resolved

Merge branch 'main' into migrateValidateCodeFormToTypeScript

e1ff833

JKobrynski requested a review from fabioh8010 February 1, 2024 11:47

apply suggested changes

4b77282

fabioh8010 approved these changes Feb 1, 2024

View reviewed changes

blazejkustra approved these changes Feb 6, 2024

View reviewed changes

JKobrynski marked this pull request as ready for review February 6, 2024 12:38

JKobrynski requested a review from a team as a code owner February 6, 2024 12:38

melvin-bot Bot removed request for a team and VickyStash February 6, 2024 12:38

melvin-bot Bot requested a review from s77rt February 6, 2024 12:38

JKobrynski mentioned this pull request Feb 6, 2024

[TS migration] Migrate 'ValidateCodeForm' component to TypeScript #31978

Closed

s77rt suggested changes Feb 6, 2024

View reviewed changes

JKobrynski added 8 commits February 7, 2024 08:59

Merge branch 'main' into migrateValidateCodeFormToTypeScript

1c037dd

remove undefined type from formatPhoneNumber

ee28929

remove isEmptyObject from ChangeExpensifyLoginLink

3d04daf

simplify needToClearError type

4fc41f4

remove null from ref types

d55e22d

replace Boolean() with isEmptyObject()

f728ff0

remove unnecessary isEmptyObject check

be5d1ed

modify setFormError call for consistency

d662f32

JKobrynski requested a review from s77rt February 7, 2024 11:17

Merge branch 'main' into migrateValidateCodeFormToTypeScript

fa9a187

s77rt mentioned this pull request Feb 9, 2024

[TS migration] Migrate Signin to TypeScript #35294

Merged

51 tasks done

Merge branch 'main' into migrateValidateCodeFormToTypeScript

ffc805f

JKobrynski added 2 commits February 20, 2024 13:55

Merge branch 'main' into migrateValidateCodeFormToTypeScript

d62923e

apply suggested changes

334f02b

s77rt suggested changes Feb 20, 2024

View reviewed changes

JKobrynski added 4 commits February 21, 2024 07:57

Merge branch 'main' into migrateValidateCodeFormToTypeScript

c632fd2

apply suggested changes

d3fc423

remove unused @ts-expect-error from ChoseSSOOrMagicCode

3011c3e

fix type error in RoomMembersPage

ac477ea

JKobrynski requested a review from s77rt February 21, 2024 07:23

s77rt approved these changes Feb 21, 2024

View reviewed changes

tylerkaraszewski approved these changes Feb 21, 2024

View reviewed changes

tylerkaraszewski merged commit 330621f into Expensify:main Feb 21, 2024

github-actions Bot mentioned this pull request Feb 26, 2024

Deploy Checklist: New Expensify 2024-02-26 #37224

Closed

	const hasError = !isEmptyObject(account) && !isEmptyObject(account?.errors) && !needToClearError;
	const hasError = !!account && !isEmptyObject(account.errors) && !needToClearError;

	{!!credentials?.login && <Text style={styles.mr1}>{translate('loginForm.notYou', {user: credentials?.login ? formatPhoneNumber(credentials.login) : ''})}</Text>}
	{!!credentials?.login && <Text style={styles.mr1}>{translate('loginForm.notYou', {user: formatPhoneNumber(credentials.login)})}</Text>}

Conversation

JKobrynski commented Jan 30, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

melvin-bot Bot commented Feb 6, 2024

Uh oh!

Uh oh!

Uh oh!

s77rt Feb 6, 2024

Choose a reason for hiding this comment

Uh oh!

JKobrynski Feb 7, 2024

Choose a reason for hiding this comment

Uh oh!

s77rt Feb 7, 2024

Choose a reason for hiding this comment

Uh oh!

JKobrynski Feb 20, 2024

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

JKobrynski commented Feb 7, 2024

Uh oh!

s77rt commented Feb 9, 2024

Uh oh!

fabioh8010 commented Feb 13, 2024

Uh oh!

s77rt commented Feb 13, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Reviewer Checklist

Screenshots/Videos

Uh oh!

JKobrynski commented Feb 20, 2024

Uh oh!

s77rt left a comment

Choose a reason for hiding this comment

Uh oh!

s77rt Feb 8, 2024

Choose a reason for hiding this comment

Uh oh!

s77rt Feb 8, 2024

Choose a reason for hiding this comment

Uh oh!

s77rt commented Feb 20, 2024

Uh oh!

JKobrynski commented Feb 21, 2024

Uh oh!

melvin-bot Bot commented Feb 21, 2024

Uh oh!

s77rt commented Feb 21, 2024

Uh oh!

OSBotify commented Feb 26, 2024

Uh oh!

OSBotify commented Feb 28, 2024

Uh oh!

Reviewers

Uh oh!

Assignees

JKobrynski commented Jan 30, 2024 •

edited

Loading

s77rt commented Feb 13, 2024 •

edited

Loading