Workspace - Nothing happens after pressing ESC key on workspace editor

[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.41-1
Reproducible in staging?: Y
Reproducible in production?: N
Email or phone of affected tester (no customers): applausetester+kh2591@applause.expensifail.com
Issue reported by: Applause Internal Team

Action Performed:

1. Go to staging.new.expensify.com
2. Go to Account settings > Workspaces.
3. Click on any workspace.
4. Press ESC key.

Expected Result:

App will return to Workspaces list.

Actual Result:

Nothing happens after pressing ESC key on workspace editor.

Workaround:

Unknown

Platforms:

• Android: Native
• Android: mWeb Chrome
• iOS: Native
• iOS: mWeb Safari
• MacOS: Chrome / Safari
• MacOS: Desktop

Screenshots/Videos

View all open jobs on GitHub

[melvin-bot]

Triggered auto assignment to @bondydaa (DeployBlockerCash), see https://stackoverflowteams.com/c/expensify/questions/9980/ for more details.

[melvin-bot]

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

[github-actions]

👋 Friendly reminder that deploy blockers are time-sensitive ⏱ issues! Check out the open `StagingDeployCash` deploy checklist to see the list of PRs included in this release, then work quickly to do one of the following:

1. Identify the pull request that introduced this issue and revert it.
2. Find someone who can quickly fix the issue.
3. Fix the issue yourself.

[IuliiaHerets]

We think that this bug might be related to #wave-collect - Release 1

[bondydaa]

I don't think this needs to be a blocker and I'm not actually sure if that is a useful UX pattern to have.

[bondydaa]

started a discussion here (internal slack) https://expensify.slack.com/archives/C03U7DCU4/p1727472828047069

[Nodebrute]

@bondydaa The problem is that we can’t close any RHP (Right-Hand Panel) using the Escape key. This feature used to work in our app and it's a regression from this PR

On production:

Screen.Recording.2024-09-28.at.5.58.40.AM.mov

[bernhardoj]

Edited by proposal-police: This proposal was edited at 2024-09-28 05:06:59 UTC.

Proposal

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

Pressing ESC doesn't close RHP/Full screen navigator.

What is the root cause of that problem?

The ESC shortcut is overridden by the SearchRouter shortcut here.

App/src/components/Search/SearchRouter/SearchRouter.tsx

Lines 62 to 65 in 71db3f1

	useKeyboardShortcut(CONST.KEYBOARD_SHORTCUTS.ESCAPE, () => {
	closeSearchRouter();
	clearUserQuery();
	});

The SearchRouter is added to the AuthScreens which is available app wide.

App/src/libs/Navigation/AppNavigator/AuthScreens.tsx

Line 573 in 71db3f1

<SearchRouter />

Because of that, the shortcut here to close RHP doesn't work anymore.

App/src/libs/Navigation/AppNavigator/AuthScreens.tsx

Lines 308 to 320 in 71db3f1

	const unsubscribeEscapeKey = KeyboardShortcut.subscribe(
	shortcutConfig.shortcutKey,
	() => {
	if (modal.current.willAlertModalBecomeVisible) {
	return;
	}
	if (modal.current.disableDismissOnEscape) {
	return;
	}
	Navigation.dismissModal();
	},

This somehow happens after #49185 where we migrate from withOnyx to useOnyx. Before migration, the SearchRouter shortcut is subscribed first, followed by the AuthScreen shortcut. The reason the SearchRouter shortcut still works is that we enable bubbling in the AuthScreen shortcut.

After the migration, the AuthScreen shortcut is subscribed first, followed by the SearchRouter shortcut. So, pressing ESC will trigger the SearchRouter shortcut.

Even though this happens after #49185, I'd say the root cause is coming from the initial PR that adds the SearchRouter.

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

In SearchRouter, only enable the shortcut when visible.

App/src/components/Search/SearchRouter/SearchRouter.tsx

Lines 62 to 65 in 71db3f1

	useKeyboardShortcut(CONST.KEYBOARD_SHORTCUTS.ESCAPE, () => {
	closeSearchRouter();
	clearUserQuery();
	});

useKeyboardShortcut(CONST.KEYBOARD_SHORTCUTS.ESCAPE, () => {
    closeSearchRouter();
    clearUserQuery();
}, {isActive: isSearchRouterDisplayed});

App/src/components/Search/SearchRouter/SearchRouter.tsx

Line 25 in 71db3f1

const [userSearchQuery, setUserSearchQuery] = useState<SearchQueryJSON | undefined>(undefined);

However, I noticed that we only clear the query when closing the modal using ESC, but the query state stays if we close it by simply clicking outside the modal. To solve this, instead of clearing the query inside the shortcut, we can clear it when the modal closes.

onModalHide={clearUserQuery}

[IuliiaHerets]

@bondydaa @muttmuure This issue happens to all RHP

20240928_061855.mp4

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

[bondydaa]

looks like the offending PR was reverted here #49185 (comment) / #49922

Looks @IuliiaHerets can you retest when you have a moment and confirm?

[bondydaa]

just tested myself and see the esc key working as expected again on RHP and as described to go back from workspace settings. closing.

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