[HOLD for payment 2024-07-25] [$250] Incorrect animation when accessing Referral information page

[m-natarajan]

If you haven’t already, check out our contributing guidelines for onboarding and email [email protected] to request to join our Slack channel!

---

Version Number: 9.0.3-6
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
Expensify/Expensify Issue URL:
Issue reported by: @shawnborton
Slack conversation: https://expensify.slack.com/archives/C049HHMV9SM/p1719906639184049

Action Performed:

1. Open app
2. From global menu click on 'Fab' > start chat
3. From the bottom of the page click on the referral banner

Expected Result:

Animation should correct when RHP page for referral is opened

Actual Result:

The transition from Start a chat to the Referral RHP page is incorrect.

Workaround:

unknown

Platforms:

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

• Android: Native
• Android: mWeb Chrome
• iOS: Native
• iOS: mWeb Safari
• MacOS: Chrome / Safari
• MacOS: Desktop

Screenshots/Videos

CleanShot.2024-07-02.at.09.49.52.mp4

Recording.281.mp4

View all open jobs on GitHub

Upwork Automation - Do Not Edit

• Upwork Job URL: https://www.upwork.com/jobs/~018c7e0a6ee4ee4a2e
• Upwork Job ID: 1808294158595817715
• Last Price Increase: 2024-07-03
• Automatic offers:
• nkdengineer | Contributor | 103052448

Issue Owner

Current Issue Owner: @lschurr

[melvin-bot]

Triggered auto assignment to @lschurr (Bug), see https://stackoverflow.com/c/expensify/questions/14418 for more details. Please add this bug to a GH project, as outlined in the SO.

[neonbhai]

Proposal

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

Incorrect animation when accessing Referral information page

What is the root cause of that problem?

On the Participants screen we autofocus the text input, which interrupts the animation making it janky. To handle the animations correctly we need it to be a part of screens with autofocus here

It occurs as FocusTrap tries to override the autofocus behavior of the page (for the initialFocus behaviour), causing the animations to be interrupted

App/src/components/FocusTrap/FocusTrapForScreen/index.web.tsx

Lines 50 to 54 in 75c104b

	// We don't want to ovverride autofocus on these screens.
	initialFocus: () => {
	if (SCREENS_WITH_AUTOFOCUS.includes(activeRouteName)) {
	return false;
	}

InitialFocus tries to focus on the first element (which is not the textInput for this page):

We solve a similar issue with sign page in #43985

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

We should add SCREENS.MONEY_REQUEST.STEP_PARTICIPANTS to SCREENS_WITH_AUTOFOCUS

App/src/components/FocusTrap/SCREENS_WITH_AUTOFOCUS.ts

Lines 4 to 13 in 5dc65d0

	const SCREENS_WITH_AUTOFOCUS: string[] = [
	...Object.keys(CENTRAL_PANE_WORKSPACE_SCREENS),
	SCREENS.REPORT,
	SCREENS.REPORT_DESCRIPTION_ROOT,
	SCREENS.PRIVATE_NOTES.EDIT,
	SCREENS.SETTINGS.PROFILE.STATUS,
	SCREENS.SETTINGS.PROFILE.PRONOUNS,
	SCREENS.NEW_TASK.DETAILS,
	SCREENS.MONEY_REQUEST.CREATE,
	];

Result:

This works perfectly:

Screen.Recording.2024-07-03.at.2.21.26.AM.mov

[melvin-bot]

Job added to Upwork: https://www.upwork.com/jobs/~018c7e0a6ee4ee4a2e

[melvin-bot]

Triggered auto assignment to Contributor-plus team member for initial proposal review - @Ollyws (External)

[nkdengineer]

Proposal

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

What is the root cause of that problem?

After we implement the focus trap, the animation can be janky if we navigate to a screen that is not a screen with autofocus in RHP or LHP.

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

We should add the refer page to SCREENS_WITH_AUTOFOCUS

SCREENS.REFERRAL_DETAILS,

https://github.com/nkdengineer/App/blob/3b18d08786c0f8960f2824261350b8ba0244b7bc/src/components/FocusTrap/SCREENS_WITH_AUTOFOCUS.ts#L4

What alternative solutions did you explore? (Optional)

[jnowakow]

It also happens on chat details screens:

rhp-bug.mov

rhp-2.mov

And also on Search:

rhp-3.mov

[Ollyws]

@neonbhai Could you expand the RCA a little, because in the PR that added the focus-trap (#39520) this issue does not occur.

[neonbhai]

@Ollyws hi, I've updated the proposal here

[Ollyws]

@neonbhai Thanks for the update but what I'm asking is, if it wasn't the focus-trap PR that caused this issue...what caused it?

[neonbhai]

Reading through the code says the animation should be interrupted from the focus trap PR itself, since SCREENS_WITH_AUTOFOCUS was created to fix this problem and at the start didn't include our screen.

It took some time but I caught the behaviour on eb3b5389bb (focus trap PR last commit)

Screen.Recording.2024-07-04.at.6.57.52.AM.mp4

Cannot reproduce this at all on ebc8de8 (parent commit to focus trap PR)

cc: @Ollyws

[Ollyws]

Ahh ok thanks @neonbhai, I think what's happened here is that the initial culprit was the focus-trap PR (#39520), but this issue only became visibly apparent after enabling concurrent mode (#42592).

@neonbhai's solution LGTM.
🎀👀🎀 C+ reviewed

[melvin-bot]

Triggered auto assignment to @chiragsalian, see https://stackoverflow.com/c/expensify/questions/7972 for more details.

[Ollyws]

Actually @neonbhai, although it's on the right track your solution doesn't seem to be working:

Screen.Recording.2024-07-04.at.10.50.44.mov

[nkdengineer]

@Ollyws Can you please check my proposal, I tested and it works well.

[Ollyws]

Ah yes SCREENS.REFERRAL_DETAILS, is the correct screen so let's go with @nkdengineer's proposal.

🎀👀🎀 C+ reviewed

[melvin-bot]

Current assignee @chiragsalian is eligible for the choreEngineerContributorManagement assigner, not assigning anyone new.

[melvin-bot]

@Ollyws, @chiragsalian, @lschurr Eep! 4 days overdue now. Issues have feelings too...

[melvin-bot]

📣 @nkdengineer 🎉 An offer has been automatically sent to your Upwork account for the Contributor role 🎉 Thanks for contributing to the Expensify app!

Offer link
Upwork job
Please accept the offer and leave a comment on the Github issue letting us know when we can expect a PR to be ready for review 🧑‍💻
Keep in mind: Code of Conduct | Contributing 📖

[chiragsalian]

Oops not sure how i missed this. @nkdengineer's proposal LGTM. Looks like lauren just assigned the issue to you. Feel free to create a PR 🙂

[nkdengineer]

@Ollyws The PR is here.

[melvin-bot]

Reviewing label has been removed, please complete the "BugZero Checklist".

[melvin-bot]

The solution for this issue has been 🚀 deployed to production 🚀 in version 9.0.8-6 and is now subject to a 7-day regression period 📆. Here is the list of pull requests that resolve this issue:

• prevent initial focus trap while has a focused element. #44932

If no regressions arise, payment will be issued on 2024-07-25. 🎊

For reference, here are some details about the assignees on this issue:

• @Ollyws requires payment through NewDot Manual Requests
• @nkdengineer requires payment automatic offer (Contributor)

[melvin-bot]

BugZero Checklist: The PR fixing this issue has been merged! The following checklist (instructions) will need to be completed before the issue can be closed:

• [@Ollyws] The PR that introduced the bug has been identified. Link to the PR:
• [@Ollyws] The offending PR has been commented on, pointing out the bug it caused and why, so the author and reviewers can learn from the mistake. Link to comment:
• [@Ollyws] A discussion in #expensify-bugs has been started about whether any other steps should be taken (e.g. updating the PR review checklist) in order to catch this type of bug sooner. Link to discussion:
• [@Ollyws] Determine if we should create a regression test for this bug.
• [@Ollyws] If we decide to create a regression test for the bug, please propose the regression test steps to ensure the same bug will not reach production again.
• [@lschurr] Link the GH issue for creating/updating the regression test once above steps have been agreed upon:

[Ollyws]

We're closing the PR because #44932 already fixed the issue while we were working on it. According to the C+ doc section 17 the contributor and C+ are due compensation in this situation, thanks!

[lschurr]

Payment summary:

• Contributor: @nkdengineer $250 (paid in Upwork)
• Reviewer: @Ollyws $250 (to be paid in NewDot)

[Ollyws]

Requested on ND.

[JmillsExpensify]

$250 approved for @Ollyws