Let apps override the channel list search filters and sort by andremion · Pull Request #6884 · GetStream/stream-chat-android

andremion · 2026-10-23T14:07:43Z

Goal

Let apps change the filters and sort that ChannelListViewModel uses for channel search and message search. Before, they were fixed in the view model, so apps could not search channels by member name or limit message search to some channels. The other SDKs already allow this.

Implementation

New ChannelListSearchOptions: an open class with channelFilter, channelSort, messageChannelFilter, messageFilter and messageSort. The defaults keep the current behaviour in Standard, Predefined and Grouped modes.
Each function gets a params holder (ChannelSearchParams, MessageSearchParams) with the query, the current user, and the list filter and sort. The list filter and sort are null in Predefined and Grouped modes, because the server owns them.
New ChannelListViewModel and ChannelListViewModelFactory constructors that take searchOptions instead of messageSearchSort.
The constructors that take messageSearchSort are deprecated, with the same signatures as before, so the API change is additive. The deprecated value is only used when messageSort returns null. We can remove it in the next major.
messageChannelFilter can return null to skip the message search.
Compose sample: new "Member name search" login flag that overrides channelFilter to also match member.user.name.

Testing

Manual, in the Compose sample (turn on "Channel search" in the login screen flags):

Search for a member's name, for example "Lando". No channel is found, because the default search matches channel names only.
Turn on "Member name search" too and log in again. Search "Lando" again. The channels with that member are shown.
Search for a channel name. Only the matching channel is shown.

Unit tests: ChannelListSearchOptionsTest covers the defaults. ChannelListViewModelTest checks that custom options are used for channel search in all three modes, for the next pages, and for message search.

E2E: MemberNameSearchTests (2 tests) and a new ChannelSearchTests test. All of them, plus the existing channel and message search tests, passed locally against the mock server.

Validation: ./gradlew spotlessCheck detekt apiCheck testDebugUnitTest passed.

Summary by CodeRabbit

New Features
- Channel search can now match member names as well as channel names. In the sample app, this option can be enabled in the feature settings.
- Compose channel lists now support customizable channel and message search behavior, including filters and sorting.
Tests
- Added coverage for channel and member-name search, search filters and sorting, and message search behavior.

In Standard mode, the channel search added `member.user.name` OR `name` autocomplete to the integrator's filter. It now adds `name` autocomplete AND the current user's membership, the same filter that Predefined and Grouped modes already use. The integrator's filter still applies. Channels can no longer be found by a member's name.

Add ChannelListSearchOptions, an open class passed to the ChannelListViewModel and ChannelListViewModelFactory constructors. Apps can override the channel search filter and sort, and the message search channel filter and message filter. The defaults keep the current behaviour in all query modes. The compose sample gets a member name search flag that overrides the channel filter to also match member names, with e2e tests for it.

andremion · 2026-10-23T14:07:50Z

@CodeRabbit review

github-actions · 2026-10-23T14:07:55Z

PR checklist ✅

All required conditions are satisfied:

Title length is OK (or ignored by label).
At least one pr: label exists.
Sections ### Goal, ### Implementation, and ### Testing are filled, or the PR is bot-authored.
An issue is linked (Linear ticket or GitHub issue), or the PR is bot-authored.

🎉 Great job! This PR is ready for review.

coderabbitai · 2026-10-23T14:07:57Z

✅ Action performed

Review finished.

Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.

coderabbitai · 2026-10-23T14:11:44Z

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info

⚙️ Run configuration

Source mode: Auto
Repository: Unavailable
Branch: Unavailable
File: No configuration file from this repository applied
Commit: Unavailable
Layers: Repository UI
Review profile: CHILL
Plan: Advanced
Run ID: f4931309-b0c4-4a8d-8eb3-c88e07912084

📥 Commits

Reviewing files that changed from the base of the PR and between 4a039c3 and a54d26a.

📒 Files selected for processing: 14

stream-chat-android-compose-sample/src/androidTestE2eDebug/kotlin/io/getstream/chat/android/compose/tests/ChannelSearchTests.kt
stream-chat-android-compose-sample/src/androidTestE2eDebug/kotlin/io/getstream/chat/android/compose/tests/MemberNameSearchTests.kt
stream-chat-android-compose-sample/src/androidTestE2eDebug/kotlin/io/getstream/chat/android/compose/tests/StreamTestCase.kt
stream-chat-android-compose-sample/src/e2e/java/io/getstream/chat/android/compose/sample/ui/StartupActivity.kt
stream-chat-android-compose-sample/src/main/java/io/getstream/chat/android/compose/sample/data/CustomSettings.kt
stream-chat-android-compose-sample/src/main/java/io/getstream/chat/android/compose/sample/feature/channel/list/SampleChannelListViewModelFactory.kt
stream-chat-android-compose-sample/src/main/java/io/getstream/chat/android/compose/sample/ui/login/CustomLoginActivity.kt
stream-chat-android-compose-sample/src/main/res/values/strings.xml
stream-chat-android-compose/api/stream-chat-android-compose.api
stream-chat-android-compose/src/main/java/io/getstream/chat/android/compose/viewmodel/channels/ChannelListSearchOptions.kt
stream-chat-android-compose/src/main/java/io/getstream/chat/android/compose/viewmodel/channels/ChannelListViewModel.kt
stream-chat-android-compose/src/main/java/io/getstream/chat/android/compose/viewmodel/channels/ChannelListViewModelFactory.kt
stream-chat-android-compose/src/test/kotlin/io/getstream/chat/android/compose/viewmodel/channels/ChannelListSearchOptionsTest.kt
stream-chat-android-compose/src/test/kotlin/io/getstream/chat/android/compose/viewmodel/channels/ChannelListViewModelTest.kt

Included review availability: This review used your included allowance. Your plan provides up to 4 included reviews per hour; 3 remain after this review.

📝 Walkthrough

The Compose channel list API adds configurable options for channel filters, channel sorting, and message-search filters. The view model uses these options across standard, predefined-filter, and grouped searches, including pagination. The sample app adds an opt-in member-name search setting and end-to-end tests for member-name and channel-name queries.

Priority: ➖ Normal

Merge Risk: ⚪ Minimal · up to a54d2

No confirmed issue blocks merging after normal validation.

Pre-merge checks: 4 · 1

Failed checks: 1 warning

Check name	Status	Explanation	Resolution
Docstring Coverage		Docstring coverage is 16.67% which is insufficient. The required threshold is 80.00%. Docstring coverage is scoped to functions touched by this diff. Analyzed 60 functions across 12 files. (2 skipped:…	Write docstrings for the functions missing them to satisfy the coverage threshold.

Passed checks: 4 passed

Check name	Status	Explanation
Title check		The title clearly summarizes the main change: it lets applications override channel-list search filters and sorting. It is concise and specific.
Linked Issues check		Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check		Check skipped because no linked issues were found for this pull request.
Description check		The pull request description clearly explains the goal, implementation, testing, linked issue, and validation results. It omits the required Checklist section and does not explicitly confirm the Strea…

Full details: Description check

Explanation

The pull request description clearly explains the goal, implementation, testing, linked issue, and validation results. It omits the required Checklist section and does not explicitly confirm the Stream CLA or tests/docs checklist items.

Full details: Docstring Coverage

Explanation

Docstring coverage is 16.67% which is insufficient. The required threshold is 80.00%. Docstring coverage is scoped to functions touched by this diff. Analyzed 60 functions across 12 files. (2 skipped: 2 unsupported.)

Resolution

Write docstrings for the functions missing them to satisfy the coverage threshold.

✨ Finishing Touches: 💡 1

📝 Generate docstrings: 💡

Commit to this branch
Create a new PR

🧪 Generate unit tests (beta)

Commit to this branch
Create a new PR

Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

_{A rabbit checks the channel list,
And finds a name among the mist.
With filters set and queries bright,
Three group chats come into sight.
The bunny hops; the tests pass right!}

_{Comment @coderabbitai help to get the list of available commands.}

github-actions · 2026-10-23T14:13:26Z

SDK Size Comparison 📏

SDK	Before	After	Status
stream-chat-android-client	6.27 MB	6.27 MB	🟢
stream-chat-android-ui-components	11.59 MB	11.59 MB	🟢
stream-chat-android-compose	13.26 MB	13.26 MB	🟢
stream-chat-android-ai-compose	2.17 MB	2.17 MB	🟢
stream-chat-android-ai-ondevice	1.67 MB	1.67 MB	🟢

…to andrerego/and-1201-add-support-to-override-the-messageschannel-search # Conflicts: # stream-chat-android-compose/src/main/java/io/getstream/chat/android/compose/viewmodel/channels/ChannelListViewModel.kt

sonarqubecloud · 2026-10-23T16:02:55Z

Quality Gate passed

Issues
6 New issues
0 Accepted issues

Measures
0 Security Hotspots
89.2% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

andremion added 2 commits October 23, 2026 13:48

andremion added the pr:new-feature New feature label Oct 23, 2026

Base automatically changed from andrerego/and-978-use-the-name-and-membership-filter-for-channel-search-in to develop October 23, 2026 14:56

Merge branch 'develop' of github.com:GetStream/stream-chat-android in…

8c82164

…to andrerego/and-1201-add-support-to-override-the-messageschannel-search # Conflicts: # stream-chat-android-compose/src/main/java/io/getstream/chat/android/compose/viewmodel/channels/ChannelListViewModel.kt

andremion marked this pull request as ready for review October 23, 2026 15:04

andremion requested a review from a team as a code owner October 23, 2026 15:04

andremion enabled auto-merge October 23, 2026 15:04

gpunto approved these changes Oct 23, 2026

View reviewed changes

Comment thread ...c/main/java/io/getstream/chat/android/compose/viewmodel/channels/ChannelListSearchOptions.kt

Comment thread ...c/main/java/io/getstream/chat/android/compose/viewmodel/channels/ChannelListSearchOptions.kt Outdated

Describe when the search options are called for the next page

5baef6b

andremion disabled auto-merge October 23, 2026 15:33

Add messageSort to the search options and deprecate messageSearchSort

0bfddf2

andremion enabled auto-merge October 23, 2026 15:45

andremion added 2 commits October 23, 2026 16:50

Cover the deprecated constructors and a skipped next message page

be6421f

Split the channel list test fixture by query mode

d130d12

andremion added this pull request to the merge queue Oct 23, 2026

Merged via the queue into develop with commit 5a9e2ee Oct 23, 2026
25 checks passed

andremion deleted the andrerego/and-1201-add-support-to-override-the-messageschannel-search branch October 23, 2026 16:35

Navigation Menu

Repository navigation

Let apps override the channel list search filters and sort - #6884

Let apps override the channel list search filters and sort#6884
andremion merged 7 commits into
developfrom
andrerego/and-1201-add-support-to-override-the-messageschannel-search

andremion commented Oct 23, 2026 •

edited

Loading

Uh oh!

andremion commented Oct 23, 2026

Uh oh!

github-actions Bot commented Oct 23, 2026

Uh oh!

coderabbitai Bot commented Oct 23, 2026 •

edited

Loading

Uh oh!

coderabbitai Bot commented Oct 23, 2026 •

edited

Loading

Uh oh!

github-actions Bot commented Oct 23, 2026

Uh oh!

Uh oh!

Uh oh!

sonarqubecloud Bot commented Oct 23, 2026

Uh oh!

Uh oh!

Reviewers

Uh oh!

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Conversation

andremion commented Oct 23, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Goal

Implementation

Testing

Summary by CodeRabbit

Uh oh!

andremion commented Oct 23, 2026

Uh oh!

github-actions Bot commented Oct 23, 2026

PR checklist ✅

Uh oh!

coderabbitai Bot commented Oct 23, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

coderabbitai Bot commented Oct 23, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

github-actions Bot commented Oct 23, 2026

SDK Size Comparison 📏

Uh oh!

Uh oh!

Uh oh!

sonarqubecloud Bot commented Oct 23, 2026

Quality Gate passed

Uh oh!

Uh oh!

Reviewers

Uh oh!

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

andremion commented Oct 23, 2026 •

edited

Loading

coderabbitai Bot commented Oct 23, 2026 •

edited

Loading

coderabbitai Bot commented Oct 23, 2026 •

edited

Loading