Image Web/Desktop: Add support for http headers by kidroca · Pull Request #34505 · Expensify/App

kidroca · 2024-01-15T14:57:49Z

Details

This PR refactors the Image component, aligning the web/desktop and native implementations for better consistency and maintainability.

Changes:

Introduced BaseImage Component:
- File Location: src/components/Image/BaseImage.tsx
- This new component acts as a bridge between the native and web implementations.
- For the onLoad event, it ensures that both web and native platforms have the same signature.
Native Implementation Update:
- File Location: src/components/Image/BaseImage.native.tsx
- The native side uses expo-image, with a slight adjustment for the onLoad prop, to make it's interface uniform.
Unified Image Component for Web/Desktop and Native:
- File Location: src/components/Image/index.js
- The main Image component has been refactored to use the new BaseImage.
- This change streamlines the authToken inclusion process in the image source, ensuring it works seamlessly across both platforms.
Removed Redundant Native Specific Implementation:
- File Location: src/components/Image/index.native.js
- With the new unified approach, the native-specific implementation has become redundant and has been removed.
Patch for react-native-web
- File Location: patches/react-native-web+0.19.9+005+image-header-support.patch
- Implemented a custom patch for the official react-native-web version 0.19.9, incorporating changes from PR #2442. This patch adds support for Image with HTTP headers, which was previously missing in our current version.

Fixed Issues

$ #12603
PROPOSAL: N/A

Tests

Verify the Image component works on all platforms

Launch the application and navigate to a report containing multiple attachments.
Scroll through the report, ensuring that all attachments are loading successfully without any errors or delay.
Click on an attachment to open its preview.
- Confirm that the preview displays the image correctly.
- Ensure the download button is present and functional; downloading the image should work as expected.
Open your browser's developer tools or the equivalent network monitoring tool for the platform you are testing on.
- Monitor the network requests for image attachments.
- Verify that the requests contain the X-Chat-Attachment-Token header.
Test the image caching functionality:
- Keep the application open for more than 2 hours.
- Observe that the images remain loaded and are not re-fetched.
- Logout from the application and then log back in.
- Navigate to the same report with attachments.
- Images that were previously loaded should display instantly, indicating they are loaded from the cache.
- Confirm that the behavior remains consistent even if the X-Chat-Attachment-Token value changes.
Verify Attachment Opening for Scanned Receipts in Payment Requests
- Create a payment request using "Request money"
- Scan or upload a receipt during the request process.
- Once the receipt is uploaded and the request is sent, attempt to open the receipt by tapping on the receipt image.
- Confirm that the receipt opens correctly in the attachment view.

Offline tests

Make sure you have viewed some reports with attachments while online.
Disconnect from the internet or turn on airplane mode to simulate an offline state.
Navigate to a report with attachments that were previously loaded.
- Verify that these images still render correctly, even without an internet connection.
Navigate to a report with attachments that were NOT previously loaded.
- The attachments should appear in an infinite loading state, indicating they cannot be fetched without an internet connection.

QA Steps

Open the staging environment of the application.
Navigate to various reports that contain different types of attachments.
Ensure that all attachments load successfully without any visual artifacts or errors.
Click on any attachment to initiate the attachment preview.
- Confirm that the preview opens, displaying the attachment correctly.
- Locate the download button and click on it. Verify that the image is downloaded to your device or computer as expected.
Verify Attachment Opening for Scanned Receipts in Payment Requests
- Create a payment request using "Request money"
- Scan or upload a receipt during the request process.
- Once the receipt is uploaded and the request is sent, attempt to open the receipt by tapping on the receipt image.
- Confirm that the receipt opens correctly in the attachment view.

PR Author Checklist

Screenshots/Videos

Android: Native

Android: mWeb Chrome

iOS: Native

iOS: mWeb Safari

MacOS: Chrome / Safari

MacOS: Desktop

- Introduced `BaseImage` component that branches between native and web implementations. - **Native**: Utilizes `FastImage` directly. - **Web**: Minor adjustments made to the `onLoad` event signature for compatibility. - Eliminated `Image/index.native.js` as both native and web components now leverage a unified high-level implementation for image loading and rendering. (cherry picked from commit 2aa37d2)

(cherry picked from commit 19b605e)

This patch focuses on resolving issues encountered with avatar image loading, specifically addressing the challenges related to CORS (Cross-Origin Resource Sharing) errors. Changes: - Removed the `isAuthTokenRequired` flag from the `AttachmentModal` component in various files, including `ProfilePage.js`, `RoomHeaderAvatars.js`, and `DetailsPage.js`. This change is crucial for loading of avatar images that are hosted externally. Rationale: - The primary purpose of this modification is to streamline the loading process for avatars by removing the unnecessary inclusion of authentication tokens in requests for external images. This approach aligns with standard practices for handling externally hosted content and aims to enhance compatibility and performance. - Raised a question here as whether there are cases of avatar images that need authentication: https://github.com/Expensify/App/pull/24425/files#r1404352872 This update is expected to resolve the CORS errors associated with avatar image loading, thereby improving the overall functionality and user experience in our application. (cherry picked from commit cc49208)

(cherry picked from commit 1182c7d)

- Adapt to `expo-image` deprecation of `event.nativeEvent` usage. - Directly use the event object as recommended. - Ensure compatibility with components using the `onLoad` prop.

melvin-bot · 2024-01-15T14:57:55Z

@0xmiroslav 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]

0xmiroslav · 2024-01-15T15:01:00Z

Is this exact same PR as #13036?

All new files should be written in TS. Let's do that

kidroca · 2024-01-15T15:13:02Z

@0xmiroslav

Is this exact same PR as #13036?

It has slight changes, so it's not exact.
In the past we used react-native-fast-image, now that we've switched to expo-image I had to make some small adjustments in BaseImage.native to handle the onLoad prop. The rest is exactly as in #13036

All new files should be written in TS. Let's do that

Allright

0xmiroslav · 2024-01-17T12:59:53Z

Author checklist is failing

kidroca · 2024-01-17T15:53:49Z

Author checklist is failing

I had a little bit of trouble running the Android build, but resolved it today and added screenshots.

✔️ Ready for review

0xmiroslav · 2024-01-19T11:55:33Z

@Beamanator can you please generate adhoc build?
Going to test both localhost and PR domain

0xmiroslav · 2024-01-19T12:10:06Z

@Beamanator this PR will conflict with #31296. Should we hold this or continue?

Beamanator · 2024-01-19T12:10:09Z

@0xmiroslav good idea, I just triggered that build

Beamanator · 2024-01-19T12:11:21Z

@Beamanator this PR will conflict with #31296. Should we hold this or continue?

Good call, but I think that's fine - whichever gets merged first won't have to deal with merge conflicts :D

0xmiroslav · 2024-01-19T12:13:57Z

@blazejkustra or @fabioh8010 can you please review this PR in TS aspect? 3 new files are added.

github-actions · 2024-01-19T12:32:57Z

🧪🧪 Use the links below to test this adhoc build on Android, iOS, Desktop, and Web. Happy testing! 🧪🧪

Android 🤖	iOS 🍎
https://ad-hoc-expensify-cash.s3.amazonaws.com/android/34505/index.html	https://ad-hoc-expensify-cash.s3.amazonaws.com/ios/34505/index.html

Desktop 💻	Web 🕸️
https://ad-hoc-expensify-cash.s3.amazonaws.com/desktop/34505/NewExpensify.dmg	https://34505.pr-testing.expensify.com

👀 View the workflow run that generated this build 👀

blazejkustra

Just an idea, we could merge this PR with Ts migration and merge as one. Left one comment

blazejkustra · 2024-01-19T13:14:10Z

src/components/Image/types.ts

+type ImageProps = {
+    /** Event called with image dimensions when image is loaded */
+    onLoad?: (event: {nativeEvent: {width: number; height: number}}) => void;
+};


ImageProps are missing some props, you can copy them from here

@blazejkustra

Thank you for pointing out the ImageProps. I've reviewed the reference from here and appreciate your suggestion. However, I have some reservations about incorporating these types into my current Pull Request, as they seem tangential to the specific change I'm introducing:

History of Changes: The file you referenced has undergone several revisions. Directly copying it might inadvertently overwrite its existing history, leading to potential misattribution of changes.

Irrelevant Props: Some of the props, such as isAuthTokenRequired, are not relevant to the BaseImage component. Including them could introduce unnecessary complexity or errors.

Platform Specificity: The BaseImage component is tailored for specific platforms. Using the full ImageProps could lead to compatibility issues between Expo and React Native Web image, given their differences.

Given these concerns, I propose two alternatives:

Option A: We could remove the types.ts file from this Pull Request and defer its introduction to the other PR, maintaining clarity and separation of concerns.

Option B: Alternatively, we could rename the type to BaseImageProps and limit its scope to only include essential props like onLoad, ensuring compatibility and relevance to the current changes.

I believe either approach would maintain the integrity and focus of the Pull Request while addressing the need for proper typing. I'm open to further discussion on this matter.

@blazejkustra what do you think?

@kidroca Thank you for your perspective on this one! And I agree with you. Both options sounds good to me, although I'm more inclined to option B.

I've pushed an update that implements option B

0xmiroslav · 2024-01-19T13:36:28Z

Just an idea, we could merge this PR with Ts migration and merge as one. Left one comment

yes, I thought the same.
Image/index.js is the only remaining file to be migrated, along with one word change of resizeModes.js.

0xmiroslav · 2024-01-19T14:24:47Z

adhoc build (PR domain) shows error as expected.

fabioh8010

LGTM besides @blazejkustra comments!

aimane-chnaif · 2024-01-25T12:38:37Z

I will need to take this over again as @0xmiroslav is no longer C+

aimane-chnaif · 2024-01-25T12:38:51Z

Please fix conflict

# Conflicts: # src/components/RoomHeaderAvatars.js # src/pages/ProfilePage.js

kidroca · 2024-01-26T20:24:24Z

Please fix conflict

✔️ Done

trjExpensify · 2024-01-29T20:03:21Z

👋 assigned you @aimane-chnaif

aimane-chnaif · 2024-01-30T15:57:42Z

weird loading indicator but also happening on main. so out of scope

aimane-chnaif · 2024-01-30T16:42:50Z

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 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(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 form input styles:
- I verified that all the inputs inside a form are aligned with each other.
- I added Design label 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

android.mov

Android: mWeb Chrome

mchrome.mov

iOS: Native

ios.mov

iOS: mWeb Safari

msafari.mov

MacOS: Chrome / Safari

web.mov

MacOS: Desktop

desktop.mov

aimane-chnaif

Hopefully pass staging this time 🙏

Beamanator

LGTM! 🙏

OSBotify · 2024-01-31T09:03:16Z

✋ 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 · 2024-01-31T23:00:57Z

🚀 Deployed to staging by https://github.com/Beamanator in version: 1.4.35-0 🚀

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

OSBotify · 2024-02-02T15:13:30Z

🚀 Deployed to production by https://github.com/mountiny in version: 1.4.35-7 🚀

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

kidroca added 5 commits January 15, 2024 16:10

Add react-native-web patch for image header support

37df3e3

(cherry picked from commit 19b605e)

Align changes with project code styles

56497e5

(cherry picked from commit 1182c7d)

Refactor BaseImage.native.js to Align with expo-image Deprecation

5d46092

- Adapt to `expo-image` deprecation of `event.nativeEvent` usage. - Directly use the event object as recommended. - Ensure compatibility with components using the `onLoad` prop.

kidroca requested a review from a team as a code owner January 15, 2024 14:57

melvin-bot bot requested review from 0xmiroslav and removed request for a team January 15, 2024 14:57

Convert new image files to typescript

d51126f

kidroca force-pushed the kidroca/feat/attachment-with-headers branch from cb435b5 to d51126f Compare January 15, 2024 19:20

kidroca mentioned this pull request Jan 15, 2024

[HOLD for payment 2024-03-29] [HOLD for payment 2024-03-26] [$250] [Feature] RNW Image: Add support for http properties in source #12603

Closed

Beamanator self-requested a review January 19, 2024 11:46

Beamanator added the Ready To Build label Jan 19, 2024

0xmiroslav mentioned this pull request Jan 19, 2024

[TS Migration] Migrate Image to TypeScript #31296

Merged

50 tasks

blazejkustra suggested changes Jan 19, 2024

View reviewed changes

This was referenced Jan 19, 2024

[Tracking][Image][Polish] Image-related feature request and improvements #10894

Closed

[$250] [Image] Implement the ability to copy images to the clipboard #4629

Closed

This was referenced Jan 19, 2024

[Image][$1000] Improve NewDot image uploading experience, add large file support #9402

Closed

[HOLD #12603][Image][Performance] Avatars appear grey as they're loaded from server for common mobile flows - reported by @sobitneupane #11425

Closed

fabioh8010 approved these changes Jan 22, 2024

View reviewed changes

kidroca added 2 commits January 22, 2024 21:38

Add BaseImage specific props

c6b3b23

Extend BaseImage props to include native image properties

4487ccc

Merge branch 'main' into kidroca/feat/attachment-with-headers

7c5bb30

# Conflicts: # src/components/RoomHeaderAvatars.js # src/pages/ProfilePage.js

trjExpensify requested review from aimane-chnaif and removed request for 0xmiroslav January 29, 2024 20:02

trjExpensify mentioned this pull request Jan 29, 2024

[HOLD #12603][Image][Performance] Avatar images in a report are re-fetched when we hover on the message #11393

Closed

5 tasks

This comment was marked as resolved.

Sign in to view

aimane-chnaif approved these changes Jan 30, 2024

View reviewed changes

Beamanator approved these changes Jan 31, 2024

View reviewed changes

Beamanator merged commit 30ead56 into Expensify:main Jan 31, 2024

github-actions bot mentioned this pull request Jan 31, 2024

Deploy Checklist: New Expensify 2024-01-31 #35524

Closed

37 tasks

This was referenced Feb 2, 2024

[HOLD for payment 2024-02-09] [$500] IOU – Failed Split bill lost receipt when go offline #35580

Closed

[CP Staging] Revert "Image Web/Desktop: Add support for http headers" #35636

Merged

trjExpensify mentioned this pull request Feb 5, 2024

[MEDIUM] Feature Request: Make attachments to show immediately like the regular messages #35819

Closed

6 tasks

Conversation

kidroca commented Jan 15, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Details

Changes:

Fixed Issues

Tests

Verify the Image component works on all platforms

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

Uh oh!

melvin-bot bot commented Jan 15, 2024

Uh oh!

0xmiroslav commented Jan 15, 2024

Uh oh!

kidroca commented Jan 15, 2024

Uh oh!

0xmiroslav commented Jan 17, 2024

Uh oh!

kidroca commented Jan 17, 2024

Uh oh!

0xmiroslav commented Jan 19, 2024

Uh oh!

0xmiroslav commented Jan 19, 2024

Uh oh!

Beamanator commented Jan 19, 2024

Uh oh!

Beamanator commented Jan 19, 2024

Uh oh!

0xmiroslav commented Jan 19, 2024

Uh oh!

github-actions bot commented Jan 19, 2024

Uh oh!

blazejkustra left a comment

Choose a reason for hiding this comment

Uh oh!

blazejkustra Jan 19, 2024

Choose a reason for hiding this comment

Uh oh!

kidroca Jan 22, 2024

Choose a reason for hiding this comment

Uh oh!

0xmiroslav Jan 23, 2024

Choose a reason for hiding this comment

Uh oh!

blazejkustra Jan 23, 2024

Choose a reason for hiding this comment

Uh oh!

kidroca Jan 23, 2024

Choose a reason for hiding this comment

Uh oh!

0xmiroslav commented Jan 19, 2024

Uh oh!

0xmiroslav commented Jan 19, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

fabioh8010 left a comment

Choose a reason for hiding this comment

Uh oh!

aimane-chnaif commented Jan 25, 2024

Uh oh!

aimane-chnaif commented Jan 25, 2024

Uh oh!

kidroca commented Jan 26, 2024

Uh oh!

trjExpensify commented Jan 29, 2024

Uh oh!

This comment was marked as resolved.

aimane-chnaif commented Jan 30, 2024

Uh oh!

aimane-chnaif commented Jan 30, 2024

Reviewer Checklist

Screenshots/Videos

Uh oh!

aimane-chnaif left a comment

Choose a reason for hiding this comment

Uh oh!

Beamanator left a comment

kidroca commented Jan 15, 2024 •

edited

Loading

0xmiroslav commented Jan 19, 2024 •

edited

Loading