migrating MoneyRequestAmountPage to functional component #21005

BhuvaneshPatil · 2023-06-19T06:49:18Z

Details>

Refactoring MoneyRequestAmountPage to a functional component

Fixed Issues

$ #16278
PROPOSAL: #16278 (comment)

Tests

Open a MoneyRequestAmountPage it's opened when we create a Split Bill or Request Money or Send Money
To test thoroughly change the currency, amount multiple times

Verify that no errors appear in the JS console

Offline tests

QA Steps

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

Web

Google.Desktop.web.-.Made.with.Clipchamp.mp4

Mobile Web - Chrome

Mobile.-.Web.mp4

Mobile Web - Safari

Mobile.web.safari.mp4

Desktop

desktop.-.Made.with.Clipchamp.mp4

iOS

ios.-.Made.with.Clipchamp.mp4

Android

Android.-.Made.with.Clipchamp.mp4

melvin-bot · 2023-06-19T06:49:22Z

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

thesahindia · 2023-06-20T20:54:03Z

Not sure why melvin didn't request a review from @Julesssss 🤔

The changes looks good, I will try to test it in the morning.

thesahindia · 2023-06-20T20:54:22Z

@BhuvaneshPatil, you missed this item. You need to check off all the items, otherwise the test will fail.

BhuvaneshPatil · 2023-06-21T10:33:48Z

@thesahindia , Updated the checklist

thesahindia

Let's add a display name for this component. Also please resolve the conflicts.

src/pages/iou/steps/MoneyRequestAmountPage.js

…grate-MoneyRequestAmountPage

BhuvaneshPatil · 2023-06-22T15:55:12Z

Friendly bump @Julesssss @thesahindia
Can we please escalate this, chances increasing merge conflicts.

thesahindia · 2023-06-22T20:28:53Z

@BhuvaneshPatil, the amount changes to 0 when I choose a different currency

Screen.Recording.2023-06-23.at.1.57.25.AM.mov

BhuvaneshPatil · 2023-06-23T03:43:10Z

Thank you for pointing out @thesahindia . That occurred while resolving merge conflicts

s77rt · 2023-06-23T10:28:47Z

Taking this one as C+ (reviewer)

s77rt

Round 1 (didn't review all code yet* - will re-review once the below comments are addressed). This page was refactored recently and there is a lot of outdated code.

Tip: Refer to MoneyRequestConfirmPage.

src/pages/iou/steps/MoneyRequestAmountPage.js

…78-migrate-MoneyRequestAmountPage

s77rt · 2023-06-26T12:05:34Z

@BhuvaneshPatil Let me know when this is ready for re-review

BhuvaneshPatil · 2023-06-27T03:11:35Z

Hi @s77rt , I am working on the useEffect refactoring, will let you know once done

src/pages/iou/steps/MoneyRequestAmountPage.js

BhuvaneshPatil · 2023-06-28T06:08:51Z

@s77rt I have pushed the changes, I think there are still more improvements need to be done for useEffect implementations. Please provide the feedback on the same.

s77rt

Let's try prioritise the case stated in updateAmount.

Also found a bug, can't modify amount:

Start money request
Type any amount
Press Next
Select participants
Press Next
Click on Amount

You should be on send/new/amount but instead you are redirected to send/new (starting the request from the beginning)

src/pages/iou/steps/MoneyRequestAmountPage.js

…78-migrate-MoneyRequestAmountPage

mountiny · 2023-07-04T19:28:35Z

@BhuvaneshPatil @s77rt Can we please prioritize getting this one over the finish line?

s77rt · 2023-07-05T19:59:22Z

@BhuvaneshPatil I see the commits now. Seems to cover only two concerns: the useCallback and useRoute. Can you please address the rest of the comments (and the bug)? If anything is needed let's work on this on Slack

BhuvaneshPatil · 2023-07-05T20:01:40Z

Bug that you have mentioned is resolved.

PS - It was happening because I forgot to add .current for ref

…78-migrate-MoneyRequestAmountPage

BhuvaneshPatil · 2023-07-07T19:14:21Z

@s77rt , updated the code

s77rt · 2023-07-07T19:19:12Z

@BhuvaneshPatil Thanks! Can you please resolve the conflicts?

BhuvaneshPatil · 2023-07-07T19:23:45Z

Yes @s77rt . Working on them. There we have new method - dismissModalIfNecessary. It's being called in useEffect, shall I add eslint disable for exhaustive hooks?

I have wrapped it in the useCallback, and added to dependency array. Tested it - Working as expected.

s77rt · 2023-07-07T19:33:03Z

I don't see the need of useCallback here. Just wrap the function in it's own useEffect

BhuvaneshPatil · 2023-07-07T19:36:38Z

I don't see the need of useCallback here. Just wrap the function in it's own useEffect

@s77rt Sorry, but I am afraid that I don't understand what you are implying here

Do you meant to say that, create a new useEffect and have this function inside it -

    useEffect(() => {
        if (!ReportUtils.shouldHideComposer(props.report, props.errors)) {
            return;
        }
        Navigation.dismissModal(reportID);
    }, [props.errors, props.report]);

s77rt · 2023-07-07T19:58:08Z

@BhuvaneshPatil Yes, that should do it; but reportID is a ref so I think you meant to pass reportID.current.

BhuvaneshPatil · 2023-07-07T20:20:38Z

@s77rt I have updated the code for dismiss modal

s77rt · 2023-07-07T20:47:09Z

@BhuvaneshPatil Awesome! Code looking good. While testing on iOS I noticed some cursor jump behaviour, I think this bug exists in main but the jump behaviour seems to happen more often. Can you please confirm from your side if this is a regression or not?

s77rt · 2023-07-07T21:10:45Z

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

Mobile Web - Chrome

Mobile Web - Safari

Desktop

iOS

Android

s77rt · 2023-07-07T23:43:39Z

@mountiny We are probably good to merge, just need a confirmation from @BhuvaneshPatil about the iOS behaviour, it's seems to have a buggy cursor but I'm getting this on main too. So I guess we can move on with that

BhuvaneshPatil · 2023-07-08T05:05:27Z

@s77rt , I checked on master and new implementation. The jumpy behavior is at both places

s77rt · 2023-07-08T06:44:14Z

@BhuvaneshPatil Thanks for the confirmation.

s77rt

LGTM! 🚀

mountiny

One minor comment otherwise looking good.

All yours @Julesssss!

src/pages/iou/steps/MoneyRequestAmountPage.js

Julesssss · 2023-07-10T10:51:16Z

Just waiting for a lint PR fix to avoid errors once merged.

OSBotify · 2023-07-10T11:26:40Z

✋ 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-07-11T00:20:04Z

🚀 Deployed to staging by https://github.com/Julesssss in version: 1.3.39-0 🚀

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

OSBotify · 2023-07-13T01:44:06Z

🚀 Deployed to production by https://github.com/francoisl in version: 1.3.39-11 🚀

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

rushatgabhane · 2023-08-14T19:07:34Z

src/pages/iou/steps/MoneyRequestAmountPage.js

+            start: selectedAmountAsStringForState.length,
+            end: selectedAmountAsStringForState.length,
+        });
+    }, [props.iou.amount, props.iou.currency]);


Hi, this PR caused a regression/bug - Currency changes after refresh although URL has currency params
#23436

more details here - #23436 (comment)

Interesting! Previously we used the componentDidUpdate method which only occurs after an update while the useEffect is triggered also on the initial render (ignoring dependencies).

migrating MoneyRequestAmountPage to functional component

01de9c5

BhuvaneshPatil requested a review from a team as a code owner June 19, 2023 06:49

melvin-bot bot removed the request for review from a team June 19, 2023 06:49

melvin-bot bot requested a review from thesahindia June 19, 2023 06:49

Julesssss assigned BhuvaneshPatil Jun 21, 2023

Julesssss self-requested a review June 21, 2023 09:39

thesahindia suggested changes Jun 21, 2023

View reviewed changes

src/pages/iou/steps/MoneyRequestAmountPage.js Outdated Show resolved Hide resolved

Merge branch 'main' of https://github.com/Expensify/App into 16278-mi…

c245108

…grate-MoneyRequestAmountPage

fix: amount changing to zero after changing currency

2d0c251

s77rt suggested changes Jun 23, 2023

View reviewed changes

Merge branch 'main' of https://github.com/BhuvaneshPatil/App into 162…

ee19107

…78-migrate-MoneyRequestAmountPage

s77rt suggested changes Jun 27, 2023

View reviewed changes

src/pages/iou/steps/MoneyRequestAmountPage.js Show resolved Hide resolved

refactoring - for new changes

03336dc

s77rt suggested changes Jun 29, 2023

View reviewed changes

BhuvaneshPatil added 2 commits July 1, 2023 12:39

Merge branch 'main' of https://github.com/BhuvaneshPatil/App into 162…

852ea7d

…78-migrate-MoneyRequestAmountPage

Refactoring for reviews

9d8be6b

Merge branch 'main' of https://github.com/BhuvaneshPatil/App into 162…

eb41f0e

…78-migrate-MoneyRequestAmountPage

fix: wrap dismissmodal in useffect

d443484

mountiny requested review from s77rt and thesahindia July 7, 2023 23:42

s77rt approved these changes Jul 8, 2023

View reviewed changes

mountiny previously approved these changes Jul 8, 2023

View reviewed changes

src/pages/iou/steps/MoneyRequestAmountPage.js Outdated Show resolved Hide resolved

nit: changes Id to ID

7144f87

BhuvaneshPatil dismissed mountiny’s stale review via 7144f87 July 9, 2023 06:06

Julesssss approved these changes Jul 10, 2023

View reviewed changes

Julesssss merged commit 6a7c1b2 into Expensify:main Jul 10, 2023

OSBotify mentioned this pull request Jul 10, 2023

Deploy Checklist: New Expensify 2023-07-10 #22598

Closed

76 tasks

melvin-bot bot mentioned this pull request Jul 13, 2023

[HOLD for payment 2023-07-20] [$250] Migrate MoneyRequestAmountPage.js to function component #16278

Closed

1 task

rushatgabhane reviewed Aug 14, 2023

View reviewed changes

rushatgabhane mentioned this pull request Aug 14, 2023

[HOLD for payment 2023-08-14] [$1000] Currency changes after refresh although URL has currency params #23436

Closed

6 tasks

migrating MoneyRequestAmountPage to functional component #21005

migrating MoneyRequestAmountPage to functional component #21005

Conversation

BhuvaneshPatil commented Jun 19, 2023 • edited Loading

Details>

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

melvin-bot bot commented Jun 19, 2023

thesahindia commented Jun 20, 2023

thesahindia commented Jun 20, 2023

BhuvaneshPatil commented Jun 21, 2023

thesahindia left a comment

Choose a reason for hiding this comment

BhuvaneshPatil commented Jun 22, 2023

thesahindia commented Jun 22, 2023

BhuvaneshPatil commented Jun 23, 2023

s77rt commented Jun 23, 2023

s77rt left a comment • edited Loading

Choose a reason for hiding this comment

s77rt commented Jun 26, 2023

BhuvaneshPatil commented Jun 27, 2023

BhuvaneshPatil commented Jun 28, 2023

s77rt left a comment

Choose a reason for hiding this comment

mountiny commented Jul 4, 2023

s77rt commented Jul 5, 2023

BhuvaneshPatil commented Jul 5, 2023 • edited Loading

BhuvaneshPatil commented Jul 7, 2023

s77rt commented Jul 7, 2023

BhuvaneshPatil commented Jul 7, 2023 • edited Loading

s77rt commented Jul 7, 2023

BhuvaneshPatil commented Jul 7, 2023 • edited Loading

s77rt commented Jul 7, 2023

BhuvaneshPatil commented Jul 7, 2023

s77rt commented Jul 7, 2023

s77rt commented Jul 7, 2023 • edited Loading

Reviewer Checklist

Screenshots/Videos

s77rt commented Jul 7, 2023

BhuvaneshPatil commented Jul 8, 2023

s77rt commented Jul 8, 2023

s77rt left a comment

Choose a reason for hiding this comment

mountiny left a comment

Choose a reason for hiding this comment

Julesssss commented Jul 10, 2023

OSBotify commented Jul 10, 2023

OSBotify commented Jul 11, 2023

OSBotify commented Jul 13, 2023

rushatgabhane Aug 14, 2023

Choose a reason for hiding this comment

s77rt Aug 15, 2023

Choose a reason for hiding this comment

BhuvaneshPatil commented Jun 19, 2023 •

edited

Loading

s77rt left a comment •

edited

Loading

BhuvaneshPatil commented Jul 5, 2023 •

edited

Loading

BhuvaneshPatil commented Jul 7, 2023 •

edited

Loading

BhuvaneshPatil commented Jul 7, 2023 •

edited

Loading

s77rt commented Jul 7, 2023 •

edited

Loading