Skip to content

πŸ™Œ OpenHands: AI-Driven Development

fix: Track cookie-auth Cloud backend connections (#16113)

Rohit Malhotra850bd647b64c
diff --git a/__tests__/hooks/use-telemetry-identity.test.ts b/__tests__/hooks/use-telemetry-identity.test.ts
index 8fae45e916..9dbded927e 100644
--- a/__tests__/hooks/use-telemetry-identity.test.ts
+++ b/__tests__/hooks/use-telemetry-identity.test.ts
@@ -22,15 +22,26 @@ vi.mock("#/services/telemetry", () => ({
setTelemetryCloudContextMock(...args),
}));
+const trackBackendAddedMock = vi.fn();
+vi.mock("#/hooks/use-tracking", () => ({
+ useTracking: () => ({ trackBackendAdded: trackBackendAddedMock }),
+}));
+
import { useTelemetryIdentity } from "#/hooks/use-telemetry-identity";
const BACKEND_ID = "cloud-1";
const cloudBackend = { kind: "cloud" as const, id: BACKEND_ID };
+const cookieCloudBackend = {
+ kind: "cloud" as const,
+ id: BACKEND_ID,
+ authMode: "cookie" as const,
+};
const localBackend = { kind: "local" as const, id: "local-1" };
describe("useTelemetryIdentity", () => {
beforeEach(() => {
vi.clearAllMocks();
+ window.sessionStorage.clear();
useActiveBackendMock.mockReturnValue({
backend: cloudBackend,
orgId: "org-123",
@@ -94,7 +105,10 @@ describe("useTelemetryIdentity", () => {
});
it("clears Cloud user context while a local backend is active", () => {
- useActiveBackendMock.mockReturnValue({ backend: localBackend, orgId: null });
+ useActiveBackendMock.mockReturnValue({
+ backend: localBackend,
+ orgId: null,
+ });
renderHook(() => useTelemetryIdentity());
@@ -115,4 +129,90 @@ describe("useTelemetryIdentity", () => {
orgId: "org-123",
});
});
+
+ it("tracks cookie-auth Cloud backend addition after identity and email resolve", () => {
+ useActiveBackendMock.mockReturnValue({
+ backend: cookieCloudBackend,
+ orgId: "org-123",
+ });
+
+ renderHook(() => useTelemetryIdentity());
+
+ expect(trackBackendAddedMock).toHaveBeenCalledWith({
+ backendKind: "cloud",
+ connectionMethod: "cloud_cookie",
+ hasApiKey: false,
+ source: "cloud_auto_connect",
+ });
+ });
+
+ it("dedupes cookie-auth Cloud backend additions within a browser session", () => {
+ useActiveBackendMock.mockReturnValue({
+ backend: cookieCloudBackend,
+ orgId: "org-123",
+ });
+
+ const { rerender } = renderHook(() => useTelemetryIdentity());
+ rerender();
+
+ expect(trackBackendAddedMock).toHaveBeenCalledTimes(1);
+ });
+
+ it("waits for an email before tracking cookie-auth Cloud backend addition", () => {
+ useActiveBackendMock.mockReturnValue({
+ backend: cookieCloudBackend,
+ orgId: "org-123",
+ });
+ useSettingsMock.mockReturnValue({ data: {} });
+ const { rerender } = renderHook(() => useTelemetryIdentity());
+
+ expect(trackBackendAddedMock).not.toHaveBeenCalled();
+
+ useSettingsMock.mockReturnValue({
+ data: { email: "", git_user_email: "[email protected]" },
+ });
+ rerender();
+
+ expect(trackBackendAddedMock).toHaveBeenCalledWith(
+ expect.objectContaining({ connectionMethod: "cloud_cookie" }),
+ );
+ });
+
+ it("dedupes cookie-auth backend additions when sessionStorage writes fail", () => {
+ const storageFailureCloudBackend = {
+ kind: "cloud" as const,
+ id: "cloud-storage-failure",
+ authMode: "cookie" as const,
+ };
+ useActiveBackendMock.mockReturnValue({
+ backend: storageFailureCloudBackend,
+ orgId: "org-123",
+ });
+ useCloudCurrentUserIdMock.mockReturnValue({
+ [storageFailureCloudBackend.id]: {
+ userId: "storage-failure-user",
+ isLoading: false,
+ },
+ });
+ const setItemSpy = vi
+ .spyOn(Storage.prototype, "setItem")
+ .mockImplementation(() => {
+ throw new Error("sessionStorage writes blocked");
+ });
+
+ try {
+ const { rerender } = renderHook(() => useTelemetryIdentity());
+ rerender();
+
+ expect(trackBackendAddedMock).toHaveBeenCalledTimes(1);
+ } finally {
+ setItemSpy.mockRestore();
+ }
+ });
+
+ it("does not track backend_added for non-cookie Cloud identity resolution", () => {
+ renderHook(() => useTelemetryIdentity());
+
+ expect(trackBackendAddedMock).not.toHaveBeenCalled();
+ });
});
diff --git a/src/hooks/use-telemetry-identity.ts b/src/hooks/use-telemetry-identity.ts
index adb7f4dcbb..8b407efc89 100644
--- a/src/hooks/use-telemetry-identity.ts
+++ b/src/hooks/use-telemetry-identity.ts
@@ -2,17 +2,67 @@ import React from "react";
import { useActiveBackend } from "#/contexts/active-backend-context";
import { useCloudCurrentUserId } from "#/hooks/query/use-cloud-current-user-id";
import { useSettings } from "#/hooks/query/use-settings";
+import { useTracking } from "#/hooks/use-tracking";
import { setTelemetryCloudContext } from "#/services/telemetry";
+const CLOUD_COOKIE_BACKEND_ADDED_SESSION_PREFIX =
+ "agent_canvas_cloud_cookie_backend_added";
+const trackedCloudCookieBackendAddedSessionKeys = new Set<string>();
+
+function getCloudCookieBackendAddedSessionKey(
+ backendId: string,
+ userId: string,
+): string {
+ return `${CLOUD_COOKIE_BACKEND_ADDED_SESSION_PREFIX}:${backendId}:${userId}`;
+}
+
+function hasTrackedCloudCookieBackendAddedThisSession(
+ backendId: string,
+ userId: string,
+): boolean {
+ const key = getCloudCookieBackendAddedSessionKey(backendId, userId);
+ if (typeof window === "undefined") return true;
+
+ try {
+ return (
+ window.sessionStorage.getItem(key) === "true" ||
+ trackedCloudCookieBackendAddedSessionKeys.has(key)
+ );
+ } catch {
+ return trackedCloudCookieBackendAddedSessionKeys.has(key);
+ }
+}
+
+function markCloudCookieBackendAddedTrackedThisSession(
+ backendId: string,
+ userId: string,
+): void {
+ const key = getCloudCookieBackendAddedSessionKey(backendId, userId);
+ if (typeof window === "undefined") return;
+
+ try {
+ window.sessionStorage.setItem(key, "true");
+ } catch {
+ trackedCloudCookieBackendAddedSessionKeys.add(key);
+ }
+}
+
/** Keep Cloud user event context aligned with the active backend. */
export const useTelemetryIdentity = () => {
const { backend, orgId } = useActiveBackend();
const { data: settings } = useSettings();
+ const { trackBackendAdded } = useTracking();
+ const trackBackendAddedRef = React.useRef(trackBackendAdded);
const userIds = useCloudCurrentUserId();
const identity = backend.kind === "cloud" ? userIds[backend.id] : undefined;
const isIdentityLoading = identity?.isLoading ?? true;
const userId = identity?.userId ?? null;
- const email = settings?.email || settings?.git_user_email || undefined;
+ const email =
+ (settings?.email || settings?.git_user_email)?.trim() || undefined;
+
+ React.useEffect(() => {
+ trackBackendAddedRef.current = trackBackendAdded;
+ }, [trackBackendAdded]);
React.useEffect(() => {
if (backend.kind !== "cloud") {
@@ -28,5 +78,27 @@ export const useTelemetryIdentity = () => {
}
setTelemetryCloudContext({ userId, email, orgId });
- }, [backend.kind, email, isIdentityLoading, orgId, userId]);
+
+ if (
+ backend.authMode === "cookie" &&
+ email &&
+ !hasTrackedCloudCookieBackendAddedThisSession(backend.id, userId)
+ ) {
+ trackBackendAddedRef.current({
+ backendKind: "cloud",
+ connectionMethod: "cloud_cookie",
+ hasApiKey: false,
+ source: "cloud_auto_connect",
+ });
+ markCloudCookieBackendAddedTrackedThisSession(backend.id, userId);
+ }
+ }, [
+ backend.authMode,
+ backend.id,
+ backend.kind,
+ email,
+ isIdentityLoading,
+ orgId,
+ userId,
+ ]);
};
diff --git a/src/hooks/use-tracking.ts b/src/hooks/use-tracking.ts
index 160e745825..a5fdf4fb86 100644
--- a/src/hooks/use-tracking.ts
+++ b/src/hooks/use-tracking.ts
@@ -6,7 +6,10 @@ import type { CloudConnectionSource } from "#/services/cloud-funnel-analytics";
import { getCachedAgentServerVersion } from "#/api/agent-server-compatibility";
import { useActiveBackend } from "#/contexts/active-backend-context";
import { useAutomationSdkVersion } from "#/hooks/query/use-automation-sdk-version";
-import { getBackendTelemetryProperties } from "#/services/telemetry-context";
+import {
+ type BackendConnectionMethod,
+ getBackendTelemetryProperties,
+} from "#/services/telemetry-context";
import { setTelemetryBackendContext, trackEvent } from "#/services/telemetry";
/**
@@ -267,7 +270,7 @@ export const useTracking = () => {
backendVersion,
}: {
backendKind: BackendKind;
- connectionMethod: "manual" | "cloud_login";
+ connectionMethod: BackendConnectionMethod;
hasApiKey: boolean;
source?: CloudConnectionSource;
agentServerVersion?: string | null;
diff --git a/src/services/cloud-funnel-analytics.ts b/src/services/cloud-funnel-analytics.ts
index 0df7142d67..cc2f45d6bf 100644
--- a/src/services/cloud-funnel-analytics.ts
+++ b/src/services/cloud-funnel-analytics.ts
@@ -5,7 +5,8 @@ import { trackEvent } from "#/services/telemetry";
export type CloudConnectionSource =
| "onboarding"
| "add_backend_modal"
- | "manage_backends_modal";
+ | "manage_backends_modal"
+ | "cloud_auto_connect";
const CLOUD_CONVERSATION_READY_INSERT_ID_PREFIX = `${AGENT_CANVAS_CLIENT_SOURCE}:cloud_conversation_ready`;
diff --git a/src/services/telemetry-context.ts b/src/services/telemetry-context.ts
index f4939811ce..a5ce460360 100644
--- a/src/services/telemetry-context.ts
+++ b/src/services/telemetry-context.ts
@@ -2,7 +2,7 @@ import type { BackendKind } from "#/api/backend-registry/types";
export const UNKNOWN_TELEMETRY_VERSION = "unknown";
-export type BackendConnectionMethod = "manual" | "cloud_login";
+export type BackendConnectionMethod = "manual" | "cloud_login" | "cloud_cookie";
export interface CloudTelemetryContextInput {
userId?: string | null;