[TS Migration] Migrate Icon to TypeScript by JKobrynski · Pull Request #30579 · Expensify/App

JKobrynski · 2023-10-30T13:50:54Z

Details

Fixed Issues

$ #25157
PROPOSAL: N/A

Tests

Log into the app
Look at icons in the RHP and make sure they look fine

Verify that no errors appear in the JS console

Offline tests

N/A

QA Steps

Same as Tests steps above

Verify that no errors appear in the JS console

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 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
- If we are not using the full Onyx data that we loaded, I've added the proper selector in order to ensure the component only re-renders when the data it is using changes
- 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 author checklist, including those that don't apply to this PR.

Screenshots/Videos

Android: Native

iOS: Native

iOS: mWeb Safari

MacOS: Chrome / Safari

MacOS: Desktop

blazejkustra · 2023-11-02T15:10:38Z

Aad types.ts file with a common type for these files.

blazejkustra · 2023-11-02T15:12:19Z

            </G>
            <G>
                <Path
+                    // @ts-expect-error - react-native-web property


Can you try to augment the react-native-svg type? src/types/modules/

Great idea! I pushed a solution, let me know what you think 😄

blazejkustra · 2023-11-02T15:14:20Z

Try to add some QA steps! FYI tests are failing

blazejkustra · 2023-11-03T10:39:52Z

+    interface SvgProps extends BaseSvgProps {
+        xmlns?: string;
+        xmlnsXlink?: string;
+        xmlSpace?: string;
+        style?: StyleProp<SvgStyle>;
+        hovered?: string;
+        pressed?: string;


Why all these props are needed?

For some reason, when I augmented react-native-svg it started complaining about these values and them being undefined. If you remove the style prop, it starts showing errors related to these values, even without augmentation. I know it's weird. Do you have any ideas for possible causes?

blazejkustra · 2023-11-03T10:40:39Z

+
+declare module 'react-native-svg' {
+    // eslint-disable-next-line @typescript-eslint/consistent-type-definitions
+    interface SvgStyle extends ViewStyle {


Should SvgStyle extend ViewStyle?

It wasn't totally accurate, I modified it a bit

JKobrynski · 2023-11-06T08:51:38Z

@blazejkustra applied some changes, also fixed unit tests 😄

melvin-bot · 2023-11-08T08:19:29Z

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

roryabraham · 2023-11-08T15:19:01Z

Assigned to @akinwale for C+ review

akinwale · 2023-11-08T16:28:31Z

@JKobrynski Minor nitpick, the icons are in the RHP, not the LHN. Could you please update your test steps?

akinwale · 2023-11-08T16:39:18Z

TypeScript Checks task is failing. Please fix.

JKobrynski · 2023-11-09T09:24:48Z

@akinwale description updated, typechecks fixed!

akinwale · 2023-11-10T02:26:03Z

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

Android: mWeb Chrome

iOS: Native

iOS: mWeb Safari

MacOS: Chrome / Safari

MacOS: Desktop

akinwale

LGTM.

melvin-bot · 2023-11-10T05:11:47Z

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

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

roryabraham · 2023-11-10T17:57:59Z

-Icon.propTypes = propTypes;
-Icon.defaultProps = defaultProps;
-
 export default Icon;


Missing displayName property

OSBotify · 2023-11-10T18:03:59Z

✋ 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-11-14T22:11:37Z

🚀 Deployed to staging by https://github.com/roryabraham in version: 1.3.99-0 🚀

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

OSBotify · 2023-11-15T20:54:52Z

🚀 Deployed to production by https://github.com/roryabraham in version: 1.3.99-0 🚀

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

OSBotify · 2023-11-15T21:10:27Z

🚀 Deployed to staging by https://github.com/roryabraham in version: 1.4.0-0 🚀

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

JKobrynski added 3 commits October 30, 2023 09:57

migrate files that export images to TypeScript

5039d56

migrate Icon and LoungeAccessIcon to TypeScript

af9823a

migrate Expensicons.js to TypeScript

a6f68b6

JKobrynski changed the title ~~Migrate icon to type script~~ [TS Migration] Migrate Icon to TypeScript Oct 31, 2023

Merge branch 'main' into migrateIconToTypeScript

6855dc5

pasyukevich reviewed Oct 31, 2023

View reviewed changes

Comment thread src/components/Icon/index.tsx Outdated

Comment thread src/components/Icon/index.tsx Outdated

kubabutkiewicz reviewed Oct 31, 2023

View reviewed changes

Comment thread src/components/Icon/index.tsx Outdated

kubabutkiewicz reviewed Oct 31, 2023

View reviewed changes

Comment thread src/components/Icon/index.tsx

kubabutkiewicz reviewed Oct 31, 2023

View reviewed changes

Comment thread src/components/Icon/svgs/LoungeAccessIcon.tsx Outdated

kubabutkiewicz reviewed Oct 31, 2023

View reviewed changes

Comment thread src/components/Icon/svgs/LoungeAccessIcon.tsx

minor changes

babfb96

JKobrynski requested review from kubabutkiewicz and pasyukevich October 31, 2023 16:07

improve Icon types, fix linting

eb6648f

blazejkustra suggested changes Nov 2, 2023

View reviewed changes

JKobrynski added 2 commits November 3, 2023 11:22

create common types file for IconWrapperStyles

4df669d

augment react-native-svg types to include web properties

e67fb8e

blazejkustra suggested changes Nov 3, 2023

View reviewed changes

JKobrynski added 2 commits November 3, 2023 13:01

add missing props to LoungeAccessIcon

9bedad8

modify augmented types

002bfc5

JKobrynski requested a review from blazejkustra November 3, 2023 12:35

JKobrynski added 3 commits November 3, 2023 13:43

fix tests

236a415

fix jest mock

da1441a

apply another fix to jest mock

3849581

BartoszGrajdek reviewed Nov 6, 2023

View reviewed changes

Comment thread src/components/Icon/svgs/LoungeAccessIcon.tsx Outdated

Comment thread src/components/Icon/svgs/LoungeAccessIcon.tsx Outdated

remove redundant default props from LoungeAccessIcon

80fcf73

JKobrynski requested a review from BartoszGrajdek November 7, 2023 09:40

BartoszGrajdek reviewed Nov 7, 2023

View reviewed changes

Comment thread src/components/Icon/__mocks__/Expensicons.ts

JKobrynski requested a review from BartoszGrajdek November 7, 2023 13:04

BartoszGrajdek approved these changes Nov 7, 2023

View reviewed changes

JKobrynski marked this pull request as ready for review November 8, 2023 08:19

JKobrynski requested a review from a team as a code owner November 8, 2023 08:19

melvin-bot Bot removed request for a team, blazejkustra, kubabutkiewicz and pasyukevich November 8, 2023 08:19

JKobrynski mentioned this pull request Nov 8, 2023

[$250] [HOLD for payment 2023-12-13] [TS migration] Migrate 'Icon' component to TypeScript #25157

Closed

roryabraham requested a review from akinwale November 8, 2023 15:18

JKobrynski added 3 commits November 9, 2023 09:43

Merge branch 'main' into migrateIconToTypeScript

edbf015

Merge branch 'main' into migrateIconToTypeScript

b0be474

fix type error

0d05be8

akinwale approved these changes Nov 10, 2023

View reviewed changes

melvin-bot Bot mentioned this pull request Nov 10, 2023

Payment issue for E/App PR#30579 #31168

Closed

roryabraham approved these changes Nov 10, 2023

View reviewed changes

roryabraham merged commit da1dda3 into Expensify:main Nov 10, 2023

OSBotify mentioned this pull request Nov 14, 2023

Deploy Checklist: New Expensify 2023-11-14 #31324

Closed

OSBotify mentioned this pull request Nov 15, 2023

Deploy Checklist: New Expensify 2023-11-15 #31404

Closed

37 tasks

Conversation

JKobrynski commented Oct 30, 2023 • 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!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

blazejkustra commented Nov 2, 2023

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

JKobrynski commented Nov 6, 2023

Uh oh!

Uh oh!

Uh oh!

Uh oh!

melvin-bot Bot commented Nov 8, 2023

Uh oh!

roryabraham commented Nov 8, 2023

Uh oh!

akinwale commented Nov 8, 2023

Uh oh!

akinwale commented Nov 8, 2023

Uh oh!

JKobrynski commented Nov 9, 2023

Uh oh!

akinwale commented Nov 10, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Reviewer Checklist

Screenshots/Videos

Uh oh!

akinwale left a comment

Choose a reason for hiding this comment

Uh oh!

melvin-bot Bot commented Nov 10, 2023

Uh oh!

Choose a reason for hiding this comment

Uh oh!

OSBotify commented Nov 10, 2023

Uh oh!

OSBotify commented Nov 14, 2023

Uh oh!

OSBotify commented Nov 15, 2023

Uh oh!

OSBotify commented Nov 15, 2023

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

8 participants

JKobrynski commented Oct 30, 2023 •

edited

Loading

akinwale commented Nov 10, 2023 •

edited

Loading