Using stream_chat_persistence causes "Error loading channels"

[Jonny1987]

Which packages are you using?

stream_chat_flutter

On what platforms did you experience the issue?

Android

What version are you using?

9.7.0

What happened?

The channel list shows the following error:

Steps to reproduce

1. Add the stream_chat_persistence plugin with version 9.7.0 (I also see this issue with 9.0.0 for both stream_chat_persistence and stream_chat_flutter)
2. Set up the persistence plugin as follows:

final streamChatClient = StreamChatClient(
  Env.STREAM_CHAT_API_KEY,
)..chatPersistenceClient = StreamChatPersistenceClient();

3. Navigate to the channel list in the app and see the error

Supporting info to reproduce

No response

Relevant log output

Flutter analyze output

No issues found!

Flutter doctor output

[✓] Flutter (Channel stable, 3.27.4, on Ubuntu 22.04.5 LTS 6.8.0-52-generic, locale en_US.UTF-8)
    • Flutter version 3.27.4 on channel stable at /home/john/fvm/versions/3.27.4
    • Upstream repository https://github.com/flutter/flutter.git
    • Framework revision d8a9f9a52e (9 weeks ago), 2025-01-31 16:07:18 -0500
    • Engine revision 82bd5b7209
    • Dart version 3.6.2
    • DevTools version 2.40.3

[✓] Android toolchain - develop for Android devices (Android SDK version 35.0.0-rc4)
    • Android SDK at /home/john/Android/Sdk
    • Platform android-35, build-tools 35.0.0-rc4
    • Java binary at: /opt/android-studio/jbr/bin/java
    • Java version OpenJDK Runtime Environment (build 17.0.10+0-17.0.10b1087.21-11609105)
    • All Android licenses accepted.

[✓] Chrome - develop for the web
    • Chrome at google-chrome

[✓] Linux toolchain - develop for Linux desktop
    • Ubuntu clang version 14.0.0-1ubuntu1.1
    • cmake version 3.22.1
    • ninja version 1.10.1
    • pkg-config version 0.29.2

[✓] Android Studio (version 2024.1)
    • Android Studio at /opt/android-studio
    • Flutter plugin version 83.0.2
    • Dart plugin can be installed from:
      🔨 https://plugins.jetbrains.com/plugin/6351-dart
    • Java version OpenJDK Runtime Environment (build 17.0.10+0-17.0.10b1087.21-11609105)

[✓] VS Code (version 1.96.2)
    • VS Code at /usr/share/code
    • Flutter extension version 3.102.0

[✓] Connected device (3 available)
    • sdk gphone64 x86 64 (mobile) • emulator-5554 • android-x64    • Android 15 (API 35) (emulator)
    • Linux (desktop)              • linux         • linux-x64      • Ubuntu 22.04.5 LTS 6.8.0-52-generic
    • Chrome (web)                 • chrome        • web-javascript • Google Chrome 134.0.6998.35

[✓] Network resources
    • All expected network resources are available.

• No issues found!

Code of Conduct

• I agree to follow this project's Code of Conduct

[xsahil03x]

Hey @Jonny1987 , can you replicate this on our sample app and let me know? Thanks

[Jonny1987]

The issue was that SortOption in the list given to StreamChannelListController.channelStateSort need to also have the comparator parameter set when using persistence. There were no errors in the logs saying this so I needed to print the error from the StreamChannelListView code (which I think should be another issue too since the "Error loading channels" in the UI was the only information about the error). It might be worth having a note about this in the docs on the persistence package.

It seems strange that the comparator is needed since it's basically duplicating the information already in the SortOption (the field and the direction).

[xsahil03x]

Yes, initially we didn't had a way to map the field to the actual properties but we are improving the sort operations. You can track this PR for details.