[AI Assistance] Fix AI Assistance storage

Use structured clone to make sure internal setting data
is not mutated. Fixes the test isolation.

Bug: 369303513
Change-Id: I39ab62fe54c1137d891c2d8a05d192e16c9e4bc7
Reviewed-on: https://chromium-review.googlesource.com/c/devtools/devtools-frontend/+/6084696
Commit-Queue: Alex Rudenko <[email protected]>
Reviewed-by: Samiya Caur <[email protected]>

Author: OrKoN

front_end/panels/ai_assistance/AiHistoryStorage.test.ts

@@ -2,41 +2,64 @@
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.
 
-import {
-  describeWithEnvironment,
-} from '../../testing/EnvironmentHelpers.js';
+import * as Common from '../../core/common/common.js';
 
-import * as Freestyler from './ai_assistance.js';
+import * as AiAssistance from './ai_assistance.js';
 
-describeWithEnvironment('Freestyler.AiHistoryStorage', () => {
-  const agent1: Freestyler.SerializedAgent = {
+describe('AiHistoryStorage', () => {
+  const agent1: AiAssistance.SerializedAgent = {
     id: 'id1',
-    type: Freestyler.AgentType.STYLING,
+    type: AiAssistance.AgentType.STYLING,
     history: [],
   };
-  const agent2: Freestyler.SerializedAgent = {
+  const agent2: AiAssistance.SerializedAgent = {
     id: 'id2',
-    type: Freestyler.AgentType.FILE,
+    type: AiAssistance.AgentType.FILE,
     history: [],
   };
-  const agent3: Freestyler.SerializedAgent = {
+  const agent3: AiAssistance.SerializedAgent = {
     id: 'id3',
-    type: Freestyler.AgentType.NETWORK,
+    type: AiAssistance.AgentType.NETWORK,
     history: [],
   };
 
-  afterEach(() => {
-    Freestyler.AiHistoryStorage.instance().clearForTest();
+  beforeEach(() => {
+    let data: Record<string, string> = {};
+    const dummyStorage = new Common.Settings.SettingsStorage({}, {
+      get(setting) {
+        return Promise.resolve(data[setting]);
+      },
+      set(setting, value) {
+        data[setting] = value;
+      },
+      clear() {
+        data = {};
+      },
+      remove(setting) {
+        delete data[setting];
+      },
+      register(_setting) {},
+    });
+    Common.Settings.Settings.instance({
+      forceNew: true,
+      syncedStorage: dummyStorage,
+      globalStorage: dummyStorage,
+      localStorage: dummyStorage,
+    });
   });
 
+  function getStorage() {
+    return AiAssistance.AiHistoryStorage.instance(true);
+  }
+
   it('should create and retrieve history entry', async () => {
-    const storage = Freestyler.AiHistoryStorage.instance();
+    const storage = getStorage();
     await storage.upsertHistoryEntry(agent1);
     assert.deepEqual(
         storage.getHistory(),
         [{
           id: 'id1',
-          type: 'freestyler' as Freestyler.AgentType,
+          type: 'freestyler' as AiAssistance.AgentType,
           history: [],
         }],
     );
@@ -46,27 +69,27 @@ describeWithEnvironment('Freestyler.AiHistoryStorage', () => {
         [
           {
             id: 'id1',
-            type: 'freestyler' as Freestyler.AgentType,
+            type: 'freestyler' as AiAssistance.AgentType,
             history: [],
           },
           {
             id: 'id2',
-            type: 'drjones-file' as Freestyler.AgentType,
+            type: 'drjones-file' as AiAssistance.AgentType,
             history: [],
           },
         ],
     );
   });
 
   it('should update history entries correctly', async () => {
-    const storage = Freestyler.AiHistoryStorage.instance();
+    const storage = getStorage();
     await storage.upsertHistoryEntry(agent1);
     await storage.upsertHistoryEntry(agent2);
     await storage.upsertHistoryEntry({
       ...agent1,
       history: [
         {
-          type: Freestyler.ResponseType.USER_QUERY,
+          type: AiAssistance.ResponseType.USER_QUERY,
           query: 'text',
         },
       ],
@@ -76,17 +99,17 @@ describeWithEnvironment('Freestyler.AiHistoryStorage', () => {
         [
           {
             id: 'id1',
-            type: 'freestyler' as Freestyler.AgentType,
+            type: 'freestyler' as AiAssistance.AgentType,
             history: [
               {
-                type: Freestyler.ResponseType.USER_QUERY,
+                type: AiAssistance.ResponseType.USER_QUERY,
                 query: 'text',
               },
             ],
           },
           {
             id: 'id2',
-            type: 'drjones-file' as Freestyler.AgentType,
+            type: 'drjones-file' as AiAssistance.AgentType,
             history: [],
           },
         ],
@@ -98,30 +121,30 @@ describeWithEnvironment('Freestyler.AiHistoryStorage', () => {
         [
           {
             id: 'id1',
-            type: 'freestyler' as Freestyler.AgentType,
+            type: 'freestyler' as AiAssistance.AgentType,
             history: [
               {
-                type: Freestyler.ResponseType.USER_QUERY,
+                type: AiAssistance.ResponseType.USER_QUERY,
                 query: 'text',
               },
             ],
           },
           {
             id: 'id2',
-            type: 'drjones-file' as Freestyler.AgentType,
+            type: 'drjones-file' as AiAssistance.AgentType,
             history: [],
           },
           {
             id: 'id3',
-            type: 'drjones-network-request' as Freestyler.AgentType,
+            type: 'drjones-network-request' as AiAssistance.AgentType,
             history: [],
           },
         ],
     );
   });
 
   it('should delete a single entry', async () => {
-    const storage = Freestyler.AiHistoryStorage.instance();
+    const storage = getStorage();
     await storage.upsertHistoryEntry(agent1);
     await storage.upsertHistoryEntry(agent2);
     await storage.upsertHistoryEntry(agent3);
@@ -131,22 +154,22 @@ describeWithEnvironment('Freestyler.AiHistoryStorage', () => {
         [
           {
             id: 'id1',
-            type: 'freestyler' as Freestyler.AgentType,
+            type: 'freestyler' as AiAssistance.AgentType,
             history: [
 
             ],
           },
           {
             id: 'id3',
-            type: 'drjones-network-request' as Freestyler.AgentType,
+            type: 'drjones-network-request' as AiAssistance.AgentType,
             history: [],
           },
         ],
     );
   });
 
   it('should delete all entries', async () => {
-    const storage = Freestyler.AiHistoryStorage.instance();
+    const storage = getStorage();
     await storage.upsertHistoryEntry(agent1);
     await storage.upsertHistoryEntry(agent2);
     await storage.upsertHistoryEntry(agent3);

front_end/panels/ai_assistance/AiHistoryStorage.ts

@@ -14,7 +14,7 @@ export class AiHistoryStorage {
 
   constructor() {
     // This should not throw as we should be creating the setting in the `-meta.ts` file
-    this.#historySetting = Common.Settings.Settings.instance().moduleSetting('ai-assistance-history-entries');
+    this.#historySetting = Common.Settings.Settings.instance().createSetting('ai-assistance-history-entries', []);
   }
 
   clearForTest(): void {
@@ -24,7 +24,7 @@ export class AiHistoryStorage {
   async upsertHistoryEntry(agentEntry: SerializedAgent): Promise<void> {
     const release = await this.#mutex.acquire();
     try {
-      const history = await this.#historySetting.forceGet();
+      const history = structuredClone(await this.#historySetting.forceGet());
       const historyEntryIndex = history.findIndex(entry => entry.id === agentEntry.id);
       if (historyEntryIndex !== -1) {
         history[historyEntryIndex] = agentEntry;
@@ -40,7 +40,7 @@ export class AiHistoryStorage {
   async deleteHistoryEntry(id: string): Promise<void> {
     const release = await this.#mutex.acquire();
     try {
-      const history = await this.#historySetting.forceGet();
+      const history = structuredClone(await this.#historySetting.forceGet());
       this.#historySetting.set(
           history.filter(entry => entry.id !== id),
       );
@@ -59,11 +59,11 @@ export class AiHistoryStorage {
   }
 
   getHistory(): SerializedAgent[] {
-    return this.#historySetting.get();
+    return structuredClone(this.#historySetting.get());
   }
 
-  static instance(): AiHistoryStorage {
-    if (!instance) {
+  static instance(forceNew = false): AiHistoryStorage {
+    if (!instance || forceNew) {
       instance = new AiHistoryStorage();
     }
     return instance;