Skip to content

[Hold #54924] Show Product tooltip for Workspace participant on create expense#56041

Closed
parasharrajat wants to merge 15 commits intoExpensify:mainfrom
parasharrajat:parasharrajat/tooltip
Closed

[Hold #54924] Show Product tooltip for Workspace participant on create expense#56041
parasharrajat wants to merge 15 commits intoExpensify:mainfrom
parasharrajat:parasharrajat/tooltip

Conversation

@parasharrajat
Copy link
Member

@parasharrajat parasharrajat commented Jan 30, 2025

Explanation of Change

Fixed Issues

$ #55558
PROPOSAL: #55558 (comment)

Tests

  1. Login with a new user.
  2. Click fab to create a expense.
  3. Add amount or scan a receipt or create a distance.
  4. Click next to go to participant screen.
  5. Notice a tooltip is shown to the first workspace in the participant list.
  • 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: 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 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.ts 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.
  • I added unit tests for any new feature or bug fix in this PR to help automatically prevent regressions in this user flow.
  • 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
30.01.2025_19.29.07_REC.mp4
Android: mWeb Chrome
30.01.2025_19.30.13_REC.mp4
iOS: Native
30.01.2025_19.18.09_REC.mp4
iOS: mWeb Safari
30.01.2025_19.19.25_REC.mp4
MacOS: Chrome / Safari
30.01.2025_19.08.49_REC.mp4
MacOS: Desktop
30.01.2025_19.31.01_REC.mp4

@parasharrajat parasharrajat marked this pull request as ready for review January 30, 2025 14:01
@parasharrajat parasharrajat requested a review from a team as a code owner January 30, 2025 14:01
@melvin-bot melvin-bot bot requested review from hoangzinh and removed request for a team January 30, 2025 14:01
@melvin-bot
Copy link

melvin-bot bot commented Jan 30, 2025

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

@parasharrajat
Copy link
Member Author

parasharrajat commented Jan 30, 2025

@hoangzinh Looks like we don't need to manage the first-time submitter logic based on the discussion on the issue.

Also, When you scroll the page, the tooltip does not move along. I think there was an issue for this already on the app. So that should solve it too. But I believe that is out of scope of this PR as we will have to make change to the tooltips which will affect all tooltips in the app. #54924

What do you think?

@hoangzinh
Copy link
Contributor

Also, When you scroll the page, the tooltip does not move along. I think there was an issue for this already on the app. So that should solve it too. But I believe that is out of scope of this PR as we will have to make change to the tooltips which will affect all tooltips in the app.

Yes, I agree @parasharrajat

@hoangzinh
Copy link
Contributor

I think we should auto-dismiss the tooltip if a user submits an expense after seeing it. So next times, it won't show again. What do you think?

Screen.Recording.2025-01-31.at.15.09.27.mov

@hoangzinh
Copy link
Contributor

It seems we need to update API DismissProductTraining to accept a new tooltip key name

Screenshot 2025-01-31 at 15 13 05

@hoangzinh
Copy link
Contributor

hoangzinh commented Jan 31, 2025

@parasharrajat can you also put a link into this PR checklist? Thank you

If any non-english text was added/modified, I used JaimeGPT to get English > Spanish translation. I then posted it in #expensify-open-source and it was approved by an internal Expensify engineer. Link to Slack message:

@parasharrajat
Copy link
Member Author

I was OOO. I will catch up soon with this one.

@hoangzinh
Copy link
Contributor

hoangzinh commented Feb 5, 2025

@parasharrajat Do you have a timeframe on when PR is ready for next review? Thank you.

@parasharrajat
Copy link
Member Author

May be today or tomorrow.

@parasharrajat
Copy link
Member Author

I think we should auto-dismiss the tooltip if a user submits an expense after seeing it. So next times, it won't show again. What do you think?

Screen.Recording.2025-01-31.at.15.09.27.mov

Can you confirm this on the issue with the team?

@parasharrajat
Copy link
Member Author

It seems we need to update API DismissProductTraining to accept a new tooltip key name

Screenshot 2025-01-31 at 15 13 05

This needs a backend change. cc: @stitesExpensify

@stitesExpensify
Copy link
Contributor

stitesExpensify commented Feb 6, 2025

This needs a backend change.

👍 Just put a backend PR here. I'll update here when it's deployed

@parasharrajat
Copy link
Member Author

@hoangzinh Can you please remind me what is next here?

@hoangzinh
Copy link
Contributor

I think we're waiting BE API here then retest this PR

@parasharrajat
Copy link
Member Author

@stitesExpensify Is the Backend PR merged?

@stitesExpensify
Copy link
Contributor

Yes it is on production!

Copy link
Contributor

@stitesExpensify stitesExpensify left a comment

Choose a reason for hiding this comment

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

lgtm

@parasharrajat
Copy link
Member Author

Bump @stitesExpensify

1 similar comment
@parasharrajat
Copy link
Member Author

Bump @stitesExpensify

Copy link
Contributor

@stitesExpensify stitesExpensify left a comment

Choose a reason for hiding this comment

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

Sorry, I was OOO last week. Everything looks good to me but there are conflicts now :/

@parasharrajat
Copy link
Member Author

Looks like there are new conflicting changes and we will have to retest everything from start....

@parasharrajat
Copy link
Member Author

parasharrajat commented Feb 25, 2025

@hoangzinh Can you please retest this, there were new tooltips added in #56759. Can you please check that those are not affecting ours or vice-versa?

@parasharrajat
Copy link
Member Author

My tests passed. I noticed a a global issue with tooltip that I will report separately.

]}
/>
{(hovered?: boolean) => (
<EducationalTooltip
Copy link
Contributor

Choose a reason for hiding this comment

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

It's weird that we have 2 nested EducationalTooltip here. @parasharrajat

Copy link
Member Author

Choose a reason for hiding this comment

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

Yes, because there are two tooltips we need to show. Do you have any suggestion on how can we handle this?

I can refactor this to keep one EducationalTooltip and decide to show the one based on the context values. But that will still keep two useProductTrainingContext.

Copy link
Contributor

Choose a reason for hiding this comment

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

My initial idea is to pass either WORKSPACE_EXPENSE_SUBMIT or SCAN_TEST_TOOLTIP_MANAGER tooltip here

shouldRender={shouldShowProductTrainingTooltip}
renderTooltipContent={renderProductTrainingTooltip}

Copy link
Member Author

Choose a reason for hiding this comment

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

How will we determine which one to show here?

Copy link
Member Author

Choose a reason for hiding this comment

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

Updated, check now.

@parasharrajat parasharrajat requested a review from a team as a code owner February 25, 2025 12:05
@shawnborton
Copy link
Contributor

Is it possible to hide the tooltip during scroll, and then make it reappear when the user is done scrolling? Otherwise this feels a bit awkward:
CleanShot 2025-02-25 at 09 08 10@2x

@parasharrajat
Copy link
Member Author

Yeah, We discussed this earlier #56041 (comment). #54924 will solve that for us.

@parasharrajat
Copy link
Member Author

parasharrajat commented Feb 26, 2025

I noticed that scrolling the participant list up after scrolling down a few times, hide the tooltip.

Are we solving this issue somewhere? It is a global issue with tooltips I believe, I can reproduce the same problem with #56759.

IMO, tooltips were never designed to work in a list environment where there are multiple instances of the same tooltips but only a few are active.

I have a solution but I am not sure whether that will work fine everywhere. We can work on this as a separate issue and I can create a PR for the same.

I would say we hold this until #54924 is done.

@parasharrajat parasharrajat changed the title Show Product tooltip for Workspace participant on create expense [Hold #54924] Show Product tooltip for Workspace participant on create expense Feb 26, 2025
@hoangzinh
Copy link
Contributor

I also agree that we should hold off on #54924 because we also apply this tooltip for existing users (who might have a long list of recipients)

@parasharrajat
Copy link
Member Author

Not needed for now.

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.

4 participants