studio-desktop/tests/unit/services/telemetry.test.ts

import { IpcMainEvent, IpcMainInvokeEvent, ipcMain } from 'electron';
import fs from 'node:fs';
import path from 'node:path';
import { beforeEach, describe, expect, it, vi } from 'vitest';

import { ComfySettings, useComfySettings } from '@/config/comfySettings';
import { IPC_CHANNELS } from '@/constants';
import type { AppWindow } from '@/main-process/appWindow';
import { MixpanelTelemetry, promptMetricsConsent } from '@/services/telemetry';
import type { DesktopConfig } from '@/store/desktopConfig';

vi.unmock('@sentry/electron/main');
vi.unmock('@/services/telemetry');

vi.mock('@sentry/electron/main', () => ({
  init: vi.fn(),
  captureException: vi.fn(),
  setContext: vi.fn(),
}));

vi.mock('node:fs', () => {
  const mockFs = {
    existsSync: vi.fn(),
    readFileSync: vi.fn(),
    writeFileSync: vi.fn(),
  };
  return {
    default: mockFs,
    ...mockFs,
  };
});

vi.mock('node:fs/promises', () => ({
  access: vi.fn().mockResolvedValue(undefined),
  readFile: vi.fn().mockResolvedValue('{"Comfy-Desktop.SendStatistics": true}'),
  writeFile: vi.fn().mockResolvedValue(undefined),
}));

vi.mock('@/config/comfySettings', () => {
  const mockSettings = {
    get: vi.fn(),
    set: vi.fn(),
    saveSettings: vi.fn(),
  };
  return {
    ComfySettings: {
      load: vi.fn().mockResolvedValue(mockSettings),
    },
    useComfySettings: vi.fn(() => mockSettings),
  };
});

vi.mock('mixpanel');

vi.mock('@/store/desktopConfig', () => ({
  useDesktopConfig: vi.fn(() => ({
    get: vi.fn(() => '/mock/path'),
    set: vi.fn(),
  })),
}));

describe('MixpanelTelemetry', () => {
  let telemetry: MixpanelTelemetry;
  const mockInitializedMixpanelClient = {
    track: vi.fn(),
    people: {
      set: vi.fn(),
      increment: vi.fn(),
    },
  };
  const mockMixpanelClient = {
    init: vi.fn(() => mockInitializedMixpanelClient),
  };

  beforeEach(async () => {
    // Initialize settings before each test
    await ComfySettings.load('/mock/path');
  });

  describe('distinct ID management', () => {
    it('should read existing distinct ID from file', () => {
      const existingId = 'existing-uuid';
      vi.mocked(fs.existsSync).mockReturnValue(true);
      vi.mocked(fs.readFileSync).mockReturnValue(existingId);
      telemetry = new MixpanelTelemetry(mockMixpanelClient as any);
      expect(fs.readFileSync).toHaveBeenCalledWith(path.join('/mock/app/path', 'telemetry.txt'), 'utf8');
      expect(fs.writeFileSync).not.toHaveBeenCalled();
    });

    it('should create new distinct ID if file does not exist', () => {
      vi.mocked(fs.existsSync).mockReturnValue(false);
      telemetry = new MixpanelTelemetry(mockMixpanelClient as any);

      expect(fs.writeFileSync).toHaveBeenCalled();
      const writtenId = vi.mocked(fs.writeFileSync).mock.calls[0][1] as string;
      expect(typeof writtenId).toBe('string');
      expect(writtenId.length).toBeGreaterThan(0);
    });
  });

  describe('event queueing and consent', () => {
    it('should queue events when consent is not given', () => {
      const eventName = 'test_event';
      const properties = { foo: 'bar' };
      telemetry = new MixpanelTelemetry(mockMixpanelClient as any);
      telemetry.track(eventName, properties);

      expect(telemetry['queue'].length).toBe(1);
      expect(telemetry['queue'][0].eventName).toBe(eventName);
      expect(telemetry['queue'][0].properties).toMatchObject({
        ...properties,
        distinct_id: expect.any(String),
        time: expect.any(Number),
      });
    });

    it('should flush queue when consent is given', () => {
      const eventName = 'test_event';
      telemetry = new MixpanelTelemetry(mockMixpanelClient as any);
      telemetry.track(eventName);

      // Simulate receiving consent
      const installOptionsHandler = vi.mocked(ipcMain.on).mock.calls[0][1];
      const mockIpcEvent = {} as IpcMainEvent;
      installOptionsHandler(mockIpcEvent, { allowMetrics: true });

      // Track a new event which should trigger flush
      telemetry.track('another_event');

      expect(telemetry['queue'].length).toBe(0);
      expect(mockInitializedMixpanelClient.track).toHaveBeenCalledTimes(2);
    });
  });

  describe('IPC event handling', () => {
    it('should handle INSTALL_COMFYUI event and update consent', () => {
      telemetry = new MixpanelTelemetry(mockMixpanelClient as any);
      const mockIpcEvent = {} as IpcMainEvent;
      const installOptionsHandler = vi.mocked(ipcMain.on).mock.calls[0][1];
      installOptionsHandler(mockIpcEvent, { allowMetrics: true });
      expect(telemetry.hasConsent).toBe(true);
    });

    it('should register ipc handler for TRACK_EVENT', () => {
      telemetry = new MixpanelTelemetry(mockMixpanelClient as any);
      telemetry.registerHandlers();

      expect(ipcMain.on).toHaveBeenCalledWith(IPC_CHANNELS.TRACK_EVENT, expect.any(Function));
    });

    it('should handle TRACK_EVENT directly', () => {
      telemetry = new MixpanelTelemetry(mockMixpanelClient as any);
      // Register the handlers first
      telemetry.registerHandlers();

      // Get the TRACK_EVENT handler directly
      const [, trackEventHandler] = (ipcMain.on as any).mock.calls.find(
        ([channel]: any) => channel === IPC_CHANNELS.TRACK_EVENT
      );

      // Simulate the TRACK_EVENT
      const mockIpcEvent = {} as IpcMainEvent;
      trackEventHandler(mockIpcEvent, 'test_event', { foo: 'bar' });

      // Verify the event was queued (since consent is false by default)
      expect(telemetry['queue'].length).toBe(1);
      expect(telemetry['queue'][0]).toMatchObject({
        eventName: 'test_event',
        properties: expect.objectContaining({
          foo: 'bar',
          distinct_id: expect.any(String),
          time: expect.any(Number),
        }),
      });
    });

    it('should register ipc handler for INCREMENT_USER_PROPERTY', () => {
      telemetry = new MixpanelTelemetry(mockMixpanelClient as any);
      telemetry.registerHandlers();

      expect(ipcMain.on).toHaveBeenCalledWith(IPC_CHANNELS.INCREMENT_USER_PROPERTY, expect.any(Function));
    });

    it.skip('should handle INCREMENT_USER_PROPERTY messages', () => {
      telemetry = new MixpanelTelemetry(mockMixpanelClient as any);
      telemetry.registerHandlers();
      // Get the callback that was registered
      const [, callback] = (ipcMain.on as any).mock.calls.find(
        ([channel]: any) => channel === IPC_CHANNELS.INCREMENT_USER_PROPERTY
      );

      // Simulate IPC call
      callback({}, 'test_property', 5);

      // Verify mixpanel client was called correctly
      expect(mockInitializedMixpanelClient.people.increment).toHaveBeenCalledWith(
        telemetry['distinctId'],
        'test_property',
        5
      );
    });
  });
});

describe('MixpanelTelemetry', () => {
  it('should properly initialize mixpanel client', () => {
    // Create a mock mixpanel client
    const mockInitializedClient = { track: vi.fn(), people: { set: vi.fn() } };
    const mockMixpanelClient = {
      init: vi.fn().mockReturnValue(mockInitializedClient),
    };

    // Create telemetry instance with mock client
    const telemetry = new MixpanelTelemetry(mockMixpanelClient as any);

    // Verify init was called
    expect(mockMixpanelClient.init).toHaveBeenCalled();

    // This will fail because the initialized client isn't being assigned
    expect(telemetry['mixpanelClient']).toBe(mockInitializedClient);
  });
});

describe('promptMetricsConsent', () => {
  let store: Pick<DesktopConfig, 'get' | 'set'>;
  let appWindow: Pick<AppWindow, 'loadPage'>;

  const versionBeforeUpdate = '0.4.1';
  const versionAfterUpdate = '1.0.1';

  beforeEach(async () => {
    store = { get: vi.fn(), set: vi.fn() };
    appWindow = { loadPage: vi.fn() };
    // Initialize settings before each test
    await ComfySettings.load('/mock/path');
  });

  const runTest = async ({
    storeValue,
    settingsValue,
    expectedResult,
    mockConsent,
    promptUser,
  }: {
    storeValue: string | undefined;
    settingsValue: boolean | null | undefined;
    expectedResult: boolean;
    mockConsent?: boolean;
    promptUser?: boolean;
  }) => {
    vi.mocked(store.get).mockReturnValue(storeValue);
    vi.mocked(useComfySettings().get).mockReturnValue(settingsValue);

    if (mockConsent !== undefined) {
      vi.mocked(ipcMain.handleOnce).mockImplementation(((
        channel: string,
        handler: (event: IpcMainInvokeEvent, ...args: any[]) => unknown
      ): void => {
        if (channel === IPC_CHANNELS.SET_METRICS_CONSENT) {
          handler({} as IpcMainInvokeEvent, mockConsent);
        }
      }) as any);
    }

    // @ts-expect-error - appWindow is a mock and doesn't implement all of AppWindow
    const result = await promptMetricsConsent(store as DesktopConfig, appWindow);

    expect(result).toBe(expectedResult);

    if (promptUser) {
      expect(store.set).toHaveBeenCalled();
      expect(appWindow.loadPage).toHaveBeenCalledWith('metrics-consent');
      expect(ipcMain.handleOnce).toHaveBeenCalledWith(IPC_CHANNELS.SET_METRICS_CONSENT, expect.any(Function));
    }

    if (promptUser) ipcMain.removeHandler(IPC_CHANNELS.SET_METRICS_CONSENT);
  };

  it('should prompt for update if metrics were previously enabled', async () => {
    await runTest({
      storeValue: versionBeforeUpdate,
      settingsValue: true,
      expectedResult: true,
      mockConsent: true,
      promptUser: true,
    });
    expect(store.set).toHaveBeenCalled();
    expect(appWindow.loadPage).toHaveBeenCalledWith('metrics-consent');
    expect(ipcMain.handleOnce).toHaveBeenCalledWith(IPC_CHANNELS.SET_METRICS_CONSENT, expect.any(Function));
  });

  it('should not show prompt if consent is up-to-date', async () => {
    await runTest({
      storeValue: versionAfterUpdate,
      settingsValue: true,
      expectedResult: true,
    });
    expect(store.get).toHaveBeenCalledWith('versionConsentedMetrics');
    expect(store.set).not.toHaveBeenCalled();
    expect(appWindow.loadPage).not.toHaveBeenCalled();
    expect(ipcMain.handleOnce).not.toHaveBeenCalled();
  });

  it('should return true if consent is up-to-date and metrics enabled', async () => {
    await runTest({
      storeValue: versionAfterUpdate,
      settingsValue: true,
      expectedResult: true,
    });
    expect(store.set).not.toHaveBeenCalled();
  });

  it('should return false if consent is up-to-date and metrics are disabled', async () => {
    await runTest({
      storeValue: versionAfterUpdate,
      settingsValue: false,
      expectedResult: false,
    });
    expect(store.set).not.toHaveBeenCalled();
  });

  it('should return false if consent is out-of-date and metrics are disabled', async () => {
    await runTest({
      storeValue: versionBeforeUpdate,
      settingsValue: false,
      expectedResult: false,
    });
    expect(store.set).toHaveBeenCalled();
    expect(appWindow.loadPage).not.toHaveBeenCalled();
    expect(ipcMain.handleOnce).not.toHaveBeenCalled();
  });

  it('should update consent to false if the user denies', async () => {
    await runTest({
      storeValue: versionBeforeUpdate,
      settingsValue: true,
      expectedResult: false,
      mockConsent: false,
      promptUser: true,
    });
    expect(store.set).toHaveBeenCalled();
    expect(appWindow.loadPage).toHaveBeenCalledWith('metrics-consent');
    expect(ipcMain.handleOnce).toHaveBeenCalledWith(IPC_CHANNELS.SET_METRICS_CONSENT, expect.any(Function));
  });

  it('should return false if previous metrics setting is null', async () => {
    await runTest({
      storeValue: versionBeforeUpdate,
      settingsValue: null,
      expectedResult: false,
    });
    expect(store.set).toHaveBeenCalled();
    expect(appWindow.loadPage).not.toHaveBeenCalled();
    expect(ipcMain.handleOnce).not.toHaveBeenCalled();
  });

  it('should prompt for update if versionConsentedMetrics is undefined', async () => {
    await runTest({
      storeValue: undefined,
      settingsValue: true,
      expectedResult: true,
      mockConsent: true,
      promptUser: true,
    });
    expect(store.set).toHaveBeenCalled();
    expect(appWindow.loadPage).toHaveBeenCalledWith('metrics-consent');
    expect(ipcMain.handleOnce).toHaveBeenCalledWith(IPC_CHANNELS.SET_METRICS_CONSENT, expect.any(Function));
  });

  it('should return false if both settings are null or undefined', async () => {
    await runTest({
      storeValue: undefined,
      settingsValue: null,
      expectedResult: false,
    });
    expect(store.set).toHaveBeenCalled();
    expect(appWindow.loadPage).not.toHaveBeenCalled();
    expect(ipcMain.handleOnce).not.toHaveBeenCalled();
  });

  it('should return false if metrics are disabled and consent is null', async () => {
    await runTest({
      storeValue: versionBeforeUpdate,
      settingsValue: null,
      expectedResult: false,
    });
    expect(store.set).toHaveBeenCalled();
    expect(appWindow.loadPage).not.toHaveBeenCalled();
    expect(ipcMain.handleOnce).not.toHaveBeenCalled();
  });
});