App does not scroll to bottom on paying any pending request

[kavimuru]

If you haven’t already, check out our contributing guidelines for onboarding and email contributors@expensify.com to request to join our Slack channel!

---

Action Performed:

1. Open the app and login with user A
2. Open the app on any other device and login with user B
3. From user B device, request for money to user A
4. Add few more messages below to ensure request money message will need to be scrolled to be reached
5. From user A device, scroll above and pay the request and observe that app adds new Settled text but does not scroll to bottom

Expected Result:

App should scroll to bottom when user pays the request as we add new settled message in the report

Actual Result:

App does not scroll to bottom when user pays the request

Workaround:

Can the user still use Expensify without this being fixed? Have you informed them of the workaround?

Platforms:

Which of our officially supported platforms is this issue occurring on?

• Android / native
• Android / Chrome
• iOS / native
• iOS / Safari
• MacOS / Chrome / Safari
• MacOS / Desktop

Version Number: 1.3.8-4
Reproducible in staging?: y
Reproducible in production?: y
If this was caught during regression testing, add the test name, ID and link from TestRail:
Email or phone of affected tester (no customers):
Logs: https://stackoverflow.com/c/expensify/questions/4856
Notes/Photos/Videos: Any additional supporting documentation

Recording.413.mp4

scroll.to.bottom.issue.pay.request.mp4

Expensify/Expensify Issue URL:
Issue reported by: @dhanashree-sawant
Slack conversation: https://expensify.slack.com/archives/C049HHMV9SM/p1682681991747269

View all open jobs on GitHub

[MelvinBot]

Triggered auto assignment to @anmurali (Bug), see https://stackoverflow.com/c/expensify/questions/14418 for more details.

[MelvinBot]

Bug0 Triage Checklist (Main S/O)

• This "bug" occurs on a supported platform (ensure Platforms in OP are ✅)
• This bug is not a duplicate report (check E/App issues and #expensify-bugs)
  • If it is, comment with a link to the original report, close the issue and add any novel details to the original issue instead
• This bug is reproducible using the reproduction steps in the OP. S/O
  • If the reproduction steps are clear and you're unable to reproduce the bug, check with the reporter and QA first, then close the issue.
  • If the reproduction steps aren't clear and you determine the correct steps, please update the OP.
• This issue is filled out as thoroughly and clearly as possible
  • Pay special attention to the title, results, platforms where the bug occurs, and if the bug happens on staging/production.
• I have reviewed and subscribed to the linked Slack conversation to ensure Slack/Github stay in sync

[PrashantMangukiya]

Proposal

Posting proposal early as per new guidelines

Please re-state the problem that we are trying to solve in this issue.

App does not scroll to bottom on paying any pending request

What is the root cause of that problem?

When settlement button tapped, it will call this.payMoneyRequest() function as shown at line 208

App/src/pages/iou/IOUDetailsModal.js

Lines 207 to 215 in a786349

	<SettlementButton
	onPress={paymentMethodType => this.payMoneyRequest(paymentMethodType)}
	shouldShowPaypal={Boolean(lodashGet(this.props, 'iouReport.submitterPayPalMeAddress'))}
	currency={lodashGet(this.props, 'iouReport.currency')}
	enablePaymentsRoute={ROUTES.IOU_DETAILS_ENABLE_PAYMENTS}
	addBankAccountRoute={ROUTES.IOU_DETAILS_ADD_BANK_ACCOUNT}
	addDebitCardRoute={ROUTES.IOU_DETAILS_ADD_DEBIT_CARD}
	chatReportID={this.props.route.params.chatReportID}
	/>

Here is the code for payMoneyRequest() function

App/src/pages/iou/IOUDetailsModal.js

Lines 129 to 161 in a786349

	payMoneyRequest(paymentMethodType) {
	const recipient = {
	login: this.props.iouReport.ownerEmail,
	payPalMeAddress: this.props.iouReport.submitterPayPalMeAddress,
	};
	if (paymentMethodType === CONST.IOU.PAYMENT_TYPE.ELSEWHERE) {
	IOU.payMoneyRequestElsewhere(
	this.props.chatReport,
	this.props.iouReport,
	recipient,
	);
	return;
	}
	if (paymentMethodType === CONST.IOU.PAYMENT_TYPE.PAYPAL_ME) {
	IOU.payMoneyRequestViaPaypal(
	this.props.chatReport,
	this.props.iouReport,
	recipient,
	);
	return;
	}
	if (paymentMethodType === CONST.IOU.PAYMENT_TYPE.EXPENSIFY) {
	IOU.payMoneyRequestWithWallet(
	this.props.chatReport,
	this.props.iouReport,
	recipient,
	);
	Navigation.navigate(ROUTES.getReportRoute(this.props.route.params.chatReportID));
	}
	}

We can see that, depending on the paymentMethodType we call IOU.payMoneyRequestElsewhere() at line 136, OR IOU.payMoneyRequestViaPaypal() at line 145, OR IOU.payMoneyRequestWithWallet() at line 154.

So once api called it will just return, i..e we do not take care to scroll to bottom of the report. So it will not automatically scroll to bottom of the report. This is the root cause of the problem.

What changes do you think we should make in order to solve the problem?

To solve this issue we have to call api to scroll at bottom of the report once pay money request finished. We can achieve this via ReportScrollManager.scrollToBottom() function.

So within <SettlementButton> we have to update onPress as shown below.

<SettlementButton
  //onPress={paymentMethodType => this.payMoneyRequest(paymentMethodType)}  // *** Old Code ***
  onPress={(paymentMethodType) => {
      this.payMoneyRequest(paymentMethodType);
      ReportScrollManager.scrollToBottom();    // *** Add this
  }}
  ...
/>

So once payMoneyRequest() function call finish it will call ReportScrollManager.scrollToBottom(). So this will solve the issue and scroll to report bottom as shown in result video.

What alternative solutions did you explore? (Optional)

We can call ReportScrollManager.scrollToBottom() within payMoneyRequest() function within each if condition as shown below.

payMoneyRequest(paymentMethodType) { 
   ....
  
   if (paymentMethodType === CONST.IOU.PAYMENT_TYPE.ELSEWHERE) { 
       IOU.payMoneyRequestElsewhere(...); 
       ReportScrollManager.scrollToBottom();   // *** Add this
       return; 
   } 

   if (paymentMethodType === CONST.IOU.PAYMENT_TYPE.PAYPAL_ME) { 
       IOU.payMoneyRequestViaPaypal(...); 
       ReportScrollManager.scrollToBottom();   // *** Add this
       return; 
   } 

   if (paymentMethodType === CONST.IOU.PAYMENT_TYPE.EXPENSIFY) { 
       IOU.payMoneyRequestWithWallet(...); 
       ReportScrollManager.scrollToBottom();   // *** Add this
       Navigation.navigate(ROUTES.getReportRoute(this.props.route.params.chatReportID)); 
   } 
} 

Results

IOU-Settle.mov

[MelvinBot]

Looks like something related to react-navigation may have been mentioned in this issue discussion.

As a reminder, please make sure that all proposals are not workarounds and that any and all attempt to fix the issue holistically have been made before proceeding with a solution. Proposals to change our DeprecatedCustomActions.js files should not be accepted.

Feel free to drop a note in #expensify-open-source with any questions.

[anmurali]

Not sure this is a bug. Followed up in the Slack thread here

[dukenv0307]

Proposal

Please re-state the problem that we are trying to solve in this issue.

App does not scroll to bottom on paying any pending request

What is the root cause of that problem?

I am not sure if this issue is a bug. But currently, it is inconsistent between sending/requesting money flow and the paying flow.

The root cause is that we have logic to scroll the chat to the bottom in the sending/requesting money flow but no logic to scroll the chat to the bottom in the paying flow.

Note that: A new message is created in all the above flow.

What changes do you think we should make in order to solve the problem?

First, we need to clarify what is expected.

Case 1: Should scroll to the bottom after requesting/sending/paying the money

Solution: In /src/libs/actions/IOU.js we should add logic to scroll to the bottom in 3 functions: payMoneyRequestElsewhere, payMoneyRequestWithWallet, payMoneyRequestViaPaypal like this

function payMoneyRequestElsewhere(chatReport, iouReport, recipient) {
    .....

    Navigation.navigate(ROUTES.getReportRoute(chatReport.reportID));
    ReportScrollManager.scrollToBottom();
}


function payMoneyRequestWithWallet(chatReport, iouReport, recipient) {
    .....
    Navigation.navigate(ROUTES.getReportRoute(chatReport.reportID));
    ReportScrollManager.scrollToBottom();
}

function payMoneyRequestViaPaypal(chatReport, iouReport, recipient) {
    .....

    Navigation.navigate(ROUTES.getReportRoute(chatReport.reportID));
    ReportScrollManager.scrollToBottom();
    asyncOpenURL(Promise.resolve(), buildPayPalPaymentUrl(iouReport.total, recipient.payPalMeAddress, iouReport.currency));
}

I think it is better to call scrollToBottom function after navigating so we can consider moving the scrollToBottom function
in sending/requesting money flow (that is executed in this PR) back navigating function

Case 2: Shouldn't scroll to the bottom after requesting/sending/paying the money

Solution: Revert this PR

Improvement

No matter what case we come up with, we also should remove this line

App/src/pages/iou/IOUDetailsModal.js

Line 159 in f524362

Navigation.navigate(ROUTES.getReportRoute(this.props.route.params.chatReportID));

Because we just call it in the payMoneyRequestWithWallet function

App/src/libs/actions/IOU.js

Lines 980 to 987 in f524362

	function payMoneyRequestWithWallet(chatReport, iouReport, recipient) {
	const {
	params, optimisticData, successData, failureData,
	} = getPayMoneyRequestParams(chatReport, iouReport, recipient, CONST.IOU.PAYMENT_TYPE.EXPENSIFY);
	API.write('PayMoneyRequestWithWallet', params, {optimisticData, successData, failureData});
	Navigation.navigate(ROUTES.getReportRoute(chatReport.reportID));

What alternative solutions did you explore? (Optional)

[anmurali]

Not a bug.