chrome-devtools-frontend/front_end/panels/ai_assistance/PatchWidget.test.ts

Chrome DevTools UI

// 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 Common from '../../core/common/common.js';
import * as Host from '../../core/host/host.js';
import * as Root from '../../core/root/root.js';
import * as AiAssistanceModel from '../../models/ai_assistance/ai_assistance.js';
import type * as Persistence from '../../models/persistence/persistence.js';
import * as Workspace from '../../models/workspace/workspace.js';
import * as WorkspaceDiff from '../../models/workspace_diff/workspace_diff.js';
import * as PanelCommon from '../../panels/common/common.js';
import {
  cleanup,
  createPatchWidget,
  createPatchWidgetWithDiffView,
  createTestFilesystem,
  initializePersistenceImplForTests,
  MockAidaAbortError,
  mockAidaClient,
  MockAidaFetchError,
  setupAutomaticFileSystem,
} from '../../testing/AiAssistanceHelpers.js';
import {updateHostConfig} from '../../testing/EnvironmentHelpers.js';
import {expectCall} from '../../testing/ExpectStubCall.js';
import {describeWithMockConnection} from '../../testing/MockConnection.js';

import * as AiAssistance from './ai_assistance.js';

describeWithMockConnection('PatchWidget', () => {
  let showFreDialogStub: sinon.SinonStub<Parameters<typeof PanelCommon.FreDialog.show>, Promise<boolean>>;
  beforeEach(() => {
    Common.Settings.moduleSetting('ai-assistance-patching-fre-completed').set(true);
    showFreDialogStub = sinon.stub(PanelCommon.FreDialog, 'show');

    initializePersistenceImplForTests();
    setupAutomaticFileSystem();
  });

  afterEach(() => {
    cleanup();
  });

  describe('applyToWorkspace', () => {
    beforeEach(() => {
      createTestFilesystem('file://test');
      Common.Settings.Settings.instance().createSetting('ai-assistance-patching-selected-project-id', 'file://test');
      updateHostConfig({
        devToolsFreestyler: {
          enabled: true,
          patching: true,
        },
      });
    });

    describe('enterprise text cases', () => {
      it('should FRE text include no logging case when the enterprise policy value is ALLOW_WITHOUT_LOGGING',
         async () => {
           Common.Settings.moduleSetting('ai-assistance-patching-fre-completed').set(false);
           updateHostConfig({
             devToolsFreestyler: {
               enabled: true,
               patching: true,
             },
             aidaAvailability: {enterprisePolicyValue: Root.Runtime.GenAiEnterprisePolicyValue.ALLOW_WITHOUT_LOGGING}
           });
           const {view, widget} = await createPatchWidget();
           widget.changeSummary = 'body { background-color: red; }';

           view.input.onApplyToWorkspace();

           assert.isTrue(showFreDialogStub.called, 'Expected FreDialog to be shown but it\'s not shown');
           assert.exists(showFreDialogStub.lastCall.args[0].reminderItems.find(
               reminderItem => reminderItem.content.toString().includes(
                   'This data will not be used to improve Google’s AI models.')));
         });

      it('should FRE text not include no logging case when the enterprise policy value is ALLOW_WITHOUT_LOGGING',
         async () => {
           Common.Settings.moduleSetting('ai-assistance-patching-fre-completed').set(false);
           updateHostConfig({
             devToolsFreestyler: {
               enabled: true,
               patching: true,
             },
             aidaAvailability: {enterprisePolicyValue: Root.Runtime.GenAiEnterprisePolicyValue.ALLOW}
           });
           const {view, widget} = await createPatchWidget();
           widget.changeSummary = 'body { background-color: red; }';

           view.input.onApplyToWorkspace();

           assert.isTrue(showFreDialogStub.called, 'Expected FreDialog to be shown but it\'s not shown');
           assert.notExists(showFreDialogStub.lastCall.args[0].reminderItems.find(
               reminderItem => reminderItem.content.toString().includes(
                   'This data will not be used to improve Google’s AI models.')));
         });

      it('should tooltip text include no logging case when the enterprise policy value is ALLOW_WITHOUT_LOGGING',
         async () => {
           Common.Settings.moduleSetting('ai-assistance-patching-fre-completed').set(false);
           updateHostConfig({
             devToolsFreestyler: {
               enabled: true,
               patching: true,
             },
             aidaAvailability: {enterprisePolicyValue: Root.Runtime.GenAiEnterprisePolicyValue.ALLOW_WITHOUT_LOGGING}
           });
           const {view} = await createPatchWidget();

           assert.include(
               view.input.applyToWorkspaceTooltipText, 'This data will not be used to improve Google’s AI models.');
         });

      it('should tooltip text not include no logging case when the enterprise policy value is ALLOW', async () => {
        Common.Settings.moduleSetting('ai-assistance-patching-fre-completed').set(false);
        updateHostConfig({
          devToolsFreestyler: {
            enabled: true,
            patching: true,
          },
          aidaAvailability: {enterprisePolicyValue: Root.Runtime.GenAiEnterprisePolicyValue.ALLOW}
        });
        const {view} = await createPatchWidget();

        assert.notInclude(
            view.input.applyToWorkspaceTooltipText, 'This data will not be used to improve Google’s AI models.');
      });
    });

    it('should show FRE dialog on applyToWorkspace click if the setting is false', async () => {
      Common.Settings.moduleSetting('ai-assistance-patching-fre-completed').set(false);
      const {view, widget} = await createPatchWidget();
      widget.changeSummary = 'body { background-color: red; }';

      view.input.onApplyToWorkspace();

      assert.isTrue(showFreDialogStub.called, 'Expected FreDialog to be shown but it\'s not shown');
    });

    it('should not show FRE dialog on applyToWorkspace click if the setting is true', async () => {
      Common.Settings.moduleSetting('ai-assistance-patching-fre-completed').set(true);
      const {view, widget} = await createPatchWidget();
      widget.changeSummary = 'body { background-color: red; }';

      view.input.onApplyToWorkspace();

      assert.isFalse(showFreDialogStub.called, 'Expected FreDialog to be not shown but it\'s shown');
    });

    it('should show files uploaded', async () => {
      const {view, widget} = await createPatchWidget({
        aidaClient: mockAidaClient([
          [{explanation: '', functionCalls: [{name: 'updateFiles', args: {files: ['index.html']}}]}], [{
            explanation: 'done',
          }]
        ]),
      });
      widget.changeSummary = 'body { background-color: red; }';

      view.input.onApplyToWorkspace();

      assert.strictEqual((await view.nextInput).sources, `Filenames in test.
Files:
* index.html`);
    });

    it('should show error state when applyToWorkspace fails', async () => {
      const {view, widget} = await createPatchWidget({aidaClient: mockAidaClient([[MockAidaFetchError]])});
      widget.changeSummary = 'body { background-color: red; }';

      view.input.onApplyToWorkspace();

      const input = await view.nextInput;
      assert.strictEqual(input.patchSuggestionState, AiAssistance.PatchWidget.PatchSuggestionState.ERROR);
    });

    it('should show error state when there are no changes after applying to workspace', async () => {
      const {view, widget} =
          await createPatchWidget({aidaClient: mockAidaClient([[{explanation: 'no patch applied'}]])});
      sinon.stub(WorkspaceDiff.WorkspaceDiff.workspaceDiff(), 'modifiedUISourceCodes').returns([]);
      widget.changeSummary = 'body { background-color: red; }';

      view.input.onApplyToWorkspace();

      const input = await view.nextInput;
      assert.strictEqual(input.patchSuggestionState, AiAssistance.PatchWidget.PatchSuggestionState.ERROR);
    });

    it('should return back to initial state when the user aborts applying to workspace', async () => {
      const {view, widget} = await createPatchWidget({aidaClient: mockAidaClient([[MockAidaAbortError]])});
      widget.changeSummary = 'body { background-color: red; }';

      view.input.onApplyToWorkspace();

      const input = await view.nextInput;
      assert.strictEqual(input.patchSuggestionState, AiAssistance.PatchWidget.PatchSuggestionState.INITIAL);
    });
  });

  describe('workspace', () => {
    let project: Persistence.FileSystemWorkspaceBinding.FileSystem;

    beforeEach(() => {
      project = createTestFilesystem('file://test').project;
      updateHostConfig({
        devToolsFreestyler: {
          enabled: true,
          patching: true,
        },
      });
    });

    it('does not select a workspace project if patching is disabled', async () => {
      updateHostConfig({
        devToolsFreestyler: {
          enabled: true,
          patching: false,
        },
      });
      const {view} = await createPatchWidget();
      assert.strictEqual(view.input.projectName, '');
    });

    it('does not select a workspace project if setting does not exist', async () => {
      const {view} = await createPatchWidget();
      assert.strictEqual(view.input.projectName, '');
    });

    it('selects a workspace project matching the setting', async () => {
      Common.Settings.Settings.instance().createSetting('ai-assistance-patching-selected-project-id', 'file://test');
      const {view} = await createPatchWidget();
      assert.strictEqual(view.input.projectName, 'test');
    });

    it('removes a selected workspace project upon workspace removal', async () => {
      Common.Settings.Settings.instance().createSetting('ai-assistance-patching-selected-project-id', 'file://test');
      const {view} = await createPatchWidget();
      assert.strictEqual(view.input.projectName, 'test');

      Workspace.Workspace.WorkspaceImpl.instance().removeProject(project);
      const input = await view.nextInput;
      assert.strictEqual(input.projectName, '');
    });

    it('selection is triggered by applyToWorkspace click if no workspace is (pre-)selected', async () => {
      let handler: (project: Workspace.Workspace.Project) => void = () => {};
      const showSelectWorkspaceDialogStub =
          sinon.stub(AiAssistance.SelectWorkspaceDialog, 'show').callsFake((handleProjectSelected, _project) => {
            handler = handleProjectSelected;
          });
      const {view, widget} =
          await createPatchWidget({aidaClient: mockAidaClient([[{explanation: 'suggested patch'}]])});
      widget.changeSummary = 'body { background-color: red; }';
      assert.strictEqual(view.input.projectName, '');

      // Simulate clicking the "Apply to workspace" button
      view.input.onApplyToWorkspace();
      await new Promise(resolve => setTimeout(resolve, 0));
      sinon.assert.calledOnce(showSelectWorkspaceDialogStub);

      // Simulate selecting a workspace with the SelectWorkspaceDialog
      handler(project);
      const input = await view.nextInput;

      // Assert that a patch has been generated and a project has been selected
      assert.strictEqual(input.patchSuggestionState, AiAssistance.PatchWidget.PatchSuggestionState.SUCCESS);
      assert.strictEqual(input.projectName, 'test');
    });

    it('selection is triggered by the "change"-button if a workspace is already (pre-)selected', async () => {
      const {project: project2} = createTestFilesystem('file://test2');
      Common.Settings.Settings.instance().createSetting('ai-assistance-patching-selected-project-id', 'file://test');
      let handler: (project: Workspace.Workspace.Project) => void = () => {};
      const showSelectWorkspaceDialogStub =
          sinon.stub(AiAssistance.SelectWorkspaceDialog, 'show').callsFake((onProjectSelected, _project) => {
            handler = onProjectSelected;
          });
      const {view, widget} = await createPatchWidget();
      widget.changeSummary = 'body { background-color: red; }';
      assert.strictEqual(view.input.projectName, 'test');

      // Simulate clicking the "Change" button
      sinon.assert.notCalled(showSelectWorkspaceDialogStub);
      assert.isDefined(view.input.onChangeWorkspaceClick);
      view.input.onChangeWorkspaceClick();
      sinon.assert.calledOnce(showSelectWorkspaceDialogStub);

      // Simulate selecting a different workspace with the SelectWorkspaceDialog
      handler(project2);
      const input = await view.nextInput;

      // Assert that the project has been updated
      assert.strictEqual(input.projectName, 'test2');
    });

    it('preselects an automatic workspace folder and allows connecting to it', async () => {
      setupAutomaticFileSystem({hasFileSystem: true});
      const showSelectWorkspaceDialogSpy = sinon.spy(AiAssistance.SelectWorkspaceDialog, 'show');
      const applyChangesSpy = sinon.spy(AiAssistanceModel.PatchAgent.prototype, 'applyChanges');

      const {view, widget} = await createPatchWidget();
      widget.changeSummary = 'body { background-color: red; }';
      assert.strictEqual(view.input.projectName, 'my-automatic-file-system');
      assert.strictEqual(view.input.projectPath, '/path/to/my-automatic-file-system');

      // Clicking on "Apply to workspace" does not open a SelectWorkspaceDialog
      view.input.onApplyToWorkspace();
      sinon.assert.notCalled(showSelectWorkspaceDialogSpy);
      await new Promise(resolve => setTimeout(resolve, 0));
      sinon.assert.notCalled(applyChangesSpy);

      // This simulates the user confirming the file permissions dialog
      createTestFilesystem('file:///path/to/my-automatic-file-system');
      sinon.assert.calledOnce(applyChangesSpy);
    });
  });

  describe('diff view', () => {
    let uiSourceCode: Workspace.UISourceCode.UISourceCode;
    let commitWorkingCopyStub:
        sinon.SinonStub<Parameters<typeof Workspace.UISourceCode.UISourceCode.prototype.commitWorkingCopy>>;

    beforeEach(() => {
      uiSourceCode = createTestFilesystem('file://test').uiSourceCode;
      Common.Settings.Settings.instance().createSetting('ai-assistance-patching-selected-project-id', 'file://test');
      updateHostConfig({
        devToolsFreestyler: {
          enabled: true,
          patching: true,
        },
      });

      commitWorkingCopyStub =
          sinon.stub(Workspace.UISourceCode.UISourceCode.prototype, 'commitWorkingCopy').callThrough();
    });

    it('on apply should should not call stashChanges', async () => {
      const {
        view,
        widget,
      } = await createPatchWidget({
        aidaClient: mockAidaClient([[{explanation: 'patch applied'}]]),
      });
      widget.changeSummary = 'body { background-color: red; }';
      const changeManager = sinon.createStubInstance(AiAssistanceModel.ChangeManager);
      changeManager.stashChanges.returns(Promise.resolve());
      widget.changeManager = changeManager;
      view.input.onApplyToWorkspace();
      await view.nextInput;
      sinon.assert.notCalled(changeManager.stashChanges);
    });

    it('on save should stash changes', async () => {
      const {view, widget} = await createPatchWidgetWithDiffView();
      const changeManager = sinon.createStubInstance(AiAssistanceModel.ChangeManager);
      changeManager.stashChanges.returns(Promise.resolve());
      widget.changeManager = changeManager;
      uiSourceCode.setWorkingCopy('working copy');

      view.input.onSaveAll();
      const nextInput = await view.nextInput;

      assert.isTrue(nextInput.savedToDisk);
      assert.isTrue(commitWorkingCopyStub.called, 'Expected commitWorkingCopy to be called but it is not called');
      sinon.assert.calledOnce(changeManager.stashChanges);
    });

    it('discard should discard the working copy and render the view without patchSuggestion', async () => {
      const {view, widget} = await createPatchWidgetWithDiffView();
      const changeManager = sinon.createStubInstance(AiAssistanceModel.ChangeManager);
      changeManager.stashChanges.returns(Promise.resolve());
      widget.changeManager = changeManager;
      uiSourceCode.setWorkingCopy('working copy');

      view.input.onDiscard();
      const nextInput = await view.nextInput;

      assert.strictEqual(nextInput.patchSuggestionState, AiAssistance.PatchWidget.PatchSuggestionState.INITIAL);
      sinon.assert.calledOnce(changeManager.popStashedChanges);
    });

    it('on discard should submit a negative rating if rpcId exists', async () => {
      const rpcId = 'discard-test-123';
      const aidaClientMock = mockAidaClient([[{
        explanation: 'patch',
        metadata: {rpcGlobalId: rpcId},
      }]]);
      const {view, aidaClient} = await createPatchWidgetWithDiffView({aidaClient: aidaClientMock});

      const aidaClientCall = expectCall(aidaClient.registerClientEvent as sinon.SinonStub);
      view.input.onDiscard();
      await view.nextInput;
      const [aidaClientEvent] = await aidaClientCall;

      assert.strictEqual(aidaClientEvent.corresponding_aida_rpc_global_id, rpcId);
      assert.strictEqual(
          aidaClientEvent.do_conversation_client_event?.user_feedback?.sentiment, Host.AidaClient.Rating.NEGATIVE);
      assert.isTrue(aidaClientEvent.disable_user_content_logging, 'Logging should always be disabled');
    });

    it('on save should submit a positive rating if rpcId exists', async () => {
      const rpcId = 'save-test-456';
      const aidaClientMock = mockAidaClient([[{
        explanation: 'patch',
        metadata: {rpcGlobalId: rpcId},
      }]]);
      const {view, aidaClient} = await createPatchWidgetWithDiffView({aidaClient: aidaClientMock});

      const aidaClientCall = expectCall(aidaClient.registerClientEvent as sinon.SinonStub);
      view.input.onSaveAll();
      await view.nextInput;
      const [aidaClientEvent] = await aidaClientCall;

      assert.strictEqual(aidaClientEvent.corresponding_aida_rpc_global_id, rpcId);
      assert.strictEqual(
          aidaClientEvent.do_conversation_client_event?.user_feedback?.sentiment, Host.AidaClient.Rating.POSITIVE);
      assert.isTrue(aidaClientEvent.disable_user_content_logging, 'Logging should always be disabled');
    });

    it('on discard should not submit a rating if rpcId does not exist in apply response', async () => {
      const aidaClientMock = mockAidaClient([[{
        explanation: 'patch',
      }]]);
      const {view, aidaClient} = await createPatchWidgetWithDiffView({aidaClient: aidaClientMock});

      view.input.onDiscard();
      await view.nextInput;

      sinon.assert.notCalled(aidaClient.registerClientEvent as sinon.SinonStub);
    });

    it('on save should not submit a rating if rpcId does not exist in apply response', async () => {
      const aidaClientMock = mockAidaClient([[{
        explanation: 'patch',
      }]]);
      const {view, aidaClient} = await createPatchWidgetWithDiffView({aidaClient: aidaClientMock});

      view.input.onSaveAll();
      await view.nextInput;

      sinon.assert.notCalled(aidaClient.registerClientEvent as sinon.SinonStub);
    });
  });
});