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 multiple scroll sliders on login page in iOS Safari #17133

Merged

Conversation

huzaifa-99
Copy link
Contributor

Details

Fixed Issues

$ #16625
PROPOSAL: #16625 (comment)

Tests

Test Pinch and zoom

  1. Open app on mWeb Safari/Chrome (make sure to test on iOS 10+ Safari)
  2. Touch 2 fingers and pinch to zoom
  3. Verify that the document should not zoom

Test Double tab to zoom

  1. Open app on mWeb Safari/Chrome (make sure to test on iOS 10+ Safari)
  2. Double tab on the screen to zoom
  3. Verify that the document should not zoom
  • Verify that no errors appear in the JS console

Offline tests

QA Steps

Test Pinch and zoom

  1. Open app on mWeb Safari/Chrome (make sure to test on iOS 10+ Safari)
  2. Touch 2 fingers and pinch to zoom
  3. Verify that the document should not zoom

Test Double tab to zoom

  1. Open app on mWeb Safari/Chrome (make sure to test on iOS 10+ Safari)
  2. Double tab on the screen to zoom
  3. Verify that the document should not zoom
  • 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 / Chrome
    • iOS / native
    • iOS / 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 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 correct English and approved by marketing by adding the Waiting for Copy label for a copy review on the original GH to get the correct copy.
    • 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 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(themeColors.componentBG))
  • 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 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 author checklist, including those that don't apply to this PR.

Screenshots/Videos

Web

Chrome

Desktop.Chrome.mov

Safari

Desktop.Safari.mov
Mobile Web - Chrome
mWeb.Chrome.mp4
Mobile Web - Safari
mWeb.Safari.mov
Desktop
Desktop.Native.mov
iOS
iOS.Native.mov
Android
Android.Native.mp4

@huzaifa-99 huzaifa-99 requested a review from a team as a code owner April 7, 2023 12:53
@melvin-bot melvin-bot bot requested review from marcochavezf and parasharrajat and removed request for a team April 7, 2023 12:53
@MelvinBot
Copy link

@marcochavezf @parasharrajat One of you needs to 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]

@parasharrajat
Copy link
Member

What is your take on the problem mentioned here #16625 (comment)?

Please always pay attention to the proposal feedback and try to proactively act on them.

@huzaifa-99
Copy link
Contributor Author

Apologies @parasharrajat, I missed that.

The only problem with all the proposals here is that it disables iOS Safari's quick tab view feature. If you quickly pinch-in the webpage, Safari opens the tabs view where you can see the opened tabs. But I think this is less important. Still we can try to solve this in PR cc: @huzaifa-99

This PR blocks zooming for iOS 10+ Safari. For versions below that, the user cannot zoom so the quick tab view feature is disabled for those versions already. For consistency we could either support quick tabs view for all iOS Safari versions or block it. The problem here is that we would have to add some kind of javascript touch event to an app level container to support it, and I can't ATM say that it will work perfectly. You also mentioned here that you are not in favour of JS event. Please let me know your thoughts.

@parasharrajat
Copy link
Member

Thanks. Can you please come up with an approach? I think it will be better to analyse that. Even if you don't, it's fine.

@huzaifa-99
Copy link
Contributor Author

@parasharrajat Apologies I got a little busy over the weekend. I will try to work on an approach to support quick tabs view today but can't promise. Hope its not a blocker for this PR?

@huzaifa-99
Copy link
Contributor Author

Please have a review when you get a chance
cc: @parasharrajat @marcochavezf

@parasharrajat
Copy link
Member

I am waiting on your reply about the approach.

@huzaifa-99
Copy link
Contributor Author

huzaifa-99 commented Apr 14, 2023

@parasharrajat We can follow this approach to disable both zoom types (pinch-to-zoom and double-tap) while still allowing iOS safari quick tabs view feature.

  1. To block pinch to zoom and allow quick tabs view we have to add this script to this file
<script>
    window.addEventListener('DOMContentLoaded', () => {
        document.body.addEventListener('touchmove', function (event) {
            if (event.scale >= 1 && event.touches.length === 2) {
                event.preventDefault()
            }
        }, { passive: false });
    })
</script>
  1. To prevent double-tap to zoom, we can use the touch-action: manipulation property on the body tag here which will disable double tap to zoom.
Demo
Screen.Recording.2023-04-14.at.5.57.57.PM.mov

Coming from our previous discussion, quick tabs view is already disabled ATM in iOS safari version <=10 . These changes will allow quick tabs view for all versions. Just to be clear here, I don't know if it could have any side effects.

@parasharrajat
Copy link
Member

Thanks @huzaifa-99. Even I am not sure how future-proof this will be. Safari is dangerous to play around with.

I think we are fine without a quick-tab view. cc: @marcochavezf.

@parasharrajat
Copy link
Member

parasharrajat commented Apr 14, 2023

Screenshots

🔲 iOS / native

image

🔲 iOS / Safari

Screen.Recording.2023-04-20.at.4.35.48.PM.mov

🔲 MacOS / Desktop

image

🔲 MacOS / Chrome

image

🔲 Android / Chrome

screen-2023-04-15_16.11.11.mp4

🔲 Android / native

Screen.Recording.2023-04-20.at.5.23.20.PM.mov

@huzaifa-99
Copy link
Contributor Author

@parasharrajat did you get a chance to test for iOS safari?

@parasharrajat
Copy link
Member

Will do that today.

@huzaifa-99
Copy link
Contributor Author

@parasharrajat bump ^

@parasharrajat
Copy link
Member

I am trying to build the iOS app since yesterday. I will finish the review as soon as that is fixed.

@parasharrajat
Copy link
Member

BUG: iOS Safari: Multi-touch pinch-zoom on a message shows a mini menu.

Steps: Simulator:

  1. Open any report.
  2. Scroll the message history so the message actor's name is in the center of the screen.
  3. Now press 'option+ Click' to show the touch points.
  4. Expand the touch points outwards over the message.
  5. Notice that the menu will show up.
Screen.Recording.2023-04-19.at.5.32.02.AM.mov

This issue can be categorized as unrelated as the mini menu should be hidden on mobile devices. This is very hard to reproduce on staging but I reproduced it once. But because this PR increases the severity of that, it will be considered the root cause.

@marcochavezf Should we solve it here?

@huzaifa-99
Copy link
Contributor Author

huzaifa-99 commented Apr 19, 2023

@parasharrajat I think #17487 is related (tho not the same)?

@parasharrajat
Copy link
Member

That is unrelated.

@marcochavezf
Copy link
Contributor

BUG: iOS Safari: Multi-touch pinch-zoom on a message shows a mini menu.

Steps: Simulator:

  1. Open any report.
  2. Scroll the message history so the message actor's name is in the center of the screen.
  3. Now press 'option+ Click' to show the touch points.
  4. Expand the touch points outwards over the message.
  5. Notice that the menu will show up.

Screen.Recording.2023-04-19.at.5.32.02.AM.mov
This issue can be categorized as unrelated as the mini menu should be hidden on mobile devices. This is very hard to reproduce on staging but I reproduced it once. But because this PR increases the severity of that, it will be considered the root cause.

@marcochavezf Should we solve it here?

I think this is an extreme edge case because a user shouldn't try to zoom in/out on the chat, and if they try, I don't think showing the mini menu is a bad thing. So we shouldn't worry about it.

@huzaifa-99
Copy link
Contributor Author

@parasharrajat @marcochavezf are we ok to merge this?

@parasharrajat
Copy link
Member

parasharrajat commented Apr 20, 2023

Ok. Thanks @marcochavezf I am going to report that as a separate bug. Mini menu are meant for web desktop platform. For mobile, popup context menu should be shown.

Let me finish the checklist and we can merge this.

Copy link
Member

@parasharrajat parasharrajat left a comment

Choose a reason for hiding this comment

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

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 / Chrome
    • iOS / native
    • iOS / 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 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 correct English and approved by marketing by adding the Waiting for Copy label for a copy review on the original GH to get the correct copy.
    • 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(themeColors.componentBG)
  • 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 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 have checked off every checkbox in the PR reviewer checklist, including those that don't apply to this PR.

cc: @marcochavezf

🎀 👀 🎀 C+ reviewed

@marcochavezf marcochavezf merged commit 4f7cfdb into Expensify:main Apr 21, 2023
@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/marcochavezf in version: 1.3.4-0 🚀

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

@OSBotify
Copy link
Contributor

🚀 Deployed to production by https://github.com/jasperhuangg in version: 1.3.4-0 🚀

platform result
🤖 android 🤖 success ✅
🖥 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.

5 participants