[HOLD for payment 2023-11-09] [$1000] Web - API OpenReport shows after switch away from the app and back

[kbecciv]

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. Log in with any account
2. Open Developer tool - Network
3. Switch away from the app and back

Expected Result:

NO api OpenReport shows after switch away and back

Actual Result:

API OpenReport shows after switch away and back

Workaround:

Unknown

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.72.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
Notes/Photos/Videos: Any additional supporting documentation

Recording.4659.mp4

Expensify/Expensify Issue URL:
Issue reported by: @quinthar
Slack conversation: https://expensify.slack.com/archives/C049HHMV9SM/p1695079219960739

View all open jobs on GitHub

Upwork Automation - Do Not Edit

• Upwork Job URL: https://www.upwork.com/jobs/~014f1c0d7d7d757660
• Upwork Job ID: 1704588615900069888
• Last Price Increase: 2023-10-11
• Automatic offers:
• hoangzinh | Reviewer | 27362270
• saranshbalyan-1234 | Contributor | 27362271

[melvin-bot]

Job added to Upwork: https://www.upwork.com/jobs/~014f1c0d7d7d757660

[melvin-bot]

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

[melvin-bot]

Triggered auto assignment to @laurenreidexpensify (External), see https://stackoverflow.com/c/expensify/questions/8582 for more details.

[melvin-bot]

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

[melvin-bot]

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

[saranshbalyan-1234]

Proposal

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

OpenReport API gets called after switching tabs

What is the root cause of that problem?

We are calling the OpenReport API if visibility changes.

App/src/pages/home/ReportScreen.js

Lines 263 to 280 in 94c07ea

	useFocusEffect(
	useCallback(() => {
	const unsubscribeVisibilityListener = Visibility.onVisibilityChange(() => {
	const isTopMostReportID = Navigation.getTopmostReportId() === getReportID(route);
	// If the report is not fully visible (AKA on small screen devices and LHR is open) or the report is optimistic (AKA not yet created)
	// we don't need to call openReport
	if (!getIsReportFullyVisible(isTopMostReportID) || report.isOptimisticReport) {
	return;
	}
	Report.openReport(report.reportID);
	});
	return () => unsubscribeVisibilityListener();
	// The effect should run only on the first focus to attach listener
	// eslint-disable-next-line react-hooks/exhaustive-deps
	}, []),
	);

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

Based upon the suggestions as per this comment
#27887 (comment)
#27887 (comment)
We are going to remove this code.

Just need to either remove or comment the above code and its working fine.

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

N/A

[abdel-h66]

Proposal

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

OpenReport is called even when the report is already focused.

What is the root cause of that problem?

We are using the useFocusEffect to handle opening a report but this will run every time the repors gets back to view

App/src/pages/home/ReportScreen.js

Lines 263 to 280 in 94c07ea

	useFocusEffect(
	useCallback(() => {
	const unsubscribeVisibilityListener = Visibility.onVisibilityChange(() => {
	const isTopMostReportID = Navigation.getTopmostReportId() === getReportID(route);
	// If the report is not fully visible (AKA on small screen devices and LHR is open) or the report is optimistic (AKA not yet created)
	// we don't need to call openReport
	if (!getIsReportFullyVisible(isTopMostReportID) || report.isOptimisticReport) {
	return;
	}
	Report.openReport(report.reportID);
	});
	return () => unsubscribeVisibilityListener();
	// The effect should run only on the first focus to attach listener
	// eslint-disable-next-line react-hooks/exhaustive-deps
	}, []),
	);

And I think the Report.openReport(report.reportID); called inside the useFocusEffect is a duplicate to fetchReportIfNeeded()

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

I would suggest removing the call Report.openReport(report.reportID);

    useFocusEffect(
        useCallback(() => {
            const unsubscribeVisibilityListener = Visibility.onVisibilityChange(() => {
                const isTopMostReportID = Navigation.getTopmostReportId() === getReportID(route);
                // If the report is not fully visible (AKA on small screen devices and LHR is open) or the report is optimistic (AKA not yet created)
                // we don't need to call openReport
                if (!getIsReportFullyVisible(isTopMostReportID) || report.isOptimisticReport) {
                    return;
                }

              // Remove this call. 
                Report.openReport(report.reportID);
            });

            return () => unsubscribeVisibilityListener();
        }, []),
    );

What alternative solutions did you explore? (Optional)

N/A

[hoangzinh]

Thank you @saranshbalyan-1234 and @abdel-h66 for your proposals.

Both proposals correctly pointed out the LOC that will trigger the OpenReport API command when users switch tabs. But we haven't pointed out the reason why we have those LOCs in the beginning. Without clearing the reason, it will be easy to revert the fix for a bug/requirement that we would like to cover before. Could you please investigate deeper on that? Thanks

[abdel-h66]

Yes that's true @hoangzinh after digging deeper into the previous changes for that part of the code, I found a PR that fixed the following issue.

Switching other app after receiving messages, message will be marked 'read'
#15634

This means that the visibility change subscription serves as a guard against reading messages without actually seeing them so removing it will definitly break this.

As this being said, the issue seemed to appear on mobile only because that's where the getIsReportFullyVisible will return false, with the LHN open.

So that check fixes the report being opened without seeing it, but that doesn't stop the call on devices where the report is already open and visibitly changes.

I found out that adding a third check isTopMostReportID, while keeping the previous one to guard againt a regression will stop the unecessary call to OpenReport on an already open report. The solution. will look something like this.

    useFocusEffect(
        useCallback(() => {
            const unsubscribeVisibilityListener = Visibility.onVisibilityChange(() => {
                const isTopMostReportID = Navigation.getTopmostReportId() === getReportID(route);
                // If the report is not fully visible (AKA on small screen devices and LHR is open) or the report is optimistic (AKA not yet created)
                // we don't need to call openReport
                if (!getIsReportFullyVisible(isTopMostReportID) || report.isOptimisticReport) {
                    return;
                }

                if(isTopMostReportID) {
                    return;
                }


                Report.openReport(report.reportID);
            });

            return () => unsubscribeVisibilityListener();
            // The effect should run only on the first focus to attach listener
            // eslint-disable-next-line react-hooks/exhaustive-deps
        }, []),
    );

[saranshbalyan-1234]

@hoangzinh the isuue is with the useLayoutEffect which is causing api to be called whenever screen is focused,

App/src/pages/home/ReportScreen.js

Lines 262 to 280 in 94c07ea

	useFocusEffect(
	useCallback(() => {
	const unsubscribeVisibilityListener = Visibility.onVisibilityChange(() => {
	const isTopMostReportID = Navigation.getTopmostReportId() === getReportID(route);
	// If the report is not fully visible (AKA on small screen devices and LHR is open) or the report is optimistic (AKA not yet created)
	// we don't need to call openReport
	if (!getIsReportFullyVisible(isTopMostReportID) || report.isOptimisticReport) {
	return;
	}
	Report.openReport(report.reportID);
	});
	return () => unsubscribeVisibilityListener();
	// The effect should run only on the first focus to attach listener
	// eslint-disable-next-line react-hooks/exhaustive-deps
	}, []),
	);

Instead useLayoutEffect we can keep this code in a useEffect which is solving the issue, tested and its working fine with useEffect

[saranshbalyan-1234]

moreover @abdel-h66 's proposed solution is not working

   if(isTopMostReportID) {
                    return;
                }

Thinking moving it to useEffect would make much sense

[abdel-h66]

I just double checked my solution @saranshbalyan-1234 and it seems working just fine 😅 do you have a specific use case where it didn't work I would like to check

[hoangzinh]

@abdel-h66, I don't think it's related to the issue #15634. This issue solved another problem on small screen devices, where the user is still on LHN but the App still marks unread messages as read (just in case you don't know what LHN stands for, please take a look at this doc https://github.com/Expensify/App/blob/main/contributingGuides/CONTRIBUTING.md#guide-on-acronyms-used-within-expensify-communication)

So by introducing the third check as you mentioned

I found out that adding a third check isTopMostReportID,

AFAIK, the below code will never be called. Because in Web, we always open a report => isTopMostReportID always has value, so it's the same as we remove the App visible callback as described in your proposal.

I just checked, your third check of isTopMostReportID is a conjunction of 2nd check here so the below code will never be called

[hoangzinh]

@saranshbalyan-1234 I don't think it's related to useLayoutEffect hook, because this hook is only used to register the App visible callback Visibility.onVisibilityChange when the Report screen is focused back. Moreover, I tried to test your suggestion but it still calls OpenReport API when switching tabs

[saranshbalyan-1234]

after removing cache, my proposal did not work, my bad!

[melvin-bot]

@garrettmknight, @hoangzinh Whoops! This issue is 2 days overdue. Let's get this updated quick!

[garrettmknight]

@abdel-h66 can you update your solution with @hoangzinh's feedback?

[abdel-h66]

Yes @garrettmknight I still didnt have time for a second look on this one, I will update here once I try something different

[saranshbalyan-1234]

@marcaaron sure will update it soon, Thank you for the offer

[saranshbalyan-1234]

PR raised, please check @hoangzinh @marcaaron

[saranshbalyan-1234]

creating a new PR due to conflicts, sorry for inconvienience

[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 1.3.94-2 and is now subject to a 7-day regression period 📆. Here is the list of pull requests that resolve this issue:

• Remove openreport api calls while switching windows #30572

If no regressions arise, payment will be issued on 2023-11-09. 🎊

After the hold period is over and BZ checklist items are completed, please complete any of the applicable payments for this issue, and check them off once done.

• External issue reporter
• Contributor that fixed the issue
• Contributor+ that helped on the issue and/or PR

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

• @hoangzinh requires payment offer (Reviewer)
• @saranshbalyan-1234 requires payment 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:

• [@hoangzinh] The PR that introduced the bug has been identified. Link to the PR:
• [@hoangzinh] 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:
• [@hoangzinh] 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:
• [@hoangzinh] Determine if we should create a regression test for this bug.
• [@hoangzinh] 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.
• [@garrettmknight] Link the GH issue for creating/updating the regression test once above steps have been agreed upon:

[garrettmknight]

Summarizing payments:

• Urgency bonus: No
• Contributor: @saranshbalyan-1234 $1000 paid via Upwork
• Reviewer: @hoangzinh $1000 paid via upwork

@hoangzinh can you get to the checklist when you get a chance

[hoangzinh]

BugZero Checklist:

• The PR that introduced the bug has been identified. Link to the PR: Refactor Update Last Read #9529
• 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: 🚫 According to the comment here [HOLD for payment 2023-11-09] [$1000] Web - API OpenReport shows after switch away from the app and back #27887 (comment), I think it's not a regression bug, but it's about design purpose at this time.
• 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: N/A
• Determine if we should create a regression test for this bug ⛔ Nope, it's just a perf improvement, removing a redundant API call when switching the browser tab.

[garrettmknight]

Nice one, closing!