Refactor IOUModal to MoneyRequestModal by thienlnam · Pull Request #16679 · Expensify/App

thienlnam · 2023-03-29T15:55:48Z

Details

Fixed Issues

$ https://github.com/Expensify/Expensify/issues/270592
$ #16276

Tests

This is a refactor of the IOUModal so lets test the main flows in all sorts of ways

Request Money

Request money via the global create
Update the currency to something random
Select a participant
Verify a transaction is created between you and the participant

Split bill

Split bill via the global create
Update the currency to USD
Select 8 participants and notice you see the text You've selected the maximum number (8) of participants.
Continue and write a description
Notice that a group chat was created, and in each DM a message was sent

Send Money

Send money via the global create
Update the currency to USD
Select a participant and hit 'Settle outside of Expensify'
Verify it works as expected

Verify that the nothing about the IOU functionality has changed
Verify that no errors appear in the JS console

Offline tests

Go through all of the flows offline and then go back online and verify they work as expected

QA Steps

Same steps as Tests

PR Author Checklist

Screenshots/Videos

Web

Screen.Recording.2023-04-03.at.4.48.28.PM.mov

Mobile Web - Chrome

Screen.Recording.2023-04-04.at.11.29.55.AM.mov

Mobile Web - Safari

Screen.Recording.2023-04-04.at.11.36.47.AM.mov

Desktop

Screen.Recording.2023-04-03.at.6.05.03.PM.mov

iOS

Android

marcaaron

Looking pretty 👌. Left a few notes on the hooks stuff.

marcaaron · 2023-04-03T20:04:07Z

+        const isDoneCreatingIOUTransaction = prevCreatingIOUTransactionStatusRef.current && !lodashGet(props, 'iou.creatingIOUTransaction');
+
+        // User came back online, so we can try to create the IOU transaction again
+        if (prevNetworkStatusRef.current && !props.network.isOffline) {


NAB / maybe for a follow up. But I would consider refactoring this logic into a custom hook called useNetworkReconnect() that does something like this:

exports the context object from here:

App/src/components/OnyxProvider.js

Lines 9 to 10 in 4efde84

const [withNetwork, NetworkProvider] = createOnyxContext(ONYXKEYS.NETWORK);

const [withPersonalDetails, PersonalDetailsProvider] = createOnyxContext(ONYXKEYS.PERSONAL_DETAILS);

function useNetworkReconnect(callback) { const {isOffline} = useContext(NetworkContext); const prevIsOfflineRef = useRef(isOffline); useEffect(() => { if (prevIsOfflineRef.current && !isOffline) { callback(); } prevIsOfflineRef.current = isOffline; }, [isOffline]); }

and would be used like this

useNetworkReconnect(PersonalDetails.openMoneyRequestModalPage);

I agree it would be nice to have a seperate hook for this, I'll create another issue that will go in and just refactor all instances of it

marcaaron · 2023-04-03T20:06:49Z

+        const selectedCurrencyCode = lodashGet(props, 'iou.selectedCurrencyCode');
+        if (prevSelectedCurrencyCodeRef.current !== selectedCurrencyCode) {
+            IOU.setIOUSelectedCurrency(selectedCurrencyCode);
+        }


NAB, but feel like I don't understand it or maybe it's an anti-pattern. Why is the currency changing? Can we just update this whenever the currency changes (e.g. by moving IOU.setIOUSelectedCurrency() closer to the logic that updates the prop instead of applying a side effect)?

Yeah I also agree this is an anti-pattern, I would imagine we call this where the logic happens of the user changing their currency code

... I went to the spot where the currency is selected and it already does this so I am going to 🔪 it from here and see what breaks

marcaaron · 2023-04-03T20:12:37Z

+                </View>
+            </View>
+        );
+    }


Pretty much all of these functions should use useCallback() if they have dependencies.

And if they don't we can move them to the top of the file. I looked briefly and I think most do have dependencies.

What's the guideline for when to cache methods? I didn't think it was necessary here because none of these functions perform any heavy computational tasks that need to be cached

thienlnam · 2023-04-03T23:17:20Z

This is ready to be reviewed, I still need to add screenshots but we can do a code review
cc @marcaaron @Julesssss @luacmartins @mountiny

marcaaron

Each time we render this component the inline functions with dependencies inside it will get re-created. Based on this conversation we have decided to just wrap those with useCallback().

Full context here: https://expensify.slack.com/archives/C01GTK53T8Q/p1680096510744619

marcaaron · 2023-04-04T21:37:15Z

+ * A modal used for requesting money, splitting bills or sending money.
+ */
+const propTypes = {
+    /** Whether the IOU is for a single request or a group bill split */


nab, should we change some of these IOU to Request?

Updated some of them to Request - didn't update all of them because they are still IOU reports and used like that throughout the code so didn't want it to cause more confusion

marcaaron · 2023-04-04T21:43:25Z

+    useEffect(() => {
+        PersonalDetails.openMoneyRequestModalPage();
+        IOU.setIOUSelectedCurrency(props.currentUserPersonalDetails.localCurrencyCode);
+    // eslint-disable-next-line react-hooks/exhaustive-deps -- props.currentUserPersonalDetails will always exist from Onyx


it's not needed because we get it from onyx

And because we do not want this effect to run again.

I think it's kind of an anti-pattern though (that we can clean up later probably). If we always want the "iou selected currency" to be the "local currency code" when this component mounts then we should update that value in Onyx whenever we update the local currency code. We can hook into the initial render like this - but it's not obvious if we should...

marcaaron · 2023-04-04T21:48:56Z

+
+    useEffect(() => {
+        // We only want to check if we just finished creating an IOU transaction
+        // We check it within this effect because we're sending the request optimistically but if an error occurs from the API, we will update the iou state with the error later


Is it kind of sus and/or confusing? If the error occurs from the API then could we just look at props.iou.error as a dependency? If we didn't have an error before, but have one now then we should set the index to 0.

also having trouble understanding the case where we'd dismiss the modal. Anytime the iou changes and we have no errors and we're not in the process of creating the transaction via the API we call dismissModal()? Why is that exactly?

Yeah I agree it is kind of confusing

If the error occurs from the API then could we just look at props.iou.error as a dependency?

We could, but we'd still need to check the previous props to see if we are done creating iou otherwise this would run each re-render

also having trouble understanding the case where we'd dismiss the modal. Anytime the iou changes and we have no errors and we're not in the process of creating the transaction via the API we call dismissModal()? Why is that exactly?

Don't have a great answer for this, I'm mostly just refactoring the existing logic in place

My guess actually is that we have this logic in place for the offline handling of creating IOUs. Like if you dismiss the modal right after the transaction was created, then we don't have the ability to re-open and restart the money request. This handling is basically like - user comes back online? okay open the money request modal and then now that they are back online based on the success state of the IOU either restart the modal or dismiss it

Ok, I think at a minimum we should just add a more specific dependency for creatingIOUTransaction? If I am understanding the logic correctly we only want to do "something" (show error or dismiss) when the transaction API call completes.

I believe we're already kind of handling this with prevCreatingIOUTransactionStatusRef, like we need to check that creatingIOUTransaction is true but also that the previous creatingIOUTransaction is false to confirm this is the first time that the IOU was created

More weirdness happening, creating this issue #16942 to investigate it more deeply but not block on this

thienlnam · 2023-04-04T23:03:17Z

Okay, there's some more weird logic to clean up but I don't want to keep holding this PR for these changes bc many other PRs are on hold for this.

I created another issue to investigate more deeply here #16942 but this will at least unblock the other PRs. Right now, this uses mostly the same logic that was already existing

thienlnam · 2023-04-04T23:03:38Z

Ready to review / test!

fedirjh · 2023-04-04T23:17:31Z

Reviewer Checklist

Screenshots/Videos

Web

Screen.Recording.2023-04-04.at.9.20.42.PM.mov

Offline test

Screen.Recording.2023-04-05.at.12.51.06.AM.mov

Mobile Web - Chrome

Screen.Recording.2023-04-04.at.10.45.25.PM.mov

Mobile Web - Safari

Simulator.Screen.Recording.-.iPhone.14.-.2023-04-04.at.22.24.30.mp4

Desktop

Screen.Recording.2023-04-04.at.9.35.28.PM.mov

iOS

Simulator.Screen.Recording.-.iPhone.14.-.2023-04-04.at.22.18.06.mp4

Android

Screen.Recording.2023-04-04.at.10.51.47.PM.mov

marcaaron

LGTM - full disclosure I did not test the changes yet, but will give it a go if needed.

marcaaron · 2023-04-04T23:11:39Z

+    const participantsWithDetails = _.map(OptionsListUtils.getPersonalDetailsForLogins(reportParticipants, props.personalDetails), personalDetails => ({
+        login: personalDetails.login,
+        text: personalDetails.displayName,
+        firstName: lodashGet(personalDetails, 'firstName', ''),
+        lastName: lodashGet(personalDetails, 'lastName', ''),
+        alternateText: Str.isSMSLogin(personalDetails.login) ? Str.removeSMSDomain(personalDetails.login) : personalDetails.login,
+        icons: [{
+            source: ReportUtils.getAvatar(personalDetails.avatar, personalDetails.login),
+            name: personalDetails.login,
+            type: CONST.ICON_TYPE_AVATAR,
+        }],
+        keyForList: personalDetails.login,
+        payPalMeAddress: lodashGet(personalDetails, 'payPalMeAddress', ''),
+        phoneNumber: lodashGet(personalDetails, 'phoneNumber', ''),
+    }));
+
+    // Skip IOUParticipants step if participants are passed in
+    const steps = reportParticipants.length ? [Steps.IOUAmount, Steps.IOUConfirm] : [Steps.IOUAmount, Steps.IOUParticipants, Steps.IOUConfirm];
+
+    const prevCreatingIOUTransactionStatusRef = useRef(lodashGet(props.iou, 'creatingIOUTransaction'));
+    const prevNetworkStatusRef = useRef(props.network.isOffline);
+
+    const [previousStepIndex, setPreviousStepIndex] = useState(0);
+    const [currentStepIndex, setCurrentStepIndex] = useState(0);
+    const [participants, setParticipants] = useState(participantsWithDetails);


Another possible follow up, but we should definitely use a lazy init for useState() here.. we need to pull the logic from line 109 down into the useState() call so we only calculate it once instead of on every render (might not be hurting anything but it's unnecessary work)...

Suggested change

const participantsWithDetails = _.map(OptionsListUtils.getPersonalDetailsForLogins(reportParticipants, props.personalDetails), personalDetails => ({

login: personalDetails.login,

text: personalDetails.displayName,

firstName: lodashGet(personalDetails, 'firstName', ''),

lastName: lodashGet(personalDetails, 'lastName', ''),

alternateText: Str.isSMSLogin(personalDetails.login) ? Str.removeSMSDomain(personalDetails.login) : personalDetails.login,

icons: [{

source: ReportUtils.getAvatar(personalDetails.avatar, personalDetails.login),

name: personalDetails.login,

type: CONST.ICON_TYPE_AVATAR,

}],

keyForList: personalDetails.login,

payPalMeAddress: lodashGet(personalDetails, 'payPalMeAddress', ''),

phoneNumber: lodashGet(personalDetails, 'phoneNumber', ''),

}));

// Skip IOUParticipants step if participants are passed in

const steps = reportParticipants.length ? [Steps.IOUAmount, Steps.IOUConfirm] : [Steps.IOUAmount, Steps.IOUParticipants, Steps.IOUConfirm];

const prevCreatingIOUTransactionStatusRef = useRef(lodashGet(props.iou, 'creatingIOUTransaction'));

const prevNetworkStatusRef = useRef(props.network.isOffline);

const [previousStepIndex, setPreviousStepIndex] = useState(0);

const [currentStepIndex, setCurrentStepIndex] = useState(0);

const [participants, setParticipants] = useState(participantsWithDetails);

// Skip IOUParticipants step if participants are passed in

const steps = reportParticipants.length ? [Steps.IOUAmount, Steps.IOUConfirm] : [Steps.IOUAmount, Steps.IOUParticipants, Steps.IOUConfirm];

const prevCreatingIOUTransactionStatusRef = useRef(lodashGet(props.iou, 'creatingIOUTransaction'));

const prevNetworkStatusRef = useRef(props.network.isOffline);

const [previousStepIndex, setPreviousStepIndex] = useState(0);

const [currentStepIndex, setCurrentStepIndex] = useState(0);

const [participants, setParticipants] = useState(() => _.map(OptionsListUtils.getPersonalDetailsForLogins(reportParticipants, props.personalDetails), personalDetails => ({

login: personalDetails.login,

text: personalDetails.displayName,

firstName: lodashGet(personalDetails, 'firstName', ''),

lastName: lodashGet(personalDetails, 'lastName', ''),

alternateText: Str.isSMSLogin(personalDetails.login) ? Str.removeSMSDomain(personalDetails.login) : personalDetails.login,

icons: [{

source: ReportUtils.getAvatar(personalDetails.avatar, personalDetails.login),

name: personalDetails.login,

type: CONST.ICON_TYPE_AVATAR,

}],

keyForList: personalDetails.login,

payPalMeAddress: lodashGet(personalDetails, 'payPalMeAddress', ''),

phoneNumber: lodashGet(personalDetails, 'phoneNumber', ''),

})));

Good point, will add that to the list of things to do in #16942

MelvinBot · 2023-04-04T23:22:13Z

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

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

marcaaron · 2023-04-05T00:29:29Z

Gonna merge this so we can keep the Manual Requests train rolling 🚅

OSBotify · 2023-04-05T00:34:55Z

✋ 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-04-05T03:18:28Z

🚀 Deployed to staging by https://github.com/marcaaron in version: 1.2.95-0 🚀

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

OSBotify · 2023-04-06T00:58:27Z

🚀 Deployed to production by https://github.com/thienlnam in version: 1.2.95-0 🚀

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

sobitneupane · 2023-04-27T12:01:43Z

+};
+
+const ModalHeader = props => (
+    <View style={[styles.headerBar]}>


There was some inconsistency in styling Header with Back button. It was fixed by this PR.

thienlnam added 13 commits March 29, 2023 12:03

Migrate the new modal props / HOC

2dda81f

add the class functions

6408554

migrate this.step

4cf8420

add refs for previous values

3b228b3

refactor the useEffect

6f1af21

add seperate component for header

1d5d5bc

update all instances of this

a447ee3

remove seperate header for now

c2aa299

fix function declarations

d8dd2d8

Comment updates

60cf4f8

Update method for openMoneyRequestModalPage

9f1a746

Update usages of IOUModal Component

e0aaee7

update the api command that is called

3cce255

mountiny assigned thienlnam Apr 3, 2023

mountiny requested review from Julesssss, luacmartins, marcaaron and mountiny April 3, 2023 19:41

marcaaron reviewed Apr 3, 2023

View reviewed changes

Comment thread src/pages/iou/MoneyRequestModal.js Outdated

Merge branch 'main' into jack-refactorIOUModal

e810c37

This was referenced Apr 3, 2023

[$250] useNetworkReconnect Custom Hook #16889

Closed

[HOLD #16679] Refactor Header into a new component from MoneyRequestModal #16890

Closed

thienlnam added 6 commits April 3, 2023 14:58

review comments / kill currency update

81380cc

update routes / useEffect cleanup

6424dd2

clean up comments

07b1fd8

add new header component

592f083

clean up method to use new component

1d916df

remove IOU Modal

d4dd9d8

thienlnam requested review from fedirjh and removed request for rushatgabhane April 4, 2023 18:42

fedirjh reviewed Apr 4, 2023

View reviewed changes

Comment thread src/pages/iou/MoneyRequestModal.js Outdated

remove lint

c9af57d

marcaaron requested changes Apr 4, 2023

View reviewed changes

review. comments / update functions to useCallback

1a8df6f

fedirjh reviewed Apr 4, 2023

View reviewed changes

Comment thread src/pages/iou/MoneyRequestModal.js Outdated

fedirjh reviewed Apr 4, 2023

View reviewed changes

Comment thread src/pages/iou/MoneyRequestModal.js Outdated

fedirjh reviewed Apr 4, 2023

View reviewed changes

Comment thread src/pages/iou/MoneyRequestModal.js Outdated

update some functions to memo

0ac8c49

thienlnam mentioned this pull request Apr 4, 2023

[HOLD for payment 2023-05-23] Investigate how to clean up MoneyRequestModal effects #16942

Closed

thienlnam requested review from fedirjh and marcaaron April 4, 2023 23:03

marcaaron approved these changes Apr 4, 2023

View reviewed changes

fedirjh approved these changes Apr 4, 2023

View reviewed changes

melvin-bot Bot mentioned this pull request Apr 4, 2023

Payment issue for E/App PR#16679 #16944

Closed

marcaaron merged commit ce1dccb into main Apr 5, 2023

marcaaron deleted the jack-refactorIOUModal branch April 5, 2023 00:29

OSBotify mentioned this pull request Apr 5, 2023

Deploy Checklist: New Expensify 2023-04-05 #16956

Closed

15 tasks

MelvinBot mentioned this pull request Apr 6, 2023

[HOLD for payment 2023-04-13] Migrate IOUModal.js to function component #16276

Closed

1 task

Prince-Mendiratta mentioned this pull request Apr 13, 2023

[HOLD for payment 2023-04-27] [$1000] Back button in split bill page is 20px padding left inconsistent with other pages of the app #17366

Closed

6 tasks

sobitneupane reviewed Apr 27, 2023

View reviewed changes

	const [withNetwork, NetworkProvider] = createOnyxContext(ONYXKEYS.NETWORK);
	const [withPersonalDetails, PersonalDetailsProvider] = createOnyxContext(ONYXKEYS.PERSONAL_DETAILS);

Uh oh!

Conversation

thienlnam commented Mar 29, 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!

marcaaron left a comment

Choose a reason for hiding this comment

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!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

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!

Uh oh!

thienlnam commented Apr 3, 2023

Uh oh!

Uh oh!

marcaaron left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

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!

marcaaron Apr 4, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

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!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

thienlnam commented Apr 4, 2023

Uh oh!

thienlnam commented Apr 4, 2023

thienlnam commented Mar 29, 2023 •

edited

Loading

marcaaron left a comment •

edited

Loading

marcaaron Apr 4, 2023 •

edited

Loading

fedirjh commented Apr 4, 2023 •

edited

Loading