Make accessing ChatClientConfig in the Database Layer safer

[nuno-vieira]

🔗 Issue Links

Resolves https://linear.app/stream/issue/IOS-639/

🎯 Goal

Make accessing the ChatClientConfiginternally more thread safer.

🛠 Implementation

Initially, the idea was to pass ChatClientConfig around instead of accessing directly in the NSManagedObjectContext. The problem is that this would cause a massive amount of breaking changes. So the plans changed, and now the whole ChatClientConfig is stored in the NSManagedObjectContext.userInfo, but we make it thread-safe.

🧪 Manual Testing Notes

N/A

☑️ 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.0 MB	7.0 MB	0 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	1.67 ms	83.3% 🔼	🟢
	Duration	2.6 s	2.55 s	1.92% 🔼	🟢
	Hitch time ratio	4 ms per s	0.66 ms per s	83.5% 🔼	🟢
	Frame rate	75 fps	78.22 fps	4.29% 🔼	🟢
	Number of hitches	1	0.2	80.0% 🔼	🟢

[Stream-SDK-Bot]

SDK Size

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

[laevandus]

This does bring slight overhead (it is not huge, just tried sending 20 messages). Thinking if we want to do this since we fixed actual misuses already and this accessor is only used from asModel().

[nuno-vieira]

Hum I see, I'll do a couple more perf tests. But if there is a significant impact, maybe it is better we remove the performAndWait

[nuno-vieira]

After running the benchmarking script on a real device, it looks like there is no significant impact:

For now, lets keep it this way to bulletproof, but if we find any issues with this in the future, we can remove the performAndWait 👍

[nuno-vieira]

Let's re-test this with this branch: #3564

For now we merge it as it

[sonarqubecloud]

Quality Gate passed

Issues
174 New issues
0 Accepted issues

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

See analysis details on SonarQube Cloud

[laevandus]

✅