[TS migration] Migrate RadioButton to Typescript #31050

MaciejSWM · 2023-11-08T09:03:53Z

Details

RadioButton component is marked on the screenshot below. It's those colourful radio buttons that can be toggled on and off.

Fixed Issues

$ #25025
PROPOSAL:

Tests

I don't know how to reach this component with the normal app flow so I suggest doing the following:
Assign a sample question to walletAdditionalDetails.questions in AdditionalDetailsStep.js:

function AdditionalDetailsStep({walletAdditionalDetails, translate, currentUserPersonalDetails}) {
    // Add questions:
    walletAdditionalDetails.questions = [{"answer":["1251","6253","113","None of the above","Skip Question"],"prompt":"Which number goes with your address on MASONIC AVE?","type":"street.number.b"}];

Replace any of the existing menuItems in FloatingActionButtonAndPopover.js with the following:

{
    icon: Expensicons.MoneyCircle,
    text: 'Send enable payments',
    onSelected: () => interceptAnonymousUser(() => Navigation.navigate(ROUTES.IOU_SEND_ENABLE_PAYMENTS)),
},

This will let you hit New Chat -> Send enable payments and you will reach the screen presented in the screenshot above.
Check and uncheck a couple of radio buttons to validate if RadioButton component works after migration.

Offline tests

Same as Tests

QA Steps

Create a new account
Navigate to https://staging.new.expensify.com/send/new/enable-payments
Go through the enable payments steps until you reach this screen

4. Make sure that the radio buttons can be clicked on and off 5. Navigate to the next page and make sure everything works as expected

PR Author Checklist

Screenshots/Videos

Android: Native

Screen.Recording.2023-11-08.at.14.40.00.mov

Android: mWeb Chrome

Screen.Recording.2023-11-08.at.13.04.28.mov

iOS: Native

Screen.Recording.2023-11-08.at.13.16.43.mov

iOS: mWeb Safari

Screen.Recording.2023-11-08.at.13.04.28.mov

MacOS: Chrome / Safari

Screen.Recording.2023-11-08.at.12.44.32.mov

MacOS: Desktop

Screen.Recording.2023-11-08.at.12.57.31.mov

fabioh8010 · 2023-11-13T08:10:41Z

src/components/RadioButton.tsx

-};
-
-function RadioButton(props) {
+function RadioButton({isChecked, onPress = () => undefined, accessibilityLabel, disabled = false, hasError = false}: RadioButtonProps) {


Suggested change

function RadioButton({isChecked, onPress = () => undefined, accessibilityLabel, disabled = false, hasError = false}: RadioButtonProps) {

function RadioButton({isChecked, onPress, accessibilityLabel, disabled = false, hasError = false}: RadioButtonProps) {

I think we don't need to assign a default value to onPress

fabioh8010 · 2023-11-13T08:11:21Z

src/components/RadioButton.tsx

@@ -54,8 +48,4 @@ function RadioButton(props) {
    );
 }

-RadioButton.propTypes = propTypes;
-RadioButton.defaultProps = defaultProps;
-RadioButton.displayName = 'RadioButton';


Please keep the displayName.

RadioButton.displayName = 'RadioButton';

kubabutkiewicz

Please resolve conflicts and @fabioh8010 commnets

MaciejSWM · 2023-11-20T18:56:23Z

@kubabutkiewicz everything resolved now

melvin-bot · 2023-11-21T08:53:00Z

@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-23T11:33:35Z

src/components/RadioButton.tsx

-};
-
-function RadioButton(props) {
+function RadioButton({isChecked, onPress, accessibilityLabel, disabled = false, hasError = false}: RadioButtonProps) {


Nit: Unnecessary reordering of properties compared to the type declaration (hasError could be before disabled).

Makes sense!

cubuspl42 · 2023-11-23T11:35:55Z

I left one comment, a nit-pick; otherwise, things look great (it's a short file). I'll fill the checklist when I can, which might be tomorrow (I'm in limited capacity mode this week, sorry!).

MaciejSWM · 2023-11-24T12:33:21Z

Thx @cubuspl42. Props reordered. Ready when you are.

cubuspl42 · 2023-11-27T09:52:28Z

"Reassure Performance Tests" check is failing. Would you check if merging main fixes it?

I'm filling the "PR Reviewer Checklist" right now. Sorry for the delay.

cubuspl42 · 2023-11-27T09:58:28Z

Hm, we're not far behind main, though

cubuspl42 · 2023-11-27T10:18:35Z

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

ts-migration-RadioButton-web.mp4

Mobile Web - Chrome

ts-migration-RadioButton-android-web-compressed.mp4

Mobile Web - Safari

ts-migration-RadioButton-ios-web.mp4

Desktop

iOS

ts-migration-RadioButton-ios.mp4

Android

ts-migration-RadioButton-android-compressed.mp4

melvin-bot · 2023-11-27T10:19:09Z

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

cubuspl42 · 2023-11-27T10:20:48Z

@stitesExpensify

Looking at the code, this is a proper TypeScript migration with minimal chances of introducing a regression. I followed the suggested test steps, and the component works fine. I also don't know the "genuine" way to reach this component.

MaciejSWM · 2023-11-27T10:48:07Z

Fresh merge fixed that failing perf test @cubuspl42

stitesExpensify

LGTM

stitesExpensify · 2023-11-27T17:37:15Z

Updated QA steps. Applause should be able to get to that page with sandbox credentials

OSBotify · 2023-11-27T17:37:25Z

✋ 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-27T19:22:40Z

🚀 Deployed to staging by https://github.com/stitesExpensify in version: 1.4.4-0 🚀

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

OSBotify · 2023-11-29T11:45:16Z

🚀 Deployed to production by https://github.com/mountiny in version: 1.4.4-3 🚀

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

MaciejSWM added 7 commits October 20, 2023 16:05

WIP TS migration

15e8258

Optional props

d9e6d23

Drop propTypes and defaultProps

46eb799

Merge branch 'main' into ts-migration/RadioButton

c7c5cf1

Missing semicolon

6324a61

onPress should be optional

46f1132

Merge branch 'main' into ts-migration/RadioButton

873e587

blazejkustra approved these changes Nov 10, 2023

View reviewed changes

fabioh8010 reviewed Nov 13, 2023

View reviewed changes

kubabutkiewicz approved these changes Nov 20, 2023

View reviewed changes

kubabutkiewicz suggested changes Nov 20, 2023

View reviewed changes

MaciejSWM added 3 commits November 20, 2023 19:32

Merge branch 'main' into ts-migration/RadioButton

66284aa

Make onPress required

838f2e2

Restore displayName

c2f7796

MaciejSWM requested a review from fabioh8010 November 20, 2023 19:04

fabioh8010 approved these changes Nov 21, 2023

View reviewed changes

kubabutkiewicz approved these changes Nov 21, 2023

View reviewed changes

MaciejSWM marked this pull request as ready for review November 21, 2023 08:52

MaciejSWM requested a review from a team as a code owner November 21, 2023 08:52

melvin-bot bot requested review from cubuspl42 and removed request for a team November 21, 2023 08:52

cubuspl42 reviewed Nov 23, 2023

View reviewed changes

MaciejSWM added 2 commits November 24, 2023 13:31

Merge branch 'main' into ts-migration/RadioButton

6d1a971

Reorder props

56a4841

cubuspl42 approved these changes Nov 27, 2023

View reviewed changes

melvin-bot bot requested a review from stitesExpensify November 27, 2023 10:19

Merge branch 'main' into ts-migration/RadioButton

56f326a

stitesExpensify approved these changes Nov 27, 2023

View reviewed changes

stitesExpensify merged commit 60aa8a9 into Expensify:main Nov 27, 2023
15 checks passed

github-actions bot mentioned this pull request Nov 27, 2023

Deploy Checklist: New Expensify 2023-11-27 #32066

Closed

53 tasks

kbecciv mentioned this pull request Nov 28, 2023

Web - Wallet - Cannot proceed with add bank account flow #32082

Closed

6 tasks

MaciejSWM deleted the ts-migration/RadioButton branch November 28, 2023 09:43

kbecciv mentioned this pull request Nov 28, 2023

[$500] Wallet - Radio buttons in questionnaire page have a different design #32119

Closed

6 tasks

melvin-bot bot mentioned this pull request Nov 29, 2023

[HOLD for payment 2023-12-06] [$500] [TS migration] Migrate 'RadioButton.js' component to TypeScript #25025

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[TS migration] Migrate RadioButton to Typescript #31050

[TS migration] Migrate RadioButton to Typescript #31050

MaciejSWM commented Nov 8, 2023 •

edited by stitesExpensify

Loading

fabioh8010 Nov 13, 2023

fabioh8010 Nov 13, 2023

kubabutkiewicz left a comment

MaciejSWM commented Nov 20, 2023

melvin-bot bot commented Nov 21, 2023

cubuspl42 Nov 23, 2023

MaciejSWM Nov 24, 2023

cubuspl42 commented Nov 23, 2023

MaciejSWM commented Nov 24, 2023

cubuspl42 commented Nov 27, 2023

cubuspl42 commented Nov 27, 2023

cubuspl42 commented Nov 27, 2023

melvin-bot bot commented Nov 27, 2023

cubuspl42 commented Nov 27, 2023

MaciejSWM commented Nov 27, 2023

stitesExpensify left a comment

stitesExpensify commented Nov 27, 2023

OSBotify commented Nov 27, 2023

OSBotify commented Nov 27, 2023

OSBotify commented Nov 29, 2023

	function RadioButton({isChecked, onPress = () => undefined, accessibilityLabel, disabled = false, hasError = false}: RadioButtonProps) {
	function RadioButton({isChecked, onPress, accessibilityLabel, disabled = false, hasError = false}: RadioButtonProps) {

[TS migration] Migrate RadioButton to Typescript #31050

[TS migration] Migrate RadioButton to Typescript #31050

Conversation

MaciejSWM commented Nov 8, 2023 • edited by stitesExpensify Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

fabioh8010 Nov 13, 2023

Choose a reason for hiding this comment

fabioh8010 Nov 13, 2023

Choose a reason for hiding this comment

kubabutkiewicz left a comment

Choose a reason for hiding this comment

MaciejSWM commented Nov 20, 2023

melvin-bot bot commented Nov 21, 2023

cubuspl42 Nov 23, 2023

Choose a reason for hiding this comment

MaciejSWM Nov 24, 2023

Choose a reason for hiding this comment

cubuspl42 commented Nov 23, 2023

MaciejSWM commented Nov 24, 2023

cubuspl42 commented Nov 27, 2023

cubuspl42 commented Nov 27, 2023

cubuspl42 commented Nov 27, 2023

Reviewer Checklist

Screenshots/Videos

melvin-bot bot commented Nov 27, 2023

cubuspl42 commented Nov 27, 2023

MaciejSWM commented Nov 27, 2023

stitesExpensify left a comment

Choose a reason for hiding this comment

stitesExpensify commented Nov 27, 2023

OSBotify commented Nov 27, 2023

OSBotify commented Nov 27, 2023

OSBotify commented Nov 29, 2023

MaciejSWM commented Nov 8, 2023 •

edited by stitesExpensify

Loading