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

Feature: Use attachment gallery everywhere #31308

Merged

Conversation

chrispader
Copy link
Contributor

@chrispader chrispader commented Nov 14, 2023

@pecanoro @ntdiary @dylanexpensify

Details

This PR adapts the AttachmentGallery/ImageTransformer component so that we can use it instead of ImageZoom within the ImageView component.

Fixed Issues

$ #28159
PROPOSAL: #28159 (comment)

Tests

  • Verify that no errors appear in the JS console

Attachment carousel

  1. Go to a report with (image) attachments
  2. Open attachment
  3. Test image lightbox capabilities (zooming, panning, double tap, swiping)
  4. Test carrousel: swipe through attachments
  5. Ensure no bugs, lags or unexpected behaviour is experienced

"Send attachment" preview

  1. Go to a report with (image) attachments
  2. Click on "+" in the composer -> Send attachment -> from Gallery
  3. Upload an image
  4. Test image lightbox capabilities in the preview
  5. Ensure no bugs, lags or unexpected behaviour is experienced

Offline tests

Not needed.

QA Steps

  • Verify that no errors appear in the JS console

Same as in Tests.

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 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 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.

Screenshots/Videos

Android: Native
attachment_gallery_android_compressed.mov
Android: mWeb Chrome

Not affected.

iOS: Native
attachment_gallery_compressed.mov
iOS: mWeb Safari

Not affected.

MacOS: Chrome / Safari

Not affected.

MacOS: Desktop

Not affected.

@chrispader chrispader marked this pull request as ready for review November 15, 2023 15:14
@chrispader chrispader requested a review from a team as a code owner November 15, 2023 15:14
@melvin-bot melvin-bot bot requested review from ntdiary and removed request for a team November 15, 2023 15:14
Copy link

melvin-bot bot commented Nov 15, 2023

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

@chrispader
Copy link
Contributor Author

@ntdiary Ready for review! 🚀

@chrispader chrispader force-pushed the feat/use-attachment-gallery-everywhere branch from 21684a5 to 70c2dd8 Compare November 21, 2023 15:00
@chrispader
Copy link
Contributor Author

chrispader commented Nov 21, 2023

Just added a new patch file for react-native-fast-image that reflects the changes from @ArekChr in the upstream PR.

This fixes the crash issue when uploading large images.

@chrispader
Copy link
Contributor Author

@ntdiary ready for review and merge 🚀

@ntdiary
Copy link
Contributor

ntdiary commented Nov 22, 2023

@chrispader, great PR, really like the overall changes. It just needs a bit more time for testing some details (might take one day or two). Here's first small thought: could we keep the loading indicator visible until the large image is actually displayed?
This way, the user experience might be better. 😄

loading.mp4

@chrispader
Copy link
Contributor Author

Here's first small thought: could we keep the loading indicator visible until the large image is actually displayed?
This way, the user experience might be better. 😄

Sorry, this was actually supposed to work. Gonna fix this any second :)

@chrispader
Copy link
Contributor Author

@ntdiary fixed!

Actually just started working on a PR to migrate all of the "Attachment Gallery" components to TS: #33081

Copy link
Contributor

@ntdiary ntdiary left a comment

Choose a reason for hiding this comment

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

LGTM. Thanks again, @chrispader, great work!
Btw, It's half past midnight now, and I'm starting to feel a bit dizzy, need to go to bed first. 😂

@pecanoro
Copy link
Contributor

I will merge this in a bit, testing it!

@pecanoro
Copy link
Contributor

@chrispader I just realized the description is missing QA steps, we need them

@chrispader
Copy link
Contributor Author

@chrispader I just realized the description is missing QA steps, we need them

just updated it! Is that sufficient?

@pecanoro
Copy link
Contributor

That's good enough! Merging!

@pecanoro pecanoro merged commit 6c110a4 into Expensify:main Dec 15, 2023
18 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/pecanoro in version: 1.4.14-0 🚀

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

@OSBotify
Copy link
Contributor

🚀 Deployed to staging by https://github.com/pecanoro in version: 1.4.14-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.4.14-6 🚀

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

isAuthTokenRequired={isAuthTokenRequired}
encryptedSourceUrl={encryptedSourceUrl}
isUsedInCarousel={isUsedInCarousel}
Copy link
Contributor

Choose a reason for hiding this comment

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

This line was accidentally removed? This causes regression of switching to another attachment even in zoomed state of PDF.

Copy link
Contributor Author

@chrispader chrispader Dec 28, 2023

Choose a reason for hiding this comment

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

Yes you're right. This was removed accidentally.

Is there a PR already? Otherwise i created one here: #33696

cc @aimane-chnaif

Comment on lines +181 to +182
const width = (e.nativeEvent?.width || 0) / PixelRatio.get();
const height = (e.nativeEvent?.height || 0) / PixelRatio.get();
Copy link
Contributor

Choose a reason for hiding this comment

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

@chrispader Can you tell me why this was divided by PixelRatio.get()?

Copy link
Contributor

Choose a reason for hiding this comment

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

@shubham1206agra the Pixel ratio multiplication is so that the image has correct pixelation and looks good, if we remove it, the image will look blurry, since the device pixel ratio is high. The issue here is just that the formula we're using is incorrect.

@chrispader can you confirm that this is the intention, and that the formula is wrong as per this

Copy link
Contributor

Choose a reason for hiding this comment

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

@dukenv0307 I am not able to see any pixelation if I don't use PixelRatio.get().
@chrispader Do you have a case where I will see the pixelation?

Copy link
Contributor

Choose a reason for hiding this comment

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

Maybe Expo Image already took care of this internally.

Copy link
Contributor

@dukenv0307 dukenv0307 Dec 28, 2023

Choose a reason for hiding this comment

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

@shubham1206agra I see the pixelation very clearly on my iOS simulator

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Yes, this should indeed be * PixelRatio.get() instead.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Also, it should be added to the fallback image's onLoad function. Please make sure to add it there as well.

};
}) => {scaleX: number; scaleY: number; minScale: number; maxScale: number};

const getCanvasFitScale: GetCanvasFitScale = ({canvasSize, contentSize}) => {
Copy link
Contributor

Choose a reason for hiding this comment

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

👋 Coming from #40788
This has introduced an issue on native Android, where if you're viewing a small image, it's scaled up to fill all of the screen
We've resolved this by capping the scaleX and scaleY at 1, so the images are no longer scaled up automatically

Copy link
Contributor Author

Choose a reason for hiding this comment

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

makes sense! thanks for the catch 🙌

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.

8 participants