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: Individually selected expense rows in grouped reports don't have a background color applied to them. #45384

Merged
merged 9 commits into from
Jul 24, 2024

Conversation

Krishna2323
Copy link
Contributor

@Krishna2323 Krishna2323 commented Jul 14, 2024

Details

Fixed Issues

$ #45190
PROPOSAL: #45190 (comment)

Tests

  1. Click Search in bottom navigation
  2. Click "Shared" > Click check box on any one of the grouped expenses
  3. Verify selected item is highlighted with a background color
  • Verify that no errors appear in the JS console

Offline tests

  1. Click Search in bottom navigation
  2. Click "Shared" > Click check box on any one of the grouped expenses
  3. Verify selected item is highlighted with a background color

QA Steps

  1. Click Search in bottom navigation
  2. Click "Shared" > Click check box on any one of the grouped expenses
  3. Verify selected item is highlighted with a background color
  • 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 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
android_native.mp4
Android: mWeb Chrome
android_chrome.mp4
iOS: Native
ios_native.mp4
iOS: mWeb Safari
ios_safari.mp4
MacOS: Chrome / Safari
web_chrome.mp4
MacOS: Desktop
desktop_app.mp4

… a background color applied to them.

Signed-off-by: krishna2323 <[email protected]>
@Krishna2323 Krishna2323 requested a review from a team as a code owner July 14, 2024 22:47
@melvin-bot melvin-bot bot requested review from ishpaul777 and removed request for a team July 14, 2024 22:47
Copy link

melvin-bot bot commented Jul 14, 2024

@ishpaul777 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 shawnborton requested a review from a team July 15, 2024 05:58
@shawnborton
Copy link
Contributor

Looking good!

One thing we might consider doing - the idea is that each of these rows or groups on the search page has 12px of horizontal and vertical padding, as well as 12px of vertical gap between the items. So that means when we make it so that each row can be selectable with a full bleed background color, we end up using 12px of horizontal padding and 6px of vertical padding for each row item.

That being said, that means the first item (the group name/report title) and the last expense in the group don't quite have enough padding to make the entire card feel as though it has 12px of vertical padding, so I think we need to also add 6px of vertical padding to the entire group, to give us this effect:
CleanShot 2024-07-15 at 08 00 08@2x

Let me know if that makes sense! cc @Expensify/design

@ishpaul777
Copy link
Contributor

ishpaul777 commented Jul 15, 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
Record_2024-07-23-17-30-49.mp4
Android: mWeb Chrome
Record_2024-07-23-17-26-32.mp4
iOS: Native
trim.72C22594-3BC6-4B08-B2F7-234FD405648E.MOV
iOS: mWeb Safari
trim.B0AC47CC-8D6B-4C91-AA22-A510986D3130.MOV
MacOS: Chrome / Safari
Screen.Recording.2024-07-23.at.3.55.30.PM-1.mov
MacOS: Desktop
Screen.Recording.2024-07-23.at.5.19.27.PM.mov

@dannymcclain
Copy link
Contributor

@shawnborton that makes sense to me! The 6px value makes me slightly sad 😂 but I'm totally down to go that route.

@shawnborton
Copy link
Contributor

Haha I had a feeling it might, I don't know a better way around that other than changing our spacing for these to 16px 🙂

@dannymcclain
Copy link
Contributor

Totally. I don't either so I'm down to go with what you've suggested!

@ishpaul777
Copy link
Contributor

@Krishna2323 can you please make changes as asked #45384 (comment)

@Krishna2323
Copy link
Contributor Author

can you please make changes as asked #45384 (comment)

will be updated today.

@Krishna2323
Copy link
Contributor Author

Code updated.

@Expensify/design please check the screenshots below:

Large screen width

web_chrome_one_item web_chrome_all_item

Small screen width

small_width_one_item small_width_all_item

@shawnborton
Copy link
Contributor

Going to create a test build for easier testing.

This comment has been minimized.

@shawnborton
Copy link
Contributor

Looks like the padding for the rows is using 8px 12px but we need it to be 6px 12px. See my comment here.

CleanShot 2024-07-17 at 08 44 08@2x

@shawnborton
Copy link
Contributor

And then for the top portion, it looks like it's using 12px for padding, but it needs to be 12px (top) 12px (right) 6px (bottom) 12px (left):
CleanShot 2024-07-17 at 08 45 10@2x

@shawnborton
Copy link
Contributor

Actually sorry, maybe a better approach is to:

Give the whole card wrapper a vertical padding of 6px:
CleanShot 2024-07-17 at 08 49 31@2x

Then for the header, it should get a padding of 6px vertical and 12px horizontal:
CleanShot 2024-07-17 at 08 50 12@2x

And then for the inner part of the header, we should give it a min-height of 40px (just on desktop) to match the rows below:
CleanShot 2024-07-17 at 08 50 44@2x

That should make this look identical to production, but keep the correct gaps/spacing for when rows are selected. Let me know if that all makes sense!

@Krishna2323
Copy link
Contributor Author

Krishna2323 commented Jul 17, 2024

@shawnborton, sorry for incorrect update, I should have confirmed before updating. I have understood the new changes and will update in few hours.

@ishpaul777

This comment was marked as duplicate.

@shawnborton
Copy link
Contributor

Sounds good, thanks for your understanding and let us know when we can test again!

@Krishna2323
Copy link
Contributor Author

Sorry for the delay, I messed up something and I'm very stressed about that from morning. I will update you very soon.

Signed-off-by: krishna2323 <[email protected]>
@Krishna2323
Copy link
Contributor Author

Krishna2323 commented Jul 18, 2024

@shawnborton, please review video below, do we also need to make 6px vertical padding for each item as mentioned here?

report_list_spacing_fix.mp4

@shawnborton
Copy link
Contributor

This part is slightly off still:
CleanShot 2024-07-18 at 11 16 39@2x

The padding should be 6px 12px, not 8px 12px.

@shawnborton
Copy link
Contributor

This definitely feels good and correct on desktop.

On mobile, given that we are using a min-height for the report title now, I think we might consider taking out some of the bottom margin from the top header area... maybe reduce it to 6px if it has a report title below it?
CleanShot 2024-07-18 at 16 17 24@2x

But if not, 12px makes sense to maintain our 12px gaps:
CleanShot 2024-07-18 at 16 18 51@2x

Let me know if that makes sense.

Comment on lines 5105 to 5106
paddingVertical: 6,
paddingHorizontal: 0,
Copy link
Contributor

Choose a reason for hiding this comment

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

Please reuse ...spacing.ph0 and ...spacing.pv1half

Copy link
Contributor

Choose a reason for hiding this comment

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

i am not sure why are we creating a new style we can just reuse utility styles 🤔

@Krishna2323
Copy link
Contributor Author

Krishna2323 commented Jul 19, 2024

@shawnborton @dannymcclain, on mobile if the title is not present the margin for header will be 12px else it would be 6px.

report_list_spacing_fix_mobile.1.mp4

@shawnborton
Copy link
Contributor

Nice! Looks like we have a conflict here, but I think we're ready to get this into final review. Thanks for your patience as we've been working through feedback.

Copy link
Contributor

@shawnborton
Copy link
Contributor

Nice, this is looking good on the test builds above.

@ishpaul777
Copy link
Contributor

will finish this today, @Krishna2323 Please resolve conflicts

@Krishna2323
Copy link
Contributor Author

@ishpaul777, conflicts resolved.

@Krishna2323
Copy link
Contributor Author

@ishpaul777, by mistake I started a review instead of adding a comment that's why I think my comments are not visible.
Monosnap fix: Individually selected expense rows in grouped reports don't have a background color applied to them  by Krishna2323 · Pull… 2024-07-23 08-13-36

@shawnborton
Copy link
Contributor

Let's try to get this one over the finish line soon, thanks!

Signed-off-by: krishna2323 <[email protected]>
@Krishna2323
Copy link
Contributor Author

@ishpaul777, code is updated.

@melvin-bot melvin-bot bot requested a review from marcaaron July 23, 2024 12:03
@marcaaron
Copy link
Contributor

@shawnborton want to take a last look here before I merge?

@shawnborton
Copy link
Contributor

I think we're all good to merge!

@marcaaron marcaaron merged commit 8806b90 into Expensify:main Jul 24, 2024
16 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.

@OSBotify
Copy link
Contributor

🚀 Deployed to staging by https://github.com/marcaaron in version: 9.0.12-0 🚀

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

@OSBotify
Copy link
Contributor

🚀 Deployed to production by https://github.com/francoisl in version: 9.0.12-0 🚀

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

@OSBotify
Copy link
Contributor

🚀 Deployed to staging by https://github.com/marcaaron in version: 9.0.13-0 🚀

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

@ishpaul777 ishpaul777 mentioned this pull request Aug 5, 2024
50 tasks
const listItemPressableStyle = [
styles.selectionListPressableItemWrapper,
styles.pv1half,
styles.ph0,
Copy link
Contributor

Choose a reason for hiding this comment

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

FYI, setting zero horizontal padding here caused the following issue: #50316

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.

7 participants