[AI Assistance] extract file operations

Bug: 399563024
Change-Id: Ib9b06888cea4a3d8290cf69ed64ef5ea1ad0ae16
Reviewed-on: https://chromium-review.googlesource.com/c/devtools/devtools-frontend/+/6321927
Commit-Queue: Alex Rudenko <[email protected]>
Reviewed-by: Ergün Erdoğmuş <[email protected]>

Author: OrKoN

config/gni/devtools_grd_files.gni

@@ -1201,6 +1201,7 @@ grd_files_debug_sources = [
   "front_end/panels/accessibility/accessibilityNode.css.js",
   "front_end/panels/accessibility/accessibilityProperties.css.js",
   "front_end/panels/accessibility/axBreadcrumbs.css.js",
+  "front_end/panels/ai_assistance/AgentProject.js",
   "front_end/panels/ai_assistance/AiAssistancePanel.js",
   "front_end/panels/ai_assistance/AiHistoryStorage.js",
   "front_end/panels/ai_assistance/ChangeManager.js",

front_end/panels/ai_assistance/AgentProject.test.ts

@@ -0,0 +1,53 @@
+// Copyright 2024 The Chromium Authors. All rights reserved.
+// Use of this source code is governed by a BSD-style license that can be
+// found in the LICENSE file.
+
+import * as Platform from '../../core/platform/platform.js';
+import {describeWithEnvironment} from '../../testing/EnvironmentHelpers.js';
+import {createFileSystemUISourceCode} from '../../testing/UISourceCodeHelpers.js';
+
+import * as AiAssistance from './ai_assistance.js';
+
+describeWithEnvironment('AgentProject', () => {
+  async function mockProject() {
+    const {project, uiSourceCode} = createFileSystemUISourceCode({
+      url: Platform.DevToolsPath.urlString`file:///path/to/overrides/example.html`,
+      fileSystemPath: Platform.DevToolsPath.urlString`file:///path/to/overrides/`,
+      mimeType: 'text/html',
+      content: 'content',
+    });
+
+    uiSourceCode.setWorkingCopy('content working copy');
+
+    return {project: new AiAssistance.AgentProject(project), uiSourceCode};
+  }
+
+  it('can list files', async () => {
+    const {project} = await mockProject();
+
+    assert.deepEqual(project.getFiles(), ['example.html']);
+  });
+
+  it('can search files', async () => {
+    const {project} = await mockProject();
+
+    assert.deepEqual(await project.searchFiles('content working copy'), [{
+                       columnNumber: 0,
+                       filepath: 'example.html',
+                       lineNumber: 0,
+                       matchLength: 20,
+                     }]);
+  });
+
+  it('can read files', async () => {
+    const {project} = await mockProject();
+
+    assert.deepEqual(project.readFile('example.html'), 'content working copy');
+  });
+
+  it('can write files files', async () => {
+    const {project} = await mockProject();
+    project.writeFile('example.html', 'updated');
+    assert.deepEqual(project.readFile('example.html'), 'updated');
+  });
+});

front_end/panels/ai_assistance/AgentProject.ts

@@ -0,0 +1,103 @@
+// Copyright 2025 The Chromium Authors. All rights reserved.
+// Use of this source code is governed by a BSD-style license that can be
+// found in the LICENSE file.
+
+import * as TextUtils from '../../models/text_utils/text_utils.js';
+import type * as Workspace from '../../models/workspace/workspace.js';
+
+import {debugLog} from './debug.js';
+
+/**
+ * AgentProject wraps around a Workspace.Workspace.Project and
+ * implements AI Assistance-specific logic for accessing workspace files
+ * including additional checks and restrictions.
+ */
+export class AgentProject {
+  #project: Workspace.Workspace.Project;
+
+  constructor(project: Workspace.Workspace.Project) {
+    this.#project = project;
+  }
+
+  #indexFiles(): {files: string[], map: Map<string, Workspace.UISourceCode.UISourceCode>} {
+    const files = [];
+    const map = new Map();
+    for (const uiSourceCode of this.#project.uiSourceCodes()) {
+      // fullDisplayName includes the project name. TODO: a better
+      // getter for a relative file path is needed.
+      let path = uiSourceCode.fullDisplayName();
+      const idx = path.indexOf('/');
+      if (idx !== -1) {
+        path = path.substring(idx + 1);
+      }
+      files.push(path);
+      map.set(path, uiSourceCode);
+    }
+    return {files, map};
+  }
+
+  /**
+   * Provides file names in the project to the agent.
+   */
+  getFiles(): string[] {
+    return this.#indexFiles().files;
+  }
+
+  /**
+   * Provides access to the file content in the working copy
+   * of the matching UiSourceCode.
+   */
+  readFile(filepath: string): string|undefined {
+    const {map} = this.#indexFiles();
+    const uiSourceCode = map.get(filepath);
+    if (!uiSourceCode) {
+      return;
+    }
+    // TODO: needs additional handling for binary files.
+    return uiSourceCode.workingCopyContentData().text;
+  }
+
+  /**
+   * This method updates the file content in the working copy of the
+   * UiSourceCode identified by the filepath.
+   */
+  writeFile(filepath: string, content: string): void {
+    const {map} = this.#indexFiles();
+    const uiSourceCode = map.get(filepath);
+    if (!uiSourceCode) {
+      throw new Error(`UISourceCode ${filepath} not found`);
+    }
+    uiSourceCode.setWorkingCopy(content);
+  }
+
+  /**
+   * This method searches in files for the agent and provides the
+   * matches to the agent.
+   */
+  async searchFiles(query: string, caseSensitive?: boolean, isRegex?: boolean): Promise<Array<{
+    filepath: string,
+    lineNumber: number,
+    columnNumber: number,
+    matchLength: number,
+  }>> {
+    const {map} = this.#indexFiles();
+    const matches = [];
+    for (const [filepath, file] of map.entries()) {
+      await file.requestContentData();
+      debugLog('searching in', filepath, 'for', query);
+      const content = file.isDirty() ? file.workingCopyContentData() : await file.requestContentData();
+      const results =
+          TextUtils.TextUtils.performSearchInContentData(content, query, caseSensitive ?? true, isRegex ?? false);
+      for (const result of results) {
+        debugLog('matches in', filepath);
+        matches.push({
+          filepath,
+          lineNumber: result.lineNumber,
+          columnNumber: result.columnNumber,
+          matchLength: result.matchLength
+        });
+      }
+    }
+    return matches;
+  }
+}

front_end/panels/ai_assistance/BUILD.gn

@@ -18,6 +18,7 @@ generate_css("css_files") {
 
 devtools_module("ai_assistance") {
   sources = [
+    "AgentProject.ts",
     "AiAssistancePanel.ts",
     "AiHistoryStorage.ts",
     "ChangeManager.ts",
@@ -96,6 +97,7 @@ ts_library("unittests") {
   testonly = true
 
   sources = [
+    "AgentProject.test.ts",
     "AiAssistancePanel.test.ts",
     "AiHistoryStorage.test.ts",
     "ChangeManager.test.ts",

front_end/panels/ai_assistance/agents/PatchAgent.ts

@@ -3,8 +3,8 @@
 // found in the LICENSE file.
 
 import * as Host from '../../../core/host/host.js';
-import * as TextUtils from '../../../models/text_utils/text_utils.js';
 import type * as Workspace from '../../../models/workspace/workspace.js';
+import {AgentProject} from '../AgentProject.js';
 import {debugLog} from '../debug.js';
 
 import {
@@ -18,24 +18,8 @@ import {
   ResponseType,
 } from './AiAgent.js';
 
-function getFiles(project: Workspace.Workspace.Project):
-    {files: string[], map: Map<string, Workspace.UISourceCode.UISourceCode>} {
-  const files = [];
-  const map = new Map();
-  for (const uiSourceCode of project.uiSourceCodes()) {
-    let path = uiSourceCode.fullDisplayName();
-    const idx = path.indexOf('/');
-    if (idx !== -1) {
-      path = path.substring(idx + 1);
-    }
-    files.push(path);
-    map.set(path, uiSourceCode);
-  }
-  return {files, map};
-}
-
 export class PatchAgent extends AiAgent<Workspace.Workspace.Project> {
-  #project: Workspace.Workspace.Project;
+  #project: AgentProject;
   #fileUpdateAgent: FileUpdateAgent;
   #changeSummary = '';
 
@@ -63,7 +47,7 @@ export class PatchAgent extends AiAgent<Workspace.Workspace.Project> {
 
   constructor(opts: BaseAgentOptions&{fileUpdateAgent?: FileUpdateAgent, project: Workspace.Workspace.Project}) {
     super(opts);
-    this.#project = opts.project;
+    this.#project = new AgentProject(opts.project);
     this.#fileUpdateAgent = opts.fileUpdateAgent ?? new FileUpdateAgent(opts);
     this.declareFunction<Record<never, unknown>>('listFiles', {
       description: 'Returns a list of all files in the project.',
@@ -74,16 +58,9 @@ export class PatchAgent extends AiAgent<Workspace.Workspace.Project> {
         properties: {},
       },
       handler: async () => {
-        if (!this.#project) {
-          return {
-            error: 'No project available',
-          };
-        }
-        const project = this.#project;
-        const {files} = getFiles(project);
         return {
           result: {
-            files,
+            files: this.#project.getFiles(),
           }
         };
       },
@@ -119,33 +96,9 @@ export class PatchAgent extends AiAgent<Workspace.Workspace.Project> {
         },
       },
       handler: async params => {
-        if (!this.#project) {
-          return {
-            error: 'No project available',
-          };
-        }
-        const project = this.#project;
-        const {map} = getFiles(project);
-        const matches = [];
-        for (const [filepath, file] of map.entries()) {
-          await file.requestContentData();
-          debugLog('searching in', filepath, 'for', params.query);
-          const content = file.isDirty() ? file.workingCopyContentData() : await file.requestContentData();
-          const results = TextUtils.TextUtils.performSearchInContentData(
-              content, params.query, params.caseSensitive ?? true, params.isRegex ?? false);
-          for (const result of results) {
-            debugLog('matches in', filepath);
-            matches.push({
-              filepath,
-              lineNumber: result.lineNumber,
-              columnNumber: result.columnNumber,
-              matchLength: result.matchLength
-            });
-          }
-        }
         return {
           result: {
-            matches,
+            matches: await this.#project.searchFiles(params.query, params.caseSensitive, params.isRegex),
           }
         };
       },
@@ -170,17 +123,10 @@ export class PatchAgent extends AiAgent<Workspace.Workspace.Project> {
       },
       handler: async args => {
         debugLog('updateFiles', args.files);
-        if (!this.#project) {
-          return {
-            error: 'No project available',
-          };
-        }
-        const project = this.#project;
-        const {map} = getFiles(project);
         for (const file of args.files.slice(0, 3)) {
           debugLog('updating', file);
-          const uiSourceCode = map.get(file);
-          if (!uiSourceCode) {
+          const content = this.#project.readFile(file);
+          if (content === undefined) {
             debugLog(file, 'not found');
             continue;
           }
@@ -194,7 +140,7 @@ Following '===' I provide the source code file. Update the file to apply the sam
 CRITICAL: Output the entire file with changes without any other modifications! DO NOT USE MARKDOWN.
 
 ===
-${uiSourceCode.workingCopyContentData().text}
+${content}
 `;
           let response;
           for await (response of this.#fileUpdateAgent.run(prompt, {selected: null})) {
@@ -206,7 +152,7 @@ ${uiSourceCode.workingCopyContentData().text}
             continue;
           }
           const updated = response.text;
-          uiSourceCode.setWorkingCopy(updated);
+          this.#project.writeFile(file, updated);
           debugLog('updated', updated);
         }
         return {

front_end/panels/ai_assistance/ai_assistance.ts

@@ -3,6 +3,7 @@
 // found in the LICENSE file.
 
 export * from './debug.js';
+export * from './AgentProject.js';
 export * from './agents/AiAgent.js';
 export * from './agents/FileAgent.js';
 export * from './agents/NetworkAgent.js';