summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authormatt korwel <[email protected]>2025-07-09 21:51:37 -0700
committerGitHub <[email protected]>2025-07-09 21:51:37 -0700
commit58607b92dfe76dd657338b5433d0fd33800f9272 (patch)
tree4a07182ca01f20074a5544db5caf5a198cabae6c
parentb7f8e1360fc13c077c24c98fe9d85e0734195000 (diff)
Revert "fix: Use Email for Clearcut Logging and Refactor User Info Fetching" (#3744)
-rw-r--r--packages/core/src/code_assist/oauth2.test.ts19
-rw-r--r--packages/core/src/code_assist/oauth2.ts99
-rw-r--r--packages/core/src/telemetry/clearcut-logger/clearcut-logger.ts33
-rw-r--r--packages/core/src/utils/user_id.test.ts26
-rw-r--r--packages/core/src/utils/user_id.ts30
5 files changed, 108 insertions, 99 deletions
diff --git a/packages/core/src/code_assist/oauth2.test.ts b/packages/core/src/code_assist/oauth2.test.ts
index 58081e6a..76d43726 100644
--- a/packages/core/src/code_assist/oauth2.test.ts
+++ b/packages/core/src/code_assist/oauth2.test.ts
@@ -61,11 +61,30 @@ describe('oauth2', () => {
const mockGetAccessToken = vi
.fn()
.mockResolvedValue({ token: 'mock-access-token' });
+ const mockRefreshAccessToken = vi.fn().mockImplementation((callback) => {
+ // Mock the callback-style refreshAccessToken method
+ const mockTokensWithIdToken = {
+ access_token: 'test-access-token',
+ refresh_token: 'test-refresh-token',
+ id_token:
+ 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiJ0ZXN0LWdvb2dsZS1hY2NvdW50LWlkLTEyMyJ9.signature', // Mock JWT with sub: test-google-account-id-123
+ };
+ callback(null, mockTokensWithIdToken);
+ });
+ const mockVerifyIdToken = vi.fn().mockResolvedValue({
+ getPayload: () => ({
+ sub: 'test-google-account-id-123',
+ aud: 'test-audience',
+ iss: 'https://accounts.google.com',
+ }),
+ });
const mockOAuth2Client = {
generateAuthUrl: mockGenerateAuthUrl,
getToken: mockGetToken,
setCredentials: mockSetCredentials,
getAccessToken: mockGetAccessToken,
+ refreshAccessToken: mockRefreshAccessToken,
+ verifyIdToken: mockVerifyIdToken,
credentials: mockTokens,
on: vi.fn(),
} as unknown as OAuth2Client;
diff --git a/packages/core/src/code_assist/oauth2.ts b/packages/core/src/code_assist/oauth2.ts
index c2fd0d12..93d0e28b 100644
--- a/packages/core/src/code_assist/oauth2.ts
+++ b/packages/core/src/code_assist/oauth2.ts
@@ -44,7 +44,6 @@ const SIGN_IN_FAILURE_URL =
const GEMINI_DIR = '.gemini';
const CREDENTIAL_FILENAME = 'oauth_creds.json';
const GOOGLE_ACCOUNT_ID_FILENAME = 'google_account_id';
-const GOOGLE_ACCOUNT_EMAIL_FILENAME = 'google_account_email';
/**
* An Authentication URL for updating the credentials of a Oauth2Client
@@ -71,10 +70,13 @@ export async function getOauthClient(
// If there are cached creds on disk, they always take precedence
if (await loadCachedCredentials(client)) {
// Found valid cached credentials.
- // Check if we need to retrieve Google Account ID or Email
- if (!getCachedGoogleAccountId() || !getCachedGoogleAccountEmail()) {
+ // Check if we need to retrieve Google Account ID
+ if (!getCachedGoogleAccountId()) {
try {
- await fetchAndCacheUserInfo(client);
+ const googleAccountId = await getRawGoogleAccountId(client);
+ if (googleAccountId) {
+ await cacheGoogleAccountId(googleAccountId);
+ }
} catch {
// Non-fatal, continue with existing auth.
}
@@ -161,7 +163,10 @@ async function authWithWeb(client: OAuth2Client): Promise<OauthWebLogin> {
client.setCredentials(tokens);
// Retrieve and cache Google Account ID during authentication
try {
- await fetchAndCacheUserInfo(client);
+ const googleAccountId = await getRawGoogleAccountId(client);
+ if (googleAccountId) {
+ await cacheGoogleAccountId(googleAccountId);
+ }
} catch (error) {
console.error(
'Failed to retrieve Google Account ID during authentication:',
@@ -270,73 +275,57 @@ export function getCachedGoogleAccountId(): string | null {
}
}
-function getGoogleAccountEmailCachePath(): string {
- return path.join(os.homedir(), GEMINI_DIR, GOOGLE_ACCOUNT_EMAIL_FILENAME);
-}
-
-async function cacheGoogleAccountEmail(email: string): Promise<void> {
- const filePath = getGoogleAccountEmailCachePath();
- await fs.mkdir(path.dirname(filePath), { recursive: true });
- await fs.writeFile(filePath, email, 'utf-8');
-}
-
-export function getCachedGoogleAccountEmail(): string | null {
- try {
- const filePath = getGoogleAccountEmailCachePath();
- if (existsSync(filePath)) {
- return readFileSync(filePath, 'utf-8').trim() || null;
- }
- return null;
- } catch (error) {
- console.debug('Error reading cached Google Account Email:', error);
- return null;
- }
-}
-
export async function clearCachedCredentialFile() {
try {
await fs.rm(getCachedCredentialPath(), { force: true });
// Clear the Google Account ID cache when credentials are cleared
await fs.rm(getGoogleAccountIdCachePath(), { force: true });
- await fs.rm(getGoogleAccountEmailCachePath(), { force: true });
} catch (_) {
/* empty */
}
}
-async function fetchAndCacheUserInfo(client: OAuth2Client): Promise<void> {
+/**
+ * Retrieves the authenticated user's Google Account ID from Google's UserInfo API.
+ * @param client - The authenticated OAuth2Client
+ * @returns The user's Google Account ID or null if not available
+ */
+export async function getRawGoogleAccountId(
+ client: OAuth2Client,
+): Promise<string | null> {
try {
- const { token } = await client.getAccessToken();
- if (!token) {
- return;
- }
-
- const response = await fetch(
- 'https://www.googleapis.com/oauth2/v2/userinfo',
- {
- headers: {
- Authorization: `Bearer ${token}`,
- },
+ // 1. Get a new Access Token including the id_token
+ const refreshedTokens = await new Promise<Credentials | null>(
+ (resolve, reject) => {
+ client.refreshAccessToken((err, tokens) => {
+ if (err) {
+ return reject(err);
+ }
+ resolve(tokens ?? null);
+ });
},
);
- if (!response.ok) {
- console.error(
- 'Failed to fetch user info:',
- response.status,
- response.statusText,
- );
- return;
+ if (!refreshedTokens?.id_token) {
+ console.warn('No id_token obtained after refreshing tokens.');
+ return null;
}
- const userInfo = await response.json();
- if (userInfo.id) {
- await cacheGoogleAccountId(userInfo.id);
- }
- if (userInfo.email) {
- await cacheGoogleAccountEmail(userInfo.email);
+ // 2. Verify the ID token to securely get the user's Google Account ID.
+ const ticket = await client.verifyIdToken({
+ idToken: refreshedTokens.id_token,
+ audience: OAUTH_CLIENT_ID,
+ });
+
+ const payload = ticket.getPayload();
+ if (!payload?.sub) {
+ console.warn('Could not extract sub claim from verified ID token.');
+ return null;
}
+
+ return payload.sub;
} catch (error) {
- console.error('Error retrieving user info:', error);
+ console.error('Error retrieving or verifying Google Account ID:', error);
+ return null;
}
}
diff --git a/packages/core/src/telemetry/clearcut-logger/clearcut-logger.ts b/packages/core/src/telemetry/clearcut-logger/clearcut-logger.ts
index 1b1cec04..a64a9795 100644
--- a/packages/core/src/telemetry/clearcut-logger/clearcut-logger.ts
+++ b/packages/core/src/telemetry/clearcut-logger/clearcut-logger.ts
@@ -17,10 +17,8 @@ import {
} from '../types.js';
import { EventMetadataKey } from './event-metadata-key.js';
import { Config } from '../../config/config.js';
-import {
- getInstallationId,
- getGoogleAccountEmail,
-} from '../../utils/user_id.js';
+import { getInstallationId } from '../../utils/user_id.js';
+import { getGoogleAccountId } from '../../utils/user_id.js';
const start_session_event_name = 'start_session';
const new_prompt_event_name = 'new_prompt';
@@ -68,23 +66,13 @@ export class ClearcutLogger {
}
createLogEvent(name: string, data: object): object {
- // eslint-disable-next-line @typescript-eslint/no-explicit-any
- const logEvent: any = {
+ return {
console_type: 'GEMINI_CLI',
application: 102,
event_name: name,
+ client_install_id: getInstallationId(),
event_metadata: [data] as object[],
};
-
- const email = getGoogleAccountEmail();
- // Should log either email or install ID, not both. See go/cloudmill-1p-oss-instrumentation#define-sessionable-id
- if (email) {
- logEvent.client_email = email;
- } else {
- logEvent.client_install_id = getInstallationId();
- }
-
- return logEvent;
}
flushIfNeeded(): void {
@@ -92,24 +80,33 @@ export class ClearcutLogger {
return;
}
+ // Fire and forget - don't await
this.flushToClearcut().catch((error) => {
console.debug('Error flushing to Clearcut:', error);
});
}
- flushToClearcut(): Promise<LogResponse> {
+ async flushToClearcut(): Promise<LogResponse> {
if (this.config?.getDebugMode()) {
console.log('Flushing log events to Clearcut.');
}
const eventsToSend = [...this.events];
this.events.length = 0;
+ const googleAccountId = await getGoogleAccountId();
+
return new Promise<Buffer>((resolve, reject) => {
const request = [
{
log_source_name: 'CONCORD',
request_time_ms: Date.now(),
log_event: eventsToSend,
+ // Add UserInfo with the raw Gaia ID
+ user_info: googleAccountId
+ ? {
+ UserID: googleAccountId,
+ }
+ : undefined,
},
];
const body = JSON.stringify(request);
@@ -258,7 +255,7 @@ export class ClearcutLogger {
this.enqueueLogEvent(this.createLogEvent(start_session_event_name, data));
// Flush start event immediately
this.flushToClearcut().catch((error) => {
- console.debug('Error flushing to Clearcut:', error);
+ console.debug('Error flushing start session event to Clearcut:', error);
});
}
diff --git a/packages/core/src/utils/user_id.test.ts b/packages/core/src/utils/user_id.test.ts
index 42d8958c..185d6c95 100644
--- a/packages/core/src/utils/user_id.test.ts
+++ b/packages/core/src/utils/user_id.test.ts
@@ -5,7 +5,7 @@
*/
import { describe, it, expect } from 'vitest';
-import { getInstallationId, getGoogleAccountEmail } from './user_id.js';
+import { getInstallationId, getGoogleAccountId } from './user_id.js';
describe('user_id', () => {
describe('getInstallationId', () => {
@@ -22,24 +22,30 @@ describe('user_id', () => {
});
});
- describe('getGoogleAccountEmail', () => {
- it('should return a non-empty string', () => {
- const result = getGoogleAccountEmail();
+ describe('getGoogleAccountId', () => {
+ it('should return a non-empty string', async () => {
+ const result = await getGoogleAccountId();
expect(result).toBeDefined();
expect(typeof result).toBe('string');
// Should be consistent on subsequent calls
- const secondCall = getGoogleAccountEmail();
+ const secondCall = await getGoogleAccountId();
expect(secondCall).toBe(result);
});
- it('should return empty string when no Google Account email is cached', () => {
- // In a clean test environment, there should be no cached Google Account email
- const googleAccountEmailResult = getGoogleAccountEmail();
+ it('should return empty string when no Google Account ID is cached, or a valid ID when cached', async () => {
+ // The function can return either an empty string (if no cached ID) or a valid Google Account ID (if cached)
+ const googleAccountIdResult = await getGoogleAccountId();
- // They should be the same when no Google Account email is cached
- expect(googleAccountEmailResult).toBe('');
+ expect(googleAccountIdResult).toBeDefined();
+ expect(typeof googleAccountIdResult).toBe('string');
+
+ // Should be either empty string or a numeric string (Google Account ID)
+ if (googleAccountIdResult !== '') {
+ // If we have a cached ID, it should be a numeric string
+ expect(googleAccountIdResult).toMatch(/^\d+$/);
+ }
});
});
});
diff --git a/packages/core/src/utils/user_id.ts b/packages/core/src/utils/user_id.ts
index 045cbd77..42bbee35 100644
--- a/packages/core/src/utils/user_id.ts
+++ b/packages/core/src/utils/user_id.ts
@@ -8,11 +8,8 @@ import * as os from 'os';
import * as fs from 'fs';
import * as path from 'path';
import { randomUUID } from 'crypto';
-import { createRequire } from 'module';
import { GEMINI_DIR } from './paths.js';
-const require = createRequire(import.meta.url);
-
const homeDir = os.homedir() ?? '';
const geminiDir = path.join(homeDir, GEMINI_DIR);
const installationIdFile = path.join(geminiDir, 'installation_id');
@@ -61,23 +58,24 @@ export function getInstallationId(): string {
}
/**
- * Retrieves the email for the currently authenticated user.
- * When OAuth is available, returns the user's cached email. Otherwise, returns an empty string.
- * @returns A string email for the user (Google Account email if available, otherwise empty string).
+ * Retrieves the obfuscated Google Account ID for the currently authenticated user.
+ * When OAuth is available, returns the user's cached Google Account ID. Otherwise, returns the installation ID.
+ * @returns A string ID for the user (Google Account ID if available, otherwise installation ID).
*/
-export function getGoogleAccountEmail(): string {
- // Try to get cached Google Account email first
+export async function getGoogleAccountId(): Promise<string> {
+ // Try to get cached Google Account ID first
try {
- // Dynamically import to avoid circular dependencies
- // eslint-disable-next-line no-restricted-syntax
- const { getCachedGoogleAccountEmail } = require('../code_assist/oauth2.js');
- const googleAccountEmail = getCachedGoogleAccountEmail();
- if (googleAccountEmail) {
- return googleAccountEmail;
+ // Dynamic import to avoid circular dependencies
+ const { getCachedGoogleAccountId } = await import(
+ '../code_assist/oauth2.js'
+ );
+ const googleAccountId = getCachedGoogleAccountId();
+ if (googleAccountId) {
+ return googleAccountId;
}
} catch (error) {
- // If there's any error accessing Google Account email, just return empty string
- console.debug('Could not get cached Google Account email:', error);
+ // If there's any error accessing Google Account ID, just return empty string
+ console.debug('Could not get cached Google Account ID:', error);
}
return '';