feat: add hard and soft deletes in the db

Author: isekovanic

package/src/components/Channel/Channel.tsx

@@ -1450,6 +1450,7 @@ const ChannelWithContext = (props: PropsWithChildren<ChannelPropsWithContext>) =
    */
   const removeMessage: MessagesContextValue['removeMessage'] = async (message) => {
     if (channel) {
+      // TODO: See if it's easy to refactor this to be able to accept DB queries
       channel.state.removeMessage(message);
       copyMessagesStateFromChannel(channel);
 
@@ -1458,10 +1459,14 @@ const ChannelWithContext = (props: PropsWithChildren<ChannelPropsWithContext>) =
       }
     }
 
-    if (enableOfflineSupport) {
-      await dbApi.deleteMessage({
-        id: message.id,
-      });
+    if (client.offlineDb) {
+      // FIXME: Batch these maybe ?.
+      await Promise.all([
+        client.offlineDb.dropPendingTasks({ messageId: message.id }),
+        client.offlineDb.hardDeleteMessage({
+          id: message.id,
+        }),
+      ]);
     }
   };
 
@@ -1497,47 +1502,32 @@ const ChannelWithContext = (props: PropsWithChildren<ChannelPropsWithContext>) =
     }
   };
 
-  const deleteMessage: MessagesContextValue['deleteMessage'] = async (message) => {
+  const deleteMessage: MessagesContextValue['deleteMessage'] = async (
+    message,
+    hardDelete = false,
+  ) => {
     if (!channel.id) {
       throw new Error('Channel has not been initialized yet');
     }
 
-    if (!enableOfflineSupport) {
-      if (message.status === MessageStatusTypes.FAILED) {
-        await removeMessage(message);
-        return;
-      }
-      await client.deleteMessage(message.id);
-      return;
-    }
-
     if (message.status === MessageStatusTypes.FAILED) {
-      await client.offlineDb?.syncManager.dropPendingTasks({ messageId: message.id });
       await removeMessage(message);
-    } else {
-      const updatedMessage = {
-        ...message,
-        cid: channel.cid,
-        deleted_at: new Date().toISOString(),
-        type: 'deleted' as MessageLabel,
-      };
-      updateMessage(updatedMessage);
+      return;
+    }
+    const updatedMessage = {
+      ...message,
+      cid: channel.cid,
+      deleted_at: new Date().toISOString(),
+      type: 'deleted' as MessageLabel,
+    };
+    updateMessage(updatedMessage);
 
-      threadInstance?.upsertReplyLocally({ message: updatedMessage });
+    threadInstance?.upsertReplyLocally({ message: updatedMessage });
 
-      const data = await client.offlineDb?.syncManager.queueTask({
-        task: {
-          channelId: channel.id,
-          channelType: channel.type,
-          messageId: message.id,
-          payload: [message.id],
-          type: 'delete-message',
-        },
-      });
+    const data = await client.deleteMessage(message.id, hardDelete);
 
-      if (data?.message) {
-        updateMessage({ ...data.message });
-      }
+    if (data?.message) {
+      updateMessage({ ...data.message });
     }
   };
 

package/src/contexts/messagesContext/MessagesContext.tsx

@@ -107,7 +107,7 @@ export type MessagesContextValue = Pick<MessageContextValue, 'isMessageAIGenerat
    * Defaults to: [DateHeader](https://github.com/GetStream/stream-chat-react-native/blob/main/package/src/components/MessageList/DateHeader.tsx)
    **/
   DateHeader: React.ComponentType<DateHeaderProps>;
-  deleteMessage: (message: MessageResponse) => Promise<void>;
+  deleteMessage: (message: MessageResponse, hardDelete?: boolean) => Promise<void>;
   deleteReaction: (type: string, messageId: string) => Promise<void>;
 
   /** Should keyboard be dismissed when messaged is touched */

package/src/store/OfflineDB.ts

@@ -3,7 +3,6 @@ import type {
   GetChannelsForQueryType,
   GetChannelsType,
   GetLastSyncedAtType,
-  UpsertReactionType,
   UpsertUserSyncStatusType,
 } from 'stream-chat';
 
@@ -32,17 +31,16 @@ export class OfflineDB extends AbstractOfflineDB {
   upsertUserSyncStatus = ({ userId, lastSyncedAt }: UpsertUserSyncStatusType) =>
     api.upsertUserSyncStatus({ currentUserId: userId, lastSyncedAt });
 
-  /* eslint-disable @typescript-eslint/no-unused-vars */
-  // @ts-expect-error Not yet impelmented
-  upsertReaction = async (options: UpsertReactionType) => {};
-  /* eslint-enable */
-
   addPendingTask = api.addPendingTask;
 
   deletePendingTask = api.deletePendingTask;
 
   deleteReaction = api.deleteReaction;
 
+  hardDeleteMessage = api.deleteMessage;
+
+  softDeleteMessage = api.softDeleteMessage;
+
   getPendingTasks = api.getPendingTasks;
 
   resetDB = SqliteClient.resetDB;

package/src/store/apis/addPendingTask.ts

@@ -1,8 +1,9 @@
+import type { PendingTask } from 'stream-chat';
+
 import { mapTaskToStorable } from '../mappers/mapTaskToStorable';
 import { createDeleteQuery } from '../sqlite-utils/createDeleteQuery';
 import { createUpsertQuery } from '../sqlite-utils/createUpsertQuery';
 import { SqliteClient } from '../SqliteClient';
-import type { PendingTask } from '../types';
 
 /*
  * addPendingTask - Adds a pending task to the database

package/src/store/apis/index.ts

@@ -27,3 +27,4 @@ export * from './updatePollMessage';
 export * from './addPendingTask';
 export * from './deletePendingTask';
 export * from './getPendingTasks';
+export * from './softDeleteMessage';

package/src/store/apis/softDeleteMessage.ts

@@ -0,0 +1,26 @@
+import { MessageLabel } from 'stream-chat';
+
+import { createUpdateQuery } from '../sqlite-utils/createUpdateQuery';
+import { SqliteClient } from '../SqliteClient';
+
+export const softDeleteMessage = async ({ flush = true, id }: { id: string; flush?: boolean }) => {
+  const query = createUpdateQuery(
+    'messages',
+    {
+      deletedAt: new Date().toISOString(),
+      type: 'deleted' as MessageLabel,
+    },
+    { id },
+  );
+
+  SqliteClient.logger?.('info', 'softDeleteMessage', {
+    flush,
+    id,
+  });
+
+  if (flush) {
+    await SqliteClient.executeSql.apply(null, query);
+  }
+
+  return [query];
+};

package/src/store/mappers/mapTaskToStorable.ts

@@ -1,4 +1,4 @@
-import type { PendingTask } from '../types';
+import type { PendingTask } from 'stream-chat';
 
 export const mapTaskToStorable = (task: PendingTask) => ({
   ...task,