[TS migration] Migrate TabSelector components to typescript #33084

SzymczakJ · 2023-12-14T16:42:24Z

Details

Migration of 'TabSelector' to Typescript.

Fixed Issues

$ #25089
PROPOSAL: N/A

Tests

Verify that TabSelector component works properly in testing requesting money flow(changing request money options from distance request to manual request etc.).
Test main flows of the app(sending messages, logging, requesting money).

Offline tests

N/A

QA Steps

Verify that TabSelector component works properly in testing requesting money flow(changing request money options from distance request to manual request etc.). Also test main flows of the app(sending messages, logging, requesting money).

PR Author Checklist

Screenshots/Videos

Android: Native

android.mov

Android: mWeb Chrome

https://github.com/Expensify/App/assets/88395093/dbb680e5-320d-436f-818a-73d94e37f5e5

iOS: Native

ios.mov

iOS: mWeb Safari

iosweb.mov

MacOS: Chrome / Safari

web.mov

MacOS: Desktop

desktop.mov

blazejkustra

LGTM!

VickyStash · 2023-12-18T11:30:09Z

src/components/TabSelector/TabSelector.tsx

-};
-
-const getIconAndTitle = (route, translate) => {
+function getIconAndTitle(route: string, translate: LocaleContextProps['translate']): {icon: FunctionComponent<SvgProps>; title: string} {


Let's create a separate type for return type {icon: FunctionComponent<SvgProps>; title: string}

VickyStash · 2023-12-18T11:32:47Z

src/components/TabSelector/TabSelector.tsx

-                        navigation.navigate({name: route.name, merge: true});
+                        navigation.navigate({key: route.key, merge: true});


Could you clarify why this was changed?

The previous usage wasn't interpreted by typescript properly, I would have to use
navigation.navigate({name: route.name, merge: true, params: {}); because params is not optional in navigate function arguments. Thats why I switched to navigation.navigate({key: route.key, merge: true}); usage, because it does the same thing, but has optional params argument.

VickyStash

LGTM

melvin-bot · 2023-12-18T12:51:45Z

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

SzymczakJ · 2023-12-20T11:02:24Z

Hi @alitoshmatov, could you please review this PR? 😁

alitoshmatov · 2023-12-20T11:03:13Z

Working on it

alitoshmatov · 2023-12-20T16:12:09Z

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(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 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 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

tabs-android.mov

Android: mWeb Chrome

tabs-mweb.mov

iOS: Native

iOS: mWeb Safari

tabs-safari.mp4

MacOS: Chrome / Safari

tabs-web.mov

MacOS: Desktop

tabs-desktop.mov

alitoshmatov

LGTM

melvin-bot · 2023-12-20T16:18:35Z

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

cead22 · 2023-12-20T16:38:30Z

I got assigned the issue so I can review this

cead22 · 2023-12-20T16:43:27Z

src/components/TabSelector/TabLabel.tsx

    /** Title of the tab */
-    title: PropTypes.string,
+    title?: string;

    /** Animated opacity value while the label is inactive state */


Suggested change

/** Animated opacity value while the label is inactive state */

/** Animated opacity value while the label is in inactive state */

cead22 · 2023-12-20T16:43:39Z

src/components/TabSelector/TabIcon.tsx

+    /** Icon to display on tab */
+    icon?: (props: SrcProps) => React.ReactNode;
+
+    /** Animated opacity value while the label is inactive state */


Suggested change

/** Animated opacity value while the label is inactive state */

/** Animated opacity value while the icon is in inactive state */

cead22 · 2023-12-20T16:44:14Z

src/components/TabSelector/TabIcon.tsx

+    /** Animated opacity value while the label is inactive state */
+    inactiveOpacity?: number | Animated.AnimatedInterpolation<number>;
+
+    /** Animated opacity value while the label is in active state */


Suggested change

/** Animated opacity value while the label is in active state */

/** Animated opacity value while the icon is in active state */

cead22 · 2023-12-20T16:48:06Z

src/components/TabSelector/TabSelectorItem.tsx


    /** Animated background color value for the tab button */
-    // eslint-disable-next-line
-    backgroundColor: PropTypes.any,
+    backgroundColor?: string | Animated.AnimatedInterpolation<string>;

    /** Animated opacity value while the label is inactive state */


Suggested change

/** Animated opacity value while the label is inactive state */

/** Animated opacity value while the tab is in inactive state */

cead22 · 2023-12-20T16:48:13Z

src/components/TabSelector/TabSelectorItem.tsx


    /** Animated opacity value while the label is inactive state */
-    // eslint-disable-next-line
-    inactiveOpacity: PropTypes.any,
+    inactiveOpacity?: number | Animated.AnimatedInterpolation<number>;

    /** Animated opacity value while the label is in active state */


Suggested change

/** Animated opacity value while the label is in active state */

/** Animated opacity value while the tab is in active state */

cead22 · 2023-12-20T16:49:01Z

src/components/TabSelector/TabSelectorItem.tsx


    /** Whether this tab is active */
-    isFocused: PropTypes.bool,
+    isFocused?: boolean;


Should we call this isActive instead, since the comment says "Whether this tab is active", and the comments I'm suggesting changes on also use "active" and not "focused"?

Suggested change

isFocused?: boolean;

isActive?: boolean;

SzymczakJ · 2023-12-20T17:12:42Z

@cead22 fixed the comments the way you requested 😃

cead22 · 2023-12-20T17:16:01Z

@VickyStash @blazejkustra @alitoshmatov can one of you give this another look just in case I missed something. Thanks!

cead22 · 2023-12-21T15:52:51Z

Anyone?

alitoshmatov · 2023-12-21T16:30:50Z

Working on it

alitoshmatov · 2023-12-21T19:37:15Z

Everything looks good and working well

Screen.Recording.2023-12-21.at.21.37.53.mov

Simulator.Screen.Recording.-.iPhone.15.Plus.-.2023-12-21.at.21.38.46.mp4

cead22 · 2023-12-22T16:26:56Z

Thank you!

OSBotify · 2023-12-22T16:31:19Z

✋ 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 · 2023-12-26T00:37:45Z

🚀 Deployed to staging by https://github.com/cead22 in version: 1.4.17-0 🚀

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

OSBotify · 2023-12-27T16:10:48Z

🚀 Deployed to production by https://github.com/mountiny in version: 1.4.17-8 🚀

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

blazejkustra · 2023-12-27T16:36:50Z

@VickyStash @blazejkustra @alitoshmatov can one of you give this another look just in case I missed something. Thanks!

Sorry, I was OOO. Thanks for quick merge!

migrate TabSelector components to typescript

2dca05b

blazejkustra approved these changes Dec 14, 2023

View reviewed changes

SzymczakJ added 2 commits December 15, 2023 12:36

Merge branch 'main' into @szymczak/25089

2213e8b

Merge branch 'main' into @szymczak/25089

db28c84

VickyStash reviewed Dec 18, 2023

View reviewed changes

fix pr comments

e3dfe18

SzymczakJ requested a review from VickyStash December 18, 2023 12:14

VickyStash approved these changes Dec 18, 2023

View reviewed changes

SzymczakJ marked this pull request as ready for review December 18, 2023 12:51

SzymczakJ requested a review from a team as a code owner December 18, 2023 12:51

melvin-bot bot requested review from alitoshmatov and removed request for a team December 18, 2023 12:51

Merge branch 'main' into @szymczak/25089

920efa8

alitoshmatov approved these changes Dec 20, 2023

View reviewed changes

cead22 requested changes Dec 20, 2023

View reviewed changes

fix pr comments

dbfb60a

SzymczakJ requested a review from cead22 December 20, 2023 17:12

cead22 approved these changes Dec 20, 2023

View reviewed changes

cead22 merged commit 6a55d16 into Expensify:main Dec 22, 2023
15 checks passed

github-actions bot mentioned this pull request Dec 26, 2023

Deploy Checklist: New Expensify 2023-12-26 #33576

Closed

42 tasks

melvin-bot bot mentioned this pull request Dec 27, 2023

[HOLD for payment 2024-01-03] [TS migration] Migrate 'TabSelector' component to TypeScript #25089

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[TS migration] Migrate TabSelector components to typescript #33084

[TS migration] Migrate TabSelector components to typescript #33084

SzymczakJ commented Dec 14, 2023 •

edited

Loading

blazejkustra left a comment

VickyStash Dec 18, 2023

VickyStash Dec 18, 2023

SzymczakJ Dec 18, 2023

VickyStash left a comment

melvin-bot bot commented Dec 18, 2023

SzymczakJ commented Dec 20, 2023

alitoshmatov commented Dec 20, 2023

alitoshmatov commented Dec 20, 2023

alitoshmatov left a comment

melvin-bot bot commented Dec 20, 2023

cead22 commented Dec 20, 2023

cead22 Dec 20, 2023

cead22 Dec 20, 2023

cead22 Dec 20, 2023

cead22 Dec 20, 2023

cead22 Dec 20, 2023

cead22 Dec 20, 2023

SzymczakJ commented Dec 20, 2023

cead22 commented Dec 20, 2023

cead22 commented Dec 21, 2023

alitoshmatov commented Dec 21, 2023

alitoshmatov commented Dec 21, 2023

cead22 commented Dec 22, 2023

OSBotify commented Dec 22, 2023

OSBotify commented Dec 26, 2023

OSBotify commented Dec 27, 2023

blazejkustra commented Dec 27, 2023

		navigation.navigate({name: route.name, merge: true});
		navigation.navigate({key: route.key, merge: true});

	/** Animated opacity value while the label is inactive state */
	/** Animated opacity value while the label is in inactive state */

	/** Animated opacity value while the label is inactive state */
	/** Animated opacity value while the icon is in inactive state */

	/** Animated opacity value while the label is inactive state */
	/** Animated opacity value while the tab is in inactive state */

[TS migration] Migrate TabSelector components to typescript #33084

[TS migration] Migrate TabSelector components to typescript #33084

Conversation

SzymczakJ commented Dec 14, 2023 • edited Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

blazejkustra left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

VickyStash left a comment

Choose a reason for hiding this comment

melvin-bot bot commented Dec 18, 2023

SzymczakJ commented Dec 20, 2023

alitoshmatov commented Dec 20, 2023

alitoshmatov commented Dec 20, 2023

Reviewer Checklist

Screenshots/Videos

alitoshmatov left a comment

Choose a reason for hiding this comment

melvin-bot bot commented Dec 20, 2023

cead22 commented Dec 20, 2023

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

SzymczakJ commented Dec 20, 2023

cead22 commented Dec 20, 2023

cead22 commented Dec 21, 2023

alitoshmatov commented Dec 21, 2023

alitoshmatov commented Dec 21, 2023

cead22 commented Dec 22, 2023

OSBotify commented Dec 22, 2023

OSBotify commented Dec 26, 2023

OSBotify commented Dec 27, 2023

blazejkustra commented Dec 27, 2023

SzymczakJ commented Dec 14, 2023 •

edited

Loading