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

kidroca · 2024-02-15T08:09:16Z

Note: This PR was previously reverted (see PR #35636 for reference). Our objective now is to identify an issue that manifests only post-deployment. We should be able to use the pr-testing link to detect any problems in loading/rendering images

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

Screen.Recording.2024-02-15.at.9.35.41.mov

MacOS: Desktop

melvin-bot · 2024-02-15T08:26:47Z

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

aimane-chnaif · 2024-02-15T08:55:12Z

@Beamanator please generate adhoc build

Beamanator · 2024-02-15T09:10:47Z

Creating adhoc build soon 👍

Update: Building... https://github.com/Expensify/App/actions/runs/7913538905

kidroca · 2024-02-15T14:35:06Z

@aimane-chnaif, @francoisl, @Beamanator

I couldn't recreate the problem that led to reverting the previous PR, following these steps: #35636 (comment)

Furthermore, until the receipt image is uploaded and processed we're supplying the local file blob to represent the receipt image

This means the browser can release the local blob resource when it's no longer used, though I wasn't able to reproduce this either, but technically if you refresh, or better yet close the app window and open it again this local blob might be released to conserve resources

I have a working theory that since it takes some time to process a receipt, once the receipt result is ready the backend provides the remote attachment address, at that point the user happened to be offline and the remote image couldn't load
I see that in such cases we currently show an offline image placeholder

Or perhaps the issue @francoisl encountered is an unrelated, intermittent bug that manifests independently of the image update changes.

francoisl · 2024-02-15T20:27:11Z

Not sure if it helps, but here's what I'm seeing from https://36560.pr-testing.expensify.com/

The image has a blob:https:// src, even after reloading the app, and even after the receipt is finished processing in the backend
While offline, switching back and forth to a chat that has the blob: image replaces it with the offline placeholder - even though I can still refresh the blob: image in a separate tab, which seems to indicate that the browser did not release the blob

Screen.Recording.2024-02-15.at.12.18.13.PM.mov

kidroca · 2024-02-16T11:27:45Z

I believe I've identified the issue—the preflight response isn't being cached, resulting in its repeated execution with each image render. While the images themselves are cached, the browser is forced to reinitiate the preflight check due to the absence of caching headers. These headers are crucial as they instruct the browser on whether and how long to cache the preflight request.

a preflight request is being made even though the actual resource is cached

Consequently, in offline scenarios, the browser is unable to perform the preflight request, leading to a failure in loading all images.

Here are some visuals to illustrate the point:

Image caching example (Notice how the GET response for the image is cached):
Preflight request missing caching headers:

To fix the issue in offline usage, and omit doing preflight request for cached items we should add some cache to the preflight response as well (this is a backend task)

cubuspl42 · 2024-02-23T11:58:54Z

We're holding on this PR in #35041. Is this going to land relatively soon, or should we just figure out the way forward without waiting for this?

cubuspl42 · 2024-02-26T10:41:09Z

Conflicts ⚔️

kidroca · 2024-02-26T11:26:49Z

This Pull Request cannot be merged at this time due to unresolved issues related to preflight caching, as detailed in this comment. Proceeding with the merge before implementing the required backend adjustments would replicate the offline experience issues that previously necessitated a revert, as seen in PR #35636.

I will address any conflicts that arise in the meantime once the backend changes are completed, setting the stage for us to move forward with this PR.

trjExpensify · 2024-02-27T11:42:20Z

To fix the issue in offline usage, and omit doing preflight request for cached items we should add some cache to the preflight response as well (this is a backend task)

@Beamanator are you going to take this on, or perhaps @justinpersaud, as you've been helping out on resolving some backend issues related to this?

justinpersaud · 2024-03-04T15:11:48Z

@kidroca I just deployed a change to enable caching of preflight requests if you'd like to test again and report back.

kidroca · 2024-03-04T17:32:37Z

@kidroca I just deployed a change to enable caching of preflight requests if you'd like to test again and report back.

It doesn't seem possible to use the current PR review environment: https://36560.pr-testing.expensify.com/

I've pushed updates to sync with main and resolve conflicts, so we need to re-run the adhoc build: #36560 (comment)

amyevans · 2024-03-12T16:19:49Z

This got built, however the workflow failed on the Post a GitHub comment with app download links for testing step, so I'm going to just post them manually:

(cherry picked from commit 19b605e) (cherry picked from commit 37df3e3)

- Introduced `BaseImage` component that branches between native and web implementations. - **Native**: Utilizes `expo-image` 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. - Added `BaseImage` specific props - Adapt to `expo-image` deprecation of `event.nativeEvent` usage. - Ensure compatibility with components using the `onLoad` prop.

kidroca · 2024-03-13T11:32:50Z

@amyevans, thank you for your assistance. However, it appears that this PR was still significantly out of sync with main, leading us to encounter the "Update Requested" screen again on the review environment: https://36560.pr-testing.expensify.com/.

I've just re-synced with main. Could you please trigger another ad-hoc build? 🥺

Beamanator · 2024-03-13T11:53:22Z

Sorry y'all, I just got back from vacay 🙏 I just triggered another adhoc build 👍 - https://github.com/Expensify/App/actions/runs/8264151190

github-actions · 2024-03-13T12:19:19Z

🧪🧪 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/36560/index.html	https://ad-hoc-expensify-cash.s3.amazonaws.com/ios/36560/index.html

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

👀 View the workflow run that generated this build 👀

kidroca · 2024-03-13T12:25:36Z

Hello @Beamanator,

I noticed that the Web build and deploy process was successful: https://github.com/Expensify/App/actions/runs/8264151190/job/22607147679. However, there seems to be an issue, as the review environment still displays the "Update Requested" screen. This could either be because the build isn't using the latest code, or there might be a build issue. Upon inspecting the details, I observed that App's version in the network calls is 1.4.42-0, which is incorrect. After pulling the remote branch, I confirmed that the version should be 1.4.51-3. Therefore, it appears something is not functioning as expected with the ad hoc build process.

Could you investigate, or confirm you have the same issue on this review env: https://36560.pr-testing.expensify.com/

aimane-chnaif · 2024-03-13T12:38:59Z

I have no issue. No "Update required" popup

Beamanator · 2024-03-13T12:41:14Z

Same here 🤔 I'm able to sign in and I see appversion: 1.4.51-3

kidroca · 2024-03-13T14:16:22Z

Same here 🤔 I'm able to sign in and I see appversion: 1.4.51-3

Thank you for checking, everyone. It appears to have been a caching issue, as switching to a different browser resolved the problem for me. I can no longer reproduce the issue with thumbnail images when offline, nor the issue with failed receipt OCRs. I've confirmed that the preflight requests are now cached for 24 hours, which means they are entirely skipped in CORS checks.

✔️ The PR is now ready for review. It has already been reviewed and approved in previous iterations, but it's worth taking another look since I introduced some changes while resolving conflicts with the recent conversion of the Image to TypeScript.

Beamanator · 2024-03-14T10:20:48Z

Amazing, thanks so much @kidroca 🙏 @aimane-chnaif can you please do another full review before we move forward with this PR?

aimane-chnaif · 2024-03-17T16:22:09Z

Code looks good.
Retested past regressions (#32593, #35580) on both localhost and PR build. Not repro anymore

aimane-chnaif · 2024-03-17T16:29:14Z

Hope this behavior would be fine: (at least not blocker)

Offline icon glitches for a brief moment (around 21s in video)

Screen.Recording.2024-03-17.at.4.24.16.PM.mov

aimane-chnaif · 2024-03-18T00:42:59Z

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 either coming verbatim from figma or has been approved by marketing (in order to get marketing approval, ask the Bug Zero team member to add the Waiting for copy label to the issue)
- 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 UI (e.g. new buttons, new UI components, changing the padding/spacing/sizing, moving components, etc) or modifies the form input styles:
- I verified that all the inputs inside a form are aligned with each other.
- I added Design label and/or tagged @Expensify/design 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

Beamanator

This looks great to me, Hoping this is the last time we have to merge this 🙏

OSBotify · 2024-03-18T08:18:15Z

✋ 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-03-18T16:30:16Z

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

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

OSBotify · 2024-03-19T23:11:20Z

🚀 Deployed to production by https://github.com/AndrewGable in version: 1.4.54-4 🚀

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

kidroca mentioned this pull request Feb 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

kidroca marked this pull request as ready for review February 15, 2024 08:26

kidroca requested a review from a team as a code owner February 15, 2024 08:26

melvin-bot bot requested review from aimane-chnaif and removed request for a team February 15, 2024 08:26

Beamanator self-requested a review February 15, 2024 09:10

Beamanator added the Ready To Build label Feb 15, 2024

This comment has been minimized.

Sign in to view

This was referenced Feb 19, 2024

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

Closed

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

Closed

cubuspl42 mentioned this pull request Feb 23, 2024

Receipt thumbnail should show the top of the receipt #35041

Merged

50 tasks

aimane-chnaif mentioned this pull request Feb 28, 2024

[TS Migration] Migrate Image to TypeScript #31296

Merged

50 tasks

Beamanator mentioned this pull request Feb 28, 2024

Add NewDot image preflight request caching #37431

Closed

cubuspl42 mentioned this pull request Mar 1, 2024

[HOLD] [$250] [MEDIUM] Smartscan: Receipt thumbnail should show the top of the receipt #34120

Closed

6 tasks

kidroca force-pushed the kidroca/feat/attachment-with-headers-2 branch 2 times, most recently from 5911738 to c5bf5fc Compare March 4, 2024 17:27

justinpersaud added Ready To Build and removed Ready To Build labels Mar 4, 2024

trjExpensify mentioned this pull request Mar 8, 2024

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

Closed

kidroca added 3 commits March 13, 2024 13:18

Add react-native-web patch for image header support

53337f5

(cherry picked from commit 19b605e) (cherry picked from commit 37df3e3)

Refactor: Exclude Auth Token for External Avatar Images

22a1de0

kidroca force-pushed the kidroca/feat/attachment-with-headers-2 branch from c5bf5fc to 22a1de0 Compare March 13, 2024 11:19

aimane-chnaif approved these changes Mar 18, 2024

View reviewed changes

Beamanator approved these changes Mar 18, 2024

View reviewed changes

Beamanator merged commit 135cfeb into Expensify:main Mar 18, 2024
15 checks passed

github-actions bot mentioned this pull request Mar 18, 2024

Deploy Checklist: New Expensify 2024-03-18 #38489

Closed

65 tasks

situchan mentioned this pull request Mar 19, 2024

[$500] [HOLD for payment 2024-03-29] [HOLD for payment 2024-03-26] Profile - Avatar is blank when viewed in full screen #38516

Closed

6 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

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

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

kidroca commented Feb 15, 2024

melvin-bot bot commented Feb 15, 2024

aimane-chnaif commented Feb 15, 2024

Beamanator commented Feb 15, 2024 •

edited

Loading

This comment has been minimized.

kidroca commented Feb 15, 2024

francoisl commented Feb 15, 2024

kidroca commented Feb 16, 2024 •

edited

Loading

cubuspl42 commented Feb 23, 2024

cubuspl42 commented Feb 26, 2024

kidroca commented Feb 26, 2024

trjExpensify commented Feb 27, 2024

justinpersaud commented Mar 4, 2024

kidroca commented Mar 4, 2024

amyevans commented Mar 12, 2024

kidroca commented Mar 13, 2024

Beamanator commented Mar 13, 2024 •

edited

Loading

github-actions bot commented Mar 13, 2024

kidroca commented Mar 13, 2024

aimane-chnaif commented Mar 13, 2024

Beamanator commented Mar 13, 2024

kidroca commented Mar 13, 2024

Beamanator commented Mar 14, 2024 •

edited

Loading

aimane-chnaif commented Mar 17, 2024

aimane-chnaif commented Mar 17, 2024

aimane-chnaif commented Mar 18, 2024

Beamanator left a comment

OSBotify commented Mar 18, 2024

OSBotify commented Mar 18, 2024

OSBotify commented Mar 19, 2024

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

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

Conversation

kidroca commented Feb 15, 2024

Details

Changes:

Fixed Issues

Tests

Verify the Image component works on all platforms

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

melvin-bot bot commented Feb 15, 2024

aimane-chnaif commented Feb 15, 2024

Beamanator commented Feb 15, 2024 • edited Loading

This comment has been minimized.

kidroca commented Feb 15, 2024

francoisl commented Feb 15, 2024

kidroca commented Feb 16, 2024 • edited Loading

cubuspl42 commented Feb 23, 2024

cubuspl42 commented Feb 26, 2024

kidroca commented Feb 26, 2024

trjExpensify commented Feb 27, 2024

justinpersaud commented Mar 4, 2024

kidroca commented Mar 4, 2024

amyevans commented Mar 12, 2024

kidroca commented Mar 13, 2024

Beamanator commented Mar 13, 2024 • edited Loading

github-actions bot commented Mar 13, 2024

kidroca commented Mar 13, 2024

aimane-chnaif commented Mar 13, 2024

Beamanator commented Mar 13, 2024

kidroca commented Mar 13, 2024

Beamanator commented Mar 14, 2024 • edited Loading

aimane-chnaif commented Mar 17, 2024

aimane-chnaif commented Mar 17, 2024

aimane-chnaif commented Mar 18, 2024

Reviewer Checklist

Screenshots/Videos

Beamanator left a comment

Choose a reason for hiding this comment

OSBotify commented Mar 18, 2024

OSBotify commented Mar 18, 2024

OSBotify commented Mar 19, 2024

Beamanator commented Feb 15, 2024 •

edited

Loading

kidroca commented Feb 16, 2024 •

edited

Loading

Beamanator commented Mar 13, 2024 •

edited

Loading

Beamanator commented Mar 14, 2024 •

edited

Loading