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

Feature: Empty state UI for LHN #37361

Merged
merged 20 commits into from
Apr 1, 2024

Conversation

tienifr
Copy link
Contributor

@tienifr tienifr commented Feb 27, 2024

Details

This PR implements an "empty state" UI when users have cleared out the LHN in #focus mode on small screen devices.

Fixed Issues

$ #34926
PROPOSAL: #34926 (comment)

Tests

Small screen devices only

  1. Switch to #focus mode
  2. Mark all reports as read or unpin them so that LHN is cleared out
  3. Verify the empty state UI shows as expected
  4. Verify it in different themes, languages and devices
  • Verify that no errors appear in the JS console

Offline tests

NA

QA Steps

Small screen devices only

  1. Switch to #focus mode
  2. Mark all reports as read or unpin them so that LHN is cleared out
  3. Verify the empty state UI shows as expected
  • 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 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 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 form input styles:
    • I verified that all the inputs inside a form are aligned with each other.
    • I added Design label 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

Native
Screen.Recording.2024-03-04.at.22.06.56-compressed.mov
Screen.Recording.2024-03-04.at.22.06.28-compressed.mov
mWeb
Screen.Recording.2024-03-04.at.22.07.43-compressed.mov
Screen.Recording.2024-03-04.at.22.07.22-compressed.mov
Screen.Recording.2024-03-04.at.22.05.59-compressed.mov

@tienifr tienifr marked this pull request as ready for review February 28, 2024 20:22
@tienifr tienifr requested a review from a team as a code owner February 28, 2024 20:22
@melvin-bot melvin-bot bot requested review from DylanDylann and removed request for a team February 28, 2024 20:22
Copy link

melvin-bot bot commented Feb 28, 2024

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

@tienifr
Copy link
Contributor Author

tienifr commented Feb 29, 2024

@DylanDylann The logic of adding Concierge chat here is supposed to remove but I need testing it carefully. For now, please hard code that.

@DylanDylann
Copy link
Contributor

@tienifr Yeah, ping me again when all logic is ready

@@ -302,6 +302,12 @@ export default {
update: 'Actualizar',
member: 'Miembro',
role: 'Role',
emptyLHN: {
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Copy was verified here.

@tienifr
Copy link
Contributor Author

tienifr commented Mar 4, 2024

@DylanDylann The changes are ready for review. I tested removing the logic to add Concierge chat when report list is empty and verified it did not cause any trouble.

@roryabraham Also please add Design label so design team can weigh in.

@roryabraham
Copy link
Contributor

design label didn't work so I'm manually requesting review from @dannymcclain, who created the mockups

This comment has been minimized.

@DylanDylann
Copy link
Contributor

@tienifr Jest Unit Tests / Storybook tests (pull_request) is failed

src/components/LHNOptionsList/LHNOptionsList.tsx Outdated Show resolved Hide resolved
src/components/LHNOptionsList/LHNOptionsList.tsx Outdated Show resolved Hide resolved
src/styles/variables.ts Show resolved Hide resolved
src/components/LHNOptionsList/LHNOptionsList.tsx Outdated Show resolved Hide resolved
dannymcclain
dannymcclain previously approved these changes Mar 27, 2024
Copy link
Contributor

@dannymcclain dannymcclain left a comment

Choose a reason for hiding this comment

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

From a design perspective I think this is looking and feeling good. Obviously make sure to still get a proper technical review from an engineer.

cc @Expensify/design in case y'all have any other feedback.

@tienifr
Copy link
Contributor Author

tienifr commented Mar 27, 2024

I'm working on the storybook test failure. Will post update tomorrow.

src/components/BlockingViews/BlockingView.tsx Outdated Show resolved Hide resolved
src/components/BlockingViews/BlockingView.tsx Outdated Show resolved Hide resolved
@tienifr
Copy link
Contributor Author

tienifr commented Mar 28, 2024

I've resolved all @roryabraham feedback above and fixed Storybook test failure. @DylanDylann This is ready for your review & retest again.

@@ -45,6 +45,10 @@ const webpackConfig = ({config}: {config: Configuration}) => {
...custom.resolve.alias,
};

// We can ignore the "module not installed" warning from lottie-react-native
// because we are not using the library for JSON format of Lottie animations.
config.ignoreWarnings = [{module: new RegExp('node_modules/lottie-react-native/lib/module/LottieView/index.web.js')}];
Copy link
Contributor Author

@tienifr tienifr Mar 28, 2024

Choose a reason for hiding this comment

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

This was referenced from:

stats: {
// We can ignore the "module not installed" warning from lottie-react-native
// because we are not using the library for JSON format of Lottie animations.
warningsFilter: ['./node_modules/lottie-react-native/lib/module/LottieView/index.web.js'],
},

I already tried that stats.warningsFilter config and used the correct module path but it didn't work. I'm not sure about that. However, based on the recommendation here, ignoreWarnings seems a better alternative.

Copy link
Contributor

Choose a reason for hiding this comment

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

@tienifr If we don't add this change, which story test will be failed

Copy link
Contributor Author

@tienifr tienifr Apr 1, 2024

Choose a reason for hiding this comment

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

There're no specific test fail, it just threw an error/warning when we built the story page. More info here (Please expand the Storybook run section and scroll to bottom).

Copy link
Contributor

Choose a reason for hiding this comment

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

Oh yeah, It helps remove some warnings but I still see errors in Story Test. But it seems it isn't related to this PR.

Screenshot 2024-04-01 at 11 36 46

shouldEmbedLinkWithSubtitle?: boolean;

/** Render custom subtitle */
CustomSubtitle?: React.ReactElement;
Copy link
Contributor

Choose a reason for hiding this comment

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

@tienifr Using camelCase convention

Copy link
Contributor Author

@tienifr tienifr Apr 1, 2024

Choose a reason for hiding this comment

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

We used PascalCase for component props like here, here, here and here.

Copy link
Contributor

Choose a reason for hiding this comment

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

PascalCase is correct for component props

@DylanDylann
Copy link
Contributor

DylanDylann commented Apr 1, 2024

if (!optionItem) {
return null;
}

Should we remove this code or move it out of OptionRowLHN to ensure all logic to hide reports in LHN is moved to LHNOptionsList?

@DylanDylann
Copy link
Contributor

DylanDylann commented Apr 1, 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
Screen.Recording.2024-04-01.at.11.43.17.mov
Android: mWeb Chrome
Screen.Recording.2024-04-01.at.11.40.23.mov
iOS: Native
Screen.Recording.2024-04-01.at.11.46.35.mov
iOS: mWeb Safari
Screen.Recording.2024-04-01.at.11.43.57.mov
MacOS: Chrome / Safari
MacOS: Desktop

Copy link
Contributor

@DylanDylann DylanDylann left a comment

Choose a reason for hiding this comment

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

@roryabraham Could you help to re-run all tests?

@melvin-bot melvin-bot bot requested a review from roryabraham April 1, 2024 04:47
@DylanDylann
Copy link
Contributor

@roryabraham I approved this PR to re-run all tests. A minor comment. Everything else looks good

@roryabraham roryabraham merged commit 732555a into Expensify:main Apr 1, 2024
18 checks passed
@melvin-bot melvin-bot bot added the Emergency label Apr 1, 2024
Copy link

melvin-bot bot commented Apr 1, 2024

@roryabraham looks like this was merged without a test passing. Please add a note explaining why this was done and remove the Emergency label if this is not an emergency.

@OSBotify
Copy link
Contributor

OSBotify commented Apr 1, 2024

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

@roryabraham
Copy link
Contributor

@OSBotify
Copy link
Contributor

OSBotify commented Apr 2, 2024

🚀 Deployed to staging by https://github.com/roryabraham in version: 1.4.59-0 🚀

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

@OSBotify
Copy link
Contributor

OSBotify commented Apr 8, 2024

🚀 Deployed to production by https://github.com/Julesssss in version: 1.4.60-13 🚀

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

@@ -54,6 +66,40 @@ function LHNOptionsList({
onFirstItemRendered();
}, [onFirstItemRendered]);

const emptyLHNSubtitle = useMemo(
Copy link
Member

Choose a reason for hiding this comment

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

UI was broken on Android devices. Let's make sure we test this so that the UI looks good on each platform. #41349

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