feat(cli): implement compact tool output (#20974)

2026-04-20 10:10:56 -07:00 · 2026-03-30 16:43:29 -07:00
parent 3e95b8ec59
commit 1df5c98b33
45 changed files with 2670 additions and 386 deletions
@@ -0,0 +1,178 @@
+/**
+ * @license
+ * Copyright 2026 Google LLC
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+import { renderWithProviders } from '../../../test-utils/render.js';
+import { createMockSettings } from '../../../test-utils/mockConfig.js';
+import { ToolGroupMessage } from './ToolGroupMessage.js';
+import {
+  CoreToolCallStatus,
+  LS_DISPLAY_NAME,
+  READ_FILE_DISPLAY_NAME,
+} from '@google/gemini-cli-core';
+import { expect, it, describe } from 'vitest';
+import type { IndividualToolCallDisplay } from '../../types.js';
+
+describe('ToolGroupMessage Compact Rendering', () => {
+  const defaultProps = {
+    item: {
+      id: '1',
+      role: 'assistant',
+      content: '',
+      timestamp: new Date(),
+      type: 'help' as const, // Adding type property to satisfy HistoryItem type
+    },
+    terminalWidth: 80,
+  };
+
+  const compactSettings = createMockSettings({
+    merged: {
+      ui: {
+        compactToolOutput: true,
+      },
+    },
+  });
+
+  it('renders consecutive compact tools without empty lines between them', async () => {
+    const toolCalls: IndividualToolCallDisplay[] = [
+      {
+        callId: 'call1',
+        name: LS_DISPLAY_NAME,
+        status: CoreToolCallStatus.Success,
+        resultDisplay: 'file1.txt\nfile2.txt',
+        description: 'Listing files',
+        confirmationDetails: undefined,
+        isClientInitiated: true,
+        parentCallId: undefined,
+      },
+      {
+        callId: 'call2',
+        name: LS_DISPLAY_NAME,
+        status: CoreToolCallStatus.Success,
+        resultDisplay: 'file3.txt',
+        description: 'Listing files',
+        confirmationDetails: undefined,
+        isClientInitiated: true,
+        parentCallId: undefined,
+      },
+    ];
+
+    const { lastFrame, waitUntilReady } = await renderWithProviders(
+      <ToolGroupMessage {...defaultProps} toolCalls={toolCalls} />,
+      { settings: compactSettings },
+    );
+
+    await waitUntilReady();
+    const output = lastFrame();
+
+    expect(output).toMatchSnapshot();
+  });
+
+  it('does not add an extra empty line between a compact tool and a standard tool', async () => {
+    const toolCalls: IndividualToolCallDisplay[] = [
+      {
+        callId: 'call1',
+        name: LS_DISPLAY_NAME,
+        status: CoreToolCallStatus.Success,
+        resultDisplay: 'file1.txt',
+        description: 'Listing files',
+        confirmationDetails: undefined,
+        isClientInitiated: true,
+        parentCallId: undefined,
+      },
+      {
+        callId: 'call2',
+        name: 'non-compact-tool',
+        status: CoreToolCallStatus.Success,
+        resultDisplay: 'some large output',
+        description: 'Doing something',
+        confirmationDetails: undefined,
+        isClientInitiated: true,
+        parentCallId: undefined,
+      },
+    ];
+
+    const { lastFrame, waitUntilReady } = await renderWithProviders(
+      <ToolGroupMessage {...defaultProps} toolCalls={toolCalls} />,
+      { settings: compactSettings },
+    );
+
+    await waitUntilReady();
+    const output = lastFrame();
+    expect(output).toMatchSnapshot();
+  });
+
+  it('does not add an extra empty line if a compact tool has a dense payload', async () => {
+    const toolCalls: IndividualToolCallDisplay[] = [
+      {
+        callId: 'call1',
+        name: LS_DISPLAY_NAME,
+        status: CoreToolCallStatus.Success,
+        resultDisplay: 'file1.txt',
+        description: 'Listing files',
+        confirmationDetails: undefined,
+        isClientInitiated: true,
+        parentCallId: undefined,
+      },
+      {
+        callId: 'call2',
+        name: READ_FILE_DISPLAY_NAME,
+        status: CoreToolCallStatus.Success,
+        resultDisplay: {
+          summary: 'read file',
+          payload: 'file content',
+          files: ['file.txt'],
+        }, // Dense payload
+        description: 'Reading file',
+        confirmationDetails: undefined,
+        isClientInitiated: true,
+        parentCallId: undefined,
+      },
+    ];
+
+    const { lastFrame, waitUntilReady } = await renderWithProviders(
+      <ToolGroupMessage {...defaultProps} toolCalls={toolCalls} />,
+      { settings: compactSettings },
+    );
+
+    await waitUntilReady();
+    const output = lastFrame();
+    expect(output).toMatchSnapshot();
+  });
+
+  it('does not add an extra empty line between a standard tool and a compact tool', async () => {
+    const toolCalls: IndividualToolCallDisplay[] = [
+      {
+        callId: 'call1',
+        name: 'non-compact-tool',
+        status: CoreToolCallStatus.Success,
+        resultDisplay: 'some large output',
+        description: 'Doing something',
+        confirmationDetails: undefined,
+        isClientInitiated: true,
+        parentCallId: undefined,
+      },
+      {
+        callId: 'call2',
+        name: LS_DISPLAY_NAME,
+        status: CoreToolCallStatus.Success,
+        resultDisplay: 'file1.txt',
+        description: 'Listing files',
+        confirmationDetails: undefined,
+        isClientInitiated: true,
+        parentCallId: undefined,
+      },
+    ];
+
+    const { lastFrame, waitUntilReady } = await renderWithProviders(
+      <ToolGroupMessage {...defaultProps} toolCalls={toolCalls} />,
+      { settings: compactSettings },
+    );
+
+    await waitUntilReady();
+    const output = lastFrame();
+    expect(output).toMatchSnapshot();
+  });
+});