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

Feat: Add placeholder thumbnail to expenses with no receipt #52848

Merged
merged 12 commits into from
Dec 3, 2024

Conversation

gijoe0295
Copy link
Contributor

@gijoe0295 gijoe0295 commented Nov 20, 2024

Explanation of Change

  • Add empty receipt placeholders to expense/report previews without receipts
  • Update the Add receipt placeholder icon

image

image

Fixed Issues

$ #52638
PROPOSAL: #52638 (comment)

Tests

  1. Create several expenses with and without receipts to a workspace
  2. Verify the report preview shows empty receipt placeholders and receipt thumbnails in the order of the created expenses
  3. Verify the figure in the corner shows the number of remaining expenses in the expense report (total expenses - 3 thumbnails)
  4. Tap the report preview to open expense report
  5. Verify expenses without receipt shows empty receipt placeholders
  6. Tap the expense preview without receipt to open transaction details report
  7. Verify Add receipt placeholder shows with a green plus icon
  8. Tap the receipt placeholder
  9. Verify app opens Upload receipt page
  10. Tap FAB > Submit expense > Manual
  11. Create an expense
  12. In confirmation step, verify the Add receipt placeholder shows with a green plus icon
  • Verify that no errors appear in the JS console

Offline tests

QA Steps

  1. Submit 2 manual expenses (without receipts) and 2 scan expenses (with receipt) to a workspace respectively
  2. Verify the report preview shows 2 empty receipt placeholders and 2 receipt thumbnails respectively
  3. Verify the figure in the corner shows the number of remaining expenses in the expense report (+1 in this case)
  4. Tap the report preview to open expense report
  5. Verify expenses without receipt shows empty receipt placeholders
  6. Tap the expense preview without receipt to open transaction details report
  7. Verify Add receipt placeholder shows with a green plus icon
  8. Tap the receipt placeholder
  9. Verify app opens Upload receipt page
  10. Tap FAB > Submit expense > Manual
  11. Create an expense
  12. In confirmation step, verify the Add receipt placeholder shows with a green plus icon
  • 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 verified the translation was requested/reviewed in #expensify-open-source and it was approved by an internal Expensify engineer. Link to Slack message:
    • I verified all numbers, amounts, dates and phone numbers shown in the product are using the localization methods
    • I verified any copy / text that was added to the app is grammatically correct in English. It adheres to proper capitalization guidelines (note: only the first word of header/labels should be capitalized), and is either coming verbatim from figma or has been approved by marketing (in order to get marketing approval, ask the Bug Zero team member to add the Waiting for copy label to the issue)
    • I verified proper file naming conventions were followed for any new files or renamed files. All non-platform specific files are named after what they export and are not named "index.js". All platform-specific files are named for the platform the code supports as outlined in the README.
    • I verified the JSDocs style guidelines (in STYLE.md) were followed
  • If a new code pattern is added I verified it was agreed to be used by multiple Expensify engineers
  • I followed the guidelines as stated in the Review Guidelines
  • I tested other components that can be impacted by my changes (i.e. if the PR modifies a shared library or component like Avatar, I verified the components using Avatar are working as expected)
  • I verified all code is DRY (the PR doesn't include any logic written more than once, with the exception of tests)
  • I verified any variables that can be defined as constants (ie. in CONST.js or at the top of the file that uses the constant) are defined as such
  • I verified that if a function's arguments changed that all usages have also been updated correctly
  • If any new file was added I verified that:
    • The file has a description of what it does and/or why is needed at the top of the file if the code is not self explanatory
  • If a new CSS style is added I verified that:
    • A similar style doesn't already exist
    • The style can't be created with an existing StyleUtils function (i.e. StyleUtils.getBackgroundAndBorderStyle(theme.componentBG))
  • If the PR modifies code that runs when editing or sending messages, I tested and verified there is no unexpected behavior for all supported markdown - URLs, single line code, code blocks, quotes, headings, bold, strikethrough, and italic.
  • If the PR modifies a generic component, I tested and verified that those changes do not break usages of that component in the rest of the App (i.e. if a shared library or component like Avatar is modified, I verified that Avatar is working as expected in all cases)
  • If the PR modifies a component related to any of the existing Storybook stories, I tested and verified all stories for that component are still working as expected.
  • If the PR modifies a component or page that can be accessed by a direct deeplink, I verified that the code functions as expected when the deeplink is used - from a logged in and logged out account.
  • If the PR modifies the UI (e.g. new buttons, new UI components, changing the padding/spacing/sizing, moving components, etc) or modifies the form input styles:
    • I verified that all the inputs inside a form are aligned with each other.
    • I added Design label and/or tagged @Expensify/design so the design team can review the changes.
  • If a new page is added, I verified it's using the ScrollView component to make it scrollable when more elements are added to the page.
  • If the main branch was merged into this PR after a review, I tested again and verified the outcome was still expected according to the Test steps.

Screenshots/Videos

Android: Native

Screenshot_1732209009
Screenshot_1732209132
Screenshot_1732209175

Android: mWeb Chrome

Screenshot_1732209215

Screenshot_1732209320

iOS: Native

Simulator Screenshot - iPhone 16 - 2024-11-21 at 23 47 32

Simulator Screenshot - iPhone 16 - 2024-11-21 at 23 47 37

Simulator Screenshot - iPhone 16 - 2024-11-21 at 23 47 45

Simulator Screenshot - iPhone 16 - 2024-11-21 at 23 47 57

iOS: mWeb Safari

Simulator Screenshot - iPhone 16 - 2024-11-22 at 00 02 23

Simulator Screenshot - iPhone 16 - 2024-11-22 at 00 02 36

MacOS: Chrome / Safari

Screenshot 2024-11-21 at 23 39 13

Screenshot 2024-11-21 at 23 39 28

Screenshot 2024-11-21 at 23 39 38

Screenshot 2024-11-21 at 23 42 17

MacOS: Desktop

Screenshot 2024-11-22 at 00 07 15

Screenshot 2024-11-22 at 00 07 13

Screenshot 2024-11-22 at 00 07 08

@gijoe0295 gijoe0295 changed the title Feat: Add placeholder thumbnail to expenses with no receipt [WIP] Feat: Add placeholder thumbnail to expenses with no receipt Nov 20, 2024
@gijoe0295 gijoe0295 changed the title [WIP] Feat: Add placeholder thumbnail to expenses with no receipt Feat: Add placeholder thumbnail to expenses with no receipt Nov 21, 2024
@gijoe0295 gijoe0295 marked this pull request as ready for review November 21, 2024 17:16
@gijoe0295 gijoe0295 requested review from a team as code owners November 21, 2024 17:16
@melvin-bot melvin-bot bot requested review from brunovjk and removed request for a team November 21, 2024 17:16
Copy link

melvin-bot bot commented Nov 21, 2024

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

@shawnborton
Copy link
Contributor

It looks like we don't have perfectly even borders and a clean border radius here, any ideas what's happening?
CleanShot 2024-11-21 at 15 20 43@2x

@brunovjk
Copy link
Contributor

brunovjk commented Nov 22, 2024

@gijoe0295 I've noticed an issue: clicking a placeholder receipt in the request preview doesn’t redirect to the expense, unlike clicking a regular receipt preview:

52848_bug.mov

@dannymcclain
Copy link
Contributor

Similar to Shawn's comment, it looks like the gap between placeholder thumbnails is too big.

CleanShot 2024-11-22 at 08 28 24@2x

The gap/border/whatever we call it should be equal on all sides and between thumbnails.

CleanShot 2024-11-22 at 08 30 23@2x

@brunovjk
Copy link
Contributor

👋 @gijoe0295 Have you had a chance to look at the latest comments? Thanks.

@gijoe0295
Copy link
Contributor Author

Yeah I found the root cause. Will push the changes soon.

@gijoe0295
Copy link
Contributor Author

gijoe0295 commented Nov 26, 2024

@brunovjk @dannymcclain I fixed the uneven borders & navigation press issues.

Screenshot 2024-11-26 at 23 12 32

Screenshot 2024-11-26 at 23 34 50

Screenshot 2024-11-26 at 23 35 33

@brunovjk

This comment was marked as outdated.

@brunovjk
Copy link
Contributor

Sorry @gijoe0295, when it's ready for review, please let me know. Thank you :D

@gijoe0295
Copy link
Contributor Author

@brunovjk Sorry for the confusion. It's ready for review. I just forgot to push the last commit for fixing the onPress issue.

@brunovjk
Copy link
Contributor

No worries 👊

@brunovjk
Copy link
Contributor

brunovjk commented Nov 26, 2024

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
52848_android_native.mov
Android: mWeb Chrome
52848_android_web.mov
iOS: Native
52848_ios_native.mov
iOS: mWeb Safari
52848_ios_web.mov
MacOS: Chrome / Safari
52848_web_chrome.mov
MacOS: Desktop
52848_web_desktop.mov

@brunovjk

This comment was marked as outdated.

@brunovjk
Copy link
Contributor

Looking good @gijoe0295, except for one detail: We need to show the receipt instead of the Add receipt placeholder after the user uploads a receipt. Let me know your thoughts. Thanks a lot.

Production
prod.mov
This PR
pr_bug.mov

@brunovjk
Copy link
Contributor

@gijoe0295, did you have a chance to take a look at my last comment? Thanks.

@gijoe0295
Copy link
Contributor Author

@brunovjk I resolved it.

Copy link
Contributor

@brunovjk brunovjk left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I noticed some unrelated issues, like warnings in native and bugs like duplicate preview creation or the scan confirmation modal not disappearing on desktop (though the expense is created). These were reported in Slack and are unrelated to this PR.

We need confirmation @Expensify/design. Other than that, everything seems good to me.

Additionally, @jasperhuangg, could you confirm if unit tests are required, should we include them here or address them in a separate PR? Thank you.

Reviewer Checklist

@dannymcclain
Copy link
Contributor

Running a build to test this bad boy

Copy link
Contributor

github-actions bot commented Dec 2, 2024

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

Copy link
Contributor

github-actions bot commented Dec 2, 2024

🧪🧪 Use the links below to test this adhoc build on Android, iOS, Desktop, and Web. Happy testing! 🧪🧪

Android 🤖 iOS 🍎
https://ad-hoc-expensify-cash.s3.amazonaws.com/android/52848/index.html ❌ FAILED ❌
Android The QR code can't be generated, because the iOS build failed
Desktop 💻 Web 🕸️
https://ad-hoc-expensify-cash.s3.amazonaws.com/desktop/52848/NewExpensify.dmg https://52848.pr-testing.expensify.com
Desktop Web

👀 View the workflow run that generated this build 👀

@shawnborton
Copy link
Contributor

Quick spin and it looks pretty good to me!

@dannymcclain
Copy link
Contributor

Looking good to me too!

@jasperhuangg jasperhuangg merged commit 1ead788 into Expensify:main Dec 3, 2024
18 checks passed
@OSBotify
Copy link
Contributor

OSBotify commented Dec 3, 2024

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

Copy link
Contributor

github-actions bot commented Dec 4, 2024

🚀 Deployed to staging by https://github.com/jasperhuangg in version: 9.0.71-0 🚀

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

Copy link
Contributor

github-actions bot commented Dec 5, 2024

🚀 Deployed to production by https://github.com/puneetlath in version: 9.0.71-2 🚀

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

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