Skip to content

armgit / Pulse

Public Imported from GitHub
0

Real-time monitoring dashboard for Proxmox VE, PBS, Docker, Kubernetes, TrueNAS and vSphere. Self-hosted, with alerts for failed backups, full disks, unhealthy containers and offline nodes.

6.6 KB
Raw Blame
import { afterEach, beforeEach, describe, expect, it } from 'vitest';
import { createRoot } from 'solid-js';
import { useColumnVisibility, type ColumnDef } from '@/hooks/useColumnVisibility';

describe('useColumnVisibility', () => {
  const storageKey = 'test-column-visibility';

  beforeEach(() => {
    window.localStorage.clear();
  });

  afterEach(() => {
    window.localStorage.clear();
  });

  it('hides columns marked defaultHidden when no user preference exists', () => {
    createRoot((dispose) => {
      const columns: ColumnDef[] = [
        { id: 'name', label: 'Name' },
        { id: 'type', label: 'Type', toggleable: true, defaultHidden: true },
      ];

      const visibility = useColumnVisibility(storageKey, columns);

      expect(visibility.hiddenColumns()).toEqual(['type']);
      expect(visibility.visibleColumns().map((col) => col.id)).toEqual(['name']);

      dispose();
    });
  });

  it('merges explicit defaultHidden ids with column-level defaults', () => {
    createRoot((dispose) => {
      const columns: ColumnDef[] = [
        { id: 'name', label: 'Name' },
        { id: 'type', label: 'Type', toggleable: true, defaultHidden: true },
        { id: 'ip', label: 'IP', toggleable: true },
      ];

      const visibility = useColumnVisibility(storageKey, columns, ['ip']);

      expect(visibility.hiddenColumns()).toEqual(['type', 'ip']);
      expect(visibility.visibleColumns().map((col) => col.id)).toEqual(['name']);

      dispose();
    });
  });

  it('prefers saved user visibility state over defaultHidden configuration', () => {
    window.localStorage.setItem(storageKey, JSON.stringify(['ip']));

    createRoot((dispose) => {
      const columns: ColumnDef[] = [
        { id: 'name', label: 'Name' },
        { id: 'type', label: 'Type', toggleable: true, defaultHidden: true },
        { id: 'ip', label: 'IP', toggleable: true },
      ];

      const visibility = useColumnVisibility(storageKey, columns, ['ip']);

      expect(visibility.hiddenColumns()).toEqual(['ip']);
      expect(visibility.visibleColumns().map((col) => col.id)).toEqual(['name', 'type']);

      dispose();
    });
  });

  it('hides newly default-hidden columns once for existing user preferences', async () => {
    window.localStorage.setItem(storageKey, JSON.stringify(['ip']));

    let disposeRoot: (() => void) | undefined;
    let visibility: ReturnType<typeof useColumnVisibility> | undefined;

    createRoot((dispose) => {
      disposeRoot = dispose;
      const columns: ColumnDef[] = [
        { id: 'name', label: 'Name' },
        { id: 'type', label: 'Type', toggleable: true, defaultHidden: true },
        { id: 'ip', label: 'IP', toggleable: true },
        { id: 'aiContext', label: 'AI Context', toggleable: true, defaultHidden: true },
      ];

      visibility = useColumnVisibility(storageKey, columns, ['ip'], undefined, {}, ['aiContext']);

      expect(visibility.hiddenColumns()).toEqual(['ip', 'aiContext']);
      expect(visibility.visibleColumns().map((col) => col.id)).toEqual(['name', 'type']);
    });

    await Promise.resolve();
    expect(window.localStorage.getItem(storageKey)).toBe(JSON.stringify(['ip', 'aiContext']));
    expect(window.localStorage.getItem(`${storageKey}:default-hidden-applied`)).toBe(
      JSON.stringify(['aiContext']),
    );

    visibility?.show('aiContext');
    await Promise.resolve();
    expect(window.localStorage.getItem(storageKey)).toBe(JSON.stringify(['ip']));
    disposeRoot?.();

    createRoot((dispose) => {
      const columns: ColumnDef[] = [
        { id: 'name', label: 'Name' },
        { id: 'type', label: 'Type', toggleable: true, defaultHidden: true },
        { id: 'ip', label: 'IP', toggleable: true },
        { id: 'aiContext', label: 'AI Context', toggleable: true, defaultHidden: true },
      ];

      const remounted = useColumnVisibility(storageKey, columns, ['ip'], undefined, {}, [
        'aiContext',
      ]);

      expect(remounted.hiddenColumns()).toEqual(['ip']);
      expect(remounted.visibleColumns().map((col) => col.id)).toEqual([
        'name',
        'type',
        'aiContext',
      ]);

      dispose();
    });
  });

  it('does not reapply a default-hidden migration after a fresh user shows the column', async () => {
    const columns: ColumnDef[] = [
      { id: 'name', label: 'Name' },
      { id: 'diskio', label: 'Disk I/O', toggleable: true, defaultHidden: true },
    ];
    let dispose = () => {};
    let visibility: ReturnType<typeof useColumnVisibility>;
    createRoot((d) => {
      dispose = d;
      visibility = useColumnVisibility(storageKey, columns, [], undefined, {}, ['diskio']);
    });
    await Promise.resolve();
    visibility!.show('diskio');
    await Promise.resolve();
    expect(window.localStorage.getItem(storageKey)).toBe('[]');
    dispose();
    createRoot((d) => {
      const reloaded = useColumnVisibility(storageKey, columns, [], undefined, {}, ['diskio']);
      expect(reloaded.isHiddenByUser('diskio')).toBe(false);
      d();
    });
  });

  it('resets back to the canonical default-hidden set', () => {
    createRoot((dispose) => {
      const columns: ColumnDef[] = [
        { id: 'name', label: 'Name' },
        { id: 'type', label: 'Type', toggleable: true, defaultHidden: true },
        { id: 'ip', label: 'IP', toggleable: true },
      ];

      const visibility = useColumnVisibility(storageKey, columns);

      visibility.show('type');
      visibility.hide('ip');
      expect(visibility.hiddenColumns()).toEqual(['ip']);

      visibility.resetToDefaults();
      expect(visibility.hiddenColumns()).toEqual(['type']);
      expect(visibility.visibleColumns().map((col) => col.id)).toEqual(['name', 'ip']);

      dispose();
    });
  });

  it('migrates persisted legacy column ids to canonical ids', async () => {
    window.localStorage.setItem(storageKey, JSON.stringify(['subject', 'source', 'source']));

    let disposeRoot: (() => void) | undefined;

    createRoot((dispose) => {
      disposeRoot = dispose;
      const columns: ColumnDef[] = [
        { id: 'item', label: 'Item', toggleable: true },
        { id: 'platform', label: 'Platform', toggleable: true },
        { id: 'outcome', label: 'Outcome' },
      ];

      const visibility = useColumnVisibility(storageKey, columns, [], undefined, {
        subject: 'item',
        source: 'platform',
      });

      expect(visibility.hiddenColumns()).toEqual(['item', 'platform']);
      expect(visibility.visibleColumns().map((col) => col.id)).toEqual(['outcome']);
    });

    await Promise.resolve();
    expect(window.localStorage.getItem(storageKey)).toBe(JSON.stringify(['item', 'platform']));
    disposeRoot?.();
  });
});