document coalesce feature #2128
Conversation
|
@maxandersen Any reason this PR is still in draft? ../Frenck |
Co-authored-by: J. Nick Koston <[email protected]>
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
| ``` | ||
| { | ||
| "id": 1, | ||
| "type": "supported_features", | ||
| "features": { coalesce_messages: 1 } | ||
| } | ||
| ``` |
There was a problem hiding this comment.
Specify language for the code block.
Add the JSON language identifier to the code block for better readability.
- ```
+ ```jsonTools
Markdownlint
92-92: null
Fenced code blocks should have a language specified(MD040, fenced-code-language)
| } | ||
| ``` | ||
|
|
||
| As of now the only feature supported is 'coalesce_messages' which result in messages being sent coalesced in bulk instead of individually. |
There was a problem hiding this comment.
Fix grammar and clarity.
Correct the grammatical errors and improve the clarity of the sentence.
- As of now the only feature supported is 'coalesce_messages' which result in messages being sent coalesced in bulk instead of individually.
+ As of now, the only feature supported is 'coalesce_messages', which results in messages being sent in bulk instead of individually.Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| As of now the only feature supported is 'coalesce_messages' which result in messages being sent coalesced in bulk instead of individually. | |
| As of now, the only feature supported is 'coalesce_messages', which results in messages being sent in bulk instead of individually. |
Tools
LanguageTool
[typographical] ~100-~100: After the expression ‘As of now’ a comma is usually used.
Context: ...: { coalesce_messages: 1 } } ``` As of now the only feature supported is 'coalesce...(COMMA_OF_AS_OF_NOW)
[uncategorized] ~100-~100: This verb does not appear to agree with the subject. Consider using a different form.
Context: ... supported is 'coalesce_messages' which result in messages being sent coalesced in bul...(AI_EN_LECTOR_REPLACEMENT_VERB_AGREEMENT)
| ## Feature enablement phase | ||
|
|
||
| Clients that supports features that needs enabling should as their first message (with `"id": 1`) send a message in the form: |
There was a problem hiding this comment.
Fix grammar and clarity.
Correct the grammar issues and improve the clarity of the sentence.
- Clients that supports features that needs enabling should as their first message (with `"id": 1`) send a message in the form:
+ Clients that support features needing enabling should, as their first message (with `"id": 1`), send a message in the form:Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| ## Feature enablement phase | |
| Clients that supports features that needs enabling should as their first message (with `"id": 1`) send a message in the form: | |
| ## Feature enablement phase | |
| Clients that support features needing enabling should, as their first message (with `"id": 1`), send a message in the form: |
Tools
LanguageTool
[grammar] ~90-~90: The plural noun “Clients” expects the verb form “support”.
Context: ... Feature enablement phase Clients that supports features that needs enabling should as ...(NNS_THAT_VBZ)
[grammar] ~90-~90: Possible subject-verb agreement error detected.
Context: ...se Clients that supports features that needs enabling should as their first message ...(PLURAL_THAT_AGREEMENT)
WalkthroughWalkthroughThe recent update introduces a "Feature enablement phase" in the WebSocket API documentation, detailing how clients can signal their support for specific features. Clients must send an initial message containing an Changes
Sequence Diagram(s)sequenceDiagram
participant Client
participant Server
Client->>Server: Send initial message with { "id": 1, "type": "supported_features", "features": { "coalesce_messages": true } }
Server-->>Client: Acknowledge support for features
Recent review detailsConfiguration used: CodeRabbit UI Files selected for processing (1)
Additional context usedLanguageTool
Markdownlint
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? TipsChatThere are 3 ways to chat with CodeRabbit:
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 as PR comments)
Additionally, you can add CodeRabbit Configuration File (
|
|
sorry missed the ping - I just put it in draft as I was only able to document something was missing from the doc - I didn't figure out how it is actually supposed to work hence I put in draft hoping others could fill in the blanks :) putting it in non-draft now :) |
Proposed change
try document the coalesce feature.
opening as draft because after reading more ii realize this also introduces a new format for state changes and a "subscribeEntties" which is also not documented in the docs. If someonw can fill in the blanks that would be great.
Type of change
Additional information
Summary by CodeRabbit
coalesce_messagesfeature, which allows bulk message sending for improved communication efficiency.