feat: add message/channel paginator stack with thread minimal-init and state stores#1795
Open
MartinCupela wants to merge 39 commits into
Open
feat: add message/channel paginator stack with thread minimal-init and state stores#1795MartinCupela wants to merge 39 commits into
MartinCupela wants to merge 39 commits into
Conversation
Support setting paginator items directly, optional request retries, offline DB in ChannelPaginator, identification of pagination restart based on query shape change.
…has_unread, last_updated
…n other matching paginators
…n other matching paginators
…eat/message-paginator # Conflicts: # src/channel.ts # src/client.ts
… and message.updated
…or itemOrderComparator
….messages.deleted and message.deleted events
…eflect reaction events
Resolve all 7 textual conflicts + hidden semantic conflicts from folding PR #1674 into current master (release-v10). Types pass; 3462/3469 unit tests pass. Notable resolutions: - member.added/removed: keep master fix #1761 (drop PR's reintroduced member_count double-count). - UserGroupPaginator (#1743): ported to the new paginators/BasePaginator<T,Q>. - client.ts / textComposer types / pagination barrel: unioned, dead code dropped. Known remaining failures tracked in specs/.../decisions.md (own_capabilities design decision + 3 items needing diagnosis). WIP checkpoint; not pushed. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
- own_capabilities (Option B): keep reactive getter/setter but return undefined until loaded, preserving #1732 unread on uninitialized channels; update PR's 'undefined ID no options' expectation. - UserGroupPaginator: stable query shape + apply forward cursor in query() so pages accumulate (new base resets list on query-shape change). - orchestrator test: expect item:undefined on notification.removed_from_channel (master #1788 evicts channel from activeChannels). - messageComposer config test: add master's trackUploadProgress + commands. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
## CLA - [ ] I have signed the [Stream CLA](https://docs.google.com/forms/d/e/1FAIpQLScFKsKkAJI7mhCr7K9rEIOpqIDThrWxuvxnwUq2XkHyG154vQ/viewform) (required). - [ ] Code changes are tested ## Description of the changes, What, Why and How? Spec: https://stream-wiki.notion.site/Local-Unread-Count-specification-38b6a5d7f9f68073a5e1c73298fe0d71 Adds an optin, client side unread count for channels that have read events disabled (e.g. livestreams). Those channels normally don't track unread at all and so `_countMessageAsUnread` bails out whenever `own_capabilities` lacks `read-events`, so integrators have no "N new messages" affordance to show while scrolled up. With the new `isLocalUnreadCountEnabled` client option (default `false`), the SDK maintains a purely local unread count for those channels. It increments on incoming messages and is reset via the new `channel.markReadLocally()` method, which dispatches a client only `message.local_read` event. That event reuses the exact `message.read` state logic in `_handleChannelEvent` (so read state updates stay in one place) but skips `syncDeliveredCandidates()`, so the count is never sent to the backend. `hasReadEvents()` centralizes the capability check. When offline support is enabled, the local read/unread state is persisted for channels with disabled `read-events` so the count survives a cold start. The offline DB handles `message.local_read` (guarded so it can only affect channels with disabled `read-events` channels with the option on) and falls back gracefully when `state.read[userId]` is absent, since the server never sends a read for these channels. Behavior is fully gated behind the flag, so default off means no change for existing integrations. ## Changelog - Add `isLocalUnreadCountEnabled` client option for a client side unread count on channels with disabled `read-events` (e.g. livestreams) - Add `Channel.markReadLocally()` to reset the local unread count with no backend call - Add `Channel.hasReadEvents()` helper - Add client only `message.local_read` event - Persist local unread state to the offline DB so it survives app restarts
## [9.50.0](v9.49.0...v9.50.0) (2026-07-03) ### Features * localized unread count ([#1787](#1787)) ([0a40196](0a40196))
MartinCupela
requested review from
arnautov-anton,
isekovanic,
oliverlaz,
santhoshvai,
szuperaz and
vishalnarkhede
as code owners
MartinCupela
changed the title
Contributor
|
Size Change: +96.3 kB (+23.54%) 🚨 Total Size: 505 kB 📦 View Changed
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
This PR is a broader SDK architecture update, not just a message pagination introduction.
In addition to the new paginator stack, it introduces minimal
Threadinitialization (without initial server thread payload), reactiveStateStore-based state inChannelState, new orchestration/event-pipeline utilities.What’s included
1) New pagination foundation + message pagination
src/pagination/paginators/*:BasePaginatorChannelPaginatorMessagePaginatorMessageReplyPaginatorReminderPaginatorMessagePaginatorintegration for channel and thread flows:2) Multi-list channel orchestration
ChannelPaginatorsOrchestratorfor managing multiple channel lists/paginators.EventHandlerPipelinefor composable/ordered event handling.3) Thread minimal-init support (no initial thread payload required)
Threadconstructor now supports initialization from:client + channel + parentMessage(with optionaldraft)threadData4) Reactive
ChannelStatestoresStateStore-backed reactive slices inChannelState:5) Message operations + local update flows
MessageOperationsandMessageOperationStatePolicy.6) Config/setup and request customization improvements
InstanceConfigurationService.ChannelandThread.Channelcustom mark-read request signature.Testing
Large test expansion and updates across:
Base,Channel,Message,MessageReply, compiler/index utilities)Todo