Repository navigation
feat(ScheduledMessages): scheduled messages built on existing SDK patterns #3426
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,108 @@ | ||
| import { useEffect, useMemo, useState } from 'react'; | ||
| import type { OwnCapabilitiesState } from 'stream-chat'; | ||
| import { | ||
| asDynamicKey, | ||
| ListItemLayout, | ||
| Switch, | ||
| useNotificationApi, | ||
| useStateStore, | ||
| useTranslationContext, | ||
| } from 'stream-chat-react'; | ||
| import { | ||
| type ChannelManagementActionItem, | ||
| defaultChannelManagementActionSet, | ||
| useChannelDetailContext, | ||
| } from 'stream-chat-react/channel-detail'; | ||
|
|
||
| import { IconLock } from '../icons'; | ||
|
|
||
| const toError = (error: unknown) => | ||
| error instanceof Error ? error : new Error('An unknown error occurred'); | ||
|
|
||
| const selectCanFreeze = ({ ownCapabilities }: OwnCapabilitiesState) => ({ | ||
| canFreeze: !!ownCapabilities?.includes('freeze-channel'), | ||
| }); | ||
|
|
||
| const FreezeActionIcon = () => ( | ||
| <IconLock className='str-chat__channel-detail__action-icon' /> | ||
| ); | ||
|
|
||
| /** | ||
| * Freezes or unfreezes the channel, for a user whose role has the `UpdateChannelFrozen` | ||
| * permission. A frozen channel takes no new messages, which is also how a scheduled message | ||
| * can be made to fail with `channel_frozen`. The SDK ships no freeze action; it is demo code. | ||
| */ | ||
| const ChannelFreezeAction = () => { | ||
| const { channel } = useChannelDetailContext(); | ||
| const { addNotification } = useNotificationApi(); | ||
| const { t } = useTranslationContext(); | ||
| const { canFreeze } = useStateStore(channel.state, selectCanFreeze); | ||
| const [frozen, setFrozen] = useState(!!channel.data?.frozen); | ||
|
|
||
| // follows a freeze made elsewhere, such as in the dashboard | ||
| useEffect(() => { | ||
| setFrozen(!!channel.data?.frozen); | ||
| const { unsubscribe } = channel.on('channel.updated', ({ channel: data }) => { | ||
| if (data?.frozen !== undefined) setFrozen(data.frozen); | ||
| }); | ||
| return unsubscribe; | ||
| }, [channel]); | ||
|
|
||
| const TrailingSlot = useMemo(() => { | ||
| function ChannelFreezeSwitch() { | ||
| return <Switch on={frozen} presentation />; | ||
| } | ||
| return ChannelFreezeSwitch; | ||
| }, [frozen]); | ||
|
|
||
| if (!canFreeze) return null; | ||
|
|
||
| const toggleFrozen = async () => { | ||
| const nextFrozen = !frozen; | ||
| setFrozen(nextFrozen); | ||
|
Comment on lines
+60
to
+62
There was a problem hiding this comment. Prevent overlapping freeze updates. Starting from an unfrozen channel, click twice before either request completes. The requests capture Add an in-flight guard and disable the button until the request completes. Reconcile the displayed state after failure.
 |
||
| try { | ||
| await channel.updatePartial({ set: { frozen: nextFrozen } }); | ||
| } catch (error) { | ||
| setFrozen(!nextFrozen); | ||
| addNotification({ | ||
| context: { channel }, | ||
| emitter: 'ChannelFreezeAction', | ||
| error: toError(error), | ||
| message: nextFrozen | ||
| ? t( | ||
| asDynamicKey('viteExample.channelFreeze.freezeError.text'), | ||
| "Couldn't freeze the channel", | ||
| ) | ||
| : t( | ||
| asDynamicKey('viteExample.channelFreeze.unfreezeError.text'), | ||
| "Couldn't unfreeze the channel", | ||
| ), | ||
| severity: 'error', | ||
| type: 'api:channel:freeze:failed', | ||
| }); | ||
| } | ||
| }; | ||
|
|
||
| return ( | ||
| <ListItemLayout | ||
| LeadingIcon={FreezeActionIcon} | ||
| RootElement='button' | ||
| rootProps={{ | ||
| 'aria-pressed': frozen, | ||
| className: | ||
| 'str-chat__form__switch-field str-chat__channel-management-view-action', | ||
| onClick: toggleFrozen, | ||
| }} | ||
| title={t(asDynamicKey('viteExample.channelFreeze.title'), 'Freeze channel')} | ||
| TrailingSlot={TrailingSlot} | ||
| /> | ||
| ); | ||
| }; | ||
|
|
||
| /** The SDK's channel actions with the freeze switch after Mute chat. */ | ||
| export const channelManagementActionSetWithFreeze: ChannelManagementActionItem[] = | ||
| defaultChannelManagementActionSet.flatMap((action) => | ||
| action.type === 'muteChannel' | ||
| ? [action, { Component: ChannelFreezeAction, type: 'freezeChannel' }] | ||
| : [action], | ||
| ); | ||
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
Oops, something went wrong.
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.
Script executed:
rg -n -C 5 'availableSlots|bindingOf|openChannels' \ src/plugins/SlotLayout/workspaceNavigationAdapter.tsx git show release-v14:src/components/ChannelList/ChannelListHeader.tsxRepository: GetStream/stream-chat-react
Length of output: 4878
Script executed:
Repository: GetStream/stream-chat-react
Length of output: 41096
Script executed:
Repository: GetStream/stream-chat-react
Length of output: 29959
Web query:
GetStream stream-chat-react v14 ChannelListHeader HeaderEndContent channel useChatContext sourceResult:
Script executed:
Repository: GetStream/stream-chat-react
Length of output: 15655
Account for covered channels in the visibility gate.
If a layer covers the only channel,
openChannelsstill contains its base binding. The example can then show the toggle with no channel visible. Use layout state to check visible bindings, or document that applications must use their own selection state to preserve the v14 gate.