bug: channel list not updated after pinning a channel

[michalvankodev]

Describe the bug

After pinning a channel the channel list is not re-sorted and it doesn't show newly pinned channel within the group of other pinned channels.

To Reproduce

Steps to reproduce the behavior:

1. Query channels with sort:

  const sort: ChannelSort = {
    pinned_at: -1,
    last_updated_at: -1,
    last_message_at: -1,
  };

2. Pin channel that is not yet pinned from the bottom of the queried channels
3. Pinned channel's state is updated but the channel list is not updated according to the sorting.

Expected behavior

Channel list should be sorted according to the sort rules passed and should be updated when channel is updated

Screenshots

Best friends group is pinned but it was not attached to the group of pinned channels

Package version

• stream-chat-react: 12.8.1

If I should apply sorting manually is there a way how to just force update?

[arnautov-anton]

Hey, @michalvankodev, thank you for submitting this issue.

The problem is in the sort object - when pulling data from database you sort by keys, the order of the keys is important. That being said - our SDK allows passing sort as an object - it's meant to be used with single key only. This object gets re-constructed client-level to an array before being sent to the BE for further processing. To ensure the proper order of the keys is delivered to the BE for processing we recommend passing an array to the sort property of the ChannelList, only in this shape the runtime re-sorting of the channels (with consideration to pinned channels) is enabled:

const sort: ChannelSort = [
    { pinned_at: -1 },
    { last_updated_at: -1 },
    { last_message_at: -1 },
 ];

[michalvankodev]

Thanks @arnautov-anton. This has resolved the issue. It would be worth mentioning this in the documentation instead of the examples provided.

[arnautov-anton]

Definitely, it's on our list to add this limitation to the documentation. I'll also explore an option to allow such objects to be considered as well as it seems that for...in accesses object properties chronologically as they were created - we can check if the key appears to be first and enable the expected behavior in such case as well as we can reliably tell that the array to be sent to the BE will be constructed deterministically.