Skip to content

Conversation

@ttypic
Copy link
Contributor

@ttypic ttypic commented Aug 26, 2025

This release introduces experimental support for Live Objects, providing realtime, collaborative data structures that automatically synchronize state across all connected clients.

Implemented enhancements:

  • Experimental support for Live Objects has been added. Note: This feature is experimental and the API may change in future releases.

Summary by CodeRabbit

  • Documentation
    • Added release notes for v1.3.0 including LiveObjects support and related getting-started links; updated README and CONTRIBUTING examples to reference v1.3.0.
  • Bug Fixes
    • Notes that v1.2.54 includes minor improvements: prevented a null-pointer issue in connectivity checks and fixed async connection state transition side effects.
  • Tests
    • Updated expected user-agent version in realtime websocket header test to 1.3.0.
  • Chores
    • Bumped project version to 1.3.0.

@ttypic ttypic requested review from sacOO7 and umair-ably August 26, 2025 17:40
@coderabbitai
Copy link

coderabbitai bot commented Aug 26, 2025

Walkthrough

Bumps project version to 1.3.0 across docs, build properties, and a test expectation; adds a new 1.3.0 CHANGELOG entry mentioning LiveObjects. No code or public API changes.

Changes

Cohort / File(s) Summary of Changes
Changelog update
CHANGELOG.md
Added new top-level 1.3.0 release entry with Full Changelog link, "What's Changed" describing LiveObjects support (LiveObjects Swift Plugin), and two documentation links; augmented 1.2.54 block with minor improvements and two implemented enhancements.
Documentation version bumps
CONTRIBUTING.md, README.md
Updated dependency/AAR version references from 1.2.54 to 1.3.0 in installation and usage examples (Maven, Gradle, LiveObjects, proxy OkHttp snippets).
Build property
gradle.properties
Updated VERSION_NAME from 1.2.54 to 1.3.0.
Test expectation
lib/src/test/java/io/ably/lib/test/realtime/RealtimeHttpHeaderTest.java
Adjusted expected websocket agent header string from ably-java/1.2.54 ... to ably-java/1.3.0 ....

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Poem

I thump to mark a version hop,
From 1.2.54 to 1.3.0 I pop!
Docs and headers all align,
A tiny hop — the code’s fine. 🥕

Tip

🔌 Remote MCP (Model Context Protocol) integration is now available!

Pro plan users can now connect to remote MCP servers from the Integrations page. Connect with popular remote MCPs such as Notion and Linear to add more context to your reviews and chats.


📜 Recent review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

💡 Knowledge Base configuration:

  • MCP integration is disabled by default for public repositories
  • Jira integration is disabled by default for public repositories
  • Linear integration is disabled by default for public repositories

You can enable these sources in your CodeRabbit configuration.

📥 Commits

Reviewing files that changed from the base of the PR and between 62defc3 and c68dca8.

📒 Files selected for processing (1)
  • CHANGELOG.md (1 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • CHANGELOG.md
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (11)
  • GitHub Check: check-rest-okhttp
  • GitHub Check: check-rest
  • GitHub Check: check (29)
  • GitHub Check: check-liveobjects
  • GitHub Check: check-realtime-okhttp
  • GitHub Check: check-realtime
  • GitHub Check: check (29)
  • GitHub Check: check (19)
  • GitHub Check: check (24)
  • GitHub Check: check (21)
  • GitHub Check: check
✨ Finishing Touches
🧪 Generate unit tests
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch release/1.3.0

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.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbit in a new review comment at the desired location with your query.
  • PR comments: Tag @coderabbit 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:
    • @coderabbit gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbit read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Support

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

CodeRabbit Commands (Invoked using PR/Issue comments)

Type @coderabbit help to get the list of available commands.

Other keywords and placeholders

  • Add @coderabbit ignore or @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbit summary or @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbit or @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

Status, Documentation and Community

  • Visit our Status Page to check the current availability of CodeRabbit.
  • 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.

@github-actions github-actions bot temporarily deployed to staging/pull/1156/features August 26, 2025 17:40 Inactive
@github-actions github-actions bot temporarily deployed to staging/pull/1156/features August 26, 2025 17:41 Inactive
@github-actions github-actions bot temporarily deployed to staging/pull/1156/javadoc August 26, 2025 17:44 Inactive
Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 0

🧹 Nitpick comments (4)
lib/src/test/java/io/ably/lib/test/realtime/RealtimeHttpHeaderTest.java (1)

90-92: Tests correctly reference VERSION_NAME; optional refactor to derive version from metadata

All checks confirm the test’s hard-coded version (1.3.0) matches gradle.properties. No blocking issues remain.

• Optional refactor: replace the literal "ably-java/1.3.0" with a lookup using your package’s implementation metadata, e.g.

String version = YourClass.class.getPackage().getImplementationVersion();
assertEquals("Verify correct lib version",
    requestParameters.get("agent"),
    Collections.singletonList("ably-java/" + (version != null ? version : "1.3.0")
        + " jre/" + System.getProperty("java.version")));

This keeps the test aligned automatically on each release.

CONTRIBUTING.md (1)

238-239: Use a variable placeholder for the AAR version in CONTRIBUTING.md

To avoid having to update this example on every release, replace the hard-coded version with a placeholder—just like other docs:

• File: CONTRIBUTING.md, line 238
• Change the AAR reference to use ${ABLY_VERSION}

- implementation files('libs/ably-android-1.3.0.aar')
+ implementation files("libs/ably-android-${ABLY_VERSION}.aar")
README.md (2)

145-145: OkHttp engine dependency updated to 1.3.0 — LGTM

If you plan to promote OkHttp usage more broadly, consider cross-linking to the section that explains swapping engines (already present in CONTRIBUTING).


116-116: Flag Live Objects as Experimental in README

The liveobjects module is correctly included and published:

  • settings.gradle.kts, line 18: include("liveobjects")
  • gradle.properties, line 1: GROUP=io.ably

To make its experimental status clear to users, add an inline comment in README.md (line 116):

-    runtimeOnly("io.ably:liveobjects:1.3.0")
+    runtimeOnly("io.ably:liveobjects:1.3.0") // Experimental: API may change
📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

💡 Knowledge Base configuration:

  • MCP integration is disabled by default for public repositories
  • Jira integration is disabled by default for public repositories
  • Linear integration is disabled by default for public repositories

You can enable these sources in your CodeRabbit configuration.

📥 Commits

Reviewing files that changed from the base of the PR and between 39c62f6 and 62defc3.

📒 Files selected for processing (5)
  • CHANGELOG.md (1 hunks)
  • CONTRIBUTING.md (1 hunks)
  • README.md (3 hunks)
  • gradle.properties (1 hunks)
  • lib/src/test/java/io/ably/lib/test/realtime/RealtimeHttpHeaderTest.java (1 hunks)
🧰 Additional context used
🧠 Learnings (4)
📓 Common learnings
Learnt from: sacOO7
PR: ably/ably-java#1151
File: lib/src/main/java/io/ably/lib/objects/type/counter/LiveCounter.java:15-15
Timestamp: 2025-08-19T10:42:35.254Z
Learning: The ably-java library has not had any official releases yet, so breaking changes to public APIs (like adding new abstract methods to interfaces) are acceptable during the pre-release development phase.
📚 Learning: 2025-06-05T10:27:53.946Z
Learnt from: sacOO7
PR: ably/ably-java#1095
File: gradle/libs.versions.toml:24-26
Timestamp: 2025-06-05T10:27:53.946Z
Learning: The ably-java project prefers to use the latest available versions of testing dependencies (including pre-release versions) when they contain relevant bug fixes, rather than sticking strictly to stable releases.

Applied to files:

  • gradle.properties
  • README.md
  • CHANGELOG.md
📚 Learning: 2025-08-19T10:42:35.254Z
Learnt from: sacOO7
PR: ably/ably-java#1151
File: lib/src/main/java/io/ably/lib/objects/type/counter/LiveCounter.java:15-15
Timestamp: 2025-08-19T10:42:35.254Z
Learning: The ably-java library has not had any official releases yet, so breaking changes to public APIs (like adding new abstract methods to interfaces) are acceptable during the pre-release development phase.

Applied to files:

  • README.md
  • CHANGELOG.md
📚 Learning: 2025-08-14T10:43:57.974Z
Learnt from: sacOO7
PR: ably/ably-java#1148
File: lib/src/main/java/io/ably/lib/objects/ObjectsHelper.java:24-25
Timestamp: 2025-08-14T10:43:57.974Z
Learning: In the ably-java LiveObjects renaming effort, log messages may intentionally retain "LiveObjects" terminology even when other parts of the codebase are being renamed to "Objects", due to internal technical debates about where the renaming should be applied. The team makes deliberate decisions about which parts of the codebase to rename versus which to keep as-is.

Applied to files:

  • CHANGELOG.md
🪛 markdownlint-cli2 (0.17.2)
README.md

58-58: Trailing punctuation in heading
Punctuation: ':'

(MD026, no-trailing-punctuation)

⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (12)
  • GitHub Check: check (29)
  • GitHub Check: build
  • GitHub Check: check (24)
  • GitHub Check: check-rest-okhttp
  • GitHub Check: check (29)
  • GitHub Check: check (21)
  • GitHub Check: check-realtime-okhttp
  • GitHub Check: check (19)
  • GitHub Check: check-liveobjects
  • GitHub Check: check
  • GitHub Check: check-realtime
  • GitHub Check: check-rest
🔇 Additional comments (4)
gradle.properties (1)

2-2: Version bump to 1.3.0 — no stale references remain

  • Scanned for “1.2.54” across the repo (excluding build/**) and only historical entries were found in CHANGELOG.md, which are expected.
  • Verified all code/tests/docs now reference “1.3.0” (e.g. RealtimeHttpHeaderTest.java line 91).

Everything’s in sync and ready for tagging.

CHANGELOG.md (1)

3-12: CHANGELOG.md compare link validated

  • New 1.3.0 entry is clear, concise, and the compare link format has been confirmed in CHANGELOG.md (lines 3–12).
  • Optional nit: for consistency with past entries, consider appending the release date to the heading (e.g., “## 1.3.0 – 2025-08-26”).

✅ No blockers.

README.md (2)

54-54: Maven coordinates bumped to 1.3.0 — LGTM


61-61: Gradle notation updated to 1.3.0 — LGTM

Copy link
Collaborator

@sacOO7 sacOO7 left a comment

Choose a reason for hiding this comment

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

LGTM

@sacOO7
Copy link
Collaborator

sacOO7 commented Aug 27, 2025

Do we also need liveobjects README similar to swift plugin?

@github-actions github-actions bot temporarily deployed to staging/pull/1156/features August 28, 2025 11:35 Inactive
@ttypic ttypic merged commit f94b846 into main Aug 28, 2025
14 checks passed
@ttypic ttypic deleted the release/1.3.0 branch August 28, 2025 12:17
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Development

Successfully merging this pull request may close these issues.

3 participants