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

#23546 - Wrong Image opens on HT Report in Safari #28441

Closed
wants to merge 8 commits into from

Conversation

mikesmnx
Copy link

@mikesmnx mikesmnx commented Sep 29, 2023

Details

Wrong Image opens on HT Report in Safari

Fixed Issues

$ #23546
PROPOSAL: #23546 (comment)

Tests

  1. Join #announce channel.
  2. Scroll up and open shared images by users.
  3. After scrolling a little up again open some other image.
  4. Correct image is displayed.
  • Verify that no errors appear in the JS console

Offline tests

  1. Open #announce channel.
  2. Scroll up and open shared images by users.
  3. After scrolling a little up again open some other image.
  4. Correct image is displayed.
  5. Turn off network connection.
  6. Repeat steps 3-4.

QA Steps

  1. Join #announce channel (or any other channel with existing shared images).
  2. Scroll up and open shared images by users.
  3. After scrolling a little up again open some other image.
  4. Correct image is displayed.
  • 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 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 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
    • If we are not using the full Onyx data that we loaded, I've added the proper selector in order to ensure the component only re-renders when the data it is using changes
      • 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 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 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.mp4
Mobile Web - Chrome
android-chrome.mp4
Mobile Web - Safari
ios-safari.MP4
Desktop
macos-desk.mp4
iOS
ios-app-emu.mp4
Android
android-native.mp4

@mikesmnx mikesmnx requested a review from a team as a code owner September 29, 2023 07:12
@github-actions
Copy link
Contributor

github-actions bot commented Sep 29, 2023

CLA Assistant Lite bot All contributors have signed the CLA ✍️ ✅

@melvin-bot melvin-bot bot requested review from nkuoch and removed request for a team September 29, 2023 07:13
@melvin-bot
Copy link

melvin-bot bot commented Sep 29, 2023

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

@@ -189,7 +190,7 @@ function AttachmentCarousel({report, reportActions, source, onNavigate, setDownl
bounces={false}
// Scroll only one image at a time no matter how fast the user swipes
disableIntervalMomentum
pagingEnabled
pagingEnabled={false}
Copy link
Contributor

Choose a reason for hiding this comment

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

can't you just remove it?

Copy link
Author

Choose a reason for hiding this comment

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

@nkuoch done

@mikesmnx
Copy link
Author

I have read the CLA Document and I hereby sign the CLA

@parasharrajat
Copy link
Member

Please add space between the issue links required for automation and checks.

Screenshot 2023-09-29 at 4 50 23 PM

@parasharrajat
Copy link
Member

parasharrajat commented Sep 29, 2023

You suggested a couple of props to be changed on the proposal #23546 (comment) but I only see a few on the changes. Can you please explain the reason behind this?

@mikesmnx
Copy link
Author

@parasharrajat During testing across all platforms, I discovered that certain properties, such as "bounces" or "maxToRenderPerBatch," slightly altered the current UX. So, I made only the necessary adjustments to maintain the app's existing state.

@nkuoch
Copy link
Contributor

nkuoch commented Sep 30, 2023

image

@mikesmnx
Copy link
Author

recheck

@mikesmnx
Copy link
Author

mikesmnx commented Oct 1, 2023

@nkuoch Sorry, Nathalie, I'm a bit confused. I've already signed the CLA and received confirmation of it. I tried to add a "recheck" comment here. I also verified that this step exists in the workflow (https://github.com/Expensify/App/actions/runs/6348672890/workflow?pr=28441), but it seems the check hasn't been retriggered.

@nkuoch nkuoch requested a review from parasharrajat October 2, 2023 08:02
@nkuoch
Copy link
Contributor

nkuoch commented Oct 3, 2023

All good now. @parasharrajat do you mind doing the reviewer checklist?

@parasharrajat
Copy link
Member

Checking it now...

@parasharrajat
Copy link
Member

parasharrajat commented Oct 9, 2023

Screenshots

🔲 iOS / native

🔲 iOS / Safari

🔲 MacOS / Desktop

Screen.Recording.2023-10-09.at.7.42.41.PM.mov

🔲 MacOS / Chrome

Screen.Recording.2023-10-09.at.7.38.08.PM.mov

🔲 Android / Chrome

🔲 Android / native

@parasharrajat
Copy link
Member

@mikesmnx I found an issue. Notice the image does not snap to the edge.

Screen.Recording.2023-10-09.at.8.02.37.PM.mov

@mikesmnx
Copy link
Author

mikesmnx commented Oct 9, 2023

@parasharrajat Checking

@parasharrajat
Copy link
Member

@mikesmnx Any update?

@mikesmnx
Copy link
Author

@parasharrajat I've found another approach to fix the issue and am currently verifying it across all platforms. I believe it will be ready by tomorrow

@parasharrajat
Copy link
Member

Thanks for the update.

@mikesmnx
Copy link
Author

@parasharrajat Updated the code and chose to retain pagingEnabled. Without it, we would have to implement paging manually, which would result in varied behaviors across supported platforms. I've tested this on the iPhone 11, 13 Pro Max, 14 Pro Max (emulator), Mac desktop app, iOS native app, and also on an Android 13 device, it's working as expected.

@parasharrajat
Copy link
Member

parasharrajat commented Oct 13, 2023

Thanks @mikesmnx. Can you please summarize the effect of these changes?

@mikesmnx
Copy link
Author

@parasharrajat I've added contentInset and contentInsetAdjustmentBehavior to achieve more stable behavior (iOS only). Since we don't have any padding, the top, left, bottom, and right are all set to zero (contentInset). The contentInsetAdjustmentBehavior is set to 'automatic' to ensure that content fits within the scroll area.

I've switched from snapToInterval to snapToOffsets because the latter is more stable with large lists.

I adjusted the windowSize (number of rendered items outside visible area) to 1, which has improved memory usage and the selection of the first item.

I also removed maxToRenderPerBatch, as it tends to be unstable with large lists.

@parasharrajat
Copy link
Member

@mikesmnx Can you please merge the main? I will test it afterward.

@mikesmnx
Copy link
Author

@parasharrajat Done

@parasharrajat
Copy link
Member

@nkuoch Can you please run the workflows here?

@nkuoch
Copy link
Contributor

nkuoch commented Nov 2, 2023

done

@parasharrajat
Copy link
Member

Screenshots

🔲 iOS / native

🔲 iOS / Safari

🔲 MacOS / Desktop

🔲 MacOS / Chrome

🔲 Android / Chrome

🔲 Android / native

@parasharrajat
Copy link
Member

I have tried a few times but I couldn't reproduce the issue so I am not able to verify the solution.

I will try to get a heavy account and try on that.

@mikesmnx
Copy link
Author

Hope this helps. I just followed the first three steps from the issue with the iPhone (latest iOS/Safari).

video5384103322170964912.mp4

@parasharrajat
Copy link
Member

Sorry for the delay here. I am AFK till weekend. I will get this wrapped up on Monday.

@parasharrajat
Copy link
Member

I still couldn't. @mikesmnx Can you please merge the main? I am asking someone for help.

@mikesmnx
Copy link
Author

mikesmnx commented Dec 8, 2023

@parasharrajat done

@parasharrajat
Copy link
Member

Thanks.

// Enable scrolling by swiping on mobile (touch) devices only
// disable scroll for desktop/browsers because they add their scrollbars
// Enable scrolling FlatList only when PDF is not in a zoomed state
scrollEnabled={canUseTouchScreen}
ref={scrollRef}
initialScrollIndex={page}
initialNumToRender={3}
windowSize={5}
maxToRenderPerBatch={CONST.MAX_TO_RENDER_PER_BATCH.CAROUSEL}
Copy link
Member

Choose a reason for hiding this comment

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

why did we remove this?

Copy link
Author

Choose a reason for hiding this comment

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

Recently, the 'maxToRenderPerBatch' was set to use a constant, but we have removed it in this PR

@@ -195,16 +196,17 @@ function AttachmentCarousel({report, reportActions, parentReportActions, source,
disableIntervalMomentum
pagingEnabled
snapToAlignment="start"
snapToInterval={containerWidth}
contentInset={{top: 0, left: 0, bottom: 0, right: 0}}
contentInsetAdjustmentBehavior="automatic"
Copy link
Member

Choose a reason for hiding this comment

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

Why do we need this? Can you please explain the issue it solves?

Copy link
Author

Choose a reason for hiding this comment

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

Please check my comment here

@@ -195,16 +196,17 @@ function AttachmentCarousel({report, reportActions, parentReportActions, source,
disableIntervalMomentum
pagingEnabled
snapToAlignment="start"
snapToInterval={containerWidth}
contentInset={{top: 0, left: 0, bottom: 0, right: 0}}
Copy link
Member

Choose a reason for hiding this comment

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

This seems to be default value. Any reason for adding this?

Copy link
Author

Choose a reason for hiding this comment

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

As I recall from my tests on platforms, such as macOS desktop and iOS native, I found that without explicitly setting this value (despite it being the default), the view appeared slightly different (with a 1-2px padding)

Copy link
Member

Choose a reason for hiding this comment

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

Let's add that as a comment.

Copy link
Author

Choose a reason for hiding this comment

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

Done

@parasharrajat
Copy link
Member

Bug: This is what happening on iOS Safari for me.

Screen.Recording.2023-12-11.at.5.49.32.PM.mov

@parasharrajat
Copy link
Member

There is a warning on Android.

tewst.mov

@parasharrajat
Copy link
Member

@mikesmnx bump.

@mikesmnx
Copy link
Author

@parasharrajat I'm not sure I understood correctly. Should I resolve the warning on Android?

@parasharrajat
Copy link
Member

parasharrajat commented Dec 14, 2023

Yes, I noticed that warning on this branch. If this warning is present on main then you don't have to solve it. Also, there is an issue with Safari.

@parasharrajat
Copy link
Member

@mikesmnx Did you get the time to check the warning and issue of Safari?

@mikesmnx
Copy link
Author

mikesmnx commented Jan 2, 2024

@parasharrajat Apologies for the delay—I was on holiday. I will update the pull request by Wednesday or Thursday

@parasharrajat
Copy link
Member

Let's close this PR @mikesmnx

@mikesmnx mikesmnx closed this Jun 6, 2024
@mikesmnx
Copy link
Author

mikesmnx commented Jun 6, 2024

@parasharrajat done

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.

3 participants