Skip to content

The fastest, cheapest, most efficient open-source agent harness. Run more than 500 agents on a $10 VPS.

18.4 KB
Raw Blame
/**
 * Unit tests for configPersistence utilities.
 * Tests URL storage, validation, and normalization.
 */
import { afterEach, beforeEach, describe, expect, it, vi } from 'vitest';

import {
  clearStoredCoreMode,
  clearStoredCoreToken,
  clearStoredRpcUrl,
  getDefaultRpcUrl,
  getStoredCoreMode,
  getStoredCoreToken,
  getStoredRpcUrl,
  isLocalOrPrivateNetworkHost,
  isValidRpcUrl,
  normalizeRpcUrl,
  peekStoredGatewayId,
  peekStoredRpcUrl,
  redactRpcUrlForLog,
  storeCoreMode,
  storeCoreToken,
  storeGatewayId,
  storeRpcUrl,
} from '../configPersistence';

const STORAGE_KEY = 'openhuman_core_rpc_url';
const TOKEN_STORAGE_KEY = 'openhuman_core_rpc_token';
const MODE_STORAGE_KEY = 'openhuman_core_mode';
const GATEWAY_ID_STORAGE_KEY = 'openhuman_core_gateway_id';

describe('configPersistence', () => {
  beforeEach(() => {
    // Clear localStorage before each test
    localStorage.removeItem(STORAGE_KEY);
    localStorage.removeItem(TOKEN_STORAGE_KEY);
    localStorage.removeItem(MODE_STORAGE_KEY);
    localStorage.removeItem(GATEWAY_ID_STORAGE_KEY);
  });

  afterEach(() => {
    // Clean up after each test
    localStorage.removeItem(STORAGE_KEY);
    localStorage.removeItem(TOKEN_STORAGE_KEY);
    localStorage.removeItem(MODE_STORAGE_KEY);
    localStorage.removeItem(GATEWAY_ID_STORAGE_KEY);
  });

  describe('getStoredRpcUrl', () => {
    it('returns default URL when no URL is stored', () => {
      const result = getStoredRpcUrl();
      expect(result).toBe('http://127.0.0.1:7788/rpc');
    });

    it('returns stored URL when available', () => {
      localStorage.setItem(STORAGE_KEY, 'http://localhost:8080/rpc');
      const result = getStoredRpcUrl();
      expect(result).toBe('http://localhost:8080/rpc');
    });

    it('trims whitespace from stored URL', () => {
      localStorage.setItem(STORAGE_KEY, '  http://localhost:8080/rpc  ');
      const result = getStoredRpcUrl();
      expect(result).toBe('http://localhost:8080/rpc');
    });

    it('returns default when stored URL is empty', () => {
      localStorage.setItem(STORAGE_KEY, '');
      const result = getStoredRpcUrl();
      expect(result).toBe('http://127.0.0.1:7788/rpc');
    });
  });

  describe('storeRpcUrl', () => {
    it('stores a valid URL', () => {
      storeRpcUrl('http://localhost:9000/rpc');
      expect(localStorage.getItem(STORAGE_KEY)).toBe('http://localhost:9000/rpc');
    });

    it('trims and stores URL', () => {
      storeRpcUrl('  http://localhost:9000/rpc  ');
      expect(localStorage.getItem(STORAGE_KEY)).toBe('http://localhost:9000/rpc');
    });

    it('clears stored URL when given empty string', () => {
      localStorage.setItem(STORAGE_KEY, 'http://localhost:9000/rpc');
      storeRpcUrl('');
      expect(localStorage.getItem(STORAGE_KEY)).toBeNull();
    });

    it('clears stored URL when given whitespace-only string', () => {
      localStorage.setItem(STORAGE_KEY, 'http://localhost:9000/rpc');
      storeRpcUrl('   ');
      expect(localStorage.getItem(STORAGE_KEY)).toBeNull();
    });
  });

  describe('clearStoredRpcUrl', () => {
    it('removes stored URL', () => {
      localStorage.setItem(STORAGE_KEY, 'http://localhost:9000/rpc');
      clearStoredRpcUrl();
      expect(localStorage.getItem(STORAGE_KEY)).toBeNull();
    });
  });

  describe('isValidRpcUrl', () => {
    it('returns true for valid http URL', () => {
      expect(isValidRpcUrl('http://localhost:7788/rpc')).toBe(true);
    });

    it('returns true for valid https URL', () => {
      expect(isValidRpcUrl('https://api.example.com/rpc')).toBe(true);
    });

    it('returns true for URL without /rpc suffix', () => {
      expect(isValidRpcUrl('http://localhost:7788')).toBe(true);
    });

    it('returns false for empty string', () => {
      expect(isValidRpcUrl('')).toBe(false);
    });

    it('returns false for whitespace-only string', () => {
      expect(isValidRpcUrl('   ')).toBe(false);
    });

    it('returns false for null/undefined', () => {
      expect(isValidRpcUrl(null as unknown as string)).toBe(false);
      expect(isValidRpcUrl(undefined as unknown as string)).toBe(false);
    });

    it('returns false for invalid protocol', () => {
      expect(isValidRpcUrl('ftp://localhost:7788/rpc')).toBe(false);
      expect(isValidRpcUrl('ws://localhost:7788/rpc')).toBe(false);
    });

    it('returns false for malformed URL', () => {
      expect(isValidRpcUrl('not a valid url')).toBe(false);
      expect(isValidRpcUrl('http://')).toBe(false);
    });
  });

  describe('normalizeRpcUrl', () => {
    it('trims whitespace', () => {
      expect(normalizeRpcUrl('  http://localhost:7788/rpc  ')).toBe('http://localhost:7788/rpc');
    });

    it('removes trailing slashes', () => {
      expect(normalizeRpcUrl('http://localhost:7788/rpc/')).toBe('http://localhost:7788/rpc');
      expect(normalizeRpcUrl('http://localhost:7788/')).toBe('http://localhost:7788/rpc');
    });

    it('handles multiple trailing slashes', () => {
      expect(normalizeRpcUrl('http://localhost:7788/rpc///')).toBe('http://localhost:7788/rpc');
    });

    it('preserves URL without trailing slash', () => {
      expect(normalizeRpcUrl('http://localhost:7788/rpc')).toBe('http://localhost:7788/rpc');
    });

    it('preserves query and hash values when normalizing paths', () => {
      expect(normalizeRpcUrl('https://host.example?next=/')).toBe(
        'https://host.example/rpc?next=/'
      );
      expect(normalizeRpcUrl('https://host.example/#/')).toBe('https://host.example/rpc#/');
      expect(normalizeRpcUrl('https://host.example/rpc/?next=/#/')).toBe(
        'https://host.example/rpc?next=/#/'
      );
    });
  });

  describe('redactRpcUrlForLog', () => {
    it('removes credentials, query, and hash values before logging', () => {
      expect(redactRpcUrlForLog('https://user:[email protected]/rpc?token=secret#/token')).toBe(
        'https://host.example/rpc'
      );
    });

    it('returns a sentinel for malformed URLs', () => {
      expect(redactRpcUrlForLog('not a url')).toBe('[invalid-url]');
    });
  });

  describe('getDefaultRpcUrl', () => {
    it('returns the expected default URL', () => {
      expect(getDefaultRpcUrl()).toBe('http://127.0.0.1:7788/rpc');
    });
  });

  describe('isValidRpcUrl — edge cases', () => {
    it('returns true for localhost with a port', () => {
      expect(isValidRpcUrl('http://localhost:7788')).toBe(true);
    });

    it('returns true for a bare IP address URL', () => {
      expect(isValidRpcUrl('http://192.168.1.100:7788/rpc')).toBe(true);
    });

    it('returns true for an HTTPS URL', () => {
      expect(isValidRpcUrl('https://remote-core.example.com/rpc')).toBe(true);
    });

    it('returns true for a URL with a path segment', () => {
      expect(isValidRpcUrl('http://127.0.0.1:7788/rpc')).toBe(true);
    });

    it('returns false for empty string', () => {
      expect(isValidRpcUrl('')).toBe(false);
    });

    it('returns false for whitespace-only string', () => {
      expect(isValidRpcUrl('   ')).toBe(false);
    });

    it('returns false for a URL without a protocol', () => {
      expect(isValidRpcUrl('localhost:7788/rpc')).toBe(false);
      expect(isValidRpcUrl('127.0.0.1:7788')).toBe(false);
    });

    it('returns false for a ws:// URL', () => {
      expect(isValidRpcUrl('ws://localhost:7788')).toBe(false);
    });

    it('returns false for a ftp:// URL', () => {
      expect(isValidRpcUrl('ftp://localhost:7788')).toBe(false);
    });

    it('returns false for a completely malformed string', () => {
      expect(isValidRpcUrl('not a url at all')).toBe(false);
    });

    it('returns false for http:// with no host', () => {
      expect(isValidRpcUrl('http://')).toBe(false);
    });
  });

  describe('isLocalOrPrivateNetworkHost', () => {
    it('allows localhost and loopback addresses', () => {
      expect(isLocalOrPrivateNetworkHost('localhost')).toBe(true);
      expect(isLocalOrPrivateNetworkHost('app.localhost')).toBe(true);
      expect(isLocalOrPrivateNetworkHost('127.0.0.1')).toBe(true);
      expect(isLocalOrPrivateNetworkHost('::1')).toBe(true);
    });

    it('allows RFC1918, link-local, and Tailscale/CGNAT IPv4 addresses', () => {
      expect(isLocalOrPrivateNetworkHost('10.0.0.8')).toBe(true);
      expect(isLocalOrPrivateNetworkHost('172.16.0.1')).toBe(true);
      expect(isLocalOrPrivateNetworkHost('172.31.255.255')).toBe(true);
      expect(isLocalOrPrivateNetworkHost('192.168.1.100')).toBe(true);
      expect(isLocalOrPrivateNetworkHost('169.254.10.20')).toBe(true);
      expect(isLocalOrPrivateNetworkHost('100.64.0.1')).toBe(true);
      expect(isLocalOrPrivateNetworkHost('100.116.244.64')).toBe(true);
      expect(isLocalOrPrivateNetworkHost('100.127.255.254')).toBe(true);
    });

    it('allows private IPv6 ranges', () => {
      expect(isLocalOrPrivateNetworkHost('fc00::1')).toBe(true);
      expect(isLocalOrPrivateNetworkHost('fd12:3456::1')).toBe(true);
      expect(isLocalOrPrivateNetworkHost('fe80::1')).toBe(true);
    });

    it('rejects public hosts and invalid IPv4 addresses', () => {
      expect(isLocalOrPrivateNetworkHost('example.com')).toBe(false);
      expect(isLocalOrPrivateNetworkHost('8.8.8.8')).toBe(false);
      expect(isLocalOrPrivateNetworkHost('100.128.0.1')).toBe(false);
      expect(isLocalOrPrivateNetworkHost('256.1.1.1')).toBe(false);
    });
  });

  describe('normalizeRpcUrl — edge cases', () => {
    it('adds /rpc suffix when given a core base URL', () => {
      expect(normalizeRpcUrl('http://127.0.0.1:7788')).toBe('http://127.0.0.1:7788/rpc');
      expect(normalizeRpcUrl('https://example.trycloudflare.com/')).toBe(
        'https://example.trycloudflare.com/rpc'
      );
    });

    it('does not double-add /rpc — leaves existing /rpc alone', () => {
      expect(normalizeRpcUrl('http://127.0.0.1:7788/rpc')).toBe('http://127.0.0.1:7788/rpc');
    });

    it('handles trailing slash after /rpc', () => {
      expect(normalizeRpcUrl('http://127.0.0.1:7788/rpc/')).toBe('http://127.0.0.1:7788/rpc');
    });

    it('handles uppercase protocol casing (trims only, does not lowercase)', () => {
      // The normalizer does not lowercase — it just trims slashes and whitespace
      expect(normalizeRpcUrl('  HTTP://localhost:7788/rpc  ')).toBe('HTTP://localhost:7788/rpc');
    });

    it('removes multiple trailing slashes', () => {
      expect(normalizeRpcUrl('http://127.0.0.1:7788/rpc///')).toBe('http://127.0.0.1:7788/rpc');
    });

    it('trims leading and trailing whitespace', () => {
      expect(normalizeRpcUrl('  http://127.0.0.1:7788/rpc  ')).toBe('http://127.0.0.1:7788/rpc');
    });
  });

  describe('storeRpcUrl + getStoredRpcUrl — round-trip', () => {
    it('stores normalized base core URLs as RPC endpoints', () => {
      storeRpcUrl('https://remote.example.com');
      expect(localStorage.getItem(STORAGE_KEY)).toBe('https://remote.example.com/rpc');
      expect(getStoredRpcUrl()).toBe('https://remote.example.com/rpc');
      expect(peekStoredRpcUrl()).toBe('https://remote.example.com/rpc');
    });

    it('normalizes previously persisted base core URLs on read', () => {
      localStorage.setItem(STORAGE_KEY, 'https://old.example.com/');
      expect(getStoredRpcUrl()).toBe('https://old.example.com/rpc');
      expect(peekStoredRpcUrl()).toBe('https://old.example.com/rpc');
    });

    it('round-trips an HTTPS URL', () => {
      storeRpcUrl('https://remote.example.com/rpc');
      expect(getStoredRpcUrl()).toBe('https://remote.example.com/rpc');
    });

    it('round-trips a localhost URL with a non-standard port', () => {
      storeRpcUrl('http://localhost:12345/rpc');
      expect(getStoredRpcUrl()).toBe('http://localhost:12345/rpc');
    });

    it('round-trips an IP address URL', () => {
      storeRpcUrl('http://10.0.0.1:7788/rpc');
      expect(getStoredRpcUrl()).toBe('http://10.0.0.1:7788/rpc');
    });
  });

  describe('clearStoredRpcUrl + getStoredRpcUrl', () => {
    it('getStoredRpcUrl returns the default after clearStoredRpcUrl', () => {
      storeRpcUrl('http://some-host:9999/rpc');
      expect(getStoredRpcUrl()).toBe('http://some-host:9999/rpc');

      clearStoredRpcUrl();
      expect(getStoredRpcUrl()).toBe('http://127.0.0.1:7788/rpc');
    });

    it('localStorage key is null after clearStoredRpcUrl', () => {
      storeRpcUrl('http://some-host:9999/rpc');
      clearStoredRpcUrl();
      expect(localStorage.getItem('openhuman_core_rpc_url')).toBeNull();
    });
  });

  describe('getStoredRpcUrl — localStorage unavailable', () => {
    it('returns the default URL when localStorage throws', () => {
      const getItemSpy = vi.spyOn(localStorage, 'getItem').mockImplementation(() => {
        throw new Error('Storage unavailable');
      });
      try {
        expect(getStoredRpcUrl()).toBe('http://127.0.0.1:7788/rpc');
      } finally {
        getItemSpy.mockRestore();
      }
    });
  });

  describe('getStoredCoreToken / storeCoreToken / clearStoredCoreToken', () => {
    it('returns null when no token is stored', () => {
      expect(getStoredCoreToken()).toBeNull();
    });

    it('returns the stored token', () => {
      localStorage.setItem(TOKEN_STORAGE_KEY, 'abc-123');
      expect(getStoredCoreToken()).toBe('abc-123');
    });

    it('trims whitespace around the stored token', () => {
      localStorage.setItem(TOKEN_STORAGE_KEY, '   xyz   ');
      expect(getStoredCoreToken()).toBe('xyz');
    });

    it('treats whitespace-only / empty stored values as null', () => {
      localStorage.setItem(TOKEN_STORAGE_KEY, '   ');
      expect(getStoredCoreToken()).toBeNull();
      localStorage.setItem(TOKEN_STORAGE_KEY, '');
      expect(getStoredCoreToken()).toBeNull();
    });

    it('storeCoreToken persists trimmed value', () => {
      storeCoreToken('  hello  ');
      expect(localStorage.getItem(TOKEN_STORAGE_KEY)).toBe('hello');
    });

    it('storeCoreToken with empty string clears the stored value', () => {
      localStorage.setItem(TOKEN_STORAGE_KEY, 'something');
      storeCoreToken('');
      expect(localStorage.getItem(TOKEN_STORAGE_KEY)).toBeNull();
    });

    it('clearStoredCoreToken removes the value', () => {
      localStorage.setItem(TOKEN_STORAGE_KEY, 'something');
      clearStoredCoreToken();
      expect(localStorage.getItem(TOKEN_STORAGE_KEY)).toBeNull();
    });

    it('returns null when localStorage is unavailable', () => {
      const getItemSpy = vi.spyOn(Storage.prototype, 'getItem').mockImplementation(() => {
        throw new Error('blocked');
      });
      try {
        expect(getStoredCoreToken()).toBeNull();
      } finally {
        getItemSpy.mockRestore();
      }
    });
  });

  describe('peekStoredRpcUrl', () => {
    it('returns null when nothing is stored', () => {
      expect(peekStoredRpcUrl()).toBeNull();
    });

    it('returns the stored value (trimmed) — even when it equals the build-time default', () => {
      // Regression: legacy `getStoredRpcUrl !== CORE_RPC_URL` check threw away
      // user-explicit URLs that happened to equal the default, silently
      // routing cloud-mode RPC back to the local sidecar.
      localStorage.setItem(STORAGE_KEY, '  http://127.0.0.1:7788/rpc  ');
      expect(peekStoredRpcUrl()).toBe('http://127.0.0.1:7788/rpc');
    });
  });

  describe('getStoredCoreMode / storeCoreMode / clearStoredCoreMode', () => {
    it('returns null by default', () => {
      expect(getStoredCoreMode()).toBeNull();
    });

    it('round-trips local and cloud markers', () => {
      storeCoreMode('local');
      expect(getStoredCoreMode()).toBe('local');
      storeCoreMode('cloud');
      expect(getStoredCoreMode()).toBe('cloud');
    });

    it('treats unrecognised stored values as null', () => {
      localStorage.setItem(MODE_STORAGE_KEY, 'gibberish');
      expect(getStoredCoreMode()).toBeNull();
    });

    it('clearStoredCoreMode removes the marker', () => {
      storeCoreMode('cloud');
      clearStoredCoreMode();
      expect(getStoredCoreMode()).toBeNull();
    });

    it('logs the mode string directly, not an object wrapper', () => {
      const spy = vi.spyOn(console, 'debug').mockImplementation(() => {});
      try {
        storeCoreMode('cloud');
        const calls = spy.mock.calls.flat();
        // Must NOT log an object like { mode } — that renders as [object Object]
        const hasObjectArg = calls.some(arg => typeof arg === 'object' && arg !== null);
        expect(hasObjectArg).toBe(false);
        const modeArg = calls.find(arg => typeof arg === 'string' && arg === 'cloud');
        expect(modeArg).toBe('cloud');
      } finally {
        spy.mockRestore();
      }
    });

    it('falls back to the E2E default local mode when no marker has been written', async () => {
      vi.resetModules();
      vi.doMock('../config', () => ({
        CORE_RPC_URL: 'http://127.0.0.1:7788/rpc',
        E2E_DEFAULT_CORE_MODE: 'local',
      }));

      try {
        localStorage.removeItem(MODE_STORAGE_KEY);
        const mod = await import('../configPersistence');

        expect(mod.getStoredCoreMode()).toBe('local');
      } finally {
        vi.doUnmock('../config');
        vi.resetModules();
      }
    });
  });
});

describe('gateway id storage', () => {
  beforeEach(() => {
    localStorage.removeItem(GATEWAY_ID_STORAGE_KEY);
    localStorage.removeItem(MODE_STORAGE_KEY);
  });

  it('round-trips the id the gateway mode refers to', () => {
    storeGatewayId('builder');

    expect(peekStoredGatewayId()).toBe('builder');
    expect(localStorage.getItem(GATEWAY_ID_STORAGE_KEY)).toBe('builder');
  });

  it('reports nothing stored rather than an empty string', () => {
    // `coreModeSlice` falls through to the picker on null; an empty string
    // would be an id that resolves to no gateway.
    expect(peekStoredGatewayId()).toBeNull();
  });

  it('treats a blank stored value as nothing stored', () => {
    localStorage.setItem(GATEWAY_ID_STORAGE_KEY, '   ');

    expect(peekStoredGatewayId()).toBeNull();
  });

  it('trims surrounding whitespace off a stored id', () => {
    localStorage.setItem(GATEWAY_ID_STORAGE_KEY, '  builder  ');

    expect(peekStoredGatewayId()).toBe('builder');
  });

  it('stores no credential beside the id', () => {
    // The gateway's URL, bearer, SSH destination and identity path stay in the
    // Tauri shell's own store; a renderer XSS can read anything kept here.
    storeGatewayId('builder');

    const everything = Object.keys(localStorage).map(k => localStorage.getItem(k) ?? '');
    expect(everything.join(' ')).not.toMatch(/ssh|bearer|@/i);
  });

  it('accepts "gateway" as a core mode marker', () => {
    storeCoreMode('gateway');

    expect(getStoredCoreMode()).toBe('gateway');
  });
});