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

Fix: Use different fallback receipt icon when displaying a Search row that has no receipt and isn't editable #44742

Merged
merged 17 commits into from
Aug 5, 2024

Conversation

neonbhai
Copy link
Contributor

@neonbhai neonbhai commented Jul 2, 2024

Details

Fixed Issues

$ #44240
PROPOSAL: #44240 (comment)

Tests

  1. Open Expensify App
  2. Go to Search
  3. In the receipt column, verify that:
    • If the report has a receipt, the receipt preview is shown
    • If the report has no receipt and is open/submitted then the "Receipt Plus" icon is shown
    • If the report has no receipt and is settled then the "Receipt Slash" icon is shown
  • Verify that no errors appear in the JS console

Offline tests

Same as Tests step

QA Steps

Same as Tests step

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 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 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 2024-07-15 at 8 00 55 AM
Android: mWeb Chrome Screenshot 2024-07-13 at 10 07 17 AM
iOS: Native Screenshot 2024-07-15 at 7 49 40 AM
iOS: mWeb Safari Screenshot 2024-07-13 at 9 52 24 AM
MacOS: Chrome / Safari
Web-2.mp4
MacOS: Desktop Desktop

@neonbhai neonbhai requested a review from a team as a code owner July 2, 2024 18:43
@melvin-bot melvin-bot bot removed the request for review from a team July 2, 2024 18:43
Copy link

melvin-bot bot commented Jul 2, 2024

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

@melvin-bot melvin-bot bot requested a review from s77rt July 2, 2024 18:44
@neonbhai neonbhai marked this pull request as draft July 2, 2024 18:44
@neonbhai
Copy link
Contributor Author

My mac stopped working a few days ago, just got it back from repair. Working on Finalizing this PR! Sorry for the delay! 🙇

@neonbhai neonbhai marked this pull request as ready for review July 15, 2024 03:04
@neonbhai
Copy link
Contributor Author

@s77rt PR is ready for your review!

Noting one thing, The pay someone flow in app seems to have a problem on main where the request is marked Submitted instead of Reimbursed, making isSettled calculation false

Image Screenshot 2024-07-14 at 6 14 34 AM

I've been trying to debug the root cause and the optimistic data is fine. The bug seems to be with how Onyx is managing the BE responses. @bernhardoj also observed the same thing when debugging a similar issue (with connected root cause) here

@luacmartins luacmartins self-requested a review July 23, 2024 20:29
@luacmartins
Copy link
Contributor

What's the status on this one @neonbhai ?

@s77rt
Copy link
Contributor

s77rt commented Jul 31, 2024

@neonbhai Any updates on this?

@neonbhai
Copy link
Contributor Author

Apologies for the delay 🙇 bought and setup a new pc

PR is ready for review!

Noting that when using a high traffic account not all reports are loaded in Onyx, this makes the report status checks incorrect (as it is null)

Screen.Recording.2024-07-30.at.8.51.38.PM.mp4

The icon updates after we click on it and the report is loaded. Simultaneously allReports length increases as a new report is loaded

To fix this I have added an extra check for Paid and Done actions, since these transactions cannot be modified

cc: @s77rt

@s77rt
Copy link
Contributor

s77rt commented Jul 31, 2024

@neonbhai Can you please merge main? I'm having a problem testing this

@neonbhai
Copy link
Contributor Author

Merged main!

@s77rt
Copy link
Contributor

s77rt commented Aug 1, 2024

@neonbhai Still seeing reports with the wrong icon

Screen.Recording.2024-08-01.at.8.14.55.AM.mov

@neonbhai
Copy link
Contributor Author

neonbhai commented Aug 1, 2024

Looks like this is still caused by the issue that not all report objects shown in search are loaded in Onyx 😥
This makes the status checks on the report objects null here

Possible Solutions:

  • Call openReport when a report is not found in Onyx.
    wondering if the decision to not load all this was done as part of the performance improvements in App, since there are prod accounts with 15K reports. Calling openReport on search page will affect performance for high traffic accounts

  • Since we show Receipt thumbnail for every transactionItem on the search page, suggesting we have canModifyReceipt as part of the transactionItem data coming from BE (as BE would have access to the reports connected to transaction data it is sending). This would save the frontend client from loading full reports.
    I would recommend this.

cc: @s77rt

@s77rt
Copy link
Contributor

s77rt commented Aug 1, 2024

@neonbhai Can we use the existing fields: action, canDelete and canHold?

@neonbhai
Copy link
Contributor Author

neonbhai commented Aug 2, 2024

We might be able to use canDelete, but I see a bug in app:

When setting up a flow, where an Employee submits to an Approver -> Which then goes to the Admin
(Submit Frequency is Manual)

The Approver and Requestor can see the receipt empty state, but cannot click on it to add a receipt:

Screen.Recording.2024-08-02.at.7.43.32.PM.mov

Admin's POV for a submitted Expense. The empty state is not clickable (cannot edit receipt)

@neonbhai
Copy link
Contributor Author

neonbhai commented Aug 2, 2024

Here is the current behaviour of app:

Flow: Employee submits to an Approver -> Which then goes to the Admin
(Submit Frequency is Manual)

The expenses were made (not submitted yet)

  • Requestor - can Edit Receipt
  • Approver - cannot Edit Receipt - sees empty state
  • Admin - cannot Edit Receipt - sees empty state

The expenses were submitted

  • Requestor - can Edit Receipt
  • Approver - cannot Edit Receipt - sees empty state
  • Admin - cannot Edit Receipt - sees empty state

The expenses were approved

  • Requestor - cannot Edit Receipt
  • Approver - cannot Edit Receipt
  • Admin - cannot Edit Receipt

The expenses were paid

  • Requestor - cannot Edit Receipt
  • Approver - cannot Edit Receipt
  • Admin - cannot Edit Receipt

Is the behavior of the Approver and Admin not being able to edit the receipt in any step correct?

And if a role cannot edit an expense, should they be seeing the receipt empty state?

cc: @s77rt @luacmartins

@s77rt
Copy link
Contributor

s77rt commented Aug 3, 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 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 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.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(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.
  • 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
Android: mWeb Chrome mweb-chrome
iOS: Native ios
iOS: mWeb Safari mweb-safari
MacOS: Chrome / Safari web
MacOS: Desktop desktop

src/libs/ReportUtils.ts Outdated Show resolved Hide resolved
@s77rt
Copy link
Contributor

s77rt commented Aug 3, 2024

@neonbhai If the user (no matter their role) cannot add a receipt they should not see the "add the receipt" icon

@s77rt
Copy link
Contributor

s77rt commented Aug 4, 2024

@neonbhai

Verify the slashed receipt is visible if a report is settled

This is not clear. Please change to:

  • In the receipt column, verify that:
    • If the report has a receipt, the receipt preview is shown
    • If the report has no receipt and is open/submitted then the "Receipt Plus" icon is shown
    • If the report has no receipt and is settled then the "Receipt Slash" icon is shown

Tag me once done

@neonbhai
Copy link
Contributor Author

neonbhai commented Aug 4, 2024

Makes sense, updated!

cc: @s77rt

Copy link
Contributor

@s77rt s77rt left a comment

Choose a reason for hiding this comment

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

Thank you!

@luacmartins luacmartins merged commit 66ae374 into Expensify:main Aug 5, 2024
16 of 17 checks passed
@OSBotify
Copy link
Contributor

OSBotify commented Aug 5, 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.

@OSBotify
Copy link
Contributor

OSBotify commented Aug 6, 2024

🚀 Deployed to staging by https://github.com/luacmartins in version: 9.0.17-0 🚀

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

@OSBotify
Copy link
Contributor

OSBotify commented Aug 7, 2024

🚀 Deployed to production by https://github.com/marcaaron in version: 9.0.17-2 🚀

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

2 similar comments
@OSBotify
Copy link
Contributor

OSBotify commented Aug 8, 2024

🚀 Deployed to production by https://github.com/marcaaron in version: 9.0.17-2 🚀

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

@OSBotify
Copy link
Contributor

OSBotify commented Aug 8, 2024

🚀 Deployed to production by https://github.com/marcaaron in version: 9.0.17-2 🚀

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

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

Successfully merging this pull request may close these issues.

4 participants