[HOLD for payment 2024-10-14] [HOLD for payment 2024-10-11] Categories - Settings RHP shows spinner briefly when it is opened

[IuliiaHerets]

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.44-3
Reproducible in staging?: Y
Reproducible in production?: N
If this was caught during regression testing, add the test name, ID and link from TestRail: [email protected]
Issue reported by: Applause Internal Team

Action Performed:

1. Go to staging.new.expensify.com
2. Go to workspace settings > Categories.
3. Click Settings.

Expected Result:

Settings RHP will open smoothly without loading (production behavior).

Actual Result:

Settings RHP shows spinner briefly when it is opened.

Workaround:

Unknown

Platforms:

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

Screenshots/Videos

Bug6623627_1727985127710.20241004_035010.mp4

View all open jobs on GitHub

Issue Owner

Current Issue Owner: @trjExpensify

[melvin-bot]

Triggered auto assignment to @iwiznia (DeployBlockerCash), see https://stackoverflowteams.com/c/expensify/questions/9980/ for more details.

[melvin-bot]

Triggered auto assignment to @trjExpensify (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.

[IuliiaHerets]

We think that this bug might be related to #wave-control

[github-actions]

👋 Friendly reminder that deploy blockers are time-sensitive ⏱ issues! Check out the open `StagingDeployCash` deploy checklist to see the list of PRs included in this release, then work quickly to do one of the following:

1. Identify the pull request that introduced this issue and revert it.
2. Find someone who can quickly fix the issue.
3. Fix the issue yourself.

[bernhardoj]

Edited by proposal-police: This proposal was edited at 2024-10-04 09:05:04 UTC.

Proposal

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

The categories settings always shows loading indicator when opening it.

What is the root cause of that problem?

The page is wrapped with a withPolicyConnections HOC. The loading will show if the data needs to be fetched.

App/src/pages/workspace/withPolicyConnections.tsx

Lines 34 to 35 in f83b69e

	const isConnectionDataFetchNeeded =
	!isOffline && !!props.policy && (!!props.policy.areConnectionsEnabled || !isEmptyObject(props.policy.connections)) && !hasConnectionsDataBeenFetched;

In our case, hasConnectionsDataBeenFetched is always undefined initially. That's because we set the initWithStoredValues as false here.

App/src/pages/workspace/withPolicyConnections.tsx

Lines 31 to 33 in f83b69e

	const [hasConnectionsDataBeenFetched] = useOnyx(`${ONYXKEYS.COLLECTION.POLICY_HAS_CONNECTIONS_DATA_BEEN_FETCHED}${props.policy?.id ?? '-1'}`, {
	initWithStoredValues: false,
	});

This happens after we fix a useOnyx issue where initWithStoredValues doesn't work as intended here. Even though this happens after the Onyx update, the root cause of the issue already exists before.

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

Remove the initWithStoredValues setting so we get the saved value.

Also, prevent the fetching if the onyx data is still loading.

const [hasConnectionsDataBeenFetched, hasConnectionsDataBeenFetchedResult] = useOnyx(`${ONYXKEYS.COLLECTION.POLICY_HAS_CONNECTIONS_DATA_BEEN_FETCHED}${props.policy?.id ?? '-1'}`);
const isOnyxDataLoading = isLoadingOnyxValue(hasConnectionsDataBeenFetchedResult);
const isConnectionDataFetchNeeded =
    !isOnyxDataLoading && !isOffline && !!props.policy && (!!props.policy.areConnectionsEnabled || !isEmptyObject(props.policy.connections)) && !hasConnectionsDataBeenFetched;

or we can just show the loading if the onyx data is still loading.

[iwiznia]

Proposal looks good.

[bernhardoj]

PR is ready

[isagoico]

Unable to reproduce on latest build v9.0.44-10. RHP opens and displays content right away 🎉

[trjExpensify]

Great! Adding @fedirjh for the review.

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

• [CP Staging] Fix categories settings page always show loader when open the page #50226

If no regressions arise, payment will be issued on 2024-10-11. 🎊

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

• @fedirjh requires payment through NewDot Manual Requests
• @bernhardoj requires payment through NewDot Manual Requests

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

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

[melvin-bot]

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

• [CP Staging] Fix categories settings page always show loader when open the page #50226

If no regressions arise, payment will be issued on 2024-10-14. 🎊

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

• @fedirjh requires payment through NewDot Manual Requests
• @bernhardoj requires payment through NewDot Manual Requests

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

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

[melvin-bot]

Payment Summary

Upwork Job

• Reviewer: @fedirjh owed $250 via NewDot
• Reviewer: @bernhardoj owed $250 via NewDot

BugZero Checklist (@trjExpensify)

• I have verified the correct assignees and roles are listed above and updated the neccesary manual offers
• I have verified that there are no duplicate or incorrect contracts on Upwork for this job (https://www.upwork.com/ab/applicants//hired)
• I have paid out the Upwork contracts or cancelled the ones that are incorrect
• I have verified the payment summary above is correct

[melvin-bot]

@iwiznia, @trjExpensify, @fedirjh, @bernhardoj Uh oh! This issue is overdue by 2 days. Don't forget to update your issues!

[bernhardoj]

Requested in ND.

[fedirjh]

BugZero Checklist:

• Link to the PR: Bump Onyx to v2.0.71 #49857
• Link to discussion: N/A Nothing to add to checklist
• Determine if we should create a regression test for this bug:

Regression Test Proposal

1. Open App 
2. Go to workspace settings -> Categories
3. Click Settings
4. Verify Settings RHP will open smoothly without loading indicator

• Do we agree 👍 or 👎

[trjExpensify]

Confirming payment summary as follows:

• $250 to @fedirjh for the C+ review
• $250 to @bernhardoj for the fix

Both to be paid via ND!

[bernhardoj]

Requested in ND.

[trjExpensify]

As for the regression test, we have this one in TestRail. Instead of a brand new test, I think we can just add the 4th point from above to that test.

[trjExpensify]

^^ created an issue for that, closing!

[JmillsExpensify]

$250 approved for @bernhardoj

[garrettmknight]

$250 approved for @fedirjh