Feature: Tooltip for GBR

[tienifr]

Details

This PR implements customized tooltip alignments and adds it to GBR from Concierge DM when a user first signs in.

Fixed Issues

$ #42218
PROPOSAL:

Tests

[Native & mWeb only]

1. Login with a completely new account
2. Complete the onboarding flow
3. Verify a tooltip shows over Concierge chat saying Get started here!

• 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)
• 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: mWeb Chrome

iOS: Native

iOS: mWeb Safari

MacOS: Chrome / Safari

MacOS: Desktop

[trjExpensify]

@tienifr can you provide an update, please?

[tienifr]

@trjExpensify I'm actively working on this, the Slack discussion with team did give a hint about stacking mechanism but I still found no working solution. Odd thing is this only happens with FlashList but not other lists (FlatList, SelectionList...). I'm researching @shopify/flash-list source code to investigate. Expect to find root cause today.

[trjExpensify]

@trjExpensify I'm actively working on this, the Slack discussion with team did give a hint about stacking mechanism but I still found no working solution. Odd thing is this only happens with FlashList but not other lists (FlatList, SelectionList...). I'm researching @shopify/flash-list source code to investigate. Expect to find root cause today.

Thanks for the update. Did you get to the root cause?

[tienifr]

Update: Root cause is that ProgressiveListView from recyclerlistview renders one list item at a time. The later item will have higher order in the stack than the previous one, which means it would obscure the previous one. That's why when we use inverted list, the problem never happens because the list is rendered from bottom up. However, as per my observation, the order of rendering is unknown and not always deterministic (random). I wonder if we somehow can config the list so that the rendering order is deterministic and the row with the tooltip will render last in the list so no other items can obscure it. Next steps to investigate:

1. The render order of the list items
2. Enforce a specific list item to render last

[trjExpensify]

@dukenv0307 can you weigh in here and help move this along? Thanks!

[trjExpensify]

@tienifr you have conflicts now. Please address them today, thanks!

[dukenv0307]

@trjExpensify Sorry, I think it's just a draft PR. BTW, I don't really understand the bug we're facing, can you elaborate more @tienifr?

[trjExpensify]

Yeah it is, @dukenv0307. But I was wondering if you could offer some guidance or collaborate to overcome whatever is preventing us from putting this into review.

I don't really understand the bug we're facing, can you elaborate more @tienifr?

This is a great question. Please share where you're now stuck, @tienifr. 👍

[trjExpensify]

@tienifr once again, requesting an update here please. What's your ETA to have the PR in review?

[tienifr]

I did ask for support from @dukenv0307 through Slack DM so we could speed things up. He did gave me some hints about configuring the zIndex just like what we did here but it didn't work either. Give me today so I could get the PR ready.

[trjExpensify]

How did it go?

[dukenv0307]

@tienifr Did you try CellRendererComponent

it worked well on my side

[trjExpensify]

@tienifr can you prioritising the above today?

[melvin-bot]

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

[trjExpensify]

The Web PR is on prod as of like 10mins ago.

[tienifr]

I fixed the position bug, pls check again @dukenv0307

[dukenv0307]

@tienifr lint failed

[tienifr]

@dukenv0307 Fixed

[dukenv0307]

@tienifr I think we should remove the tooltip after the first time users dismiss it cc @shawnborton @dannymcclain

[dukenv0307]

Currently, it's open whenever users back to LHN

[dubielzyk-expensify]

Yeah we want this to be a one-time thing. If a user dismissed it, then it should never re-appear

[tienifr]

@dukenv0307 Fixed. Pls check again

[dukenv0307]

@tienifr Position works failed on Android native

[dukenv0307]

test well, but we got the lint failed again @tienifr

[melvin-bot]

We did not find an internal engineer to review this PR, trying to assign a random engineer to #42218 as well as to this PR... Please reach out for help on Slack if no one gets assigned!

[grgia]

Quick question, otherwise mostly LGTM

[OSBotify]

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

[paultsimura]

@tienifr @dukenv0307 please check this out. It seems like this PR caused a regression:

Here, we call the renderTooltipContent() if it's present:

App/src/components/Tooltip/BaseGenericTooltip/index.tsx

Lines 96 to 98 in c666296

	if (renderTooltipContent) {
	content = <View ref={viewRef(contentRef)}>{renderTooltipContent()}</View>;
	} else {

Before this PR, we wouldn't render the at all if the shouldRender was false inside the EducationalTooltip. Now, we render it but don't show it. It results in renderTooltipContent() being called even if the tooltip is not shown.

I guess this is happening because the BaseGenericTooltip element is hidden after the first render, not destroyed. Therefore the renderTooltipContent() is called every time there is a window resize.

[dukenv0307]

@paultsimura @tienifr

Now, we render it but don't show it

We decide to do that to prevent the blink problem when the tooltip hides

Therefore the renderTooltipContent() is called every time there is a window resize.

Can we fix it by useMemo/useCallback

[paultsimura]

It's preferable that we make sure the renderTooltipContent() is not called at all unless the tooltip is displayed.