refactor(cli): simplify keypress and mouse providers and update tests (#22853)

2026-04-09 21:00:56 -07:00 · 2026-03-18 16:38:56 +00:00
parent 81a97e78f1
commit d7dfcf7f99
40 changed files with 923 additions and 863 deletions
--- a/packages/cli/src/test-utils/AppRig.tsx
+++ b/packages/cli/src/test-utils/AppRig.tsx
@@ -204,6 +204,7 @@ export class AppRig {
      enableEventDrivenScheduler: true,
      extensionLoader: new MockExtensionManager(),
      excludeTools: this.options.configOverrides?.excludeTools,
+      useAlternateBuffer: false,
      ...this.options.configOverrides,
    };
    this.config = makeFakeConfig(configParams);
@@ -275,6 +276,9 @@ export class AppRig {
          enabled: false,
          hasSeenNudge: true,
        },
+        ui: {
+          useAlternateBuffer: false,
+        },
      },
    });
  }
@@ -410,7 +414,6 @@ export class AppRig {
          config: this.config!,
          settings: this.settings!,
          width: this.options.terminalWidth ?? 120,
-          useAlternateBuffer: false,
          uiState: {
            terminalHeight: this.options.terminalHeight ?? 40,
          },
--- a/packages/cli/src/test-utils/mockCommandContext.ts
+++ b/packages/cli/src/test-utils/mockCommandContext.ts
@@ -37,14 +37,14 @@ export const createMockCommandContext = (
    },
    services: {
      config: null,
-      // eslint-disable-next-line @typescript-eslint/no-unsafe-type-assertion
+
      settings: {
        merged: defaultMergedSettings,
        setValue: vi.fn(),
        forScope: vi.fn().mockReturnValue({ settings: {} }),
      } as unknown as LoadedSettings,
      git: undefined as GitService | undefined,
-      // eslint-disable-next-line @typescript-eslint/no-unsafe-type-assertion, @typescript-eslint/no-unsafe-assignment
+
      logger: {
        log: vi.fn(),
        logMessage: vi.fn(),
@@ -53,7 +53,7 @@ export const createMockCommandContext = (
        // eslint-disable-next-line @typescript-eslint/no-explicit-any
      } as any, // Cast because Logger is a class.
    },
-    // eslint-disable-next-line @typescript-eslint/no-unsafe-type-assertion, @typescript-eslint/no-unsafe-assignment
+
    ui: {
      addItem: vi.fn(),
      clear: vi.fn(),
@@ -72,7 +72,7 @@ export const createMockCommandContext = (
    } as any,
    session: {
      sessionShellAllowlist: new Set<string>(),
-      // eslint-disable-next-line @typescript-eslint/no-unsafe-type-assertion
+
      stats: {
        sessionStartTime: new Date(),
        lastPromptTokenCount: 0,
@@ -93,14 +93,12 @@ export const createMockCommandContext = (

  // eslint-disable-next-line @typescript-eslint/no-explicit-any
  const merge = (target: any, source: any): any => {
-    // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
    const output = { ...target };

    for (const key in source) {
      if (Object.prototype.hasOwnProperty.call(source, key)) {
-        // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
        const sourceValue = source[key];
-        // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
+
        const targetValue = output[key];

        if (
@@ -108,11 +106,10 @@ export const createMockCommandContext = (
          Object.prototype.toString.call(sourceValue) === '[object Object]' &&
          Object.prototype.toString.call(targetValue) === '[object Object]'
        ) {
-          // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
          output[key] = merge(targetValue, sourceValue);
        } else {
          // If not, we do a direct assignment. This preserves Date objects and others.
-          // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
+
          output[key] = sourceValue;
        }
      }
@@ -120,6 +117,5 @@ export const createMockCommandContext = (
    return output;
  };

-  // eslint-disable-next-line @typescript-eslint/no-unsafe-return
  return merge(defaultMocks, overrides);
 };
--- a/packages/cli/src/test-utils/render.tsx
+++ b/packages/cli/src/test-utils/render.tsx
@@ -18,7 +18,7 @@ import type React from 'react';
 import { act, useState } from 'react';
 import os from 'node:os';
 import path from 'node:path';
-import { LoadedSettings } from '../config/settings.js';
+import type { LoadedSettings } from '../config/settings.js';
 import { KeypressProvider } from '../ui/contexts/KeypressContext.js';
 import { SettingsContext } from '../ui/contexts/SettingsContext.js';
 import { ShellFocusContext } from '../ui/contexts/ShellFocusContext.js';
@@ -416,11 +416,10 @@ export const render = (
  stdout.clear();
  act(() => {
    instance = inkRenderDirect(tree, {
-      // eslint-disable-next-line @typescript-eslint/no-unsafe-type-assertion
      stdout: stdout as unknown as NodeJS.WriteStream,
-      // eslint-disable-next-line @typescript-eslint/no-unsafe-type-assertion
+
      stderr: stderr as unknown as NodeJS.WriteStream,
-      // eslint-disable-next-line @typescript-eslint/no-unsafe-type-assertion
+
      stdin: stdin as unknown as NodeJS.ReadStream,
      debug: false,
      exitOnCtrlC: false,
@@ -499,7 +498,6 @@ const getMockConfigInternal = (): Config => {
  return mockConfigInternal;
 };

-// eslint-disable-next-line @typescript-eslint/no-unsafe-type-assertion
 const configProxy = new Proxy({} as Config, {
  get(_target, prop) {
    if (prop === 'getTargetDir') {
@@ -526,21 +524,13 @@ const configProxy = new Proxy({} as Config, {
    }
    const internal = getMockConfigInternal();
    if (prop in internal) {
-      // eslint-disable-next-line @typescript-eslint/no-unsafe-type-assertion
      return internal[prop as keyof typeof internal];
    }
    throw new Error(`mockConfig does not have property ${String(prop)}`);
  },
 });

-export const mockSettings = new LoadedSettings(
-  { path: '', settings: {}, originalSettings: {} },
-  { path: '', settings: {}, originalSettings: {} },
-  { path: '', settings: {}, originalSettings: {} },
-  { path: '', settings: {}, originalSettings: {} },
-  true,
-  [],
-);
+export const mockSettings = createMockSettings();

 // A minimal mock UIState to satisfy the context provider.
 // Tests that need specific UIState values should provide their own.
@@ -657,9 +647,8 @@ export const renderWithProviders = (
    uiState: providedUiState,
    width,
    mouseEventsEnabled = false,
-    // eslint-disable-next-line @typescript-eslint/no-unsafe-type-assertion
+
    config = configProxy as unknown as Config,
-    useAlternateBuffer = true,
    uiActions,
    persistentState,
    appState = mockAppState,
@@ -670,7 +659,6 @@ export const renderWithProviders = (
    width?: number;
    mouseEventsEnabled?: boolean;
    config?: Config;
-    useAlternateBuffer?: boolean;
    uiActions?: Partial<UIActions>;
    persistentState?: {
      get?: typeof persistentStateMock.get;
@@ -685,20 +673,17 @@ export const renderWithProviders = (
    button?: 0 | 1 | 2,
  ) => Promise<void>;
 } => {
-  // eslint-disable-next-line @typescript-eslint/no-unsafe-type-assertion
  const baseState: UIState = new Proxy(
    { ...baseMockUiState, ...providedUiState },
    {
      get(target, prop) {
        if (prop in target) {
-          // eslint-disable-next-line @typescript-eslint/no-unsafe-type-assertion
          return target[prop as keyof typeof target];
        }
        // For properties not in the base mock or provided state,
        // we'll check the original proxy to see if it's a defined but
        // unprovided property, and if not, throw.
        if (prop in baseMockUiState) {
-          // eslint-disable-next-line @typescript-eslint/no-unsafe-type-assertion
          return baseMockUiState[prop as keyof typeof baseMockUiState];
        }
        throw new Error(`mockUiState does not have property ${String(prop)}`);
@@ -716,31 +701,8 @@ export const renderWithProviders = (
  persistentStateMock.mockClear();

  const terminalWidth = width ?? baseState.terminalWidth;
-  let finalSettings = settings;
-  if (useAlternateBuffer !== undefined) {
-    finalSettings = createMockSettings({
-      ...settings.merged,
-      ui: {
-        ...settings.merged.ui,
-        useAlternateBuffer,
-      },
-    });
-  }
-
-  // Wrap config in a Proxy so useAlternateBuffer hook (which reads from Config) gets the correct value,
-  // without replacing the entire config object and its other values.
-  let finalConfig = config;
-  if (useAlternateBuffer !== undefined) {
-    finalConfig = new Proxy(config, {
-      get(target, prop, receiver) {
-        if (prop === 'getUseAlternateBuffer') {
-          return () => useAlternateBuffer;
-        }
-        // eslint-disable-next-line @typescript-eslint/no-unsafe-return
-        return Reflect.get(target, prop, receiver);
-      },
-    });
-  }
+  const finalSettings = settings;
+  const finalConfig = config;

  const mainAreaWidth = terminalWidth;

@@ -768,7 +730,7 @@ export const renderWithProviders = (
  capturedOverflowState = undefined;
  capturedOverflowActions = undefined;

-  const renderResult = render(
+  const wrapWithProviders = (comp: React.ReactElement) => (
    <AppContext.Provider value={appState}>
      <ConfigContext.Provider value={finalConfig}>
        <SettingsContext.Provider value={finalSettings}>
@@ -803,7 +765,7 @@ export const renderWithProviders = (
                                        flexGrow={0}
                                        flexDirection="column"
                                      >
-                                        {component}
+                                        {comp}
                                      </Box>
                                    </ContextCapture>
                                  </ScrollProvider>
@@ -821,12 +783,16 @@ export const renderWithProviders = (
          </UIStateContext.Provider>
        </SettingsContext.Provider>
      </ConfigContext.Provider>
-    </AppContext.Provider>,
-    terminalWidth,
+    </AppContext.Provider>
  );

+  const renderResult = render(wrapWithProviders(component), terminalWidth);
+
  return {
    ...renderResult,
+    rerender: (newComponent: React.ReactElement) => {
+      renderResult.rerender(wrapWithProviders(newComponent));
+    },
    capturedOverflowState,
    capturedOverflowActions,
    simulateClick: (col: number, row: number, button?: 0 | 1 | 2) =>
@@ -847,9 +813,8 @@ export function renderHook<Result, Props>(
  waitUntilReady: () => Promise<void>;
  generateSvg: () => string;
 } {
-  // eslint-disable-next-line @typescript-eslint/no-unsafe-type-assertion
  const result = { current: undefined as unknown as Result };
-  // eslint-disable-next-line @typescript-eslint/no-unsafe-type-assertion
+
  let currentProps = options?.initialProps as Props;

  function TestComponent({
@@ -884,7 +849,6 @@ export function renderHook<Result, Props>(

  function rerender(props?: Props) {
    if (arguments.length > 0) {
-      // eslint-disable-next-line @typescript-eslint/no-unsafe-type-assertion
      currentProps = props as Props;
    }
    act(() => {
@@ -911,7 +875,6 @@ export function renderHookWithProviders<Result, Props>(
    width?: number;
    mouseEventsEnabled?: boolean;
    config?: Config;
-    useAlternateBuffer?: boolean;
  } = {},
 ): {
  result: { current: Result };
@@ -920,7 +883,6 @@ export function renderHookWithProviders<Result, Props>(
  waitUntilReady: () => Promise<void>;
  generateSvg: () => string;
 } {
-  // eslint-disable-next-line @typescript-eslint/no-unsafe-type-assertion
  const result = { current: undefined as unknown as Result };

  let setPropsFn: ((props: Props) => void) | undefined;
@@ -942,7 +904,7 @@ export function renderHookWithProviders<Result, Props>(
  act(() => {
    renderResult = renderWithProviders(
      <Wrapper>
-        {/* eslint-disable-next-line @typescript-eslint/no-unsafe-type-assertion */}
+        {}
        <TestComponent initialProps={options.initialProps as Props} />
      </Wrapper>,
      options,
@@ -952,7 +914,6 @@ export function renderHookWithProviders<Result, Props>(
  function rerender(newProps?: Props) {
    act(() => {
      if (arguments.length > 0 && setPropsFn) {
-        // eslint-disable-next-line @typescript-eslint/no-unsafe-type-assertion
        setPropsFn(newProps as Props);
      } else if (forceUpdateFn) {
        forceUpdateFn();
--- a/packages/cli/src/test-utils/settings.ts
+++ b/packages/cli/src/test-utils/settings.ts
@@ -46,23 +46,22 @@ export const createMockSettings = (
    workspace,
    isTrusted,
    errors,
-    // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
+
    merged: mergedOverride,
    ...settingsOverrides
  } = overrides;

  const loaded = new LoadedSettings(
-    // eslint-disable-next-line @typescript-eslint/no-unsafe-type-assertion
    (system as any) || { path: '', settings: {}, originalSettings: {} },
-    // eslint-disable-next-line @typescript-eslint/no-unsafe-type-assertion
+
    (systemDefaults as any) || { path: '', settings: {}, originalSettings: {} },
-    // eslint-disable-next-line @typescript-eslint/no-unsafe-type-assertion
+
    (user as any) || {
      path: '',
      settings: settingsOverrides,
      originalSettings: settingsOverrides,
    },
-    // eslint-disable-next-line @typescript-eslint/no-unsafe-type-assertion
+
    (workspace as any) || { path: '', settings: {}, originalSettings: {} },
    isTrusted ?? true,
    errors || [],
@@ -76,7 +75,6 @@ export const createMockSettings = (
  // Assign any function overrides (e.g., vi.fn() for methods)
  for (const key in overrides) {
    if (typeof overrides[key] === 'function') {
-      // eslint-disable-next-line @typescript-eslint/no-unsafe-type-assertion, @typescript-eslint/no-unsafe-assignment
      (loaded as any)[key] = overrides[key];
    }
  }