Dismiss thread when hard deleting root message

[nuno-vieira]

🔗 Issue Links

Resolves https://linear.app/stream/issue/IOS-282/hard-delete-on-a-root-message-from-a-thread-is-broken

🎯 Goal

Fix the Thread not dismissing when the root message is hard deleted.

🛠 Implementation

I've decided to implement this on the Demo App since hard deleting is an action that only exists on the Demo App. Usually, we do not advertise the feature much since it is not recommended.

Besides that, the logic will most likely differ depending on the app. So this is mostly app logic and not SDK logic.

Either way, while doing this, I spotted some bugs:

• The ChatThreadVC.didReceiveEvent delegate was always being called twice. This was due to the fact that we had channelEventsController and eventsController assigning both delegates to the ChatThreadVC
• The MessageDeletedEvent was not being surfaced to the didReceiveEvent delegate. This only happened for the hard deleted message, and the reason is that this event requires a message: ChatMessage property. But, since the mesasge is hard deleted, it also does not exist in CoreData, so we can't provide the whole message, only the ID. For this reason, I created a new event MessageHardDeletedEvent and deprecated the MessageDeletedEvent.isHardDeleted property. This was the only option to avoid breaking changes.

UPDATE: In order to avoid creating a new MessageHardDeletedEvent, and diverge from the other SDKs, we decided to map the message payload directly to the model so that the MessageDeletedEvent.message is present.

🧪 Manual Testing Notes

Dismissing Thread

1. Create / Open a Thread
2. Hard delete the root message inside a thread
3. Should dismiss the view

Hard Deleting Thread from Channel

1. Create a Thread
2. Send a reply also in channel
3. Go back to the Channel
4. Hard delete the root thread
5. Should delete the thread and replies also in channel

☑️ Contributor Checklist

• I have signed the Stream CLA (required)
• This change should be manually QAed
• Changelog is updated with client-facing changes
• Changelog is updated with new localization keys
• New code is covered by unit tests
• Documentation has been updated in the docs-content repo

[Stream-SDK-Bot]

SDK Size

title	develop	branch	diff	status
StreamChat	7.02 MB	7.05 MB	+32 KB	🟢
StreamChatUI	4.77 MB	4.77 MB	0 KB	🟢

[Stream-SDK-Bot]

SDK Performance

target	metric	benchmark	branch	performance	status
MessageList	Hitches total duration	10 ms	3.34 ms	66.6% 🔼	🟢
	Duration	2.6 s	2.55 s	1.92% 🔼	🟢
	Hitch time ratio	4 ms per s	1.32 ms per s	67.0% 🔼	🟢
	Frame rate	75 fps	78.48 fps	4.64% 🔼	🟢
	Number of hitches	1	0.4	60.0% 🔼	🟢

[Stream-SDK-Bot]

SDK Size

title	develop	branch	diff	status
StreamChat	7.02 MB	7.02 MB	0 KB	🟢
StreamChatUI	4.77 MB	4.77 MB	0 KB	🟢

[martinmitrevski]

why do we deprecate it in this PR?

[nuno-vieira]

The ChatThreadVC.didReceiveEvent delegate was always being called twice. This was due to the fact that we had channelEventsController and eventsController assigning both delegates to the ChatThreadVC

Its in the PR description. Since it is not used anymore, it is deprecated. The delegate of this controller was conflicting with the eventsController

[sonarqubecloud]

Quality Gate passed

Issues
177 New issues
0 Accepted issues

Measures
0 Security Hotspots
84.2% Coverage on New Code
0.1% Duplication on New Code

See analysis details on SonarQube Cloud