From 88be3ce7ee9f228001a2e7e5131546c8e9c093d0 Mon Sep 17 00:00:00 2001 From: dante01yoon Date: Fri, 2 Oct 2026 17:25:44 -0400 Subject: [PATCH 1/2] feat(telemetry): report session_bootstrap and session_signed_out_remotely Cloud, website and billing-web now pass the web-session identity's onBootstrap and onSignedOutRemotely hooks to their existing sinks: Cloud to Datadog RUM and PostHog, website to PostHog, billing-web to RUM and PostHog. The names and payloads live once in account-core. --- .../src/session/unifiedBillingSession.test.ts | 33 ++++++++-- .../src/session/unifiedBillingSession.ts | 5 +- .../src/telemetry/billingWebTelemetry.test.ts | 34 ++++++++++ .../src/telemetry/billingWebTelemetry.ts | 15 ++++- .../workshop-web-session-identity.test.ts | 32 ++++++++-- .../config/workshop-web-session-identity.ts | 5 +- apps/website/src/scripts/__mocks__/posthog.ts | 9 ++- apps/website/src/scripts/posthog.test.ts | 21 +++++++ apps/website/src/scripts/posthog.ts | 8 ++- packages/account-core/src/telemetry.test.ts | 62 +++++++++++++++++++ packages/account-core/src/telemetry.ts | 37 ++++++++++- .../auth/session/cloudWebSessionStore.ts | 5 ++ src/platform/auth/webSessionFlagOff.test.ts | 4 +- src/platform/auth/webSessionFlagOn.test.ts | 48 +++++++++++--- src/platform/telemetry/TelemetryRegistry.ts | 5 ++ .../cloud/DatadogRumTelemetryProvider.test.ts | 18 ++++++ .../cloud/DatadogRumTelemetryProvider.ts | 5 ++ .../cloud/PostHogTelemetryProvider.test.ts | 21 +++++++ .../cloud/PostHogTelemetryProvider.ts | 5 ++ src/platform/telemetry/types.ts | 6 +- 20 files changed, 349 insertions(+), 29 deletions(-) create mode 100644 packages/account-core/src/telemetry.test.ts diff --git a/apps/billing-web/src/session/unifiedBillingSession.test.ts b/apps/billing-web/src/session/unifiedBillingSession.test.ts index 0d612985897..a3ef963ee10 100644 --- a/apps/billing-web/src/session/unifiedBillingSession.test.ts +++ b/apps/billing-web/src/session/unifiedBillingSession.test.ts @@ -8,6 +8,7 @@ import type { User } from 'firebase/auth' import { createWebSessionBillingClient } from '@/session/billingWebClient' import { createUnifiedBillingSession } from '@/session/unifiedBillingSession' +import { billingWebTelemetry } from '@/telemetry/billingWebTelemetry' const API = 'https://testcloud.comfy.org/api' @@ -66,6 +67,20 @@ const TEAM = new Response( }) ) +function trackedWebSessionEvents() { + const track = vi + .spyOn(billingWebTelemetry, 'trackWebSessionEvent') + .mockImplementation(() => undefined) + return () => track.mock.calls.map(([event]) => event) +} + +function bootstrapEvent(outcome: string) { + return { + name: 'session_bootstrap', + properties: { outcome, origin: globalThis.location.origin } + } +} + function setup({ state = LIVE, remembered = null as User | null, @@ -104,6 +119,7 @@ function setup({ describe('billing-web on the shared web session', () => { it('signs in from a live session without touching Firebase (SS1)', async () => { + const tracked = trackedWebSessionEvents() const { session, firebase, sent, paths } = setup({ workspaceId: 'ws-team' }) @@ -112,6 +128,7 @@ describe('billing-web on the shared web session', () => { await expect(session.signInPort.loadIdentity()).resolves.toBeUndefined() expect(firebase.loadFirebase).not.toHaveBeenCalled() + expect(tracked()).toEqual([bootstrapEvent('signed_in')]) expect(paths()).toEqual([ 'GET /api/auth/session', 'GET /api/workspaces/current' @@ -145,29 +162,34 @@ describe('billing-web on the shared web session', () => { name: 'no session, nothing remembered: sign-in', state: { kind: 'dead', code: 'no_session' }, remembered: null, - phase: 'signed-out' + phase: 'signed-out', + outcome: 'signed_out' }, { name: 'expired session, nothing remembered: sign-in', state: { kind: 'dead', code: 'session_expired' }, remembered: null, - phase: 'signed-out' + phase: 'signed-out', + outcome: 'signed_out' }, { name: 'no session, a remembered login: silent restore', state: { kind: 'dead', code: 'no_session' }, remembered: 'user-1', - phase: 'authenticated' + phase: 'authenticated', + outcome: 'restored' }, { name: 'revoked session: sign-in', state: { kind: 'dead', code: 'session_revoked' }, remembered: 'user-1', - phase: 'signed-out' + phase: 'signed-out', + outcome: 'revoked' } ] as const)( '$name, consulting Firebase only then', - async ({ state, remembered, phase }) => { + async ({ state, remembered, phase, outcome }) => { + const tracked = trackedWebSessionEvents() const { session, firebase } = setup({ state, remembered: remembered === null ? null : firebaseUser(remembered) @@ -176,6 +198,7 @@ describe('billing-web on the shared web session', () => { await expect(session.settledPhase()).resolves.toBe(phase) expect(firebase.loadFirebase).toHaveBeenCalled() + expect(tracked()).toEqual([bootstrapEvent(outcome)]) } ) diff --git a/apps/billing-web/src/session/unifiedBillingSession.ts b/apps/billing-web/src/session/unifiedBillingSession.ts index edfdfa491b1..dd374825c24 100644 --- a/apps/billing-web/src/session/unifiedBillingSession.ts +++ b/apps/billing-web/src/session/unifiedBillingSession.ts @@ -19,6 +19,7 @@ import type { } from '@comfyorg/account-core/billing' import type { FirebaseIdentity } from '@comfyorg/account-core/firebase' import { createRequestAuthorizer } from '@comfyorg/account-core/requestAuth' +import { webSessionTelemetryHooks } from '@comfyorg/account-core/telemetry' import type { SessionErrorCode } from '@comfyorg/account-core/session' import type { WebSession, @@ -37,6 +38,7 @@ import type { SignInPort } from '@/auth/useSignInController' import type { BillingWebSessionPhase } from '@/router' +import { billingWebTelemetry } from '@/telemetry/billingWebTelemetry' export interface UnifiedBillingSessionDeps { /** Ingest API root, e.g. `https://cloud.comfy.org/api`. */ @@ -112,7 +114,8 @@ export function createUnifiedBillingSession(deps: UnifiedBillingSessionDeps) { (await (await firebaseUser())?.getIdToken()) ?? null, signOutLocally: async () => (await deps.loadFirebase())?.signOut() } - } + }, + ...webSessionTelemetryHooks(billingWebTelemetry.trackWebSessionEvent) }) const authorize = createRequestAuthorizer({ getWorkspaceToken: () => diff --git a/apps/billing-web/src/telemetry/billingWebTelemetry.test.ts b/apps/billing-web/src/telemetry/billingWebTelemetry.test.ts index 33879a692db..bf2eb5b8c51 100644 --- a/apps/billing-web/src/telemetry/billingWebTelemetry.test.ts +++ b/apps/billing-web/src/telemetry/billingWebTelemetry.test.ts @@ -356,6 +356,40 @@ describe('trackCheckoutJourneyEvent', () => { }) }) +describe('trackWebSessionEvent', () => { + it.for([ + { + name: 'session_bootstrap', + properties: { outcome: 'restored', origin: 'https://billing.comfy.org' } + }, + { + name: 'session_signed_out_remotely', + properties: { origin: 'https://billing.comfy.org' } + } + ] as const)('sends $name to RUM and PostHog as is', async (event) => { + vi.mocked(datadogRum.getInitConfiguration).mockReturnValue({ + clientToken: 'pub', + applicationId: 'app' + }) + const telemetry = createBillingWebTelemetry() + await telemetry.startPostHog({ + config: Promise.resolve(CONFIGURED), + identity: ref({ kind: 'unknown' }) + }) + + telemetry.trackWebSessionEvent(event) + + expect(datadogRum.addAction).toHaveBeenCalledExactlyOnceWith( + event.name, + event.properties + ) + expect(posthog.capture).toHaveBeenCalledExactlyOnceWith( + event.name, + event.properties + ) + }) +}) + describe('startPostHog', () => { it('turns off every PostHog capture that would carry page text or a full URL', async () => { const telemetry = createBillingWebTelemetry() diff --git a/apps/billing-web/src/telemetry/billingWebTelemetry.ts b/apps/billing-web/src/telemetry/billingWebTelemetry.ts index e62e017e3ef..8ba201564c6 100644 --- a/apps/billing-web/src/telemetry/billingWebTelemetry.ts +++ b/apps/billing-web/src/telemetry/billingWebTelemetry.ts @@ -15,6 +15,7 @@ import { getCheckoutJourneyTelemetryEventPayload } from '@comfyorg/account-core/billing' import type { CloudTelemetryConfig } from '@comfyorg/account-core/firebase' +import type { WebSessionTelemetryEvent } from '@comfyorg/account-core/telemetry' import { createPostHogBeforeSend, createPostHogUrlQueryScrub @@ -43,7 +44,10 @@ type PostHogClient = Pick< > interface BillingEvent { - readonly name: BillingTelemetryEventName | CheckoutJourneyTelemetryEventName + readonly name: + | BillingTelemetryEventName + | CheckoutJourneyTelemetryEventName + | WebSessionTelemetryEvent['name'] readonly properties: Readonly> } @@ -222,6 +226,12 @@ export function createBillingWebTelemetry() { ) } + function trackWebSessionEvent(event: WebSessionTelemetryEvent): void { + attempt(() => + send({ name: event.name, properties: { ...event.properties } }) + ) + } + /** The RUM user is the opaque id of the signed-in user, nothing else. */ function startRumUser(identity: WatchSource): void { syncIdentity(RUM_USER, identity) @@ -231,7 +241,8 @@ export function createBillingWebTelemetry() { startPostHog, startRumUser, trackBillingEvent, - trackCheckoutJourneyEvent + trackCheckoutJourneyEvent, + trackWebSessionEvent } } diff --git a/apps/website/src/config/workshop-web-session-identity.test.ts b/apps/website/src/config/workshop-web-session-identity.test.ts index 006fdbde212..c7649fe8694 100644 --- a/apps/website/src/config/workshop-web-session-identity.test.ts +++ b/apps/website/src/config/workshop-web-session-identity.test.ts @@ -56,6 +56,13 @@ function stubCloud(...sessionAnswers: Answer[]) { return sessionRequests } +function bootstrapEvent(outcome: string) { + return { + name: 'session_bootstrap', + properties: { outcome, origin: window.location.origin } + } +} + async function loadModules(firebaseUid: string | undefined) { const firebase = await import('./workshop-firebase') const firebaseSubscribe = vi.mocked(firebase.workshopIdentity.onUserChanged) @@ -64,9 +71,11 @@ async function loadModules(firebaseUid: string | undefined) { return () => {} }) const { workshopIdentity } = await import('./workshop-account') + const { captureWebSessionEvent } = await import('../scripts/posthog') await import('@comfyorg/account-core/requestAuth') return { signOutWorkshop: vi.mocked(firebase.signOutWorkshop), + captureWebSessionEvent: vi.mocked(captureWebSessionEvent), firebaseSubscribe, loadFirebase: () => workshopIdentity.activate(), ...(await import('./workshop-web-session-identity')), @@ -95,6 +104,9 @@ describe('resolveWorkshopAccountSource with the flag on', () => { await vi.waitFor(() => expect(modules.signOutWorkshop).toHaveBeenCalledTimes(signOuts) ) + expect(modules.captureWebSessionEvent).toHaveBeenCalledExactlyOnceWith( + bootstrapEvent('signed_in') + ) } ) @@ -109,8 +121,11 @@ describe('resolveWorkshopAccountSource with the flag on', () => { it('does not restore without a loaded Firebase login, and falls back to it', async () => { const sessionRequests = stubCloud(NO_SESSION) - const { resolveWorkshopAccountSource, ACCOUNT_SOURCE_CAP_MS } = - await loadModules('uid-1') + const { + resolveWorkshopAccountSource, + ACCOUNT_SOURCE_CAP_MS, + captureWebSessionEvent + } = await loadModules('uid-1') vi.useFakeTimers({ shouldAdvanceTime: false }) const source = resolveWorkshopAccountSource() @@ -121,6 +136,9 @@ describe('resolveWorkshopAccountSource with the flag on', () => { 'the signed-out answer decides, not the cap' ).toBe('firebase') expect(sessionRequests.map(({ method }) => method)).toEqual(['GET']) + expect(captureWebSessionEvent).toHaveBeenCalledExactlyOnceWith( + bootstrapEvent('signed_out') + ) }) it('restores the session from a loaded Firebase login', async () => { @@ -129,8 +147,11 @@ describe('resolveWorkshopAccountSource with the flag on', () => { { status: 200, body: { success: true } }, liveSession('uid-1') ) - const { resolveWorkshopAccountSource, loadFirebase } = - await loadModules('uid-1') + const { + resolveWorkshopAccountSource, + loadFirebase, + captureWebSessionEvent + } = await loadModules('uid-1') await loadFirebase() expect(await resolveWorkshopAccountSource()).toBe('session') @@ -142,5 +163,8 @@ describe('resolveWorkshopAccountSource with the flag on', () => { expect(sessionRequests[1].headers).toEqual({ Authorization: 'Bearer id-token' }) + expect(captureWebSessionEvent).toHaveBeenCalledExactlyOnceWith( + bootstrapEvent('restored') + ) }) }) diff --git a/apps/website/src/config/workshop-web-session-identity.ts b/apps/website/src/config/workshop-web-session-identity.ts index 99635164582..7d5fff63dd8 100644 --- a/apps/website/src/config/workshop-web-session-identity.ts +++ b/apps/website/src/config/workshop-web-session-identity.ts @@ -11,9 +11,11 @@ import type { WebSession, WebSessionUser } from '@comfyorg/account-core/webSession' +import { webSessionTelemetryHooks } from '@comfyorg/account-core/telemetry' import type { RememberedLogin } from '@comfyorg/account-core/webSessionIdentity' import { createWebSessionIdentity } from '@comfyorg/account-core/webSessionIdentity' +import { captureWebSessionEvent } from '../scripts/posthog' import { workshopIdentity } from './workshop-account' import { WORKSHOP_CLOUD_BASE_URL } from './workshop-env' import type { WorkshopAccountSource } from './workshop-account-source' @@ -64,7 +66,8 @@ export function bootWorkshopWebSession( globalThis.fetch(...args) }, principal: { kind: 'account', rememberedLogin: rememberedWorkshopLogin }, - origin: window.location.origin + origin: window.location.origin, + ...webSessionTelemetryHooks(captureWebSessionEvent) }) identity.subscribe((state) => { if (state.phase === 'signed_in') { diff --git a/apps/website/src/scripts/__mocks__/posthog.ts b/apps/website/src/scripts/__mocks__/posthog.ts index dc70be594c1..3ba9486e58f 100644 --- a/apps/website/src/scripts/__mocks__/posthog.ts +++ b/apps/website/src/scripts/__mocks__/posthog.ts @@ -33,7 +33,8 @@ const posthog: typeof realPosthog = { captureAuthRefreshFailed: vi.fn(), captureSignupOpened: vi.fn(), captureAuthCompleted: vi.fn(), - captureAuthFailed: vi.fn() + captureAuthFailed: vi.fn(), + captureWebSessionEvent: vi.fn() } const { @@ -61,7 +62,8 @@ const { captureAuthRefreshFailed, captureSignupOpened, captureAuthCompleted, - captureAuthFailed + captureAuthFailed, + captureWebSessionEvent } = posthog export { @@ -89,5 +91,6 @@ export { captureAuthRefreshFailed, captureSignupOpened, captureAuthCompleted, - captureAuthFailed + captureAuthFailed, + captureWebSessionEvent } diff --git a/apps/website/src/scripts/posthog.test.ts b/apps/website/src/scripts/posthog.test.ts index b1dd9fec3cb..79eb32dda57 100644 --- a/apps/website/src/scripts/posthog.test.ts +++ b/apps/website/src/scripts/posthog.test.ts @@ -966,6 +966,27 @@ describe('shared auth telemetry events', () => { ) }) + it.for([ + { + name: SESSION_TELEMETRY_EVENT.bootstrap, + properties: { outcome: 'signed_in', origin: 'https://www.comfy.org' } + }, + { + name: SESSION_TELEMETRY_EVENT.signedOutRemotely, + properties: { origin: 'https://www.comfy.org' } + } + ] as const)('reports the web session event $name as is', async (event) => { + const { initPostHog, captureWebSessionEvent } = await import('./posthog') + initPostHog() + + captureWebSessionEvent(event) + + expect(hoisted.mockCapture).toHaveBeenCalledWith( + event.name, + event.properties + ) + }) + it("reports sign-up opens and auth failures under the cloud app's event names", async () => { const { initPostHog, diff --git a/apps/website/src/scripts/posthog.ts b/apps/website/src/scripts/posthog.ts index c1209ae09cb..bfab5624966 100644 --- a/apps/website/src/scripts/posthog.ts +++ b/apps/website/src/scripts/posthog.ts @@ -14,7 +14,8 @@ import { } from '@comfyorg/account-core/telemetry' import type { AuthCompletedMetadata, - AuthErrorMetadata + AuthErrorMetadata, + WebSessionTelemetryEvent } from '@comfyorg/account-core/telemetry' import { createPostHogBeforeSend } from '@comfyorg/shared-frontend-utils/piiUtil' import { normalizeTurnstileMode } from '@comfyorg/account-core/turnstile' @@ -67,6 +68,7 @@ export type CliClientId = export type RouterRoadmapCardId = 'workflow' | 'strategy' | 'use-case' | 'byok' type AnalyticsEvent = + | WebSessionTelemetryEvent | { name: `website:workshop_${WorkshopAnalyticsEvent['name']}` properties: WorkshopAnalyticsEvent['properties'] @@ -528,6 +530,10 @@ export function captureAuthRefreshFailed(outcome: SessionRefreshOutcome): void { }) } +export function captureWebSessionEvent(event: WebSessionTelemetryEvent): void { + captureEvent(event) +} + export function captureSignupOpened(): void { captureEvent({ name: ANALYTICS_EVENT.signUpOpened }) } diff --git a/packages/account-core/src/telemetry.test.ts b/packages/account-core/src/telemetry.test.ts new file mode 100644 index 00000000000..a43332df88a --- /dev/null +++ b/packages/account-core/src/telemetry.test.ts @@ -0,0 +1,62 @@ +import { describe, expect, it } from 'vitest' + +import { createWebSessionIdentity } from './core/webSessionIdentity.js' +import type { WebSessionTelemetryEvent } from './telemetry.js' +import { webSessionTelemetryHooks } from './telemetry.js' +import type { FakeWebSessionState } from './testing.js' +import { createFakeWebSessionEndpoint, fakeWebSessionUser } from './testing.js' + +const ORIGIN = 'https://www.comfy.example' +const settle = () => new Promise((resolve) => setTimeout(resolve, 0)) + +describe('webSessionTelemetryHooks', () => { + it.for<{ state: FakeWebSessionState; outcome: string }>([ + { + state: { kind: 'live', user: fakeWebSessionUser({ id: 'user-1' }) }, + outcome: 'signed_in' + }, + { state: { kind: 'dead', code: 'session_revoked' }, outcome: 'revoked' } + ])( + 'reports a $outcome boot as session_bootstrap with outcome and origin only', + async ({ state, outcome }) => { + const tracked: WebSessionTelemetryEvent[] = [] + const endpoint = createFakeWebSessionEndpoint({ state }) + const identity = createWebSessionIdentity({ + session: { + apiBaseUrl: 'https://cloud.example/api', + fetchImpl: endpoint.fetch + }, + principal: { + kind: 'account', + rememberedLogin: { + currentUserId: async () => null, + getProof: async () => null, + signOutLocally: async () => undefined + } + }, + origin: ORIGIN, + ...webSessionTelemetryHooks((event) => tracked.push(event)) + }) + + identity.boot() + await settle() + identity.dispose() + + expect(tracked).toEqual([ + { name: 'session_bootstrap', properties: { outcome, origin: ORIGIN } } + ]) + } + ) + + it('reports a remote sign-out as session_signed_out_remotely with the origin', () => { + const tracked: WebSessionTelemetryEvent[] = [] + + webSessionTelemetryHooks((event) => + tracked.push(event) + ).onSignedOutRemotely?.({ origin: ORIGIN }) + + expect(tracked).toEqual([ + { name: 'session_signed_out_remotely', properties: { origin: ORIGIN } } + ]) + }) +}) diff --git a/packages/account-core/src/telemetry.ts b/packages/account-core/src/telemetry.ts index 7497b3f872a..b72d269644a 100644 --- a/packages/account-core/src/telemetry.ts +++ b/packages/account-core/src/telemetry.ts @@ -4,11 +4,46 @@ * every host. The package never calls a telemetry API itself; call sites * stay host-specific. */ +import type { + WebSessionBootstrapEvent, + WebSessionIdentityOptions +} from './core/webSessionIdentity.js' + export const SESSION_TELEMETRY_EVENT = { refreshSucceeded: 'auth.unified.refresh.succeeded', - refreshFailed: 'auth.unified.refresh.failed' + refreshFailed: 'auth.unified.refresh.failed', + bootstrap: 'session_bootstrap', + signedOutRemotely: 'session_signed_out_remotely' } as const +export type WebSessionTelemetryEvent = + | { + readonly name: typeof SESSION_TELEMETRY_EVENT.bootstrap + readonly properties: WebSessionBootstrapEvent + } + | { + readonly name: typeof SESSION_TELEMETRY_EVENT.signedOutRemotely + readonly properties: { readonly origin: string } + } + +/** The web-session identity's telemetry hooks, routed to one host sink. */ +export function webSessionTelemetryHooks( + track: (event: WebSessionTelemetryEvent) => void +): Pick { + return { + onBootstrap: ({ outcome, origin }) => + track({ + name: SESSION_TELEMETRY_EVENT.bootstrap, + properties: { outcome, origin } + }), + onSignedOutRemotely: ({ origin }) => + track({ + name: SESSION_TELEMETRY_EVENT.signedOutRemotely, + properties: { origin } + }) + } +} + /** * The cloud app's `billing.operation.*` events, emitted by the billing * operation lifecycle for every observed `billing_op_id` regardless of diff --git a/src/platform/auth/session/cloudWebSessionStore.ts b/src/platform/auth/session/cloudWebSessionStore.ts index ebb4f8fdb23..9e50e28679c 100644 --- a/src/platform/auth/session/cloudWebSessionStore.ts +++ b/src/platform/auth/session/cloudWebSessionStore.ts @@ -26,6 +26,7 @@ import { } from '@comfyorg/account-core/sessionTokenMint' import { readWebSession } from '@comfyorg/account-core/webSession' import { createWebSessionIdentity } from '@comfyorg/account-core/webSessionIdentity' +import { webSessionTelemetryHooks } from '@comfyorg/account-core/telemetry' import { createWebCrossTabRefreshPort, createWebVisibilityPort @@ -47,6 +48,7 @@ import { provideWebSessionRequests, WebSessionTokenError } from '@/platform/auth/session/webSessionFetch' +import { useTelemetry } from '@/platform/telemetry' import { reportError } from '@/platform/telemetry/reportError' import { useToastStore } from '@/platform/updates/common/toastStore' import { useTeamWorkspaceStore } from '@/platform/workspace/stores/teamWorkspaceStore' @@ -150,6 +152,9 @@ function createCloudIdentity(): WebSessionIdentity { }, origin: window.location.origin, onAccountChanged: resetForAccountChange, + ...webSessionTelemetryHooks((event) => + useTelemetry()?.trackWebSessionEvent(event) + ), ...(visibility && { heartbeat: { visibility, ...(crossTab && { crossTab }) } }) diff --git a/src/platform/auth/webSessionFlagOff.test.ts b/src/platform/auth/webSessionFlagOff.test.ts index 26d4d5a9520..5204e31625a 100644 --- a/src/platform/auth/webSessionFlagOff.test.ts +++ b/src/platform/auth/webSessionFlagOff.test.ts @@ -16,6 +16,7 @@ import { import { useCloudWebSessionStore } from '@/platform/auth/session/cloudWebSessionStore' import { refreshRemoteConfig } from '@/platform/remoteConfig/refreshRemoteConfig' import { remoteConfig } from '@/platform/remoteConfig/remoteConfig' +import { useTelemetry } from '@/platform/telemetry' import { useBillingReadRail } from '@/platform/workspace/composables/useBillingReadRail' import { TOKEN_REFRESH_BUFFER_MS } from '@/platform/workspace/workspaceConstants' import { api } from '@/scripts/api' @@ -714,7 +715,7 @@ describe('an interactive sign-in with unified_web_session off', () => { remoteConfig.value = {} }) - it('never consumes the marker and sends no session request', async () => { + it('never consumes the marker and sends no session request or session event', async () => { const recorder = installFetchRecorder({ unified_cloud_auth: false }) await refreshRemoteConfig({ useAuth: false }) @@ -725,6 +726,7 @@ describe('an interactive sign-in with unified_web_session off', () => { expect( recorder.all.filter(({ path }) => path === '/api/auth/session') ).toEqual([]) + expect(useTelemetry()?.trackWebSessionEvent).not.toHaveBeenCalled() }) }) diff --git a/src/platform/auth/webSessionFlagOn.test.ts b/src/platform/auth/webSessionFlagOn.test.ts index b404265b77f..e43ddc65b1e 100644 --- a/src/platform/auth/webSessionFlagOn.test.ts +++ b/src/platform/auth/webSessionFlagOn.test.ts @@ -38,6 +38,7 @@ import { webSessionResourceHeader, webSessionSend } from '@/platform/auth/session/webSessionFetch' +import { useTelemetry } from '@/platform/telemetry' import { reportError } from '@/platform/telemetry/reportError' import { refreshRemoteConfig } from '@/platform/remoteConfig/refreshRemoteConfig' import { remoteConfig } from '@/platform/remoteConfig/remoteConfig' @@ -363,40 +364,69 @@ describe('cloud app on the shared web session (unified_web_session on)', () => { name: '200 for the remembered user signs in as is', session: { userId: 'user-a' }, requests: ['GET'], - signsOutLocally: false + signsOutLocally: false, + outcome: 'signed_in' }, { name: '200 for another user signs the remembered login out', session: { userId: 'user-b' }, requests: ['GET'], - signsOutLocally: true + signsOutLocally: true, + outcome: 'signed_in' }, { name: '401 session_revoked signs out and never restores', session: 'revoked', requests: ['GET'], - signsOutLocally: true + signsOutLocally: true, + outcome: 'revoked' }, { name: '401 no_session restores once from the remembered login', session: 'none', requests: ['GET', 'POST', 'GET'], - signsOutLocally: false + signsOutLocally: false, + outcome: 'restored' } ] satisfies { name: string session: ServerSession requests: string[] signsOutLocally: boolean - }[])('boot: $name', async ({ session, requests, signsOutLocally }) => { - const server = installServer(session) + outcome: string + }[])( + 'boot: $name', + async ({ session, requests, signsOutLocally, outcome }) => { + const server = installServer(session) + await refreshRemoteConfig({ useAuth: false }) + identity.signIn(USER_A) + + await useSessionCookie().ensureSessionCookie() + + expect(methodsOf(server.requests)).toEqual(requests) + expect(firebaseSignOut).toHaveBeenCalledTimes(signsOutLocally ? 1 : 0) + expect( + useTelemetry()?.trackWebSessionEvent + ).toHaveBeenCalledExactlyOnceWith({ + name: 'session_bootstrap', + properties: { outcome, origin: location.origin } + }) + } + ) + + it('reports a session revoked under a signed-in tab as signed out remotely', async () => { + const server = installServer({ userId: 'user-a' }) await refreshRemoteConfig({ useAuth: false }) identity.signIn(USER_A) - await useSessionCookie().ensureSessionCookie() - expect(methodsOf(server.requests)).toEqual(requests) - expect(firebaseSignOut).toHaveBeenCalledTimes(signsOutLocally ? 1 : 0) + server.session = 'revoked' + await vi.advanceTimersByTimeAsync(TEN_MINUTES_MS) + + expect(useTelemetry()?.trackWebSessionEvent).toHaveBeenLastCalledWith({ + name: 'session_signed_out_remotely', + properties: { origin: location.origin } + }) }) it('resets the tab and tells the user when another account takes the session', async () => { diff --git a/src/platform/telemetry/TelemetryRegistry.ts b/src/platform/telemetry/TelemetryRegistry.ts index acd9e217ed7..42614bb9d62 100644 --- a/src/platform/telemetry/TelemetryRegistry.ts +++ b/src/platform/telemetry/TelemetryRegistry.ts @@ -2,6 +2,7 @@ import type { BillingTelemetryEvent, CheckoutJourneyTelemetryEvent } from '@comfyorg/account-core/billing' +import type { WebSessionTelemetryEvent } from '@comfyorg/account-core/telemetry' import type { AddCreditsClickMetadata, AgentAttachButtonClickedMetadata, @@ -133,6 +134,10 @@ export class TelemetryRegistry implements TelemetryDispatcher { this.dispatch((provider) => provider.trackUnifiedAuthRefresh?.(metadata)) } + trackWebSessionEvent(event: WebSessionTelemetryEvent): void { + this.dispatch((provider) => provider.trackWebSessionEvent?.(event)) + } + trackImageLoadFailed(metadata: ImageLoadFailureMetadata): void { this.dispatch((provider) => provider.trackImageLoadFailed?.(metadata)) } diff --git a/src/platform/telemetry/providers/cloud/DatadogRumTelemetryProvider.test.ts b/src/platform/telemetry/providers/cloud/DatadogRumTelemetryProvider.test.ts index a673125e649..2ac3bfe2067 100644 --- a/src/platform/telemetry/providers/cloud/DatadogRumTelemetryProvider.test.ts +++ b/src/platform/telemetry/providers/cloud/DatadogRumTelemetryProvider.test.ts @@ -172,6 +172,24 @@ describe('DatadogRumTelemetryProvider', () => { ) }) + it.for([ + { + name: 'session_bootstrap', + properties: { outcome: 'restored', origin: 'https://cloud.comfy.org' } + }, + { + name: 'session_signed_out_remotely', + properties: { origin: 'https://cloud.comfy.org' } + } + ] as const)('records the web session event $name as is', (event) => { + new DatadogRumTelemetryProvider().trackWebSessionEvent(event) + + expect(addAction).toHaveBeenCalledExactlyOnceWith( + event.name, + event.properties + ) + }) + it('records image load failures by source', () => { new DatadogRumTelemetryProvider().trackImageLoadFailed({ source: 'node_image_preview' diff --git a/src/platform/telemetry/providers/cloud/DatadogRumTelemetryProvider.ts b/src/platform/telemetry/providers/cloud/DatadogRumTelemetryProvider.ts index 5c9e279f3fc..d36bfa1de30 100644 --- a/src/platform/telemetry/providers/cloud/DatadogRumTelemetryProvider.ts +++ b/src/platform/telemetry/providers/cloud/DatadogRumTelemetryProvider.ts @@ -8,6 +8,7 @@ import type { BillingTelemetryEvent, CheckoutJourneyTelemetryEvent } from '@comfyorg/account-core/billing' +import type { WebSessionTelemetryEvent } from '@comfyorg/account-core/telemetry' // oxlint-disable-next-line no-restricted-imports -- the telemetry layer owns the sinks that reportError() fans out to import { datadogRum } from '@datadog/browser-rum' @@ -68,6 +69,10 @@ export class DatadogRumTelemetryProvider implements TelemetryProvider { ) } + trackWebSessionEvent(event: WebSessionTelemetryEvent): void { + datadogRum.addAction(event.name, event.properties) + } + trackImageLoadFailed(metadata: ImageLoadFailureMetadata): void { datadogRum.addAction(TelemetryEvents.IMAGE_LOAD_FAILED, metadata) } diff --git a/src/platform/telemetry/providers/cloud/PostHogTelemetryProvider.test.ts b/src/platform/telemetry/providers/cloud/PostHogTelemetryProvider.test.ts index 4a8e178d7f1..42e7c9fe743 100644 --- a/src/platform/telemetry/providers/cloud/PostHogTelemetryProvider.test.ts +++ b/src/platform/telemetry/providers/cloud/PostHogTelemetryProvider.test.ts @@ -611,6 +611,27 @@ describe('PostHogTelemetryProvider', () => { ) }) + it.for([ + { + name: 'session_bootstrap', + properties: { outcome: 'restored', origin: 'https://cloud.comfy.org' } + }, + { + name: 'session_signed_out_remotely', + properties: { origin: 'https://cloud.comfy.org' } + } + ] as const)('captures the web session event $name as is', async (event) => { + const provider = createProvider() + await vi.dynamicImportSettled() + + provider.trackWebSessionEvent(event) + + expect(hoisted.mockCapture).toHaveBeenCalledWith( + event.name, + event.properties + ) + }) + it('captures image load failures', async () => { const provider = createProvider() await vi.dynamicImportSettled() diff --git a/src/platform/telemetry/providers/cloud/PostHogTelemetryProvider.ts b/src/platform/telemetry/providers/cloud/PostHogTelemetryProvider.ts index 472b7d66007..888a8276381 100644 --- a/src/platform/telemetry/providers/cloud/PostHogTelemetryProvider.ts +++ b/src/platform/telemetry/providers/cloud/PostHogTelemetryProvider.ts @@ -9,6 +9,7 @@ import type { BillingTelemetryEvent, CheckoutJourneyTelemetryEvent } from '@comfyorg/account-core/billing' +import type { WebSessionTelemetryEvent } from '@comfyorg/account-core/telemetry' import type { PostHog } from 'posthog-js' import { watch } from 'vue' import type { WatchStopHandle } from 'vue' @@ -442,6 +443,10 @@ export class PostHogTelemetryProvider implements TelemetryProvider { ) } + trackWebSessionEvent(event: WebSessionTelemetryEvent): void { + this.trackEvent(event.name, event.properties) + } + trackImageLoadFailed(metadata: ImageLoadFailureMetadata): void { this.trackEvent(TelemetryEvents.IMAGE_LOAD_FAILED, metadata) } diff --git a/src/platform/telemetry/types.ts b/src/platform/telemetry/types.ts index 0cbf461130f..b123f671fb8 100644 --- a/src/platform/telemetry/types.ts +++ b/src/platform/telemetry/types.ts @@ -32,7 +32,8 @@ import type { AgentRunMode } from '@comfyorg/ingest-types' import type { AuthErrorMetadata, AuthFlowAction, - AuthMethod + AuthMethod, + WebSessionTelemetryEvent } from '@comfyorg/account-core/telemetry' import type { SessionRefreshOutcome } from '@comfyorg/account-core/session' @@ -1307,6 +1308,7 @@ export interface TelemetryProvider { trackAuthFailed?(metadata: AuthErrorMetadata): void trackUnifiedAuthRetry?(metadata: UnifiedAuthRetryMetadata): void trackUnifiedAuthRefresh?(metadata: UnifiedAuthRefreshMetadata): void + trackWebSessionEvent?(event: WebSessionTelemetryEvent): void trackImageLoadFailed?(metadata: ImageLoadFailureMetadata): void trackUserLoggedIn?(): void trackBootstrapComplete?(metadata: BootstrapCompleteMetadata): void @@ -1640,6 +1642,7 @@ export type TelemetryEventName = | (typeof TelemetryEvents)[keyof typeof TelemetryEvents] | BillingTelemetryEventName | CheckoutJourneyTelemetryEventName + | WebSessionTelemetryEvent['name'] export const OnboardingTourEvents: Record< OnboardingTourStage, @@ -1691,6 +1694,7 @@ export type TelemetryEventProperties = | AuthErrorMetadata | UnifiedAuthRetryMetadata | UnifiedAuthRefreshMetadata + | WebSessionTelemetryEvent['properties'] | ImageLoadFailureMetadata | BootstrapCompleteMetadata | SurveyResponses From 93e31af8dd9036cfd8b08dec3e4aaae63a855b9a Mon Sep 17 00:00:00 2001 From: dante01yoon Date: Fri, 2 Oct 2026 17:28:22 -0400 Subject: [PATCH 2/2] chore(telemetry): mark the dispatcher's web session method as used through the interface --- src/platform/telemetry/TelemetryRegistry.ts | 1 + 1 file changed, 1 insertion(+) diff --git a/src/platform/telemetry/TelemetryRegistry.ts b/src/platform/telemetry/TelemetryRegistry.ts index 42614bb9d62..bfc39caf30a 100644 --- a/src/platform/telemetry/TelemetryRegistry.ts +++ b/src/platform/telemetry/TelemetryRegistry.ts @@ -134,6 +134,7 @@ export class TelemetryRegistry implements TelemetryDispatcher { this.dispatch((provider) => provider.trackUnifiedAuthRefresh?.(metadata)) } + // fallow-ignore-next-line unused-class-member trackWebSessionEvent(event: WebSessionTelemetryEvent): void { this.dispatch((provider) => provider.trackWebSessionEvent?.(event)) }