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

Design clean-up and consistency across expense reports and requests #26603

Merged
merged 28 commits into from
Sep 4, 2023

Conversation

mountiny
Copy link
Contributor

@mountiny mountiny commented Sep 3, 2023

Details

The app has several inaccuracies for previewing a description and merchant of expense reports and expense requests. Also, we are fixing the whisper effect on messages and removing right carets form all report and request previews.
NOTE: the initial proposal has more items to implement, but not all of them were decided to fix. Please read the "Tests" block below to check all fixed scenarios.

Fixed Issues

$ #26138
PROPOSAL: #26138 (comment)

Tests

1. We're showing right carets for all report and request previews, when instead right carets should be removed from all request and report previews.

  1. Open any workspace chat.
  2. Request any type/amount of money requests.
  3. Verify that there is no any right carets.

2. Similarly, IOU reports are showing the merchant when they should instead be showing the description (because IOUs always have the same merchant, which is **Request**).

  1. Open any workspace chat.
  2. Request default cash requests with/without description.
  3. Verify that there is no merchant on requests.
  4. Verify there is a description on requests where you've added it.

3. When a merchant name exists for an expense / request preview, we only show the merchant.

  1. Open any workspace chat.
  2. Request a scan receipt requests with/without description.
  3. Verify that there is no description on requests.
  4. Verify there is a merchant on requests.

4. Normal "Cash" requests are missing the X requests logic.

  1. Open any workspace chat.
  2. Request a few times default cash requests.
  3. Verify that starts from 2+ requests, there is a counter.

5. Receipt whisper cards are no visible when they are inside "Only visible for you" message.

  1. Open any workspace chat.
  2. Request a receipt request.
  3. Verify that their cards are contrast with the background.

6. (none) is showing as a merchant for receipts being scanned

  1. Open any workspace chat.
  2. Request a receipt request without customizing the merchant
  3. Verify that the card does not show (none) as a merchant
  4. Click into the detail of the request
  5. Verify the Merchant is (none)

7. Rounded bottom corners of the images in the report preview

  1. Open any workspace chat.
  2. Make a distance or receipt request
  3. Verify that the report preview and the request preview inside the expense report has bottom corners rounded as well

8. On Report Preview for requests made to Saastr or SBE workspaces, there is no user email in the workspace name

  1. Open workspace chat with SaaStr or SBE workspace
  2. Make a request to such workspace
  3. Verify that the message says SBE owes $xx.xx or SaaStr owes $xx.xx and there is no email prepending the SBE
  • Verify that no errors appear in the JS console

Offline tests

Same as "Tests"

QA Steps

Same as "Tests"

  • Verify that no errors appear in the JS console

PR Author Checklist

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

Screenshots/Videos

Web

1. We're showing right carets for all report and request previews, when instead right carets should be removed from all request and report previews.

1 Safari 1 1 Safari 1 Chrome 1 1 Chrome

2. Similarly, IOU reports are showing the merchant when they should instead be showing the description (because IOUs always have the same merchant, which is **Request**).

2 Safari 2 Chrome

3. When a merchant name exists for an expense / request preview, we only show the merchant.

3 Safari 3 Chrome

4. Normal "Cash" requests are missing the X requests logic.

4 Safari 4 Chrome

5. Cards are no visible when they are inside "Only visible for you" message.

5 Safari 5 1 Safari 5 Chrome 5 1 Chrome

6. (none) is not showing for the smartscanning receipts

image

7. Rounded bottom corners of the images in the report preview

image

8. On Report Preview for requests made to Saastr or SBE workspaces, there is no user email in the workspace name

image
Mobile Web - Chrome

1. We're showing right carets for all report and request previews, when instead right carets should be removed from all request and report previews.

1 IOS Chrome
1 1 IOS Chrome

2. Similarly, IOU reports are showing the merchant when they should instead be showing the description (because IOUs always have the same merchant, which is **Request**).

2 IOS Chrome

3. When a merchant name exists for an expense / request preview, we only show the merchant.

3 IOS Chrome

4. Normal "Cash" requests are missing the X requests logic.

4 IOS Chrome

5. Cards are no visible when they are inside "Only visible for you" message.

5 IOS Chrome
5 1 IOS Chrome

Mobile Web - Safari

1. We're showing right carets for all report and request previews, when instead right carets should be removed from all request and report previews.

1 IOS Safari

1 1 IOS Safari

2. Similarly, IOU reports are showing the merchant when they should instead be showing the description (because IOUs always have the same merchant, which is **Request**).

2 IOS Safari

3. When a merchant name exists for an expense / request preview, we only show the merchant.

3 IOS Safari

4. Normal "Cash" requests are missing the X requests logic.

4 IOS Safari

5. Cards are no visible when they are inside "Only visible for you" message.

5 IOS Safari

5 1 IOS Safari

Desktop

1. We're showing right carets for all report and request previews, when instead right carets should be removed from all request and report previews.

1 Desktop 1 1 Desktop

2. Similarly, IOU reports are showing the merchant when they should instead be showing the description (because IOUs always have the same merchant, which is **Request**).

2 Desktop

3. When a merchant name exists for an expense / request preview, we only show the merchant.

3 Desktop

4. Normal "Cash" requests are missing the X requests logic.

4 Desktop

5. Cards are no visible when they are inside "Only visible for you" message.

5 Desktop 5 1 Desktop
iOS

1. We're showing right carets for all report and request previews, when instead right carets should be removed from all request and report previews.

1 IOS 1 1 IOS

2. Similarly, IOU reports are showing the merchant when they should instead be showing the description (because IOUs always have the same merchant, which is **Request**).

2 IOS

3. When a merchant name exists for an expense / request preview, we only show the merchant.

3 IOS

4. Normal "Cash" requests are missing the X requests logic.

4 IOS

5. Cards are no visible when they are inside "Only visible for you" message.

5 IOS 5 1 IOS
Android

1. We're showing right carets for all report and request previews, when instead right carets should be removed from all request and report previews.

1 Android 1 1 Android

2. Similarly, IOU reports are showing the merchant when they should instead be showing the description (because IOUs always have the same merchant, which is **Request**).

2 Android

3. When a merchant name exists for an expense / request preview, we only show the merchant.

3 Android

4. Normal "Cash" requests are missing the X requests logic.

4 Android

5. Cards are no visible when they are inside "Only visible for you" message.

5 Android 5 1 Android

@mountiny mountiny self-assigned this Sep 3, 2023
@situchan
Copy link
Contributor

situchan commented Sep 3, 2023

I see @rezkiy37 raised PR already. Is it different purpose?

@mountiny mountiny marked this pull request as ready for review September 3, 2023 12:34
@mountiny mountiny requested a review from a team as a code owner September 3, 2023 12:34
@melvin-bot melvin-bot bot requested review from luacmartins, rushatgabhane and shawnborton and removed request for a team September 3, 2023 12:34
@melvin-bot
Copy link

melvin-bot bot commented Sep 3, 2023

@shawnborton @rushatgabhane @luacmartins 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]

@mountiny
Copy link
Contributor Author

mountiny commented Sep 3, 2023

Not from this PR, but I can do endless payment with $0. After click Pay elsewhere, it says paid and then Pay button reappears. This is repeated

So this is an admin on its own workspace right?

I think this will be because the smartscans are not valid and we dont handle the errors well. Its not critical for the conference

@mountiny
Copy link
Contributor Author

mountiny commented Sep 3, 2023

Pushed in some small clean up I missed before

@situchan
Copy link
Contributor

situchan commented Sep 4, 2023

This is super minor but it looks nicer when image border color is same as bottom background when hovered (or whisper) so that it feels image is fully inside card view

Screenshot 2023-09-04 at 10 55 09 AM
Screen.Recording.2023-09-04.at.10.54.51.AM.mov

@situchan
Copy link
Contributor

situchan commented Sep 4, 2023

Tests

1. We're showing right carets for all report and request previews, when instead right carets should be removed from all request and report previews.

web1.mov

2. Similarly, IOU reports are showing the merchant when they should instead be showing the description (because IOUs always have the same merchant, which is **Request**).

web2.mov

3. When a merchant name exists for an expense / request preview, we only show the merchant.

web3.mov

4. Normal "Cash" requests are missing the X requests logic.

web4.mov

5. Receipt whisper cards are no visible when they are inside "Only visible for you" message.

web5.mov

6. (none) is showing as a merchant for receipts being scanned

web6.mov

7. Rounded bottom corners of the images in the report preview

web7.mov

8. On Report Preview for requests made to Saastr or SBE workspaces, there is no user email in the workspace name

Screenshot 2023-09-03 at 9 11 20 PM Screenshot 2023-09-03 at 9 11 26 PM Screenshot 2023-09-03 at 9 11 11 PM

@situchan
Copy link
Contributor

situchan commented Sep 4, 2023

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 the PR modifies a component or page that can be accessed by a direct deeplink, I verified that the code functions as expected when the deeplink is used - from a logged in and logged out account.
  • If a new page is added, I verified it's using the ScrollView component to make it scrollable when more elements are added to the page.
  • If the main branch was merged into this PR after a review, I tested again and verified the outcome was still expected according to the Test steps.
  • I have checked off every checkbox in the PR reviewer checklist, including those that don't apply to this PR.

Screenshots/Videos

Web

#26603 (comment)

Mobile Web - Chrome
mchrome.mov
Mobile Web - Safari
msafari.mov
Desktop
desktop.mov
iOS
ios.mov
Android
android.mov

@situchan
Copy link
Contributor

situchan commented Sep 4, 2023

Bug: [mobile] hover flickering on long-press (happening on main)

Screen.Recording.2023-09-04.at.11.53.15.AM.mov

Copy link
Contributor

@situchan situchan left a comment

Choose a reason for hiding this comment

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

:shipit:

Copy link
Contributor

@Julesssss Julesssss left a comment

Choose a reason for hiding this comment

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

Tests well for me 👍

@Julesssss Julesssss merged commit a7cba2d into main Sep 4, 2023
12 checks passed
@Julesssss Julesssss deleted the vit-26503theft branch September 4, 2023 10:47
@OSBotify
Copy link
Contributor

OSBotify commented Sep 4, 2023

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

@shawnborton
Copy link
Contributor

Something still feels off here... the corners of the receipt don't feel very crisp:
image

I also wanted to confirm that the inner border on those receipt images is 4px?

@OSBotify
Copy link
Contributor

OSBotify commented Sep 4, 2023

🚀 Deployed to staging by https://github.com/Julesssss in version: 1.3.63-0 🚀

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

@OSBotify
Copy link
Contributor

OSBotify commented Sep 5, 2023

🚀 Deployed to production by https://github.com/mountiny in version: 1.3.63-2 🚀

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

@OSBotify
Copy link
Contributor

OSBotify commented Sep 5, 2023

🚀 Deployed to staging by https://github.com/Julesssss in version: 1.3.64-0 🚀

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

@OSBotify
Copy link
Contributor

OSBotify commented Sep 6, 2023

🚀 Deployed to production by https://github.com/mountiny in version: 1.3.64-2 🚀

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

// Show the merchant for IOUs and expenses only if they are custom or not related to scanning smartscan
const shouldShowMerchant =
!_.isEmpty(requestMerchant) && !props.isBillSplit && requestMerchant !== CONST.TRANSACTION.PARTIAL_TRANSACTION_MERCHANT && requestMerchant !== CONST.TRANSACTION.DEFAULT_MERCHANT;
const shouldShowDescription = !_.isEmpty(description) && !shouldShowMerchant;
Copy link
Contributor

Choose a reason for hiding this comment

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

We should have checked if the receipt was not being scanned here. Not doing so caused #31104.

Copy link
Contributor

Choose a reason for hiding this comment

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

Okay, thank you for letting me know. AFAIK, the bug already fixed.

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.

8 participants