Feature: Tooltip for workspace chat #45390

tienifr · 2024-07-15T09:06:52Z

Details

Display a tooltip the first time user views the workspace chat.

Fixed Issues

$ #45046
PROPOSAL: #45046 (comment)

Tests

Log in as User A, an account that owns a workspace
Invite B, a user that does not yet have an Expensify account
Check B's email for the invitation
Open the new.expensify.com link from the email in a different browser
On A, open the workspace chat
Verify a tooltip shows over the composer's Create button saying Get started! Submit your first expense or ¡Empecemos! Presenta tu primer gasto
Press Create button
Verify the tooltip disappears (or it will automatically disappear in 5 seconds)

Verify that no errors appear in the JS console

Offline tests

NA

QA Steps

See 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

…oltip-for-gbr

tienifr · 2024-07-19T10:10:40Z

Update: I had several issues:

When I switch the report, the tooltip is not hidden and moves to some random places in the page
The tooltip position in Safari is not correct, it's always center aligned wrt the target even though the computed position values are correct

trjExpensify · 2024-07-22T15:31:38Z

@tienifr did you fix those issues or ask for help if you need it? We want to keep this PR moving. CC: @dukenv0307 as you'll have some context on this.

dukenv0307 · 2024-07-24T03:16:21Z

@tienifr Can you update the PR and let me know what's your blocker right now? Thanks

…oltip-for-workspace-chat

trjExpensify · 2024-07-29T16:04:41Z

@tienifr you have conflicts. Can you fix those and confirm this is ready for a review today?

…oltip-for-workspace-chat

melvin-bot · 2024-07-29T21:47:22Z

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

dukenv0307 · 2024-08-06T10:51:31Z

@tienifr Is it ready for review?

trjExpensify · 2024-08-06T22:00:02Z

Bump, @tienifr please confirm this is ready for re-review?

dubielzyk-expensify · 2024-08-07T06:16:12Z

Other than the bug, the videos above looked good to me!

tienifr · 2024-08-07T08:29:02Z

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

-                <View style={pointerStyle} />
-            </View>
-        </Animated.View>
+        <Portal hostName={!shouldUseOverlay ? 'modal' : undefined}>


Teleport the portal to the modal layer, otherwise, the tooltip in any modal/popover would be obscured by that modal. For example the tooltip for QAB.

tienifr · 2024-08-07T08:31:14Z

src/components/Tooltip/GenericTooltip.tsx

+            return;
+        }
+        setShouldUseOverlay(false);
+        hideTooltip();


Interacting with shouldRender prop causes the target component to re-render thus leads to flickering. I move the logic to hide tooltip from the target component (i.e. composer) to inside the tooltip itself to avoid such flickering.

tienifr · 2024-08-07T08:33:10Z

@dukenv0307 I fixed the Android bug above and also discovered several other bugs. Added explanations for them above ^. Ready for review.

dukenv0307 · 2024-08-07T10:24:27Z

@tienifr I think we should use the same logic here

…oltip-for-workspace-chat

tienifr · 2024-08-07T10:50:34Z

@dukenv0307 Thanks for the suggestions. Updated.

dukenv0307 · 2024-08-07T17:14:10Z

LGTM

deetergp

Looks good, thanks!

OSBotify · 2024-08-07T19:10:48Z

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

OSBotify · 2024-08-07T22:11:33Z

🚀 Deployed to staging by https://github.com/deetergp in version: 9.0.18-0 🚀

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

IuliiaHerets · 2024-08-09T14:31:40Z

This PR is failing for Desktop app because of issue #47169

OSBotify · 2024-08-12T10:02:46Z

🚀 Deployed to production by https://github.com/mountiny in version: 9.0.18-10 🚀

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

hungvu193 · 2025-01-14T10:22:40Z

src/pages/home/report/ReportActionCompose/ReportActionCompose.tsx

+                        }}
+                        wrapperStyle={styles.reportActionComposeTooltipWrapper}
+                        shiftHorizontal={variables.composerTooltipShiftHorizontal}
+                        shiftVertical={variables.composerTooltipShiftVertical}


On mobile safari, the viewport is scrolled when the keyboard is shown. We should also add the topOffset here to avoid this bug.

More details: #53976 (comment)

tienifr added 13 commits June 24, 2024 22:34

feature: align tooltip by anchorAlignment on web

cc1ee1f

make anchorAlignment work on native

f6c3290

Merge branch 'main' of https://github.com/tienifr/App into feature/to…

dfbda8d

…oltip-for-gbr

Merge branch 'main' of https://github.com/tienifr/App into feature/to…

404a3a7

…oltip-for-gbr

apply tooltip to lhn row

cfd72f1

Merge branch 'main' of https://github.com/tienifr/App into feature/to…

16f1bc0

…oltip-for-gbr

Merge branch 'main' of https://github.com/tienifr/App into feature/to…

73d1599

…oltip-for-gbr

add copy and icon

8353e39

Merge branch 'main' of https://github.com/tienifr/App into feature/to…

a0a183d

…oltip-for-gbr

hide tooltip when navigate

e26e63c

fix test & perf

da051d6

revert: apply tooltip to lhn row

c8829de

implement tooltip ui

5de4ac7

tienifr added 4 commits July 26, 2024 15:37

Merge branch 'main' of https://github.com/tienifr/App into feature/to…

6b8e66c

…oltip-for-workspace-chat

add nvp

578834f

hide tooltip when press add or navigate to other pages

6c3ad40

update Spanish copy

7440641

tienifr added 3 commits July 30, 2024 02:28

Merge branch 'main' of https://github.com/tienifr/App into feature/to…

84e49a1

…oltip-for-workspace-chat

dismiss tooltip

0051bf1

refactor shouldShow logic

1c9b6c8

tienifr marked this pull request as ready for review July 29, 2024 21:47

tienifr requested review from a team as code owners July 29, 2024 21:47

melvin-bot bot removed the request for review from a team July 29, 2024 21:47

melvin-bot bot requested a review from dukenv0307 July 29, 2024 21:47

fix lint

f6a013c

tienifr added 3 commits August 7, 2024 14:22

delay measure

602bec7

fix: composer flickers when tap to hide tooltip

bef2353

fix lint

4b6d7e4

tienifr commented Aug 7, 2024

View reviewed changes

tienifr added 2 commits August 7, 2024 17:45

Merge branch 'main' of https://github.com/tienifr/App into feature/to…

a79ad14

…oltip-for-workspace-chat

polish settimeout callback

d106777

fix lint

b83cb82

dukenv0307 approved these changes Aug 7, 2024

View reviewed changes

melvin-bot bot requested a review from deetergp August 7, 2024 17:14

deetergp approved these changes Aug 7, 2024

View reviewed changes

deetergp merged commit 6a6c242 into Expensify:main Aug 7, 2024
16 checks passed

github-actions bot mentioned this pull request Aug 7, 2024

Deploy Checklist: New Expensify 2024-08-07 #47006

Closed

88 tasks

This was referenced Aug 8, 2024

[HOLD for Payment 2024-09-06][$250] Navigation - black page when Navigating back from invited workspace chat #47049

Closed

Desktop - Chat - No tooltip for WS chat for a new user #47169

Closed

melvin-bot bot mentioned this pull request Aug 12, 2024

[HOLD for payment 2024-08-19] [Guided Setup Stage 3] Add the tooltip for Workspace Chat #45046

Closed

lakchote mentioned this pull request Sep 13, 2024

[Search v2.3] [App] Implement Saved Search feature #48566

Merged

71 tasks

hungvu193 reviewed Jan 14, 2025

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Feature: Tooltip for workspace chat #45390

Feature: Tooltip for workspace chat #45390

tienifr commented Jul 15, 2024 •

edited

Loading

tienifr commented Jul 19, 2024

trjExpensify commented Jul 22, 2024

dukenv0307 commented Jul 24, 2024

trjExpensify commented Jul 29, 2024

melvin-bot bot commented Jul 29, 2024

dukenv0307 commented Aug 6, 2024

trjExpensify commented Aug 6, 2024

dubielzyk-expensify commented Aug 7, 2024

tienifr Aug 7, 2024

tienifr Aug 7, 2024

tienifr commented Aug 7, 2024 •

edited

Loading

dukenv0307 commented Aug 7, 2024

tienifr commented Aug 7, 2024

dukenv0307 commented Aug 7, 2024

deetergp left a comment

OSBotify commented Aug 7, 2024

OSBotify commented Aug 7, 2024

IuliiaHerets commented Aug 9, 2024

OSBotify commented Aug 12, 2024

hungvu193 Jan 14, 2025

Feature: Tooltip for workspace chat #45390

Feature: Tooltip for workspace chat #45390

Conversation

tienifr commented Jul 15, 2024 • edited Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

tienifr commented Jul 19, 2024

trjExpensify commented Jul 22, 2024

dukenv0307 commented Jul 24, 2024

trjExpensify commented Jul 29, 2024

melvin-bot bot commented Jul 29, 2024

dukenv0307 commented Aug 6, 2024

trjExpensify commented Aug 6, 2024

dubielzyk-expensify commented Aug 7, 2024

tienifr Aug 7, 2024

Choose a reason for hiding this comment

tienifr Aug 7, 2024

Choose a reason for hiding this comment

tienifr commented Aug 7, 2024 • edited Loading

dukenv0307 commented Aug 7, 2024

tienifr commented Aug 7, 2024

dukenv0307 commented Aug 7, 2024

deetergp left a comment

Choose a reason for hiding this comment

OSBotify commented Aug 7, 2024

OSBotify commented Aug 7, 2024

IuliiaHerets commented Aug 9, 2024

OSBotify commented Aug 12, 2024

hungvu193 Jan 14, 2025

Choose a reason for hiding this comment

tienifr commented Jul 15, 2024 •

edited

Loading

tienifr commented Aug 7, 2024 •

edited

Loading