feat: move sync manager to LLC too

Author: isekovanic

package/src/components/Channel/Channel.tsx

@@ -94,7 +94,6 @@ import * as dbApi from '../../store/apis';
 import { ChannelUnreadState, FileTypes } from '../../types/types';
 import { addReactionToLocalState } from '../../utils/addReactionToLocalState';
 import { compressedImageURI } from '../../utils/compressImage';
-import { DBSyncManager } from '../../utils/DBSyncManager';
 import { patchMessageTextCommand } from '../../utils/patchMessageTextCommand';
 import { removeReactionFromLocalState } from '../../utils/removeReactionFromLocalState';
 import { removeReservedFields } from '../../utils/removeReservedFields';
@@ -1065,11 +1064,13 @@ const ChannelWithContext = (props: PropsWithChildren<ChannelPropsWithContext>) =
     let connectionChangedSubscription: ReturnType<ChannelType['on']>;
 
     if (enableOfflineSupport) {
-      connectionChangedSubscription = DBSyncManager.onSyncStatusChange((statusChanged) => {
-        if (statusChanged) {
-          connectionChangedHandler();
-        }
-      });
+      connectionChangedSubscription = client.offlineDb.syncManager.onSyncStatusChange(
+        (statusChanged) => {
+          if (statusChanged) {
+            connectionChangedHandler();
+          }
+        },
+      );
     } else {
       connectionChangedSubscription = client.on('connection.changed', (event) => {
         if (event.online) {
@@ -1080,8 +1081,7 @@ const ChannelWithContext = (props: PropsWithChildren<ChannelPropsWithContext>) =
     return () => {
       connectionChangedSubscription.unsubscribe();
     };
-    // eslint-disable-next-line react-hooks/exhaustive-deps
-  }, [enableOfflineSupport, shouldSyncChannel]);
+  }, [enableOfflineSupport, client, shouldSyncChannel]);
 
   // In case the channel is disconnected which may happen when channel is deleted,
   // underlying js client throws an error. Following function ensures that Channel component
@@ -1493,8 +1493,7 @@ const ChannelWithContext = (props: PropsWithChildren<ChannelPropsWithContext>) =
 
     copyMessagesStateFromChannel(channel);
 
-    const sendReactionResponse = await DBSyncManager.queueTask({
-      client,
+    const sendReactionResponse = await client.offlineDb.syncManager.queueTask({
       task: {
         channelId: channel.id,
         channelType: channel.type,
@@ -1523,7 +1522,7 @@ const ChannelWithContext = (props: PropsWithChildren<ChannelPropsWithContext>) =
     }
 
     if (message.status === MessageStatusTypes.FAILED) {
-      await DBSyncManager.dropPendingTasks({ messageId: message.id });
+      await client.offlineDb.syncManager.dropPendingTasks({ messageId: message.id });
       await removeMessage(message);
     } else {
       const updatedMessage = {
@@ -1536,8 +1535,7 @@ const ChannelWithContext = (props: PropsWithChildren<ChannelPropsWithContext>) =
 
       threadInstance?.upsertReplyLocally({ message: updatedMessage });
 
-      const data = await DBSyncManager.queueTask({
-        client,
+      const data = await client.offlineDb.syncManager.queueTask({
         task: {
           channelId: channel.id,
           channelType: channel.type,
@@ -1577,8 +1575,7 @@ const ChannelWithContext = (props: PropsWithChildren<ChannelPropsWithContext>) =
 
     copyMessagesStateFromChannel(channel);
 
-    await DBSyncManager.queueTask({
-      client,
+    await client.offlineDb.syncManager.queueTask({
       task: {
         channelId: channel.id,
         channelType: channel.type,

package/src/components/ChannelList/hooks/usePaginatedChannels.ts

@@ -229,18 +229,18 @@ export const usePaginatedChannels = ({
       return true;
     };
 
-    let listener: ReturnType<typeof DBSyncManager.onSyncStatusChange>;
+    let listener: ReturnType<typeof client.offlineDb.syncManager.onSyncStatusChange>;
     if (enableOfflineSupport) {
       // Any time DB is synced, we need to update the UI with local DB channels first,
       // and then call queryChannels to ensure any new channels are added to UI.
-      listener = DBSyncManager.onSyncStatusChange(async (syncStatus) => {
-        // if (syncStatus) {
-        //   const loadingChannelsSucceeded = await loadOfflineChannels();
-        //   if (loadingChannelsSucceeded) {
-        //     await reloadList();
-        //     setForceUpdate((u) => u + 1);
-        //   }
-        // }
+      listener = client.offlineDb.syncManager.onSyncStatusChange(async (syncStatus) => {
+        if (syncStatus) {
+          //   const loadingChannelsSucceeded = await loadOfflineChannels();
+          //   if (loadingChannelsSucceeded) {
+          await reloadList();
+          //     setForceUpdate((u) => u + 1);
+          //   }
+        }
       });
       // On start, load the channels from local db.
       // loadOfflineChannels().then((success) => {
@@ -265,7 +265,7 @@ export const usePaginatedChannels = ({
 
     return () => listener?.unsubscribe?.();
     // eslint-disable-next-line react-hooks/exhaustive-deps
-  }, [filterStr, sortStr, channelManager]);
+  }, [client, filterStr, sortStr, channelManager]);
 
   return {
     channelListInitialized,

package/src/components/Chat/Chat.tsx

@@ -1,7 +1,7 @@
 import React, { PropsWithChildren, useEffect, useState } from 'react';
 import { Image, Platform } from 'react-native';
 
-import type { Channel, StreamChat } from 'stream-chat';
+import type { Channel } from 'stream-chat';
 
 import { useAppSettings } from './hooks/useAppSettings';
 import { useCreateChatContext } from './hooks/useCreateChatContext';
@@ -27,7 +27,6 @@ import { NativeHandlers } from '../../native';
 import { OfflineDB } from '../../store/OfflineDB';
 import { SqliteClient } from '../../store/SqliteClient';
 
-import { DBSyncManager } from '../../utils/DBSyncManager';
 import type { Streami18n } from '../../utils/i18n/Streami18n';
 import { version } from '../../version.json';
 
@@ -215,18 +214,15 @@ const ChatWithContext = (props: PropsWithChildren<ChatProps>) => {
 
     const initializeDatabase = () => {
       // TODO: Rethink this, it looks ugly
-      console.log('TESTING2', client);
-      const offlineDBInstance = new OfflineDB({ client });
-      console.log(offlineDBInstance);
-      client.setOfflineDBApi(offlineDBInstance);
+      client.setOfflineDBApi(new OfflineDB({ client }));
       // This acts as a lock for some very rare occurrences of concurrency
       // issues we've encountered before with the QuickSqliteClient being
       // uninitialized before it's being invoked.
       setInitialisedDatabaseConfig({ initialised: false, userID });
       SqliteClient.initializeDatabase()
         .then(async () => {
           setInitialisedDatabaseConfig({ initialised: true, userID });
-          await DBSyncManager.init(client as unknown as StreamChat);
+          await client.offlineDb.syncManager.init();
         })
         .catch((error) => {
           console.log('Error Initializing DB:', error);
@@ -254,13 +250,13 @@ const ChatWithContext = (props: PropsWithChildren<ChatProps>) => {
     return () => {
       client.threads.unregisterSubscriptions();
       client.polls.unregisterSubscriptions();
+      // In case something went wrong, make sure to also unsubscribe the listener
+      // on unmount if it exists to prevent a memory leak.
+      // FIXME: Should be wrapped in its own unregistration mechanism
+      client.offlineDb.syncManager?.connectionChangedListener?.unsubscribe();
     };
   }, [client]);
 
-  // In case something went wrong, make sure to also unsubscribe the listener
-  // on unmount if it exists to prevent a memory leak.
-  useEffect(() => () => DBSyncManager.connectionChangedListener?.unsubscribe(), []);
-
   const initialisedDatabase =
     initialisedDatabaseConfig.initialised && userID === initialisedDatabaseConfig.userID;
 

package/src/store/OfflineDB.ts

@@ -1,6 +1,8 @@
-import { AbstractOfflineDB, GetChannelsForQueryType, GetChannelsType } from 'stream-chat';
+import { AbstractOfflineDB, GetLastSyncedAtType, UpsertUserSyncStatusType } from 'stream-chat';
+import type { GetChannelsForQueryType, GetChannelsType } from 'stream-chat';
 
 import * as api from './apis';
+import { SqliteClient } from './SqliteClient';
 
 export class OfflineDB extends AbstractOfflineDB {
   upsertCidsForQuery = api.upsertCidsForQuery;
@@ -11,4 +13,22 @@ export class OfflineDB extends AbstractOfflineDB {
   // FIXME
   getChannelsForQuery = ({ userId, filters, sort }: GetChannelsForQueryType) =>
     api.getChannelsForFilterSort({ currentUserId: userId, filters, sort });
+
+  getAllChannelCids = api.getAllChannelIds;
+  // FIXME
+  getLastSyncedAt = ({ userId }: GetLastSyncedAtType) =>
+    api.getLastSyncedAt({ currentUserId: userId });
+  // FIXME
+  upsertUserSyncStatus = ({ userId, lastSyncedAt }: UpsertUserSyncStatusType) =>
+    api.upsertUserSyncStatus({ currentUserId: userId, lastSyncedAt });
+
+  addPendingTask = api.addPendingTask;
+
+  deletePendingTask = api.deletePendingTask;
+
+  getPendingTasks = api.getPendingTasks;
+
+  resetDB = SqliteClient.resetDB;
+
+  executeSqlBatch = SqliteClient.executeSqlBatch;
 }

package/src/store/apis/index.ts

@@ -22,3 +22,6 @@ export * from './upsertMembers';
 export * from './upsertMessages';
 export * from './upsertReads';
 export * from './updatePollMessage';
+export * from './addPendingTask';
+export * from './deletePendingTask';
+export * from './getPendingTasks';