[HOLD for payment 2023-08-10] [$1000] Web - Workspace name is empty in request money page

[kbecciv]

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:

Requirement: have policy expense chat beta access and a workspace

1. Press FAB and choose Request Money
2. Enter any amount and press Next
3. Search your workspace and select it as the participant
4. Verify you are brought to the confirmation page

Expected Result:

Workspace name is shown on the confirmation page

Actual Result:

Workspace name is not shown on the confirmation page

Workaround:

Unknown

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.43-3
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

Screen.Recording.2023-07-21.at.00.34.09.mov

Recording.3802.mp4

Expensify/Expensify Issue URL:
Issue reported by: @bernhardoj
Slack conversation: https://expensify.slack.com/archives/C049HHMV9SM/p1689870865032739

View all open jobs on GitHub

Upwork Automation - Do Not Edit

• Upwork Job URL: https://www.upwork.com/jobs/~011f529c8226628bb0
• Upwork Job ID: 1683692732773302272
2023-07-25
• Automatic offers:
• s77rt | Reviewer | 25818805
• bernhardoj | Contributor | 25818806
• bernhardoj | Reporter | 25818807

[melvin-bot]

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

[kbecciv]

Proposal

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

Workspace name is empty on money request confirmation page

What is the root cause of that problem?

The confirmation list item is OptionRow and the title (that should show the workspace name) is retrieved from this.props.option.text. The option props data that is shown (for the workspace) on the confirmation page comes from OptionListUtils.getPolicyExpenseReportOptions.

App/src/libs/OptionsListUtils.js

Lines 118 to 125 in be2c81f

	function getPolicyExpenseReportOptions(report) {
	const expenseReport = policyExpenseReports[`${ONYXKEYS.COLLECTION.REPORT}${report.reportID}`];
	const policyExpenseChatAvatarSource = ReportUtils.getWorkspaceAvatar(expenseReport);
	return [
	{
	...expenseReport,
	keyForList: expenseReport.policyID,
	text: expenseReport.displayName,

We can see that we return text with the value from expenseReport.displayName and it's been like this for a f few months. The problem is, the displayName property does not exist on a report. This might raise a question, if it doesn't exist, why do we just see the issue now? Why it works just fine before?
Short: The answer is, this issue started to happen after this PR #21406.
Long:
Before the above PR, we can access displayName from a report object. The displayName is available because we are mutating the Onyx report object here:

App/src/libs/SidebarUtils.js

Lines 122 to 131 in be2c81f

	_.each(reportsToDisplay, (report) => {
	// Normally, the spread operator would be used here to clone the report and prevent the need to reassign the params.
	// However, this code needs to be very performant to handle thousands of reports, so in the interest of speed, we're just going to disable this lint rule and add
	// the reportDisplayName property to the report object directly.
	// eslint-disable-next-line no-param-reassign
	report.displayName = ReportUtils.getReportName(report);
	// eslint-disable-next-line no-param-reassign
	report.iouReportAmount = ReportUtils.getMoneyRequestTotal(report, allReportsDict);
	});

We are still mutating it now, the difference is, the report object we are mutating is the cloned report. If you notice the code above, we are mutating the reportsToDisplay that is the filtered allReportsDict.

App/src/libs/SidebarUtils.js

Lines 105 to 112 in be2c81f

	function getOrderedReportIDs(currentReportId, allReportsDict, betas, policies, priorityMode, allReportActions) {
	const isInGSDMode = priorityMode === CONST.PRIORITY_MODE.GSD;
	const isInDefaultMode = !isInGSDMode;
	// Filter out all the reports that shouldn't be displayed
	const reportsToDisplay = _.filter(allReportsDict, (report) =>
	ReportUtils.shouldReportBeInOptionList(report, currentReportId, isInGSDMode, allReportsDict, betas, policies, allReportActions),
	);

allReportsDict is passed from SidebarLinksData, which is the chatReports as you can see below.

App/src/pages/home/sidebar/SidebarLinksData.js

Lines 71 to 72 in be2c81f

	const optionListItems = useMemo(() => {
	const reportIDs = SidebarUtils.getOrderedReportIDs(currentReportID, chatReports, betas, policies, priorityMode, allReportActions);

chatReports comes from the Onyx with a selector.

App/src/pages/home/sidebar/SidebarLinksData.js

Lines 177 to 180 in be2c81f

	chatReports: {
	key: ONYXKEYS.COLLECTION.REPORT,
	selector: chatReportSelector,
	},

The selector is the one that clones the object.

App/src/pages/home/sidebar/SidebarLinksData.js

Lines 112 to 145 in be2c81f

	const chatReportSelector = (report) =>
	report && {
	reportID: report.reportID,
	participants: report.participants,
	participantAccountIDs: report.participantAccountIDs,
	hasDraft: report.hasDraft,
	isPinned: report.isPinned,
	errorFields: {
	addWorkspaceRoom: report.errorFields && report.errorFields.addWorkspaceRoom,
	},
	lastMessageText: report.lastMessageText,
	lastVisibleActionCreated: report.lastVisibleActionCreated,
	iouReportID: report.iouReportID,
	total: report.total,
	hasOutstandingIOU: report.hasOutstandingIOU,
	statusNum: report.statusNum,
	stateNum: report.stateNum,
	chatType: report.chatType,
	type: report.type,
	policyID: report.policyID,
	visibility: report.visibility,
	lastReadTime: report.lastReadTime,
	// Needed for name sorting:
	reportName: report.reportName,
	policyName: report.policyName,
	oldPolicyName: report.oldPolicyName,
	// Other less obvious properites considered for sorting:
	ownerAccountID: report.ownerAccountID,
	currency: report.currency,
	managerID: report.managerID,
	// Other important less obivous properties for filtering:
	parentReportActionID: report.parentReportActionID,
	parentReportID: report.parentReportID,
	};

Previously, reportsToDisplay comes directly from the report object, that is allReports.

App/src/libs/SidebarUtils.js

Lines 28 to 33 in be2c81f

	let allReports;
	Onyx.connect({
	key: ONYXKEYS.COLLECTION.REPORT,
	waitForCollectionCallback: true,
	callback: (val) => (allReports = val),
	});

That's why before the PR, mutating the report object will have an effect on every part of the app that uses the object.
So, the current code mutates the cloned object, while the previous code mutates the real object.
NOTE: even though the issue happens after #21406, I wouldn't say it's a regression, but rather we are discovering a hidden bug.

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

Never use the displayName property. We also have another issue #22128 that also avoids it now.
Instead, get the name from ReportUtils.getReportName(expenseReport).
We will use the result for both text and name inside the icons array.

[melvin-bot]

@kadiealexander Uh oh! This issue is overdue by 2 days. Don't forget to update your issues!

[kadiealexander]

Reproduced

[melvin-bot]

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

[melvin-bot]

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

[melvin-bot]

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

[s77rt]

@bernhardoj Thanks for the proposal. Your RCA is correct and the solution looks good to me. The displayName prop is not a real prop after all (it's a client-side only). The use of ReportUtils.getReportName makes sense here. But before moving forward, can you please check if we can improve this loop, instead of assigning displayName and iouReportAmount to report we should use local variables to prevent this kind of bug.

[bernhardoj]

Hmm, I don't know what the local variables would look like. One idea I could think of is to introduce a new object that stored both displayName and iouReportAmount.

const reports = {};
// There are a few properties that need to be calculated for the report which are used when sorting reports.
_.each(reportsToDisplay, (report) => {
    reports[report.reportID] = {
        displayName: ReportUtils.getReportName(report),
        iouReportAmount: ReportUtils.getMoneyRequestTotal(report, allReportsDict),
    }
});

and then in the sort below we can do like:

-pinnedReports = _.sortBy(pinnedReports, (report) => report.displayName.toLowerCase());
-outstandingIOUReports = lodashOrderBy(outstandingIOUReports, ['iouReportAmount', (report) => report.displayName.toLowerCase()], ['desc', 'asc']);
+pinnedReports = _.sortBy(pinnedReports, (report) => reports[report.reportID].displayName.toLowerCase());
+outstandingIOUReports = lodashOrderBy(outstandingIOUReports, [(report) => reports[report.reportID].iouReportAmount, (report) => reports[report.reportID].displayName.toLowerCase()], ['desc', 'asc']);
and so on...

haven't tested it yet.

[s77rt]

@bernhardoj Thanks for the update. Given that getOrderedReportIDs is only called once on the cloned object let's not worry about that reassignment.

🎀 👀 🎀 C+ reviewed
Link to proposal

[melvin-bot]

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

[kadiealexander]

@AndrewGable any thoughts here?

[melvin-bot]

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

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

📣 @bernhardoj 🎉 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

[bernhardoj]

PR is ready

cc: @s77rt

[melvin-bot]

🎯 ⚡️ Woah @s77rt / @bernhardoj, 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 @bernhardoj got assigned: 2023-07-29 00:12:03 Z
• when the PR got merged: 2023-08-01 02:50:01 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.49-3 and is now subject to a 7-day regression period 📆. Here is the list of pull requests that resolve this issue:

• Fix empty workspace name in money requests confirmation page #23844

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

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:

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

• [@s77rt] The PR that introduced the bug has been identified. Link to the PR: Improve the performance of report name generation #12399 and [Fix #21022] Improve performance by reducing re-renders SidebarLinks #21406
• [@s77rt] 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: Improve the performance of report name generation #12399 (comment) and [Fix #21022] Improve performance by reducing re-renders SidebarLinks #21406 (comment)
• [@s77rt] 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: [HOLD for payment 2023-08-10] [$1000] Web - Workspace name is empty in request money page #23348 (comment)
• [@s77rt] Determine if we should create a regression test for this bug.
• [@s77rt] 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.
• [@kadiealexander] Link the GH issue for creating/updating the regression test once above steps have been agreed upon: n/a

[s77rt]

• The PR that introduced the bug has been identified: Improve the performance of report name generation #12399 and [Fix #21022] Improve performance by reducing re-renders SidebarLinks #21406
• The offending PR has been commented on: Improve the performance of report name generation #12399 (comment) and [Fix #21022] Improve performance by reducing re-renders SidebarLinks #21406 (comment)
• A discussion in #expensify-bugs has been started: I don't think this is needed. Seems a pretty edge case
• Determine if we should create a regression test for this bug: No

[kadiealexander]

Payouts due:

Issue Reporter: $250 @bernhardoj
Contributor: $1000 + $500 bonus @bernhardoj
Contributor+: $1000 + $500 bonus @s77rt

Eligible for 50% #urgency bonus? Yes

Upwork job is here.

[bernhardoj]

I can't access the job.

Can you invite me to the job?

[kadiealexander]

It's cool, we already have a contract in the works! :)

[bernhardoj]

Ah, you're right. I didn't see that 😅. Thanks!

[kadiealexander]

Everyone is paid 🎉 thanks for your work on this!