[$250] Troubleshoot - Use staging server option is disabled upon logging in and after clearing cache

[izarutskaya]

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.79-0
Reproducible in staging?: Yes
Reproducible in production?: Unable to check as it testing preference
If this was caught on HybridApp, is this reproducible on New Expensify Standalone?: No, reproducible on hybrid only
If this was caught during regression testing, add the test name, ID and link from TestRail: https://expensify.testrail.io/index.php?/cases/view/2761712
Email or phone of affected tester (no customers): N/A
Issue reported by: Applause Internal Team
Device used: iPhone 15 iOS 18.1.1
App Component: User Settings

Action Performed:

1. Open staging Hybrid app and log in
2. Navigate to Settings/ Troubleshoot
3. Scroll down to the Use staging server option and verify if it is enabled
4. Enable the option manually
5. In the Troubleshoot tap Clear cache and restart, then Reset and refresh
6. Check the Use staging server option toggle position

Expected Result:

Use staging server option is enabled automatically upon log in and remains enabled after clearing cache

Actual Result:

Use staging server option is disabled upon logging in and after clearing cache

Workaround:

Unknown

Platforms:

• Android: Standalone
• Android: HybridApp
• Android: mWeb Chrome
• iOS: Standalone
• iOS: HybridApp
• iOS: mWeb Safari
• MacOS: Chrome / Safari
• MacOS: Desktop

Screenshots/Videos

Bug6701433_1734979627116.ScreenRecording_12-23-2024_10-27-31_1.mp4

View all open jobs on GitHub

Upwork Automation - Do Not Edit

• Upwork Job URL: https://www.upwork.com/jobs/~021872694579402665672
• Upwork Job ID: 1872694579402665672
• Last Price Increase: 2024-12-27

Issue Owner

Current Issue Owner: @allgandalf

[melvin-bot]

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

[melvin-bot]

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

[melvin-bot]

💬 A slack conversation has been started in #expensify-open-source

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

[melvin-bot]

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

[melvin-bot]

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

[carlosmiceli]

Removing DB since it's a staging issue, but I'm not 100% sure it can be solved by contributors. Adding the label so we get confirmation.

[ikevin127]

Edited by proposal-police: This proposal was edited at 2024-12-28 00:22:34 UTC.

Proposal

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

Use staging server option is disabled upon logging in and after clearing cache.

What is the root cause of that problem?

Note

The issue is present on all platform, it's not specific to HybridApp.

This happens because shouldUseStagingServer boolean is stored in ONYXKEYS.USER key (see reference) and when Clear cache and restart is executed, clearOnyxAndResetApp is called here which clears onyx storage except for KEYS_TO_PRESERVE which doesn't include ONYXKEYS.USER where shouldUseStagingServer boolean is stored.

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

Preserve ONYXKEYS.USER object key shouldUseStagingServer and its value such that Use Staging Server option remains toggled ON after Clear cache and restart is executed in case it was ON before.

One way to execute this is to only preserve shouldUseStagingServer from ONYXKEYS.USER:

• In App.ts where clearOnyxAndResetApp is located, extract and preserve shouldUseStagingServer similar to what was done here with preservedUserSession, and just like here, preserve shouldUseStagingServer which we would write like this:

// top of `App.ts` under `preservedUserSession` logic:
let preservedShouldUseStagingServer: boolean | undefined;
Onyx.connect({
    key: ONYXKEYS.USER,
    callback: (value) => {
        preservedShouldUseStagingServer = value?.shouldUseStagingServer;
    },
});

// above Onyx.clear(KEYS_TO_PRESERVE) block:
const shouldUseStagingServer = preservedShouldUseStagingServer; // <- we do this because `let preservedShouldUseStagingServer` will be lost once Onyx is cleared, so we need to store it in a constant before clearing (below)

// within the `clearOnyxAndResetApp` function, inside the Onyx.clear(KEYS_TO_PRESERVE) block:
if (shouldUseStagingServer) {
    Onyx.set(ONYXKEYS.USER, {shouldUseStagingServer});
}

What specific scenarios should we cover in automated tests to prevent reintroducing this issue in the future?

We can test that after clearOnyxAndResetApp was called, ONYXKEYS.USER object with key shouldUseStagingServer is preserved.

What alternative solutions did you explore? (Optional)

An alternative way to execute this would be to preserve the whole ONYXKEYS.USER object:

• which can contain multiple key / values that we might not want to preserve:

{
    isUsingExpensifyCard: false,
    isFromPublicDomain: true,
    hasAccessibleDomainPolicies: false,
    isGuide: false,
    isSubscribedToNewsletter: true,
    shouldUseStagingServer: true, // <- this one is of interest to us for this issue
    validated: false,
}

to do this we would simply pass ONYXKEYS.USER here to KEYS_TO_PRESERVE.

Result video (before / after)

MacOS: Chrome

Before	After
before.mov	after.mov