[TS migration] Migrate 'Section.js' component to TypeScript #33645

blazejkustra · 2023-12-27T16:04:22Z

Details

Migration of Section to Typescript + Fixes this console warning.

Fixed Issues

$ #25024
PROPOSAL: N/A

Tests

Open any workspace -> click on Reimbursements, Settings, Cards, Bills, Members, Travel etc
Check that individual sections are displayed as before and make sure interactions work as expected (clicking, clicking and holding. etc)

Offline tests

N/A

QA Steps

Same as tests

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

Android: mWeb Chrome

android-web.webm

iOS: Native

ios.mp4

iOS: mWeb Safari

ios-web.mp4

MacOS: Chrome / Safari

web.mov

MacOS: Desktop

desktop.mov

src/components/MenuItemList.tsx

VickyStash · 2023-12-27T16:34:25Z

src/components/MenuItemList.tsx

+                        {...menuItemProps}
+                        disabled={menuItemProps.disabled ?? isExecuting}
+                        onPress={shouldUseSingleExecution ? singleExecution(onPress) : onPress}
+                        interactive


@blazejkustra Please see this discussion we had internally regarding interactive, what do you think?

I agree, changed the implementation in this PR.

src/components/Section/index.tsx

src/components/MenuItemList.tsx

VickyStash · 2023-12-27T16:41:21Z

src/components/MenuItemList.tsx

+    return (
+        <>
+            {menuItems.map((menuItemProps) => {
+                const onPress = menuItemProps.onPress ?? (() => {});


Maybe it makes sense to update MenuItem typing instead of adding default onPress value, but I'm not sure about it

I added it because singleExecution wasn't erroring that way, now it should be fine!

VickyStash

LGTM!

melvin-bot · 2023-12-27T17:21:59Z

@aimane-chnaif 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]

blazejkustra · 2023-12-29T20:59:07Z

@aimane-chnaif Done 👌

aimane-chnaif · 2023-12-29T21:00:05Z

reviewing

aimane-chnaif · 2023-12-29T21:24:54Z

src/components/MenuItem.tsx

-type ResponsiveProps = {
-    /** Function to fire when component is pressed */
-    onPress: (event: GestureResponderEvent | KeyboardEvent) => void;
-
-    interactive?: true;
-};
-
-type UnresponsiveProps = {
-    onPress?: undefined;
-
-    /** Whether the menu item should be interactive at all */
-    interactive: false;
-};


Any reason for this removal? This automatically enabled interactive when onPress is defined

Yes, please have a look at this discussion

aimane-chnaif · 2023-12-29T22:01:44Z

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

mchrome.mov

iOS: Native

ios.mov

iOS: mWeb Safari

msafari.mov

MacOS: Chrome / Safari

web.mov

MacOS: Desktop

desktop.mov

blazejkustra · 2024-01-03T11:29:26Z

@aimane-chnaif Kind bump, this is blocking several other TS issues. I would appreciate a reviewer checklist on this one, thank you 😄

aimane-chnaif · 2024-01-03T11:30:29Z

will complete review today

blazejkustra · 2024-01-04T09:06:31Z

@aimane-chnaif Merged the newest main for you 👍

aimane-chnaif · 2024-01-06T01:25:40Z

Got this warning on workspaces list page. Also happening on main so OOS

mountiny

Couple NABs! Thank you for completing this

mountiny · 2024-01-07T19:24:18Z

src/components/Section/IconSection.tsx

+            {!!icon && (
+                <Icon
+                    src={icon}
+                    height={68}


Are there any style consts for this?

mountiny · 2024-01-07T19:25:32Z

src/components/Section/index.tsx

+import type IconAsset from '@src/types/utils/IconAsset';
+import IconSection from './IconSection';
+
+const CARD_LAYOUT = {


Wondering if we should rename this to SECTION_CARD_LAYOUT to make it clearer when imported

OSBotify · 2024-01-07T19:30:44Z

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

blimpich · 2024-01-08T19:29:25Z

The predeploy.yml Github action seems to be consistently failing since this PR got merged. Do we think any of the changes here could have caused this?

OSBotify · 2024-01-09T05:37:18Z

🚀 Deployed to staging by https://github.com/mountiny in version: 1.4.23-0 🚀

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

OSBotify · 2024-01-10T06:04:33Z

🚀 Deployed to production by https://github.com/thienlnam in version: 1.4.23-4 🚀

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

[TS migration] Migrate 'Section.js' component to TypeScript

9072dbc

VickyStash reviewed Dec 27, 2023

View reviewed changes

blazejkustra added 2 commits December 27, 2023 18:07

Adjust MenuItem and MenuItemList

fe57401

Fix package.json

2a50e51

VickyStash approved these changes Dec 27, 2023

View reviewed changes

blazejkustra marked this pull request as ready for review December 27, 2023 17:21

blazejkustra requested a review from a team as a code owner December 27, 2023 17:21

melvin-bot bot requested review from aimane-chnaif and removed request for a team December 27, 2023 17:21

blazejkustra mentioned this pull request Dec 27, 2023

[Wave8] Create a Workspace Card #32339

Merged

45 tasks

filip-solecki approved these changes Dec 28, 2023

View reviewed changes

blazejkustra added 2 commits December 29, 2023 21:57

Merge branch 'main' into ts/Section

15f4ed5

Merge branch 'main' into ts/Section

b90b5da

aimane-chnaif reviewed Dec 29, 2023

View reviewed changes

blazejkustra added 3 commits January 2, 2024 11:58

Merge branch 'main' into ts/Section

9974e38

Rerun checks

60e0c99

Merge branch 'main' into ts/Section

0c8274a

blazejkustra added 3 commits January 4, 2024 09:41

Merge branch 'main' into ts/Section

63a7d25

Fix typecheck

4cebe6a

Fix type imports

09a65e6

Merge branch 'main' into ts/Section

56a99fa

blazejkustra requested a review from aimane-chnaif January 5, 2024 17:11

aimane-chnaif approved these changes Jan 6, 2024

View reviewed changes

melvin-bot bot requested a review from mountiny January 6, 2024 01:47

mountiny approved these changes Jan 7, 2024

View reviewed changes

mountiny merged commit d067f4b into Expensify:main Jan 7, 2024
17 checks passed

blimpich mentioned this pull request Jan 8, 2024

[HOLD for payment 2024-01-31] predeploy.yml Github Action is broken in main #34108

Closed

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

Deploy Checklist: New Expensify 2024-01-09 #34121

Closed

87 tasks

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

[HOLD for payment 2024-01-17] [TS migration] Migrate 'Section.js' component to TypeScript #25024

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[TS migration] Migrate 'Section.js' component to TypeScript #33645

[TS migration] Migrate 'Section.js' component to TypeScript #33645

blazejkustra commented Dec 27, 2023 •

edited

Loading

VickyStash Dec 27, 2023

blazejkustra Dec 27, 2023

VickyStash Dec 27, 2023

blazejkustra Dec 27, 2023

VickyStash left a comment

melvin-bot bot commented Dec 27, 2023

blazejkustra commented Dec 29, 2023

aimane-chnaif commented Dec 29, 2023

aimane-chnaif Dec 29, 2023

blazejkustra Dec 29, 2023

aimane-chnaif commented Dec 29, 2023 •

edited

Loading

blazejkustra commented Jan 3, 2024

aimane-chnaif commented Jan 3, 2024

blazejkustra commented Jan 4, 2024

aimane-chnaif commented Jan 6, 2024

mountiny left a comment

mountiny Jan 7, 2024

mountiny Jan 7, 2024

OSBotify commented Jan 7, 2024

blimpich commented Jan 8, 2024

OSBotify commented Jan 9, 2024

OSBotify commented Jan 10, 2024

[TS migration] Migrate 'Section.js' component to TypeScript #33645

[TS migration] Migrate 'Section.js' component to TypeScript #33645

Conversation

blazejkustra commented Dec 27, 2023 • edited Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

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 27, 2023

blazejkustra commented Dec 29, 2023

aimane-chnaif commented Dec 29, 2023

Choose a reason for hiding this comment

Choose a reason for hiding this comment

aimane-chnaif commented Dec 29, 2023 • edited Loading

Reviewer Checklist

Screenshots/Videos

blazejkustra commented Jan 3, 2024

aimane-chnaif commented Jan 3, 2024

blazejkustra commented Jan 4, 2024

aimane-chnaif commented Jan 6, 2024

mountiny left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

OSBotify commented Jan 7, 2024

blimpich commented Jan 8, 2024

OSBotify commented Jan 9, 2024

OSBotify commented Jan 10, 2024

blazejkustra commented Dec 27, 2023 •

edited

Loading

aimane-chnaif commented Dec 29, 2023 •

edited

Loading