[HOLD for payment 2024-12-30] [$250] Workspace list is opened in background when workspace description is opened from workspace chat

[IuliiaHerets]

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: 9.0.72-0
Reproducible in staging?: Yes
Reproducible in production?: Yes
If this was caught on HybridApp, is this reproducible on New Expensify Standalone?: N/A
If this was caught during regression testing, add the test name, ID and link from TestRail: Exp
Email or phone of affected tester (no customers): applausetester+kh1311020@applause.expensifail.com
Issue reported by: Applause Internal Team

Action Performed:

1. Go to staging.new.expensify.com
2. Create a workspace.
3. Go to workspace settings > Profile.
4. Click Description, add a description and save it.
5. Click on the workspace chat under "Submit expenses using your workspace chat below" on the same page (important).
6. In workspace chat, click on the header subtitle to open workspace description editor.

Expected Result:

The background will be workspace settings.

Actual Result:

The background is workspace list.

Workaround:

Unknown

Platforms:

• Android: Standalone
• Android: HybridApp
• Android: mWeb Chrome
• iOS: Standalone
• iOS: HybridApp
• iOS: mWeb Safari
• MacOS: Chrome / Safari
• MacOS: Desktop

Screenshots/Videos

Bug6685724_1733436790635.20241206_060831.mp4

View all open jobs on GitHub

Upwork Automation - Do Not Edit

• Upwork Job URL: https://www.upwork.com/jobs/~021864885429995006456
• Upwork Job ID: 1864885429995006456
• Last Price Increase: 2024-12-06
• Automatic offers:
• twilight2294 | Contributor | 105273277

Issue Owner

Current Issue Owner: @kadiealexander

[melvin-bot]

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

[Shahidullah-Muffakir]

Edited by proposal-police: This proposal was edited at 2024-12-10 04:12:50 UTC.

Proposal

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

When user clicks on the workspace description in the workspace header, The workspaces list is shown in the background, but Workspace profile is expected.

What is the root cause of that problem?

We are not passing backTo here, when user click on the desc:

App/src/pages/home/HeaderView.tsx

Line 265 in 840c227

Navigation.navigate(ROUTES.WORKSPACE_PROFILE_DESCRIPTION.getRoute(report.policyID ?? '-1'));

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

pass ROUTES.WORKSPACE_INITIAL.getRoute(report?.policyID ?? '-1') as the backTo route:
Navigation.navigate(ROUTES.WORKSPACE_PROFILE_DESCRIPTION.getRoute(report.policyID ?? '-1', ROUTES.WORKSPACE_INITIAL.getRoute(report?.policyID ?? '-1')));

and modify the ROUTES.WORKSPACE_PROFILE_DESCRIPTION.getRoute to accept backTo :

App/src/ROUTES.ts

Line 856 in 840c227

getRoute: (policyID: string) => `settings/workspaces/${policyID}/profile/description` as const,

as:

getRoute: (policyID: string, backTo?: string) => getUrlWithBackToParam(`settings/workspaces/${policyID}/profile/description` as const, backTo),

[melvin-bot]

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

[melvin-bot]

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

[huult]

Edited by proposal-police: This proposal was edited at 2024-12-06 09:09:03 UTC.

Proposal

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

Workspace list is opened in background when workspace description is opened from workspace chat

What is the root cause of that problem?

The issue occurs because the Report route is included in the navigation stack after clicking the workspace chat under “Submit expenses using your workspace chat below.” Additionally, when the header subtitle is clicked, navigation to WORKSPACE_PROFILE_DESCRIPTION is triggered, which then adds both the Settings_Workspaces route and the RightModalNavigator to the stack.

Here is log for this:

BottomTabNavigator -> Settings_Workspace -> FullScreenNavigator -> Report -> Settings_Workspaces -> RightModalNavigator

This results in an incorrect navigation flow, as the Report route is stacked before Settings_Workspaces, and FullScreenNavigator is stacked before Report. This causes navigation to the workspace list instead of the workspace profile, as the workspace profile is located in FullScreenNavigator.

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

To resolve this issue, we need to remove the Report route when navigating to WORKSPACE_PROFILE_DESCRIPTION.

BottomTabNavigator -> Settings_Workspace -> FullScreenNavigator -> Settings_Workspaces -> RightModalNavigator

To do this, we need to add Navigation.goBack() to return to the FullScreenNavigator before navigating to WORKSPACE_PROFILE_DESCRIPTION. Something like this:

1 Add go back before navigation to WORKSPACE_PROFILE_DESCRIPTION

App/src/pages/home/HeaderView.tsx

Lines 264 to 267 in 5180ef4

	if (ReportUtils.canEditPolicyDescription(policy)) {
	Navigation.navigate(ROUTES.WORKSPACE_PROFILE_DESCRIPTION.getRoute(report.policyID ?? '-1'));
	return;
	}

    if (ReportUtils.canEditPolicyDescription(policy)) {
        Navigation.goBack();
        Navigation.navigate(ROUTES.WORKSPACE_PROFILE_DESCRIPTION.getRoute(report.policyID ?? '-1'));
        return;
    }

2 This is similar to this issue; we still applied goBack before navigating to WORKSPACE_PROFILE_DESCRIPTION

App/src/components/ReportWelcomeText.tsx

Lines 109 to 114 in e8dd2bd

	onPress={() => {
	if (!canEditPolicyDescription) {
	return;
	}
	Navigation.navigate(ROUTES.WORKSPACE_PROFILE_DESCRIPTION.getRoute(policy?.id ?? '-1'));
	}}

    onPress={() => {
        if (!canEditPolicyDescription) {
            return;
        }

        Navigation.goBack();
        Navigation.navigate(ROUTES.WORKSPACE_PROFILE_DESCRIPTION.getRoute(policy?.id ?? '-1'));
    }}

POC

Screen.Recording.2024-12-06.at.16.07.24.mp4

What specific scenarios should we cover in automated tests to prevent reintroducing this issue in the future?

What alternative solutions did you explore? (Optional)

Reminder: Please use plain English, be brief and avoid jargon. Feel free to use images, charts or pseudo-code if necessary. Do not post large multi-line diffs or write walls of text. Do not create PRs unless you have been hired for this job.

[twilight2294]

Proposal

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

Workspace list is opened in background when workspace description is opened from workspace chat

What is the root cause of that problem?

When we click on workspace chat in policy settings, FullScreenNavigator is pushed on the screen navigation stack and not replaced:

App/src/libs/Navigation/linkTo/index.ts

Lines 114 to 118 in 3baf965

	if (type === CONST.NAVIGATION.TYPE.UP) {
	action.type = CONST.NAVIGATION.ACTION_TYPE.REPLACE;
	} else {
	action.type = CONST.NAVIGATION.ACTION_TYPE.PUSH;
	}

This issue is only caused on the profile tabs and not on other tabs of the workspace because profile tab is at the root of the workspace settings screen.

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

We should pass CONST.NAVIGATION.TYPE.UP in here while navigating to workspace chat this will make sure that we replace the appropriate screen at the root:

    <MenuItem
        title={getReportName(currentUserPolicyExpenseChat)}
        description={translate('workspace.common.workspace')}
        icon={getIcons(currentUserPolicyExpenseChat, personalDetails)}
        onPress={() => Navigation.navigate(ROUTES.REPORT_WITH_ID.getRoute(currentUserPolicyExpenseChat?.reportID ?? '-1'), CONST.NAVIGATION.TYPE.UP)}
        shouldShowRightIcon
        wrapperStyle={[styles.br2, styles.pl2, styles.pr0, styles.pv3, styles.mt1, styles.alignItemsCenter]}
        shouldShowSubscriptAvatar
    />

What specific scenarios should we cover in automated tests to prevent reintroducing this issue in the future?

N/A navigation bug so no tests

What alternative solutions did you explore? (Optional)

[vit0-9]

Proposal

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

Workspace list is opened in background when workspace description is opened from workspace chat

What is the root cause of that problem?

The issue occurs because the navigation logic uses Navigation.navigate() for the route, which may reuse a cached navigation stack containing the workspace list. This happens when the navigation state isn't cleanly reset or managed.

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

Replace Navigation.navigate() with Navigation.closeAndNavigate() to ensure the navigation state is cleaned and the correct route is opened without reusing unintended screens.

Code Change in HeaderView.tsx lines 263 - 269 should look like this:

onPress={() => {
    if (ReportUtils.canEditPolicyDescription(policy)) {
        Navigation.closeAndNavigate(ROUTES.WORKSPACE_PROFILE_DESCRIPTION.getRoute(report.policyID ?? '-1'));
        return;
    }
    Navigation.closeAndNavigate(ROUTES.REPORT_WITH_ID_DETAILS.getRoute(reportID, Navigation.getReportRHPActiveRoute()));
}}

proposal-expensify-53665lq.mov

What specific scenarios should we cover in automated tests to prevent reintroducing this issue in the future?

What alternative solutions did you explore? (Optional)

Alternative you can use a replace function, resetting or a conditional goBack.