[TS migration] Migrate MenuItem to Typescript #31141

MaciejSWM · 2023-11-09T16:30:40Z

Details

This is quite a delicate migration - 50 props used in all of the places across the app - the MenuItem is used in all the screens in the RIght Hand Panel and some of the screens in the Global Nav screens. Please test those screens.

Fixed Issues

$ #25144
PROPOSAL:

Tests

Verify that no errors appear in the JS console
Add a background color on the outer element of MenuItem for easier testing.
Go through all the possible screens and make any possible actions with the items in Right Hand Panel (Settings).
Do the same with the Global Nav screens - some of them (like Request Money -> Distance) also use MenuItem.

Offline tests

Not affected directly by Offline mode

QA Steps

Verify that no errors appear in the JS console
Go through all the possible screens and make any possible actions with the items in Right Hand Panel (Settings).
Do the same with the Global Nav screens - some of them (like Request Money -> Distance) also use MenuItem.

PR Author Checklist

Screenshots/Videos

Android: Native

Screen.Recording.2023-12-19.at.15.18.51.mov

Android: mWeb Chrome

Screen.Recording.2023-12-19.at.15.18.51.mov

iOS: Native

Screen.Recording.2023-12-19.at.14.34.01.mov

iOS: mWeb Safari

Screen.Recording.2023-12-19.at.14.35.16.mov

MacOS: Chrome / Safari

Screen.Recording.2023-12-19.at.14.31.31.mov

MacOS: Desktop

Screen.Recording.2023-12-19.at.14.32.03.mov

melvin-bot · 2023-12-19T10:04:11Z

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

MaciejSWM · 2023-12-19T10:08:45Z

@shubham1206agra please wait a little bit, I forgot to record videos. Unless this is not blocking you

shubham1206agra · 2023-12-19T13:29:46Z

@MaciejSWM Please ping here whenever you have completed the videos

MaciejSWM · 2023-12-19T14:19:55Z

@shubham1206agra ready

shubham1206agra · 2023-12-19T14:37:28Z

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

Screen.Recording.2023-12-19.at.6.53.52.PM.mov

iOS: mWeb Safari

Screen.Recording.2023-12-19.at.6.32.51.PM.mp4

MacOS: Chrome / Safari

Screen.Recording.2023-12-19.at.6.25.33.PM.mp4

MacOS: Desktop

Screen.Recording.2023-12-19.at.6.44.32.PM.mp4

melvin-bot · 2023-12-19T14:37:46Z

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

OSBotify · 2023-12-19T17:28:13Z

✋ This PR was not deployed to staging yet because QA is ongoing. It will be automatically deployed to staging after the next production release.

blazejkustra · 2023-12-19T17:47:20Z

Thank you @deetergp!

OSBotify · 2023-12-21T05:30:23Z

🚀 Deployed to staging by https://github.com/deetergp in version: 1.4.15-0 🚀

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

pac-guerreiro · 2023-12-21T13:36:55Z

@deetergp @blazejkustra @kubabutkiewicz @fabioh8010

I'm getting typescript errors of missing props while using MenuItemWithTopDescription. It seems to me that some props that were optional previously became required, like hoverAndPressStyle.

shubham1206agra · 2023-12-21T20:03:36Z

@pac-guerreiro Can you mark other props that also became required by mistake?

OSBotify · 2023-12-22T05:19:06Z

🚀 Deployed to production by https://github.com/jasperhuangg in version: 1.4.15-5 🚀

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

pac-guerreiro · 2023-12-22T15:22:51Z

@shubham1206agra You can check the props that need to be optional here -> https://github.com/Expensify/App/pull/33242/files#diff-9db0c2baf85f38b9a238d03f1089a686039ab6c6b94ef412bda920293909b7a4

When the above PR is merged, these issues will be fixed!

shubham1206agra · 2024-02-21T16:42:11Z

src/components/MenuItem.tsx

+                                    />
+                                )}
+                                {/* Since subtitle can be of type number, we should allow 0 to be shown */}
+                                {(subtitle ?? subtitle === 0) && (


This line created a regression when subtitle is 0. More details #35358

MaciejSWM added 30 commits November 9, 2023 17:29

Props types for MenuItem

271d86c

Destructure props

8dba84c

Make the component a function declaration

12ec1ed

Type onPress

49d35b1

Validate style props

0cedba9

Prop types -> Typescript props

b6e0925

Prop types -> Typescript props

9676e34

Prop types -> Typescript props

87db8e2

Prop types -> Typescript props

3683fcb

Merge branch 'main' into ts-migration/MenuItem

11654e7

Get rid of too many union types

8802892

Typing

f74f3c3

Merge branch 'main' into ts-migration/MenuItem

7e5d64d

Merge branch 'main' into ts-migration/MenuItem

e8593ab

Post-merge type adjustments

9858112

Adjust style typing

ebdbc9f

Use titleStyle and delete duplicated style

e12a6c5

Migrate to TS

1ed677c

Discriminative union for icon types

bbe82dc

Fix pressable types - drop invalid Children props

e5d8ea7

Merge branch 'main' into ts-migration/MenuItem

9208c95

Migrate MenuItemWithTopDescription to TS

cbca351

Restore menuItemPropTypes

29c23d1

Fix isDeleted handling

8f33445

Fix onPress TS

66fd830

Fix icon types

8c4690f

Drop unused import

88ad038

Merge branch 'main' into ts-migration/MenuItem

1ef5d7f

Eslint

560d65e

Map children in inline mode

7db8be2

MaciejSWM added 2 commits December 18, 2023 16:22

Split type imports

bd2b0c9

Use safe operator

9de6f8b

MaciejSWM requested a review from kubabutkiewicz December 18, 2023 15:24

kubabutkiewicz approved these changes Dec 19, 2023

View reviewed changes

MaciejSWM marked this pull request as ready for review December 19, 2023 10:04

MaciejSWM requested a review from a team as a code owner December 19, 2023 10:04

melvin-bot bot requested review from shubham1206agra and removed request for a team December 19, 2023 10:04

shubham1206agra approved these changes Dec 19, 2023

View reviewed changes

melvin-bot bot requested a review from deetergp December 19, 2023 14:37

blazejkustra mentioned this pull request Dec 19, 2023

[NoQA] [Wave8] Workspace List Items #32817

Merged

48 tasks

deetergp approved these changes Dec 19, 2023

View reviewed changes

deetergp merged commit 9857874 into Expensify:main Dec 19, 2023

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

Deploy Checklist: New Expensify 2023-12-21 #33391

Closed

51 tasks

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

[HOLD for payment 2023-12-29] [TS migration] Migrate 'MenuItem' component to TypeScript #25144

Closed

shubham1206agra reviewed Feb 21, 2024

View reviewed changes

shubham1206agra mentioned this pull request Feb 21, 2024

[HOLD for payment 2024-02-20] [$500] 0 member is formatted weirdly when leaving a room and revisiting room details #35358

Closed

6 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[TS migration] Migrate MenuItem to Typescript #31141

[TS migration] Migrate MenuItem to Typescript #31141

MaciejSWM commented Nov 9, 2023 •

edited

Loading

melvin-bot bot commented Dec 19, 2023

MaciejSWM commented Dec 19, 2023

shubham1206agra commented Dec 19, 2023

MaciejSWM commented Dec 19, 2023

shubham1206agra commented Dec 19, 2023

melvin-bot bot commented Dec 19, 2023

OSBotify commented Dec 19, 2023

blazejkustra commented Dec 19, 2023

OSBotify commented Dec 21, 2023

pac-guerreiro commented Dec 21, 2023

shubham1206agra commented Dec 21, 2023

OSBotify commented Dec 22, 2023

pac-guerreiro commented Dec 22, 2023

shubham1206agra Feb 21, 2024

[TS migration] Migrate MenuItem to Typescript #31141

[TS migration] Migrate MenuItem to Typescript #31141

Conversation

MaciejSWM commented Nov 9, 2023 • edited Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

melvin-bot bot commented Dec 19, 2023

MaciejSWM commented Dec 19, 2023

shubham1206agra commented Dec 19, 2023

MaciejSWM commented Dec 19, 2023

shubham1206agra commented Dec 19, 2023

Reviewer Checklist

Screenshots/Videos

melvin-bot bot commented Dec 19, 2023

OSBotify commented Dec 19, 2023

blazejkustra commented Dec 19, 2023

OSBotify commented Dec 21, 2023

pac-guerreiro commented Dec 21, 2023

shubham1206agra commented Dec 21, 2023

OSBotify commented Dec 22, 2023

pac-guerreiro commented Dec 22, 2023

shubham1206agra Feb 21, 2024

Choose a reason for hiding this comment

MaciejSWM commented Nov 9, 2023 •

edited

Loading