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

handle login scroll on virtual viewport #42603

Merged

Conversation

suneox
Copy link
Contributor

@suneox suneox commented May 24, 2024

Details

Fixed Issues

$ #41108
PROPOSAL: #41108 (comment)

Tests

Precondition: install chrome on ios device

  1. Open login page by chrome on ios device
  2. Focus to input field to trigger keyboard open
  3. Verify no blank space above keyboard and submit button is visible
  • Verify that no errors appear in the JS console

Offline tests

QA Steps

Precondition: install chrome on ios device

  1. Open login page by chrome on ios device
  2. Focus to input field to trigger keyboard open
  3. Verify no blank space above keyboard and submit button is visible
  • 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

iOS: mWeb Chrome
RPReplay_Final1716566467.MP4
Android: Native
Screen.Recording.2024-05-24.at.22.52.20.mov
Android: mWeb Chrome
Screen.Recording.2024-05-24.at.22.51.01.mov
iOS: Native
Screen.Recording.2024-05-24.at.22.52.36.mov
iOS: mWeb Safari
Screen.Recording.2024-05-24.at.22.49.33.mov
MacOS: Chrome / Safari
Screen.Recording.2024-05-24.at.23.07.44.mov
MacOS: Desktop
Screen.Recording.2024-05-24.at.22.53.59.mov

@suneox suneox requested a review from a team as a code owner May 24, 2024 16:10
@melvin-bot melvin-bot bot requested review from eh2077 and removed request for a team May 24, 2024 16:10
Copy link

melvin-bot bot commented May 24, 2024

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

@eh2077
Copy link
Contributor

eh2077 commented May 26, 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

N/A. The changes of this PR only applies to mobile Webkit browser.

Android: mWeb Chrome

N/A. The changes of this PR only applies to mobile Webkit browser.

iOS: Native
0-ios.mp4
iOS: mWeb Safari
0-mobile-safari.mp4
iOS: mWeb Chrome
ios-mobile-chrome.mp4
MacOS: Chrome / Safari

N/A. The changes of this PR only applies to mobile Webkit browser.

MacOS: Desktop

N/A. The changes of this PR only applies to mobile Webkit browser.

@eh2077
Copy link
Contributor

eh2077 commented May 26, 2024

@suneox Android is not working

Screen.Recording.2024-05-27.at.1.03.48.AM.mov

@suneox
Copy link
Contributor Author

suneox commented May 27, 2024

@suneox Android is not working

I'll check and feedback asap
@eh2077 could you please provide your simulator model?

@suneox
Copy link
Contributor Author

suneox commented May 27, 2024

@eh2077 Could you please share your tested device? I just double-check, and it doesn't happen on native device due to this issue happen on mobile web due to virtual viewport auto trigger scroll the input to safe area view

Screen.Recording.2024-05-28.at.00.14.09.mov

@eh2077
Copy link
Contributor

eh2077 commented May 28, 2024

@suneox I'm using Nexus 5 API 33. Can you try signing out?

@suneox
Copy link
Contributor Author

suneox commented May 29, 2024

@suneox I'm using Nexus 5 API 33. Can you try signing out?

I'll check asap

@suneox
Copy link
Contributor Author

suneox commented May 31, 2024

@suneox I'm using Nexus 5 API 33. Can you try signing out?

@madmax330
I would like to confirm it's an edge case for the older device? Due to initial scope of this issue to fix virtual viewport on mWeb, so should we handle this issue on this PR?

cc: @eh2077

@madmax330
Copy link
Contributor

Did this PR introduce this behavior or is it already this was for those older devices?

@suneox
Copy link
Contributor Author

suneox commented May 31, 2024

Did this PR introduce this behavior or is it already this was for those older devices?

@madmax330
This PR to handle fix blank space on mWeb use webkit, and handle fix scroll on virtual viewport after mWeb trigger scroll into the input. This behavior (trigger scroll when focus input) only happens on mWeb so i think we should only fix for mWeb and shouldn't apply behavior on mWeb for native

Scroll behavior native & mWeb
RPReplay_Final1717321998.MP4

@eh2077
Copy link
Contributor

eh2077 commented Jun 3, 2024

@suneox Is it possible to follow Platform-Specific File Extensions to avoid introduce the regression?

@suneox
Copy link
Contributor Author

suneox commented Jun 3, 2024

@suneox Is it possible to follow Platform-Specific File Extensions to avoid introduce the regression?

@eh2077 I have update condition Browser.isMobileWebKit() before correct scroll position when focus

@eh2077
Copy link
Contributor

eh2077 commented Jun 4, 2024

@suneox Is it possible to follow Platform-Specific File Extensions to avoid introduce the regression?

@eh2077 I have update condition Browser.isMobileWebKit() before correct scroll position when focus

@suneox So the regression on Android native App is fixed right? I haven't tested your latest changes because my laptop has trouble to build the App.

@suneox
Copy link
Contributor Author

suneox commented Jun 4, 2024

@suneox So the regression on Android native App is fixed right? I haven't tested your latest changes because my laptop has trouble to build the App.

@eh2077 I don't think we have regression on android native due to the scroll behavior only happens on mWeb, and it raises overlap issue, currently this PR is fix for mWeb.
@madmax330 How about your thoughts in this comment? about we shouldn't bring behavior on mWeb to native

Comment on lines 222 to 230
const submitContainerRef = useRef<View | HTMLDivElement>(null);
const handleFocus = useCallback(() => {
if (!Browser.isMobileWebKit()) {
return;
}
InteractionManager.runAfterInteractions(() => {
htmlDivElementRef(submitContainerRef).current?.scrollIntoView?.({behavior: 'smooth', block: 'end'});
});
}, []);
Copy link
Contributor

Choose a reason for hiding this comment

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

Can you please add some comments to explain the intent of this callback?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I have updated explanation for this change

@eh2077
Copy link
Contributor

eh2077 commented Jun 7, 2024

I'm still working on preparing recordings

@eh2077
Copy link
Contributor

eh2077 commented Jun 10, 2024

@suneox I got following error when testing mobile Safari
SyntaxError: Invalid regular expression: invalid group specifier name
image

It seems the App use some regex expression which is not support in mobile Webkit. Did you face similar issue?

I used physical iPhone 12 Pro Max with iOS 16.1.1

@suneox
Copy link
Contributor Author

suneox commented Jun 10, 2024

@suneox I got following error when testing mobile Safari SyntaxError: Invalid regular expression: invalid group specifier name image

It seems the App use some regex expression which is not support in mobile Webkit. Did you face similar issue?

I used physical iPhone 12 Pro Max with iOS 16.1.1

I haven't got this issue, i think it is not related to regex

Screenshots/Videos

iOS: mWeb Chrome
RPReplay_Final1716566467.MP4
Android: Native
Screen.Recording.2024-05-24.at.22.52.20.mov
Android: mWeb Chrome
Screen.Recording.2024-05-24.at.22.51.01.mov
iOS: Native
Screen.Recording.2024-05-24.at.22.52.36.mov
iOS: mWeb Safari
Screen.Recording.2024-05-24.at.22.49.33.mov
MacOS: Chrome / Safari
Screen.Recording.2024-05-24.at.23.07.44.mov
MacOS: Desktop
Screen.Recording.2024-05-24.at.22.53.59.mov

I have double-check a current regex on both function isMobileSafari and isMobileWebKit It uses a common regex rule, i think it related to webpack bundle. So could you please restart run dev?

const isMobileSafari: IsMobileSafari = () => {
    const userAgent = navigator.userAgent;
    return /iP(ad|od|hone)/i.test(userAgent) && /WebKit/i.test(userAgent) && !/(CriOS|FxiOS|OPiOS|mercury)/i.test(userAgent);
};

const isMobileWebKit: IsMobileWebKit = () => {
    const userAgent = navigator.userAgent;
    return /iP(ad|od|hone)/i.test(userAgent) && /WebKit/i.test(userAgent);
};

@eh2077
Copy link
Contributor

eh2077 commented Jun 10, 2024

@suneox I tried restarting but still same error. I'm curious what's your iOS version? I found that Added support for RegExp lookbehind assertions. was added in iOS 16.4, see https://developer.apple.com/documentation/safari-release-notes/safari-16_4-release-notes#New-Features

@suneox
Copy link
Contributor Author

suneox commented Jun 10, 2024

@suneox I tried restarting but still same error. I'm curious what's your iOS version? I found that Added support for RegExp lookbehind assertions. was added in iOS 16.4, see https://developer.apple.com/documentation/safari-release-notes/safari-16_4-release-notes#New-Features

@eh2077 I use iOS 17. A difference between isMobileWebKit and isMobileSafari is extra condition && !/(CriOS|FxiOS|OPiOS|mercury)/i.test(userAgent) on isMobileSafari function so I don't think it related to condition isMobileWebKit. Could you please help me revert each change set to verify due to I can't reproduce your issue? Thank you so much!

@eh2077
Copy link
Contributor

eh2077 commented Jun 10, 2024

I see, changes of this PR should be fine. Let me try switching to main and see what happens.

Update: I got same error on the main branch with iOS 16.1.1

Let me try upgrade iOS to 17 then

Update: It works after upgraded to iOS 17

I reported this issue here on slack.

Copy link
Contributor

@eh2077 eh2077 left a comment

Choose a reason for hiding this comment

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

LGTM and tested well!

@melvin-bot melvin-bot bot requested a review from madmax330 June 11, 2024 14:24
@madmax330 madmax330 merged commit 98b2cb0 into Expensify:main Jun 11, 2024
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.

@OSBotify
Copy link
Contributor

🚀 Deployed to staging by https://github.com/madmax330 in version: 1.4.82-0 🚀

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

@OSBotify
Copy link
Contributor

🚀 Deployed to production by https://github.com/mountiny in version: 1.4.82-4 🚀

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

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