Image Web/Desktop: Add support for http headers #13036

kidroca · 2022-11-25T02:32:10Z

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.js
- 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.js
- The native side now directly uses react-native-fast-image.
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.

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.

PR Author Checklist

Screenshots/Videos

Web

Screen.Recording.2023-11-06.at.9.14.20.mp4

Mobile Web - Chrome

Mobile Web - Safari

Desktop

Screen.Recording.2023-11-06.at.10.27.12.mov

iOS

Android

Beamanator · 2022-12-02T11:51:53Z

Holding on this as we try to get the upstream react-native-web PR merged: necolas/react-native-web#2442

kidroca · 2022-12-21T19:53:33Z

Image requests made with headers, then the same requests getting served from cache

Still served from browser cache after login out, closing browser window, then opening a new window and loging in

Sample request content

no longer uses query param for the token
has a X-Chat-Attachment-Token request header instead

kidroca · 2022-12-23T09:55:08Z

I've cherry picked this commit in order to test the new Image functionality: 34d941d92742dda5e383a19b759ef60247e5376a
Once the code makes it to main I'll drop the commit and merge main to my branch and conflicts should be resolved

Details about the related PR here: #12603 (comment)

Beamanator · 2023-01-02T16:04:09Z

Thanks for this @kidroca!

Once the code makes it to main

Note: There's a draft PR to re-implement the iOS / Android caching: #13304 but we're not planning to move forward with that for another week (assuming the maintainer of https://github.com/DylanVann/react-native-fast-image/ doesn't respond sooner)

So if we get your react-native-web PR (Expensify fork) merged sooner, we may need to decide if we want to wait on that ^ draft PR or implement some of it in your PR to take advantage of your react-native-web changes

melvin-bot · 2023-01-17T12:00:39Z

@Beamanator @aimane-chnaif 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]

aimane-chnaif · 2023-01-18T08:48:02Z

reviewing today

Beamanator · 2023-01-18T12:55:52Z

@aimane-chnaif I'm sorry if you've already started reviewing, but we're still going through a few revisions on the react-native-web Fork PR - that being said, feel free to test just to make sure the current code works, though I may request a re-test if we go through with some suggested refactors 👍

Beamanator

Love what I've seen so far, got a few initial comments

src/libs/replaceSourceOrigin.js

src/components/Image/BaseImage.js

Beamanator · 2023-01-25T12:24:17Z

@aimane-chnaif FYI the changes in the related fork PR are very close to being approved, so feel free to jump in and start testing this when you have a chance 👍 🙏

Beamanator · 2023-01-27T15:18:49Z

@kidroca ok it looks like @expensify/react-native-web v0.18.11 has been published and is ready for testing in this PR 👍

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.

kidroca · 2023-11-29T16:29:12Z

@kidroca please merge main

Done

aimane-chnaif

LGTM! Some minor feedback

src/components/Image/index.js

src/components/Image/BaseImage.js

aimane-chnaif · 2023-12-03T18:37:47Z

Seeing various console errors but out of scope as already happening on main

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

aimane-chnaif · 2023-12-03T20:32:04Z

src/components/Image/index.native.js

-    },
-})(Image);
-ImageWithOnyx.resizeMode = RESIZE_MODES;
-ImageWithOnyx.resolveDimensions = resolveDimensions;


👍
Context: https://github.com/Expensify/App/pull/20798/files#r1382847804

aimane-chnaif · 2023-12-03T20:34:09Z

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

kidroca · 2023-12-05T09:00:25Z

Pushed a commit to address the code style issues

aimane-chnaif · 2023-12-05T09:06:00Z

can you please also pull main and retest? almost 1k commits behind

kidroca · 2023-12-05T20:14:39Z

can you please also pull main and retest? almost 1k commits behind

I've synced and re-tested - everything seems good, though there seems to be a Typescript error unrelated to my changes

src/libs/actions/Link.ts:103:29 - error TS2345: Argument of type 'string' is not assignable to parameter of type 'AllRoutes | undefined'.

aimane-chnaif · 2023-12-05T20:16:03Z

can you please also pull main and retest? almost 1k commits behind

I've synced and re-tested - everything seems good, though there seems to be a Typescript error unrelated to my changes
src/libs/actions/Link.ts:103:29 - error TS2345: Argument of type 'string' is not assignable to parameter of type 'AllRoutes | undefined'.

It's being discussed here.
I think we should sync main once again after this is fixed

aimane-chnaif · 2023-12-05T20:25:46Z

@kidroca please merge main again. It's fixed in #32510

kidroca · 2023-12-05T20:47:52Z

@kidroca please merge main again. It's fixed in #32510

✔️ Done

aimane-chnaif

🎉

Beamanator

LGTM!

OSBotify · 2023-12-06T11:09:59Z

✋ 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 · 2023-12-06T22:16:58Z

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

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

OSBotify · 2023-12-06T23:11:08Z

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

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

OSBotify · 2023-12-08T01:08:15Z

🚀 Deployed to production by https://github.com/yuwenmemon in version: 1.4.9-5 🚀

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

kidroca force-pushed the kidroca/feature/react-native-web-image-headers branch from 8ddbaa0 to efdf4d2 Compare November 25, 2022 11:20

This was referenced Nov 25, 2022

[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

Image: support ImageSource with headers Expensify/react-native-web#8

Closed

kidroca changed the title ~~Kidroca/feature/react native web image headers~~ Image: Add support for http headers in source Nov 25, 2022

kidroca changed the title ~~Image: Add support for http headers in source~~ Image Web/Desktop: Add support for http headers Nov 25, 2022

kidroca force-pushed the kidroca/feature/react-native-web-image-headers branch from ac2598f to 2dbbf10 Compare December 21, 2022 13:08

kidroca force-pushed the kidroca/feature/react-native-web-image-headers branch from 2dbbf10 to 4ddff74 Compare December 23, 2022 08:08

Beamanator mentioned this pull request Jan 10, 2023

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

Closed

39 tasks

kidroca force-pushed the kidroca/feature/react-native-web-image-headers branch 2 times, most recently from c4b7588 to 39a5238 Compare January 17, 2023 11:48

This comment was marked as outdated.

Sign in to view

kidroca marked this pull request as ready for review January 17, 2023 12:00

kidroca requested a review from a team as a code owner January 17, 2023 12:00

melvin-bot bot requested review from aimane-chnaif and Beamanator and removed request for a team January 17, 2023 12:00

Beamanator reviewed Jan 18, 2023

View reviewed changes

src/libs/replaceSourceOrigin.js Outdated Show resolved Hide resolved

src/libs/replaceSourceOrigin.js Outdated Show resolved Hide resolved

src/libs/replaceSourceOrigin.js Outdated Show resolved Hide resolved

src/components/Image/BaseImage.js Outdated Show resolved Hide resolved

kidroca force-pushed the kidroca/feature/react-native-web-image-headers branch from 39a5238 to 9e0a124 Compare January 19, 2023 11:05

This comment was marked as outdated.

Sign in to view

kidroca force-pushed the kidroca/feature/react-native-web-image-headers branch from b8cf933 to 75e5c63 Compare January 25, 2023 10:42

kidroca mentioned this pull request Jan 25, 2023

[add] Image source headers handling Expensify/react-native-web#11

Merged

kidroca force-pushed the kidroca/feature/react-native-web-image-headers branch from 061ee6e to cc49208 Compare November 29, 2023 16:17

aimane-chnaif reviewed Dec 3, 2023

View reviewed changes

src/components/Image/index.js Outdated Show resolved Hide resolved

src/components/Image/BaseImage.js Show resolved Hide resolved

aimane-chnaif reviewed Dec 3, 2023

View reviewed changes

Align changes with project code styles

1182c7d

Merge branch 'main' into kidroca/feature/react-native-web-image-headers

8fed789

Merge branch 'main' into kidroca/feature/react-native-web-image-headers

18000a2

aimane-chnaif approved these changes Dec 5, 2023

View reviewed changes

Beamanator mentioned this pull request Dec 6, 2023

Tracker to follow up with react-native-web patches #32544

Closed

Beamanator approved these changes Dec 6, 2023

View reviewed changes

Beamanator merged commit efcd932 into Expensify:main Dec 6, 2023
16 checks passed

github-actions bot mentioned this pull request Dec 6, 2023

Deploy Checklist: New Expensify 2023-12-06 #32589

Closed

74 tasks

izarutskaya mentioned this pull request Dec 7, 2023

[$500] Chat - Loading animation not shown when open 1:1 Conversation with uncached attachments #32699

Closed

6 tasks

blimpich mentioned this pull request Dec 7, 2023

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

Merged

0xmiros mentioned this pull request Jan 15, 2024

Image Web/Desktop: Add support for http headers #34505

Merged

48 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Image Web/Desktop: Add support for http headers #13036

Image Web/Desktop: Add support for http headers #13036

kidroca commented Nov 25, 2022 •

edited

Loading

Beamanator commented Dec 2, 2022

kidroca commented Dec 21, 2022

kidroca commented Dec 23, 2022

Beamanator commented Jan 2, 2023

This comment was marked as outdated.

melvin-bot bot commented Jan 17, 2023

aimane-chnaif commented Jan 18, 2023

Beamanator commented Jan 18, 2023

Beamanator left a comment

This comment was marked as outdated.

Beamanator commented Jan 25, 2023

Beamanator commented Jan 27, 2023

kidroca commented Nov 29, 2023

aimane-chnaif left a comment

aimane-chnaif commented Dec 3, 2023

aimane-chnaif Dec 3, 2023

aimane-chnaif commented Dec 3, 2023

kidroca commented Dec 5, 2023

aimane-chnaif commented Dec 5, 2023

kidroca commented Dec 5, 2023

aimane-chnaif commented Dec 5, 2023

aimane-chnaif commented Dec 5, 2023

kidroca commented Dec 5, 2023

aimane-chnaif left a comment

Beamanator left a comment

OSBotify commented Dec 6, 2023

OSBotify commented Dec 6, 2023

OSBotify commented Dec 6, 2023

OSBotify commented Dec 8, 2023

Image Web/Desktop: Add support for http headers #13036

Image Web/Desktop: Add support for http headers #13036

Conversation

kidroca commented Nov 25, 2022 • edited Loading

Details

Changes:

Fixed Issues

Tests

Verify the Image component works on all platforms

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

Beamanator commented Dec 2, 2022

kidroca commented Dec 21, 2022

kidroca commented Dec 23, 2022

Beamanator commented Jan 2, 2023

This comment was marked as outdated.

melvin-bot bot commented Jan 17, 2023

aimane-chnaif commented Jan 18, 2023

Beamanator commented Jan 18, 2023

Beamanator left a comment

Choose a reason for hiding this comment

This comment was marked as outdated.

Beamanator commented Jan 25, 2023

Beamanator commented Jan 27, 2023

kidroca commented Nov 29, 2023

aimane-chnaif left a comment

Choose a reason for hiding this comment

aimane-chnaif commented Dec 3, 2023

aimane-chnaif Dec 3, 2023

Choose a reason for hiding this comment

aimane-chnaif commented Dec 3, 2023

Reviewer Checklist

Screenshots/Videos

kidroca commented Dec 5, 2023

aimane-chnaif commented Dec 5, 2023

kidroca commented Dec 5, 2023

aimane-chnaif commented Dec 5, 2023

aimane-chnaif commented Dec 5, 2023

kidroca commented Dec 5, 2023

aimane-chnaif left a comment

Choose a reason for hiding this comment

Beamanator left a comment

Choose a reason for hiding this comment

OSBotify commented Dec 6, 2023

OSBotify commented Dec 6, 2023

OSBotify commented Dec 6, 2023

OSBotify commented Dec 8, 2023

kidroca commented Nov 25, 2022 •

edited

Loading