refactor: update remote sync interfaces and improve test structure

Author: egalvis27

src/apps/main/interface.d.ts

@@ -157,8 +157,10 @@ export interface IElectronAPI {
   startRemoteSync(): Promise<void>;
   getUpdateStatus(): Promise<{ version: string } | null>;
   onUpdateAvailable(callback: (info: { version: string }) => void): () => void;
-  getRemoteSyncStatus(): Promise<import('./remote-sync/helpers').RemoteSyncStatus>;
-  onRemoteSyncStatusChange(callback: (status: import('./remote-sync/helpers').RemoteSyncStatus) => void): () => void;
+  getRemoteSyncStatus(): Promise<import('../../backend/features/remote-sync/helpers').RemoteSyncStatus>;
+  onRemoteSyncStatusChange(
+    callback: (status: import('../../backend/features/remote-sync/helpers').RemoteSyncStatus) => void,
+  ): () => void;
   getVirtualDriveStatus(): Promise<import('../../backend/features/virtual-drive').FuseDriveStatus>;
   onVirtualDriveStatusChange(
     callback: (event: { status: import('../../backend/features/virtual-drive').FuseDriveStatus }) => void,

src/apps/main/preload.d.ts

@@ -149,8 +149,10 @@ declare interface Window {
 
     getUsage: () => Promise<import('../../backend/features/usage/usage.types').Usage>;
 
-    onRemoteSyncStatusChange(callback: (status: import('./remote-sync/helpers').RemoteSyncStatus) => void): () => void;
-    getRemoteSyncStatus(): Promise<import('./remote-sync/helpers').RemoteSyncStatus>;
+    onRemoteSyncStatusChange(
+      callback: (status: import('../../backend/features/remote-sync/helpers').RemoteSyncStatus) => void,
+    ): () => void;
+    getRemoteSyncStatus(): Promise<import('../../backend/features/remote-sync/helpers').RemoteSyncStatus>;
     getVirtualDriveStatus(): Promise<import('../../backend/features/virtual-drive').FuseDriveStatus>;
     onVirtualDriveStatusChange(
       callback: (event: { status: import('../../backend/features/virtual-drive').FuseDriveStatus }) => void,

src/backend/features/remote-sync/handlers.test.ts

@@ -1,7 +1,5 @@
-import { ipcMain } from 'electron';
 import { logger } from '@internxt/drive-desktop-core/build/backend';
 import { vi } from 'vitest';
-import { getIpcHandler } from '../../../../tests/vitest/ipc.helper';
 import { call, calls, partialSpyOn } from '../../../../tests/vitest/utils.helper';
 
 const mocks = vi.hoisted(() => {
@@ -22,12 +20,19 @@ vi.mock('./service', () => ({
   startRemoteSync: mocks.startRemoteSync,
 }));
 
+type IpcMainHandleMock = {
+  handle: { mock: { calls: Array<[string, (...args: unknown[]) => unknown]> } };
+};
+
 async function loadHandlersModule() {
   vi.resetModules();
 
+  const electronModule = await import('electron');
   const eventBusModule = await import('../../../apps/main/event-bus');
   const initialSyncReadyModule = await import('./InitialSyncReady');
 
+  const ipcMain = electronModule.ipcMain as unknown as IpcMainHandleMock;
+
   const eventBusOnMock = partialSpyOn(eventBusModule.default, 'on', false);
   const eventBusEmitMock = partialSpyOn(eventBusModule.default, 'emit');
   const setInitialSyncStateMock = partialSpyOn(initialSyncReadyModule, 'setInitialSyncState');
@@ -37,10 +42,15 @@ async function loadHandlersModule() {
   return {
     eventBusEmitMock,
     eventBusOnMock,
+    ipcMain,
     setInitialSyncStateMock,
   };
 }
 
+function getIpcHandler(ipcMain: IpcMainHandleMock, eventName: string) {
+  return ipcMain.handle.mock.calls.find(([name]) => name === eventName)?.[1];
+}
+
 function getEventBusHandler(eventBusOnMock: ReturnType<typeof partialSpyOn>, eventName: string) {
   const calls = eventBusOnMock.mock.calls as Array<[string, (...args: unknown[]) => unknown]>;
 
@@ -57,7 +67,7 @@ describe('handlers.test', () => {
 
   it('should register ipc handlers and event listeners', async () => {
     // When
-    const { eventBusOnMock } = await loadHandlersModule();
+    const { eventBusOnMock, ipcMain } = await loadHandlersModule();
 
     // Then
     expect(ipcMain.handle).toHaveBeenCalledWith('START_REMOTE_SYNC', expect.any(Function));
@@ -69,8 +79,8 @@ describe('handlers.test', () => {
 
   it('should start a sync from the ipc handler and emit remote changes synched', async () => {
     // Given
-    const { eventBusEmitMock } = await loadHandlersModule();
-    const handler = getIpcHandler('START_REMOTE_SYNC');
+    const { eventBusEmitMock, ipcMain } = await loadHandlersModule();
+    const handler = getIpcHandler(ipcMain, 'START_REMOTE_SYNC');
 
     // When
     await handler?.();
@@ -83,8 +93,8 @@ describe('handlers.test', () => {
   it('should return the current sync status from the ipc handler', async () => {
     // Given
     mocks.remoteSyncController.getSyncStatus.mockReturnValue('SYNCED');
-    await loadHandlersModule();
-    const handler = getIpcHandler('get-remote-sync-status');
+    const { ipcMain } = await loadHandlersModule();
+    const handler = getIpcHandler(ipcMain, 'get-remote-sync-status');
 
     // When
     const result = await handler?.();

src/backend/features/remote-sync/service.test.ts

@@ -41,7 +41,6 @@ function createUpdatedRemoteItemsDtoFixture(): UpdatedRemoteItemsDto {
 const mocks = vi.hoisted(() => {
   const filesCollection = {
     getAll: vi.fn(),
-    getAllWhere: vi.fn(),
   };
 
   const foldersCollection = {
@@ -69,11 +68,15 @@ vi.mock('lodash', () => ({
 }));
 
 vi.mock('../../../apps/main/database/collections/DriveFileCollection', () => ({
-  DriveFilesCollection: vi.fn(() => mocks.filesCollection),
+  DriveFilesCollection: vi.fn(function DriveFilesCollectionMock() {
+    return mocks.filesCollection;
+  }),
 }));
 
 vi.mock('../../../apps/main/database/collections/DriveFolderCollection', () => ({
-  DriveFoldersCollection: vi.fn(() => mocks.foldersCollection),
+  DriveFoldersCollection: vi.fn(function DriveFoldersCollectionMock() {
+    return mocks.foldersCollection;
+  }),
 }));
 
 vi.mock('./remote-sync-controller', () => ({
@@ -123,7 +126,6 @@ describe('service.test', () => {
     const result = createUpdatedRemoteItemsDtoFixture();
     mocks.filesCollection.getAll.mockResolvedValue({ success: true, result: result.files });
     mocks.foldersCollection.getAll.mockResolvedValue({ success: true, result: result.folders });
-    mocks.filesCollection.getAllWhere.mockResolvedValue({ result: [{ uuid: 'file-1' }] });
   });
 
   it('should mark initial sync as ready and broadcast when the controller becomes synced for the first time', async () => {
@@ -203,15 +205,4 @@ describe('service.test', () => {
     call(eventBusEmitMock).toBe('REMOTE_CHANGES_SYNCHED');
   });
 
-  it('should return only existing files from the local collection', async () => {
-    // Given
-    const { service } = await loadServiceModule();
-
-    // When
-    const result = await service.getExistingFiles();
-
-    // Then
-    call(mocks.filesCollection.getAllWhere).toStrictEqual({ status: 'EXISTS' });
-    expect(result).toStrictEqual([{ uuid: 'file-1' }]);
-  });
 });