Web - Saved search - Tooltip reappears after it disappears

[lanitochka17]

If you haven’t already, check out our contributing guidelines for onboarding and email contributors@expensify.com to request to join our Slack channel!

---

Version Number: 9.0.41-1
Reproducible in staging?: Y
Reproducible in prodaction?: N
If this was caught during regression testing, add the test name, ID and link from TestRail: N/A
Email or phone of affected tester (no customers): applausetester+kh010901@applause.expensifail.com
Issue reported by: Applause - Internal Team

Action Performed:

1. Go to staging.new.expensify.com
2. Log in with a new account
3. Go to Search
4. Click Filters
5. Add some filters
6. Click Save search
7. Note that tooltip appears on the saved search
8. Click 3-dot menu > Rename
9. Rename the search and save it

Expected Result:

The tooltip should not reappear after it disappears

Actual Result:

The tooltip reappears after it disappears

Workaround:

Unknown

Platforms:

Which of our officially supported platforms is this issue occurring on?

• Android: Native
• Android: mWeb Chrome
• iOS: Native
• iOS: mWeb Safari
• MacOS: Chrome / Safari
• MacOS: Desktop

Screenshots/Videos

Add any screenshot/video evidence

Bug6617794_1727466826401.20240928_035109.mp4

View all open jobs on GitHub

[melvin-bot]

Triggered auto assignment to @blimpich (DeployBlockerCash), see https://stackoverflowteams.com/c/expensify/questions/9980/ for more details.

[github-actions]

👋 Friendly reminder that deploy blockers are time-sensitive ⏱ issues! Check out the open `StagingDeployCash` deploy checklist to see the list of PRs included in this release, then work quickly to do one of the following:

1. Identify the pull request that introduced this issue and revert it.
2. Find someone who can quickly fix the issue.
3. Fix the issue yourself.

[lanitochka17]

We think that this bug might be related to #wave-control

[Krishna2323]

Edited by proposal-police: This proposal was edited at 2024-09-27 22:48:30 UTC.

Proposal


Offending PR: #49682

Please re-state the problem that we are trying to solve in this issue.

Web - Saved search - Tooltip reappears after it disappears

What is the root cause of that problem?

We aren't calling onHideTooltip?.(); when tooltip is closed when modal is opened.

App/src/components/Tooltip/EducationalTooltip/BaseEducationalTooltip.tsx

Lines 41 to 51 in 71db3f1

	// If the modal is open, hide the tooltip immediately and clear the timeout
	if (!shouldShow) {
	hideTooltipRef.current();
	return;
	}
	// Automatically hide tooltip after 5 seconds if shouldAutoDismiss is true
	const timerID = setTimeout(() => {
	hideTooltipRef.current?.();
	onHideTooltip?.();
	}, 5000);

What changes do you think we should make in order to solve the problem?


• We should call onHideTooltip?.(); after hideTooltipRef.current();.

App/src/components/Tooltip/EducationalTooltip/BaseEducationalTooltip.tsx

Lines 41 to 45 in 71db3f1

	// If the modal is open, hide the tooltip immediately and clear the timeout
	if (!shouldShow) {
	hideTooltipRef.current();
	return;
	}

• We can also call onHideTooltip?.(); in the cleanup function below.
  

  App/src/components/Tooltip/EducationalTooltip/BaseEducationalTooltip.tsx

  Lines 24 to 33 in 71db3f1

  	useEffect(
  	() => () => {
  	if (!hideTooltipRef.current) {
  	return;
  	}
  	hideTooltipRef.current();
  	},
  	[],
  	);

What alternative solutions did you explore? (Optional)

• We can call onHideTooltip(); inside the useEffect below.
  

  App/src/components/Tooltip/GenericTooltip.tsx

  Lines 124 to 145 in 71db3f1

  	/**
  	* Hide the tooltip in an animation.
  	*/
  	const hideTooltip = useCallback(() => {
  	animation.current.stopAnimation();
  	if (TooltipSense.isActive() && !isTooltipSenseInitiator.current) {
  	animation.current.setValue(0);
  	} else {
  	// Hide the first tooltip which initiated the TooltipSense with animation
  	isTooltipSenseInitiator.current = false;
  	Animated.timing(animation.current, {
  	toValue: 0,
  	duration: 140,
  	useNativeDriver: false,
  	}).start();
  	}
  	TooltipSense.deactivate();
  	setIsVisible(false);
  	}, []);

Result

[blimpich]

@Krishna2323 since this is marked as a deploy blocker you need to identify what caused the regression in the first place. I don't consider the proposal complete without that.

[Krishna2323]

@blimpich sorry, I knew that but forgot to add that in the proposal.

Offending PR: #49682

[blimpich]

In order for me to mark this as external I would want (A) the original contributor and C+ to not be reachable (B) the original PR for some reason shouldn't be reverted because it'll cause more problems then it'll solve and (C) the problem is urgent enough that I don't want to wait for the original contributor to get around to it.

For this issue A is true but B and C are not. I think this problem is minor enough that we can demote it and make it follow up work for people who worked on the PR who caused the regression. Not worth reverting over a slightly buggy tooltip IMO.

cc: @luacmartins @daledah @dukenv0307

[melvin-bot]

Triggered auto assignment to @VictoriaExpensify (Bug), see https://stackoverflow.com/c/expensify/questions/14418 for more details. Please add this bug to a GH project, as outlined in the SO.

[dukenv0307]

@daledah Pls raise the PR, I think we just need to clear the timeout (second one)

[daledah]

@dukenv0307 Here's the PR

[dukenv0307]

@blimpich @luacmartins I want to confirm the expectation here

The tooltip should not reappear after it disappears

Should we dismiss the tooltip forever when users open the modal when the tooltip is open? If not so, we can see the tooltip re-appear when all modals are hide, then it'll be removed after 5s

[luacmartins]

Should we dismiss the tooltip forever when users open the modal when the tooltip is open

IMO we should do this. Left a comment on the PR.