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

Adds ReceiptEmptyState Component and adds new component to MoneyRequestView #31029

Merged
merged 13 commits into from
Nov 15, 2023

Conversation

cdanwards
Copy link
Contributor

@cdanwards cdanwards commented Nov 7, 2023

Details

Fixed Issues

$ #30663

This is the second PR for this issue. It adds the new ReceiptEmptyState component and also adds it to the MoneyRequestView.

Tests

  • Navigate to a Money Request that does not contain a receipt attached
  • Verify that the ReceiptEmptyState component is shown
  • Within the MoneyRequestView set hasErrors to true
  • Verify that the ReceiptEmptyState component has a red border
  • Tap the ReceiptEmptyState component
  • Upload an image via the Receipt Selector and after completion, verify that the ReceiptEmptyState component is no longer shown on the Money Request View

Offline tests

  • Navigate to a Money Request that does not contain a receipt attached
  • Verify that the ReceiptEmptyState component is shown
  • Within the MoneyRequestView set hasErrors to true
  • Verify that the ReceiptEmptyState component has a red border
  • Tap the ReceiptEmptyState component
  • Upload an image via the Receipt Selector and after completion, verify that the ReceiptEmptyState component is no longer shown on the Money Request View

QA Steps

  • Verify that no errors appear in the JS console
  • Set the Betas.canUseViolations to true
  • Navigate to a Money Request that does not contain a receipt attached
  • Verify that the ReceiptEmptyState component is shown
  • Within the MoneyRequestView set hasErrors to true
  • Verify that the ReceiptEmptyState component has a red border
  • Tap the ReceiptEmptyState component
  • Verify that the app navigates to the Receipt Selector
  • Select an image
  • Verify that the app navigates you to the Money Request view
  • Verify that the correct image has been uploaded
  • Verify that the ReceiptEmptyState component is no longer shown

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 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
      • 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

Android: Native
Anroid_receipt.mov
Android: mWeb Chrome Screenshot 2023-11-10 at 4 05 14 PM Screenshot 2023-11-10 at 4 05 28 PM
Photo_Flow_Android_mWeb_480.mov
iOS: Native
iOS_receipt_1080.mov
iOS: mWeb Safari Screenshot 2023-11-10 at 4 09 31 PM Screenshot 2023-11-10 at 4 09 51 PM
Trimmed_iOS_photo_flow_720.mov
MacOS: Chrome / Safari
Web_receipt.mov
MacOS: Desktop
desktop_receipt.mov

@cdanwards cdanwards marked this pull request as ready for review November 9, 2023 14:27
@cdanwards cdanwards requested a review from a team as a code owner November 9, 2023 14:27
@melvin-bot melvin-bot bot requested review from pecanoro and removed request for a team November 9, 2023 14:27
Copy link

melvin-bot bot commented Nov 9, 2023

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

src/components/ReceiptEmptyState.js Outdated Show resolved Hide resolved
src/components/ReportActionItem/MoneyRequestView.js Outdated Show resolved Hide resolved
src/components/ReceiptEmptyState.js Outdated Show resolved Hide resolved
src/components/ReceiptEmptyState.js Outdated Show resolved Hide resolved
src/components/ReceiptEmptyState.js Outdated Show resolved Hide resolved
cdanwards and others added 3 commits November 9, 2023 15:17
Co-authored-by: Carlos Alvarez <cead22@gmail.com>
Co-authored-by: Carlos Alvarez <cead22@gmail.com>
pecanoro
pecanoro previously approved these changes Nov 9, 2023
@pecanoro
Copy link
Contributor

pecanoro commented Nov 9, 2023

Let's see if puller bear gets us a c+ to review it

@pecanoro
Copy link
Contributor

pecanoro commented Nov 9, 2023

@cdanwards It seems we are missing screenshots in some platforms btw!

@pecanoro pecanoro requested review from a team and removed request for a team November 9, 2023 22:05
@melvin-bot melvin-bot bot requested review from joelbettner and removed request for a team November 10, 2023 15:06

This comment was marked as duplicate.

@pecanoro pecanoro removed the request for review from joelbettner November 10, 2023 15:12
@pecanoro
Copy link
Contributor

Ok, it seems puller bear is not going to work so I will ask for a C+ in the channel.

@parasharrajat
Copy link
Member

BUG: The empty area should not be clickable.

Screen.Recording.2023-11-10.at.9.21.04.PM.mov

Copy link
Member

@parasharrajat parasharrajat left a comment

Choose a reason for hiding this comment

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

⬆️

@pecanoro
Copy link
Contributor

@parasharrajat That does not happen on production right now, right?

@cead22 Is the above expected? When testing the current behavior, it does not show the image placeholder if the request has no receipt at all so I am not sure if we want that or not.

@cdanwards
Copy link
Contributor Author

When testing the current behavior, it does not show the image placeholder if the request has no receipt at all so I am not sure if we want that or not.

@pecanoro following up on this comment. Is there more info you can provide around this? Are the betas set to allow you to use violations?

@parasharrajat
Copy link
Member

That does not happen on production right now, right?

The image placeholder is only added on this PR and is not visible on prod.

@cead22
Copy link
Contributor

cead22 commented Nov 14, 2023

Good catch, in the issue I suggested the following

if hasReceipt is false and permissions.canUseViolations() is true we show the ReceiptEmptyState component

But we should only show this receipt empty state if the money request can be edited, and it looks like we can use canEdit for that. How does that sound?

@parasharrajat
Copy link
Member

parasharrajat commented Nov 14, 2023

Probably, canEdit && !isSettled

@cead22
Copy link
Contributor

cead22 commented Nov 14, 2023

That works, but let's not block on this if this receipt empty state is only showing for the case in question for users on the beta.

I'll check with design to see if we should show a different image, or the same image with gray/secondary colors, or something else

@parasharrajat
Copy link
Member

Ok. That would be the last change.

Copy link
Member

@parasharrajat parasharrajat left a comment

Choose a reason for hiding this comment

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

Reviewer Checklist

  • I have verified the author checklist is complete (all boxes are checked off).
  • I verified the correct issue is linked in the ### Fixed Issues section above
  • I verified testing steps are clear and they cover the changes made in this PR
    • I verified the steps for local testing are in the Tests section
    • I verified the steps for Staging and/or Production testing are in the QA steps section
    • I verified the steps cover any possible failure scenarios (i.e. verify an input displays the correct error message if the entered data is not correct)
    • I turned off my network connection and tested it while offline to ensure it matches the expected behavior (i.e. verify the default avatar icon is displayed if app is offline)
  • I checked that screenshots or videos are included for tests on all platforms
  • I included screenshots or videos for tests on all platforms
  • I verified tests pass on all platforms & I tested again on:
    • Android / native
    • Android / Chrome
    • iOS / native
    • iOS / Safari
    • MacOS / Chrome / Safari
    • MacOS / Desktop
  • If there are any errors in the console that are unrelated to this PR, I either fixed them (preferred) or linked to where I reported them in Slack
  • I verified proper code patterns were followed (see Reviewing the code)
    • I verified that any callback methods that were added or modified are named for what the method does and never what callback they handle (i.e. toggleReport and not onIconClick).
    • I verified that the left part of a conditional rendering a React component is a boolean and NOT a string, e.g. myBool && <MyComponent />.
    • I verified that comments were added to code that is not self explanatory
    • I verified that any new or modified comments were clear, correct English, and explained "why" the code was doing something instead of only explaining "what" the code was doing.
    • I verified any copy / text shown in the product is localized by adding it to src/languages/* files and using the translation method
    • I verified all numbers, amounts, dates and phone numbers shown in the product are using the localization methods
    • I verified any copy / text that was added to the app is grammatically correct in English. It adheres to proper capitalization guidelines (note: only the first word of header/labels should be capitalized), and is approved by marketing by adding the Waiting for Copy label for a copy review on the original GH to get the correct copy.
    • I verified proper file naming conventions were followed for any new files or renamed files. All non-platform specific files are named after what they export and are not named "index.js". All platform-specific files are named for the platform the code supports as outlined in the README.
    • I verified the JSDocs style guidelines (in STYLE.md) were followed
  • If a new code pattern is added I verified it was agreed to be used by multiple Expensify engineers
  • I verified that this PR follows the guidelines as stated in the Review Guidelines
  • I verified other components that can be impacted by these changes have been tested, and I retested again (i.e. if the PR modifies a shared library or component like Avatar, I verified the components using Avatar have been tested & I retested again)
  • I verified all code is DRY (the PR doesn't include any logic written more than once, with the exception of tests)
  • I verified any variables that can be defined as constants (ie. in CONST.js or at the top of the file that uses the constant) are defined as such
  • If a new component is created I verified that:
    • A similar component doesn't exist in the codebase
    • All props are defined accurately and each prop has a /** comment above it */
    • The file is named correctly
    • The component has a clear name that is non-ambiguous and the purpose of the component can be inferred from the name alone
    • The only data being stored in the state is data necessary for rendering and nothing else
    • For Class Components, any internal methods passed to components event handlers are bound to this properly so there are no scoping issues (i.e. for onClick={this.submit} the method this.submit should be bound to this in the constructor)
    • Any internal methods bound to this are necessary to be bound (i.e. avoid this.submit = this.submit.bind(this); if this.submit is never passed to a component event handler like onClick)
    • All JSX used for rendering exists in the render method
    • The component has the minimum amount of code necessary for its purpose, and it is broken down into smaller components in order to separate concerns and functions
  • If any new file was added I verified that:
    • The file has a description of what it does and/or why is needed at the top of the file if the code is not self explanatory
  • If a new CSS style is added I verified that:
    • A similar style doesn't already exist
    • The style can't be created with an existing StyleUtils function (i.e. StyleUtils.getBackgroundAndBorderStyle(themeColors.componentBG)
  • If the PR modifies code that runs when editing or sending messages, I tested and verified there is no unexpected behavior for all supported markdown - URLs, single line code, code blocks, quotes, headings, bold, strikethrough, and italic.
  • If the PR modifies a generic component, I tested and verified that those changes do not break usages of that component in the rest of the App (i.e. if a shared library or component like Avatar is modified, I verified that Avatar is working as expected in all cases)
  • If the PR modifies a component related to any of the existing Storybook stories, I tested and verified all stories for that component are still working as expected.
  • If 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.

🎀 👀 🎀 C+ reviewed

Copy link

melvin-bot bot commented Nov 15, 2023

🎯 @parasharrajat, thanks for reviewing and testing this PR! 🎉

An E/App issue has been created to issue payment here: #31370.

@pecanoro pecanoro merged commit 37ddb03 into Expensify:main Nov 15, 2023
17 checks passed
@OSBotify
Copy link
Contributor

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

@kavimuru
Copy link

@cdanwards @parasharrajat Could you help with the following in the QA steps?

Set the Betas.canUseViolations to true
Within the MoneyRequestView set hasErrors to true

@cead22
Copy link
Contributor

cead22 commented Nov 16, 2023

Set the Betas.canUseViolations to true

@kavimuru for this, just use an email address @applause.expensifail.com since that domain is on all betas

  • Within the MoneyRequestView set hasErrors to true
  • Verify that the ReceiptEmptyState component has a red border

You can skip these two steps actually

@cead22
Copy link
Contributor

cead22 commented Nov 16, 2023

I approved but meant to test -- I shouldn't have approved, but testing isn't working for me. It looks like Permissions.canUseViolations isn't defined in src/components/ReportActionItem/MoneyRequestView.js, because we're not importing it. @cdanwards can you confirm and fix please, and add tests covering the case of a user on the beta, and a user not on the beta?

@cead22
Copy link
Contributor

cead22 commented Nov 16, 2023

Let's also get Design's eyes on the border for this new component, as it looks a little bit too thick to me

@@ -176,6 +177,12 @@ function MoneyRequestView({report, betas, parentReport, policyCategories, should
</View>
</OfflineWithFeedback>
)}
{!hasReceipt && canEdit && !isSettled && Permissions.canUseViolations() && (
Copy link
Contributor

Choose a reason for hiding this comment

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

@parasharrajat
Copy link
Member

parasharrajat commented Nov 16, 2023

Looks like it was removed during the merge commit. why didn't it throw a lint warning?

@parasharrajat
Copy link
Member

parasharrajat commented Nov 16, 2023

Created a PR to fix this small mistake #31420

@MonilBhavsar
Copy link
Contributor

Looks like it was removed during the merge commit. why didn't it throw a lint warning?

Agree, let's create a new issue for this. It should throw in such cases

@cdanwards
Copy link
Contributor Author

Thanks @parasharrajat. Sorry @cead22 for that oversight.

@OSBotify
Copy link
Contributor

🚀 Deployed to production by https://github.com/mountiny in version: 1.4.0-3 🚀

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

@cdanwards cdanwards deleted the cdanwards/receipt-empty-state branch November 20, 2023 14:43
@@ -176,6 +177,12 @@ function MoneyRequestView({report, betas, parentReport, policyCategories, should
</View>
</OfflineWithFeedback>
)}
{!hasReceipt && canEdit && !isSettled && Permissions.canUseViolations() && (
<ReceiptEmptyState
hasError={hasErrors}
Copy link
Contributor

Choose a reason for hiding this comment

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

@cdanwards I have a question. Is the hasErrors always false in this line?

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.

9 participants