-
Notifications
You must be signed in to change notification settings - Fork 299
fix(Channel): guard render-phase channel.getConfig() against disconnected channels #3257
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. Weβll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
oliverlaz
wants to merge
2
commits into
master
Choose a base branch
from
fix/disconnected-channel-getconfig
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
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
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
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
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
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
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
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
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
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,29 @@ | ||
| import { fromPartial } from '@total-typescript/shoehorn'; | ||
| import type { Channel, ChannelConfigWithInfo } from 'stream-chat'; | ||
| import { describe, expect, it, vi } from 'vitest'; | ||
| import { getChannelConfig } from '../getChannelConfig'; | ||
|
|
||
| const config = fromPartial<ChannelConfigWithInfo>({ read_events: true }); | ||
|
|
||
| describe('getChannelConfig', () => { | ||
| it('returns the channel config for a connected channel', () => { | ||
| const channel = fromPartial<Channel>({ | ||
| disconnected: false, | ||
| getConfig: () => config, | ||
| }); | ||
|
|
||
| expect(getChannelConfig(channel)).toBe(config); | ||
| }); | ||
|
|
||
| it('returns undefined for a disconnected channel without calling getConfig', () => { | ||
| // channel.getConfig() calls channel.getClient(), which throws | ||
| // "You can't use a channel after client.disconnect() was called" | ||
| const getConfig = vi.fn(() => { | ||
| throw new Error("You can't use a channel after client.disconnect() was called"); | ||
| }); | ||
| const channel = fromPartial<Channel>({ disconnected: true, getConfig }); | ||
|
|
||
| expect(getChannelConfig(channel)).toBeUndefined(); | ||
| expect(getConfig).not.toHaveBeenCalled(); | ||
| }); | ||
| }); |
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,19 @@ | ||
| import type { Channel, ChannelConfigWithInfo } from 'stream-chat'; | ||
|
|
||
| /** | ||
| * `channel.getConfig()` calls `channel.getClient()`, which throws | ||
| * "You can't use a channel after client.disconnect() was called" once the | ||
| * channel is disconnected (e.g. the current user was removed from the channel | ||
| * or the channel was deleted - see `channel.deleted`, | ||
| * `notification.channel_deleted` and `notification.removed_from_channel`). | ||
| * | ||
| * The `disconnected` flag is flipped from an asynchronous WS event, so there is | ||
| * always a window between the flag becoming true and React unmounting the | ||
| * subtree that renders the channel. Any render inside that window would throw, | ||
| * so callers must never reach `getConfig()` for a disconnected channel. | ||
| * | ||
| * `undefined` is already part of `getConfig()`'s return type, so consumers need | ||
| * no extra handling beyond what they do for a not-yet-configured channel. | ||
| */ | ||
| export const getChannelConfig = (channel: Channel): ChannelConfigWithInfo | undefined => | ||
| channel.disconnected ? undefined : channel.getConfig(); |
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
π©Ί Stability & Availability | π Major | β‘ Quick win
Recheck disconnection before
clear().Line 103 only protects the start of cleanup. A WebSocket event can disconnect the channel while
createDraft()is pending. Thefinallycallback then callsmessageComposer.clear(), which reacheschannel.getConfig()afterclient.disconnect()and can throw.Recheck
messageComposer.channel.disconnectedinsidefinally. Add a test that leavescreateDraft()pending, unmounts, disconnects the channel, resolves the draft promise, and verifies thatclear()is not called.Proposed fix
π Committable suggestion
π€ Prompt for AI Agents