Skip to content

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

12.7 KB
Raw Blame
/**
 * Unit tests for `isTauri()` — the canonical Tauri-runtime guard used across
 * `app/src/`. Beyond delegating to `@tauri-apps/api/core::isTauri()`, this
 * wrapper also confirms that the IPC transport (`window.__TAURI_INTERNALS__
 * .invoke`) is wired before reporting `true`.
 *
 * Why it matters: under CEF, `globalThis.isTauri` (which the underlying
 * `coreIsTauri()` checks) is injected by the webview bootstrap BEFORE the
 * `postMessage` IPC bridge is connected. An `invoke()` landing in that gap
 * throws `TypeError: Cannot read properties of undefined (reading
 * 'postMessage')` deep inside Tauri's `sendIpcMessage`, which surfaces as
 * the OPENHUMAN-REACT-S Sentry issue (#1472 follow-up). All call sites that
 * gate on `isTauri()` should now route through the non-Tauri branch during
 * the gap instead of bursting into IPC.
 */
import { afterEach, beforeEach, describe, expect, it, vi } from 'vitest';

import { IpcUnavailableError, isTauri, parseServiceCliOutput, safeInvoke } from './common';

const coreIsTauriMock = vi.fn();
const coreInvokeMock = vi.fn();

vi.mock('@tauri-apps/api/core', () => ({
  isTauri: () => coreIsTauriMock(),
  // Forward only the args that `safeInvoke` actually passed so arity-strict
  // expectations (`toHaveBeenCalledWith(cmd)` / `toHaveBeenCalledWith(cmd,
  // args)`) match the wrapper's contract. Spreading `arguments` would invent
  // a trailing `undefined`; using rest preserves the original arity.
  invoke: (...args: unknown[]) => coreInvokeMock(...args),
}));

describe('isTauri (tauriCommands/common)', () => {
  // We mutate `window` to simulate Tauri-runtime bootstrap state across cases.
  // Stash + restore so other tests in the suite (which share the jsdom global)
  // see a pristine window.
  let originalInternals: unknown;

  beforeEach(() => {
    coreIsTauriMock.mockReset();
    originalInternals = (window as unknown as { __TAURI_INTERNALS__?: unknown })
      .__TAURI_INTERNALS__;
  });

  afterEach(() => {
    if (originalInternals === undefined) {
      delete (window as unknown as { __TAURI_INTERNALS__?: unknown }).__TAURI_INTERNALS__;
    } else {
      (window as unknown as { __TAURI_INTERNALS__?: unknown }).__TAURI_INTERNALS__ =
        originalInternals;
    }
  });

  it('returns false when not running in Tauri at all (browser/Vitest)', () => {
    coreIsTauriMock.mockReturnValue(false);
    delete (window as unknown as { __TAURI_INTERNALS__?: unknown }).__TAURI_INTERNALS__;

    expect(isTauri()).toBe(false);
  });

  it('returns true when both the runtime flag and the IPC `invoke` handle are present', () => {
    coreIsTauriMock.mockReturnValue(true);
    (window as unknown as { __TAURI_INTERNALS__?: { invoke: unknown } }).__TAURI_INTERNALS__ = {
      invoke: () => Promise.resolve(),
    };

    expect(isTauri()).toBe(true);
  });

  // The OPENHUMAN-REACT-S regression: Tauri sets `globalThis.isTauri = true`
  // (so the official check returns true) before CEF wires the IPC postMessage
  // bridge. During that gap any unguarded `invoke(...)` blows up inside
  // `sendIpcMessage` with the "Cannot read properties of undefined (reading
  // 'postMessage')" TypeError. Our guard must short-circuit to `false` so
  // call sites skip the IPC path instead of trusting the runtime flag alone.
  it('returns false during the CEF gap when runtime flag is set but __TAURI_INTERNALS__ is missing', () => {
    coreIsTauriMock.mockReturnValue(true);
    delete (window as unknown as { __TAURI_INTERNALS__?: unknown }).__TAURI_INTERNALS__;

    expect(isTauri()).toBe(false);
  });

  it('returns false during the partial-bootstrap gap when __TAURI_INTERNALS__ exists but `invoke` is not yet wired', () => {
    coreIsTauriMock.mockReturnValue(true);
    // Some CEF bootstrap stages set the object literal before the IPC handle
    // is attached. Treat that as "not ready".
    (window as unknown as { __TAURI_INTERNALS__?: Record<string, unknown> }).__TAURI_INTERNALS__ =
      {};

    expect(isTauri()).toBe(false);
  });

  it('returns false when __TAURI_INTERNALS__.invoke is present but not a function', () => {
    coreIsTauriMock.mockReturnValue(true);
    (window as unknown as { __TAURI_INTERNALS__?: { invoke: unknown } }).__TAURI_INTERNALS__ = {
      invoke: 'not-a-function',
    };

    expect(isTauri()).toBe(false);
  });
});

// `parseServiceCliOutput` runs against raw CLI stdout from the `openhuman`
// sidecar. The core process can crash mid-write, return a partial response, or
// drift from the expected JSON schema across versions — any of which produces
// malformed input. The guard must reject those cases with a descriptive error
// rather than handing typed garbage back to callers.
describe('parseServiceCliOutput (tauriCommands/common)', () => {
  it('returns the parsed response when shape matches CommandResponse', () => {
    const raw = JSON.stringify({ result: { value: 42 }, logs: ['ok'] });

    const parsed = parseServiceCliOutput<{ value: number }>(raw);

    expect(parsed.result).toEqual({ value: 42 });
    expect(parsed.logs).toEqual(['ok']);
  });

  it('accepts null result and empty logs (valid CommandResponse shape)', () => {
    const raw = JSON.stringify({ result: null, logs: [] });

    const parsed = parseServiceCliOutput<null>(raw);

    expect(parsed.result).toBeNull();
    expect(parsed.logs).toEqual([]);
  });

  it('throws a descriptive error when the input is not valid JSON', () => {
    expect(() => parseServiceCliOutput('not-json')).toThrow(/Failed to parse service CLI output/);
  });

  it('throws when the parsed value is null', () => {
    expect(() => parseServiceCliOutput('null')).toThrow(/CommandResponse shape/);
  });

  it('throws when the parsed value is an array (not an object)', () => {
    expect(() => parseServiceCliOutput('[]')).toThrow(/CommandResponse shape/);
  });

  it('throws when required `logs` field is missing', () => {
    expect(() => parseServiceCliOutput(JSON.stringify({ result: 1 }))).toThrow(
      /CommandResponse shape/
    );
  });

  it('throws when required `result` field is missing', () => {
    expect(() => parseServiceCliOutput(JSON.stringify({ logs: [] }))).toThrow(
      /CommandResponse shape/
    );
  });

  it('throws when `logs` is not an array', () => {
    expect(() => parseServiceCliOutput(JSON.stringify({ result: 1, logs: 'oops' }))).toThrow(
      /CommandResponse shape/
    );
  });

  it('throws when `logs` contains non-string entries', () => {
    expect(() => parseServiceCliOutput(JSON.stringify({ result: 1, logs: [1, 2] }))).toThrow(
      /CommandResponse shape/
    );
  });
});

// `safeInvoke` is the migration target for every IPC call site that today
// hands a bare `invoke(...)` Promise to `.catch(noop)` or to a try/catch.
// Under CEF the underlying `coreInvoke` can throw **synchronously** when the
// vendored `ipc-protocol.js` fallback path runs into the unwired
// `window.ipc.postMessage` (see OPENHUMAN-TAURI-REACT-7 / TAURI-REACT-6). The
// sync throw escapes the surrounding Promise body and lands on
// `onunhandledrejection`, where Sentry captures it as noisy `Non-Error
// promise rejection` events. `safeInvoke` must convert that into a rejected
// Promise tagged with `IpcUnavailableError`.
describe('safeInvoke (tauriCommands/common)', () => {
  beforeEach(() => {
    coreInvokeMock.mockReset();
  });

  it('returns the resolved value when the underlying invoke resolves', async () => {
    coreInvokeMock.mockResolvedValue('ok');

    await expect(safeInvoke<string>('greet')).resolves.toBe('ok');
    // Wrapper forwards only the args the caller passed (preserves arity for
    // strict-match test mocks like `tauriBridge.test.ts`).
    expect(coreInvokeMock).toHaveBeenCalledWith('greet');
  });

  it('forwards args (and only args) when called with two arguments', async () => {
    coreInvokeMock.mockResolvedValue(42);

    await safeInvoke<number>('doStuff', { foo: 1 });

    expect(coreInvokeMock).toHaveBeenCalledWith('doStuff', { foo: 1 });
  });

  it('forwards args and options when called with three arguments', async () => {
    coreInvokeMock.mockResolvedValue(42);

    await safeInvoke<number>('doStuff', { foo: 1 }, { headers: { 'X-Test': '1' } });

    expect(coreInvokeMock).toHaveBeenCalledWith(
      'doStuff',
      { foo: 1 },
      { headers: { 'X-Test': '1' } }
    );
  });

  it('rejects with the original error when the underlying invoke returns a rejected promise (no sync throw)', async () => {
    coreInvokeMock.mockRejectedValue(new Error('command failed'));

    await expect(safeInvoke<string>('whatever')).rejects.toThrow('command failed');
  });

  // The OPENHUMAN-TAURI-REACT-7 / TAURI-REACT-6 regression: a sync `TypeError`
  // thrown inside the IPC fallback (vendored `ipc-protocol.js:84`) escapes the
  // Promise body of `coreInvoke` if the call site doesn't wrap it. `safeInvoke`
  // must catch that throw and surface it as a *rejected* Promise instead, so
  // existing `.catch(...)` chains keep working and Sentry stops capturing the
  // raw TypeError as an unhandled rejection.
  it('converts a synchronous coreInvoke throw into a rejected Promise', async () => {
    coreInvokeMock.mockImplementation(() => {
      throw new Error('something went wrong sync');
    });

    const promise = safeInvoke<string>('willThrow');
    // The wrapper must return a Promise *object* even though the underlying
    // call threw synchronously. `expect(...).rejects` would fail with a
    // confusing message if the wrapper itself re-threw.
    expect(promise).toBeInstanceOf(Promise);
    await expect(promise).rejects.toThrow('something went wrong sync');
  });

  it('wraps the CEF "postMessage of undefined" TypeError in IpcUnavailableError', async () => {
    const cefThrow = new TypeError("Cannot read properties of undefined (reading 'postMessage')");
    coreInvokeMock.mockImplementation(() => {
      throw cefThrow;
    });

    const err = await safeInvoke<void>('mascot_window_hide').catch((e: unknown) => e);

    expect(err).toBeInstanceOf(IpcUnavailableError);
    const typed = err as IpcUnavailableError;
    expect(typed.name).toBe('IpcUnavailableError');
    expect(typed.cmd).toBe('mascot_window_hide');
    expect(typed.cause).toBe(cefThrow);
    expect(typed.message).toContain('mascot_window_hide');
    expect(typed.message).toContain('postMessage');
  });

  it('does NOT wrap unrelated TypeErrors that do not mention postMessage', async () => {
    const otherTypeError = new TypeError('something else entirely');
    coreInvokeMock.mockImplementation(() => {
      throw otherTypeError;
    });

    const err = await safeInvoke<void>('some_cmd').catch((e: unknown) => e);

    // Pass through verbatim — existing message-based classifiers (e.g.
    // `classifyWebviewAccountError`) must keep seeing the original error.
    expect(err).toBe(otherTypeError);
    expect(err).not.toBeInstanceOf(IpcUnavailableError);
  });

  it('also rejects with IpcUnavailableError when the failure mode arrives via the promise (mid-session fallback)', async () => {
    // The fallback path can also surface the same TypeError via the rejected
    // Promise pathway (when CEF eventually wires the bridge object, the call
    // proceeds far enough to construct the Promise but still fails on the
    // missing `postMessage`). Same classifier must handle both shapes.
    const cefThrow = new TypeError("Cannot read properties of undefined (reading 'postMessage')");
    coreInvokeMock.mockRejectedValue(cefThrow);

    const err = await safeInvoke<void>('mascot_window_show').catch((e: unknown) => e);

    expect(err).toBeInstanceOf(IpcUnavailableError);
    expect((err as IpcUnavailableError).cmd).toBe('mascot_window_show');
  });

  // #5155: the dereference is now *guarded* — the vendored bootstrap and
  // settles the pending callback with a plain
  // `{ message }` object instead of letting a `TypeError` escape. That shape
  // is not a `TypeError`, so the classifier must recognise it by message or
  // every `instanceof IpcUnavailableError` degradation branch goes dead.
  it.each(['IPC postMessage interface is unavailable on this platform'])(
    'classifies the guarded IPC-unavailable rejection %j as IpcUnavailableError',
    async message => {
      coreInvokeMock.mockRejectedValue({ message });

      const err = await safeInvoke<void>('core_rpc_url').catch((e: unknown) => e);

      expect(err).toBeInstanceOf(IpcUnavailableError);
      // The underlying reason survives instead of collapsing to the generic
      // 'IPC bridge not wired' fallback string.
      expect((err as IpcUnavailableError).message).toContain(message);
    }
  );

  it('does NOT classify an unrelated rejection object as IpcUnavailableError', async () => {
    const other = { message: 'thread not found' };
    coreInvokeMock.mockRejectedValue(other);

    const err = await safeInvoke<void>('threads_get').catch((e: unknown) => e);

    expect(err).toBe(other);
  });
});