Add SendMessageInterceptor to intercept send message request

[nuno-vieira]

🔗 Issue Links

IOS-857

🎯 Goal

Add a way to intercept our send message request

📝 Summary

• Add SendMessageInterceptor
• Add SendMessageInterceptorFactory
• Add ChatMessage.changing()
• Improve documentation of ChatMessage.replacing()

🛠 Implementation

SendMessageInterceptor

A new protocol has been introduced, SendMessageInterceptor. This will only be used if the customer provides an interceptor. If no interceptor is provided, nothing is changed.

The SendMessageInterceptor is not exposed directly in the ChatClientConfig. Instead, it can be injected through a SendMessageInterceptorFactory. The factory gives us more flexibility, especially to make it possible to inject the ChatClient, which can be useful in case a customer wants to use the interceptor but still wants to use our internal APIClient to make the request. I created an example on how, in the future, we can provide this to customers here. For now, I reverted it, but if any customer needs to use our APIClient, it will be easy to provide it. It can be useful for customers who might want to intercept our message requests, but only for a certain type of messages, or simply want to override some data.

ChatMessage.changing() vs ChatMessage.replacing()

I added documentation to ChatMessage.replacing() since it was lacking, and it could be misleading on how to use it. The replacing() function is useful when overriding data, especially if the customer wants to delete some of it. For example, providing the state with nil will make the message state as published. Since this behaviour might not be what some customers need, a changing() function has been introduced for the case where customers just want to change some data, but the rest should be left unchanged (It is different from replacing() because in this case it is not possible to erase data, since nil will fallback to the original data).

🧪 Manual Testing Notes

N/A. Covered by unit tests.

☑️ 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.2 MB	7.2 MB	+1 KB	🟢
StreamChatUI	4.72 MB	4.72 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.31 ms per s	67.25% 🔼	🟢
	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.2 MB	7.2 MB	+1 KB	🟢
StreamChatUI	4.72 MB	4.72 MB	0 KB	🟢

[github-actions]

	1 Warning
⚠️	Big PR

Generated by 🚫 Danger

[sonarqubecloud]

Quality Gate passed

Issues
4 New issues
0 Accepted issues

Measures
0 Security Hotspots
99.2% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud