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 the viewport is scrolled to bottom when the search modal shows while a keyboard is visible #55704

Conversation

bernhardoj
Copy link
Contributor

@bernhardoj bernhardoj commented Jan 24, 2025

Explanation of Change

Fixed Issues

$ #53136
PROPOSAL: #53136 (comment)

Tests

Same as QA Steps

  • Verify that no errors appear in the JS console

Offline tests

Same as QA Steps

QA Steps

  1. Open any chat
  2. Focus on the composer (verify the keyboard shows on mobile)
  3. Press on the search button at the header
  4. Verify the search modal/page is not scrolled to the bottom
  • 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 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
android.mweb.mp4
iOS: Native
ios.mp4
iOS: mWeb Safari
ios.mweb.mp4
MacOS: Chrome / Safari
web.mp4
MacOS: Desktop
desktop.mp4

@bernhardoj bernhardoj requested a review from a team as a code owner January 24, 2025 06:59
@melvin-bot melvin-bot bot requested review from DylanDylann and removed request for a team January 24, 2025 06:59
Copy link

melvin-bot bot commented Jan 24, 2025

@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

DylanDylann commented Jan 27, 2025

@bernhardoj I can see the search page is flickering clearly. If you can't reproduce it, you can make the search list longer and try again

Screen.Recording.2025-01-28.at.01.25.38.mov

@bernhardoj
Copy link
Contributor Author

Oh, I think it's acceptable. I mentioned that in this comment.

I decided to use the scroll option because of the 2nd point in this comment. This also happens on the report screen, but I personally prefer doing the scroll option.

@DylanDylann
Copy link
Contributor

@bernhardoj Is there any problem with your first solution (using useViewportOffsetTop)? I see It worked well without flicker

@bernhardoj
Copy link
Contributor Author

@DylanDylann it's the same problem with the report screen. When you close the keyboard, the header will move as shown in the first video on my proposal.

@DylanDylann
Copy link
Contributor

@bernhardoj

When you close the keyboard, the header will move as shown in the first video on my #53136 (comment).

Could you improve that behavior?

@DylanDylann
Copy link
Contributor

Or please help to solve this problem

@DylanDylann
Copy link
Contributor

@bernhardoj Any update?

@bernhardoj
Copy link
Contributor Author

Honestly, I can't think of a way to improve it. I tried using both solutions (pad it with offset top and scroll the viewport to the top) but it looks worse.

h.mp4

Maybe it's safer to go with the padding solution since the report screen also behaves that way?

@DylanDylann
Copy link
Contributor

@bernhardoj Yeah, I just checked again and I think it is acceptable. Could you update to use your first solution in the proposal?

@bernhardoj
Copy link
Contributor Author

Updated

@DylanDylann
Copy link
Contributor

@bernhardoj Could you upload videos again?

@DylanDylann
Copy link
Contributor

When navigating to the search page, the cursor jumps to the middle of the input in a moment. @bernhardoj Did you see this problem?

Screen.Recording.2025-02-12.at.17.44.09.mov

@bernhardoj
Copy link
Contributor Author

When navigating to the search page, the cursor jumps to the middle of the input in a moment. @bernhardoj Did you see this problem?

Yeah, but I noticed it happen on main too, even without the composer being focused. I previously fixed it here: #52659

asad.mp4

But looks like it's not working anymore. I even tried to hardcode the caretHidden to BaseTextInput, but it doesn't work.

@bernhardoj
Copy link
Contributor Author

Found a padding problem on native. Will fix it tomorrow

@bernhardoj
Copy link
Contributor Author

Fixed. Updated the recordings.

@DylanDylann
Copy link
Contributor

DylanDylann commented Feb 13, 2025

@bernhardoj Could you fix this problem on this PR? I know it also happens on the main and this seems to be out of the scope of this PR. But it will cause weird behavior to our users

Screen.Recording.2025-02-13.at.16.00.47.mov

@bernhardoj
Copy link
Contributor Author

I even tried to hardcode the caretHidden to BaseTextInput, but it doesn't work.

I will see if I can find the issue because as I mention, the props doesn't work at all.

@bernhardoj
Copy link
Contributor Author

Ah, I see. The search input is rendered with react-native-live-markdown, and it currently doesn't support caretHidden.

@DylanDylann
Copy link
Contributor

The search input is rendered with react-native-live-markdown, and it currently doesn't support caretHidden.

It looks like we need to make a fix on react-native-live-markdown

@DylanDylann
Copy link
Contributor

Could you process it too?

@bernhardoj
Copy link
Contributor Author

here is the pr: Expensify/react-native-live-markdown#621

@bernhardoj
Copy link
Contributor Author

There are 3 versions behind the version which contains the caretHidden fix.
current version: 0.1.230
caretHidden version: 0.1.234

Do we really need to wait for it? It's already happening on prod. There is also a new 0.1.235, so we can just let them update the version.

@DylanDylann
Copy link
Contributor

@bernhardoj Could you verify if this bug is solved on the new version?

@bernhardoj
Copy link
Contributor Author

0.1.235 has the bug resolved because our fix is in 0.1.234

@DylanDylann
Copy link
Contributor

@bernhardoj I think we can bump live-markdown version on this PR

@bernhardoj
Copy link
Contributor Author

Updated. Hopefully, there won't be an issue with 0.1.231-0.1.233, otherwise, I will need to redo this PR.

@DylanDylann
Copy link
Contributor

@bernhardoj BUG: When clicking back button from search page, the header of report is located in wrong places

Screen.Recording.2025-02-21.at.16.12.19.mov

@bernhardoj
Copy link
Contributor Author

I can't seem to repro it.

aa.mp4

Maybe because I just merged with main? Can you please try again?

Copy link
Contributor

⚠️ This PR is possibly changing native code, it may cause problems with HybridApp. Please run an AdHoc build to verify that HybridApp will not break. ⚠️

Copy link
Contributor

🚧 @dylanexpensify has triggered a test hybrid app build. You can view the workflow run here.

Copy link
Contributor

🧪🧪 Use the links below to test this adhoc build on Android, iOS, Desktop, and Web. Happy testing! 🧪🧪

Android 🤖 iOS 🍎
https://ad-hoc-expensify-cash.s3.amazonaws.com/android//index.html https://ad-hoc-expensify-cash.s3.amazonaws.com/ios//index.html
Android iOS
Desktop 💻 Web 🕸️
N/A N/A
N/A N/A

👀 View the workflow run that generated this build 👀

@DylanDylann
Copy link
Contributor

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.2025-02-24.at.18.19.11.mov
Android: mWeb Chrome
Screen.Recording.2025-02-24.at.17.00.02.mov
iOS: Native
Screen.Recording.2025-02-24.at.18.30.08.mov
iOS: mWeb Safari
Screen.Recording.2025-02-24.at.16.59.40.mov
MacOS: Chrome / Safari
Screen.Recording.2025-02-24.at.17.00.53.mov
MacOS: Desktop
Screen.Recording.2025-02-24.at.17.03.12.mov

@melvin-bot melvin-bot bot requested a review from youssef-lr February 24, 2025 11:42
@DylanDylann
Copy link
Contributor

Test well on Android Hybrid App

Screenrecorder-2025-02-24-18-40-21-224-2025-02-24.11_43_18.777.mp4

@ZhenjaHorbach
Copy link
Contributor

Looks good on IOS Hybrid App !

IMG_9156.MP4

youssef-lr
youssef-lr previously approved these changes Feb 24, 2025
@youssef-lr
Copy link
Contributor

@bernhardoj can you take look at conflicts please

@bernhardoj
Copy link
Contributor Author

@youssef-lr Fixed

Copy link
Contributor

⚠️ This PR is possibly changing native code, it may cause problems with HybridApp. Please run an AdHoc build to verify that HybridApp will not break. ⚠️

@youssef-lr youssef-lr merged commit 4fe7c70 into Expensify:main Feb 26, 2025
25 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.

Copy link
Contributor

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

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

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

Successfully merging this pull request may close these issues.

6 participants