[HOLD for payment 2024-05-02] [$250] Track expense - Track expense shortcut doesn't update to the correct one in offline mode

[izarutskaya]

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

---

Version Number: 1.4.62-0
Reproducible in staging?: Y
Reproducible in production?: Y
Logs: https://stackoverflow.com/c/expensify/questions/4856
Issue reported by: Applause-Internal team

Action Performed:

1. Navigate to staging.new.expensify.com
2. Track a distance expense
3. Go offline
4. Track a manual expense
5. Click on FAB and observe the shortcut
6. Go online and do step 5 again

Expected Result:

The shortcut should update to track expense (previously was "track distance").

Actual Result:

Shortcut doesn't update to the recent track action if user is offline

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

Bug6445682_1712828866766.bandicam_2024-04-11_12-41-14-620.mp4

View all open jobs on GitHub

Upwork Automation - Do Not Edit

• Upwork Job URL: https://www.upwork.com/jobs/~01a0bd1968ee14fdd2
• Upwork Job ID: 1778795114726465536
• Last Price Increase: 2024-04-12
• Automatic offers:
• ikevin127 | Reviewer | 0
• nkdengineer | Contributor | 0

Issue Owner

Current Issue Owner: @sonialiap

[melvin-bot]

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

[izarutskaya]

We think this issue might be related to the #collect project.

[nkdengineer]

Proposal

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

Shortcut doesn't update to the recent track action if user is offline

What is the root cause of that problem?

In buildOnyxDataForTrackExpense, we don't update the optimistic data of QAB to trackExpense action. After TrackExpense API is complete, BE returns QAB data as trackExpense action. That is the reason why in offline, QAB doesn't update when we create a track expense.

App/src/libs/actions/IOU.ts

Line 808 in 91a01a7

function buildOnyxDataForTrackExpense(

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

In buildOnyxDataForTrackExpense function, we should update optimistic data of QAB as trackExpense action

const isScanRequest = TransactionUtils.isScanRequest(transaction);
const isDistanceRequest = TransactionUtils.isDistanceRequest(transaction);
let newQuickAction: ValueOf<typeof CONST.QUICK_ACTIONS> = CONST.QUICK_ACTIONS.TRACK_MANUAL;
if (isScanRequest) {
    newQuickAction = CONST.QUICK_ACTIONS.TRACK_SCAN
} else if (isDistanceRequest) {
    newQuickAction = CONST.QUICK_ACTIONS.TRACK_DISTANCE
}
optimisticData.push({
    onyxMethod: Onyx.METHOD.SET,
    key: ONYXKEYS.NVP_QUICK_ACTION_GLOBAL_CREATE,
    value: {
        action: newQuickAction,
        chatReportID: chatReport?.reportID,
        isFirstQuickAction: isEmptyObject(quickAction),
    },
});

App/src/libs/actions/IOU.ts

Line 808 in 91a01a7

function buildOnyxDataForTrackExpense(

Actually when we click on QAB of track expense, nothing happens because we don't have any case for track expense. It's a known issue and we're handling it in another issue.

App/src/pages/home/sidebar/SidebarScreen/FloatingActionButtonAndPopover.tsx

Line 158 in 91a01a7

const navigateToQuickAction = () => {

What alternative solutions did you explore? (Optional)

NA

[allgandalf]

Proposal

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

Shortcut for track expense doesn't update when we track any expense in offline mode

What is the root cause of that problem?

We do not set quickAction optimistically in buildOnyxDataForTrackExpense and hence when offline, the value isn't stored in onyx and not updated in Quick Action :

App/src/libs/actions/IOU.ts

Line 808 in 91a01a7

function buildOnyxDataForTrackExpense(

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

We need to define newQuickAction in buildOnyxDataForTrackExpense which takes values based on the type of the Track Expense Request and set it accordingly optimistically in Onyx:

    let newQuickAction: ValueOf<typeof CONST.QUICK_ACTIONS> = isScanRequest ? CONST.QUICK_ACTIONS.TRACK_SCAN : CONST.QUICK_ACTIONS.TRACK_MANUAL;

    if (TransactionUtils.isDistanceRequest(transaction)) {
        newQuickAction = CONST.QUICK_ACTIONS.TRACK_DISTANCE;
    }

    optimisticData.push({
        onyxMethod: Onyx.METHOD.SET,
        key: ONYXKEYS.NVP_QUICK_ACTION_GLOBAL_CREATE,
        value: {
            action: newQuickAction,
            chatReportID: chatReport?.reportID,
            isFirstQuickAction: isEmptyObject(quickAction),
        },
    });
    

What alternative solutions did you explore? (Optional)

[melvin-bot]

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

[melvin-bot]

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

[sonialiap]

@ikevin127 what do you think of the proposals?

[ikevin127]

I'm reviewing the proposals, will get back with a response soon (today)!

[ikevin127]

@nkdengineer's proposal LGTM. It was the first proposal to point out the correct RCA and solution.

🎀👀🎀 C+ reviewed

[melvin-bot]

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

[allgandalf]

opps, I guess my GitHub didn't update at the time of posting my proposal, I saw that no proposal was above me at that time 😆 sorry for the extra work @ikevin127

[ikevin127]

@GandalfGwaihir Your RCA and solution are correct, but the selected proposal was the first to point them out. Additionally, your proposed solution does not bring a significant change compared to the selected proposal as it's simply a slightly different way of writing the code which in essence is doing the same thing.

opps, I guess my GitHub didn't update at the time of posting my proposal, I saw that no proposal was above me at that time 😆 sorry for the extra work @ikevin127

No worries! 😁

[marcochavezf]

Thanks for the review @ikevin127, assigning @nkdengineer 🚀

[melvin-bot]

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

Offer link
Upwork job

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

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

• fix: Track expense shortcut doesn't update to the correct one in offline mode #40267

If no regressions arise, payment will be issued on 2024-05-02. 🎊

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

• @ikevin127 requires payment automatic offer (Reviewer)
• @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:

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

[ikevin127]

• [@ikevin127] The PR that introduced the bug has been identified. Link to the PR: Track Expense flow #37282
• [@ikevin127] 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: Track Expense flow #37282 (comment)
• [@ikevin127] 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.

No need to start a discussion on this since we already have a checkbox within the PR review checklist related to testing while offline for both PR author and reviewer:

• I turned off my network connection and tested it while offline to ensure it matches the expected behavior (i.e. verify the default avatar icon is displayed if app is offline)

• [@ikevin127] Determine if we should create a regression test for this bug.
• [@ikevin127] 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.

Regression Test Proposal

1. Navigate to staging.new.expensify.com.
2. Click on FAB > Track expense > Distance > submit Track expense.
3. Click on FAB and ensure that Track distance shortcut is shown indicating most recent Distance expense tracking.
4. Go offline.
5. Click on FAB > Track expense > Manual > submit Track expense.
6. Click on FAB and ensure that Track expense shortcut is shown indicating most recent Manual expense tracking.

Do we agree 👍 or 👎

[sonialiap]

@ikevin127 $250 paid ✔️
@nkdengineer $250 paid ✔️