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

[Self-guided tours v1] Add self-guided tours in Search Page Empty State #50931

Merged

Conversation

c3024
Copy link
Contributor

@c3024 c3024 commented Oct 16, 2024

Details

This PR adds self guided tours in the empty state view of Search Page.

Fixed Issues

$ #50926
PROPOSAL:

Tests

Test 1:

  1. Logon to ND with a new account.
  2. Select any onboarding purpose other than "Manage my team expenses".
  3. Click on "Search" in the bottom tab bar.
  4. Verify that two buttons "Take a tour" and "Create Expense" are shown in the empty state view of the Search Page in the center pane.
  5. Click on the "Take a tour" button.
  6. Verify that you are taken to the employee-focused tour.
  7. Click on the "Create Expense" button.
  8. Verify that the RHP for "Submit Expense" flow opens.

Test 2:

  1. Logon to ND with a new account.
  2. Select "Manage my team expenses" as the onboarding purpose.
  3. Follow steps 3 to 5 in Test 1.
  4. Click on the "Take a tour" button.
  5. Verify that you are taken to the admin-focused tour.
  6. Click on the "Create Expense" button.
  7. Verify that the RHP for "Submit Expense" flow opens.
  • Verify that no errors appear in the JS console

Offline tests

NA

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: 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): Reported them on Slack here.
  • 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
    • 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
navatticAndroid.mp4
Android: mWeb Chrome
navatticAndroidmWeb.mp4
iOS: Native
navatticiOS.mp4
iOS: mWeb Safari
navatticiOSmWeb.mp4
MacOS: Chrome / Safari
navatticChrome.mp4
MacOS: Desktop
navatticDesktop.mp4

@c3024 c3024 requested review from a team as code owners October 16, 2024 18:02
@melvin-bot melvin-bot bot requested review from rushatgabhane and removed request for a team October 16, 2024 18:03
Copy link

melvin-bot bot commented Oct 16, 2024

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

@c3024 c3024 changed the title Add self-guided Navattic tours in Search Page Empty State Add self-guided tours in Search Page Empty State Oct 16, 2024
src/CONST.ts Outdated
@@ -753,6 +753,11 @@ const CONST = {
DELAYED_SUBMISSION_HELP_URL: 'https://help.expensify.com/articles/expensify-classic/reports/Automatically-submit-employee-reports',
// Use Environment.getEnvironmentURL to get the complete URL with port number
DEV_NEW_EXPENSIFY_URL: 'https://dev.new.expensify.com:',
NAVATTIC: {
ADMIN_TOUR: 'http://expensify.navattic.com/kh204a7',
EMPLOYEE_TOUR: 'http://expensify.navattic.com/35609gb',
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
EMPLOYEE_TOUR: 'http://expensify.navattic.com/35609gb',
EMPLOYEE_TOUR: 'https://expensify.navattic.com/35609gb',

src/CONST.ts Outdated
@@ -753,6 +753,11 @@ const CONST = {
DELAYED_SUBMISSION_HELP_URL: 'https://help.expensify.com/articles/expensify-classic/reports/Automatically-submit-employee-reports',
// Use Environment.getEnvironmentURL to get the complete URL with port number
DEV_NEW_EXPENSIFY_URL: 'https://dev.new.expensify.com:',
NAVATTIC: {
ADMIN_TOUR: 'http://expensify.navattic.com/kh204a7',
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
ADMIN_TOUR: 'http://expensify.navattic.com/kh204a7',
ADMIN_TOUR: 'https://expensify.navattic.com/kh204a7',

@@ -4291,6 +4291,10 @@ const translations = {
title: 'No hay nada que ver aquí',
subtitle: 'Por favor intenta crear algo usando el botón verde.',
},
emptyExpenseResults: {
title: "You haven't created any expenses yet",
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
title: "You haven't created any expenses yet",
title: "Aún no has creado ningún gasto",

@@ -4291,6 +4291,10 @@ const translations = {
title: 'No hay nada que ver aquí',
subtitle: 'Por favor intenta crear algo usando el botón verde.',
},
emptyExpenseResults: {
title: "You haven't created any expenses yet",
subtitle: 'Use the green button below to create an expense or take a tour of Expensify to learn more.',
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
subtitle: 'Use the green button below to create an expense or take a tour of Expensify to learn more.',
subtitle: 'Usa el botón verde de abajo para crear un gasto o realiza un recorrido por Expensify para aprender más.',

@@ -5593,6 +5597,9 @@ const translations = {
hasMissingInvoiceBankAccount: 'Falta la cuenta bancaria de la factura',
},
},
emptySearchView: {
takeATour: 'Take a tour',
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
takeATour: 'Take a tour',
takeATour: 'Realiza un recorrido',

Copy link
Member

@rushatgabhane rushatgabhane left a comment

Choose a reason for hiding this comment

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

@c3024 please add the button to trips too.
Screenshot 2024-10-17 at 00 54 24

Button on staging -

image

Copy link
Member

@rushatgabhane rushatgabhane left a comment

Choose a reason for hiding this comment

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

Bug 1: For type chat, we're showing the same expenses message.
Bug 2: For tyoe invoices, we're showing the same expenses message.

Expected: show the old empty view.

image

@c3024
Copy link
Contributor Author

c3024 commented Oct 17, 2024

@rushatgabhane

Thanks! Updated all except this.

please add the button to trips too.

Corrected its style back to the usual style.

I will add the tour link to trips in this v1 or a later version after @zsgreenwald adds it to the GitHub issue so that someone OOTL do not see inconsistencies between the plan and the PR.

@c3024 c3024 changed the title Add self-guided tours in Search Page Empty State [Self-guided tours v1] Add self-guided tours in Search Page Empty State Oct 17, 2024
@c3024
Copy link
Contributor Author

c3024 commented Oct 17, 2024

@zsgreenwald

I have not found a Figma design for the narrow layout of the search page empty state modal.

When the buttons are arranged horizontally on narrow layout, the text “Create Expense” gets cut off.

Screenshot 2024-10-17 at 10 27 41 AM

So, I styled them to be laid out vertically on narrow layouts.

Screenshot 2024-10-17 at 10 32 28 AM

Let me know if this needs changes. Thanks!

@rushatgabhane
Copy link
Member

@c3024 vertical layout looks great!

@shawnborton
Copy link
Contributor

Vertical makes sense to me. Are we planning to do that for desktop as well? I ask because on desktop, I think the modals have a max-width of 400px so I'm not sure if they have enough horizontal space to support the two buttons. We shouldn't be making that modal any larger, it should stay capped at 400px width.

@c3024
Copy link
Contributor Author

c3024 commented Oct 17, 2024

It follows the usual styling adjustments for narrow layouts on Desktop app and Web Chrome also.

Screen.Recording.2024-10-17.at.1.38.29.PM.mov

@shawnborton
Copy link
Contributor

Got it. I think that's fine given that the button labels are short enough to support two horizontal buttons. Let's just make sure it also works when in Spanish too :)

@rushatgabhane
Copy link
Member

@c3024 could you fix travel modal button. It is half in size

@c3024
Copy link
Contributor Author

c3024 commented Oct 17, 2024

@rushatgabhane

Corrected its style back to the usual style.

Screen.Recording.2024-10-17.at.6.25.31.PM.mov

@dannymcclain
Copy link
Contributor

I like the horizontal button layout on desktop + stacked on mobile. But like Shawn said, if we find that the labels get too long in Spanish or something, I think the stacked layout would still work fine on desktop too if we have to go that route.

@c3024
Copy link
Contributor Author

c3024 commented Oct 17, 2024

No problems with Spanish labels as well.

spanishNavattic.mp4

@shawnborton
Copy link
Contributor

Nice!

@rushatgabhane
Copy link
Member

rushatgabhane commented Oct 17, 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-10-17.at.23.22.12.mov
Android: mWeb Chrome
iOS: Native
Screen.Recording.2024-10-17.at.23.30.55.mov
iOS: mWeb Safari
Screen.Recording.2024-10-17.at.23.32.15.mov
MacOS: Chrome / Safari image image

invoices (for v1)

image

chats (for v1)

image
MacOS: Desktop
Screen.Recording.2024-10-17.at.23.39.02.mov

Copy link
Member

@rushatgabhane rushatgabhane left a comment

Choose a reason for hiding this comment

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

LGTM

@melvin-bot melvin-bot bot requested a review from mountiny October 17, 2024 18:03
Copy link
Contributor

@mountiny mountiny left a comment

Choose a reason for hiding this comment

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

Simple and quick changes

Copy link
Contributor

@dubielzyk-expensify dubielzyk-expensify left a comment

Choose a reason for hiding this comment

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

Checked and it all looks good from a visual standpoint.

@mountiny mountiny merged commit c3d33fc into Expensify:main Oct 18, 2024
18 checks passed
@c3024 c3024 deleted the add-navattic-tour-link-in-empty-search-modal branch October 18, 2024 03:18
@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.

Copy link
Contributor

🚀 Deployed to staging by https://github.com/mountiny in version: 9.0.51-1 🚀

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

Copy link
Contributor

🚀 Deployed to production by https://github.com/yuwenmemon in version: 9.0.51-4 🚀

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

Copy link
Contributor

🚀 Deployed to production by https://github.com/yuwenmemon in version: 9.0.51-4 🚀

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
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

7 participants