Fix wrong cursor after close emoji picker #62071

bernhardoj · 2025-05-15T05:20:14Z

Explanation of Change

Fixed Issues

$ #61292
PROPOSAL: #61292 (comment)

Tests

Same as QA Steps

Verify that no errors appear in the JS console

Offline tests

Same as QA Steps

QA Steps

Send a message to a chat
Right-click or long press and choose Edit
Add an emoji from the emoji picker
Type anything
Open the emoji picker again
Now close the emoji picker
Verify the cursor is still at its place

Verify that no errors appear in the JS console

PR Author Checklist

I linked the correct issue in the ### Fixed Issues section above
I wrote clear testing steps that cover the changes made in this PR
- I added steps for local testing in the Tests section
- I added steps for the expected offline behavior in the Offline steps section
- I added steps for Staging and/or Production testing in the QA steps section
- I added steps to cover failure scenarios (i.e. verify an input displays the correct error message if the entered data is not correct)
- I turned off my network connection and tested it while offline to ensure it matches the expected behavior (i.e. verify the default avatar icon is displayed if app is offline)
- I tested this PR with a High Traffic account against the staging or production API to ensure there are no regressions (e.g. long loading states that impact usability).
I included screenshots or videos for tests on all platforms
I ran the tests on all platforms & verified they passed on:
- Android: Native
- Android: mWeb Chrome
- iOS: Native
- iOS: mWeb Safari
- MacOS: Chrome / Safari
- MacOS: Desktop
I verified there are no console errors (if there's a console error not related to the PR, report it or open an issue for it to be fixed)
I verified there are no new alerts related to the canBeMissing param for useOnyx
I followed proper code patterns (see Reviewing the code)
- I verified that any callback methods that were added or modified are named for what the method does and never what callback they handle (i.e. toggleReport and not onIconClick)
- I verified that comments were added to code that is not self explanatory
- I verified that any new or modified comments were clear, correct English, and explained "why" the code was doing something instead of only explaining "what" the code was doing.
- I verified any copy / text shown in the product is localized by adding it to src/languages/* files and using the translation method
  - If any non-english text was added/modified, I used JaimeGPT to get English > Spanish translation. I then posted it in #expensify-open-source and it was approved by an internal Expensify engineer. Link to Slack message:
- I verified all numbers, amounts, dates and phone numbers shown in the product are using the localization methods
- I verified any copy / text that was added to the app is grammatically correct in English. It adheres to proper capitalization guidelines (note: only the first word of header/labels should be capitalized), and is either coming verbatim from figma or has been approved by marketing (in order to get marketing approval, ask the Bug Zero team member to add the Waiting for copy label to the issue)
- I verified proper file naming conventions were followed for any new files or renamed files. All non-platform specific files are named after what they export and are not named "index.js". All platform-specific files are named for the platform the code supports as outlined in the README.
- I verified the JSDocs style guidelines (in STYLE.md) were followed
If a new code pattern is added I verified it was agreed to be used by multiple Expensify engineers
I followed the guidelines as stated in the Review Guidelines
I tested other components that can be impacted by my changes (i.e. if the PR modifies a shared library or component like Avatar, I verified the components using Avatar are working as expected)
I verified all code is DRY (the PR doesn't include any logic written more than once, with the exception of tests)
I verified any variables that can be defined as constants (ie. in CONST.ts or at the top of the file that uses the constant) are defined as such
I verified that if a function's arguments changed that all usages have also been updated correctly
If any new file was added I verified that:
- The file has a description of what it does and/or why is needed at the top of the file if the code is not self explanatory
If a new CSS style is added I verified that:
- A similar style doesn't already exist
- The style can't be created with an existing StyleUtils function (i.e. StyleUtils.getBackgroundAndBorderStyle(theme.componentBG))
If the PR modifies code that runs when editing or sending messages, I tested and verified there is no unexpected behavior for all supported markdown - URLs, single line code, code blocks, quotes, headings, bold, strikethrough, and italic.
If the PR modifies a generic component, I tested and verified that those changes do not break usages of that component in the rest of the App (i.e. if a shared library or component like Avatar is modified, I verified that Avatar is working as expected in all cases)
If the PR modifies a component related to any of the existing Storybook stories, I tested and verified all stories for that component are still working as expected.
If the PR modifies a component or page that can be accessed by a direct deeplink, I verified that the code functions as expected when the deeplink is used - from a logged in and logged out account.
If the PR modifies the UI (e.g. new buttons, new UI components, changing the padding/spacing/sizing, moving components, etc) or modifies the form input styles:
- I verified that all the inputs inside a form are aligned with each other.
- I added Design label and/or tagged @Expensify/design so the design team can review the changes.
If a new page is added, I verified it's using the ScrollView component to make it scrollable when more elements are added to the page.
I added unit tests for any new feature or bug fix in this PR to help automatically prevent regressions in this user flow.
If the main branch was merged into this PR after a review, I tested again and verified the outcome was still expected according to the Test steps.

Screenshots/Videos

Android: Native

android.mp4

Android: mWeb Chrome

iOS: Native

ios.mp4

iOS: mWeb Safari

MacOS: Chrome / Safari

web.mp4

MacOS: Desktop

desktop.mp4

melvin-bot · 2025-05-15T05:20:19Z

@mananjadhav Please copy/paste the Reviewer Checklist from here into a new comment on this PR and complete it. If you have the K2 extension, you can simply click: [this button]

bernhardoj · 2025-05-15T05:25:10Z

src/hooks/useSidePanel.ts

@@ -64,7 +64,7 @@ function useSidePanel() {
    const {windowWidth} = useWindowDimensions();
    const sidePanelWidth = shouldUseNarrowLayout ? windowWidth : variables.sideBarWidth;

-    const [isSidePanelTransitionEnded, setIsSidePanelTransitionEnded] = useState(false);
+    const [isSidePanelTransitionEnded, setIsSidePanelTransitionEnded] = useState(true);


I changed this to true because the side panel is not transitioning at all initially. This is to fix an issue where the edit composer won't be refocused after closing the emoji picker because ready to focus promise is never resolved.

App/src/libs/ComposerFocusManager.ts

Lines 203 to 211 in 11385b8

function setReadyToFocus(id?: ModalId) {

const key = id ?? getTopmostModalId();

const promise = promiseMap.get(key);

if (!promise) {

return;

}

promise.resolve?.();

promiseMap.delete(key);

}

The promise is created because the help modal is mounted even though it shouldn't be.

App/src/components/SidePanel/HelpModal/index.tsx

Lines 45 to 62 in 11385b8

useEffect(() => {

ComposerFocusManager.resetReadyToFocus(uniqueModalId);

window.history.pushState({isSidePanelOpen: true}, '', null);

const handlePopState = () => {

if (isExtraLargeScreenWidth) {

return;

}

closeSidePanel();

};

window.addEventListener('popstate', handlePopState);

return () => {

window.removeEventListener('popstate', handlePopState);

ComposerFocusManager.setReadyToFocus(uniqueModalId);

};

// eslint-disable-next-line react-compiler/react-compiler, react-hooks/exhaustive-deps

}, []);

App/src/components/SidePanel/index.tsx

Lines 5 to 15 in 11385b8

function SidePanel() {

const {isSidePanelTransitionEnded, shouldHideSidePanel, sidePanelTranslateX, shouldHideSidePanelBackdrop, closeSidePanel} = useSidePanel();

if (isSidePanelTransitionEnded && shouldHideSidePanel) {

return null;

}

return (

<Help

shouldHideSidePanel={shouldHideSidePanel}

sidePanelTranslateX={sidePanelTranslateX}

But mWeb still doesn't refocus because of the early return here:

App/src/pages/home/report/ReportActionItemMessageEdit.tsx

Lines 525 to 531 in 11385b8

onModalHide={() => {

const activeElementId = DomUtils.getActiveElement()?.id;

if (activeElementId === CONST.COMPOSER.NATIVE_ID || activeElementId === CONST.EMOJI_PICKER_BUTTON_NATIVE_ID) {

return;

}

ReportActionComposeFocusManager.focus();

}}

Is this an existing bug or a result of our change. Have we tested if it is causing any regression?

It's actually a bug from #61884. Before the early return added here, setIsSidePanelTransitionEnded(true) will be called after it's mounted and the animation is done (even though technically there is nothing to animate), so the value will eventually be true too.

App/src/hooks/useSidePanel.ts

Lines 76 to 96 in d4347a6

useEffect(() => {

if (shouldHideSidePanel && prevShouldHideSidePanel) {

sidePanelTranslateX.current.setValue(sidePanelWidth);

sidePanelOffset.current.setValue(shouldApplySidePanelOffset ? variables.sideBarWidth : 0);

return;

}

setIsSidePanelTransitionEnded(false);

Animated.parallel([

Animated.timing(sidePanelOffset.current, {

toValue: shouldApplySidePanelOffset ? variables.sideBarWidth : 0,

duration: CONST.ANIMATED_TRANSITION,

useNativeDriver: true,

}),

Animated.timing(sidePanelTranslateX.current, {

toValue: shouldHideSidePanel ? sidePanelWidth : 0,

duration: CONST.ANIMATED_TRANSITION,

useNativeDriver: true,

}),

]).start(() => setIsSidePanelTransitionEnded(true));

}, [shouldHideSidePanel, shouldApplySidePanelOffset, sidePanelWidth, prevShouldHideSidePanel]);

We now have an issue created for that bug.

The offending PR is reverted, should I revert this back?

Yes please.

Can you check if syncing with main fixes it?

Syncing with main and reverting this change fixes it.

mananjadhav · 2025-05-17T16:33:50Z

Reviewer Checklist

I have verified the author checklist is complete (all boxes are checked off).
I verified the correct issue is linked in the ### Fixed Issues section above
I verified testing steps are clear and they cover the changes made in this PR
- I verified the steps for local testing are in the Tests section
- I verified the steps for Staging and/or Production testing are in the QA steps section
- I verified the steps cover any possible failure scenarios (i.e. verify an input displays the correct error message if the entered data is not correct)
- I turned off my network connection and tested it while offline to ensure it matches the expected behavior (i.e. verify the default avatar icon is displayed if app is offline)
I checked that screenshots or videos are included for tests on all platforms
I included screenshots or videos for tests on all platforms
I verified that the composer does not automatically focus or open the keyboard on mobile unless explicitly intended. This includes checking that returning the app from the background does not unexpectedly open the keyboard.
I verified tests pass on all platforms & I tested again on:
- Android: HybridApp
- Android: mWeb Chrome
- iOS: HybridApp
- iOS: mWeb Safari
- MacOS: Chrome / Safari
- MacOS: Desktop
If there are any errors in the console that are unrelated to this PR, I either fixed them (preferred) or linked to where I reported them in Slack
I verified there are no new alerts related to the canBeMissing param for useOnyx
I verified proper code patterns were followed (see Reviewing the code)
- I verified that any callback methods that were added or modified are named for what the method does and never what callback they handle (i.e. toggleReport and not onIconClick).
- I verified that comments were added to code that is not self explanatory
- I verified that any new or modified comments were clear, correct English, and explained "why" the code was doing something instead of only explaining "what" the code was doing.
- I verified any copy / text shown in the product is localized by adding it to src/languages/* files and using the translation method
- I verified all numbers, amounts, dates and phone numbers shown in the product are using the localization methods
- I verified any copy / text that was added to the app is grammatically correct in English. It adheres to proper capitalization guidelines (note: only the first word of header/labels should be capitalized), and is either coming verbatim from figma or has been approved by marketing (in order to get marketing approval, ask the Bug Zero team member to add the Waiting for copy label to the issue)
- I verified proper file naming conventions were followed for any new files or renamed files. All non-platform specific files are named after what they export and are not named "index.js". All platform-specific files are named for the platform the code supports as outlined in the README.
- I verified the JSDocs style guidelines (in STYLE.md) were followed
If a new code pattern is added I verified it was agreed to be used by multiple Expensify engineers
I verified that this PR follows the guidelines as stated in the Review Guidelines
I verified other components that can be impacted by these changes have been tested, and I retested again (i.e. if the PR modifies a shared library or component like Avatar, I verified the components using Avatar have been tested & I retested again)
I verified all code is DRY (the PR doesn't include any logic written more than once, with the exception of tests)
I verified any variables that can be defined as constants (ie. in CONST.ts or at the top of the file that uses the constant) are defined as such
If a new component is created I verified that:
- A similar component doesn't exist in the codebase
- All props are defined accurately and each prop has a /** comment above it */
- The file is named correctly
- The component has a clear name that is non-ambiguous and the purpose of the component can be inferred from the name alone
- The only data being stored in the state is data necessary for rendering and nothing else
- For Class Components, any internal methods passed to components event handlers are bound to this properly so there are no scoping issues (i.e. for onClick={this.submit} the method this.submit should be bound to this in the constructor)
- Any internal methods bound to this are necessary to be bound (i.e. avoid this.submit = this.submit.bind(this); if this.submit is never passed to a component event handler like onClick)
- All JSX used for rendering exists in the render method
- The component has the minimum amount of code necessary for its purpose, and it is broken down into smaller components in order to separate concerns and functions
If any new file was added I verified that:
- The file has a description of what it does and/or why is needed at the top of the file if the code is not self explanatory
If a new CSS style is added I verified that:
- A similar style doesn't already exist
- The style can't be created with an existing StyleUtils function (i.e. StyleUtils.getBackgroundAndBorderStyle(theme.componentBG)
If the PR modifies code that runs when editing or sending messages, I tested and verified there is no unexpected behavior for all supported markdown - URLs, single line code, code blocks, quotes, headings, bold, strikethrough, and italic.
If the PR modifies a generic component, I tested and verified that those changes do not break usages of that component in the rest of the App (i.e. if a shared library or component like Avatar is modified, I verified that Avatar is working as expected in all cases)
If the PR modifies a component related to any of the existing Storybook stories, I tested and verified all stories for that component are still working as expected.
If the PR modifies a component or page that can be accessed by a direct deeplink, I verified that the code functions as expected when the deeplink is used - from a logged in and logged out account.
If the PR modifies the UI (e.g. new buttons, new UI components, changing the padding/spacing/sizing, moving components, etc) or modifies the form input styles:
- I verified that all the inputs inside a form are aligned with each other.
- I added Design label and/or tagged @Expensify/design so the design team can review the changes.
If a new page is added, I verified it's using the ScrollView component to make it scrollable when more elements are added to the page.
For any bug fix or new feature in this PR, I verified that sufficient unit tests are included to prevent regressions in this flow.
If the main branch was merged into this PR after a review, I tested again and verified the outcome was still expected according to the Test steps.
I have checked off every checkbox in the PR reviewer checklist, including those that don't apply to this PR.

Screenshots/Videos

Android: HybridApp

android-emoji-cursor.mov

Android: mWeb Chrome

mweb-chrome-emoji-cursor.mov

iOS: HybridApp

ios-emoji-cursor.mov

iOS: mWeb Safari

mweb-safari-emoji-cursor.mov

MacOS: Chrome / Safari

web-emoji-cursor.mov

MacOS: Desktop

desktop-emoji-cursor.mov

This reverts commit 7bd7be1.

mananjadhav · 2025-05-21T16:35:58Z

@AndrewGable Quick bump. Failing tests are unrelated. Possible to rerun and check?

OSBotify · 2025-05-21T19:09:12Z

✋ This PR was not deployed to staging yet because QA is ongoing. It will be automatically deployed to staging after the next production release.

github-actions · 2025-05-23T19:30:43Z

🚀 Deployed to staging by https://github.com/AndrewGable in version: 9.1.51-0 🚀

platform	result
🖥 desktop 🖥	success ✅
🕸 web 🕸	success ✅
🤖 android 🤖	success ✅
🍎 iOS 🍎	success ✅

bernhardoj added 2 commits May 15, 2025 13:18

clear the emoji selection after refocus

4f3c2aa

fix side panel transition state is stuck at false initially

7bd7be1

bernhardoj requested a review from a team as a code owner May 15, 2025 05:20

melvin-bot bot requested review from mananjadhav and removed request for a team May 15, 2025 05:20

bernhardoj commented May 15, 2025

View reviewed changes

lint

0dfba97

bernhardoj mentioned this pull request May 16, 2025

[Due for payment 2025-05-28] [Due for payment 2025-05-27] [$125] Help Modal - Help modal is shown when reducing the size of the window #61016

Open

8 tasks

mananjadhav approved these changes May 17, 2025

View reviewed changes

melvin-bot bot requested a review from AndrewGable May 17, 2025 16:40

bernhardoj added 2 commits May 18, 2025 23:06

Merge branch 'main' into fix/61292-wrong-cursor-after-close-emoji-picker

64a789b

Revert "fix side panel transition state is stuck at false initially"

64629fa

This reverts commit 7bd7be1.

AndrewGable approved these changes May 21, 2025

View reviewed changes

AndrewGable merged commit c0c64ed into Expensify:main May 21, 2025
17 checks passed

github-actions bot mentioned this pull request May 23, 2025

Deploy Checklist: New Expensify 2025-05-23 #62662

Open

mitarachim mentioned this pull request May 23, 2025

mWeb- Composer loses focus after emoji is added during message edit #62703

Open

8 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Fix wrong cursor after close emoji picker #62071

Fix wrong cursor after close emoji picker #62071

Uh oh!

bernhardoj commented May 15, 2025

Uh oh!

melvin-bot bot commented May 15, 2025

Uh oh!

bernhardoj May 15, 2025

Uh oh!

bernhardoj May 15, 2025

Uh oh!

mananjadhav May 15, 2025

Uh oh!

bernhardoj May 15, 2025

Uh oh!

bernhardoj May 16, 2025

Uh oh!

bernhardoj May 18, 2025

Uh oh!

mananjadhav May 18, 2025

Uh oh!

mananjadhav May 18, 2025

Uh oh!

bernhardoj May 18, 2025

Uh oh!

mananjadhav commented May 17, 2025 •

edited

Loading

Uh oh!

mananjadhav commented May 21, 2025

Uh oh!

Uh oh!

OSBotify commented May 21, 2025

Uh oh!

github-actions bot commented May 23, 2025

Uh oh!

Uh oh!

	function setReadyToFocus(id?: ModalId) {
	const key = id ?? getTopmostModalId();
	const promise = promiseMap.get(key);
	if (!promise) {
	return;
	}
	promise.resolve?.();
	promiseMap.delete(key);
	}

	useEffect(() => {
	ComposerFocusManager.resetReadyToFocus(uniqueModalId);
	window.history.pushState({isSidePanelOpen: true}, '', null);
	const handlePopState = () => {
	if (isExtraLargeScreenWidth) {
	return;
	}

	closeSidePanel();
	};

	window.addEventListener('popstate', handlePopState);
	return () => {
	window.removeEventListener('popstate', handlePopState);
	ComposerFocusManager.setReadyToFocus(uniqueModalId);
	};
	// eslint-disable-next-line react-compiler/react-compiler, react-hooks/exhaustive-deps
	}, []);

	function SidePanel() {
	const {isSidePanelTransitionEnded, shouldHideSidePanel, sidePanelTranslateX, shouldHideSidePanelBackdrop, closeSidePanel} = useSidePanel();

	if (isSidePanelTransitionEnded && shouldHideSidePanel) {
	return null;
	}

	return (
	<Help
	shouldHideSidePanel={shouldHideSidePanel}
	sidePanelTranslateX={sidePanelTranslateX}

	onModalHide={() => {
	const activeElementId = DomUtils.getActiveElement()?.id;
	if (activeElementId === CONST.COMPOSER.NATIVE_ID \|\| activeElementId === CONST.EMOJI_PICKER_BUTTON_NATIVE_ID) {
	return;
	}
	ReportActionComposeFocusManager.focus();
	}}

	useEffect(() => {
	if (shouldHideSidePanel && prevShouldHideSidePanel) {
	sidePanelTranslateX.current.setValue(sidePanelWidth);
	sidePanelOffset.current.setValue(shouldApplySidePanelOffset ? variables.sideBarWidth : 0);
	return;
	}
	setIsSidePanelTransitionEnded(false);

	Animated.parallel([
	Animated.timing(sidePanelOffset.current, {
	toValue: shouldApplySidePanelOffset ? variables.sideBarWidth : 0,
	duration: CONST.ANIMATED_TRANSITION,
	useNativeDriver: true,
	}),
	Animated.timing(sidePanelTranslateX.current, {
	toValue: shouldHideSidePanel ? sidePanelWidth : 0,
	duration: CONST.ANIMATED_TRANSITION,
	useNativeDriver: true,
	}),
	]).start(() => setIsSidePanelTransitionEnded(true));
	}, [shouldHideSidePanel, shouldApplySidePanelOffset, sidePanelWidth, prevShouldHideSidePanel]);

Fix wrong cursor after close emoji picker #62071

Fix wrong cursor after close emoji picker #62071

Uh oh!

Conversation

bernhardoj commented May 15, 2025

Explanation of Change

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

Uh oh!

melvin-bot bot commented May 15, 2025

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

mananjadhav commented May 17, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Reviewer Checklist

Screenshots/Videos

Uh oh!

mananjadhav commented May 21, 2025

Uh oh!

Uh oh!

OSBotify commented May 21, 2025

Uh oh!

github-actions bot commented May 23, 2025

Uh oh!

Uh oh!

mananjadhav commented May 17, 2025 •

edited

Loading