GPS tooltips still appear when starting GPS after log out and login again

[jponikarchuk]

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: 80540
Reproducible in staging?: Yes
Reproducible in production?: Yes
If this was caught during regression testing, add the test name, ID and link from BrowserStack: #80351
Email or phone of affected tester (no customers): Expensifail account
Issue reported by: Applause Internal Team
Bug source: Pull Request QA execution
Device used: Android 13 / Xiaomi Poco F5, iOS 15.8.3 / iPhone 7 Plus
App Component: Other

Action Performed:

1. Launch the hybrid app and login using Expensifail account
2. FAB > Track Distance > GPS tab
3. Tap the Start GPS trip (allow the location permission flow if appear)
4. Wait for start address to appear
   Verify that it also shows the GPS tooltip
5. Close the GPS tooltip
6. Stop the trip and log out
7. Log in again and FAB > Track Distance > GPS tab
8. Tap the Start GPS trip

Expected Result:

Stop the trip and log out, log in again and check that after starting the trip and showing the start address there is no tooltip

Actual Result:

GPS tooltips still appear when starting GPS after log out and login again

Workaround:

Unknown

Platforms:

• Android: App
• Android: mWeb Chrome
• iOS: App
• iOS: mWeb Safari
• iOS: mWeb Chrome
• Windows: Chrome
• MacOS: Chrome / Safari

Screenshots/Videos

1.mp4

View all open jobs on GitHub

Issue Owner

Current Issue Owner: @brianlee-expensify

[melvin-bot]

Triggered auto assignment to Contributor-plus team member for initial proposal review - @sobitneupane (External)

[melvin-bot]

Triggered auto assignment to @brianlee-expensify (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.

[MobileMage]

Proposal

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

When a user dismisses the GPS tooltip by clicking the X button, then logs out and logs back in, the GPS tooltip incorrectly appears again when starting a new GPS trip. The expected behavior is that once dismissed, the tooltip should never appear again for that user, even across login sessions.

What is the root cause of that problem?

The root cause is that the shouldTooltipBeVisible function in ProductTrainingContext/index.tsx does not wait for the NVP_DISMISSED_PRODUCT_TRAINING data to finish loading from the server before making the visibility decision.

Looking at the code at

App/src/components/ProductTrainingContext/index.tsx

Line 80 in 71844e9

const [dismissedProductTraining] = useOnyx(ONYXKEYS.NVP_DISMISSED_PRODUCT_TRAINING, {canBeMissing: true});

And the shouldTooltipBeVisible function at

App/src/components/ProductTrainingContext/index.tsx

Lines 129 to 182 in 71844e9

	const shouldTooltipBeVisible = useCallback(
	(tooltipName: ProductTrainingTooltipName) => {
	if (isLoadingOnyxValue(isOnboardingCompletedMetadata) || isLoadingApp) {
	return false;
	}
	const isDismissed = isProductTrainingElementDismissed(tooltipName, dismissedProductTraining);
	if (isDismissed) {
	return false;
	}
	const tooltipConfig = TOOLTIPS[tooltipName];
	// if hasBeenAddedToNudgeMigration is true, and welcome modal is not dismissed, don't show tooltip
	if (hasBeenAddedToNudgeMigration && !dismissedProductTraining?.[CONST.MIGRATED_USER_WELCOME_MODAL]) {
	return false;
	}
	if (isOnboardingCompleted === false) {
	return false;
	}
	// We need to make an exception for these tooltips because it is shown in a modal, otherwise it would be hidden if a modal is visible
	if (
	tooltipName !== CONST.PRODUCT_TRAINING_TOOLTIP_NAMES.SCAN_TEST_TOOLTIP &&
	tooltipName !== CONST.PRODUCT_TRAINING_TOOLTIP_NAMES.SCAN_TEST_TOOLTIP_MANAGER &&
	tooltipName !== CONST.PRODUCT_TRAINING_TOOLTIP_NAMES.SCAN_TEST_CONFIRMATION &&
	tooltipName !== CONST.PRODUCT_TRAINING_TOOLTIP_NAMES.SCAN_TEST_DRIVE_CONFIRMATION &&
	tooltipName !== CONST.PRODUCT_TRAINING_TOOLTIP_NAMES.GPS_TOOLTIP &&
	isModalVisible
	) {
	return false;
	}
	return tooltipConfig.shouldShow({
	shouldUseNarrowLayout,
	isUserPolicyEmployee,
	isUserPolicyAdmin,
	hasBeenAddedToNudgeMigration,
	isUserInPaidPolicy,
	});
	},
	[
	isOnboardingCompletedMetadata,
	isLoadingApp,
	dismissedProductTraining,
	hasBeenAddedToNudgeMigration,
	isOnboardingCompleted,
	isModalVisible,
	shouldUseNarrowLayout,
	isUserPolicyEmployee,
	isUserPolicyAdmin,
	isUserInPaidPolicy,
	],
	);

:

The function checks isLoadingApp and isOnboardingCompletedMetadata loading states, but does NOT check if dismissedProductTraining has finished loading.

When a user logs back in:

1. The GPS tracking starts and isTracking becomes true
2. The GPSTooltip component calls useProductTrainingContext which triggers shouldTooltipBeVisible
3. shouldTooltipBeVisible checks isLoadingApp - which may be false at this point
4. It then calls isProductTrainingElementDismissed(tooltipName, dismissedProductTraining)
5. Since dismissedProductTraining is still loading (value is undefined), isProductTrainingElementDismissed returns false - treating it as NOT dismissed
6. The tooltip is shown even though the user had previously dismissed it
7. Later, when the NVP data loads from the server with the dismissed state, but the tooltip is already visible

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

We need to add a loading check for dismissedProductTraining in the shouldTooltipBeVisible function to prevent the tooltip from showing while the dismissed state is still being loaded.

In src/components/ProductTrainingContext/index.tsx:

1. Get the metadata for dismissedProductTraining by updating line 80:

const [dismissedProductTraining, dismissedProductTrainingMetadata] = useOnyx(ONYXKEYS.NVP_DISMISSED_PRODUCT_TRAINING, {canBeMissing: true});

2. Add a loading check in shouldTooltipBeVisible at line 131:

const shouldTooltipBeVisible = useCallback(
    (tooltipName: ProductTrainingTooltipName) => {
        if (isLoadingOnyxValue(isOnboardingCompletedMetadata, dismissedProductTrainingMetadata) || isLoadingApp) {
            return false;
        }
        // ... rest of the function remains the same
    },
    [
        isOnboardingCompletedMetadata,
        dismissedProductTrainingMetadata,  // Add to dependencies
        isLoadingApp,
        dismissedProductTraining,
        // ... rest of dependencies
    ],
);

This ensures the tooltip visibility decision is deferred until we know for certain whether the user has previously dismissed it.

What alternative solutions did you explore? (Optional)

[GCyganek]

Part of GPS feature that I'm responsible for as a Software Mansion engineer, will take care of this

[GCyganek]

I'll sync with @jnowakow later today as we probably need to update list of product training tooltips in the backend as the requests are returning 401 when sending request to update dismissed product training gpsTooltip

[GCyganek]

There will be a PR soon with a fix on the backend and it should work when it's merged