Fix focus loss after message deletion in edit mode #49538

Shahidullah-Muffakir · 2024-09-20T14:13:17Z

Details

This PR fixes a problem where deleting a message while editing causes the text input area (composer) to lose focus. The issue was caused by a mistake in how a callback function was assigned, which led to unexpected behavior. The solution is to call the runAndResetCallback function directly to make sure it works correctly and resets as needed. Also, I corrected some typos in the references to onConfirmDeleteModal to avoid any future errors.

Fixed Issues

$#45472
PROPOSAL:#45472 (comment)

Tests

Start the ND Desktop App or go to staging.new.expensify.com and log in with any account.
Open any chat and send a message.
Press the Arrow Up key, then use Ctrl + A (or Cmd + A) to select all text, followed by the 'Delete' key.
Press 'Enter' to confirm the deletion.
Ensure that the focus remains on the composer field after deletion.

Verify that no errors appear in the JS console

Offline tests

Same as tests.

QA Steps

same as tests.

Verify that no errors appear in the JS console

PR Author Checklist

Screenshots/Videos

Android: Native

This feature is only supported on the desktop app and web.

Android: mWeb Chrome

This feature is only supported on the desktop app and web.

iOS: Native

This feature is only supported on the desktop app and web..

iOS: mWeb Safari

This feature is only supported on the desktop app and web.

MacOS: Chrome / Safari

safari.mov

MacOS: Desktop

desktop.mov

melvin-bot · 2024-09-20T14:13:22Z

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

Shahidullah-Muffakir · 2024-09-20T14:22:58Z

@brunovjk, It seems the linting error in PopoverReportActionContextMenu.tsx is unrelated to the changes made in this PR, as I haven't modified that file. The error is related to the use of the deprecated substr() method. Would you like me to address this issue in this PR, or should it be handled separately? Thank you.

App/src/pages/home/report/ContextMenu/PopoverReportActionContextMenu.tsx

Line 228 in c666296

setInstanceID(Math.random().toString(36).substr(2, 5));

brunovjk · 2024-09-20T14:30:21Z

@brunovjk, It seems the linting error in PopoverReportActionContextMenu.tsx is unrelated to the changes made in this PR, as I haven't modified that file. The error is related to the use of the deprecated substr() method. Would you like me to address this issue in this PR, or should it be handled separately? Thank you.

App/src/pages/home/report/ContextMenu/PopoverReportActionContextMenu.tsx

Line 228 in c666296

setInstanceID(Math.random().toString(36).substr(2, 5));

Good work so far @Shahidullah-Muffakir. Good question, I'll ask on Slack about it and get back here. Thanks.

Shahidullah-Muffakir · 2024-09-20T16:12:15Z

@brunovjk, my bad about the earlier message. I got it wrong. The linting error is actually in the same file where we made our PR changes.
The problem is with the substr() method, which is old and not recommended anymore. We can fix it pretty easily by changing substr to slice.
Want me to go ahead and make this change in our current PR? Let me know what you think.

We will modify

App/src/pages/home/report/ContextMenu/PopoverReportActionContextMenu.tsx

Line 228 in c666296

setInstanceID(Math.random().toString(36).substr(2, 5));

To:
setInstanceID(Math.random().toString(36).slice(2, 7));

Both extract 5 characters starting from index 2.
substr(2, 5) means "start at index 2, take 5 characters"
slice(2, 7) means "start at index 2, end before index 7" (which is also 5 characters)

brunovjk · 2024-09-20T16:34:53Z

Great @Shahidullah-Muffakir! I'm waiting for someone to comment on Slack, if nothing happens by Monday, please feel free to make the necessary updates and then we'll hand it over to an internal reviewer. What do you think? Thanks.

Shahidullah-Muffakir · 2024-09-20T16:43:57Z

@brunovjk, Sounds good to me. We'll wait until Monday for any comments on Slack. Thank you!

brunovjk · 2024-09-21T14:59:10Z

@Shahidullah-Muffakir Do you also see a delay to focus the composer? Thanks.
Desktop:

Screen.Recording.2024-09-21.at.11.45.50.mov

Chorme:

Screen.Recording.2024-09-21.at.11.46.42.mov

In native it doesn't:

Screen.Recording.2024-09-21.at.11.55.15.mov

I wonder if in native it should focus the composer after deleting/editing a message, according to the issue "Web/Desktop - Chat - Focus is lost ..." I dont think so, what do you think @youssef-lr? Thank you.

Shahidullah-Muffakir · 2024-09-21T15:31:35Z

@brunovjk, Yes, I see the same delay in focusing the composer. It seems like the delay might be caused by the time it takes to process the message deletion request. I believe this line of code could be the reason for the delay:

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

Line 297 in 9160fa5

Report.deleteReportActionDraft(reportID, action);

Not sure if there’s much we can do about this, Thank you.

brunovjk · 2024-09-23T20:02:46Z

@Shahidullah-Muffakir Let's move forward and resolve this lint issue, okay?
"This feature is only supported on the desktop app and web" Are you sure about this? I think so too, but I'd like to confirm before moving forward.

Shahidullah-Muffakir · 2024-09-23T20:40:21Z

@Shahidullah-Muffakir Let's move forward and resolve this lint issue, okay? "This feature is only supported on the desktop app and web" Are you sure about this? I think so too, but I'd like to confirm before moving forward.

@brunovjk, Sure, I'll take care of the lint issue.

As for the native apps, the issue description (#45472) mentions pressing the Up Arrow Key to edit a message. Since that's not possible on mobile apps, that's why I said it's only supported on desktop and web.

However, on mobile, if we edit a comment by tapping on it, clear the text, and confirm the deletion through the modal, the input is refocused as expected. I tested this, and it works fine on mobile.

Screen.Recording.2024-09-24.at.2.08.31.AM.mov

Shahidullah-Muffakir · 2024-09-23T21:54:09Z

@brunovjk I’ve fixed the linting issue. Thank you.

brunovjk · 2024-09-25T14:49:46Z

The changes seem good to me @Shahidullah-Muffakir, but I'm still unsure about the expected behavior on different platforms. I tested on Web and Desktop and apart from the small delay it seems good to me:

MacOS: Chrome / Safari

49538_web_chorme.mov

MacOS: Desktop

49538_web_desktop.mov

On emulators, both web and native, the composer is not focused after deleting a comment, but even when editing (which is not the focus of this PR) the composer is not focused as well.

Android: Native

49538_android_native.mov

Android: mWeb Chrome

49538_android_web.mov

iOS: Native

49538_ios_native.mov

With that, @youssef-lr Do you confirm that the main composer should be focused when deleting messages only on web/desktop? I didn't find any reported issue about the main composer not being focused when editing either. Can you confirm the expected behavior of "focus main composer" on different platforms after deleting a message? Thank you very much.

youssef-lr · 2024-10-01T13:14:34Z

Can you confirm the expected behavior of "focus main composer" on different platforms after deleting a message?

I think it's the same behavior on every platform.

brunovjk · 2024-10-01T14:51:02Z

@Shahidullah-Muffakir Following @youssef-lr s comment, do you think we can update the behavior? At first glance it seems a bit out of scope, I'm not sure, but if that's the case we can try an increase in compensation (not guaranteed). Please, let me know what you think and your findings. Thank you.

Shahidullah-Muffakir · 2024-10-02T09:07:37Z

Hi @youssef-lr and @brunovjk,

I'm not sure if it's necessary to focus on the input field in the native apps. Based on a discussion I found in our Slack channel, the reason we don't focus the composer in native apps is that it would trigger the keyboard to open, which takes up half the screen. This isn't ideal for the user experience. We don't want to assume the user wants to start typing immediately, and the sudden appearance of the keyboard can feel jarring.

Links to the slack discussions: https://expensify.slack.com/archives/C01GTK53T8Q/p1696528231560429

and here: https://expensify.slack.com/archives/C01GTK53T8Q/p1617206989251400?thread_ts=1617201995.245400&cid=C01GTK53T8Q

Also, since the original issue only mentions desktop, this could be why the focus behavior is different there.
Thank you.

brunovjk · 2024-10-02T13:37:18Z

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 the left part of a conditional rendering a React component is a boolean and NOT a string, e.g. myBool && <MyComponent />.
- 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.js 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.
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

Android-.Native.mov

Android: mWeb Chrome

Android-.mWeb.Chrome.mov

iOS: Native

iOS-.Native.mov

iOS: mWeb Safari

iOS-.web.mov

MacOS: Chrome / Safari

MacOS-.Chrome.Safari.mov

MacOS: Desktop

MacOS-.Desktop.mov

brunovjk

Great @Shahidullah-Muffakir! This is the investigation we needed, good work!! Thank you.

I just retested it and everything looks good to me :D Do you agree @youssef-lr?

youssef-lr

LGTM!

OSBotify · 2024-10-10T19:54:37Z

✋ 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 · 2024-10-10T23:10:53Z

🚀 Deployed to staging by https://github.com/youssef-lr in version: 9.0.48-0 🚀

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

github-actions · 2024-10-15T03:16:34Z

🚀 Deployed to production by https://github.com/marcaaron in version: 9.0.48-2 🚀

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

Fix focus loss after message deletion in edit mode and correct typos

07c6a23

Shahidullah-Muffakir requested a review from a team as a code owner September 20, 2024 14:13

melvin-bot bot requested a review from brunovjk September 20, 2024 14:13

melvin-bot bot removed the request for review from a team September 20, 2024 14:13

Merge branch 'main' of github.com:Expensify/App into fix/45472

980dd18

Shahidullah-Muffakir added 2 commits September 24, 2024 02:18

Fix linting issue

a01cdfd

Merge branch 'main' of github.com:Expensify/App into fix/45472

a5e6ef5

brunovjk approved these changes Oct 2, 2024

View reviewed changes

melvin-bot bot requested a review from youssef-lr October 2, 2024 13:37

brunovjk mentioned this pull request Oct 9, 2024

[HOLD for payment 2024-10-22] [$250] Web/Desktop - Chat - Focus is lost after deleting a message from edit mode #45472

Closed

6 tasks

youssef-lr assigned Shahidullah-Muffakir Oct 10, 2024

youssef-lr approved these changes Oct 10, 2024

View reviewed changes

youssef-lr merged commit 0984f7d into Expensify:main Oct 10, 2024
18 of 19 checks passed

github-actions bot mentioned this pull request Oct 10, 2024

Deploy Checklist: New Expensify 2024-10-10 #50603

Closed

38 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Fix focus loss after message deletion in edit mode #49538

Fix focus loss after message deletion in edit mode #49538

Shahidullah-Muffakir commented Sep 20, 2024

melvin-bot bot commented Sep 20, 2024

Shahidullah-Muffakir commented Sep 20, 2024

brunovjk commented Sep 20, 2024 •

edited

Loading

Shahidullah-Muffakir commented Sep 20, 2024 •

edited

Loading

brunovjk commented Sep 20, 2024

Shahidullah-Muffakir commented Sep 20, 2024

brunovjk commented Sep 21, 2024 •

edited

Loading

Shahidullah-Muffakir commented Sep 21, 2024

brunovjk commented Sep 23, 2024

Shahidullah-Muffakir commented Sep 23, 2024

Shahidullah-Muffakir commented Sep 23, 2024

brunovjk commented Sep 25, 2024 •

edited

Loading

youssef-lr commented Oct 1, 2024

brunovjk commented Oct 1, 2024 •

edited

Loading

Shahidullah-Muffakir commented Oct 2, 2024

brunovjk commented Oct 2, 2024 •

edited

Loading

brunovjk left a comment •

edited

Loading

youssef-lr left a comment

OSBotify commented Oct 10, 2024

github-actions bot commented Oct 10, 2024

github-actions bot commented Oct 15, 2024

Fix focus loss after message deletion in edit mode #49538

Fix focus loss after message deletion in edit mode #49538

Conversation

Shahidullah-Muffakir commented Sep 20, 2024

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

melvin-bot bot commented Sep 20, 2024

Shahidullah-Muffakir commented Sep 20, 2024

brunovjk commented Sep 20, 2024 • edited Loading

Shahidullah-Muffakir commented Sep 20, 2024 • edited Loading

brunovjk commented Sep 20, 2024

Shahidullah-Muffakir commented Sep 20, 2024

brunovjk commented Sep 21, 2024 • edited Loading

Shahidullah-Muffakir commented Sep 21, 2024

brunovjk commented Sep 23, 2024

Shahidullah-Muffakir commented Sep 23, 2024

Shahidullah-Muffakir commented Sep 23, 2024

brunovjk commented Sep 25, 2024 • edited Loading

youssef-lr commented Oct 1, 2024

brunovjk commented Oct 1, 2024 • edited Loading

Shahidullah-Muffakir commented Oct 2, 2024

brunovjk commented Oct 2, 2024 • edited Loading

Reviewer Checklist

Screenshots/Videos

brunovjk left a comment • edited Loading

Choose a reason for hiding this comment

youssef-lr left a comment

Choose a reason for hiding this comment

OSBotify commented Oct 10, 2024

github-actions bot commented Oct 10, 2024

github-actions bot commented Oct 15, 2024

brunovjk commented Sep 20, 2024 •

edited

Loading

Shahidullah-Muffakir commented Sep 20, 2024 •

edited

Loading

brunovjk commented Sep 21, 2024 •

edited

Loading

brunovjk commented Sep 25, 2024 •

edited

Loading

brunovjk commented Oct 1, 2024 •

edited

Loading

brunovjk commented Oct 2, 2024 •

edited

Loading

brunovjk left a comment •

edited

Loading