26401 avoid scroll on virtual viewport

[suneox]

Details

Fixed Issues

$ https://github.com/Expensify/App/issues/26401 PROPOSAL: https://github.com/Expensify/App/issues/26401#issuecomment-1764965213

Tests

1. Go to settings-> Click Profile
2. Click personal details -> Click legal name
3. Focus on any text field -> Swipe up to scroll
4. Verify after scrolling to the bottom, the unexpected space is not display and the user can continue to scroll up

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

Offline tests

QA Steps

1. Go to settings-> Click Profile
2. Click personal details -> Click legal name
3. Focus on any text field -> Swipe up to scroll
4. Verify after scrolling to the bottom, the unexpected space is not display and the user can continue to scroll up

• [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: mWeb Chrome
  • [x] iOS: Native
  • [x] iOS: mWeb 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 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(theme.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 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.
• [x] If the PR modifies the form input styles:
  • [x] I verified that all the inputs inside a form are aligned with each other.
  • [x] I added Design label so the design team can review the changes.
• [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.

Screenshots/Videos

Android: Native

https://github.com/Expensify/App/assets/11959869/0275ebb6-532e-4bd5-99b6-fc2af05bf4f1

Android: mWeb Chrome

https://github.com/Expensify/App/assets/11959869/722a8a64-f34d-43f5-8f94-217f249f8fc2

iOS: Native

https://github.com/Expensify/App/assets/11959869/ed78b329-3be7-45cb-8b84-926a478f4fb1

iOS: mWeb Safari

https://github.com/Expensify/App/assets/11959869/f1187b25-369e-4d13-a5b0-7100df885fd4

MacOS: Chrome / Safari

https://github.com/Expensify/App/assets/11959869/00cf20e1-240f-4458-8db9-8d1bf25d4a2b

MacOS: Desktop

https://github.com/Expensify/App/assets/11959869/a5cebd56-334b-4a40-96c0-97fd4b271abf

[melvin-bot[bot]]

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

[suneox]

Hi @fedirjh I have fix code lint, prettier, and this PR is ready to review

[fedirjh]

@suneox Sure, reviewing shortly.

[suneox]

Let's fix this bug in other places too:

• Profile display name
• Add new contact method
• Workspace settings -> name
• Private notes: nagivate to report -> click on report header
• Request money flow: there are several pages (waypoint selection, request flow, set merchant, description..)
• Task Flow (create, task title edit, task description edit)

Hi @fedirjh, I would like to confirm the scope for this PR about the list pages above. Is it an extended scope for this ticket? and some page I can not found step to access ST like

• Add new contact method
• Request money flow: request flow, set merchant, description..

and "..." is meaning for how many page?

@suneox What would happen if we enable shouldAwareViewportScroll by default ? will this affect scrollable views?

I'm not sure when we enable shouldAwareViewportScroll will not raise regression due to the scroll behavior on mWeb/Safari can be different for each page structure, so I think we should keep disable by default.

I have checked the list page you have provided above almost work well. Excludes

• Add new contact method (missing step to open)
• Request money flow: request flow, set merchant, description.. (missing step to open)
• Task Flow: task description edit

What do you think if we separate the scope for this ticket?

[fedirjh]

I would like to confirm the scope for this PR about the list pages above. Is it an extended scope for this ticket? and some page I can not found step to access ST like

@suneox We already implemented the main fix within the ScreenWrapper which is a global component used by all pages, so we should just add the new prop for all affected pages. The bug is not specific to a single screen, it just affects all screens that have a form within it (small forms specifically). Here is a video that illustrates the affected pages :

https://github.com/Expensify/App/assets/36869046/e65a2e54-b4a2-4bd7-b06a-92af96ee116f

https://github.com/Expensify/App/assets/36869046/59d5cc68-6bba-435b-bfba-94956ded358d

and "..." is meaning for how many page?

The flow has create and edit forms; affected forms are related to merchant description and waypoint point selector, I have included that in the video.

so I think we should keep disable by default.

Sounds good.

I have checked the list page you have provided above almost work well. Excludes

I have included all affected pages in the video

What do you think if we separate the scope for this ticket?

We are fixing the same bug, and I think we will only apply the new prop; no other changes are required IMO, If any page requires extra changes, then we will handle it on a separate ticket.

[suneox]

I have included all affected pages in the video

@fedirjh Thank you for your feedback, I'll update the list page you've provided asap

[suneox]

@fedirjh I have updated your feedback and we have a condition shouldEnableMaxHeight for aware view-port scroll so we can go ahead to fix global by set default shouldAwareViewportScroll. and If any page requires extra changes, then we will handle it on another ticket.

[fedirjh]

cc @suneox could you please merge main? Also we have some failing tests, could you please fix them?

[suneox]

@fedirjh I have syned with latest main

[suneox]

@fedirjh Have you got any for this PR?

[fedirjh]

Testing it shortly.

[fedirjh]

@suneox It seems that the hook used has some delay in it. So the bug is still reproducible with quicker steps :

1. Open the legal name page
2. Focus on the input and at the same time scroll the page
3. The bug occurs

https://github.com/Expensify/App/assets/36869046/bbbaddb4-b77a-46af-80fd-99d5a1c81834

[suneox]

@suneox It seems that the hook used has some delay in it. So the bug is still reproducible with quicker steps :

Let me double-check

[suneox]

@fedirjh I have handled the edge case, quickly scrolling after focusing to input

https://github.com/Expensify/App/assets/11959869/f467f4be-117a-41cf-8df4-6bb48babceea

[fedirjh]

Reviewer Checklist

• [x] I have verified the author checklist is complete (all boxes are checked off).
• [x] I verified the correct issue is linked in the ### Fixed Issues section above
• [x] I verified testing steps are clear and they cover the changes made in this PR
  • [x] I verified the steps for local testing are in the Tests section
  • [x] I verified the steps for Staging and/or Production testing are in the QA steps section
  • [x] 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)
  • [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 checked that screenshots or videos are included for tests on all platforms
• [x] I included screenshots or videos for tests on all platforms
• [x] I verified tests pass on all platforms & I tested again on:
  • [x] Android: Native
  • [x] Android: mWeb Chrome
  • [x] iOS: Native
  • [x] iOS: mWeb Safari
  • [x] MacOS: Chrome / Safari
  • [x] MacOS: Desktop
• [x] 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
• [x] I verified proper code patterns were followed (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] 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 verified that this PR follows the guidelines as stated in the Review Guidelines
• [x] 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)
• [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] 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] 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)
  • [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(theme.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 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.
• [x] If the PR modifies the form input styles:
  • [x] I verified that all the inputs inside a form are aligned with each other.
  • [x] I added Design label so the design team can review the changes.
• [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 reviewer checklist, including those that don't apply to this PR.

Screenshots/Videos

Android: Native

https://github.com/Expensify/App/assets/36869046/5324955f-4692-4a34-8702-be1a6e6fe536

Android: mWeb Chrome

https://github.com/Expensify/App/assets/36869046/22274382-0ba7-4ad7-93c0-6c80fa9daf36

iOS: Native

https://github.com/Expensify/App/assets/36869046/b9a32ccf-5afc-47d5-8671-6d386219c462

iOS: mWeb Safari

https://github.com/Expensify/App/assets/36869046/8fd03848-2710-42c9-8572-63081df13fb2

MacOS: Chrome / Safari

https://github.com/Expensify/App/assets/36869046/253835a4-5db9-4918-9622-2b4840e6b1fd

MacOS: Desktop

https://github.com/Expensify/App/assets/36869046/9d3cb826-f028-4ec3-96b6-48bf03a45510

[luacmartins]

@suneox can you please merge main? Maybe that will fix the failing test

[suneox]

Hi @luacmartins the pipeline has fixed

[OSBotify]

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

[OSBotify]

🚀 Deployed to staging by https://github.com/luacmartins in version: 1.4.39-0 🚀

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

[OSBotify]

🚀 Deployed to production by https://github.com/Beamanator in version: 1.4.39-8 🚀

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