[CP Staging] Stop showing receipt images for cash requests #25800

marcaaron · 2023-08-23T21:10:07Z

Details

Figured out the root cause after discussing with @luacmartins and @mountiny

Fixed Issues

$ #25795

Tests

Log in to User A's account.
Open User B's chat.
Navigate to the "Request money" section.
Enter an amount and request it.
Click on the requested money for more details.
Click on the description and make edits.
Open another browser and log in with User B's account.
Open User A's chat and click on the requested money.
Verify the app does not crash
Verify there are no receipt image placeholder images for transactions that do not actually have receipts.

Verify that no errors appear in the JS console

Offline tests

❌

QA Steps

Same as tests

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

Web

Mobile Web - Chrome

Mobile Web - Safari

Desktop

iOS

Android

Android is still building... 🥲

melvin-bot · 2023-08-23T21:10:11Z

@Santhosh-Sellavel @aldo-expensify 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]

aldo-expensify · 2023-08-23T21:18:37Z

I think this ends up showing an empty box like this:

It may be better to return the generic receipt image if the filename is missing, so you get something like this:

    if (!filename) {
        return {thumbnail: null, image: ReceiptGeneric};
    }

aldo-expensify · 2023-08-23T21:21:03Z

(maybe we need to send it via Pusher?).

I think you are right about this. If you log out and log back in, the receipt thumbnail is not there at all

I think this shows that the data received through the pusher doesn't match the data we download when we login and open the report. The receipt is just an empty {}:

Having said that, no idea which one is wrong: the pusher data or the data we get in the response when we load the report

But this seems like a better solution than letting the app crash.

Agreed

aldo-expensify · 2023-08-23T21:23:04Z

src/libs/ReceiptUtils.js

+    // For things that don't actually have files we will show the generic receipt icon.
+    if (!filename) {
+        return {thumbnail: null, image: ReceiptGeneric};
+    }


I think this is better placed right after if (path.startsWith('blob:') || path.startsWith('file:')) {. So if the function is called with a path and no filename we still return return {thumbnail: null, image: path}; like we used to

luacmartins · 2023-08-23T21:23:13Z

We were sending this update via Pusher here, but now I see that's just completely gone on main 🤔

luacmartins · 2023-08-23T21:29:15Z

Gonna address that here

marcaaron · 2023-08-23T21:44:42Z

Updating the solution here to only return transactions that have receipt.receiptID. should also solve the issue.

luacmartins · 2023-08-23T21:45:05Z

src/libs/TransactionUtils.js

@@ -79,7 +79,7 @@ function buildOptimisticTransaction(
 * @returns {Boolean}
 */
 function hasReceipt(transaction) {
-    return !_.isEmpty(lodashGet(transaction, 'receipt'));
+    return Boolean(lodashGet(transaction, 'receipt.receiptID'));


We don't create receiptID optimistically, so this change would prevent images from showing before we get a receiptID back from the client

Can you respond to me here -> https://expensify.slack.com/archives/C057F53HR40/p1692826510517379?thread_ts=1692826029.393829&cid=C057F53HR40

…if a transaction has a receipt

luacmartins · 2023-08-23T21:55:27Z

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 / Chrome
- iOS / native
- iOS / 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

Mobile Web - Chrome

Mobile Web - Safari

Desktop

iOS

Android

aldo-expensify

I don't think this enough, the receipt object does have a source and the crash is still happening:

aldo-expensify · 2023-08-23T22:01:21Z

src/libs/TransactionUtils.js

@@ -79,7 +79,7 @@ function buildOptimisticTransaction(
 * @returns {Boolean}
 */
 function hasReceipt(transaction) {
-    return !_.isEmpty(lodashGet(transaction, 'receipt'));
+    return Boolean(lodashGet(transaction, 'receipt.source'));


Suggested change

return Boolean(lodashGet(transaction, 'receipt.source'));

const source = lodashGet(transaction, 'receipt.source');

return source.startsWith('blob:') || source.startsWith('file:') || Boolean(lodashGet(transaction, 'receipt.filename'));

Something like that? the invalid receipt has a source "https://staging.expensify.com/receipts/", so this function is still return true when it shouldn't

src/libs/TransactionUtils.js

marcaaron · 2023-08-23T22:48:32Z

Using the state solution now

aldo-expensify

Tested well for me!

mountiny

Thanks for the fix ❤️ 🙇

marcaaron · 2023-08-23T23:02:04Z

FWIW while testing mobile web i spotted some weird behavior related to the display names. Not sure if it is on staging yet - but seems unrelated to this PR:

mountiny · 2023-08-23T23:03:16Z

I think thats unrelated but worth posting in bugs I guess

Going to merge now since Carlos approved before already

OSBotify · 2023-08-23T23:08:17Z

✋ This PR was not deployed to staging yet because QA is ongoing. It will be automatically deployed to staging after the next production release.

[CP Staging] Stop showing receipt images for cash requests (cherry picked from commit f0eeac6)

marcaaron · 2023-08-23T23:46:45Z

I think thats unrelated but worth posting in bugs I guess

Yes unrelated to this change - but related to the flow since editing the transaction is what triggers it so maybe you are interested.

Broken on dev only AFAICT. Does not appear to be on staging yet so not a deploy blocker. Thanks!!!!

mountiny · 2023-08-23T23:51:42Z

@marcaaron do you have reproduction steps for that screenshot there? Will be helpful 🙇

OSBotify · 2023-08-23T23:56:15Z

🚀 Deployed to staging by https://github.com/mountiny in version: 1.3.56-22 🚀

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

OSBotify · 2023-08-24T03:04:38Z

🚀 Deployed to production by https://github.com/roryabraham in version: 1.3.56-24 🚀

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

OSBotify · 2023-08-28T18:51:29Z

🚀 Deployed to staging by https://github.com/mountiny in version: 1.3.58-0 🚀

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

OSBotify · 2023-08-30T01:20:32Z

🚀 Deployed to production by https://github.com/luacmartins in version: 1.3.58-5 🚀

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

Provide safer access for filename param if it happens to be missing

941afad

marcaaron requested review from Li357 and luacmartins August 23, 2023 21:10

marcaaron self-assigned this Aug 23, 2023

marcaaron requested a review from a team as a code owner August 23, 2023 21:10

melvin-bot bot requested review from aldo-expensify and removed request for a team August 23, 2023 21:10

melvin-bot bot requested a review from Santhosh-Sellavel August 23, 2023 21:10

marcaaron removed the request for review from Santhosh-Sellavel August 23, 2023 21:11

Show generic receipt image when there is no receipt

27cdd58

aldo-expensify reviewed Aug 23, 2023

View reviewed changes

Only show receipt images for receipts that have receiptID

5486831

marcaaron changed the title ~~[CP Staging] Provide safer access for filename param if it happens to be missing~~ [CP Staging] Stop showing receipt images for cash requests Aug 23, 2023

marcaaron removed the request for review from Li357 August 23, 2023 21:43

luacmartins requested changes Aug 23, 2023

View reviewed changes

All receipts will have a source property so we will use this to tell …

12890a9

…if a transaction has a receipt

luacmartins previously approved these changes Aug 23, 2023

View reviewed changes

aldo-expensify requested changes Aug 23, 2023

View reviewed changes

aldo-expensify reviewed Aug 23, 2023

View reviewed changes

mountiny requested changes Aug 23, 2023

View reviewed changes

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

use state

a5c4dea

marcaaron dismissed luacmartins’s stale review via a5c4dea August 23, 2023 22:43

aldo-expensify approved these changes Aug 23, 2023

View reviewed changes

mountiny approved these changes Aug 23, 2023

View reviewed changes

mountiny merged commit f0eeac6 into main Aug 23, 2023
14 checks passed

mountiny deleted the marcaaron-fixFilenameBug branch August 23, 2023 23:03

OSBotify pushed a commit that referenced this pull request Aug 23, 2023

Merge pull request #25800 from Expensify/marcaaron-fixFilenameBug

1670d56

[CP Staging] Stop showing receipt images for cash requests (cherry picked from commit f0eeac6)

roryabraham mentioned this pull request Aug 23, 2023

Deploy Checklist: New Expensify 2023-08-21 #25625

Closed

OSBotify mentioned this pull request Aug 28, 2023

Deploy Checklist: New Expensify 2023-08-28 #26113

Closed

melvin-bot bot mentioned this pull request Aug 28, 2023

[$500] [HOLD for payment 2023-09-04] App crashes when reciever clicking on an edited money request #25795

Closed

6 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[CP Staging] Stop showing receipt images for cash requests #25800

[CP Staging] Stop showing receipt images for cash requests #25800

marcaaron commented Aug 23, 2023 •

edited

Loading

melvin-bot bot commented Aug 23, 2023

aldo-expensify commented Aug 23, 2023

aldo-expensify commented Aug 23, 2023 •

edited

Loading

aldo-expensify Aug 23, 2023 •

edited

Loading

luacmartins commented Aug 23, 2023

luacmartins commented Aug 23, 2023

marcaaron commented Aug 23, 2023

luacmartins Aug 23, 2023 •

edited

Loading

marcaaron Aug 23, 2023

luacmartins commented Aug 23, 2023 •

edited

Loading

aldo-expensify left a comment

aldo-expensify Aug 23, 2023 •

edited

Loading

marcaaron commented Aug 23, 2023

aldo-expensify left a comment

mountiny left a comment

marcaaron commented Aug 23, 2023

mountiny commented Aug 23, 2023

OSBotify commented Aug 23, 2023

marcaaron commented Aug 23, 2023

mountiny commented Aug 23, 2023

OSBotify commented Aug 23, 2023

OSBotify commented Aug 24, 2023

OSBotify commented Aug 28, 2023

OSBotify commented Aug 30, 2023

	return Boolean(lodashGet(transaction, 'receipt.source'));
	const source = lodashGet(transaction, 'receipt.source');
	return source.startsWith('blob:') \|\| source.startsWith('file:') \|\| Boolean(lodashGet(transaction, 'receipt.filename'));

[CP Staging] Stop showing receipt images for cash requests #25800

[CP Staging] Stop showing receipt images for cash requests #25800

Conversation

marcaaron commented Aug 23, 2023 • edited Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

melvin-bot bot commented Aug 23, 2023

aldo-expensify commented Aug 23, 2023

aldo-expensify commented Aug 23, 2023 • edited Loading

aldo-expensify Aug 23, 2023 • edited Loading

Choose a reason for hiding this comment

luacmartins commented Aug 23, 2023

luacmartins commented Aug 23, 2023

marcaaron commented Aug 23, 2023

luacmartins Aug 23, 2023 • edited Loading

Choose a reason for hiding this comment

marcaaron Aug 23, 2023

Choose a reason for hiding this comment

luacmartins commented Aug 23, 2023 • edited Loading

Reviewer Checklist

Screenshots/Videos

aldo-expensify left a comment

Choose a reason for hiding this comment

aldo-expensify Aug 23, 2023 • edited Loading

Choose a reason for hiding this comment

marcaaron commented Aug 23, 2023

aldo-expensify left a comment

Choose a reason for hiding this comment

mountiny left a comment

Choose a reason for hiding this comment

marcaaron commented Aug 23, 2023

mountiny commented Aug 23, 2023

OSBotify commented Aug 23, 2023

marcaaron commented Aug 23, 2023

mountiny commented Aug 23, 2023

OSBotify commented Aug 23, 2023

OSBotify commented Aug 24, 2023

OSBotify commented Aug 28, 2023

OSBotify commented Aug 30, 2023

marcaaron commented Aug 23, 2023 •

edited

Loading

aldo-expensify commented Aug 23, 2023 •

edited

Loading

aldo-expensify Aug 23, 2023 •

edited

Loading

luacmartins Aug 23, 2023 •

edited

Loading

luacmartins commented Aug 23, 2023 •

edited

Loading

aldo-expensify Aug 23, 2023 •

edited

Loading