Skip to content

Conversation

@ttypic
Copy link
Collaborator

@ttypic ttypic commented Oct 30, 2025

This branch contains the changes for release 1.1.0.

Summary by CodeRabbit

  • New Features

    • New connection status states: closing and closed for finer connection-state visibility.
  • Documentation

    • Added 1.1.0 release entry to the changelog; updated installation instructions to reference 1.1.0.
  • Chores

    • Bumped release version to 1.1.0 and updated a dependency to a newer patch release.

@ttypic ttypic requested a review from AndyTWF October 30, 2025 14:40
@coderabbitai
Copy link

coderabbitai bot commented Oct 30, 2025

Walkthrough

Adds a 1.1.0 release: bumps project and dependency versions, updates README and CHANGELOG, and introduces two new ConnectionStatus enum members: closing and closed (previously mapped to failed).

Changes

Cohort / File(s) Summary
Release Documentation
CHANGELOG.md, README.md
Adds a 1.1.0 changelog entry (Bug Fixes) noting ConnectionStatus expansion; updates installation examples from 1.0.0 to 1.1.0 in README.
Project Version Configuration
gradle.properties, gradle/libs.versions.toml
Bumps VERSION_NAME from 1.0.0 to 1.1.0; updates ably version from 1.4.1 to 1.4.2 in gradle/libs.versions.toml.
Enum State Expansion
ConnectionStatus (referenced in CHANGELOG.md)
Adds public enum members closing and closed to ConnectionStatus (previously folded into failed); CHANGELOG notes exhaustive when/switch handling for these new cases.

Sequence Diagram(s)

sequenceDiagram
  participant Caller as Application code
  participant Status as ConnectionStatus (enum)
  participant Logic as State handling (when/switch)

  Note over Status,Logic: New enum values added: closing, closed

  Caller->>Logic: query current ConnectionStatus
  Logic->>Status: read value (e.g., closing)
  alt handled explicitly
    Logic->>Caller: handle closing/closed branch
  else not updated
    Logic->>Caller: fallthrough or default (previously treated as failed)
  end
  Note right of Logic: Update when/switch to be exhaustive for closing/closed
Loading

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~20 minutes

  • Check places where ConnectionStatus is pattern-matched (when/switch) for missing closing/closed branches.
  • Verify consumers compiled against the updated enum (ABI/source compatibility).
  • Confirm VERSION_NAME and README examples are consistent.
  • Validate ably:1.4.2 upgrade is safe for this project.

Suggested reviewers

  • AndyTWF
  • umair-ably

Poem

🐰 A tiny hop from one-oh to one-one,
Two new states twinkle — closing and done,
Docs and versions all neatly aligned,
A release carrot for coders to find! 🥕

Pre-merge checks and finishing touches

❌ Failed checks (1 warning)
Check name Status Explanation Resolution
Docstring Coverage ⚠️ Warning Docstring coverage is 0.00% which is insufficient. The required threshold is 80.00%. You can run @coderabbitai generate docstrings to improve docstring coverage.
✅ Passed checks (2 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title Check ✅ Passed The pull request title "Release v1.1.0" is directly related to the primary objective of this changeset. The modifications across multiple files—version bumps in gradle.properties and README.md from 1.0.0 to 1.1.0, a new CHANGELOG.md entry for version 1.1.0, and related enum updates—all align with preparing a release for version 1.1.0. The title is concise, specific, and clearly communicates to someone scanning the repository history that this PR represents a release milestone, which is the main intent as stated in the PR description.
✨ Finishing touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch release/1.1.0

📜 Recent review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

Disabled knowledge base sources:

  • Jira 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 f84e31e and 377b596.

📒 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). (6)
  • GitHub Check: build
  • GitHub Check: coverage
  • GitHub Check: test (Android Release tests, testReleaseUnitTest)
  • GitHub Check: test (JVM tests, jvmTest)
  • GitHub Check: test (Android Debug tests, testDebugUnitTest)
  • GitHub Check: check

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

Comment @coderabbitai help to get the list of available commands and usage tips.

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: 1

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

Disabled knowledge base sources:

  • Jira 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 3643660 and f84e31e.

📒 Files selected for processing (4)
  • CHANGELOG.md (1 hunks)
  • README.md (1 hunks)
  • gradle.properties (1 hunks)
  • gradle/libs.versions.toml (1 hunks)
🧰 Additional context used
🧠 Learnings (1)
📚 Learning: 2025-02-14T13:26:06.027Z
Learnt from: sacOO7
PR: ably/ably-chat-kotlin#100
File: chat-android/src/test/java/com/ably/chat/integration/MessagesIntegrationTest.kt:203-250
Timestamp: 2025-02-14T13:26:06.027Z
Learning: In the Ably Chat Kotlin SDK, all messages (including deleted ones) are preserved in history as immutable events/records. Message deletion is implemented as a soft delete operation that adds a deletion event rather than removing the message from history.

Applied to files:

  • CHANGELOG.md
  • README.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). (6)
  • GitHub Check: build
  • GitHub Check: coverage
  • GitHub Check: check
  • GitHub Check: test (Android Debug tests, testDebugUnitTest)
  • GitHub Check: test (Android Release tests, testReleaseUnitTest)
  • GitHub Check: test (JVM tests, jvmTest)
🔇 Additional comments (4)
README.md (1)

48-48: Installation examples correctly updated to v1.1.0.

Version bumps in both Groovy and Kotlin Script installation blocks are consistent with gradle.properties and follow the established format.

Also applies to: 54-54

gradle.properties (1)

21-21: VERSION_NAME correctly bumped to 1.1.0 for Maven publishing.

Version update is consistent across gradle.properties, README.md, and CHANGELOG.md. Publishing metadata unchanged.

CHANGELOG.md (1)

3-9: v1.1.0 release entry is well-documented.

The changelog entry correctly documents the ConnectionStatus enum additions and references the originating PR #184. Version links and format are consistent with previous releases (1.0.0 section at line 11).

gradle/libs.versions.toml (1)

5-5: Verify whether ably 1.4.2 is required for these changes.

The ConnectionStatus enum changes (adding closing and closed states) are documented in the ably-chat-kotlin v1.1.0 changelog, while ably-java 1.4.2 addresses a separate issue: async requests failing after reconnection. These are distinct concerns, and no evidence shows 1.4.2 is required for the ConnectionStatus changes. Confirm whether this bump is needed for integration stability or other dependencies in this PR, or if 1.4.1 remains compatible.

@github-actions
Copy link

Code Coverage

Total Project Coverage 85.41%

@ttypic ttypic merged commit 1ac4e5d into main Oct 30, 2025
7 checks passed
@ttypic ttypic deleted the release/1.1.0 branch October 30, 2025 15:19
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