Fix duplicated watching channel calls when reconnecting

[nuno-vieira]

🔗 Issue Links

Resolves https://github.com/GetStream/ios-issues-tracking/issues/800

🎯 Goal

Fix having duplicated watching channel calls after reconnection logic.

Context: Whenever we reconnect, if the user is watching channels, we track these channels and re-watch them.

📝 Summary

This was because we were incorrectly adding a channel controller to activeChannelControllers whenever we created a controller. This is wrong; we should only add it when we call synchronize or start watching a channel. Only in this scenario do we need to track a channel.

Besides this, we did not control whether we already had a channel in the activeChannelControllers. So, there were cases where we had duplicated active channel controllers, and whenever a reconnection happened, it would trigger duplicated watch calls.

Lastly, even if a channel is open, if the customer stops watching the channel, it should not be in the activeChannelControllers. This was also missing.

🧪 Manual Testing Notes

1- Open Proxyman
2- Open Demo App Configuration and setup token refresh with 15s
3- Open the Channel List
4- Wait for reconnection
5- No channel query call should be made (Do not confuse with channel list call)
6- Open and close a few channels
7- 4. and 5.
8- Open a channel, and remain open
9- When reconnecting the a watch call should be made for the open channel

☑️ Contributor Checklist

• I have signed the Stream CLA (required)
• This change follows zero ⚠️ policy (required)
• This change should be manually QAed
• Changelog is updated with client-facing changes
• New code is covered by unit tests
• Comparison screenshots added for visual changes
• Affected documentation updated (docusaurus, tutorial, CMS)

[Stream-iOS-Bot]

StreamChat XCMetrics

target	metric	benchmark	branch	performance	status
MessageList	Hitches total duration	10 ms	10.01 ms	-0.1% 🔽	🟡
	Duration	2.6 s	2.54 s	2.31% 🔼	🟢
	Hitch time ratio	4 ms per s	3.94 ms per s	1.5% 🔼	🟢
	Frame rate	79 fps	78.15 fps	1.08% 🔼	🟢
	Number of hitches	1	1.2	-20.0% 🔽	🔴
ChannelList	Hitches total duration	12.5 ms	18.36 ms	-46.88% 🔽	🔴
	Duration	2.6 s	2.54 s	2.31% 🔼	🟢
	Hitch time ratio	5 ms per s	7.23 ms per s	-44.6% 🔽	🔴
	Frame rate	76 fps	73.99 fps	2.64% 🔼	🟢
	Number of hitches	1.2	1.6	-33.33% 🔽	🔴

[martinmitrevski]

Great find 👌

[laevandus]

I manually verified