When uploading, automatically reduce the size of receipt image #45448

nkdengineer · 2024-07-16T03:01:19Z

Details

Fixed Issues

$ #44084
PROPOSAL: #44084 (comment)

Tests

Login
Submit a manual expense
Add receipt
Upload a image with size > 24MB
Verify that: It works normally

Verify that no errors appear in the JS console

Offline tests

QA Steps

Login
Submit a manual expense
Add receipt
Upload a image with size > 24MB
Verify that: It works normally

Verify that no errors appear in the JS console

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 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 followed the guidelines as stated in the Review Guidelines
I tested other components that can be impacted by my changes (i.e. if the PR modifies a shared library or component like Avatar, I verified the components using Avatar are working as expected)
I verified all code is DRY (the PR doesn't include any logic written more than once, with the exception of tests)
I verified any variables that can be defined as constants (ie. in CONST.js or at the top of the file that uses the constant) are defined as such
I verified that if a function's arguments changed that all usages have also been updated correctly
If any new file was added I verified that:
- The file has a description of what it does and/or why is needed at the top of the file if the code is not self explanatory
If a new CSS style is added I verified that:
- A similar style doesn't already exist
- The style can't be created with an existing StyleUtils function (i.e. StyleUtils.getBackgroundAndBorderStyle(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.

Screenshots/Videos

Android: Native

Android: mWeb Chrome

android-mweb.mov

iOS: Native

ios.mov

iOS: mWeb Safari

ios-mweb-resize.mp4

MacOS: Chrome / Safari

web.mov

MacOS: Desktop

desktop.mov

melvin-bot · 2024-07-23T15:35:07Z

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

luacmartins

I haven't tested but code LGTM. Left a small suggestion to simplify the resizing code

src/libs/fileDownload/FileUtils.ts

Co-authored-by: Carlos Martins <luacmartins@gmail.com>

shubham1206agra · 2024-07-24T04:24:58Z

@nkdengineer Can you send me file to test this PR?

luacmartins · 2024-07-24T14:43:15Z

@shubham1206agra I think any image over 2MB should do it

luacmartins · 2024-07-26T15:03:30Z

@shubham1206agra bump for review

src/libs/fileDownload/FileUtils.ts

shubham1206agra · 2024-07-27T17:08:07Z

src/libs/fileDownload/FileUtils.ts

+    });
+
+const resizeImageIfNeeded = (file: FileObject) => {
+    if (!file || !Str.isImage(file.name ?? '') || (file?.size ?? 0) <= CONST.API_ATTACHMENT_VALIDATIONS.MAX_SIZE) {


@shubham1206agra I think any image over 2MB should do it

@luacmartins This is not true. I need 24MB file to check this flow. See this line.

Or do you want to manipulate this condition?

@shubham1206agra you can download the large image here

Co-authored-by: Shubham Agrawal <58412969+shubham1206agra@users.noreply.github.com>

shubham1206agra · 2024-07-29T16:22:32Z

Screen.Recording.2024-07-29.at.9.50.30.PM.mov

@nkdengineer This is giving weird result here.

luacmartins · 2024-07-29T18:58:22Z

I'm running an adhoc build since the attachment flow can be a bit weird on the simulator.

github-actions · 2024-07-29T19:33:09Z

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

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

👀 View the workflow run that generated this build 👀

shubham1206agra · 2024-07-30T01:05:53Z

@luacmartins Still not working.

shubham1206agra · 2024-07-30T02:08:26Z

@luacmartins I just tested uploading large image on main directly, and it works just fine.

@nkdengineer Can you please look into why this is happening?

nkdengineer · 2024-07-30T03:35:18Z

Checking this now.

nkdengineer · 2024-07-30T10:59:24Z

@shubham1206agra I'm investigating to find a fix for this case.

nkdengineer · 2024-07-30T15:34:33Z

@shubham1206agra The context is here. Because the canvas area limit on IOS Safari is 4096 * 4096 and manipulateAsync function uses the original width and height to create the canvas of the original image, this canvas becomes invalid and then the black image appears after resizing.

canvas.width = imageSource.naturalWidth;
canvas.height = imageSource.naturalHeight;

If we want to fix this, we need to implement it in expo-image-manipulator lib to divide the image into small canvases, get image data from the small canvases, and combine them into image data of the original image before resizing.
Display a warning as this comment When uploading, automatically reduce the size of receipt image #45448 (comment)

cc @luacmartins

luacmartins · 2024-07-30T16:32:40Z

Asked in Slack for someone familiar with expo-image-manipulator to comment here.

BrtqKr · 2024-08-01T14:42:11Z

@luacmartins @nkdengineer
Ok, so the diagnosis regarding the issue was correct - the files exceeding the limit were corrupted (the format signatures were correct tho), but...

It looks like enforcing the canvas size within the limits before performing the operations (on the image manipulator level) seems to be fixing the problem. It's a bit weird, because with those assumptions the canvas is smaller than the image being processed (for a brief moment), but the end result should be fulfilling our expectations.

On the other hand, what should not be fulfilling our expectations is the processing time - I'd suggest at least adding the indicator that the image is being processed. Uploading images of that size is probably not a common case, but this might be slightly confusing.

I'll try to send a PR during the week-end and discuss it in the image-manipulator repository directly, but for now that should be sufficient.

If you don't have any concerns regarding this approach, I think we could include the forementioned patch in this PR.

Simulator.Screen.Recording.-.iPhone.15.Pro.-.2024-08-01.at.16.34.09.mp4

luacmartins · 2024-08-01T19:11:17Z

Nice! Thanks for the investigation @BrtqKr! Looking forward to the PR!

BrtqKr · 2024-08-02T09:45:23Z

@nkdengineer if you could apply this, it would be amazing. Let me know if you have any problems related to this patch. If this gets merged before I discuss it with expo and the library gets released, I'll clean this patch and bump the version in a separate PR.

nkdengineer · 2024-08-02T09:47:50Z

@BrtqKr I will add the patch in this PR soon.

nkdengineer · 2024-08-05T03:32:06Z

@shubham1206agra Updated the patch for the resizing solution, I tested and it works well. Please help to test again, thanks.

shubham1206agra · 2024-08-05T05:07:02Z

@nkdengineer Looks like you inserted the patch incorrectly. It has unnecessary info.

nkdengineer · 2024-08-05T06:30:04Z

@shubham1206agra I updated, I missed re-installing the lib before creating the patch.

shubham1206agra · 2024-08-05T10:19:51Z

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: mWeb Chrome

Screen.Recording.2024-07-29.at.10.08.02.PM.mov

iOS: Native

Screen.Recording.2024-07-29.at.10.20.50.PM.mov

iOS: mWeb Safari

Screen.Recording.2024-08-05.at.3.43.00.PM.mov

MacOS: Chrome / Safari

Screen.Recording.2024-07-29.at.9.42.34.PM.mov

MacOS: Desktop

Screen.Recording.2024-07-29.at.10.11.34.PM.mov

luacmartins

LGTM

OSBotify · 2024-08-05T11:55:29Z

✋ 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-08-06T04:27:38Z

🚀 Deployed to staging by https://github.com/luacmartins in version: 9.0.17-0 🚀

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

OSBotify · 2024-08-07T22:03:28Z

🚀 Deployed to production by https://github.com/marcaaron in version: 9.0.17-2 🚀

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

OSBotify · 2024-08-08T04:53:05Z

🚀 Deployed to production by https://github.com/marcaaron in version: 9.0.17-2 🚀

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

OSBotify · 2024-08-08T20:04:29Z

🚀 Deployed to production by https://github.com/marcaaron in version: 9.0.17-2 🚀

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

nkdengineer added 6 commits July 16, 2024 09:59

fix: reduce size image

a557e6f

fix: add resize in native

6ddcc58

add solution for native

01815b2

merge main

e8442f2

add optional

a64a32d

add comment

0176f01

nkdengineer marked this pull request as ready for review July 23, 2024 15:35

nkdengineer requested a review from a team as a code owner July 23, 2024 15:35

melvin-bot bot removed the request for review from a team July 23, 2024 15:35

melvin-bot bot requested a review from shubham1206agra July 23, 2024 15:35

nkdengineer mentioned this pull request Jul 23, 2024

[HOLD for payment 2024-08-14] [$250] Feature Request: When uploading, automatically reduce the size of receipt image if greater than 24mb #44084

Closed

luacmartins self-requested a review July 23, 2024 15:41

luacmartins requested changes Jul 23, 2024

View reviewed changes

src/libs/fileDownload/FileUtils.ts Outdated Show resolved Hide resolved

Update src/libs/fileDownload/FileUtils.ts

21a4cb5

Co-authored-by: Carlos Martins <luacmartins@gmail.com>

luacmartins previously approved these changes Jul 24, 2024

View reviewed changes

shubham1206agra reviewed Jul 27, 2024

View reviewed changes

src/libs/fileDownload/FileUtils.ts Outdated Show resolved Hide resolved

shubham1206agra reviewed Jul 27, 2024

View reviewed changes

nkdengineer dismissed luacmartins’s stale review via 60b6b57 July 29, 2024 07:12

Update src/libs/fileDownload/FileUtils.ts

60b6b57

Co-authored-by: Shubham Agrawal <58412969+shubham1206agra@users.noreply.github.com>

luacmartins added the Ready To Build label Jul 29, 2024

temporary disable validate for test

c63cdc1

nkdengineer added 2 commits August 5, 2024 10:23

Merge branch 'main' into fix/reduce-size-image-44084

8ca9b74

add patch resize

fbf01ba

revert unnecessary change

10faa93

update patch

623fbe8

fix error

b8b8eea

luacmartins requested review from shubham1206agra and luacmartins August 5, 2024 07:56

shubham1206agra approved these changes Aug 5, 2024

View reviewed changes

luacmartins approved these changes Aug 5, 2024

View reviewed changes

luacmartins merged commit 4c0c160 into Expensify:main Aug 5, 2024
15 checks passed

github-actions bot mentioned this pull request Aug 6, 2024

Deploy Checklist: New Expensify 2024-08-06 #46849

Closed

83 tasks

m-natarajan mentioned this pull request Aug 6, 2024

IOU - Uploading a receipt with >24MB freezes the app for a while #46882

Closed

6 tasks

OlimpiaZurek mentioned this pull request Oct 4, 2024

[HOLD for payment 2024-10-17] The Heic format image showing as 2.5MB is uploading with size over 10MB #49999

Closed

6 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

When uploading, automatically reduce the size of receipt image #45448

When uploading, automatically reduce the size of receipt image #45448

nkdengineer commented Jul 16, 2024 •

edited

Loading

melvin-bot bot commented Jul 23, 2024

luacmartins left a comment

shubham1206agra commented Jul 24, 2024

luacmartins commented Jul 24, 2024

luacmartins commented Jul 26, 2024

shubham1206agra Jul 27, 2024

shubham1206agra Jul 27, 2024

nkdengineer Jul 29, 2024

shubham1206agra commented Jul 29, 2024

luacmartins commented Jul 29, 2024

github-actions bot commented Jul 29, 2024

shubham1206agra commented Jul 30, 2024

shubham1206agra commented Jul 30, 2024

nkdengineer commented Jul 30, 2024

nkdengineer commented Jul 30, 2024

nkdengineer commented Jul 30, 2024

luacmartins commented Jul 30, 2024

BrtqKr commented Aug 1, 2024 •

edited

Loading

luacmartins commented Aug 1, 2024

BrtqKr commented Aug 2, 2024 •

edited

Loading

nkdengineer commented Aug 2, 2024

nkdengineer commented Aug 5, 2024

shubham1206agra commented Aug 5, 2024

nkdengineer commented Aug 5, 2024

shubham1206agra commented Aug 5, 2024

luacmartins left a comment

OSBotify commented Aug 5, 2024

OSBotify commented Aug 6, 2024

OSBotify commented Aug 7, 2024

OSBotify commented Aug 8, 2024

OSBotify commented Aug 8, 2024

When uploading, automatically reduce the size of receipt image #45448

When uploading, automatically reduce the size of receipt image #45448

Conversation

nkdengineer commented Jul 16, 2024 • edited Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

melvin-bot bot commented Jul 23, 2024

luacmartins left a comment

Choose a reason for hiding this comment

shubham1206agra commented Jul 24, 2024

luacmartins commented Jul 24, 2024

luacmartins commented Jul 26, 2024

shubham1206agra Jul 27, 2024

Choose a reason for hiding this comment

shubham1206agra Jul 27, 2024

Choose a reason for hiding this comment

nkdengineer Jul 29, 2024

Choose a reason for hiding this comment

shubham1206agra commented Jul 29, 2024

luacmartins commented Jul 29, 2024

github-actions bot commented Jul 29, 2024

shubham1206agra commented Jul 30, 2024

shubham1206agra commented Jul 30, 2024

nkdengineer commented Jul 30, 2024

nkdengineer commented Jul 30, 2024

nkdengineer commented Jul 30, 2024

luacmartins commented Jul 30, 2024

BrtqKr commented Aug 1, 2024 • edited Loading

luacmartins commented Aug 1, 2024

BrtqKr commented Aug 2, 2024 • edited Loading

nkdengineer commented Aug 2, 2024

nkdengineer commented Aug 5, 2024

shubham1206agra commented Aug 5, 2024

nkdengineer commented Aug 5, 2024

shubham1206agra commented Aug 5, 2024

Reviewer Checklist

Screenshots/Videos

luacmartins left a comment

Choose a reason for hiding this comment

OSBotify commented Aug 5, 2024

OSBotify commented Aug 6, 2024

OSBotify commented Aug 7, 2024

OSBotify commented Aug 8, 2024

OSBotify commented Aug 8, 2024

nkdengineer commented Jul 16, 2024 •

edited

Loading

BrtqKr commented Aug 1, 2024 •

edited

Loading

BrtqKr commented Aug 2, 2024 •

edited

Loading