From be7ac8c7eed263c304740ef3d94d826219ea7ca4 Mon Sep 17 00:00:00 2001 From: Matt Miller Date: Thu, 24 Sep 2026 06:41:39 +0000 Subject: [PATCH] fix: gate Mixpanel and Customer.io user identification on store readiness Port main's whenStoresReady() guard to the Mixpanel and Customer.io telemetry providers on cloud/1.54, matching the PostHog fix in #18690. Co-Authored-By: Claude Opus 5.5 --- .../cloud/CustomerIoTelemetryProvider.test.ts | 39 ++++++++++++++-- .../cloud/CustomerIoTelemetryProvider.ts | 46 ++++++++++--------- .../cloud/MixpanelTelemetryProvider.test.ts | 28 ++++++++++- .../cloud/MixpanelTelemetryProvider.ts | 20 ++++++-- 4 files changed, 100 insertions(+), 33 deletions(-) diff --git a/src/platform/telemetry/providers/cloud/CustomerIoTelemetryProvider.test.ts b/src/platform/telemetry/providers/cloud/CustomerIoTelemetryProvider.test.ts index 1f5c18ca540..360545a0b19 100644 --- a/src/platform/telemetry/providers/cloud/CustomerIoTelemetryProvider.test.ts +++ b/src/platform/telemetry/providers/cloud/CustomerIoTelemetryProvider.test.ts @@ -1,5 +1,11 @@ +import { getActivePinia, setActivePinia } from 'pinia' import { beforeEach, describe, expect, it, vi } from 'vitest' +import { + markStoresPending, + markStoresReady +} from '@/platform/telemetry/storeReadiness' + const hoisted = vi.hoisted(() => { const analytics = { identify: vi.fn().mockResolvedValue(undefined), @@ -13,6 +19,7 @@ const hoisted = vi.hoisted(() => { const resolvedUserInfo = { value: null as { id: string } | null } return { analytics, + reportError: vi.fn(), load: vi.fn(() => analytics), inAppPlugin: vi.fn(() => ({ name: 'Customer.io In-App Plugin' })), userEmail: { value: null as string | null }, @@ -40,6 +47,10 @@ const hoisted = vi.hoisted(() => { } }) +vi.mock('@/platform/telemetry/reportError', () => ({ + reportError: hoisted.reportError +})) + vi.mock('@customerio/cdp-analytics-browser', () => ({ AnalyticsBrowser: { load: hoisted.load }, InAppPlugin: hoisted.inAppPlugin @@ -155,7 +166,6 @@ describe('CustomerIoTelemetryProvider', () => { }) it('continues tracking events and page views when the in-app plugin fails to register', async () => { - const consoleError = vi.spyOn(console, 'error').mockImplementation(() => {}) const registrationError = new Error('in-app setup failed') hoisted.analytics.register.mockRejectedValue(registrationError) const provider = createProvider() @@ -171,10 +181,9 @@ describe('CustomerIoTelemetryProvider', () => { SOURCE ) expect(hoisted.analytics.page).toHaveBeenCalledOnce() - expect(consoleError).toHaveBeenCalledWith( - 'Failed to initialize Customer.io in-app plugin:', - registrationError - ) + expect(hoisted.reportError).toHaveBeenCalledWith(registrationError, { + errorType: 'customerio_in_app_plugin_registration_failure' + }) provider.trackAddApiCreditButtonClicked() await vi.waitFor(() => @@ -220,6 +229,26 @@ describe('CustomerIoTelemetryProvider', () => { ) }) + it('defers user identification until stores are ready', async () => { + const pinia = getActivePinia() + setActivePinia(undefined) + markStoresPending() + try { + createProvider() + await vi.dynamicImportSettled() + await vi.waitFor(() => expect(hoisted.load).toHaveBeenCalled()) + + expect(hoisted.onUserResolved).not.toHaveBeenCalled() + + markStoresReady() + + await vi.waitFor(() => expect(hoisted.onUserResolved).toHaveBeenCalled()) + } finally { + markStoresReady() + setActivePinia(pinia) + } + }) + it('updates the identified user when the active locale changes', async () => { createProvider() await vi.dynamicImportSettled() diff --git a/src/platform/telemetry/providers/cloud/CustomerIoTelemetryProvider.ts b/src/platform/telemetry/providers/cloud/CustomerIoTelemetryProvider.ts index 0dd8adb0399..d73136e744f 100644 --- a/src/platform/telemetry/providers/cloud/CustomerIoTelemetryProvider.ts +++ b/src/platform/telemetry/providers/cloud/CustomerIoTelemetryProvider.ts @@ -4,6 +4,8 @@ import { watch } from 'vue' import { useCurrentUser } from '@/composables/auth/useCurrentUser' import { i18n } from '@/i18n' +import { reportError } from '@/platform/telemetry/reportError' +import { whenStoresReady } from '@/platform/telemetry/storeReadiness' import type { AuthUserInfo } from '@/types/authTypes' import { TelemetryEvents } from '../../types' @@ -67,20 +69,27 @@ export class CustomerIoTelemetryProvider implements TelemetryProvider { } void import('@customerio/cdp-analytics-browser') - .then(({ AnalyticsBrowser, InAppPlugin }) => { + .then(async ({ AnalyticsBrowser, InAppPlugin }) => { const analytics = AnalyticsBrowser.load({ writeKey }) - const inAppRegistration = analytics.register( - InAppPlugin({ - siteId, - events: null, - anonymousInApp: false, - _env: undefined, - _logging: undefined, - colorScheme: 'system' + const inAppRegistration = analytics + .register( + InAppPlugin({ + siteId, + events: null, + anonymousInApp: false, + _env: undefined, + _logging: undefined, + colorScheme: 'system' + }) + ) + .catch((error) => { + reportError(error, { + errorType: 'customerio_in_app_plugin_registration_failure' + }) }) - ) - this.analytics = analytics + await whenStoresReady() + this.analytics = analytics const currentUser = useCurrentUser() const identifyResolvedUser = (user: AuthUserInfo) => { const identity = { @@ -117,17 +126,10 @@ export class CustomerIoTelemetryProvider implements TelemetryProvider { }) void this.flushQueue() - void inAppRegistration - .catch((error) => { - console.error( - 'Failed to initialize Customer.io in-app plugin:', - error - ) - }) - .finally(() => { - this.isPageViewTrackingReady = true - this.flushPageView() - }) + void inAppRegistration.finally(() => { + this.isPageViewTrackingReady = true + this.flushPageView() + }) }) .catch((error) => { console.error('Failed to load Customer.io:', error) diff --git a/src/platform/telemetry/providers/cloud/MixpanelTelemetryProvider.test.ts b/src/platform/telemetry/providers/cloud/MixpanelTelemetryProvider.test.ts index 53599be954a..1a40361218c 100644 --- a/src/platform/telemetry/providers/cloud/MixpanelTelemetryProvider.test.ts +++ b/src/platform/telemetry/providers/cloud/MixpanelTelemetryProvider.test.ts @@ -1,5 +1,11 @@ +import { getActivePinia, setActivePinia } from 'pinia' import { beforeEach, describe, expect, it, vi } from 'vitest' +import { + markStoresPending, + markStoresReady +} from '@/platform/telemetry/storeReadiness' + const mockMixpanel = vi.hoisted(() => ({ init: vi.fn(), track: vi.fn(), @@ -256,7 +262,7 @@ describe('MixpanelTelemetryProvider — with configured token', () => { new MixpanelTelemetryProvider() await waitForMixpanelInit() - expect(mockOnUserResolved).toHaveBeenCalled() + await vi.waitFor(() => expect(mockOnUserResolved).toHaveBeenCalled()) const callback = mockOnUserResolved.mock.calls[0]?.[0] as (user: { id?: string }) => void @@ -264,6 +270,26 @@ describe('MixpanelTelemetryProvider — with configured token', () => { expect(mockMixpanel.identify).toHaveBeenCalledWith('user-42') }) + + it('defers user identification until stores are ready', async () => { + const pinia = getActivePinia() + setActivePinia(undefined) + markStoresPending() + try { + new MixpanelTelemetryProvider() + await waitForMixpanelInit() + await Promise.resolve() + + expect(mockOnUserResolved).not.toHaveBeenCalled() + + markStoresReady() + + await vi.waitFor(() => expect(mockOnUserResolved).toHaveBeenCalled()) + } finally { + markStoresReady() + setActivePinia(pinia) + } + }) }) describe('MixpanelTelemetryProvider — direct event tracking methods', () => { diff --git a/src/platform/telemetry/providers/cloud/MixpanelTelemetryProvider.ts b/src/platform/telemetry/providers/cloud/MixpanelTelemetryProvider.ts index f96d80ba37a..3f49c77547f 100644 --- a/src/platform/telemetry/providers/cloud/MixpanelTelemetryProvider.ts +++ b/src/platform/telemetry/providers/cloud/MixpanelTelemetryProvider.ts @@ -3,6 +3,8 @@ import { omit } from 'es-toolkit' import { watch } from 'vue' import { useCurrentUser } from '@/composables/auth/useCurrentUser' +import { reportError } from '@/platform/telemetry/reportError' +import { whenStoresReady } from '@/platform/telemetry/storeReadiness' import type { AuthMetadata, @@ -114,11 +116,19 @@ export class MixpanelTelemetryProvider implements TelemetryProvider { loaded: () => { this.isInitialized = true this.flushEventQueue() // flush events that were queued while initializing - useCurrentUser().onUserResolved((user) => { - if (this.mixpanel && user.id) { - this.mixpanel.identify(user.id) - } - }) + void whenStoresReady() + .then(() => { + useCurrentUser().onUserResolved((user) => { + if (this.mixpanel && user.id) { + this.mixpanel.identify(user.id) + } + }) + }) + .catch((error) => { + reportError(error, { + errorType: 'mixpanel_user_identification_failure' + }) + }) } }) })