Fix tooltip for QAB doesn't show for new user by bernhardoj · Pull Request #52446 · Expensify/App

bernhardoj · 2024-11-13T05:50:55Z

Explanation of Change

We previously prevent the tooltip to show in a modal. In this PR, we hide the tooltip when a modal will show.

Fixed Issues

$ #51987
PROPOSAL: #51987 (comment)

Tests

Same as QA Steps

Verify that no errors appear in the JS console

Offline tests

Same as QA Steps

QA Steps

// TODO: These must be filled out, or the issue title must include "[No QA]."

Log in as a new user
submit a new expense to any user
Press FAB
Verify a tooltip is shown for the QAB
Verify it auto hides after 5 secs

Verify that no errors appear in the JS console

PR Author Checklist

Screenshots/Videos

Android: Native

android.mp4

Android: mWeb Chrome

android.mweb.mp4

iOS: Native

ios.mp4

iOS: mWeb Safari

ios.mweb.mp4

MacOS: Chrome / Safari

web.mp4

MacOS: Desktop

desktop.mp4

melvin-bot · 2024-11-13T05:51:00Z

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

bernhardoj · 2024-11-13T05:53:45Z

I use a different approach since the previous one fails to close the tooltip automatically. The new solution is similar to actions/Modal.ts

App/src/libs/actions/Modal.ts

Lines 13 to 24 in 7256ad6

    
           function setCloseModal(onClose: () => void) { 
        
               if (!closeModals.includes(onClose)) { 
        
                   closeModals.push(onClose); 
        
               } 
        
               return () => { 
        
                   const index = closeModals.indexOf(onClose); 
        
                   if (index === -1) { 
        
                       return; 
        
                   } 
        
                   closeModals.splice(index, 1); 
        
               }; 
        
           }

There are 2 cases we need to handle for tooltip.

Pending tooltip to show, in this case, we need to cancel the timeout
Visible/active tooltip, in this case, we need to close the tooltip

So, TooltipManager holds all the pending and active tooltip. When a modal will show, we cancel them all.

bernhardoj · 2024-11-13T05:55:20Z

src/libs/actions/Modal.ts

 function willAlertModalBecomeVisible(isVisible: boolean, isPopover = false) {
+    if (isVisible) {
+        TooltipManager.cancelPendingAndActiveTooltips();
+    }


We only cancel it in willAlertModalBecomeVisible and not in setModalVisibility because setModalVisibility is called when the modal is shown, not when the modal will show.

App/src/components/Modal/BaseModal.tsx

Lines 102 to 109 in 7256ad6

useEffect(() => {

isVisibleRef.current = isVisible;

let removeOnCloseListener: () => void;

if (isVisible) {

Modal.willAlertModalBecomeVisible(true, type === CONST.MODAL.MODAL_TYPE.POPOVER || type === CONST.MODAL.MODAL_TYPE.BOTTOM_DOCKED);

// To handle closing any modal already visible when this modal is mounted, i.e. PopoverReportActionContextMenu

removeOnCloseListener = Modal.setCloseModal(onClose);

}

App/src/components/Modal/BaseModal.tsx

Lines 131 to 136 in 7256ad6

const handleShowModal = () => {

if (shouldSetModalVisibility) {

Modal.setModalVisibility(true);

}

onModalShow();

};

Could you please add a comment in the code for this?

bernhardoj · 2024-11-13T05:56:44Z

src/libs/Navigation/AppNavigator/AuthScreens.tsx

    focus: () => {
+        TooltipManager.cancelPendingAndActiveTooltips();
        Modal.setModalVisibility(true);
    },


And because the RHP modal uses setModalVisbility, we need to manually cancel it here.

Could you please add a comment in the code for this?

rayane-d · 2024-11-15T11:20:29Z

Reviewer Checklist

I have verified the author checklist is complete (all boxes are checked off).
I verified the correct issue is linked in the ### Fixed Issues section above
I verified testing steps are clear and they cover the changes made in this PR
- I verified the steps for local testing are in the Tests section
- I verified the steps for Staging and/or Production testing are in the QA steps section
- 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)
- 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 checked that screenshots or videos are included for tests on all platforms
I included screenshots or videos for tests on all platforms
I verified tests pass on all platforms & I tested again on:
- Android: Native
- Android: mWeb Chrome
- iOS: Native
- iOS: mWeb Safari
- MacOS: Chrome / Safari
- MacOS: Desktop
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
I verified proper code patterns were followed (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 verified that this PR follows the guidelines as stated in the Review Guidelines
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)
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
If a new component is created I verified that:
- A similar component doesn't exist in the codebase
- All props are defined accurately and each prop has a /** comment above it */
- The file is named correctly
- The component has a clear name that is non-ambiguous and the purpose of the component can be inferred from the name alone
- The only data being stored in the state is data necessary for rendering and nothing else
- 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)
- 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)
- All JSX used for rendering exists in the render method
- 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
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.
I have checked off every checkbox in the PR reviewer checklist, including those that don't apply to this PR.

Screenshots/Videos

Android: Native

Screen.Recording.2024-11-23.at.12.52.34.PM.mov

Android: mWeb Chrome

Screen.Recording.2024-11-23.at.12.46.48.PM.mov

iOS: Native

Simulator.Screen.Recording.-.iPhone.15.Pro.Max.-.2024-11-23.at.12.44.50.mp4

iOS: mWeb Safari

Simulator.Screen.Recording.-.iPhone.15.Pro.Max.-.2024-11-23.at.12.46.14.mp4

MacOS: Chrome / Safari

Screen.Recording.2024-11-23.at.12.37.12.PM.mov

MacOS: Desktop

Screen.Recording.2024-11-23.at.12.35.55.PM.mov

rayane-d · 2024-11-20T15:59:40Z

src/components/Tooltip/EducationalTooltip/TooltipManager.ts

+const pendingTooltip: NodeJS.Timeout[] = [];
+const tooltipCloseCallback: Array<() => void> = [];


Suggested change

const pendingTooltip: NodeJS.Timeout[] = [];

const tooltipCloseCallback: Array<() => void> = [];

const pendingTooltips = new Set<NodeJS.Timeout>();

const activeTooltips = new Set<() => void>();

rayane-d · 2024-11-20T16:00:13Z

src/components/Tooltip/EducationalTooltip/TooltipManager.ts

+    pendingTooltip.push(timeout);
+    return () => {
+        const index = pendingTooltip.indexOf(timeout);
+        pendingTooltip.splice(index, 1);
+    };


Suggested change

pendingTooltip.push(timeout);

return () => {

const index = pendingTooltip.indexOf(timeout);

pendingTooltip.splice(index, 1);

};

pendingTooltips.add(timeout);

return () => {

pendingTooltips.delete(timeout);

};

rayane-d · 2024-11-20T16:00:33Z

src/components/Tooltip/EducationalTooltip/TooltipManager.ts

+    tooltipCloseCallback.push(closeCallback);
+    return () => {
+        const index = tooltipCloseCallback.indexOf(closeCallback);
+        tooltipCloseCallback.splice(index, 1);
+    };


Suggested change

tooltipCloseCallback.push(closeCallback);

return () => {

const index = tooltipCloseCallback.indexOf(closeCallback);

tooltipCloseCallback.splice(index, 1);

};

activeTooltips.add(closeCallback);

return () => {

activeTooltips.delete(closeCallback);

};

rayane-d · 2024-11-20T16:00:57Z

src/components/Tooltip/EducationalTooltip/TooltipManager.ts

+    while (pendingTooltip.length > 0) {
+        clearTimeout(pendingTooltip.pop());
+    }
+    while (tooltipCloseCallback.length > 0) {
+        tooltipCloseCallback.pop()?.();
+    }


Suggested change

while (pendingTooltip.length > 0) {

clearTimeout(pendingTooltip.pop());

}

while (tooltipCloseCallback.length > 0) {

tooltipCloseCallback.pop()?.();

}

pendingTooltips.forEach((timeout) => clearTimeout(timeout));

pendingTooltips.clear();

activeTooltips.forEach((closeCallback) => closeCallback());

activeTooltips.clear();

rayane-d · 2024-11-20T16:07:15Z

src/components/Tooltip/EducationalTooltip/BaseEducationalTooltip.tsx

-        };
-    }, [shouldRender]);
+    const removeActiveTooltipRef = useRef(() => {});
+    const removePendingToltipRef = useRef(() => {});


Suggested change

const removePendingToltipRef = useRef(() => {});

const removePendingTooltipRef = useRef(() => {});

rayane-d · 2024-11-20T16:26:56Z

src/components/Tooltip/EducationalTooltip/TooltipManager.ts

+const pendingTooltip: NodeJS.Timeout[] = [];
+const tooltipCloseCallback: Array<() => void> = [];


Suggested change

const pendingTooltip: NodeJS.Timeout[] = [];

const tooltipCloseCallback: Array<() => void> = [];

// We store the timeouts for each pending tooltip here. We're using the timeout because when a tooltip is used inside an animated view (e.g., popover), we need to wait for the animation to finish before measuring content.

const pendingTooltipsTimouts: NodeJS.Timeout[] = [];

// We store the callback for closing a tooltip here.

const closeActiveTooltipCallbacks: Array<() => void> = [];

bernhardoj · 2024-11-21T05:06:25Z

Addressed all

rayane-d

LGTM and tests well 👍

pecanoro

Small suggestion

src/components/Tooltip/EducationalTooltip/TooltipManager.ts

OSBotify · 2024-11-26T15:43:11Z

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

github-actions · 2024-11-26T16:40:33Z

🚀 Deployed to staging by https://github.com/pecanoro in version: 9.0.67-0 🚀

platform	result
🤖 android 🤖	false ❌
🖥 desktop 🖥	success ✅
🍎 iOS 🍎	success ✅
🕸 web 🕸	success ✅
🤖🔄 android HybridApp 🤖🔄	success ✅
🍎🔄 iOS HybridApp 🍎🔄	success ✅

github-actions · 2024-11-28T14:21:36Z

🚀 Deployed to production by https://github.com/mountiny in version: 9.0.67-9 🚀

platform	result
🤖 android 🤖	skipped 🚫
🖥 desktop 🖥	success ✅
🍎 iOS 🍎	success ✅
🕸 web 🕸	success ✅
🤖🔄 android HybridApp 🤖🔄	failure ❌
🍎🔄 iOS HybridApp 🍎🔄	failure ❌

fix tooltip for QAB doesn't show for new user

1051bda

bernhardoj requested a review from a team as a code owner November 13, 2024 05:50

melvin-bot bot requested a review from rayane-d November 13, 2024 05:50

melvin-bot bot removed the request for review from a team November 13, 2024 05:51

bernhardoj commented Nov 13, 2024

View reviewed changes

bernhardoj added 2 commits November 13, 2024 13:58

lint

da87273

lint

3b05518

rayane-d suggested changes Nov 20, 2024

View reviewed changes

bernhardoj added 5 commits November 21, 2024 12:54

Merge branch 'main' into fix/51987-missing-tooltip-for-qab

98bc0ea

add comment

c3efa31

use set

7538b46

typo

2fc61f7

add more comment

e6ed429

rayane-d approved these changes Nov 23, 2024

View reviewed changes

melvin-bot bot requested a review from pecanoro November 23, 2024 12:02

pecanoro requested changes Nov 25, 2024

View reviewed changes

src/components/Tooltip/EducationalTooltip/TooltipManager.ts Show resolved Hide resolved

add new line

8aec50b

pecanoro approved these changes Nov 26, 2024

View reviewed changes

pecanoro merged commit 09edde6 into Expensify:main Nov 26, 2024

github-actions bot mentioned this pull request Nov 26, 2024

Deploy Checklist: New Expensify 2024-11-26 #53142

Closed

75 tasks

melvin-bot bot mentioned this pull request Nov 28, 2024

[HOLD for payment 2024-12-05] [$250] First QAB missing tooltip for new user #51987

Closed

8 tasks

rayane-d mentioned this pull request Nov 29, 2024

fix: tooltip show over dialog #49682

Merged

50 tasks

	useEffect(() => {
	isVisibleRef.current = isVisible;
	let removeOnCloseListener: () => void;
	if (isVisible) {
	Modal.willAlertModalBecomeVisible(true, type === CONST.MODAL.MODAL_TYPE.POPOVER \|\| type === CONST.MODAL.MODAL_TYPE.BOTTOM_DOCKED);
	// To handle closing any modal already visible when this modal is mounted, i.e. PopoverReportActionContextMenu
	removeOnCloseListener = Modal.setCloseModal(onClose);
	}

	const handleShowModal = () => {
	if (shouldSetModalVisibility) {
	Modal.setModalVisibility(true);
	}
	onModalShow();
	};

		const pendingTooltip: NodeJS.Timeout[] = [];
		const tooltipCloseCallback: Array<() => void> = [];

	const removePendingToltipRef = useRef(() => {});
	const removePendingTooltipRef = useRef(() => {});

-const pendingTooltip: NodeJS.Timeout[] = [];
-const tooltipCloseCallback: Array<() => void> = [];
+// We store the timeouts for each pending tooltip here. We're using the timeout because when a tooltip is used inside an animated view (e.g., popover), we need to wait for the animation to finish before measuring content.
+const pendingTooltipsTimouts: NodeJS.Timeout[] = [];
+// We store the callback for closing a tooltip here.
+const closeActiveTooltipCallbacks: Array<() => void> = [];

Conversation

bernhardoj commented Nov 13, 2024

Explanation of Change

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

Uh oh!

melvin-bot bot commented Nov 13, 2024

Uh oh!

bernhardoj commented Nov 13, 2024

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

rayane-d commented Nov 15, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Reviewer Checklist

Screenshots/Videos

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

bernhardoj commented Nov 21, 2024

Uh oh!

rayane-d left a comment

Choose a reason for hiding this comment

Uh oh!

pecanoro left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

OSBotify commented Nov 26, 2024

Uh oh!

github-actions bot commented Nov 26, 2024

Uh oh!

github-actions bot commented Nov 28, 2024

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

rayane-d commented Nov 15, 2024 •

edited

Loading