Chat single channel updates #2569

splindsay-92 · 2025-05-01T13:23:22Z

Description

Contains all the changes relating to single channel migration.

Checklist

Commits have been rebased.
Linting has been run against the changed file(s).
The PR adheres to the writing style guide and contribution guide.

coderabbitai · 2025-05-01T13:23:29Z

Important

Review skipped

Auto reviews are disabled on this repository.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

Review comments: Directly reply to a review comment made by CodeRabbit. Example:
- I pushed a fix in commit <commit_id>, please review it.
- Explain this complex logic.
- Open a follow-up GitHub issue for this discussion.
Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
- @coderabbitai explain this code block.
- @coderabbitai modularize this function.
PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
- @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
- @coderabbitai read src/utils.ts and explain its main purpose.
- @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
- @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

@coderabbitai pause to pause the reviews on a PR.
@coderabbitai resume to resume the paused reviews.
@coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
@coderabbitai full review to do a full review from scratch and review all the files again.
@coderabbitai summary to regenerate the summary of the PR.
@coderabbitai generate docstrings to generate docstrings for this PR.
@coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
@coderabbitai resolve resolve all the CodeRabbit review comments.
@coderabbitai configuration to show the current CodeRabbit configuration for the repository.
@coderabbitai help to get help.

Other keywords and placeholders

Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (`.coderabbit.yaml`)

You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
Please see the configuration documentation for more information.
If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

Visit our Documentation for detailed information on how to use CodeRabbit.
Join our Discord Community to get help, request features, and share feedback.
Follow us on X/Twitter for updates and announcements.

content/chat/rooms/typing.textile

sacOO7 · 2025-05-13T11:25:22Z

content/chat/rooms/index.textile

-  | "Room reactions":/docs/chat/rooms/reactions | @reactions@ | @AllFeaturesEnabled.reactions@ |
+  | "Presence":/docs/chat/rooms/presence | @presence.enableEvents@ | @true@ |
+  | "Occupancy":/docs/chat/rooms/occupancy | @occupancy.enableEvents@ | @false@ |
+  | "Typing indicators":/docs/chat/rooms/typing | @typing.heartbeatThrottleMs@ | @10000@ |


Is room reactions omitted because it doesn't have any options

Well we no longer have a room reactions object chat-js, so there is nothing to include here. Do I need to add it back in for kotlin?

maratal · 2025-05-13T21:40:37Z

content/chat/rooms/index.textile

Haven't noticed updates for chatClient.rooms.get(roomID: "getting-started") here similar to voltaire and website changes FYI @umair-ably

we already have a rooms.get, just a different room id

I mean that additional parameter was removed there, but not here.

content/chat/connect.textile

sacOO7

added small comment, lgtm

AndyTWF · 2025-05-15T10:17:12Z

content/chat/rooms/index.textile

+h2(#channel-relationship). Channel <> Room relationship
+
+It is important to note that each room is backed by a single Ably Pub/Sub channel. You may need to be aware of this when using some integrations with Ably, such as the "Pulsar":https://ably.com/docs/integrations/streaming/pulsar#creating-pulsar-rule connectors, or if you are operating in an environment where a Chat SDK is not available.
+The channel name is the same as the room ID with an appended suffix of @::$chat@ (e.g @some-room-id::$chat@). In most cases, you will not need to worry about this, as the Chat SDK handles the channel creation and management for you and capabilities can be configured at the room level.


Perhaps add an extra newline here to break the section up?

AndyTWF · 2025-05-15T10:18:44Z

content/chat/rooms/index.textile

 Releasing a room allows the underlying resources to be garbage collected or released.

-Releasing a room may be optional for many applications. If you have multiple transient rooms, such as in the case of a 1:1 support chat, then it is may be more beneficial.
+Releasing a room may be optional for many applications. If you have multiple transient rooms, such as in the case of a 1:1 support chat, then it may be more beneficial.


Perhaps worth mentioning that if you're sensitive to costs, releasing rooms and disconnecting more aggressively may be helpful (rather than waiting for the 2 minutes)?

vladvelici · 2025-05-15T12:01:43Z

Update chat-js version to 0.7.0?

Typing is no longer presence-based, the docs have been updated to reflect changes in logic to support this. - Also added details about the new `change` property in typing events and updated the timeout behavior with `start()` calls and grace periods. - `typing.get()` is also now synchronous.

… `heartbeatThrottleMs`

Based on the JS changes in 448fc4b..133accc.

…ease

… up version to latest release

Co-authored-by: sachin shinde <sachinshinde7676@gmail.com>

splindsay-92 force-pushed the integration/chat-single-channel branch 2 times, most recently from adc7024 to 448fc4b Compare May 1, 2025 16:31

splindsay-92 marked this pull request as ready for review May 6, 2025 11:32

splindsay-92 force-pushed the integration/chat-single-channel branch 3 times, most recently from 11da147 to 574b877 Compare May 7, 2025 11:06

splindsay-92 requested review from m-hulbert and vladvelici May 8, 2025 16:42

sacOO7 reviewed May 12, 2025

View reviewed changes

content/chat/rooms/typing.textile Outdated Show resolved Hide resolved

sacOO7 reviewed May 12, 2025

View reviewed changes

content/chat/rooms/typing.textile Show resolved Hide resolved

splindsay-92 requested a review from sacOO7 May 12, 2025 15:28

sacOO7 reviewed May 13, 2025

View reviewed changes

maratal reviewed May 13, 2025

View reviewed changes

splindsay-92 force-pushed the integration/chat-single-channel branch 2 times, most recently from 38edd89 to 26dc2aa Compare May 15, 2025 10:14

splindsay-92 requested a review from umair-ably May 15, 2025 10:14

sacOO7 reviewed May 15, 2025

View reviewed changes

content/chat/connect.textile Outdated Show resolved Hide resolved

splindsay-92 requested a review from sacOO7 May 15, 2025 10:21

sacOO7 approved these changes May 15, 2025

View reviewed changes

AndyTWF reviewed May 15, 2025

View reviewed changes

splindsay-92 requested a review from AndyTWF May 15, 2025 11:55

splindsay-92 force-pushed the integration/chat-single-channel branch from 0492321 to 6c9ab14 Compare May 15, 2025 12:54

vladvelici approved these changes May 15, 2025

View reviewed changes

splindsay-92 added 5 commits May 15, 2025 14:28

Update typing event and timeout parameter names, updating default for…

56dcef1

… `heartbeatThrottleMs`

Broken the large block of text into sections to improve readability.

6bf7583

Update SDK method from start to keystroke for typing events

69cd637

Chat: Updated the chat docs for the single room migration

78f153a

splindsay-92 and others added 15 commits May 15, 2025 14:28

Add explanation of Channel-Room relationship in documentation

567f010

Add note on occupancy feature's default state and costs

aa75404

Add note styling for integration details in chat rooms doc

f0cc2d5

Update RoomOption defaults and property references in table

1c1d65d

chat: Update Swift documentation for single channel

3442451

Based on the JS changes in 448fc4b..133accc.

Fixing PR comments

bb24e7e

Clarify billable message increase

e28e281

Refactor: Fix blang and <p> closer

dcf39e6

Update typing set event payload

1642084

update swift code and links to be in line with the upcoming 0.4.0 rel…

b58b09d

…ease

Updated kotlin docs in accordance with single channel changes, bumped…

3205592

… up version to latest release

Fixed js docs for typing, updated doc links as well

d746458

Update content/chat/connect.textile

220b9f8

Co-authored-by: sachin shinde <sachinshinde7676@gmail.com>

fixup PR comments

06b2c82

Updating languageData.ts to latest chat sdk versions

8a45af4

splindsay-92 force-pushed the integration/chat-single-channel branch from 72239a9 to 8a45af4 Compare May 15, 2025 13:28

splindsay-92 merged commit 5c4eaf9 into main May 15, 2025
6 checks passed

splindsay-92 deleted the integration/chat-single-channel branch May 15, 2025 13:35

Uh oh!

Chat single channel updates #2569

Chat single channel updates #2569

Uh oh!

Conversation

splindsay-92 commented May 1, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Checklist

Uh oh!

coderabbitai bot commented May 1, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Review skipped

Chat

Support

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

sacOO7 left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

vladvelici commented May 15, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Milestone

Development

Uh oh!

8 participants

splindsay-92 commented May 1, 2025 •

edited

Loading

coderabbitai bot commented May 1, 2025 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)