Add client_version to AIDA DoConversation requests

Send the Chrome version as metadata to the AIDA API. This allows
sorting clients into different experiment groups based on Chrome
version.

`getChromeVersion` has been moved into `Runtime.ts` to avoid a
circular dependency.

Bug: 352823552
Change-Id: I8c18e1de3c0296db85392735cd6e2e74f894f724
Reviewed-on: https://chromium-review.googlesource.com/c/devtools/devtools-frontend/+/6218231
Commit-Queue: Alex Rudenko <[email protected]>
Reviewed-by: Alex Rudenko <[email protected]>
Auto-Submit: Wolfgang Beyer <[email protected]>
Commit-Queue: Wolfgang Beyer <[email protected]>

Author: wolfib

front_end/core/host/AidaClient.test.ts

@@ -2,13 +2,26 @@
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.
 
-import {describeWithEnvironment, updateHostConfig} from '../../testing/EnvironmentHelpers.js';
+import {
+  describeWithEnvironment,
+  restoreUserAgentForTesting,
+  setUserAgentForTesting,
+  updateHostConfig
+} from '../../testing/EnvironmentHelpers.js';
 
 import * as Host from './host.js';
 
 const TEST_MODEL_ID = 'testModelId';
 
 describeWithEnvironment('AidaClient', () => {
+  beforeEach(() => {
+    setUserAgentForTesting();
+  });
+
+  afterEach(() => {
+    restoreUserAgentForTesting();
+  });
+
   it('adds no model temperature if console insights is not enabled', () => {
     updateHostConfig({
       aidaAvailability: {
@@ -21,6 +34,10 @@ describeWithEnvironment('AidaClient', () => {
       client: 'CHROME_DEVTOOLS',
       client_feature: 1,
       functionality_type: 2,
+      metadata: {
+        disable_user_content_logging: false,
+        client_version: 'unit_test',
+      },
     });
   });
 
@@ -43,6 +60,10 @@ describeWithEnvironment('AidaClient', () => {
       },
       client_feature: 1,
       functionality_type: 2,
+      metadata: {
+        disable_user_content_logging: false,
+        client_version: 'unit_test',
+      },
     });
   });
 
@@ -65,6 +86,10 @@ describeWithEnvironment('AidaClient', () => {
       },
       client_feature: 1,
       functionality_type: 2,
+      metadata: {
+        disable_user_content_logging: false,
+        client_version: 'unit_test',
+      },
     });
   });
 
@@ -84,6 +109,10 @@ describeWithEnvironment('AidaClient', () => {
       client: 'CHROME_DEVTOOLS',
       client_feature: 1,
       functionality_type: 2,
+      metadata: {
+        disable_user_content_logging: false,
+        client_version: 'unit_test',
+      },
     });
   });
 
@@ -108,6 +137,10 @@ describeWithEnvironment('AidaClient', () => {
       },
       client_feature: 1,
       functionality_type: 2,
+      metadata: {
+        disable_user_content_logging: false,
+        client_version: 'unit_test',
+      },
     });
   });
 
@@ -127,6 +160,7 @@ describeWithEnvironment('AidaClient', () => {
       client: 'CHROME_DEVTOOLS',
       metadata: {
         disable_user_content_logging: true,
+        client_version: 'unit_test',
       },
       options: {
         temperature: 0.5,

front_end/core/host/AidaClient.ts

@@ -159,10 +159,12 @@ export interface AidaRequest {
     // eslint-disable-next-line @typescript-eslint/naming-convention
     model_id?: string,
   };
-  metadata?: {
+  metadata: {
     // eslint-disable-next-line @typescript-eslint/naming-convention
     disable_user_content_logging: boolean,
     // eslint-disable-next-line @typescript-eslint/naming-convention
+    client_version: string,
+    // eslint-disable-next-line @typescript-eslint/naming-convention
     string_session_id?: string,
     // eslint-disable-next-line @typescript-eslint/naming-convention
     user_tier?: UserTier,
@@ -264,12 +266,6 @@ export class AidaBlockError extends Error {}
 
 export class AidaClient {
   static buildConsoleInsightsRequest(input: string): AidaRequest {
-    const request: AidaRequest = {
-      current_message: {parts: [{text: input}], role: Role.USER},
-      client: CLIENT_NAME,
-      functionality_type: FunctionalityType.EXPLAIN_ERROR,
-      client_feature: ClientFeature.CHROME_CONSOLE_INSIGHTS,
-    };
     const {hostConfig} = Root.Runtime;
     let temperature = -1;
     let modelId = '';
@@ -278,6 +274,20 @@ export class AidaClient {
       modelId = hostConfig.devToolsConsoleInsights.modelId || '';
     }
     const disallowLogging = hostConfig.aidaAvailability?.disallowLogging ?? true;
+    const chromeVersion = Root.Runtime.getChromeVersion();
+    if (!chromeVersion) {
+      throw new Error('Cannot determine Chrome version');
+    }
+    const request: AidaRequest = {
+      current_message: {parts: [{text: input}], role: Role.USER},
+      client: CLIENT_NAME,
+      functionality_type: FunctionalityType.EXPLAIN_ERROR,
+      client_feature: ClientFeature.CHROME_CONSOLE_INSIGHTS,
+      metadata: {
+        disable_user_content_logging: disallowLogging,
+        client_version: chromeVersion,
+      },
+    };
 
     if (temperature >= 0) {
       request.options ??= {};
@@ -287,11 +297,6 @@ export class AidaClient {
       request.options ??= {};
       request.options.model_id = modelId;
     }
-    if (disallowLogging) {
-      request.metadata = {
-        disable_user_content_logging: true,
-      };
-    }
     return request;
   }
 

front_end/core/root/Runtime.test.ts

@@ -61,4 +61,8 @@ describe('Runtime', () => {
 
     assert.deepEqual(experiments.map(experiment => experiment.name), ['example', 'configurable']);
   });
+
+  it('getChromeVersion result has the correct shape', () => {
+    assert.isTrue(/^\d{3}\.0\.0\.0$/.test(Root.Runtime.getChromeVersion()));
+  });
 });

front_end/core/root/Runtime.ts

@@ -38,6 +38,15 @@ export function isNodeEntry(pathname: string): boolean {
   return nodeEntryPoints.some(component => pathname.includes(component));
 }
 
+export const getChromeVersion = (): string => {
+  const chromeRegex = /(?:^|\W)(?:Chrome|HeadlessChrome)\/(\S+)/;
+  const chromeMatch = navigator.userAgent.match(chromeRegex);
+  if (chromeMatch && chromeMatch.length > 1) {
+    return chromeMatch[1];
+  }
+  return '';
+};
+
 export class Runtime {
   private constructor() {
   }

front_end/core/sdk/NetworkManager.ts

@@ -1362,19 +1362,10 @@ export class MultitargetNetworkManager extends Common.ObjectWrapper.ObjectWrappe
     multiTargetNetworkManagerInstance = null;
   }
 
-  static getChromeVersion(): string {
-    const chromeRegex = /(?:^|\W)(?:Chrome|HeadlessChrome)\/(\S+)/;
-    const chromeMatch = navigator.userAgent.match(chromeRegex);
-    if (chromeMatch && chromeMatch.length > 1) {
-      return chromeMatch[1];
-    }
-    return '';
-  }
-
   static patchUserAgentWithChromeVersion(uaString: string): string {
     // Patches Chrome/ChrOS version from user #agent ("1.2.3.4" when user #agent is: "Chrome/1.2.3.4").
     // Otherwise, ignore it. This assumes additional appVersions appear after the Chrome version.
-    const chromeVersion = MultitargetNetworkManager.getChromeVersion();
+    const chromeVersion = Root.Runtime.getChromeVersion();
     if (chromeVersion.length > 0) {
       // "1.2.3.4" becomes "1.0.100.0"
       const additionalAppVersion = chromeVersion.split('.', 1)[0] + '.0.100.0';
@@ -1389,7 +1380,7 @@ export class MultitargetNetworkManager extends Common.ObjectWrapper.ObjectWrappe
     if (!userAgentMetadata.brands) {
       return;
     }
-    const chromeVersion = MultitargetNetworkManager.getChromeVersion();
+    const chromeVersion = Root.Runtime.getChromeVersion();
     if (chromeVersion.length === 0) {
       return;
     }

front_end/panels/ai_assistance/agents/AiAgent.ts

@@ -3,6 +3,7 @@
 // found in the LICENSE file.
 
 import * as Host from '../../../core/host/host.js';
+import * as Root from '../../../core/root/root.js';
 import type * as Lit from '../../../ui/lit/lit.js';
 import {debugLog, isDebugMode} from '../debug.js';
 
@@ -290,6 +291,7 @@ export abstract class AiAgent<T> {
         disable_user_content_logging: !(this.#serverSideLoggingEnabled ?? false),
         string_session_id: this.#sessionId,
         user_tier: Host.AidaClient.convertToUserTierEnum(this.userTier),
+        client_version: Root.Runtime.getChromeVersion(),
       },
 
       functionality_type: declarations.length ? Host.AidaClient.FunctionalityType.AGENTIC_CHAT :

front_end/panels/ai_assistance/agents/FileAgent.test.ts

@@ -7,7 +7,11 @@ import * as SDK from '../../../core/sdk/sdk.js';
 import * as Bindings from '../../../models/bindings/bindings.js';
 import * as Workspace from '../../../models/workspace/workspace.js';
 import {createUISourceCode, mockAidaClient} from '../../../testing/AiAssistanceHelpers.js';
-import {updateHostConfig} from '../../../testing/EnvironmentHelpers.js';
+import {
+  restoreUserAgentForTesting,
+  setUserAgentForTesting,
+  updateHostConfig,
+} from '../../../testing/EnvironmentHelpers.js';
 import {describeWithMockConnection} from '../../../testing/MockConnection.js';
 import {FileAgent, FileContext, ResponseType} from '../ai_assistance.js';
 
@@ -74,6 +78,7 @@ describeWithMockConnection('FileAgent', () => {
       sinon.stub(agent, 'preamble').value('preamble');
       await Array.fromAsync(agent.run('question', {selected: null}));
 
+      setUserAgentForTesting();
       assert.deepEqual(
           agent.buildRequest({text: 'test input'}, Host.AidaClient.Role.USER),
           {
@@ -94,6 +99,7 @@ describeWithMockConnection('FileAgent', () => {
               disable_user_content_logging: false,
               string_session_id: 'sessionId',
               user_tier: 2,
+              client_version: 'unit_test',
             },
             options: {
               model_id: 'test model',
@@ -103,6 +109,7 @@ describeWithMockConnection('FileAgent', () => {
             functionality_type: 1,
           },
       );
+      restoreUserAgentForTesting();
     });
   });
 

front_end/panels/ai_assistance/agents/PerformanceAgent.test.ts

@@ -5,7 +5,12 @@
 import * as Host from '../../../core/host/host.js';
 import * as Trace from '../../../models/trace/trace.js';
 import {mockAidaClient} from '../../../testing/AiAssistanceHelpers.js';
-import {describeWithEnvironment, updateHostConfig} from '../../../testing/EnvironmentHelpers.js';
+import {
+  describeWithEnvironment,
+  restoreUserAgentForTesting,
+  setUserAgentForTesting,
+  updateHostConfig
+} from '../../../testing/EnvironmentHelpers.js';
 import {TraceLoader} from '../../../testing/TraceLoader.js';
 import * as TimelineUtils from '../../timeline/utils/utils.js';
 import {CallTreeContext, PerformanceAgent, ResponseType} from '../ai_assistance.js';
@@ -83,6 +88,7 @@ describeWithEnvironment('PerformanceAgent', () => {
       sinon.stub(agent, 'preamble').value('preamble');
 
       await Array.fromAsync(agent.run('question', {selected: null}));
+      setUserAgentForTesting();
 
       assert.deepEqual(
           agent.buildRequest(
@@ -108,6 +114,7 @@ describeWithEnvironment('PerformanceAgent', () => {
               disable_user_content_logging: false,
               string_session_id: 'sessionId',
               user_tier: 2,
+              client_version: 'unit_test',
             },
             options: {
               model_id: 'test model',
@@ -117,6 +124,7 @@ describeWithEnvironment('PerformanceAgent', () => {
             functionality_type: 1,
           },
       );
+      restoreUserAgentForTesting();
     });
   });
   describe('run', function() {

front_end/panels/ai_assistance/agents/StylingAgent.test.ts

@@ -8,6 +8,8 @@ import * as SDK from '../../../core/sdk/sdk.js';
 import {mockAidaClient} from '../../../testing/AiAssistanceHelpers.js';
 import {
   describeWithEnvironment,
+  restoreUserAgentForTesting,
+  setUserAgentForTesting,
   updateHostConfig,
 } from '../../../testing/EnvironmentHelpers.js';
 import * as AiAssistance from '../ai_assistance.js';
@@ -527,6 +529,7 @@ c`;
       sinon.stub(agent, 'preamble').value('preamble');
       await Array.fromAsync(agent.run('question', {selected: null}));
 
+      setUserAgentForTesting();
       assert.deepEqual(
           agent.buildRequest(
               {
@@ -551,6 +554,7 @@ c`;
               disable_user_content_logging: false,
               string_session_id: 'sessionId',
               user_tier: 2,
+              client_version: 'unit_test',
             },
             options: {
               model_id: 'test model',
@@ -560,6 +564,7 @@ c`;
             functionality_type: 1,
           },
       );
+      restoreUserAgentForTesting();
     });
 
     it('builds a request with aborted query in history before a real request', async () => {

front_end/testing/EnvironmentHelpers.ts

@@ -501,6 +501,17 @@ export function expectConsoleLogs(expectedLogs: {warn?: string[], log?: string[]
   });
 }
 
+let originalUserAgent: string;
+
+export function setUserAgentForTesting(): void {
+  originalUserAgent = window.navigator.userAgent;
+  Object.defineProperty(window.navigator, 'userAgent', {value: 'Chrome/unit_test', configurable: true});
+}
+
+export function restoreUserAgentForTesting(): void {
+  Object.defineProperty(window.navigator, 'userAgent', {value: originalUserAgent});
+}
+
 export function resetHostConfig() {
   for (const key of Object.keys(Root.Runtime.hostConfig)) {
     // @ts-expect-error