Fix can't download scan receipt image by bernhardoj · Pull Request #29738 · Expensify/App

bernhardoj · 2023-10-17T05:34:07Z

Details

Initially, the scan receipt image is a local file. When we try to download it, the local file path is appended with an auth token, so the file is not found.

Fixed Issues

$ #27992
PROPOSAL: #27992 (comment)

Tests

Same as QA Steps

Verify that no errors appear in the JS console

Offline tests

Same as QA Steps

QA Steps

Turn off your internet connection (or Force offline)
Open any chat
Press the + button and choose Request money
Switch to Scan tab
Select any file and confirm the request
Open the transaction thread
Press the receipt image
Press the three-dot button
Choose "Download"
Verify the receipt image is downloaded successfully

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 / Chrome
- iOS / native
- iOS / 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
- 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 author checklist, including those that don't apply to this PR.

Screenshots/Videos

Android: Native

Screen.Recording.2023-10-17.at.13.16.11.mov

Android: mWeb Chrome

Screen.Recording.2023-10-17.at.12.53.39.mov

iOS: Native

Screen.Recording.2023-10-17.at.12.50.14.mov

iOS: mWeb Safari

Screen.Recording.2023-10-17.at.12.45.04.mov

MacOS: Chrome / Safari

Screen.Recording.2023-10-17.at.12.41.05.mov

MacOS: Desktop

Screen.Recording.2023-10-17.at.12.47.53.mov

melvin-bot · 2023-10-17T05:34:12Z

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

ArekChr · 2023-10-17T10:04:18Z

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

Web

web.mov

Mobile Web - Chrome

mweb.chrome.mov

Mobile Web - Safari

mweb.safari.mov

Desktop

desktop.mov

iOS

ios.mov

Android

android.mov

ArekChr

Thanks for PR! all works

marcaaron · 2023-10-18T00:38:07Z

LGTM but some conflicts appeared.

bernhardoj · 2023-10-18T03:40:10Z

Fixed the conflict.

By the way, I found an issue. If we do a scan request and upload a non-image file, the receipt image shown is from the default receipt image asset.

App/src/libs/ReceiptUtils.ts

Lines 50 to 64 in add7f66

    
           const {fileExtension} = FileUtils.splitExtensionFromFileName(filename) as FileNameAndExtension; 
        
           let image = ReceiptGeneric; 
        
           if (fileExtension === CONST.IOU.FILE_TYPES.HTML) { 
        
               image = ReceiptHTML; 
        
           } 
        
           if (fileExtension === CONST.IOU.FILE_TYPES.DOC || fileExtension === CONST.IOU.FILE_TYPES.DOCX) { 
        
               image = ReceiptDoc; 
        
           } 
        
           if (fileExtension === CONST.IOU.FILE_TYPES.SVG) { 
        
               image = ReceiptSVG; 
        
           } 
        
           return {thumbnail: null, image};

On native, the image asset will have a type of number, so it will crash when we call startsWith. So, I pushed a fix to make sure the type is a string.

But, I think it's weird for a user to be able to view the default receipt image, but currently, it shows Failed to load PDF. I think we shouldn't add the default receipt image asset to the image carousel. If we do this, then we don't need to check whether it's a string or not. Should we fix it here or should I report it as a new bug?

Screen.Recording.2023-10-18.at.11.35.57.mov

@marcaaron

marcaaron · 2023-10-18T21:29:06Z

Cool. This sounds like polish that the wave4 team should be made aware of cc @dylanexpensify

melvin-bot · 2023-10-18T21:29:47Z

@marcaaron looks like this was merged without a test passing. Please add a note explaining why this was done and remove the Emergency label if this is not an emergency.

marcaaron · 2023-10-18T21:34:49Z

All the tests passed. Sorry Melvin.

OSBotify · 2023-10-18T21:35:18Z

✋ 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-10-19T00:32:31Z

🚀 Deployed to staging by https://github.com/marcaaron in version: 1.3.87-0 🚀

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

OSBotify · 2023-10-19T00:58:12Z

🚀 Deployed to staging by https://github.com/marcaaron in version: 1.3.87-0 🚀

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

francoisl · 2023-10-20T02:35:46Z

Hi, the QA team reported here that this fix didn't work for them on Android, can someone double-check and confirm please?

situchan · 2023-10-20T03:24:55Z

Hi, the QA team reported here that this fix didn't work for them on Android, can someone double-check and confirm please?

That might be related to #29788 which is android specific bug

bernhardoj · 2023-10-20T04:15:35Z

Works fine for me. @situchan might be right.

OSBotify · 2023-10-20T21:07:16Z

🚀 Deployed to production by https://github.com/francoisl in version: 1.3.87-12 🚀

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

OSBotify · 2023-10-20T21:39:39Z

🚀 Deployed to staging by https://github.com/marcaaron in version: 1.3.88-0 🚀

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

OSBotify · 2023-10-23T04:51:51Z

🚀 Deployed to production by https://github.com/chiragsalian in version: 1.3.88-11 🚀

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

don't set auth token if it's a local file

d135d4b

bernhardoj requested a review from a team as a code owner October 17, 2023 05:34

melvin-bot bot requested review from ArekChr and removed request for a team October 17, 2023 05:34

ArekChr approved these changes Oct 17, 2023

View reviewed changes

melvin-bot bot requested a review from marcaaron October 17, 2023 10:05

paultsimura mentioned this pull request Oct 17, 2023

[$500] mWeb - IOU-Tapping download receipt opens file couldn't be accessed page #29749

Closed

6 tasks

bernhardoj added 2 commits October 18, 2023 11:19

Merge branch 'main' into fix/27992-receipt-image-fail-to-download

0f41871

check if it's string

ac5ad67

bernhardoj mentioned this pull request Oct 18, 2023

[HOLD for payment 2023-12-08] [$1000] IOU - Tapping download on manual money request receipt app crashes #29788

Closed

6 tasks

marcaaron approved these changes Oct 18, 2023

View reviewed changes

marcaaron merged commit 1d8b6e3 into Expensify:main Oct 18, 2023

melvin-bot bot added the Emergency label Oct 18, 2023

marcaaron removed the Emergency label Oct 18, 2023

OSBotify mentioned this pull request Oct 18, 2023

Deploy Checklist: New Expensify 2023-10-18 #29926

Closed

64 tasks

melvin-bot bot mentioned this pull request Oct 20, 2023

[HOLD for payment 2023-10-27] [$500] Android - Scan IOU - A broken image is downloaded to the device when receipt cannot be downloaded #27992

Closed

6 tasks

OSBotify mentioned this pull request Oct 20, 2023

Deploy Checklist: New Expensify 2023-10-20 #30108

Closed

Conversation

bernhardoj commented Oct 17, 2023

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

Uh oh!

melvin-bot bot commented Oct 17, 2023

Uh oh!

ArekChr commented Oct 17, 2023

Reviewer Checklist

Screenshots/Videos

Uh oh!

ArekChr left a comment

Choose a reason for hiding this comment

Uh oh!

marcaaron commented Oct 18, 2023

Uh oh!

bernhardoj commented Oct 18, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

marcaaron commented Oct 18, 2023

Uh oh!

melvin-bot bot commented Oct 18, 2023

Uh oh!

marcaaron commented Oct 18, 2023

Uh oh!

OSBotify commented Oct 18, 2023

Uh oh!

OSBotify commented Oct 19, 2023

Uh oh!

OSBotify commented Oct 19, 2023

Uh oh!

francoisl commented Oct 20, 2023

Uh oh!

situchan commented Oct 20, 2023

Uh oh!

bernhardoj commented Oct 20, 2023

Uh oh!

OSBotify commented Oct 20, 2023

Uh oh!

OSBotify commented Oct 20, 2023

Uh oh!

OSBotify commented Oct 23, 2023

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

bernhardoj commented Oct 18, 2023 •

edited

Loading