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

Patch for search lhn no results found padding #41221

Conversation

brandonhenry
Copy link
Contributor

@brandonhenry brandonhenry commented Apr 29, 2024

Details

Fixed Issues

$ #39032
PROPOSAL: #37984 (comment)

Tests

  1. Open the Expensify app.
  2. Click on the search functionality.
  3. Type some random text that will result in a "No results found" message.
  • Verify that the "No results found" message is aligned with the left edge of the search input.
  • Verify that the app behaves as expected and no errors appear in the JS console.

Repeat steps 1-3 for all supported platforms:
- Android: Native
- Android: mWeb Chrome
- iOS: Native
- iOS: mWeb Safari
- MacOS: Chrome / Safari
- MacOS: Desktop

Offline tests

  1. Open the Expensify app.
  2. Click on the search functionality.
  3. Type some random text that will result in a "No results found" message.
  4. Verify that the "No results found" message is aligned with the left edge of the search input.
  5. Verify that the app behaves as expected and no errors appear in the JS console.
  6. Disable the internet connection on the device.
  • Verify that the search functionality displays the appropriate offline message or placeholder UI.
  • Verify that the app does not crash or display any error messages related to the search functionality while offline.
  1. Re-enable the internet connection and verify that the search functionality returns to normal operation and the alignment fix remains intact.

Repeat steps 1-9 with a spotty or slow internet connection to ensure the search functionality handles these scenarios gracefully.

Repeat steps 1-10 for all supported platforms:
- Android: Native
- Android: mWeb Chrome
- iOS: Native
- iOS: mWeb Safari
- MacOS: Chrome / Safari
- MacOS: Desktop

QA Steps

  1. Open the Expensify app.
  2. Click on the search functionality.
  3. Type some random text that will result in a "No results found" message.
  4. Verify that the "No results found" message is aligned with the left edge of the search input.
  5. Verify that no errors appear in the JS console.
  6. Repeat steps 1-5 for all supported platforms:
    • Android: Native
    • Android: mWeb Chrome
    • iOS: Native
    • iOS: mWeb Safari
    • MacOS: Chrome / Safari
    • MacOS: Desktop
  • Verify that the alignment fix does not break the styling or alignment of headerMessage in other places where BaseSelectionList is used.
  • Test the search functionality thoroughly to ensure there are no regressions or unintended side effects caused by the alignment fix.
  • 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 image
Android: mWeb Chrome image
iOS: Native image
iOS: mWeb Safari image
MacOS: Chrome / Safari image
MacOS: Desktop image

@brandonhenry brandonhenry requested a review from a team as a code owner April 29, 2024 15:33
@melvin-bot melvin-bot bot requested review from carlosmiceli and removed request for a team April 29, 2024 15:33
Copy link

melvin-bot bot commented Apr 29, 2024

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

@brandonhenry
Copy link
Contributor Author

Hi, ideally the review for this goes to @allroundexperts as he reviewed the first one and this is an update to have the fix affect all "no result found" error messages, not just one seen on search page

@carlosmiceli
Copy link
Contributor

Hi @brandonhenry ! I'm going to try to get to this this week, but I'm in the middle of my onboarding trip, so I may be a bit slow, in case you'd rather assign the review to someone else 😅

If there's no rush, then I'll be happy to do it 💪

shawnborton
shawnborton previously approved these changes Apr 29, 2024
@shawnborton shawnborton self-requested a review April 29, 2024 16:20
@brandonhenry
Copy link
Contributor Author

@shawnborton I made that change - makes sense!

@brandonhenry
Copy link
Contributor Author

@carlosmiceli yes if this can be assigned to shawn would be great!

@shawnborton
Copy link
Contributor

Heh, I'm just a designer so I think we should still get an engineering review @carlosmiceli - feel free to resassign to someone else though!

This comment has been minimized.

@brandonhenry
Copy link
Contributor Author

@allroundexperts if you have time to pick this up, feel free. Otherwise will wait on current reviewer

@shawnborton
Copy link
Contributor

Looks like this isn't aligned on the Search page:
CleanShot 2024-04-29 at 15 49 26@2x

It looks like the category subtitles aren't aligned correctly either, not sure if that is related to this or not:
CleanShot 2024-04-29 at 15 50 17@2x

But no categories found looks correct:
CleanShot 2024-04-29 at 15 50 46@2x

@brandonhenry
Copy link
Contributor Author

ohh looks like i reverted the other change I made here. Will verify this now and check through each screen and also update the tests!

@brandonhenry
Copy link
Contributor Author

@shawnborton fixed the search one being misupdated. Also fixed the category list one. that was another one I don't think was caught at all so great find there! The all title was different from the other fixes. If we want everything aligned at 20px, we need to also update a separate part of the code

@shawnborton
Copy link
Contributor

If we want everything aligned at 20px, we need to also update a separate part of the code

Awesome, thanks for clarifying. If it's not too much to ask, I think updating that would be great and fully fix this issue. What do you think?

@brandonhenry
Copy link
Contributor Author

@shawnborton oh yeah! i made that change, it was actually in the same place lol - should be good

@shawnborton
Copy link
Contributor

Will create a new build!

@shawnborton
Copy link
Contributor

Hmm just tried again with a new test build and I'm seeing the slight misalignment in the Chat Finder:
CleanShot 2024-04-30 at 08 52 35@2x

The small list selection labels are looking good though:
CleanShot 2024-04-30 at 08 53 44@2x

As well as no results found:
CleanShot 2024-04-30 at 08 54 09@2x

@brandonhenry
Copy link
Contributor Author

@shawnborton ahh seems I had to revert my original fix since I updated the code at the base level this time (so we update all instances of the input). Okay.. I am sure we are good now 😅

@shawnborton
Copy link
Contributor

Nice! I'll run a new build for testing.

Copy link
Contributor

@shawnborton
Copy link
Contributor

Nice, looks great!
CleanShot 2024-04-30 at 14 56 23@2x

CleanShot 2024-04-30 at 14 57 02@2x

CleanShot 2024-04-30 at 14 58 01@2x

CleanShot 2024-04-30 at 14 59 28@2x

@carlosmiceli carlosmiceli removed their request for review May 7, 2024 23:09
@shawnborton
Copy link
Contributor

The PR looks good to me, but now we need a C+ to run through the checklist.

@carlosmiceli is there a reason why you removed your assignment?

@allroundexperts
Copy link
Contributor

allroundexperts commented May 9, 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 build failing

Android: mWeb Chrome Screenshot 2024-05-10 at 1 00 08 PM
iOS: Native Screenshot 2024-05-10 at 1 00 21 PM Screenshot 2024-05-10 at 1 00 43 PM
iOS: mWeb Safari Screenshot 2024-05-10 at 1 01 33 PM Screenshot 2024-05-10 at 1 02 12 PM
MacOS: Chrome / Safari Screenshot 2024-05-10 at 12 58 43 PM Screenshot 2024-05-10 at 12 59 46 PM
MacOS: Desktop Screenshot 2024-05-10 at 12 43 13 PM Screenshot 2024-05-10 at 12 47 56 PM

@allroundexperts
Copy link
Contributor

Hi @brandonhenry!
Can you complete your checklist please?

@brandonhenry
Copy link
Contributor Author

@allroundexperts checklist completed

@carlosmiceli carlosmiceli self-requested a review May 9, 2024 22:16
@carlosmiceli
Copy link
Contributor

The PR looks good to me, but now we need a C+ to run through the checklist.

@carlosmiceli is there a reason why you removed your assignment?

Hey Shawn! I think when I assigned I thought I was no longer needed but the last few days I understood that we still need an engineer always for the PRs! My bad, will review now!

@carlosmiceli
Copy link
Contributor

I'm seeing the checklist complete at the top but the tests are failing, maybe due to the duplicate empty one below?

@brandonhenry
Copy link
Contributor Author

@carlosmiceli yeahh looks to be failing on the reviewer checklist items

Copy link
Contributor

@allroundexperts allroundexperts left a comment

Choose a reason for hiding this comment

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

LGTM!

Copy link

melvin-bot bot commented May 10, 2024

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

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

@shawnborton shawnborton merged commit 153021e into Expensify:main May 15, 2024
16 of 30 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/shawnborton in version: 1.4.75-0 🚀

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

@brandonhenry brandonhenry deleted the patch-for-search-lhn-no-results-found-padding branch May 23, 2024 18:59
@OSBotify
Copy link
Contributor

🚀 Deployed to production by https://github.com/puneetlath in version: 1.4.75-1 🚀

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

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.

5 participants