[HOLD for payment 2023-08-21] [$1000] App crashes when deleting workspace while in offline mode

[kavimuru]

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. Open ND
2. Create 5 workspaces & make sure you have 5 active workspaces
3. Apply offline network mode in dev tools
4. Delete 2 workspaces in offline mode
5. Close RHN > click on 'Profile' avatar & navigate to Settings page
6. Apply 'No throttling' in dev tools while 'Settings' page is opened

Expected Result:

App shouldn't crash

Actual Result:

App crashes

Workaround:

Can the user still use Expensify without this being fixed? Have you informed them of the workaround?

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.49-0
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.1435.mp4

Expensify/Expensify Issue URL:
Issue reported by: @Natnael-Guchima
Slack conversation: https://expensify.slack.com/archives/C049HHMV9SM/p1690459285350399

View all open jobs on GitHub

Upwork Automation - Do Not Edit

• Upwork Job URL: https://www.upwork.com/jobs/~01ab283e641a86aa39
• Upwork Job ID: 1688971711391633408
• Last Price Increase: 2023-08-08
• Automatic offers:
• fedirjh | Reviewer | 26028363
• s-alves10 | Contributor | 26028364
• natnael-guchima | Reporter | 26028365

[melvin-bot]

Triggered auto assignment to @sonialiap (Bug), see https://stackoverflow.com/c/expensify/questions/14418 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

[Natnael-Guchima]

Video to reproduce the issue.

Screencast.from.2023-08-02.19-13-38.mp4

[Pujan92]

Proposal

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

App crashes when deleting the workspaces(from more than 4 to 4 or less) offline and turns to online

What is the root cause of that problem?

For showing the extra number of items overlay in MultipleAvatars we are using a condition here with the avatars.length and inside that block for one of the styles we used props.icons[3] here.

App/src/components/MultipleAvatars.js

Line 197 in cf4e837

{avatars.length > props.maxAvatarsInRow && (

The issue is props.icons we received from the parent and on the deletion of the workspace items props.icons will be reduced/updated. But on the other side avatarRows won't be updated immediately as it needs to be calculated from the useEffect block here and that leads to the error of accessing field type of undefined.

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

We need to use avatars[3].type instead of props.icons[3].type as that we used for the rendering of the extra number of items overlay.

App/src/components/MultipleAvatars.js

Line 216 in cf4e837

props.icons[3].type === CONST.ICON_TYPE_WORKSPACE ? StyleUtils.getAvatarBorderRadius(props.size, props.icons[3].type) : {},

[namhihi237]

Proposal

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

The app shouldn't crash

What is the root cause of that problem?

When online we have 5 icons then this code is correct.

App/src/components/MultipleAvatars.js

Line 216 in 615c8a1

props.icons[3].type === CONST.ICON_TYPE_WORKSPACE ? StyleUtils.getAvatarBorderRadius(props.size, props.icons[3].type) : {},

But after deleting 2 items, on the setting side, we still show 5 workspaces here. When back online, the new workspace is deleted resulting in props.icons with only 3 items but the change here useEffect will update avatarRows again later resulting in props.icons[3] undefined causing the crash.

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

We can use avatars.
Also we should use props.maxAvatarsInRow - 1 instead of hard 3.

avatars[props.maxAvatarsInRow -1].type === CONST.ICON_TYPE_WORKSPACE ? StyleUtils.getAvatarBorderRadius(props.size, avatars[props.maxAvatarsInRow - 1].type) : {},

What alternative solutions did you explore? (Optional)

props.icons.length > props.maxAvatarsInRow -1 && props.icons[props.maxAvatarsInRow -1].type === CONST.ICON_TYPE_WORKSPACE ? StyleUtils.getAvatarBorderRadius(props.size, props.icons[props.maxAvatarsInRow -1].type) : {},

[s-alves10]

Proposal

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

App crashes when deleting workspaces in offline mode and back to online

What is the root cause of that problem?

After deleting 2 workspaces and go to settings page, we have 5 workspaces including pending deletion. So MultipleAvatar component shows 5 icons.
When switching to online mode, 2 workspaces are deleted and props.icons would have length 3. As you know, useEffect is called after rendering if at least one of its dependencies changes. So at the first rendering after props.icons is changed, props.icons.length = 3, and avatars.length = 5. This causes the app crash

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

We have to synchronize the avatarRows data and props.icons. This is impossible using useEffect due to its nature.
This is the perfect use case of useMemo.

Remove the useState and useEffect and combine them into one useMemo

    const avatarRows = useMemo(() => {
        if (!props.shouldDisplayAvatarsInRows || props.icons.length <= props.maxAvatarsInRow) {
            return [props.icons];
        }

        // Calculate the size of each row
        const rowSize = Math.min(Math.ceil(props.icons.length / 2), props.maxAvatarsInRow);

        // Slice the icons array into two rows
        const firstRow = props.icons.slice(rowSize);
        const secondRow = props.icons.slice(0, rowSize);

        // Update the state with the two rows as an array
        return [firstRow, secondRow];
    }, [props.icons, props.maxAvatarsInRow, props.shouldDisplayAvatarsInRows]);

This way, we can sync the avatarRows and props.icons

Result

24062.mp4

What alternative solutions did you explore? (Optional)

[melvin-bot]

@sonialiap Eep! 4 days overdue now. Issues have feelings too...

[sonialiap]

Triaging to external

[melvin-bot]

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

[melvin-bot]

Current assignee @sonialiap is eligible for the External assigner, not assigning anyone new.

[melvin-bot]

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

[fedirjh]

I think @s-alves10's proposal makes sense to me, it appears to fix the root cause. This bug seems to arise from recent functional refactor.

🎀 👀 🎀 C+ reviewed

[melvin-bot]

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

[melvin-bot]

📣 @fedirjh 🎉 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]

📣 @s-alves10 🎉 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]

📣 @Natnael-Guchima 🎉 An offer has been automatically sent to your Upwork account for the Reporter role 🎉 Thanks for contributing to the Expensify app!

Offer link
Upwork job

[s-alves10]

Thank you
I'll create a PR in a few hours

[s-alves10]

@fedirjh

PR is ready for review

[melvin-bot]

🎯 ⚡️ Woah @fedirjh / @s-alves10, great job pushing this forwards! ⚡️

The pull request got merged within 3 working days of assignment, so this job is eligible for a 50% #urgency bonus 🎉

• when @s-alves10 got assigned: 2023-08-09 12:46:07 Z
• when the PR got merged: 2023-08-10 08:52:30 UTC

On to the next one 🚀

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

• fix: sync avatarRows and props.icons using useMemo #24318

If no regressions arise, payment will be issued on 2023-08-21. 🎊

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:

• @fedirjh requires payment offer (Reviewer)
• @s-alves10 requires payment offer (Contributor)

As a reminder, here are the bonuses/penalties that should be applied for any External issue:

• Merged PR within 3 business days of assignment - 50% bonus
• Merged PR more than 9 business days after assignment - 50% penalty

[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.
• [@sonialiap] Link the GH issue for creating/updating the regression test once above steps have been agreed upon:

[techievivek]

Not overdue, waiting for payment to be done.

[fedirjh]

BugZero Checklist:

• Link to the PR: DMs to show all avatars #21402
• Link to comment: DMs to show all avatars #21402 (comment)
• Link to discussion: https://expensify.slack.com/archives/C01GTK53T8Q/p1692798130077389
• Determine if we should create a regression test for this bug

---

Regression Test Proposal

1. Open App
2. Create 5 workspaces or make sure you have 5 active workspaces
3. Go offline
4. Delete 2 workspaces
5. Close RHN and click Profile avatar to go to the settings page
6. Go online
7. Verify that the app doesn't crash and 3 workspaces are left

• Do we agree 👍 or 👎

[techievivek]

Regression test proposal looks good to me, let's wait for @sonialiap to get this added to the testRail.

[sonialiap]

Sorry for the delay, back from OOO and sending payments:

• @Natnael-Guchima bug report $250
• @s-alves10 fix + bonus $1500
• @fedirjh review + bonus $1500