feat: add message/channel paginator stack with thread minimal-init and state stores - #1795
Merged
Merged
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
MartinCupela
requested review from
arnautov-anton,
isekovanic and
oliverlaz
as code owners
July 8, 2026 09:49
MartinCupela
changed the title
Contributor
|
Size Change: +96.3 kB (+23.54%) 🚨 Total Size: 505 kB 📦 View Changed
|
…rge' into feat/message-paginator-master-merge
## 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? ## Changelog -
## 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? ## Changelog -
## 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? ## Changelog -
…ith paginators (#1806) ### Summary Completes the `message-paginator` initiative on the LLC side: the channel's **messages, thread replies, and pinned messages are no longer stored on `channel.state`**. Each list now lives in a paginator that is the single source of truth (interval storage + a canonical `ItemIndex`): - **Main message list** → `channel.messagePaginator` - **Thread replies** → `thread.messagePaginator` (owned by the `Thread` object) - **Pinned messages** → `channel.pinnedMessagesPaginator` (new `PinnedMessagePaginator`) ### What changed - **`ChannelState` storage removed:** `messages`, `latestMessages`, `messageSets`, `messagePagination`, `threads`, `pinnedMessages`, and their mutators (`addMessageSorted`/`addMessagesSorted`, `removeMessage`, `findMessage`, `findMessageByTimestamp`, `filterErrorMessages`, `loadMessageIntoState`, `clearMessages`, `initMessages`, `pruneOldest`, `addReaction`/`removeReaction`, `updateUserMessages`, `deleteUserMessages`, `addPinnedMessages`/`addPinnedMessage`/`removePinnedMessage`, `removeQuotedMessageReferences`, + internal helpers). - **`PinnedMessagePaginator`** added and populated from channel events; pin/unpin falls out of `ingestItem` + a `{ pinned: true }` filter (no bespoke branching). - **`MessageIntervalPaginator`** extracted as the unread-free base of `MessagePaginator`; it tracks the latest message (`latestMessageId` + `latestMessage`), advanced on ingest and mirrored into reactive state. - **`channel.state.last_message_at`** is now a **read-only getter** derived from `messagePaginator.latestMessage` (setter + backing field removed). - **`channel.state.isUpToDate` / `setIsUpToDate` removed** — live-message routing (don't disrupt a scrolled-away view) is handled structurally by the paginator's interval model. - **`Channel._trackLatestMessage` removed.** `user.updated` / `user.deleted` propagation now scans active channels (`reflectUserUpdate` / `applyMessageDeletionForUser` self-filter by author id). A targeted user-reference index is planned (`specs/user-reference-index`). - **`utils` cleanup:** removed `addToMessageList`, `messageSetPagination`, `binarySearchByDateEqualOrNearestGreater`, `deleteUserMessages`, and the `MessageSet` / message-set pagination types. - **Reactive `headItems`** added to `PaginatorState` (newest-loaded window). - **Removed the unused `MessageReplyPaginator`** (dead sibling; the thread reply list uses `MessagePaginator`). ### Breaking changes Full list + before → after migration table in **`docs/breaking-changes-v14-v15.md`**. Highlights: | Before (v14) | After (v15) | | --- | --- | | `channel.state.messages` | `channel.messagePaginator.state.items` / `.items` | | `channel.state.threads[parentId]` | `thread.messagePaginator.state.items` | | `channel.state.pinnedMessages` | `channel.pinnedMessagesPaginator.state.items` | | `channel.state.addMessageSorted(m)` | `channel.messagePaginator.ingestItem(m)` | | `channel.state.removeMessage({ id })` | `channel.messagePaginator.removeItem({ id })` | | `channel.state.findMessage(id)` | `channel.messagePaginator.getItem(id)` | | `channel.state.isUpToDate` / `setIsUpToDate` | `messagePaginator.isActiveIntervalAtHead` / `hasMoreHead` / `jumpToTheLatestMessage()` | | `channel.state.last_message_at = …` | read-only (derived); ingest a message on the paginator | Behavioral note: `last_message_at` now advances on every incoming message regardless of the viewer's scroll position (the old `isUpToDate` suppression is gone) — it's a channel-level fact. ### Follow-ups (not in this PR) - **`specs/user-reference-index`** — replace the active-channel scan on `user.updated`/`user.deleted` with a `userId → message-reference` index (design-gated). - Unifying the remaining flat paginators on interval storage - Offline migration --------- Co-authored-by: Claude Opus 4.8 <noreply@anthropic.com>
…o feat/message-paginator-master-merge # Conflicts: # src/channel.ts # src/channel_state.ts # src/client.ts # src/messageComposer/messageComposer.ts # src/messageComposer/middleware/textComposer/types.ts # src/messageComposer/textComposer.ts # src/messageDelivery/MessageDeliveryReporter.ts # src/messageDelivery/MessageReceiptsTracker.ts # src/moderation.ts # src/pagination/BasePaginator.ts # src/pagination/ReminderPaginator.ts # src/pagination/UserGroupPaginator.ts # src/signing.ts # src/thread.ts # src/types.ts # src/utils.ts # test/unit/CooldownTimer.test.ts # test/unit/MessageComposer/messageComposer.test.ts # test/unit/MessageComposer/middleware/messageComposer/cleanData.test.ts # test/unit/MessageComposer/textComposer.test.ts # test/unit/channel.test.js # test/unit/channel_state.test.js # test/unit/client.test.js # test/unit/messageDelivery/MessageDeliveryReporter.test.ts # test/unit/messageDelivery/MessageReceiptsTracker.test.ts # test/unit/pagination/UserGroupPaginator.test.ts # test/unit/threads.test.ts # test/unit/utils.test.js # test/unit/utils.test.ts
arnautov-anton
force-pushed
the
feat/message-paginator-master-merge
branch
from
July 31, 2026 08:06
4b57520 to
d00e67f
Compare
github-actions Bot
pushed a commit
that referenced
this pull request
Aug 3, 2026
## [10.0.0-rc.1](v9.50.2...v10.0.0-rc.1) (2026-08-03) ### ⚠ BREAKING CHANGES * paginator-based message storage replaces channel.state.messages and channel.state.last_message_at. The message list, thread replies and pinned messages are now owned by channel.messagePaginator, thread.messagePaginator and channel.pinnedMessagesPaginator. OpenAPI-generated clients replace the hand-written request/response types. See docs/breaking-changes-v14-v15.md for the full migration guide. ### Features * add message/channel paginator stack with thread minimal-init and state stores ([#1795](#1795)) ([62f0507](62f0507)) * integrate OpenAPI generated clients ([#1760](#1760)) ([0776bc4](0776bc4)) * v10 ([cd3141e](cd3141e))
|
🎉 This PR is included in version 10.0.0-rc.1 🎉 The release is available on: Your semantic-release bot 📦🚀 |
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
4 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