[HOLD for payment 2024-12-09] [$250] [Performance] BottomTabBar improve state using Initializer function

[gedu]

Problem

The BottomTabBar component initializes one of its states using the getChatTabBrickRoad function. This function is being called directly within the useState hook, which means it gets executed on every render, even though it only needs to run during the initial state setup.
Current implementation:

const [chatTabBrickRoad, setChatTabBrickRoad] = useState<BrickRoad>(
    getChatTabBrickRoad(activeWorkspaceID, currentReportID, reports, betas, policies, priorityMode, transactionViolations),
);

This approach causes unnecessary re-execution of getChatTabBrickRoad on every render, leading to performance overhead.

Solution

We can pass getChatTabBrickRoad as an initializer function to the useState hook instead. This ensures the function is only executed once during the initial render, improving performance:
Updated implementation:

const [chatTabBrickRoad, setChatTabBrickRoad] = useState<BrickRoad>(() =>
    getChatTabBrickRoad(activeWorkspaceID, currentReportID, reports, betas, policies, priorityMode, transactionViolations),
);

By making this change, the component avoids unnecessary re-execution of getChatTabBrickRoad on every render. This optimization reduces the render time from approximately ±500ms to just 50-100ms, resulting in a more than 5x performance improvement.

Before

After

Issue Owner

Current Issue Owner: @

Upwork Automation - Do Not Edit

• Upwork Job URL: https://www.upwork.com/jobs/~021862478694382529016
• Upwork Job ID: 1862478694382529016
• Last Price Increase: 2024-11-29

Issue Owner

Current Issue Owner: @trjExpensify

[melvin-bot]

Current assignee @mountiny is eligible for the AutoAssignerNewDotQuality assigner, not assigning anyone new.

[gedu]

@mountiny PR created

[mountiny]

$250 to @eVoloshchak

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

[melvin-bot]

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

[melvin-bot]

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

[trjExpensify]

Not sure why an offer wasn't sent to @eVoloshchak there. 🤔

[rezkiy37]

I've created one more issue where I am going to prevent such problems across the entire project - #53322. Also, I am working on a new Eslint rule - Expensify/eslint-config-expensify#138.

cc @gedu @eVoloshchak @mountiny

[mountiny]

Nice thank you!

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

• [Performance] BottomTabBar: Changed to initializer function #53201

If no regressions arise, payment will be issued on 2024-12-09. 🎊

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

• @gedu does not require payment (Contractor)
• @eVoloshchak requires payment through NewDot Manual Requests

[melvin-bot]

@eVoloshchak @trjExpensify @eVoloshchak The PR fixing this issue has been merged! The following checklist (instructions) will need to be completed before the issue can be closed. Please copy/paste the BugZero Checklist from here into a new comment on this GH and complete it. If you have the K2 extension, you can simply click: [this button]

[eVoloshchak]

Not sure why an offer wasn't sent to @eVoloshchak there. 🤔

@trjExpensify, that's because I request payments via NewDot, all good

[trjExpensify]

Ah cool, got it!

[mountiny]

@eVoloshchak can you please complete the checklist?

[melvin-bot]

Payment Summary

Upwork Job

• Contributor: @gedu is from an agency-contributor and not due payment
• Reviewer: @eVoloshchak 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/1862478694382529016/hired)
• I have paid out the Upwork contracts or cancelled the ones that are incorrect
• I have verified the payment summary above is correct

[trjExpensify]

Can we get the checklist here, please? Thanks!

[eVoloshchak]

• The PR that introduced the bug has been identified. Link to the PR: technically this was caused by RBR display in LHN, Inbox and Workspace list #46575, since that's the PR that added this particular initializer function. But this is an app-wide issue (that is being tackled in [HOLD for payment 2024-12-17] [HOLD for payment 2024-12-16] [$250] [Performance] Use initializer callbacks for useState #53322), so there is no particular PR at fault
• 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: N/A
• 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: This is not a bug, but a performance improvement
• Determine if we should create a regression test for this bug: same as above, this is not possible to test for QA

[trjExpensify]

Sounds good to me, thanks! Confirming payment summary as follows:

• $250 to @eVoloshchak for the C+ review.

Go ahead and request!

[JmillsExpensify]

$250 approved for @eVoloshchak