[HOLD for payment 2024-05-22] [$250] mWeb - In room,inviting an user& creating split scan not displaying Scan in progress in lhn

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

---

Version Number: 1.4.63-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: EXP around https://expensify.testrail.io/index.php?/tests/view/4495609
Logs: https://stackoverflow.com/c/expensify/questions/4856
Expensify/Expensify Issue URL:
Issue reported by: Applause internal team
Slack conversation:

Action Performed:

1. Go to https://staging.new.expensify.com/

2. Tap fab -- start chat -- room

3. Create a room
   4.Tap header---members and invite a member
   5.Navigate back to room page
   6.Tap plus--- split expense-- scan
   7.Upload an image using camera
   8.Tap split expense
   9.Note scan in progress shown in preview
   10.Open the expense and note header message shown scanning
   11.Navigate to LHN

Expected Result:

In room, after inviting an user& creating split scan expense must display Scan in progress message in lhn.

Actual Result:

In room, after inviting an user& creating split scan expense displays invited 1user message in LHN instead of Scan in progress message.

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

Add any screenshot/video evidence

Bug6454325_1713479892547.rov.mp4

View all open jobs on GitHub

Upwork Automation - Do Not Edit

• Upwork Job URL: https://www.upwork.com/jobs/~0169b520297273f864
• Upwork Job ID: 1782362477239189504
• Last Price Increase: 2024-04-22
• Automatic offers:
• bernhardoj | Contributor | 0

Issue Owner

Current Issue Owner: @zanyrenney

[melvin-bot]

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

[kavimuru]

@zanyrenney FYI I haven't added the External label as I wasn't 100% sure about this issue. Please take a look and add the label if you agree it's a bug and can be handled by external contributors.

[kavimuru]

This bug might be related to #vip-vsb

[bernhardoj]

Proposal

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

When doing a split bill scan in a room, the LHN last message doesn't show Scan in progress. If we do this in, let say a group chat, the LHN last message will show Scan in progress.

What is the root cause of that problem?

If it's a chat room, the last message value will be based on the report lastAction.

App/src/libs/SidebarUtils.ts

Lines 321 to 363 in 8616678

	const lastAction = visibleReportActionItems[report.reportID];
	const isThreadMessage =
	ReportUtils.isThread(report) && lastAction?.actionName === CONST.REPORT.ACTIONS.TYPE.ADD_COMMENT && lastAction?.pendingAction !== CONST.RED_BRICK_ROAD_PENDING_ACTION.DELETE;
	if ((result.isChatRoom || result.isPolicyExpenseChat || result.isThread || result.isTaskReport || isThreadMessage) && !result.isArchivedRoom) {
	if (lastAction?.actionName === CONST.REPORT.ACTIONS.TYPE.RENAMED) {
	const newName = lastAction?.originalMessage?.newName ?? '';
	result.alternateText = Localize.translate(preferredLocale, 'newRoomPage.roomRenamedTo', {newName});
	} else if (ReportActionsUtils.isTaskAction(lastAction)) {
	result.alternateText = ReportUtils.formatReportLastMessageText(TaskUtils.getTaskReportActionMessage(lastAction).text);
	} else if (
	lastAction?.actionName === CONST.REPORT.ACTIONS.TYPE.ROOM_CHANGE_LOG.INVITE_TO_ROOM ||
	lastAction?.actionName === CONST.REPORT.ACTIONS.TYPE.ROOM_CHANGE_LOG.REMOVE_FROM_ROOM ||
	lastAction?.actionName === CONST.REPORT.ACTIONS.TYPE.POLICY_CHANGE_LOG.INVITE_TO_ROOM ||
	lastAction?.actionName === CONST.REPORT.ACTIONS.TYPE.POLICY_CHANGE_LOG.REMOVE_FROM_ROOM
	) {
	const targetAccountIDs = lastAction?.originalMessage?.targetAccountIDs ?? [];
	const verb =
	lastAction.actionName === CONST.REPORT.ACTIONS.TYPE.ROOM_CHANGE_LOG.INVITE_TO_ROOM || lastAction.actionName === CONST.REPORT.ACTIONS.TYPE.POLICY_CHANGE_LOG.INVITE_TO_ROOM
	? Localize.translate(preferredLocale, 'workspace.invite.invited')
	: Localize.translate(preferredLocale, 'workspace.invite.removed');
	const users = Localize.translate(preferredLocale, targetAccountIDs.length > 1 ? 'workspace.invite.users' : 'workspace.invite.user');
	result.alternateText = `${lastActorDisplayName} ${verb} ${targetAccountIDs.length} ${users}`.trim();
	const roomName = lastAction?.originalMessage?.roomName ?? '';
	if (roomName) {
	const preposition =
	lastAction.actionName === CONST.REPORT.ACTIONS.TYPE.ROOM_CHANGE_LOG.INVITE_TO_ROOM || lastAction.actionName === CONST.REPORT.ACTIONS.TYPE.POLICY_CHANGE_LOG.INVITE_TO_ROOM
	? ` ${Localize.translate(preferredLocale, 'workspace.invite.to')}`
	: ` ${Localize.translate(preferredLocale, 'workspace.invite.from')}`;
	result.alternateText += `${preposition} ${roomName}`;
	}
	} else if (lastAction?.actionName === CONST.REPORT.ACTIONS.TYPE.POLICY_CHANGE_LOG.LEAVE_POLICY) {
	result.alternateText = Localize.translateLocal('workspace.invite.leftWorkspace');
	} else if (lastAction?.actionName !== CONST.REPORT.ACTIONS.TYPE.REPORT_PREVIEW && lastActorDisplayName && lastMessageTextFromReport) {
	result.alternateText = `${lastActorDisplayName}: ${lastMessageText}`;
	} else {
	result.alternateText = lastMessageTextFromReport.length > 0 ? lastMessageText : ReportActionsUtils.getLastVisibleMessage(report.reportID, {}, lastAction)?.lastMessageText;
	if (!result.alternateText) {
	result.alternateText = Localize.translate(preferredLocale, 'report.noActivityYet');
	}
	}

The last action is taken from visibleReportActionItems object. To get visibleReportActionItems, we sort the report actions, filter it, then take the last item.

App/src/libs/SidebarUtils.ts

Lines 35 to 47 in 8616678

	const actionsArray: ReportAction[] = ReportActionsUtils.getSortedReportActions(Object.values(actions));
	// The report is only visible if it is the last action not deleted that
	// does not match a closed or created state.
	const reportActionsForDisplay = actionsArray.filter(
	(reportAction, actionKey) =>
	ReportActionsUtils.shouldReportActionBeVisible(reportAction, actionKey) &&
	!ReportActionsUtils.isWhisperAction(reportAction) &&
	reportAction.actionName !== CONST.REPORT.ACTIONS.TYPE.CREATED &&
	reportAction.pendingAction !== CONST.RED_BRICK_ROAD_PENDING_ACTION.DELETE,
	);
	visibleReportActionItems[reportID] = reportActionsForDisplay[reportActionsForDisplay.length - 1];

Notice that in the filter, we filter out any whisper action, which is true for scan requests while scanning. So, the scan request is never taken into consideration and the last message will be the previous message.

But as I mentioned in the first section above, this doesn't happen when we do the split bill scan in a group chat for example. That's because, for group chat, we get the last message from lastMessageText,

App/src/libs/SidebarUtils.ts

Lines 390 to 393 in 8616678

	result.alternateText =
	(ReportUtils.isGroupChat(report) || ReportUtils.isDeprecatedGroupDM(report)) && lastActorDisplayName
	? `${lastActorDisplayName}: ${lastMessageText}`
	: lastMessageText || formattedLogin;

and lastMessageText comes from OptionsListUtils.getLastMessageTextForReport.

App/src/libs/SidebarUtils.ts

Lines 316 to 319 in 8616678

	const lastMessageTextFromReport = OptionsListUtils.getLastMessageTextForReport(report, lastActorDetails, policy);
	// We need to remove sms domain in case the last message text has a phone number mention with sms domain.
	let lastMessageText = Str.removeSMSDomain(lastMessageTextFromReport);

In OptionsListUtils.getLastMessageTextForReport, the way we get the last report action is by filtering it only with a ReportActionUtils.shouldReportActionBeVisibleAsLastAction function.

App/src/libs/OptionsListUtils.ts

Lines 568 to 569 in 8616678

	function getLastMessageTextForReport(report: OnyxEntry<Report>, lastActorDetails: Partial<PersonalDetails> | null, policy?: OnyxEntry<Policy>): string {
	const lastReportAction = allSortedReportActions[report?.reportID ?? '']?.find((reportAction) => ReportActionUtils.shouldReportActionBeVisibleAsLastAction(reportAction)) ?? null;

In ReportActionUtils.shouldReportActionBeVisibleAsLastAction, we will only filter out whisper messages if it's not a report preview or IOU action.

App/src/libs/ReportActionsUtils.ts

Line 567 in 8616678

!(isWhisperAction(reportAction) && !isReportPreviewAction(reportAction) && !isMoneyRequestAction(reportAction)) &&

That's why the split bill scan request is taken into consideration as the last action.

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

We should make the last action logic consistent for the last message text. In SidebarUtils itself, we have 3 ways to get the last action. One is the last action that doesn't get through the filter, two get through the filter (one filter with ReportActionUtils.shouldReportActionBeVisibleAsLastAction and the other one is the same as in SidebarUtils)

App/src/libs/OptionsListUtils.ts

Lines 570 to 571 in 8616678

	// some types of actions are filtered out for lastReportAction, in some cases we need to check the actual last action
	const lastOriginalReportAction = lastReportActions[report?.reportID ?? ''] ?? null;

App/src/libs/OptionsListUtils.ts

Line 569 in 8616678

const lastReportAction = allSortedReportActions[report?.reportID ?? '']?.find((reportAction) => ReportActionUtils.shouldReportActionBeVisibleAsLastAction(reportAction)) ?? null;

App/src/libs/OptionsListUtils.ts

Lines 265 to 272 in 8616678

	const reportActionsForDisplay = sortedReportActions.filter(
	(reportAction, actionKey) =>
	ReportActionUtils.shouldReportActionBeVisible(reportAction, actionKey) &&
	!ReportActionUtils.isWhisperAction(reportAction) &&
	reportAction.actionName !== CONST.REPORT.ACTIONS.TYPE.CREATED &&
	reportAction.pendingAction !== CONST.RED_BRICK_ROAD_PENDING_ACTION.DELETE,
	);
	visibleReportActionItems[reportID] = reportActionsForDisplay[reportActionsForDisplay.length - 1];

App/src/libs/OptionsListUtils.ts

Line 724 in 8616678

const lastAction = visibleReportActionItems[report.reportID];

Here is the plan:

1. In SidebarUtils and OptionsListUtils, update the last action filter to use ReportActionsUtils.shouldReportActionBeVisibleAsLastAction(reportAction).

const reportActionsForDisplay = actionsArray.filter((reportAction) => ReportActionsUtils.shouldReportActionBeVisibleAsLastAction(reportAction));

// SidebarUtils
visibleReportActionItems[reportID] = reportActionsForDisplay[reportActionsForDisplay.length - 1];

// OptionsListUtils - the report actions are sorted in descending order
visibleReportActionItems[reportID] = reportActionsForDisplay[0];

2. Replace the filtering code below to const lastReportAction = visibleReportActionItems[report?.reportID ?? ''] ?? null;
   

   App/src/libs/OptionsListUtils.ts

   Lines 568 to 569 in 8616678

   	function getLastMessageTextForReport(report: OnyxEntry<Report>, lastActorDetails: Partial<PersonalDetails> | null, policy?: OnyxEntry<Policy>): string {
   	const lastReportAction = allSortedReportActions[report?.reportID ?? '']?.find((reportAction) => ReportActionUtils.shouldReportActionBeVisibleAsLastAction(reportAction)) ?? null;

NOTE:
a. We can move the logic to store the last action to ReportActionsUtils and create a new util function called getLastActionForLastMessageText.
b. I removed the filtering condition for CREATED action because I think it's not needed. We can add it back if we want to play safe.
c. If we don't want to include a report preview while scanning, then we just need to perform step 2 above (and access the first item instead of the last as shown in step 1).

[zanyrenney]

Agree, this looks related to VIP VSB

[melvin-bot]

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

[melvin-bot]

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

[zanyrenney]

Already have a proposal above! @thesahindia please take a look and let me know if we can hire @bernhardoj

[zanyrenney]

bump @thesahindia if you don't have capacity to review the proposal, please let me know and I will assign another C+

[thesahindia]

@bernhardoj's proposal looks good to me!

🎀 👀 🎀 C+ reviewed

[melvin-bot]

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

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

[bernhardoj]

PR is ready

cc: @thesahindia

[melvin-bot]

⚠️ Looks like this issue was linked to a Deploy Blocker here

If you are the assigned CME please investigate whether the linked PR caused a regression and leave a comment with the results.

If a regression has occurred and you are the assigned CM follow the instructions here.

If this regression could have been avoided please consider also proposing a recommendation to the PR checklist so that we can avoid it in the future.

[bernhardoj]

The PR is reverted because of a regression. The new PR is ready

cc: @thesahindia

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

• #2 - Fix scan in progress isn't shown in room LHN last message when there is a scan in progress report preview #41821

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

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

• @bernhardoj requires payment automatic offer (Contributor)
• @thesahindia requires payment through NewDot Manual Requests

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

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

[zanyrenney]

@thesahindia please complete the checklist above before I can issue payment. Thanks!

[thesahindia]

We were filtering out all whisper actions, which caused this.

Test case steps -

1. Open a room chat
2. Invite any user
3. Verify the LHN of the room shows "invited x user"
4. Create a new split scan request in the room
5. Verify the LHN of the room shows "Scan in progress.."

[zanyrenney]

payment summary

paid $250 to @bernhardoj via UW.
@thesahindia is paid via ND. They are owed $250.

Closing!

[JmillsExpensify]

$250 approved for @thesahindia