readest/apps/readest-app/src/__tests__/helpers/settings.test.ts

import { describe, test, expect, beforeEach, vi } from 'vitest';

const getViewSettingsMock = vi.fn<(bookKey: string) => { isGlobal?: boolean } | undefined>(
  () => undefined,
);
const setViewSettingsMock = vi.fn();
const getViewMock = vi.fn(() => null);
const getViewStateMock = vi.fn(() => undefined);

vi.mock('@/store/readerStore', () => ({
  useReaderStore: {
    getState: () => ({
      bookKeys: [],
      getView: getViewMock,
      getViewState: getViewStateMock,
      getViewSettings: getViewSettingsMock,
      setViewSettings: setViewSettingsMock,
    }),
  },
}));

vi.mock('@/store/bookDataStore', () => ({
  useBookDataStore: {
    getState: () => ({
      getConfig: vi.fn(() => null),
      saveConfig: vi.fn(),
    }),
  },
}));

vi.mock('@/utils/style', () => ({
  getStyles: vi.fn(() => ''),
}));

import { getLibraryViewSettings, saveViewSettings } from '@/helpers/settings';
import { useSettingsStore } from '@/store/settingsStore';
import type { EnvConfigType } from '@/services/environment';
import type { SystemSettings } from '@/types/settings';

const envConfig = {} as EnvConfigType;

const makeSettings = (): SystemSettings =>
  ({
    globalViewSettings: { userStylesheet: '', userUIStylesheet: '' },
  }) as unknown as SystemSettings;

beforeEach(() => {
  getViewSettingsMock.mockReset();
  getViewSettingsMock.mockReturnValue(undefined);
  setViewSettingsMock.mockReset();
  useSettingsStore.setState({
    settings: makeSettings(),
    setSettings: (s: SystemSettings) => useSettingsStore.setState({ settings: s }),
    saveSettings: vi.fn(async () => {}),
  } as unknown as ReturnType<typeof useSettingsStore.getState>);
});

describe('getLibraryViewSettings', () => {
  const makeTextureSettings = (overrides: Partial<SystemSettings> = {}): SystemSettings =>
    ({
      globalViewSettings: {
        backgroundTextureId: 'paper',
        backgroundOpacity: 0.6,
        backgroundSize: 'cover',
      },
      ...overrides,
    }) as unknown as SystemSettings;

  test('inherits the reader/global texture when no library override is set', () => {
    const result = getLibraryViewSettings(makeTextureSettings());

    expect(result.backgroundTextureId).toBe('paper');
    expect(result.backgroundOpacity).toBe(0.6);
    expect(result.backgroundSize).toBe('cover');
  });

  test('uses the library overrides when they are set', () => {
    const result = getLibraryViewSettings(
      makeTextureSettings({
        libraryBackgroundTextureId: 'none',
        libraryBackgroundOpacity: 0.3,
        libraryBackgroundSize: 'contain',
      }),
    );

    expect(result.backgroundTextureId).toBe('none');
    expect(result.backgroundOpacity).toBe(0.3);
    expect(result.backgroundSize).toBe('contain');
  });

  test("tolerates the store's initial empty settings (no globalViewSettings yet)", () => {
    // useSettingsStore starts as `{} as SystemSettings`; the library page's
    // texture effect can resolve before appService.loadSettings() populates it.
    // It must yield a usable "no texture" result instead of throwing.
    const result = getLibraryViewSettings({} as SystemSettings);

    expect(result.backgroundTextureId).toBe('none');
  });

  test('resolves each field independently — an unset field still inherits', () => {
    // Only the texture id is decoupled; opacity/size were never touched and
    // must keep tracking the reader/global values.
    const result = getLibraryViewSettings(
      makeTextureSettings({ libraryBackgroundTextureId: 'sand' }),
    );

    expect(result.backgroundTextureId).toBe('sand');
    expect(result.backgroundOpacity).toBe(0.6);
    expect(result.backgroundSize).toBe('cover');
  });
});

describe('saveViewSettings', () => {
  test('global write swaps the settings reference so replicaSettingsSync subscribers fire', async () => {
    // Mirrors the gating subscriber installed by replicaSettingsSync.initSettingsSync.
    // The publish path is bypassed entirely when this never fires, which is exactly
    // why the MiscPanel "Apply" button was failing to ship custom CSS to the server
    // until some unrelated setSettings call (e.g. dictionary provider toggle)
    // happened to create a new top-level reference and trigger a diff sweep.
    const referenceChanges: SystemSettings[] = [];
    const unsubscribe = useSettingsStore.subscribe((state, prev) => {
      if (state.settings && state.settings !== prev?.settings) {
        referenceChanges.push(state.settings);
      }
    });

    try {
      await saveViewSettings(envConfig, 'book-1', 'userStylesheet', 'body { color: red; }');
    } finally {
      unsubscribe();
    }

    expect(referenceChanges).toHaveLength(1);
    expect(referenceChanges[0]!.globalViewSettings.userStylesheet).toBe('body { color: red; }');
  });

  test('global write persists with the same new reference passed to setSettings', async () => {
    let savedSettings: SystemSettings | null = null;
    const saveSettingsMock = vi.fn(async (_env: EnvConfigType, s: SystemSettings) => {
      savedSettings = s;
    });
    useSettingsStore.setState({
      saveSettings: saveSettingsMock,
    } as unknown as ReturnType<typeof useSettingsStore.getState>);

    await saveViewSettings(envConfig, 'book-1', 'userUIStylesheet', '.app { background: black; }');

    expect(saveSettingsMock).toHaveBeenCalledTimes(1);
    expect(savedSettings!.globalViewSettings.userUIStylesheet).toBe('.app { background: black; }');
    expect(savedSettings).toBe(useSettingsStore.getState().settings);
  });

  test('per-book write (isGlobal=false) does not touch the global settings reference', async () => {
    getViewSettingsMock.mockImplementation(() => ({ isGlobal: false }));
    const initial = useSettingsStore.getState().settings;
    const referenceChanges: SystemSettings[] = [];
    const unsubscribe = useSettingsStore.subscribe((state, prev) => {
      if (state.settings && state.settings !== prev?.settings) {
        referenceChanges.push(state.settings);
      }
    });

    try {
      await saveViewSettings(envConfig, 'book-1', 'userStylesheet', 'body { color: blue; }');
    } finally {
      unsubscribe();
    }

    // Per-book writes go through applyViewSettings on the readerStore — they
    // must NOT publish global settings, otherwise per-book overrides would leak
    // into the cross-device globals.
    expect(referenceChanges).toHaveLength(0);
    expect(useSettingsStore.getState().settings).toBe(initial);
  });
});