Fix iOS Composer highlight flicker after closing attachment modal #54670

ikevin127 · 2024-12-30T21:03:52Z

Explanation of Change

PR #34404 introduced the useResetComposerFocus in order to deal with issuehttps://github.com//issues/33466. Months after that we introduced ComposeFocusManager with PR #35572 which was put place in for advanced focus management when opening / closing modals. Because of the 2 conflicting focus callers we got the issue which this PR fixes - the fix is adjusting useResetComposerFocus to only call focus when we're not coming back from a modal (see PR #34404 test steps for details).

Fixed Issues

$ #54615
PROPOSAL: #54615 (comment)

Tests

Note: This is a Native or HybridApp specific issue and fix.

Launch Native or HybridApp.
Go to DM.
Send an image to the DM.
Go back to LHN and reopen DM (so that composer is auto-focused without keyboard opening).
Tap on the image.
Tap app back button.
Verify that the composer is re-focused only once without any additional on/off flicker.

Caution

On mWeb step (7.) will fail because it didn't work like that before this PR either - this can be verified on staging / production before this PR is deployed on any of the two. On mWeb the current / expected behaviour is that the composer won't re-focus when returning back from attachment modal.

Additional test steps from PR #34404 / #33466 Issue :

Launch Native or HybridApp.
Tap on a report.
Long press any sent message and select Edit comment.
Note that the main composer will be hidden when the edit comment composer is displayed and focused.
Tap report header.
Tap back button.
Verify that when user is in edit comment mode, the main compose box should not be shown after tapping header and returning back.

Caution

On mWeb step (6.) will fail because it didn't work like that before this PR either - this can be verified on staging / production before this PR is deployed on any of the two. On mWeb the current / expected behaviour is that the main composer and the edit comment composer will both show at the same time and none of them will be focused when returning back report details screen.

Verify that no errors appear in the JS console

Offline tests

N/A.

QA Steps

Note: This is a Native or HybridApp specific issue and fix.

Launch Native or HybridApp.
Go to DM.
Send an image to the DM.
Go back to LHN and reopen DM (so that composer is auto-focused without keyboard opening).
Tap on the image.
Tap app back button.
Verify that the composer is re-focused only once without any additional on/off flicker.

Caution

On mWeb step (7.) will fail because it didn't work like that before this PR either - this can be verified on staging / production before this PR is deployed on any of the two. On mWeb the current / expected behaviour is that the composer won't re-focus when returning back from attachment modal.

Additional test steps from PR #34404 / #33466 Issue :

Launch Native or HybridApp.
Tap on a report.
Long press any sent message and select Edit comment.
Note that the main composer will be hidden when the edit comment composer is displayed and focused.
Tap report header.
Tap back button.
Verify that when user is in edit comment mode, the main compose box should not be shown after tapping header and returning back.

Caution

On mWeb step (6.) will fail because it didn't work like that before this PR either - this can be verified on staging / production before this PR is deployed on any of the two. On mWeb the current / expected behaviour is that the main composer and the edit comment composer will both show at the same time and none of them will be focused when returning back report details screen.

Verify that no errors appear in the JS console

PR Author Checklist

Screenshots/Videos

Android: Native

android.mp4

Android: mWeb Chrome

android-mweb.mp4

iOS: Native

after-main.mp4

iOS: mWeb Safari

ios-mweb.mp4

MacOS: Chrome / Safari

web.mov

MacOS: Desktop

desktop.mov

melvin-bot · 2024-12-30T21:03:57Z

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

src/hooks/useResetComposerFocus.ts

shubham1206agra · 2025-01-06T09:30:05Z

@ikevin127 Can we fix this test too?

Launch Native or HybridApp.
Go to DM.
Send an image to the DM.
Go back to LHN and reopen DM (so that composer is auto-focused without keyboard opening).
Long press any sent message and select Edit comment.
Note that the main composer will be hidden when the edit comment composer is displayed and focused.
Tap on the image.
Tap app back button.
Verify that the composer is re-focused only once without any additional on/off flicker.

Main branch behavior is that the keyboard flickers, but this PR will not focus on the input.

ikevin127 · 2025-01-06T23:34:47Z

@shubham1206agra Yes, I can tackle that one, here's the solution I arrived to:

In order to focus the edit input and fix the current main branch broken behaviour would require calling the useResetComposerFocus focus() logic after interactions which means we would have to use InteractionManager.runAfterInteractions() and remove the current PRs logic which checks if modal was previously opened, the logic would be the following:

Note

With this, the hook will still call focus() but it won't call it right away because that would cause the flicker when the modal re-focus logic kicks in and they'd conflict.

The reason why this is the only solution that works in our case to pass all tests and fix the current main branch issue is because with the previous solution, even if we keep the previous modal open logic and skip the early return for when edit composer is focused, this would still not focus the main composer after returning back from the edit composer (see video below).

iOS: Native (no focus on main after edit)

ios-no-focus-after-edit.mp4

useEffect(() => {
    if (!isFocused || !shouldResetFocusRef.current) {
        return;
    }
    const interactionManagerRef = InteractionManager.runAfterInteractions(() => {
        inputRef.current?.focus(); // focus input again
        shouldResetFocusRef.current = false;
    });
    return () => interactionManagerRef.cancel();
}, [isFocused, inputRef]);

with these changes the behaviour would cover all tests + fix the current broken behaviour from main branch:

iOS: Native (preview)

ios.mp4

Please let me know if you agree with this approach and I will apply the changes right away!

shubham1206agra · 2025-01-07T03:36:24Z

@ikevin127 Please make the changes.

ikevin127 · 2025-01-07T09:19:48Z

@ikevin127 Please make the changes.

@shubham1206agra Updated solution was applied, PR is ready for review once again and is passing all tests including #54670 (comment).

shubham1206agra · 2025-01-08T07:32:45Z

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 tests pass on all platforms & I tested again on:
- Android: Native
- Android: mWeb Chrome
- iOS: Native
- 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 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: Native

Screen.Recording.2025-01-08.at.12.58.28.PM.mov

Android: mWeb Chrome

iOS: Native

Screen.Recording.2025-01-08.at.12.49.32.PM.mov

iOS: mWeb Safari

MacOS: Chrome / Safari

Screen.Recording.2025-01-08.at.12.31.07.PM.mov

MacOS: Desktop

Screen.Recording.2025-01-08.at.12.43.04.PM.mov

Beamanator

LGTM!

OSBotify · 2025-01-08T08:28:33Z

✋ 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-01-10T03:57:43Z

🚀 Deployed to staging by https://github.com/Beamanator in version: 9.0.83-0 🚀

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

github-actions · 2025-01-11T03:25:29Z

🚀 Deployed to production by https://github.com/thienlnam in version: 9.0.83-5 🚀

platform	result
🤖 android 🤖	true ❌
🖥 desktop 🖥	success ✅
🍎 iOS 🍎	success ✅
🕸 web 🕸	success ✅
🤖🔄 android HybridApp 🤖🔄	failure ❌
🍎🔄 iOS HybridApp 🍎🔄	success ✅

github-actions · 2025-01-13T13:58:50Z

🚀 Deployed to production by https://github.com/thienlnam in version: 9.0.83-5 🚀

platform	result
🤖 android 🤖	true ❌
🖥 desktop 🖥	success ✅
🍎 iOS 🍎	success ✅
🕸 web 🕸	success ✅
🤖🔄 android HybridApp 🤖🔄	failure ❌
🍎🔄 iOS HybridApp 🍎🔄	success ✅

Fix composer highlight flickers after closing attachment view

f124c97

ikevin127 requested a review from a team as a code owner December 30, 2024 21:03

melvin-bot bot requested review from shubham1206agra and removed request for a team December 30, 2024 21:03

ikevin127 mentioned this pull request Dec 30, 2024

[HOLD for payment 2025-01-18] [$250] iOS - Composer - Composer highlight flickers after closing attachment view #54615

Closed

8 tasks

shubham1206agra reviewed Jan 3, 2025

View reviewed changes

src/hooks/useResetComposerFocus.ts Outdated Show resolved Hide resolved

adjusted solution to fix additional issue

8fce2ab

shubham1206agra approved these changes Jan 8, 2025

View reviewed changes

melvin-bot bot requested a review from Beamanator January 8, 2025 07:33

Beamanator approved these changes Jan 8, 2025

View reviewed changes

Beamanator merged commit 9293c26 into Expensify:main Jan 8, 2025
17 checks passed

github-actions bot mentioned this pull request Jan 10, 2025

Deploy Checklist: New Expensify 2025-01-10 #55051

Closed

54 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Fix iOS Composer highlight flicker after closing attachment modal #54670

Fix iOS Composer highlight flicker after closing attachment modal #54670

ikevin127 commented Dec 30, 2024

melvin-bot bot commented Dec 30, 2024

shubham1206agra commented Jan 6, 2025

ikevin127 commented Jan 6, 2025

shubham1206agra commented Jan 7, 2025

ikevin127 commented Jan 7, 2025

shubham1206agra commented Jan 8, 2025

Beamanator left a comment

OSBotify commented Jan 8, 2025

github-actions bot commented Jan 10, 2025

github-actions bot commented Jan 11, 2025

github-actions bot commented Jan 13, 2025

Fix iOS Composer highlight flicker after closing attachment modal #54670

Fix iOS Composer highlight flicker after closing attachment modal #54670

Conversation

ikevin127 commented Dec 30, 2024

Explanation of Change

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

melvin-bot bot commented Dec 30, 2024

shubham1206agra commented Jan 6, 2025

ikevin127 commented Jan 6, 2025

shubham1206agra commented Jan 7, 2025

ikevin127 commented Jan 7, 2025

shubham1206agra commented Jan 8, 2025

Reviewer Checklist

Screenshots/Videos

Beamanator left a comment

Choose a reason for hiding this comment

OSBotify commented Jan 8, 2025

github-actions bot commented Jan 10, 2025

github-actions bot commented Jan 11, 2025

github-actions bot commented Jan 13, 2025