Skip to content

[AIT-99] feat: protocol v5 + message appends #1182

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.

Sign up for GitHub

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
ttypic wants to merge 2 commits into
base: main
Choose a base branch
from
+402 −296
Open

[AIT-99] feat: protocol v5 + message appends #1182

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
31969a8
[AIT-99] feat: protocol v5 + message appends
ttypic Dec 18, 2025
aa43cca
chore: apply codereview suggestions
ttypic Jan 16, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions java/build.gradle.kts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -79,6 +79,8 @@ tasks.register<Test>("testRestSuite") {
}
jvmArgs("--add-opens", "java.base/java.time=ALL-UNNAMED")
jvmArgs("--add-opens", "java.base/java.lang=ALL-UNNAMED")
jvmArgs("--add-opens", "java.base/java.net=ALL-UNNAMED")
jvmArgs("--add-opens", "java.base/java.lang.reflect=ALL-UNNAMED")
beforeTest(closureOf<TestDescriptor> { logger.lifecycle("-> $this") })
outputs.upToDateWhen { false }
testLogging {
Expand Down
101 changes: 77 additions & 24 deletions lib/src/main/java/io/ably/lib/realtime/ChannelBase.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,7 @@
import io.ably.lib.types.ProtocolMessage.Action;
import io.ably.lib.types.ProtocolMessage.Flag;
import io.ably.lib.types.Summary;
import io.ably.lib.types.UpdateDeleteResult;
import io.ably.lib.util.CollectionUtils;
import io.ably.lib.util.EventEmitter;
import io.ably.lib.util.Log;
Expand Down Expand Up @@ -1214,9 +1215,10 @@ public void getMessageAsync(String serial, Callback<Message> callback) {
* Only non-null fields will be applied to the existing message.
* @param operation operation metadata such as clientId, description, or metadata in the version field
* @throws AblyException If the update operation fails.
* @return A {@link UpdateDeleteResult} containing the updated message version serial.
*/
public void updateMessage(Message message, MessageOperation operation) throws AblyException {
messageEditsMixin.updateMessage(ably.http, message, operation);
public UpdateDeleteResult updateMessage(Message message, MessageOperation operation) throws AblyException {
Copy link
Collaborator

@sacOO7 sacOO7 Jan 19, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This seems like a blocking method. Was this a blocking method before as well?
If so, we can mark it as @Blocking for users wdyt?

Copy link
Collaborator

@sacOO7 sacOO7 Jan 19, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Similarly goes for updateMessage and similar methods

Copy link
Collaborator

@sacOO7 sacOO7 Jan 19, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We are already using org.jetbrains.annotations in liveobjects public API, so we can use them here as well wdyt? This will be reflected in the API documentation and will be helpful for LLMs to choose right public API depending on the use-case

Copy link
Collaborator

@sacOO7 sacOO7 Jan 19, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hmm.. we are also using them in lib/src/main/java/io/ably/lib/types/UpdateDeleteResult.java

return messageEditsMixin.updateMessage(ably.http, message, operation);
}

/**
Expand All @@ -1228,34 +1230,35 @@ public void updateMessage(Message message, MessageOperation operation) throws Ab
* @param message A {@link Message} object containing the fields to update and the serial identifier.
* Only non-null fields will be applied to the existing message.
* @throws AblyException If the update operation fails.
* @return A {@link UpdateDeleteResult} containing the updated message version serial.
*/
public void updateMessage(Message message) throws AblyException {
updateMessage(message, null);
public UpdateDeleteResult updateMessage(Message message) throws AblyException {
return updateMessage(message, null);
}

/**
* Asynchronously updates an existing message.
*
* @param message A {@link Message} object containing the fields to update and the serial identifier.
* @param operation operation metadata such as clientId, description, or metadata in the version field
* @param listener A listener to be notified of the outcome of this operation.
* @param callback A callback to be notified of the outcome of this operation.
* <p>
* This listener is invoked on a background thread.
* This callback is invoked on a background thread.
*/
public void updateMessageAsync(Message message, MessageOperation operation, CompletionListener listener) {
messageEditsMixin.updateMessageAsync(ably.http, message, operation, listener);
public void updateMessageAsync(Message message, MessageOperation operation, Callback<UpdateDeleteResult> callback) {
Copy link
Collaborator

@sacOO7 sacOO7 Jan 19, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This can be marked as @NonBlocking. Same goes for all methods that take callback as a param.

messageEditsMixin.updateMessageAsync(ably.http, message, operation, callback);
}

/**
* Asynchronously updates an existing message.
*
* @param message A {@link Message} object containing the fields to update and the serial identifier.
* @param listener A listener to be notified of the outcome of this operation.
* @param callback A callback to be notified of the outcome of this operation.
* <p>
* This listener is invoked on a background thread.
* This callback is invoked on a background thread.
*/
public void updateMessageAsync(Message message, CompletionListener listener) {
updateMessageAsync(message, null, listener);
public void updateMessageAsync(Message message, Callback<UpdateDeleteResult> callback) {
updateMessageAsync(message, null, callback);
}

/**
Expand All @@ -1268,9 +1271,10 @@ public void updateMessageAsync(Message message, CompletionListener listener) {
* @param message A {@link Message} message containing the serial identifier.
* @param operation operation metadata such as clientId, description, or metadata in the version field
* @throws AblyException If the delete operation fails.
* @return A {@link UpdateDeleteResult} containing the deleted message version serial.
*/
public void deleteMessage(Message message, MessageOperation operation) throws AblyException {
messageEditsMixin.deleteMessage(ably.http, message, operation);
public UpdateDeleteResult deleteMessage(Message message, MessageOperation operation) throws AblyException {
return messageEditsMixin.deleteMessage(ably.http, message, operation);
}

/**
Expand All @@ -1282,34 +1286,83 @@ public void deleteMessage(Message message, MessageOperation operation) throws Ab
*
* @param message A {@link Message} message containing the serial identifier.
* @throws AblyException If the delete operation fails.
* @return A {@link UpdateDeleteResult} containing the deleted message version serial.
*/
public void deleteMessage(Message message) throws AblyException {
deleteMessage(message, null);
public UpdateDeleteResult deleteMessage(Message message) throws AblyException {
return deleteMessage(message, null);
}

/**
* Asynchronously marks a message as deleted.
*
* @param message A {@link Message} object containing the serial identifier and operation metadata.
* @param operation operation metadata such as clientId, description, or metadata in the version field
* @param listener A listener to be notified of the outcome of this operation.
* @param callback A callback to be notified of the outcome of this operation.
* <p>
* This listener is invoked on a background thread.
* This callback is invoked on a background thread.
*/
public void deleteMessageAsync(Message message, MessageOperation operation, CompletionListener listener) {
messageEditsMixin.deleteMessageAsync(ably.http, message, operation, listener);
public void deleteMessageAsync(Message message, MessageOperation operation, Callback<UpdateDeleteResult> callback) {
messageEditsMixin.deleteMessageAsync(ably.http, message, operation, callback);
}

/**
* Asynchronously marks a message as deleted.
*
* @param message A {@link Message} object containing the serial identifier and operation metadata.
* @param listener A listener to be notified of the outcome of this operation.
* @param callback A callback to be notified of the outcome of this operation.
* <p>
* This listener is invoked on a background thread.
* This callback is invoked on a background thread.
*/
public void deleteMessageAsync(Message message, Callback<UpdateDeleteResult> callback) {
deleteMessageAsync(message, null, callback);
}

/**
* Appends message text to the end of the message.
Copy link
Collaborator

@sacOO7 sacOO7 Jan 19, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
* Appends message text to the end of the message.
* Appends message text to the end of the message data.

Copy link
Collaborator

@sacOO7 sacOO7 Jan 19, 2026 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Same goes for other appendMessage methods.
Btw, what happens when message.data isn't a string?
Does it throw an error? Can you also add one more test for the same?

*
* @param message A {@link Message} object containing the serial identifier and data to append.
* @param operation operation details such as clientId, description, or metadata
* @return A {@link UpdateDeleteResult} containing the updated message version serial.
* @throws AblyException If the append operation fails.
*/
public UpdateDeleteResult appendMessage(Message message, MessageOperation operation) throws AblyException {
return messageEditsMixin.appendMessage(ably.http, message, operation);
}

/**
* Appends message text to the end of the message.
*
* @param message A {@link Message} object containing the serial identifier and data to append.
* @return A {@link UpdateDeleteResult} containing the updated message version serial.
* @throws AblyException If the append operation fails.
*/
public UpdateDeleteResult appendMessage(Message message) throws AblyException {
return appendMessage(message, null);
}

/**
* Asynchronously appends message text to the end of the message.
*
* @param message A {@link Message} object containing the serial identifier and data to append.
* @param operation operation details such as clientId, description, or metadata
* @param callback A callback to be notified of the outcome of this operation.
* <p>
* This callback is invoked on a background thread.
*/
public void appendMessageAsync(Message message, MessageOperation operation, Callback<UpdateDeleteResult> callback) {
messageEditsMixin.appendMessageAsync(ably.http, message, operation, callback);
}

/**
* Asynchronously appends message text to the end of the message.
*
* @param message A {@link Message} object containing the serial identifier and data to append.
* @param callback A callback to be notified of the outcome of this operation.
* <p>
* This callback is invoked on a background thread.
*/
public void deleteMessageAsync(Message message, CompletionListener listener) {
deleteMessageAsync(message, null, listener);
public void appendMessageAsync(Message message, Callback<UpdateDeleteResult> callback) {
appendMessageAsync(message, null, callback);
}

/**
Expand Down
101 changes: 77 additions & 24 deletions lib/src/main/java/io/ably/lib/rest/ChannelBase.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@
import io.ably.lib.types.Param;
import io.ably.lib.types.PresenceMessage;
import io.ably.lib.types.PresenceSerializer;
import io.ably.lib.types.UpdateDeleteResult;
import io.ably.lib.util.Crypto;

/**
Expand Down Expand Up @@ -352,9 +353,10 @@ public void getMessageAsync(String serial, Callback<Message> callback) {
* Only non-null fields will be applied to the existing message.
* @param operation operation metadata such as clientId, description, or metadata in the version field
* @throws AblyException If the update operation fails.
* @return A {@link UpdateDeleteResult} containing the updated message version serial.
*/
public void updateMessage(Message message, MessageOperation operation) throws AblyException {
messageEditsMixin.updateMessage(ably.http, message, operation);
public UpdateDeleteResult updateMessage(Message message, MessageOperation operation) throws AblyException {
return messageEditsMixin.updateMessage(ably.http, message, operation);
}

/**
Expand All @@ -366,34 +368,35 @@ public void updateMessage(Message message, MessageOperation operation) throws Ab
* @param message A {@link Message} object containing the fields to update and the serial identifier.
* Only non-null fields will be applied to the existing message.
* @throws AblyException If the update operation fails.
* @return A {@link UpdateDeleteResult} containing the updated message version serial.
*/
public void updateMessage(Message message) throws AblyException {
updateMessage(message, null);
public UpdateDeleteResult updateMessage(Message message) throws AblyException {
return updateMessage(message, null);
}

/**
* Asynchronously updates an existing message.
*
* @param message A {@link Message} object containing the fields to update and the serial identifier.
* @param operation operation metadata such as clientId, description, or metadata in the version field
* @param listener A listener to be notified of the outcome of this operation.
* @param callback A callback to be notified of the outcome of this operation.
* <p>
* This listener is invoked on a background thread.
* This callback is invoked on a background thread.
*/
public void updateMessageAsync(Message message, MessageOperation operation, CompletionListener listener) {
messageEditsMixin.updateMessageAsync(ably.http, message, operation, listener);
public void updateMessageAsync(Message message, MessageOperation operation, Callback<UpdateDeleteResult> callback) {
messageEditsMixin.updateMessageAsync(ably.http, message, operation, callback);
}

/**
* Asynchronously updates an existing message.
*
* @param message A {@link Message} object containing the fields to update and the serial identifier.
* @param listener A listener to be notified of the outcome of this operation.
* @param callback A callback to be notified of the outcome of this operation.
* <p>
* This listener is invoked on a background thread.
* This callback is invoked on a background thread.
*/
public void updateMessageAsync(Message message, CompletionListener listener) {
updateMessageAsync(message, null, listener);
public void updateMessageAsync(Message message, Callback<UpdateDeleteResult> callback) {
updateMessageAsync(message, null, callback);
}

/**
Expand All @@ -406,9 +409,10 @@ public void updateMessageAsync(Message message, CompletionListener listener) {
* @param message A {@link Message} message containing the serial identifier.
* @param operation operation metadata such as clientId, description, or metadata in the version field
* @throws AblyException If the delete operation fails.
* @return A {@link UpdateDeleteResult} containing the deleted message version serial.
*/
public void deleteMessage(Message message, MessageOperation operation) throws AblyException {
messageEditsMixin.deleteMessage(ably.http, message, operation);
public UpdateDeleteResult deleteMessage(Message message, MessageOperation operation) throws AblyException {
return messageEditsMixin.deleteMessage(ably.http, message, operation);
}

/**
Expand All @@ -420,34 +424,83 @@ public void deleteMessage(Message message, MessageOperation operation) throws Ab
*
* @param message A {@link Message} message containing the serial identifier.
* @throws AblyException If the delete operation fails.
* @return A {@link UpdateDeleteResult} containing the deleted message version serial.
*/
public void deleteMessage(Message message) throws AblyException {
deleteMessage(message, null);
public UpdateDeleteResult deleteMessage(Message message) throws AblyException {
return deleteMessage(message, null);
}

/**
* Asynchronously marks a message as deleted.
*
* @param message A {@link Message} object containing the serial identifier and operation metadata.
* @param operation operation metadata such as clientId, description, or metadata in the version field
* @param listener A listener to be notified of the outcome of this operation.
* @param callback A callback to be notified of the outcome of this operation.
* <p>
* This listener is invoked on a background thread.
* This callback is invoked on a background thread.
*/
public void deleteMessageAsync(Message message, MessageOperation operation, CompletionListener listener) {
messageEditsMixin.deleteMessageAsync(ably.http, message, operation, listener);
public void deleteMessageAsync(Message message, MessageOperation operation, Callback<UpdateDeleteResult> callback) {
messageEditsMixin.deleteMessageAsync(ably.http, message, operation, callback);
}

/**
* Asynchronously marks a message as deleted.
*
* @param message A {@link Message} object containing the serial identifier and operation metadata.
* @param listener A listener to be notified of the outcome of this operation.
* @param callback A callback to be notified of the outcome of this operation.
* <p>
* This listener is invoked on a background thread.
* This callback is invoked on a background thread.
*/
public void deleteMessageAsync(Message message, Callback<UpdateDeleteResult> callback) {
deleteMessageAsync(message, null, callback);
}

/**
* Appends message text to the end of the message.
*
* @param message A {@link Message} object containing the serial identifier and data to append.
* @param operation operation details such as clientId, description, or metadata
* @return A {@link UpdateDeleteResult} containing the updated message version serial.
* @throws AblyException If the append operation fails.
*/
public UpdateDeleteResult appendMessage(Message message, MessageOperation operation) throws AblyException {
return messageEditsMixin.appendMessage(ably.http, message, operation);
}

/**
* Appends message text to the end of the message.
*
* @param message A {@link Message} object containing the serial identifier and data to append.
* @return A {@link UpdateDeleteResult} containing the updated message version serial.
* @throws AblyException If the append operation fails.
*/
public UpdateDeleteResult appendMessage(Message message) throws AblyException {
return appendMessage(message, null);
}

/**
* Asynchronously appends message text to the end of the message.
*
* @param message A {@link Message} object containing the serial identifier and data to append.
* @param operation operation details such as clientId, description, or metadata
* @param callback A callback to be notified of the outcome of this operation.
* <p>
* This callback is invoked on a background thread.
*/
public void appendMessageAsync(Message message, MessageOperation operation, Callback<UpdateDeleteResult> callback) {
messageEditsMixin.appendMessageAsync(ably.http, message, operation, callback);
}

/**
* Asynchronously appends message text to the end of the message.
*
* @param message A {@link Message} object containing the serial identifier and data to append.
* @param callback A callback to be notified of the outcome of this operation.
* <p>
* This callback is invoked on a background thread.
*/
public void deleteMessageAsync(Message message, CompletionListener listener) {
deleteMessageAsync(message, null, listener);
public void appendMessageAsync(Message message, Callback<UpdateDeleteResult> callback) {
appendMessageAsync(message, null, callback);
}

/**
Expand Down
Loading
Loading