[TS migration] Migrate 'Tooltip' component to TypeScript #31544

kosmydel · 2023-11-20T12:13:26Z

Details

Fixed Issues

$ #25123
PROPOSAL: N/A

Tests

Verify that no errors appear in the JS console
On web and desktop:
- Hover the buttons with tooltips (Search button, account settings button, FAB). Verify tooltips are correctly displayed.
Verify that the app works.

Offline tests

N/A

QA Steps

Verify that no errors appear in the JS console
Tests from above.

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 approved by marketing by adding the Waiting for Copy label for a copy review on the original GH to get the correct copy.
- 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(themeColors.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 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

Screen.Recording.2023-11-28.at.15.16.53.mov

MacOS: Desktop

Screen.Recording.2023-11-28.at.15.19.32.mov

src/components/Tooltip/BaseTooltip.tsx

src/components/DisplayNames/DisplayNamesTooltipItem.tsx

src/components/Pressable/PressableWithDelayToggle.tsx

src/components/Tooltip/BaseTooltip.native.tsx

src/components/Tooltip/BaseTooltip.tsx

src/components/Tooltip/types.ts

src/types/utils/callOrReturn.ts

src/styles/getTooltipStyles.ts

src/components/Tooltip/BaseTooltip.tsx

src/components/Tooltip/TooltipRenderedOnPageBody.tsx

src/components/Tooltip/PopoverAnchorTooltip.tsx

src/components/Tooltip/BaseTooltip.tsx

src/components/Tooltip/TooltipRenderedOnPageBody.tsx

BartoszGrajdek

Let's also move BaseTooltip files into a separate folder src/components/Tooltip/BaseTooltip/....

src/components/Tooltip/BaseTooltip.native.tsx

BartoszGrajdek

LGTM!

This reverts commit 461a428.

kosmydel · 2023-12-06T09:44:04Z

Hey, I pulled the main, resolved conflicts, and had to make fix warning on native on native, as there was a warning during runtime (related to forwardRef, web version used is while native didn't).

cc @blazejkustra, @allroundexperts

allroundexperts

Approving since this is catching conflicts so fast. This is testing well and should be good to merge!

kosmydel · 2023-12-07T08:32:16Z

I've resolved conflicts, so it is ready to proceed.

allroundexperts

Got an internal engineer!

kosmydel · 2023-12-08T11:29:14Z

I've resolved conflicts once again. cc @blazejkustra @allroundexperts

mountiny · 2023-12-08T11:41:06Z

Gonna take it over here as its component with lots of conflicts to get it over the finish line

mountiny

Ok lets go, thank you for patience @kosmydel and testing thoroughly @allroundexperts

mountiny · 2023-12-08T11:44:47Z

src/components/Tooltip/types.ts

+    /** Unique key of renderTooltipContent to rerender the tooltip when one of the key changes */
+    renderTooltipContentKey?: string[];
+
+    /** passes this down to Hoverable component to decide whether to handle the scroll behaviour to show hover once the scroll ends */


NAB

Suggested change

/** passes this down to Hoverable component to decide whether to handle the scroll behaviour to show hover once the scroll ends */

/** Passes this down to Hoverable component to decide whether to handle the scroll behaviour to show hover once the scroll ends */

OSBotify · 2023-12-08T11:50:20Z

✋ 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 · 2023-12-11T10:44:25Z

🚀 Deployed to staging by https://github.com/mountiny in version: 1.4.11-0 🚀

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

OSBotify · 2023-12-13T11:09:04Z

🚀 Deployed to production by https://github.com/Julesssss in version: 1.4.11-25 🚀

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

kosmydel added 11 commits November 20, 2023 11:07

migrate Tooltip to TS

d75347f

fixes

6e99530

more fixes

9296400

fix refs

8a97ea0

remove unknown type

15d3837

refactor

0f81bb0

Change order of props in Tooltip

9248025

fix

3f1ba1f

minor changes

88f20f3

reuse some types

9c65d98

fix

542a6d3

kosmydel commented Nov 21, 2023

View reviewed changes

src/components/Tooltip/BaseTooltip.tsx Outdated Show resolved Hide resolved

Add textRef util

316fc40

blazejkustra suggested changes Nov 23, 2023

View reviewed changes

BartoszGrajdek reviewed Nov 24, 2023

View reviewed changes

src/components/Tooltip/PopoverAnchorTooltip.tsx Outdated Show resolved Hide resolved

src/components/Tooltip/BaseTooltip.tsx Outdated Show resolved Hide resolved

src/components/Tooltip/BaseTooltip.tsx Outdated Show resolved Hide resolved

kosmydel added 4 commits November 27, 2023 09:26

use children props

b401d93

address review

ac0d976

use forwardRef

cc80269

address review

bc65c46

kosmydel requested review from blazejkustra and BartoszGrajdek November 27, 2023 10:39

blazejkustra approved these changes Nov 27, 2023

View reviewed changes

src/components/Tooltip/TooltipRenderedOnPageBody.tsx Outdated Show resolved Hide resolved

src/components/Tooltip/TooltipRenderedOnPageBody.tsx Outdated Show resolved Hide resolved

BartoszGrajdek reviewed Nov 27, 2023

View reviewed changes

src/components/Tooltip/BaseTooltip.native.tsx Outdated Show resolved Hide resolved

kosmydel added 4 commits November 27, 2023 14:36

rename file

2e46aa9

cleanup

99eaf18

make props optional

8b73221

prettier

46268ac

blazejkustra approved these changes Nov 27, 2023

View reviewed changes

BartoszGrajdek approved these changes Nov 27, 2023

View reviewed changes

Merge branch 'main' into @kosmydel/ts/tooltip

802a5a6

kosmydel added 4 commits December 6, 2023 09:54

address review

1348cb8

remove forward ref

461a428

Revert "remove forward ref"

db258e3

This reverts commit 461a428.

fix warning on native

203cd81

kosmydel requested a review from blazejkustra December 6, 2023 09:44

blazejkustra approved these changes Dec 6, 2023

View reviewed changes

allroundexperts approved these changes Dec 6, 2023

View reviewed changes

Merge branch 'main' into @kosmydel/ts/tooltip

d1380a5

allroundexperts approved these changes Dec 7, 2023

View reviewed changes

melvin-bot bot requested a review from joelbettner December 7, 2023 08:53

Merge branch 'main' into @kosmydel/ts/tooltip

629907f

kosmydel requested a review from blazejkustra December 8, 2023 11:28

blazejkustra approved these changes Dec 8, 2023

View reviewed changes

allroundexperts approved these changes Dec 8, 2023

View reviewed changes

mountiny assigned kosmydel Dec 8, 2023

mountiny requested review from mountiny and removed request for joelbettner December 8, 2023 11:40

mountiny approved these changes Dec 8, 2023

View reviewed changes

mountiny merged commit 18d4b9b into Expensify:main Dec 8, 2023
18 checks passed

github-actions bot mentioned this pull request Dec 11, 2023

Deploy Checklist: New Expensify 2023-12-11 #32794

Closed

81 tasks

kosmydel deleted the @kosmydel/ts/tooltip branch December 13, 2023 10:31

melvin-bot bot mentioned this pull request Dec 13, 2023

[HOLD for payment 2023-12-20] [TS migration] Migrate 'Tooltip' component to TypeScript #25123

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[TS migration] Migrate 'Tooltip' component to TypeScript #31544

[TS migration] Migrate 'Tooltip' component to TypeScript #31544

kosmydel commented Nov 20, 2023 •

edited

Loading

BartoszGrajdek left a comment •

edited

Loading

BartoszGrajdek left a comment

kosmydel commented Dec 6, 2023

allroundexperts left a comment

kosmydel commented Dec 7, 2023

allroundexperts left a comment

kosmydel commented Dec 8, 2023

mountiny commented Dec 8, 2023

mountiny left a comment

mountiny Dec 8, 2023

OSBotify commented Dec 8, 2023

OSBotify commented Dec 11, 2023

OSBotify commented Dec 13, 2023

	/** passes this down to Hoverable component to decide whether to handle the scroll behaviour to show hover once the scroll ends */
	/** Passes this down to Hoverable component to decide whether to handle the scroll behaviour to show hover once the scroll ends */

[TS migration] Migrate 'Tooltip' component to TypeScript #31544

[TS migration] Migrate 'Tooltip' component to TypeScript #31544

Conversation

kosmydel commented Nov 20, 2023 • edited Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

BartoszGrajdek left a comment • edited Loading

Choose a reason for hiding this comment

BartoszGrajdek left a comment

Choose a reason for hiding this comment

kosmydel commented Dec 6, 2023

allroundexperts left a comment

Choose a reason for hiding this comment

kosmydel commented Dec 7, 2023

allroundexperts left a comment

Choose a reason for hiding this comment

kosmydel commented Dec 8, 2023

mountiny commented Dec 8, 2023

mountiny left a comment

Choose a reason for hiding this comment

mountiny Dec 8, 2023

Choose a reason for hiding this comment

OSBotify commented Dec 8, 2023

OSBotify commented Dec 11, 2023

OSBotify commented Dec 13, 2023

kosmydel commented Nov 20, 2023 •

edited

Loading

BartoszGrajdek left a comment •

edited

Loading