Fix: Composer not focused on click while editor's emoji modal is open

[tienifr]

Details

Composer is not focused on click while editor's emoji modal is still open. This PR fixes that.

Fixed Issues

$ https://github.com/Expensify/App/issues/25892 PROPOSAL: https://github.com/Expensify/App/issues/25892#issuecomment-1694065191

Tests

Web & Desktop

1. Go to any chat
2. Switch a message to edit mode (A)
3. Click Emoji button of A, leave the modal open
4. Click main composer
5. Verify that main composer is focused =====
6. Click A composer
7. Right click LHN item >> Mark as unread
8. Verify that A is focused
9. Right click another message >> Copy to clipboard
10. Verify that A is focused =====
11. Switch another message to edit mode (B)
12. Click Emoji button of A >> Close the modal
13. Verify that A is focused
14. Repeat step 12-13 with B =====
15. Click then Close B composer
16. Verify that main composer is focused =====
17. Click A composer
18. Delete A from another device/browser
19. Right click another message >> Copy to clipboard
20. Verify that main composer is focused

mWeb & Android & iOS

1. Go to any chat
2. Switch a message to edit mode (A)
3. Verify main composer hides
4. Click Emoji button of A >> Close the modal
5. Verify that A is focused =====
6. Right click a message >> Copy to clipboard
7. Verify that A is focused =====
8. Switch another message to edit mode (B)
9. Click Emoji button of A >> Close the modal
10. mWeb & Android: Verify that A is focused
11. mWeb & Android: Repeat step 9-10 with B
12. iOS: Verify that B is focused =====
13. Press then Close B composer
14. Verify main composer appears =====
15. Click A composer
16. Delete A from another device/browser
17. Verify that main composer appears
18. Right click another message >> Copy to clipboard
19. mWeb: Verify that main composer is focused

• [x] Verify that no errors appear in the JS console

Offline tests

NA

QA Steps

1. Go to any chat
2. Switch a message to edit mode
3. Click Emoji button in the edit composer, leave the modal open
4. Click the main composer
5. Verify that the main composer is focused

• [x] Verify that no errors appear in the JS console

PR Author Checklist

• [x] I linked the correct issue in the ### Fixed Issues section above
• [x] I wrote clear testing steps that cover the changes made in this PR
  • [x] I added steps for local testing in the Tests section
  • [x] I added steps for the expected offline behavior in the Offline steps section
  • [x] I added steps for Staging and/or Production testing in the QA steps section
  • [x] I added steps to cover failure scenarios (i.e. verify an input displays the correct error message if the entered data is not correct)
  • [x] 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)
  • [x] 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).
• [x] I included screenshots or videos for tests on all platforms
• [x] I ran the tests on all platforms & verified they passed on:
  • [x] Android / native
  • [x] Android / Chrome
  • [x] iOS / native
  • [x] iOS / Safari
  • [x] MacOS / Chrome / Safari
  • [x] MacOS / Desktop
• [x] 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)
• [x] I followed proper code patterns (see Reviewing the code)
  • [x] 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)
  • [x] I verified that the left part of a conditional rendering a React component is a boolean and NOT a string, e.g. myBool && <MyComponent />.
  • [x] I verified that comments were added to code that is not self explanatory
  • [x] 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.
  • [x] I verified any copy / text shown in the product is localized by adding it to src/languages/* files and using the translation method
    • [x] If any non-english text was added/modified, I verified the translation was requested/reviewed in #expensify-open-source and it was approved by an internal Expensify engineer. Link to Slack message:
  • [x] I verified all numbers, amounts, dates and phone numbers shown in the product are using the localization methods
  • [x] 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 approved by marketing by adding the Waiting for Copy label for a copy review on the original GH to get the correct copy.
  • [x] 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.
  • [x] I verified the JSDocs style guidelines (in STYLE.md) were followed
• [x] If a new code pattern is added I verified it was agreed to be used by multiple Expensify engineers
• [x] I followed the guidelines as stated in the Review Guidelines
• [x] 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)
• [x] I verified all code is DRY (the PR doesn't include any logic written more than once, with the exception of tests)
• [x] I verified any variables that can be defined as constants (ie. in CONST.js or at the top of the file that uses the constant) are defined as such
• [x] I verified that if a function's arguments changed that all usages have also been updated correctly
• [x] If a new component is created I verified that:
  • [x] A similar component doesn't exist in the codebase
  • [x] All props are defined accurately and each prop has a /** comment above it */
  • [x] The file is named correctly
  • [x] The component has a clear name that is non-ambiguous and the purpose of the component can be inferred from the name alone
  • [x] The only data being stored in the state is data necessary for rendering and nothing else
    • [x] 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)
  • [x] All JSX used for rendering exists in the render method
  • [x] 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
• [x] If any new file was added I verified that:
  • [x] 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
• [x] If a new CSS style is added I verified that:
  • [x] A similar style doesn't already exist
  • [x] The style can't be created with an existing StyleUtils function (i.e. StyleUtils.getBackgroundAndBorderStyle(themeColors.componentBG))
• [x] 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.
• [x] 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)
• [x] 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.
• [x] 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.
• [x] 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.
• [x] I have checked off every checkbox in the PR author checklist, including those that don't apply to this PR.

Screenshots/Videos

Web

https://github.com/Expensify/App/assets/113963320/4879618f-83fb-4945-864c-7d164e583824

https://github.com/Expensify/App/assets/113963320/808e110e-a82f-467b-9169-1bd5024e6cdb

https://github.com/Expensify/App/assets/113963320/2d09ea96-11e7-4192-93c4-9eaa3fd4322e

Mobile Web - Chrome

https://github.com/Expensify/App/assets/113963320/ebf8f6e3-5ead-4547-931a-7fe3201f2f2c

https://github.com/Expensify/App/assets/113963320/63036fc1-3555-4e0e-a9a4-432faa2f56be

Mobile Web - Safari

https://github.com/Expensify/App/assets/113963320/ce779420-7950-4895-b3a3-67256d07353a

https://github.com/Expensify/App/assets/113963320/98ef31e8-93ea-43c9-a961-8486c90a2504

Desktop

https://github.com/Expensify/App/assets/113963320/c292e11d-11d2-46a7-8113-9a63157fceab

iOS

https://github.com/Expensify/App/assets/113963320/d3b03118-5343-429c-9003-5a651962f773

https://github.com/Expensify/App/assets/113963320/03053b0a-51e7-46c4-8ffc-bbeb50f92d85

Android

https://github.com/Expensify/App/assets/113963320/bd10c36f-7dbc-4b2f-8841-e9e028fe9bb2

https://github.com/Expensify/App/assets/113963320/d7da7ae1-67fe-4fc2-bbd7-293fb048d9a6

https://github.com/Expensify/App/assets/113963320/144194ea-50cd-44ea-a879-730a80a442e5

[MitchExpensify]

When do you think this will be ready for review @tienifr ?

[melvin-bot[bot]]

@parasharrajat 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]

[tienifr]

@parasharrajat The expected behaviors in above test cases are referenced from production.

[tienifr]

Updated!

[parasharrajat]

Speaking of this, I realized that we should not subscribe to the focus callback when the composer mounts but when it's focused instead. Subscribing on the mount is redundant.

Why do you think that? What if the composer mounted but not focused by code or the user, Now user took some action which triggered focus on the composer using the FocusManager (ReportActionComposeFocusManager.focus). How will the focus be set on the composer for that?

[tienifr]

I think this comment can explain it: https://github.com/Expensify/App/pull/28238#discussion_r1348523769. Main composer focus callback is set on mount while it's not the case for edit composers.

[tienifr]

@parasharrajat Can we continue?

[parasharrajat]

Yes...Will be finishing testing for this today.

[tienifr]

Thanks, I will add comments in a few minutes!

[parasharrajat]

Bump @tienifr

[MitchExpensify]

Friendly bump @tienifr

[parasharrajat]

Let's keep this moving @tienifr.

[tienifr]

@parasharrajat Can you check again?

we should find a way to set the order to the focus callbacks. Logic should say that now this callback should be called first if both general and main focus callbacks are set.

Based on your comment, I've changed to priority-based approach. The mechanism is almost the same, just function naming is more clear.

[tienifr]

@parasharrajat Take a look when you have time.

[tienifr]

@parasharrajat Waiting for your input.

[parasharrajat]

Thanks for the bump. I will check it soon. I am curious about a PR that is trying to change the focus mechanism for the composer https://github.com/Expensify/App/pull/29199 before we move with this PR.

I think as we waited for so long it might be better to wait on that PR if that aids or reduces complexities around focusing.

[tienifr]

@parasharrajat The PR is closed, should we process this one? I'll try to resolve the conflicts and re-tests tmr

[parasharrajat]

Yes @tienifr. Let's move. We are waiting on your updates https://github.com/Expensify/App/issues/25892#issuecomment-2241922713.

[tienifr]

@parasharrajat This is ready for review again. I'm not sure why Lint failed here but my local lint warned nothing.

[parasharrajat]

Man, I am lost. @tienifr Do you mind summarizing the solution to refresh my memory?

[parasharrajat]

Bump @tienifr

[tienifr]

We're trying to solve 2 issues:

1. Refactor: move the ReportActionComposeFocusManager logic out of the standalone Composer component
2. Solve the OP so that: 2.1. While the emoji picker is open, pressing on any composer will focus on that composer 2.2. Closing the emoji picker should refocus on its parent composer

For 2.1, root cause is that we always refocuses the edit composer when emoji picker is closed:

https://github.com/Expensify/App/blob/e3a9aa8263338722944c9f6aa259a7160ac373a4/src/pages/home/report/ReportActionItemMessageEdit.tsx#L545-L547

Solution is to let ReportActionComposeFocusManager handle which composer to refocus.

For 2.2, we should add a onPress callback to the EmojiPickerButton so that it would return focus back to its parent composer: onPress={setUpComposeFocusManager}. setUpComposeFocusManager will overwrite the focus orders to prioritize the current composer in case of many composers are open.

[tienifr]

@parasharrajat any updates? I tests on all platforms and they work fine

[parasharrajat]

I will be checking this today.

[tienifr]

@parasharrajat any updates?

[tienifr]

friendly bump @parasharrajat

[parasharrajat]

Thanks for the bump @tienifr. I have plenty of time tomorrow so I will check everything for this PR. I need to check a couple of things. Thanks for your patience.

[parasharrajat]

Screenshots

:black_square_button: iOS / native

:black_square_button: iOS / Safari

:black_square_button: MacOS / Desktop

:black_square_button: MacOS / Chrome

:black_square_button: Android / Chrome

:black_square_button: Android / native

[parasharrajat]

Bug: Edit comment does not focus the message being edited.

1. First click edit on a message.
2. Notice the cursor in the edit composer.
3. Now, edit comment on any other message.
4. Notice the cursor is not on the latest edit composer.

[tienifr]

I'm checking