Skip to content

Fix event returned IStreamChannel not triggering events due to not being watched #149

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
sierpinskid merged 1 commit into from
Jun 13, 2024
Merged

Fix event returned IStreamChannel not triggering events due to not being watched #149

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions Assets/Plugins/StreamChat/Core/State/Caches/ICacheExt.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,14 @@ public static StreamChannel TryCreateOrUpdate(this ICache cache, ChannelResponse
=> dto == null
? null
: cache.Channels.CreateOrUpdate<StreamChannel, ChannelResponseInternalDTO>(dto, out _);

public static StreamChannel TryCreateOrUpdate(this ICache cache, ChannelResponseInternalDTO dto, out bool wasCreated)
{
wasCreated = false;
return dto == null
? null
: cache.Channels.CreateOrUpdate<StreamChannel, ChannelResponseInternalDTO>(dto, out wasCreated);
}

public static StreamChannel TryCreateOrUpdate(this ICache cache, ChannelStateResponseFieldsInternalDTO dto)
=> dto == null
Expand Down
110 changes: 100 additions & 10 deletions Assets/Plugins/StreamChat/Core/StreamChatClient.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -864,45 +864,135 @@ private void OnMarkReadNotification(NotificationMarkReadEventInternalDTO eventDt

private void OnAddedToChannelNotification(NotificationAddedToChannelEventInternalDTO eventDto)
{
var channel = _cache.TryCreateOrUpdate(eventDto.Channel);
var channel = _cache.TryCreateOrUpdate(eventDto.Channel, out var wasCreated);
var member = _cache.TryCreateOrUpdate(eventDto.Member);
_cache.TryCreateOrUpdate(eventDto.Member.User);

if (!wasCreated)
{
AddedToChannelAsMember?.Invoke(channel, member);
return;
}

AddedToChannelAsMember?.Invoke(channel, member);
// Watch channel, otherwise WS events won't be received
GetOrCreateChannelWithIdAsync(channel.Type, channel.Id).ContinueWith(t =>
{
if (t.IsFaulted)
{
_logs.Error($"Failed to watch channel with type: {channel.Type} & id: {channel.Id} " +
$"before triggering the {nameof(AddedToChannelAsMember)} event. Inspect the following exception.");
_logs.Exception(t.Exception);
return;
}

AddedToChannelAsMember?.Invoke(channel, member);
});
}

private void OnRemovedFromChannelNotification(
NotificationRemovedFromChannelEventInternalDTO eventDto)
{
var channel = _cache.TryCreateOrUpdate(eventDto.Channel);
var channel = _cache.TryCreateOrUpdate(eventDto.Channel, out var wasCreated);
var member = _cache.TryCreateOrUpdate(eventDto.Member);
_cache.TryCreateOrUpdate(eventDto.Member.User);

RemovedFromChannelAsMember?.Invoke(channel, member);
if (!wasCreated)
{
RemovedFromChannelAsMember?.Invoke(channel, member);
return;
}

// Watch channel, otherwise WS events won't be received
GetOrCreateChannelWithIdAsync(channel.Type, channel.Id).ContinueWith(t =>
{
if (t.IsFaulted)
{
_logs.Error($"Failed to watch channel with type: {channel.Type} & id: {channel.Id} " +
$"before triggering the {nameof(RemovedFromChannelAsMember)} event. Inspect the following exception.");
_logs.Exception(t.Exception);
return;
}

RemovedFromChannelAsMember?.Invoke(channel, member);
});
}

private void OnInvitedNotification(NotificationInvitedEventInternalDTO eventDto)
{
var channel = _cache.TryCreateOrUpdate(eventDto.Channel);
var channel = _cache.TryCreateOrUpdate(eventDto.Channel, out var wasCreated);
var user = _cache.TryCreateOrUpdate(eventDto.User);

if (!wasCreated)
{
ChannelInviteReceived?.Invoke(channel, user);
return;
}

// Watch channel, otherwise WS events won't be received
GetOrCreateChannelWithIdAsync(channel.Type, channel.Id).ContinueWith(t =>
{
if (t.IsFaulted)
{
_logs.Error($"Failed to watch channel with type: {channel.Type} & id: {channel.Id} " +
$"before triggering the {nameof(ChannelInviteReceived)} event. Inspect the following exception.");
_logs.Exception(t.Exception);
return;
}

ChannelInviteReceived?.Invoke(channel, user);
ChannelInviteReceived?.Invoke(channel, user);
});
}

private void OnInviteAcceptedNotification(NotificationInviteAcceptedEventInternalDTO eventDto)
{
var channel = _cache.TryCreateOrUpdate(eventDto.Channel);
var channel = _cache.TryCreateOrUpdate(eventDto.Channel, out var wasCreated);
var user = _cache.TryCreateOrUpdate(eventDto.User);

if (!wasCreated)
{
ChannelInviteAccepted?.Invoke(channel, user);
return;
}

// Watch channel, otherwise WS events won't be received
GetOrCreateChannelWithIdAsync(channel.Type, channel.Id).ContinueWith(t =>
{
if (t.IsFaulted)
{
_logs.Error($"Failed to watch channel with type: {channel.Type} & id: {channel.Id} " +
$"before triggering the {nameof(ChannelInviteAccepted)} event. Inspect the following exception.");
_logs.Exception(t.Exception);
return;
}

ChannelInviteAccepted?.Invoke(channel, user);
ChannelInviteAccepted?.Invoke(channel, user);
});
}

private void OnInviteRejectedNotification(NotificationInviteRejectedEventInternalDTO eventDto)
{
var channel = _cache.TryCreateOrUpdate(eventDto.Channel);
var channel = _cache.TryCreateOrUpdate(eventDto.Channel, out var wasCreated);
var user = _cache.TryCreateOrUpdate(eventDto.User);

if (!wasCreated)
{
ChannelInviteRejected?.Invoke(channel, user);
return;
}

// Watch channel, otherwise WS events won't be received
GetOrCreateChannelWithIdAsync(channel.Type, channel.Id).ContinueWith(t =>
{
if (t.IsFaulted)
{
_logs.Error($"Failed to watch channel with type: {channel.Type} & id: {channel.Id} " +
$"before triggering the {nameof(ChannelInviteRejected)} event. Inspect the following exception.");
_logs.Exception(t.Exception);
return;
}

ChannelInviteRejected?.Invoke(channel, user);
ChannelInviteRejected?.Invoke(channel, user);
});
}

private void OnReactionReceived(ReactionNewEventInternalDTO eventDto)
Expand Down
7 changes: 4 additions & 3 deletions Assets/Plugins/StreamChat/Tests/StatefulClient/BaseStateIntegrationTests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,11 +49,12 @@ protected static IEnumerable<AuthCredentials> OtherAdminUsersCredentials
/// <summary>
/// Create temp channel with random id that will be removed in [TearDown]
/// </summary>
protected async Task<IStreamChannel> CreateUniqueTempChannelAsync(string name = null, bool watch = true)
protected async Task<IStreamChannel> CreateUniqueTempChannelAsync(string name = null, bool watch = true, StreamChatClient overrideClient = null)
{
var channelId = "random-channel-11111-" + Guid.NewGuid();
var client = overrideClient ?? Client;

var channelState = await Client.InternalGetOrCreateChannelWithIdAsync(ChannelType.Messaging, channelId, name, watch: watch);
var channelState = await client.InternalGetOrCreateChannelWithIdAsync(ChannelType.Messaging, channelId, name, watch: watch);
_tempChannels.Add(channelState);
return channelState;
}
Expand Down Expand Up @@ -89,7 +90,7 @@ protected static IEnumerator ConnectAndExecute(Func<Task> test)
yield return ConnectAndExecuteAsync(test).RunAsIEnumerator(statefulClient: Client);
}

protected Task<IStreamChatClient> GetConnectedOtherClient()
protected Task<StreamChatClient> GetConnectedOtherClient()
=> StreamTestClients.Instance.ConnectOtherStateClientAsync();

//StreamTodo: figure out syntax to wrap call in using that will subscribe to observing an event if possible
Expand Down
48 changes: 48 additions & 0 deletions Assets/Plugins/StreamChat/Tests/StatefulClient/ChannelMembersTests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -335,6 +335,53 @@ private async Task When_user_added_to_not_watched_channel_expect_user_receive_ad
Assert.AreEqual(channel, eventChannel);
Assert.AreEqual(Client.LocalUserData.User, eventMember.User);
}

[UnityTest]
public IEnumerator When_user_added_to_not_watched_channel_expect_received_channel_being_watched()
=> ConnectAndExecute(
When_user_added_to_not_watched_channel_expect_received_channel_being_watched_Async);

private async Task When_user_added_to_not_watched_channel_expect_received_channel_being_watched_Async()
{
var otherClient = await GetConnectedOtherClient();
var otherClientChannel = await CreateUniqueTempChannelAsync(watch: false, overrideClient: otherClient);

var receivedEvent = false;
IStreamChannelMember eventMember = null;
IStreamChannel eventChannel = null;
Client.AddedToChannelAsMember += (channel2, member) =>
{
receivedEvent = true;
eventMember = member;
eventChannel = channel2;
};

await otherClientChannel.AddMembersAsync(hideHistory: default, optionalMessage: default, Client.LocalUserData.User);
await WaitWhileFalseAsync(() => receivedEvent);

Assert.IsTrue(receivedEvent);
Assert.IsNotNull(eventChannel);
Assert.IsNotNull(eventMember);
Assert.AreEqual(otherClientChannel.Cid, eventChannel.Cid);
Assert.AreEqual(Client.LocalUserData.User, eventMember.User);

var receivedMessageEvent = false;
var receivedMessage = string.Empty;
IStreamChannel receivedMessageChannel = null;
otherClientChannel.MessageReceived += (messageChannel, message) =>
{
receivedMessageEvent = true;
receivedMessage = message.Text;
receivedMessageChannel = messageChannel;
};

await otherClientChannel.SendNewMessageAsync("Hello");
await WaitWhileFalseAsync(() => receivedEvent);

Assert.IsTrue(receivedMessageEvent);
Assert.AreEqual(otherClientChannel.Cid, receivedMessageChannel.Cid);
Assert.AreEqual(receivedMessage, "Hello");
}

[UnityTest]
public IEnumerator When_user_removed_from_not_watched_channel_expect_user_removed_from_channel_event()
Expand Down Expand Up @@ -371,6 +418,7 @@ private async Task When_user_removed_from_not_watched_channel_expect_user_remove
Assert.AreEqual(channel, eventChannel);
Assert.AreEqual(Client.LocalUserData.User, eventMember.User);
}

}
}
#endif
5 changes: 3 additions & 2 deletions Assets/Plugins/StreamChat/Tests/StreamTestClients.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -96,7 +96,7 @@ public IEnumerator ReconnectLowLevelClientClient()

public Task ConnectStateClientAsync() => ConnectStateClientAsync(StateClient, _stateClientCredentials);

public Task<IStreamChatClient> ConnectOtherStateClientAsync()
public Task<StreamChatClient> ConnectOtherStateClientAsync()
=> ConnectStateClientAsync(OtherStateClient, _otherUserCredentials);

private static StreamTestClients _instance;
Expand Down Expand Up @@ -132,7 +132,7 @@ private StreamTestClients()
_otherUsersCredentials = adminData.Skip(3).ToList();
}

private static async Task<IStreamChatClient> ConnectStateClientAsync(IStreamChatClient client,
private static async Task<StreamChatClient> ConnectStateClientAsync(StreamChatClient client,
AuthCredentials credentials)
{
if (client.IsConnected)
Expand All @@ -151,6 +151,7 @@ private static async Task<IStreamChatClient> ConnectStateClientAsync(IStreamChat
Debug.Log($"Wait for {nameof(StatefulClient)} to connect user with ID: {credentials.UserId}");
#endif

client.LowLevelClient.Update(0.1f);
await Task.Delay(1);

if (timer.ElapsedMilliseconds > timeout)
Expand Down