refactor: keep hardDelete and deleteForMe options mutually exclusive in client.deleteMessage

Author: MartinCupela

src/client.ts

@@ -3116,16 +3116,18 @@ export class StreamChat {
     messageID: string,
     optionsOrHardDelete?: DeleteMessageOptions | boolean,
   ): Promise<APIResponse & { message: MessageResponse }> {
-    const { hardDelete } = (
-      typeof optionsOrHardDelete === 'boolean'
-        ? { hardDelete: optionsOrHardDelete }
-        : (optionsOrHardDelete ?? {})
-    ) as DeleteMessageOptions;
+    let options: DeleteMessageOptions = {};
+    if (typeof optionsOrHardDelete === 'boolean') {
+      options = optionsOrHardDelete ? { hardDelete: true } : {};
+    } else if (optionsOrHardDelete?.deleteForMe) {
+      options = { deleteForMe: true };
+    } else if (optionsOrHardDelete?.hardDelete) {
+      options = { hardDelete: true };
+    }
 
     try {
       if (this.offlineDb) {
-        // todo: write code for this.offlineDb.deleteForMe
-        if (hardDelete) {
+        if (options.hardDelete) {
           await this.offlineDb.hardDeleteMessage({ id: messageID });
         } else {
           await this.offlineDb.softDeleteMessage({ id: messageID });
@@ -3134,7 +3136,7 @@ export class StreamChat {
           {
             task: {
               messageId: messageID,
-              payload: [messageID, optionsOrHardDelete],
+              payload: [messageID, options],
               type: 'delete-message',
             },
           },
@@ -3147,14 +3149,16 @@ export class StreamChat {
       });
     }
 
-    return this._deleteMessage(messageID, optionsOrHardDelete);
+    return this._deleteMessage(messageID, options);
   }
 
   // fixme: remove the signature with optionsOrHardDelete boolean with the next major release
   async _deleteMessage(
     messageID: string,
     optionsOrHardDelete?: DeleteMessageOptions | boolean,
   ): Promise<APIResponse & { message: MessageResponse }> {
+    // this is a API call method, we do not route hardDelete: true and deleteForMe: true to deleteForMe: true
+    // and expect to receive error response from the server
     const { deleteForMe, hardDelete } = (
       typeof optionsOrHardDelete === 'boolean'
         ? { hardDelete: optionsOrHardDelete }

test/unit/client.test.js

@@ -953,64 +953,37 @@ describe('message deletion', () => {
 			vi.resetAllMocks();
 		});
 
-		it('should soft delete the message and queue task if hardDelete is false', async () => {
-			await client.deleteMessage(messageId, false);
-
-			expect(client.offlineDb.softDeleteMessage).toHaveBeenCalledTimes(1);
-			expect(client.offlineDb.softDeleteMessage).toHaveBeenCalledWith({ id: messageId });
-			expect(client.offlineDb.hardDeleteMessage).not.toHaveBeenCalled();
-			expect(queueTaskSpy).toHaveBeenCalledTimes(1);
-
-			const taskArg = queueTaskSpy.mock.calls[0][0];
-			expect(taskArg).to.deep.equal({
-				task: {
-					messageId,
-					payload: [messageId, false],
-					type: 'delete-message',
-				},
-			});
-			expect(_deleteMessageSpy).not.toHaveBeenCalled();
-		});
-
-		it('should hard delete the message and queue task if hardDelete is true', async () => {
-			await client.deleteMessage(messageId, true);
-
-			expect(client.offlineDb.hardDeleteMessage).toHaveBeenCalledTimes(1);
-			expect(client.offlineDb.hardDeleteMessage).toHaveBeenCalledWith({ id: messageId });
-			expect(client.offlineDb.softDeleteMessage).not.toHaveBeenCalled();
-			expect(queueTaskSpy).toHaveBeenCalledTimes(1);
-
-			const taskArg = queueTaskSpy.mock.calls[0][0];
-			expect(taskArg).to.deep.equal({
-				task: {
-					messageId,
-					payload: [messageId, true],
-					type: 'delete-message',
-				},
-			});
-			expect(_deleteMessageSpy).not.toHaveBeenCalled();
-		});
-
 		it.each([
+			['undefined', undefined, {}],
+			['true', true, { hardDelete: true }],
+			['false', false, {}],
+			['{ hardDelete: false }', { hardDelete: false }, {}],
+			['{ hardDelete: true }', { hardDelete: true }, { hardDelete: true }],
+			['{ deleteForMe: true }', { deleteForMe: true }, { deleteForMe: true }],
+			['{ deleteForMe: false }', { deleteForMe: false }, {}],
 			[
 				'{ hardDelete: false, deleteForMe: true }',
 				{ hardDelete: false, deleteForMe: true },
+				{ deleteForMe: true },
 			],
 			[
 				'{ hardDelete: true, deleteForMe: true }',
 				{ hardDelete: true, deleteForMe: true },
+				{ deleteForMe: true },
 			],
 			[
 				'{ hardDelete: false, deleteForMe: false }',
 				{ hardDelete: false, deleteForMe: false },
+				{},
 			],
 			[
-				'{ hardDelete: false, deleteForMe: false }',
-				{ hardDelete: false, deleteForMe: false },
+				'{ hardDelete: true, deleteForMe: false }',
+				{ hardDelete: true, deleteForMe: false },
+				{ hardDelete: true },
 			],
-		])('should parse delete message options %s', async (_, options) => {
+		])('should parse delete message options %s', async (_, options, expectedOptions) => {
 			await client.deleteMessage(messageId, options);
-			if (options.hardDelete) {
+			if (expectedOptions.hardDelete) {
 				expect(client.offlineDb.hardDeleteMessage).toHaveBeenCalledTimes(1);
 				expect(client.offlineDb.hardDeleteMessage).toHaveBeenCalledWith({
 					id: messageId,
@@ -1030,48 +1003,50 @@ describe('message deletion', () => {
 			expect(taskArg).to.deep.equal({
 				task: {
 					messageId,
-					payload: [messageId, options],
+					payload: [messageId, expectedOptions],
 					type: 'delete-message',
 				},
 			});
 			expect(_deleteMessageSpy).not.toHaveBeenCalled();
 		});
 
-		it('should fall back to _deleteMessage if offlineDb is not set', async () => {
-			client.offlineDb = undefined;
-
-			await client.deleteMessage(messageId, true);
-
-			expect(_deleteMessageSpy).toHaveBeenCalledTimes(1);
-			expect(_deleteMessageSpy).toHaveBeenCalledWith(messageId, true);
-		});
-
 		it.each([
+			['undefined', undefined, {}],
+			['true', true, { hardDelete: true }],
+			['false', false, {}],
+			['{ hardDelete: false }', { hardDelete: false }, {}],
+			['{ hardDelete: true }', { hardDelete: true }, { hardDelete: true }],
+			['{ deleteForMe: true }', { deleteForMe: true }, { deleteForMe: true }],
+			['{ deleteForMe: false }', { deleteForMe: false }, {}],
 			[
 				'{ hardDelete: false, deleteForMe: true }',
 				{ hardDelete: false, deleteForMe: true },
+				{ deleteForMe: true },
 			],
 			[
 				'{ hardDelete: true, deleteForMe: true }',
 				{ hardDelete: true, deleteForMe: true },
+				{ deleteForMe: true },
 			],
 			[
 				'{ hardDelete: false, deleteForMe: false }',
 				{ hardDelete: false, deleteForMe: false },
+				{},
 			],
 			[
-				'{ hardDelete: false, deleteForMe: false }',
-				{ hardDelete: false, deleteForMe: false },
+				'{ hardDelete: true, deleteForMe: false }',
+				{ hardDelete: true, deleteForMe: false },
+				{ hardDelete: true },
 			],
 		])(
-			'should fall back to _deleteMessage if offlineDb is not set and delete options object is provided as %s',
-			async (_, options) => {
+			'should fall back to _deleteMessage if offlineDb is not set and delete options is %s',
+			async (_, options, expectedOptions) => {
 				client.offlineDb = undefined;
 
 				await client.deleteMessage(messageId, options);
 
 				expect(_deleteMessageSpy).toHaveBeenCalledTimes(1);
-				expect(_deleteMessageSpy).toHaveBeenCalledWith(messageId, options);
+				expect(_deleteMessageSpy).toHaveBeenCalledWith(messageId, expectedOptions);
 			},
 		);