Image Web/Desktop: Add support for http headers

[kidroca]

Details

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

Changes:

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

2. Native Implementation Update:

   • File Location: src/components/Image/BaseImage.native.js
   • The native side now directly uses react-native-fast-image.

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

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

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

1. Launch the application and navigate to a report containing multiple attachments.
2. Scroll through the report, ensuring that all attachments are loading successfully without any errors or delay.
3. 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.
4. 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.
5. 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

1. Make sure you have viewed some reports with attachments while online.
2. Disconnect from the internet or turn on airplane mode to simulate an offline state.
3. Navigate to a report with attachments that were previously loaded.
   • Verify that these images still render correctly, even without an internet connection.
4. 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

1. Open the staging environment of the application.
2. Navigate to various reports that contain different types of attachments.
3. Ensure that all attachments load successfully without any visual artifacts or errors.
4. 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

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

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]

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

[kidroca]

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]

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]

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]

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

reviewing today

[Beamanator]

@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

[Beamanator]

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

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

[kidroca]

@kidroca please merge main

Done

[aimane-chnaif]

LGTM! Some minor feedback

[aimane-chnaif]

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]

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

[aimane-chnaif]

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]

Pushed a commit to address the code style issues

[aimane-chnaif]

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

[kidroca]

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]

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]

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

[kidroca]

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

✔️ Done

[aimane-chnaif]

🎉

[Beamanator]

LGTM!

[OSBotify]

✋ 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]

🚀 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]

🚀 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]

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

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