[TS migration] Migrate 'SelectCircle.js' component to TypeScript #30077

MaciejSWM · 2023-10-20T13:07:37Z

Details

Fixed Issues

$ #25015
PROPOSAL:

Tests

Verify that no errors appear in the JS console
In styles.ts find selectCircle and change it's background color to something bright: backgroundColor: 'red',
Hit 'New' ->Start Chat, click Add to group for a couple of users. You should see the SelectCircle component working correctly, and having a red background:

Offline tests

Same as QA Steps

QA Steps

Verify that no errors appear in the JS console
Hit 'New', Start Chat, click Add to group for a couple of users. You should see the SelectCircle component working correctly.
Click on the SelectCircle component. It should deselect the selection.

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

Screen.Recording.2023-10-20.at.15.32.18.mov

Android: mWeb Chrome

Screen.Recording.2023-10-20.at.15.33.28.mov

iOS: Native

Screen.Recording.2023-10-20.at.15.13.06.mov

iOS: mWeb Safari

Screen.Recording.2023-10-20.at.15.14.24.mov

MacOS: Chrome / Safari

Screen.Recording.2023-10-20.at.15.34.59.mov

MacOS: Desktop

Screen.Recording.2023-10-20.at.15.35.40.mov

blazejkustra · 2023-10-23T16:24:27Z

src/components/SelectCircle.tsx

+        </View>
+    );
+}
+


We should always define displayName:

Suggested change

SelectCircle.displayName = 'SelectCircle';

blazejkustra · 2023-10-23T16:26:25Z

src/components/SelectCircle.tsx

+    isChecked: boolean;
+
+    /** Additional styles to pass to SelectCircle */
+    styles: Array<Record<string, unknown>>;


Please use more accurate type here, ViewStyle[]?

OR let's do it the same as in this PR

MaciejSWM · 2023-10-23T19:32:54Z

src/components/SelectCircle.tsx

+
+function SelectCircle({isChecked = false, styles = []}: SelectCircleProps) {
+    return (
+        <View style={[globalStyles.selectCircle, globalStyles.alignSelfCenter, styles]}>


Typescript made me get rid of the spread operator (...styles -> styles) after I switched from an Array<> to StyleProp<>. But the weird thing is that it still works when styles are passed like they used to be: <SelectCircle isChecked={props.isSelected} styles={[styles.singleOptionSelectorCircle]} />

If it works, that's fine with me. Please test that the styles are displayed correctly.

Yes, works just fine

Should we check that styles isn't null?

fabioh8010

@MaciejSWM I think we should update the PR title to [TS migration] Migrate 'SelectCircle.js' component to TypeScript, in order to QA team to test it.

src/components/SelectCircle.tsx

Co-authored-by: Fábio Henriques <fabio.lacerda@outlook.com>

…re-mansion-labs/expensify-app-fork into ts-migration/SelectCircle

fabioh8010

LGTM

melvin-bot · 2023-10-27T12:24:27Z

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

cubuspl42 · 2023-11-03T09:30:38Z

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 / Chrome
- iOS / native
- iOS / 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

Web

select-circle-web.mp4

Mobile Web - Chrome

select-circle-android-web-compressed.mp4

Mobile Web - Safari

select-circle-ios-web.mp4

Desktop

iOS

select-circle-ios.mp4

Android

select-circle-android-compressed.mp4

melvin-bot · 2023-11-03T09:30:56Z

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

cead22 · 2023-11-03T22:02:15Z

src/components/SelectCircle.tsx

+    isChecked: boolean;
+
+    /** Additional styles to pass to SelectCircle */
+    styles?: StyleProp<ViewStyle>;


Is there no way to define a default for this prop like []?

It is possible, we can default it to []. cc @MaciejSWM

Hey @cead22. Thanks for spotting this. It turns out that no action is needed, as RN+TS still work well when styles are undefined. Please see this:
https://github.com/Expensify/App/pull/29988/files#r1373207252
Especially the first example that passes no styles to FullScreenLoadingIndicator: https://github.com/Expensify/App/pull/29988/files#r1374544242

cead22 · 2023-11-03T22:02:40Z

src/components/SelectCircle.tsx

+
+function SelectCircle({isChecked = false, styles = []}: SelectCircleProps) {
+    return (
+        <View style={[globalStyles.selectCircle, globalStyles.alignSelfCenter, styles]}>


Should we check that styles isn't null?

OSBotify · 2023-11-06T18:23:03Z

✋ 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-06T22:30:16Z

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

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

kavimuru · 2023-11-06T22:33:35Z

@MaciejSWM Could you please share the QA steps. We need help with the following steps in "Tests" section.

In styles.ts find selectCircle and change it's background color to something bright: backgroundColor: 'red',
Hit Start Chat, click Add to group for a couple of users. You should see the SelectCircle component working correctly, and having a red background:

MaciejSWM · 2023-11-07T09:33:01Z

I updated the QA section @kavimuru. It will be enough just to test if the SelectCircle component works correctly in the app, no need to change the background color as it was just to highlight more easily that you're looking at the correct component.

OSBotify · 2023-11-09T22:47:49Z

🚀 Deployed to production by https://github.com/puneetlath in version: 1.3.96-15 🚀

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

OSBotify · 2023-11-10T15:44:24Z

🚀 Deployed to production by https://github.com/puneetlath in version: 1.3.97-7 🚀

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

MaciejSWM added 2 commits October 20, 2023 14:57

Migrate to TS

56172e9

Restore default values

dcb7386

blazejkustra suggested changes Oct 23, 2023

View reviewed changes

Use StyleProp

0b620d0

MaciejSWM commented Oct 23, 2023

View reviewed changes

blazejkustra approved these changes Oct 24, 2023

View reviewed changes

fabioh8010 reviewed Oct 25, 2023

View reviewed changes

src/components/SelectCircle.tsx Outdated Show resolved Hide resolved

MaciejSWM changed the title ~~[No QA][TS migration] Migrate SelectCircle~~ [TS migration] Migrate 'SelectCircle.js' component to TypeScript Oct 25, 2023

Make styles optional

f8b0614

Co-authored-by: Fábio Henriques <fabio.lacerda@outlook.com>

MaciejSWM requested a review from fabioh8010 October 25, 2023 19:31

MaciejSWM added 3 commits October 25, 2023 21:48

Optional styles

8196502

Merge branch 'ts-migration/SelectCircle' of https://github.com/softwa…

d64538a

…re-mansion-labs/expensify-app-fork into ts-migration/SelectCircle

Drop default value - undefined works too

fd36698

fabioh8010 approved these changes Oct 26, 2023

View reviewed changes

MaciejSWM marked this pull request as ready for review October 27, 2023 12:24

MaciejSWM requested a review from a team as a code owner October 27, 2023 12:24

melvin-bot bot requested review from cubuspl42 and removed request for a team October 27, 2023 12:24

MaciejSWM added 2 commits October 31, 2023 19:12

Merge branch 'main' into ts-migration/SelectCircle

ba7baf6

Reorder imports - eslint

6535cea

cubuspl42 approved these changes Nov 3, 2023

View reviewed changes

melvin-bot bot requested a review from cead22 November 3, 2023 09:31

cead22 approved these changes Nov 3, 2023

View reviewed changes

cead22 merged commit 1c1fb1d into Expensify:main Nov 6, 2023
19 checks passed

OSBotify mentioned this pull request Nov 6, 2023

Deploy Checklist: New Expensify 2023-11-06 #30929

Closed

OSBotify mentioned this pull request Nov 8, 2023

Deploy Checklist: New Expensify 2023-11-08 #31077

Closed

cubuspl42 mentioned this pull request Nov 27, 2023

[TS migration] Migrate 'SelectCircle.js' component to TypeScript #25015

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[TS migration] Migrate 'SelectCircle.js' component to TypeScript #30077

[TS migration] Migrate 'SelectCircle.js' component to TypeScript #30077

MaciejSWM commented Oct 20, 2023 •

edited

Loading

blazejkustra Oct 23, 2023

blazejkustra Oct 23, 2023

blazejkustra Oct 23, 2023

MaciejSWM Oct 23, 2023

blazejkustra Oct 24, 2023

MaciejSWM Oct 25, 2023

cead22 Nov 3, 2023

blazejkustra Nov 6, 2023 •

edited

Loading

fabioh8010 left a comment

fabioh8010 left a comment

melvin-bot bot commented Oct 27, 2023

cubuspl42 commented Nov 3, 2023

melvin-bot bot commented Nov 3, 2023

cead22 Nov 3, 2023

blazejkustra Nov 6, 2023

MaciejSWM Nov 6, 2023

cead22 Nov 3, 2023

OSBotify commented Nov 6, 2023

OSBotify commented Nov 6, 2023

kavimuru commented Nov 6, 2023

MaciejSWM commented Nov 7, 2023

OSBotify commented Nov 9, 2023

OSBotify commented Nov 10, 2023

[TS migration] Migrate 'SelectCircle.js' component to TypeScript #30077

[TS migration] Migrate 'SelectCircle.js' component to TypeScript #30077

Conversation

MaciejSWM commented Oct 20, 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

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

blazejkustra Nov 6, 2023 • edited Loading

Choose a reason for hiding this comment

fabioh8010 left a comment

Choose a reason for hiding this comment

fabioh8010 left a comment

Choose a reason for hiding this comment

melvin-bot bot commented Oct 27, 2023

cubuspl42 commented Nov 3, 2023

Reviewer Checklist

Screenshots/Videos

melvin-bot bot commented Nov 3, 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

OSBotify commented Nov 6, 2023

OSBotify commented Nov 6, 2023

kavimuru commented Nov 6, 2023

MaciejSWM commented Nov 7, 2023

OSBotify commented Nov 9, 2023

OSBotify commented Nov 10, 2023

MaciejSWM commented Oct 20, 2023 •

edited

Loading

blazejkustra Nov 6, 2023 •

edited

Loading