gemini-cli/packages/cli/src/ui/hooks/useTerminalTheme.test.tsx

/**
 * @license
 * Copyright 2025 Google LLC
 * SPDX-License-Identifier: Apache-2.0
 */

import { renderHook } from '../../test-utils/render.js';
import { useTerminalTheme } from './useTerminalTheme.js';
import { vi, describe, it, expect, beforeEach, afterEach } from 'vitest';
import { makeFakeConfig, type Config } from '@google/gemini-cli-core';
import os from 'node:os';
import { themeManager } from '../themes/theme-manager.js';

const mockWrite = vi.fn();
const mockSubscribe = vi.fn();
const mockUnsubscribe = vi.fn();
const mockHandleThemeSelect = vi.fn();
const mockQueryTerminalBackground = vi.fn();

vi.mock('ink', async (importOriginal) => {
  const actual = await importOriginal<typeof import('ink')>();
  return {
    ...actual,
    useStdout: () => ({
      stdout: {
        write: mockWrite,
      },
    }),
  };
});

vi.mock('../contexts/TerminalContext.js', () => ({
  useTerminalContext: () => ({
    subscribe: mockSubscribe,
    unsubscribe: mockUnsubscribe,
    queryTerminalBackground: mockQueryTerminalBackground,
  }),
}));

const mockSettings = {
  merged: {
    ui: {
      theme: 'default', // DEFAULT_THEME.name
      autoThemeSwitching: true,
      terminalBackgroundPollingInterval: 60,
    },
  },
};

vi.mock('../contexts/SettingsContext.js', () => ({
  useSettings: () => mockSettings,
}));

vi.mock('../themes/theme-manager.js', async (importOriginal) => {
  const actual =
    await importOriginal<typeof import('../themes/theme-manager.js')>();
  return {
    ...actual,
    themeManager: {
      isDefaultTheme: (name: string) =>
        name === 'default' || name === 'default-light',
      setTerminalBackground: vi.fn(),
    },
    DEFAULT_THEME: { name: 'default' },
  };
});

vi.mock('../themes/builtin/light/default-light.js', () => ({
  DefaultLight: { name: 'default-light' },
}));

describe('useTerminalTheme', () => {
  let config: Config;

  beforeEach(() => {
    vi.useFakeTimers();
    config = makeFakeConfig({
      targetDir: os.tmpdir(),
    });
    config.setTerminalBackground('#000000');
    vi.spyOn(config, 'setTerminalBackground');

    mockWrite.mockClear();
    mockSubscribe.mockClear();
    mockUnsubscribe.mockClear();
    mockHandleThemeSelect.mockClear();
    mockQueryTerminalBackground.mockClear();
    vi.mocked(themeManager.setTerminalBackground).mockClear();
    mockSettings.merged.ui.autoThemeSwitching = true;
    mockSettings.merged.ui.theme = 'default';
  });

  afterEach(() => {
    vi.useRealTimers();
    vi.restoreAllMocks();
  });

  it('should subscribe to terminal background events on mount', () => {
    const { unmount } = renderHook(() =>
      useTerminalTheme(mockHandleThemeSelect, config, vi.fn()),
    );
    expect(mockSubscribe).toHaveBeenCalled();
    unmount();
  });

  it('should unsubscribe on unmount', async () => {
    const { unmount, waitUntilReady } = renderHook(() =>
      useTerminalTheme(mockHandleThemeSelect, config, vi.fn()),
    );
    await waitUntilReady();
    unmount();
    expect(mockUnsubscribe).toHaveBeenCalled();
  });

  it('should poll for terminal background', () => {
    const { unmount } = renderHook(() =>
      useTerminalTheme(mockHandleThemeSelect, config, vi.fn()),
    );

    vi.advanceTimersByTime(60000);
    expect(mockQueryTerminalBackground).toHaveBeenCalled();
    unmount();
  });

  it('should not poll if terminal background is undefined at startup', async () => {
    config.getTerminalBackground = vi.fn().mockReturnValue(undefined);
    const { unmount } = renderHook(() =>
      useTerminalTheme(mockHandleThemeSelect, config, vi.fn()),
    );

    vi.advanceTimersByTime(60000);
    expect(mockQueryTerminalBackground).not.toHaveBeenCalled();
    unmount();
  });

  it('should switch to light theme when background is light and not call refreshStatic directly', () => {
    const refreshStatic = vi.fn();
    const { unmount } = renderHook(() =>
      useTerminalTheme(mockHandleThemeSelect, config, refreshStatic),
    );

    const handler = mockSubscribe.mock.calls[0][0];

    handler('rgb:ffff/ffff/ffff');

    expect(config.setTerminalBackground).toHaveBeenCalledWith('#ffffff');
    expect(themeManager.setTerminalBackground).toHaveBeenCalledWith('#ffffff');
    expect(refreshStatic).not.toHaveBeenCalled();
    expect(mockHandleThemeSelect).toHaveBeenCalledWith(
      'default-light',
      expect.anything(),
    );
    unmount();
  });

  it('should switch to dark theme when background is dark', () => {
    mockSettings.merged.ui.theme = 'default-light';

    config.setTerminalBackground('#ffffff');

    const refreshStatic = vi.fn();
    const { unmount } = renderHook(() =>
      useTerminalTheme(mockHandleThemeSelect, config, refreshStatic),
    );

    const handler = mockSubscribe.mock.calls[0][0];

    handler('rgb:0000/0000/0000');

    expect(config.setTerminalBackground).toHaveBeenCalledWith('#000000');
    expect(themeManager.setTerminalBackground).toHaveBeenCalledWith('#000000');
    expect(refreshStatic).not.toHaveBeenCalled();
    expect(mockHandleThemeSelect).toHaveBeenCalledWith(
      'default',
      expect.anything(),
    );

    mockSettings.merged.ui.theme = 'default';
    unmount();
  });

  it('should not update config or call refreshStatic on repeated identical background reports', () => {
    const refreshStatic = vi.fn();
    renderHook(() =>
      useTerminalTheme(mockHandleThemeSelect, config, refreshStatic),
    );

    const handler = mockSubscribe.mock.calls[0][0];

    handler('rgb:0000/0000/0000');

    expect(config.setTerminalBackground).not.toHaveBeenCalled();
    expect(themeManager.setTerminalBackground).not.toHaveBeenCalled();
    expect(refreshStatic).not.toHaveBeenCalled();

    expect(mockHandleThemeSelect).not.toHaveBeenCalled();
  });

  it('should switch theme even if terminal background report is identical to previousColor if current theme is mismatched', () => {
    // Background is dark at startup
    config.setTerminalBackground('#000000');
    vi.mocked(config.setTerminalBackground).mockClear();
    // But theme is light
    mockSettings.merged.ui.theme = 'default-light';

    const refreshStatic = vi.fn();
    const { unmount } = renderHook(() =>
      useTerminalTheme(mockHandleThemeSelect, config, refreshStatic),
    );

    const handler = mockSubscribe.mock.calls[0][0];

    // Terminal reports the same dark background
    handler('rgb:0000/0000/0000');

    expect(config.setTerminalBackground).not.toHaveBeenCalled();
    expect(themeManager.setTerminalBackground).not.toHaveBeenCalled();
    expect(refreshStatic).not.toHaveBeenCalled();
    // But it SHOULD select the dark theme because of the mismatch!
    expect(mockHandleThemeSelect).toHaveBeenCalledWith(
      'default',
      expect.anything(),
    );

    mockSettings.merged.ui.theme = 'default';
    unmount();
  });

  it('should not switch theme if autoThemeSwitching is disabled', () => {
    mockSettings.merged.ui.autoThemeSwitching = false;
    const { unmount } = renderHook(() =>
      useTerminalTheme(mockHandleThemeSelect, config, vi.fn()),
    );

    vi.advanceTimersByTime(60000);
    expect(mockQueryTerminalBackground).not.toHaveBeenCalled();

    mockSettings.merged.ui.autoThemeSwitching = true;
    unmount();
  });
});