Show eReceipts for distance requests #27204

neil-marcellini · 2023-09-11T22:49:42Z

Details

When a distance request receipt image is clicked from the transaction report the attachment modal is opened. For distance requests an eReceipt is displayed instead of the full size image of the route. The amount, merchant, waypoints list, and created date are shown.

For now, the download button will only download the route image. In the future maybe we can download the entire eReceipt view.

Fixed Issues

$ #27050
$ #28289
$ #28949
PROPOSAL: N/A

Tests

Distance request with 2 waypoints

Click the green plus, request money, distance
Enter valid start and finish locations
Create the request
Open the money request report
Click on the distance request to open the transaction report
Click on the route image
Verify that the distance eReceipt is shown and looks good

Distance request with 12 waypoints

Click the green plus, request money, distance
Enter valid start and finish locations, plus 10 stops
Create the request
Open the money request report
Click on the distance request to open the transaction report
Click on the route image
Verify that the distance eReceipt is shown and looks good
Verify that you can scroll down to see the entire eReceipt

Also run the "action performed" from the 2nd and 3rd linked issues.

Verify that no errors appear in the JS console

Offline tests

Run the same tests while offline and verify you see TBD for some values
Go back online
Verify that the value fill in

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

web.mov

Mobile Web - Chrome

androidChrome.mov

androidChromeFilled.mov

Mobile Web - Safari

Safari.mp4

Desktop

desktop1080.mov

iOS

https://drive.google.com/file/d/1-9bGeQcr-sFNX_8Q5wII57MUXeT3Jzg-/view?usp=sharing

Android

https://drive.google.com/file/d/10utdOdYCBTRV_tkUkHA6cB_tJxuyt7Q6/view?usp=sharing

neil-marcellini · 2023-09-22T08:42:31Z

Here's what I have so far. It doesn't match the mock exactly but it's pretty close. May I please have an initial design review? I still need to test the receipt with many waypoints (15) and get the PR ready for final review.

Screen.Recording.2023-09-22.at.4.39.31.PM.mov

shawnborton · 2023-09-25T03:34:59Z

This feels pretty good to me, cc @Expensify/design

The only major thing I am seeing is, should we vertically center the receipt in the available area when you view it?

We might want to coordinate with @georgia too on how this code overlaps with eReceipts for cards.

src/styles/themes/default.js

grgia · 2023-10-12T15:18:43Z

src/components/Attachments/AttachmentCarousel/CarouselItem.js

+
+ /** The id of the transaction related to the attachment */
+ transactionID: PropTypes.string,


Where is this being passed in? (Trying to understand patterns for ECard transactions eReceipts).

I'm having trouble finding where the URL is coming from, do you save it to the receipt key in the transaction object in the BE?

The AttachmentCarousel renders items here

App/src/components/Attachments/AttachmentCarousel/index.js

Lines 145 to 148 in 04e3eb1

const renderItem = useCallback(

({item}) => (

<CarouselItem

item={item}

renderItem is passed data from attachments

App/src/components/Attachments/AttachmentCarousel/index.js

Lines 204 to 206 in 04e3eb1

data={attachments}

CellRendererComponent={AttachmentCarouselCellRenderer}

renderItem={renderItem}

attachments are set up here

App/src/components/Attachments/AttachmentCarousel/index.js

Line 54 in 04e3eb1

const attachmentsFromReport = extractAttachmentsFromReport(report, reportActions);

Here's where the transactionID is set

App/src/components/Attachments/AttachmentCarousel/extractAttachmentsFromReport.js

Line 62 in 61920ff

transactionID,

I'm having trouble finding where the URL is coming from, do you save it to the receipt key in the transaction object in the BE?

Yeah it's from transaction.filename here

App/src/components/DistanceEReceipt.js

Line 34 in 8dedc7a

const {thumbnail} = TransactionUtils.hasReceipt(transaction) ? ReceiptUtils.getThumbnailAndImageURIs(transaction.receipt.source, transaction.filename) : {};

Thank you! This was super helpful

neil-marcellini · 2023-10-12T18:15:58Z

Hey @mollfpr, I had to request a new C+ in Slack here because it has been too long since the last review. Thanks for your work so far. Please try to review daily or let me know if you can not.

mananjadhav · 2023-10-12T18:22:02Z

Reviewing the PR and the previous conversations. Thanks for resolving the conflicts @neil-marcellini.

src/languages/en.ts

src/languages/es.ts

mananjadhav

Code change looks fine except for one minor object I added.

melvin-bot · 2023-10-12T19:39:09Z

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

mananjadhav · 2023-10-12T20:16:08Z

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-offline-distance-card.mov

web-distance-card-2.mov

Mobile Web - Chrome

mweb-chrome-distance-card.mov

Mobile Web - Safari

mweb-safari-distance-card.mov

Desktop

desktop-distance-carc.mov

iOS

ios-distance-card.mov

Android

android-distance-card.mov

mananjadhav · 2023-10-12T20:55:26Z

@neil-marcellini All done from my side.

@Li357 @grgia All yours.

🎀 👀 🎀 C+ reviewed.

OSBotify · 2023-10-13T09:17:52Z

✋ 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-13T21:11:13Z

🚀 Deployed to staging by https://github.com/grgia in version: 1.3.84-0 🚀

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

OSBotify · 2023-10-16T21:11:41Z

🚀 Deployed to production by https://github.com/francoisl in version: 1.3.84-10 🚀

platform	result
🤖 android 🤖	skipped 🚫
🖥 desktop 🖥	skipped 🚫
🍎 iOS 🍎	skipped 🚫
🕸 web 🕸	skipped 🚫

OSBotify · 2023-10-16T21:48:01Z

🚀 Deployed to production by https://github.com/francoisl in version: 1.3.84-10 🚀

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

OSBotify · 2023-10-16T21:50:57Z

🚀 Deployed to staging by https://github.com/grgia in version: 1.3.85-0 🚀

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

OSBotify · 2023-10-17T23:15:42Z

🚀 Deployed to production by https://github.com/francoisl in version: 1.3.85-4 🚀

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

rushatgabhane · 2023-11-06T11:31:21Z

src/components/DistanceEReceipt.js

+ <PendingMapView />
+ ) : (
+ <ThumbnailImage
+ previewSourceURL={thumbnailSource}


Hi, we had a bug here - App crashes when tapping on the receipt thumbnail while receipt is generating

On native, the pending attachment uses a static image, and it has the source: 1 (that's a standard RN, see this), which is not a string so it breaks the Str.isPDF() and Str.isImage() checks.

More details: #28814

fedirjh · 2023-11-15T18:03:23Z

src/styles/styles.js

+ eReceiptAmount: {
+ ...headlineFont,
+ fontSize: variables.fontSizeXXXLarge,
+ lineHeight: variables.lineHeightXXXLarge,


This line caused an edge case regression in #29616; when device font size is set to the minimum, the amount in the e-receipt is cut off.

WIP render an eReceipt for distance requests

fabe55f

neil-marcellini self-assigned this Sep 11, 2023

neil-marcellini added 20 commits September 11, 2023 16:26

Render the receipt image

a6b83fe

Style and clean up

9d7538c

Merge branch 'main' into neil-distance-receipts

bffd20b

Add amount and thumbnail image

71689bd

Add merchant

8095338

Display waypoints

d9ddb6f

Remove unused import

71ff545

Style e receipt merchant text

215c03e

Style eReceipt waypoint titles

90ad229

Style eReceipt waypoint address

c1aa7b3

Add date text

5bb7b9e

WIP add logo

dd0fe7e

Add logo and guaranteed eReceipt

f69bf99

Set up wrapping views with padding

3a67ed4

Fix lint issues / clean up

74664ce

Add the eReceipt background

6e1440e

The eReceipt is specific to distance requests

f8ef144

Set up gap between main sections

ab4db97

Spacing and layout within sections

0954367

Set width on eReceipt for large screens

8b8afe9

neil-marcellini mentioned this pull request Sep 22, 2023

[HOLD for payment 2023-10-23] 🟡 [$500] Add stylized receipts for distance requests #27050

Closed

shawnborton reviewed Sep 25, 2023

View reviewed changes

src/styles/themes/default.js Outdated Show resolved Hide resolved

shawnborton reviewed Sep 25, 2023

View reviewed changes

src/styles/themes/default.js Outdated Show resolved Hide resolved

neil-marcellini added 3 commits September 25, 2023 15:41

Center eReceipt vertically on page

8c28a58

Use colors directly since it's a specific purpose

3382e90

Fix missing colors import

16f3d79

Merge branch 'main' into neil-distance-receipts

4d49405

grgia reviewed Oct 12, 2023

View reviewed changes

Merge branch 'main' into neil-distance-receipts

8dedc7a

neil-marcellini requested a review from mananjadhav October 12, 2023 18:14

mananjadhav reviewed Oct 12, 2023

View reviewed changes

src/languages/en.ts Show resolved Hide resolved

mananjadhav reviewed Oct 12, 2023

View reviewed changes

src/languages/es.ts Show resolved Hide resolved

mananjadhav approved these changes Oct 12, 2023

View reviewed changes

melvin-bot bot requested a review from Li357 October 12, 2023 19:39

Fix duplicate translation key after merge

4e23ab4

grgia approved these changes Oct 13, 2023

View reviewed changes

grgia merged commit 873a250 into main Oct 13, 2023
16 checks passed

grgia deleted the neil-distance-receipts branch October 13, 2023 09:12

paultsimura mentioned this pull request Oct 13, 2023

[HOLD for payment 2023-10-30] [$500] IOU - "TBD" is missing in the IOU details of the "Amount" field in offline mode #29553

Closed

6 tasks

OSBotify mentioned this pull request Oct 13, 2023

Deploy Checklist: New Expensify 2023-10-13 #29585

Closed

97 tasks

lanitochka17 mentioned this pull request Oct 14, 2023

[HOLD for payment 2023-10-30] [$250] Distance - Waypoints are not correctly ordered in generated eReceipt #29621

Closed

7 tasks

OSBotify mentioned this pull request Oct 16, 2023

Deploy Checklist: New Expensify 2023-10-16 #29717

Closed

rushatgabhane reviewed Nov 6, 2023

View reviewed changes

fedirjh reviewed Nov 15, 2023

View reviewed changes

fedirjh mentioned this pull request Nov 15, 2023

[HOLD for payment 2023-11-13] [$125] Android - Distance - Amount in the Distance e-receipt is cut off when device font size is minimum #29616

Closed

6 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Show eReceipts for distance requests #27204

Show eReceipts for distance requests #27204

neil-marcellini commented Sep 11, 2023 •

edited

Loading

neil-marcellini commented Sep 22, 2023 •

edited

Loading

shawnborton commented Sep 25, 2023

grgia Oct 12, 2023

neil-marcellini Oct 12, 2023

grgia Oct 13, 2023

neil-marcellini commented Oct 12, 2023 •

edited

Loading

mananjadhav commented Oct 12, 2023

mananjadhav left a comment

melvin-bot bot commented Oct 12, 2023

mananjadhav commented Oct 12, 2023 •

edited

Loading

mananjadhav commented Oct 12, 2023 •

edited

Loading

OSBotify commented Oct 13, 2023

OSBotify commented Oct 13, 2023

OSBotify commented Oct 16, 2023

OSBotify commented Oct 16, 2023

OSBotify commented Oct 16, 2023

OSBotify commented Oct 17, 2023

rushatgabhane Nov 6, 2023

fedirjh Nov 15, 2023


		/** The id of the transaction related to the attachment */
		transactionID: PropTypes.string,

	const renderItem = useCallback(
	({item}) => (
	<CarouselItem
	item={item}

	data={attachments}
	CellRendererComponent={AttachmentCarouselCellRenderer}
	renderItem={renderItem}

Show eReceipts for distance requests #27204

Show eReceipts for distance requests #27204

Conversation

neil-marcellini commented Sep 11, 2023 • edited Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

neil-marcellini commented Sep 22, 2023 • edited Loading

shawnborton commented Sep 25, 2023

grgia Oct 12, 2023

Choose a reason for hiding this comment

neil-marcellini Oct 12, 2023

Choose a reason for hiding this comment

grgia Oct 13, 2023

Choose a reason for hiding this comment

neil-marcellini commented Oct 12, 2023 • edited Loading

mananjadhav commented Oct 12, 2023

mananjadhav left a comment

Choose a reason for hiding this comment

melvin-bot bot commented Oct 12, 2023

mananjadhav commented Oct 12, 2023 • edited Loading

Reviewer Checklist

Screenshots/Videos

mananjadhav commented Oct 12, 2023 • edited Loading

OSBotify commented Oct 13, 2023

OSBotify commented Oct 13, 2023

OSBotify commented Oct 16, 2023

OSBotify commented Oct 16, 2023

OSBotify commented Oct 16, 2023

OSBotify commented Oct 17, 2023

rushatgabhane Nov 6, 2023

Choose a reason for hiding this comment

fedirjh Nov 15, 2023

Choose a reason for hiding this comment

neil-marcellini commented Sep 11, 2023 •

edited

Loading

neil-marcellini commented Sep 22, 2023 •

edited

Loading

neil-marcellini commented Oct 12, 2023 •

edited

Loading

mananjadhav commented Oct 12, 2023 •

edited

Loading

mananjadhav commented Oct 12, 2023 •

edited

Loading