Repository navigation
refactor: clean up channel lifecycle - #3868
Merged
isekovanic merged 1 commit intoOct 19, 2026
Merged
Conversation
Contributor
SDK Size
|
isekovanic
added this pull request to stack #3873
October 19, 2026 07:56
This was referenced Oct 19, 2026
Merged
isekovanic
pushed a commit
that referenced
this pull request
Oct 19, 2026
…useCreateChatClient (#3871) ## 🎯 Goal Fix the SDK-side problems the v10 public-API audit found (listed in `ai-docs/v10-breaking-changes.md` §16 in #3870), so they ship fixed instead of documented as limitations. The docs PR #3870 already drops these known-issue notes from `ai-docs/v10-breaking-changes.md` and `ai-docs/ai-migration-v9-to-v10.md` (§13.1, §16.1, §R.5), so it assumes this PR lands first or together with it. This PR is code only. **Stacked on #3869** (Ivan's stack: #3866 → #3867 → #3868 → #3869). The branch is rebased onto `refactor/stop-creating-sdk-paginator`; until the PR base is moved there, the diff also shows that stack's commits. ## 🛠 Implementation details - **`<Channel>` overrode a registered page size.** On every mount it ran `channel.messagePaginator.pageSize = 25` (now in `useChannelLifecycle`, after #3868). That setter is a runtime `updateConfig` patch, which outranks every declarative layer, so a `client.config.set({ channel: { messagePaginator: { pageSize } } })` registration (the migration guide's advice) never took effect. `useChannelLifecycle` now applies the 25-message default only when no `pageSize` is registered under `channel.messagePaginator` or the general `messagePaginator` key, the two places the paginator resolves it from. - **`useCreateChatClient({ userData })` rejected `{ id, name, image }`.** It was typed `OwnUserResponse | UserResponse`, which require server-owned fields (`role`, `created_at`, …) in stream-chat v10. It is now `ClientUser`, exactly what `client.connectUser` accepts. The `as UserResponse` casts in ExpoChatGPTSample and ExpoMessaging are gone (ExpoMessaging keeps `as ClientUser` only to narrow away `null`). - **`AGENTS.md`** said the main entry must never reach `@stream-io/state-store`, but the `state-store/` stores and Poll contexts import it at runtime. The rule now matches `package/bin/validate-entry-isolation.js` (`@stream-io/state-store` and `lodash` are shared; only `react-syntax-highlighter`, `@khanacademy/simple-markdown`, `zod`, `victory-native` and Skia are AI-only), and the script path is corrected. ## 🎨 UI Changes None. ## 🧪 Testing - `Channel.test.tsx` (still passes on the rebased base) → "message page size": default 25 with nothing registered, and a registered `channel.messagePaginator.pageSize` / `messagePaginator.pageSize` is kept after mount. The two registration cases fail with the guard removed. - New `useCreateChatClient.userData.test.ts`: a type-level assertion that the hook's `userData` and `connectUser`'s parameter are mutually assignable (it fails `test:typecheck` under the old typing), plus a runtime check that a `{ id, name, image }` user is passed to `connectUser`. - After the rebase onto #3869: `yarn lint`, `cd package && yarn test:typecheck`, and the `Channel` and `useCreateChatClient` suites pass. Before the rebase, locally green: `yarn build`, `yarn lint`, `cd package && yarn test:typecheck`, `yarn typecheck` (covers the example apps without the casts), `yarn test:unit` (2200 passed). ## ☑️ Checklist - [ ] I have signed the [Stream CLA](https://docs.google.com/forms/d/e/1FAIpQLScFKsKkAJI7mhCr7K9rEIOpqIDThrWxuvxnwUq2XkHyG154vQ/viewform) (required) - [ ] PR targets the `develop` branch (targets `V10`: v10 release fix) - [x] Documentation is updated (`AGENTS.md`; migration docs in #3870) - [ ] New code is tested in main example apps, including all possible scenarios - [ ] SampleApp iOS and Android - [ ] Expo iOS and Android
isekovanic
pushed a commit
that referenced
this pull request
Oct 19, 2026
## 🎯 Goal Collect every breaking change between v9 (`develop`) and v10 (`V10`) in one place, as the source of truth for the v10 migration guide and the docs update. Also verify the running ledger `ai-docs/ai-migration-v9-to-v10.md` and measure the impact on the getstream.io React Native docs. ## 🛠 Implementation details - **`ai-docs/v10-breaking-changes.md` (new):** the full list, grouped by surface: dependencies, removed exports, component props, contexts, hooks, utilities, types, classes and stores, slots and theme, i18n, offline DB, `stream-chat` v10 changes RN integrators hit, behavioural changes, deep imports and new APIs. Each entry has a one-line migration and links to the ledger section and PR. - **`ai-docs/v10-docs-impact.md` (new):** per-page impact on `getstream.io/content/docs/chat-sdk/react-native/v9-latest`. 109 of 302 pages are affected: 6 to delete or replace, 22 major rewrites, 56 snippet or prop-table updates and 25 mentions. It also lists about 12 new pages or sections. - **`ai-docs/ai-migration-v9-to-v10.md`:** fixes 23 stale or wrong entries. Examples: - `*WithLocalUpdate` → `channel.messageOperations.*` - there is no `deactivate()`; `activate()` returns its release function - `client.activeChannels` → `client.channelManager` - `queryChannelsOverride` should use `queryChannelsAndHydrate` - `channel.markRead()` vs `markReadViaReporter()` - `dbVersion` goes 16 → 18 - `connection.changed` is no longer dispatched - §18.4 described a `channelManager` prop that v9 never had Also adds **Part R** (R.1–R.11) for the gaps the audit found: RN/Expo peer floors, the `ChatContext.isOnline` removal, the delivery-receipt props, more removed context fields and props, behaviour changes in `<Channel>`/`<Thread>`/channel list, `stream-chat` state and client APIs, the offline DB contract, i18n gaps and deep imports. - **`ai-docs/i18n-v10-migration.md`:** two corrections. The app-callable formatter keys were not dead in v9, and the date helpers were deep imports in v9. - **`.claude/plans/v10-breaking-changes.md`:** the audit plan. **How the list was produced:** 1. A TypeScript-compiler snapshot of both public surfaces (about 1,285 exports, with props, context values and class members flattened, plus the referenced `stream-chat` types), diffed mechanically. 2. The v9 `SampleApp` and `ExpoMessaging` type-checked against V10: 0 errors on v9 and 144 on v10, and every error cluster maps to an entry. 3. A review of all 40 PRs merged into `V10`, the `examples/` diff, and the deleted or rewritten tests. 4. A cross-check against the `stream-chat` and `stream-chat-react` v10 breaking-change lists. **Stack: #3866 → #3867 → #3868 → #3869 → #3871 → this PR.** The known-issue notes for the SDK bugs the audit found are removed here because #3871 fixes them. The inventory covers `V10` plus #3866–#3869: the surface diff and the v9 sample-app compile were re-run against the stack tip. ## 🎨 UI Changes None (docs only). ## 🧪 Testing Docs only. `yarn lint` passes. Every replacement API the new file names was checked against the V10 exports and `stream-chat` 10.0.0-rc.22. ## ☑️ Checklist - [ ] I have signed the [Stream CLA](https://docs.google.com/forms/d/e/1FAIpQLScFKsKkAJI7mhCr7K9rEIOpqIDThrWxuvxnwUq2XkHyG154vQ/viewform) (required) - [ ] PR targets the `develop` branch (targets `V10`) - [x] Documentation is updated - [ ] New code is tested in main example apps, including all possible scenarios (n/a, docs only)
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
2 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.
🎯 Goal
Make
<Channel>a thin component. It now renders the error state or the provider shell and nothing else. Follow-up to the standalone<Thread>refactor, stacked on it.🛠 Implementation details
Everything
<Channel>does to a channel while mounted moves into an internaluseChannelLifecyclehook:watch(), a cold open's first page, the unread snapshot, the jump to the first unread, mark read on openactivate()connection.recovered🎨 UI Changes
/
🧪 Testing
/
☑️ Checklist
developbranch