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

$ https://github.com/Expensify/App/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!

• [x] Verify that no errors appear in the JS console

Offline tests

NA

QA Steps

Same as Tests

• [x] Verify that no errors appear in the JS console

PR Author Checklist

• [x] I linked the correct issue in the ### Fixed Issues section above
• [x] I wrote clear testing steps that cover the changes made in this PR
  • [x] I added steps for local testing in the Tests section
  • [x] I added steps for the expected offline behavior in the Offline steps section
  • [x] I added steps for Staging and/or Production testing in the QA steps section
  • [x] I added steps to cover failure scenarios (i.e. verify an input displays the correct error message if the entered data is not correct)
  • [x] 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)
  • [x] 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).
• [x] I included screenshots or videos for tests on all platforms
• [x] I ran the tests on all platforms & verified they passed on:
  • [x] Android: Native
  • [x] Android: mWeb Chrome
  • [x] iOS: Native
  • [x] iOS: mWeb Safari
  • [x] MacOS: Chrome / Safari
  • [x] MacOS: Desktop
• [x] 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)
• [x] I followed proper code patterns (see Reviewing the code)
  • [x] 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)
  • [x] I verified that the left part of a conditional rendering a React component is a boolean and NOT a string, e.g. myBool && <MyComponent />.
  • [x] I verified that comments were added to code that is not self explanatory
  • [x] 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.
  • [x] I verified any copy / text shown in the product is localized by adding it to src/languages/* files and using the translation method
    • [x] 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:
  • [x] I verified all numbers, amounts, dates and phone numbers shown in the product are using the localization methods
  • [x] 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)
  • [x] 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.
  • [x] I verified the JSDocs style guidelines (in STYLE.md) were followed
• [x] If a new code pattern is added I verified it was agreed to be used by multiple Expensify engineers
• [x] I followed the guidelines as stated in the Review Guidelines
• [x] 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)
• [x] I verified all code is DRY (the PR doesn't include any logic written more than once, with the exception of tests)
• [x] 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
• [x] I verified that if a function's arguments changed that all usages have also been updated correctly
• [x] If any new file was added I verified that:
  • [x] 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
• [x] If a new CSS style is added I verified that:
  • [x] A similar style doesn't already exist
  • [x] The style can't be created with an existing StyleUtils function (i.e. StyleUtils.getBackgroundAndBorderStyle(theme.componentBG))
• [x] 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.
• [x] 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)
• [x] 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.
• [x] 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.
• [x] 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:
  • [x] I verified that all the inputs inside a form are aligned with each other.
  • [x] I added Design label and/or tagged @Expensify/design so the design team can review the changes.
• [x] 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.
• [x] 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[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]

[dubielzyk-expensify]

I would ideally like for it to point to the avatar vs the pin icon. Is that doable? cc @Expensify/design

[dukenv0307]

I think we should speed up this PR first

[tienifr]

Yeah basically they have same core implementation.

[tienifr]

Holding this one for https://github.com/Expensify/App/pull/45390 since they basically have same implementation and requirements. Merging that one resolves almost 80% of this PR work.

[trjExpensify]

With #45390 merged, can we fix up these conflicts and get Duke reviewing?

[dukenv0307]

Seem like the way you use navigation is incorrect @tienifr

[trjExpensify]

@tienifr can you put this in review today?

[tienifr]

Yes everything works perfectly. I'm resolving all the failed checks above ^

[dukenv0307]

@tienifr Pls re-test on all platforms

[dukenv0307]

Reviewer Checklist

• [x] I have verified the author checklist is complete (all boxes are checked off).
• [x] I verified the correct issue is linked in the ### Fixed Issues section above
• [x] I verified testing steps are clear and they cover the changes made in this PR
  • [x] I verified the steps for local testing are in the Tests section
  • [x] I verified the steps for Staging and/or Production testing are in the QA steps section
  • [x] 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)
  • [x] 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)
• [x] I checked that screenshots or videos are included for tests on all platforms
• [x] I included screenshots or videos for tests on all platforms
• [x] I verified tests pass on all platforms & I tested again on:
  • [x] Android: Native
  • [x] Android: mWeb Chrome
  • [x] iOS: Native
  • [x] iOS: mWeb Safari
  • [x] MacOS: Chrome / Safari
  • [x] MacOS: Desktop
• [x] 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
• [x] I verified proper code patterns were followed (see Reviewing the code)
  • [x] 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).
  • [x] I verified that the left part of a conditional rendering a React component is a boolean and NOT a string, e.g. myBool && <MyComponent />.
  • [x] I verified that comments were added to code that is not self explanatory
  • [x] 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.
  • [x] I verified any copy / text shown in the product is localized by adding it to src/languages/* files and using the translation method
  • [x] I verified all numbers, amounts, dates and phone numbers shown in the product are using the localization methods
  • [x] 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)
  • [x] 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.
  • [x] I verified the JSDocs style guidelines (in STYLE.md) were followed
• [x] If a new code pattern is added I verified it was agreed to be used by multiple Expensify engineers
• [x] I verified that this PR follows the guidelines as stated in the Review Guidelines
• [x] 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)
• [x] I verified all code is DRY (the PR doesn't include any logic written more than once, with the exception of tests)
• [x] 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
• [x] If a new component is created I verified that:
  • [x] A similar component doesn't exist in the codebase
  • [x] All props are defined accurately and each prop has a /** comment above it */
  • [x] The file is named correctly
  • [x] The component has a clear name that is non-ambiguous and the purpose of the component can be inferred from the name alone
  • [x] The only data being stored in the state is data necessary for rendering and nothing else
  • [x] 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)
  • [x] 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)
  • [x] All JSX used for rendering exists in the render method
  • [x] 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
• [x] If any new file was added I verified that:
  • [x] 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
• [x] If a new CSS style is added I verified that:
  • [x] A similar style doesn't already exist
  • [x] The style can't be created with an existing StyleUtils function (i.e. StyleUtils.getBackgroundAndBorderStyle(theme.componentBG)
• [x] 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.
• [x] 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)
• [x] 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.
• [x] 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.
• [x] 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:
  • [x] I verified that all the inputs inside a form are aligned with each other.
  • [x] I added Design label and/or tagged @Expensify/design so the design team can review the changes.
• [x] 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.
• [x] 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.
• [x] 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: mWeb Chrome

https://github.com/user-attachments/assets/5557eb8e-5d08-47ee-ac47-f326b305d4dd

iOS: Native

https://github.com/user-attachments/assets/d18d43a2-0835-4379-adf2-819bb40b4aa5

iOS: mWeb Safari

https://github.com/user-attachments/assets/049b4900-28fb-4201-b5b5-a71837298fea

MacOS: Chrome / Safari

MacOS: Desktop

https://github.com/user-attachments/assets/1c7e0a11-5bd4-4ecb-b0f7-7341c05889ed

[dukenv0307]

@trjExpensify We faced with the issue about nvp_isFirstTimeNewExpensifyUser. Waiting for responses...

[dukenv0307]

@tienifr Pls hold this PR for BE bug

[tienifr]

The BE bug is fixed, pls check again @dukenv0307

[dukenv0307]

@tienifr I found the bug on safari when the tooltip position is not correct. Can you pls test again?

[trjExpensify]

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

[tienifr]

I fixed the position bug, pls check again @dukenv0307