Bug: Cannot get unread count per channel

[MaxAst]

I have a list where each list item component has the following useEffect:

useEffect(() => {
    const channel = chatClient.channel("messaging", id);
    setUnread(channel.countUnread())
    const listener = channel.on((event) => {
      if (event.type === "notification.message_new" && event.unread_count) {
        setUnreads(event.unread_count);
      }
    });
    return () => {
      listener.unsubscribe();
    };
}, [id]);

When another channel member sends a message into the given channel, channel.countUnread() returns 0 and the event listener contains the user's total unreads on both fields, total_unread_count and unread_count. I would have expected the latter to be the unread count for only the given channel. So I guess two things are broken:

1. channel.countUnread() always returns 0 when the list item component mounts, even when the total_unread_count and unread_count are greater than 0 (I also verified that it can't be 0 by logging this at the beginning of the useEffect body: console.log(JSON.stringify(chatClient.user, null, 2));, which returned total_unread_count and unread_count greater than 0)
2. total_unread_count and unread_count both return the unread count across all channels instead of unread_count only returning the unread of the given channel

[MaxAst]

FWIW, I managed to get the unread count per channel by doing this:

useEffect(() => {
    const channel = chatClient.channel("messaging", data.channelId);
    channel
      .watch()
      .then((state) => {
        const me = state.read?.find((r) => r.user.id === chatClient.user?.id);
        if (typeof me?.unread_messages === "number") {
          setUnreads(me?.unread_messages);
        }
      })
    const listener = channel.on((event) => {
      if (event.type === "notification.message_new" && event.unread_count) {
        setUnreads(event.unread_count);
      }
    });
    return () => {
      listener.unsubscribe();
    };
  }, [data.channelId]);

it works, but feels like a workaround rather than a feature. I'd prefer not having to watch the channel

[sterlingwes]

I logged a similar issue recently if maintainers see this #1103

(Thank you for sharing your workaround)

[sterlingwes]

@MaxAst do you mind sharing your stream-chat version number? I've tried your code above and const me = state.read is always undefined for me, not sure how you're getting the initial count

[MaxAst]

"stream-chat": "^8.4.1" with "stream-chat-expo": "^5.11.2"

I'm a bit worried as to why there hasn't been a reaction by the maintainers yet.. considering it's a core feature of a paid product 🤷

[santhoshvai]

@MaxAst We found a bug in the RN SDK relevant to the unread count state. Could you please upgrade your Expo SDK to v5.12.0 and check if it has fixed the issue

[MaxAst]

@santhoshvai channel.countRead() works for me now, but now streamClient.user.total_unread_count, streamClient.user.total_unread_count, and streamClient.user.unread_channels are all 0, while channel.countRead() returns the correct value

[vanGalilea]

Closing this in favour of #1119