Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix/10731 auto focus input #51172

Merged
merged 24 commits into from
Dec 24, 2024

Conversation

christianwen
Copy link
Contributor

@christianwen christianwen commented Oct 21, 2024

Details

Fixed Issues

$ #10731
PROPOSAL: #10731 (comment)

Tests

  • 10731
  1. Go to any chats
  2. Verify that the composer is focused and the virtual keyboard is not shown. After touching on the composer, the keyboard is shown
  3. Sent any message
  4. Open edit mode
  5. Verify that the keyboard is shown
  6. Tap on the composer to bring up context menu.
  7. Verify the context menu is shown
  • 50683
  1. Login to an account
  2. Open any chat, notice that the composer is focused.
  3. Press on CTRL + K
  4. Press ESC key to dismissed the 'search modal'
  5. Verify that: Composer is focused after dismissing the modal
  • 50722
  1. Open the Hybrid app/NewDot app and log in as user A
  2. On a secondary device as user B send an IOU to user A
  3. On main device as user A open the chat with user B
  4. Select a different payment option on the IOU preview
  5. Verify that: The page does not flicker when changing a payment option
  • Verify that no errors appear in the JS console

Offline tests

Same as above

QA Steps

Same as above

  • 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 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 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
      • 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:
    • 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.js 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.
  • 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
Screen.Recording.2024-10-31.at.11.47.30.mov
Android: mWeb Chrome
Screen.Recording.2024-10-31.at.11.43.17.mov
iOS: Native
Screen.Recording.2024-10-31.at.11.49.52.mov
iOS: mWeb Safari
Screen.Recording.2024-10-31.at.11.39.29.mov
MacOS: Chrome / Safari
Screen.Recording.2024-10-31.at.11.39.54.mov
MacOS: Desktop
Screen.Recording.2024-10-31.at.11.53.43.mov

@christianwen
Copy link
Contributor Author

Updated change compare to previous PR:

For 50683: The PR works well without any change, maybe after moving to chat search modal, it's fixed

For 50722: This issue happens even on main, you can see the flicker when the keyboard open. It's the bug from keyboardAvoidingView, in case the soft keyboard is hidden, we don't need to enable it.

@christianwen christianwen marked this pull request as ready for review October 31, 2024 08:02
@christianwen christianwen requested a review from a team as a code owner October 31, 2024 08:02
@melvin-bot melvin-bot bot requested a review from DylanDylann October 31, 2024 08:02
Copy link

melvin-bot bot commented Oct 31, 2024

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

@DylanDylann
Copy link
Contributor

Reviewing today

if (!textInputRef) {
throw new Error('textInputRef is not available. This should never happen and indicates a developer error.');
}
useImperativeHandle(
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@christianwen Is there any new update on this file?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

no new update, just moved to the new file

@DylanDylann
Copy link
Contributor

@christianwen Could you also please help to merge the latest main?

@christianwen
Copy link
Contributor Author

@DylanDylann I merged main and resolved conflicts

@DylanDylann
Copy link
Contributor

@christianwen It is a bit flicker on Safari

Screen.Recording.2024-11-13.at.18.35.39.mov

@christianwen
Copy link
Contributor Author

@DylanDylann

I removed in shouldFocusInputOnScreenFocus in

(shouldFocusInputOnScreenFocus || (isEmptyChat && !ReportActionsUtils.isTransactionThread(parentReportAction) && !ReportUtils.isTaskReport(report))) &&

since we want to enable autoFocus in every devices.

but it breaks the following logic

if (!((willBlurTextInputOnTapOutside || shouldAutoFocus) && !isNextModalWillOpenRef.current && !modal?.isVisible && isFocused && (!!prevIsModalVisible || !prevIsFocused))) {

Based on this comment

// We want to focus or refocus the input when a modal has been closed or the underlying screen is refocused.
// We avoid doing this on native platforms since the software keyboard popping
// open creates a jarring and broken UX.

we need to add shouldFocusInputOnScreenFocus again in the above condition

@DylanDylann
Copy link
Contributor

DylanDylann commented Nov 18, 2024

@christianwen BUG on safari: when going to the chat, the cursor displays in the middle or in the end of the composer in a moment
Step:

  1. Go to chat A (Don't see the bug)
  2. Back to LHN
  3. Go to chat A (See the Bug)
  4. Back to LHN
  5. Go to chat A (See the Bug)
Screen.Recording.2024-11-18.at.16.39.33.mov

@christianwen
Copy link
Contributor Author

@DylanDylann

The cursor is hidden when the transition is not finished on staging

Screen.Recording.2024-11-20.at.15.56.44.mov

But when the inputMode is none the cursor is not hidden during report transition. I spent time to invest, unfortunately, I didn't find the RCA, so I just hide the cursor same as what happens on staging.

@DylanDylann
Copy link
Contributor

@christianwen With your solution, the draft message will not display right after going to the chat

Screen.Recording.2024-11-20.at.17.44.38.mov

@DylanDylann
Copy link
Contributor

DylanDylann commented Dec 5, 2024

@christianwen Please try more time

Screen.Recording.2024-12-05.at.17.25.00.mov

@DylanDylann
Copy link
Contributor

Flicker on IOS

  1. Go to any chat that have draft message
  2. Edit message
  3. Click X
Screen.Recording.2024-12-05.at.17.40.06.mov

@DylanDylann
Copy link
Contributor

@christianwen Kindly bump

@christianwen
Copy link
Contributor Author

@DylanDylann I fixed. Pls check again

@christianwen christianwen force-pushed the fix/10731-auto-focus-input branch from 7c602dc to 8b8510b Compare December 17, 2024 11:18
@DylanDylann
Copy link
Contributor

@christianwen The change looks fine. Could you please merge the latest main?

@DylanDylann
Copy link
Contributor

@christianwen For the failed Eslint, could you also fix it?

@DylanDylann
Copy link
Contributor

DylanDylann commented Dec 23, 2024

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
Screen.Recording.2024-12-23.at.16.00.24.mov
Android: mWeb Chrome
Screen.Recording.2024-12-23.at.16.01.18.mov
iOS: Native
Screen.Recording.2024-12-23.at.15.57.07.mov
iOS: mWeb Safari
Screen.Recording.2024-12-23.at.15.59.34.mov
MacOS: Chrome / Safari
Screen.Recording.2024-12-23.at.16.01.40.mov
MacOS: Desktop
Screen.Recording.2024-12-23.at.16.02.31.mov

@christianwen
Copy link
Contributor Author

@DylanDylann merged

@christianwen
Copy link
Contributor Author

@DylanDylann I also updated the default value to avoid eslint error

@DylanDylann
Copy link
Contributor

Same here: #32711 (comment)

Just a note:
Reassure Performance Tests
As mentioned above

Updated! For the perf issue, we shouldn't mind about it since this test is to compare the number of re-render when users interact with input in baseline (from main) with the current behavior (this PR). In this PR we try to open the keyboard when they focus on the composer -> it takes 2 times to re-render

This PR will change the current behavior on purpose

Copy link
Contributor

@DylanDylann DylanDylann left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@melvin-bot melvin-bot bot requested a review from iwiznia December 23, 2024 09:08
@DylanDylann
Copy link
Contributor

@iwiznia All yours

@christianwen
Copy link
Contributor Author

@DylanDylann @iwiznia I updated

@iwiznia
Copy link
Contributor

iwiznia commented Dec 24, 2024

Hmmm performance tests are failing

@DylanDylann
Copy link
Contributor

@iwiznia It is intentional as explained here

@iwiznia iwiznia merged commit 8819d9c into Expensify:main Dec 24, 2024
15 of 16 checks passed
@OSBotify
Copy link
Contributor

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants