Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve eReceipt visually in New Dot #55803

Open
wants to merge 46 commits into
base: main
Choose a base branch
from

Conversation

mkzie2
Copy link
Contributor

@mkzie2 mkzie2 commented Jan 27, 2025

Explanation of Change

Improve eReceipt visually in New Dot

Fixed Issues

$ #55083
PROPOSAL: #55083 (comment)

Tests

  1. Create card transaction
  2. If we don't have card transactions, go to the transaction detail and add this command to the console (replace the ID after _ with the transactionID that we're viewing)
Onyx.merge(`transactions_8073227627479073933`, {
    amount: 1000,
    currency: 'USD',
    cardID: 4,
    merchant: 'United Airlines',
    mccGroup: 'Airlines',
    created: '2023-07-24 13:46:20',
    hasEReceipt: true,
});

or add this useEffect to MoneyRequestView

useEffect(() => {
    Onyx.merge(`transactions_${linkedTransactionID}`, {
        amount: 1000,
        currency: 'USD',
        cardID: 4,
        merchant: 'United Airlines',
        mccGroup: 'Goods',
        created: '2023-07-24 13:46:20',
        hasEReceipt: true,
    });
    
});
  1. Notice the EReceipt preview and EReceipt detail
  2. Verify that the UI is correct with the description here
  • Verify that no errors appear in the JS console

Offline tests

Same

QA Steps

  1. Create card transaction
  2. If we don't have card transactions, go to the transaction detail and add this command to the console
Onyx.merge(`transactions_8073227627479073933`, {
    amount: 1000,
    currency: 'USD',
    cardID: 4,
    merchant: 'United Airlines',
    mccGroup: 'Airlines',
    created: '2023-07-24 13:46:20',
    hasEReceipt: true,
});

or add this useEffect to MoneyRequestView

useEffect(() => {
    Onyx.merge(`transactions_${linkedTransactionID}`, {
        amount: 1000,
        currency: 'USD',
        cardID: 4,
        merchant: 'United Airlines',
        mccGroup: 'Goods',
        created: '2023-07-24 13:46:20',
        hasEReceipt: true,
    });
    
});
  1. Notice the EReceipt preview and EReceipt detail
  2. Verify that the UI is correct with the description here
  • 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 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 used JaimeGPT to get English > Spanish translation. I then posted it 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.ts 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.
  • I added unit tests for any new feature or bug fix in this PR to help automatically prevent regressions in this user flow.
  • 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
Screen.Recording.2025-02-03.at.16.17.38.mov
Android: mWeb Chrome
Screen.Recording.2025-02-03.at.15.08.30.mov
iOS: Native
Screen.Recording.2025-02-03.at.16.23.20.mov
iOS: mWeb Safari
Screen.Recording.2025-02-03.at.15.10.11.mov
MacOS: Chrome / Safari
Screen.Recording.2025-02-03.at.15.04.40.mov
MacOS: Desktop
Screen.Recording.2025-02-03.at.16.26.39.mov

@mkzie2 mkzie2 marked this pull request as ready for review February 3, 2025 09:47
@mkzie2 mkzie2 requested review from a team as code owners February 3, 2025 09:47
@melvin-bot melvin-bot bot requested review from ishpaul777 and shawnborton and removed request for a team February 3, 2025 09:47
Copy link

melvin-bot bot commented Feb 3, 2025

@shawnborton @ishpaul777 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]

@shawnborton
Copy link
Contributor

It seems like the spacing is quite off from our mockups. Here is what I see in your videos:
CleanShot 2025-02-03 at 12 12 47@2x

Yet here is our Figma file:
CleanShot 2025-02-03 at 12 14 49@2x

Can you update and then we can review again from there?

@ishpaul777
Copy link
Contributor

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 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.ts 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.
  • For any bug fix or new feature in this PR, I verified that sufficient unit tests are included to prevent regressions in this flow.
  • 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
iOS: Native
iOS: mWeb Safari
MacOS: Chrome / Safari
MacOS: Desktop

@ishpaul777
Copy link
Contributor

ishpaul777 commented Feb 3, 2025

@mkzie2 can you please provide steps to add a card transaction (maybe we need to mock it? if yes please provide code to execute to have the mocked transaction) Thank you!

@dannymcclain
Copy link
Contributor

Aside from @shawnborton's comments, why does the receipt change colors between the preview and full receipt? I would assume it would stay the same between those views.

@mkzie2
Copy link
Contributor Author

mkzie2 commented Feb 4, 2025

Aside from @shawnborton's comments, why does the receipt change colors between the preview and full receipt? I would assume it would stay the same between those views.

No problem, this is because I hard-coded it to display the receipt.

@mkzie2
Copy link
Contributor Author

mkzie2 commented Feb 4, 2025

@shawnborton, I updated it to match the Figma. Please help to check again.

Screenshot 2025-02-04 at 12 49 45

@mkzie2
Copy link
Contributor Author

mkzie2 commented Feb 4, 2025

can you please provide steps to add a card transaction (maybe we need to mock it? if yes please provide code to execute to have the mocked transaction) Thank you!

@ishpaul777 Updated the test step.

@ishpaul777
Copy link
Contributor

ishpaul777 commented Feb 4, 2025

e-reciept distance receipt
Screenshot 2025-02-04 at 5 33 19 PM Screenshot 2025-02-04 at 5 33 50 PM

dont we want make distance e-receipt to follow similar design @Expensify/design @mkzie2

@shawnborton
Copy link
Contributor

I think we should leave the map receipts alone for now. We can follow up later and change them a bit to match these new eReceipts, but I say we tackle eReceipts first so that we don't have too much scope creep in this particular issue.

@shawnborton
Copy link
Contributor

It looks like the spacing is still off a bit. For example the content below the amount is too far to the left, we don't have enough inner padding. Please refer to the Figma file, but see this image as well:

image

Copy link
Contributor

🚧 @shawnborton has triggered a test hybrid app build. You can view the workflow run here.

Copy link
Contributor

@shawnborton
Copy link
Contributor

Hmm that's an improvement but it's still not technically working exactly as I was showing above. It's not truly scaling at it's exact proportions depending on the outer container width. What can we do about that?

Also, on the reports page, most of the eReceipts are yellow and don't have an icon:

CleanShot.2025-02-26.at.15.07.29.mp4

What's going on there? Because then when I open up the receipt, it shows the icon and it's even a different color.

@mkzie2
Copy link
Contributor Author

mkzie2 commented Feb 27, 2025

Hmm that's an improvement but it's still not technically working exactly as I was showing above. It's not truly scaling at it's exact proportions depending on the outer container width. What can we do about that?

Currently, if the width is larger than 335, I only expand the background and the receipt body and the scale is 1. Otherwise, it's scaled based on the outer width.

What's going on there? Because then when I open up the receipt, it shows the icon and it's even a different color.

@shawnborton Can you export the Onyx state and give me here so it's easy to debug this one. Thanks.

@shawnborton
Copy link
Contributor

I only expand the background and the receipt body and the scale is 1. Otherwise, it's scaled based on the outer width.

Can you get it working exactly like I am showing in my video above? We want to make sure that no matter where we place the eReceipt, it's going to scale perfectly to it's outer parent container. Let me know if that makes sense.

@mkzie2
Copy link
Contributor Author

mkzie2 commented Mar 3, 2025

Can you get it working exactly like I am showing in my video above? We want to make sure that no matter where we place the eReceipt, it's going to scale perfectly to it's outer parent container

@shawnborton I need to confirm, what it looks like if the outer parent container width is> 335px? I saw in the video above that the width starts at 335px. On the large screen, the max width of the receipt preview in MoneyRequestView is 400px. And also, please help to share what is the problem with my EReceipt implementation. It will help me to fix it easier.

We want to make sure that no matter where we place the eReceipt, it's going to scale perfectly to it's outer parent container. Let me know if that makes sense.

Let me investigate.

@ishpaul777
Copy link
Contributor

@mkzie2 Whats the latest here? Any updates

@mkzie2
Copy link
Contributor Author

mkzie2 commented Mar 5, 2025

@ishpaul777 I updated with the EReceiptWithSizeCalculation that will auto-scale the receipt preview every where we used this component. And I'm waiting the response from @shawnborton here to improve the EReceipt UI if need.

@shawnborton
Copy link
Contributor

On the large screen, the max width of the receipt preview in MoneyRequestView is 400px. And also, please help to share what is the problem with my EReceipt implementation. It will help me to fix it easier.

The idea is that the original source eReceipt is 335px wide by 540px tall. Everything we do to scale either up or down would start from that point:
CleanShot 2025-03-05 at 09 20 50@2x

Again, the idea being to treat this just like we would treat a flat image receipt. Let me know if that clears things up. And let me know if I should run another test build, or if you have more changes you want to commit first. Thanks!

@grgia
Copy link
Contributor

grgia commented Mar 5, 2025

@ishpaul777 @mkzie2

Can we generate eReceipt image for card transaction in back-end? Is this is a possible idea?
maybe it would be possible to create a image link to receipt and push it from Backend like we do for per-diem receipt

For per-diem are we generating an image from html? Does the data change the process? I'm not familiar with this flow. If it's a similar process we can likely duplicate it for eReceipts.

@grgia
Copy link
Contributor

grgia commented Mar 5, 2025

I looked into it, we can potentially do what we do for per-diem or travel receipts and generate html receipts from the BE. Is this what you had in mind @shawnborton?

I can't say it's worth the BE work to add if it's just for the report previews though. WDYT?

@shawnborton
Copy link
Contributor

I don't know that it needs to be generated by the backend... I mostly just want to make sure that we can use consistent scaling of the eReceipt the same way we would scale a flat png receipt image. Does that make sense? However we want to accomplish that doesn't matter to me too much.

@ishpaul777
Copy link
Contributor

Hm even if can create Receipt Image on Backend we need placeholder for receipt until it is the Backend process, currently perdiem receipt use the existing Erecipt component, I suggest we stick with frontend unless it's not feasible to maintain the component, I have good feeling about the scaling of receipt logic @mkzie2 pushed with last commits (still need to test it properly)

@shawnborton
Copy link
Contributor

Okay, going to run another test build then and see how it feels.

Copy link
Contributor

github-actions bot commented Mar 7, 2025

🚧 @shawnborton has triggered a test app build. You can view the workflow run here.

Copy link
Contributor

github-actions bot commented Mar 7, 2025

@shawnborton
Copy link
Contributor

Almost all eReceipts show up as yellow from the Reports page:
CleanShot 2025-03-07 at 09 02 38@2x

But then they are a different color once you open them:
CleanShot 2025-03-07 at 09 03 06@2x

We need to make it so that the same exact receipt image is used everywhere.

@shawnborton
Copy link
Contributor

On the reports page, the icon doesn't show within the colored wrapper here:
CleanShot 2025-03-07 at 09 03 43@2x

@shawnborton
Copy link
Contributor

Interesting, once I loaded a few receipts by opening them in the RHP, the thumbnails seem to work now:
CleanShot 2025-03-07 at 09 04 18@2x

@shawnborton
Copy link
Contributor

Looks like we get some weirdness when there are two lines of text for the merchant:
CleanShot 2025-03-07 at 09 05 42@2x

What we do in Figma is this:
CleanShot 2025-03-07 at 09 06 46@2x

CleanShot 2025-03-07 at 09 06 35@2x

@shawnborton
Copy link
Contributor

So it doesn't actually look like the receipt is properly scaling as I have mentioned many times now already. For example, if we make a much wider wrapper on the expense view, notice that the receipt doesn't actually scale? It just gets wider:
CleanShot 2025-03-07 at 09 13 55@2x

@dannymcclain
Copy link
Contributor

Great catches Shawn—agree with all your feedback. This one is a beast.

@ishpaul777
Copy link
Contributor

ishpaul777 commented Mar 7, 2025

Almost all eReceipts show up as yellow from the Reports page: CleanShot 2025-03-07 at 09 02 38@2x

But then they are a different color once you open them: CleanShot 2025-03-07 at 09 03 06@2x

We need to make it so that the same exact receipt image is used everywhere.

This has come up a few times now @mkzie2 can you please add explaination whats the problem and fix this at root

@mkzie2
Copy link
Contributor Author

mkzie2 commented Mar 8, 2025

So it doesn't actually look like the receipt is properly scaling as I have mentioned many times now already. For example, if we make a much wider wrapper on the expense view, notice that the receipt doesn't actually scale? It just gets wider:

@shawnborton For this problem, I got a fix here, please check my video.

Screen.Recording.2025-03-08.at.16.37.44.mp4

Looks like we get some weirdness when there are two lines of text for the merchant:

Fixed now.

Screen.Recording.2025-03-08.at.16.57.11.mov

Almost all eReceipts show up as yellow from the Reports page:

Can you get this to happen and export the Onyx data for me, it's helpful for me to debug what is the current problem with the real data.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants