3.1.3 release

[ttypic]

What's Changed

• Fixed ping() so a timed-out, rejected, or connection-dropped ping no longer leaves a stale future behind that made every later ping() call fail or hang #687
• Annotation data is now encrypted on publish and decrypted on REST get() for channels with a cipher configured, instead of being sent in plaintext #680
• Fixed the "unable to attach" log to report the connection state that is blocking the attach rather than the channel state #653

Summary by CodeRabbit

• Bug Fixes

  • Fixed stale ping operations.
  • Improved annotation encryption and decryption when custom ciphers are configured.
  • Updated attach logs to accurately report blocking connection status.

• Release

  • Updated the library to version 3.1.3.

[coderabbitai]

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info

⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Advanced

Run ID: a24eb1e8-aaaa-48c0-a338-4887f5b314da

📥 Commits

Reviewing files that changed from the base of the PR and between 8e1adb7 and 8764af1.

⛔ Files ignored due to path filters (1)

• uv.lock is excluded by !**/*.lock

📒 Files selected for processing (3)

• CHANGELOG.md
• ably/__init__.py
• pyproject.toml

Included review availability: Your plan provides up to 1 included review per hour; 0 remain after this review.

---

Walkthrough

The release updates the package version from 3.1.2 to 3.1.3 and adds a changelog entry for three fixes.

Changes

3.1.3 Release Metadata

Layer / File(s)	Summary
Version and changelog pyproject.toml, ably/__init__.py, CHANGELOG.md	The package version changes to 3.1.3. The changelog records fixes for ping futures, encrypted annotations, and attach-state logging.

Priority: ⬇️ Low

Estimated code review effort: 1 (Trivial) | ~2 minutes

Merge Risk: ⚪ Minimal · up to 8764a

This release updates the package version to 3.1.3 and documents the included fixes. The release metadata is consistent and presents no current merge-readiness risk.

🚥 Pre-merge checks | ✅ 5

✅ Passed checks (5 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title clearly identifies the 3.1.3 release, which matches the version bumps and changelog update in the pull request.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 1…
Linked Issues check	✅ Passed	Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check	✅ Passed	Check skipped because no linked issues were found for this pull request.

✨ Finishing Touches

📝 Generate docstrings

• Create stacked PR
• Commit on current branch

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Commit unit tests in branch release/3.1.3

---

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

• X
• Mastodon
• Reddit
• LinkedIn

_{A rabbit checks the version line
Three fixes rest in notes so fine
The ping hops free, the cipher gleams
Attach logs report their state in dreams
Release 3.1.3 joins the stream}

_{Comment @coderabbitai help to get the list of available commands.}