Release version 0.4.0

[lawrence-forooghian]

Note: This release contains a major version bump to ably-cocoa-plugin-support and thus will follow the release process described in https://github.com/ably/ably-cocoa-plugin-support?tab=readme-ov-file#release-process-for-breaking-plugin-support-changes. That is, we must first get this and ably/ably-cocoa#2197 approved, then merge the ably-cocoa release, then update this release PR.

Docs PR: ably/docs#3240

Summary by CodeRabbit

• Improvements
  • Mutations now apply their effects to local data as soon as the server acknowledges them (before any echo), so fetched values and local state reflect confirmed changes immediately—improved responsiveness with no public API changes.
• Documentation
  • Added a 0.4.0 changelog entry detailing the new mutation behavior and linking the full changelog.

[coderabbitai]

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info

⚙️ Run configuration

Configuration used: Repository UI

Review profile: CHILL

Plan: Pro

Run ID: 46088d24-3048-4a5d-a46f-feba61f4f0ca

📥 Commits

Reviewing files that changed from the base of the PR and between 8bce1a2 and 8aaaab3.

📒 Files selected for processing (4)

• AblyLiveObjects.xcworkspace/xcshareddata/swiftpm/Package.resolved
• CHANGELOG.md
• Package.resolved
• Package.swift

🚧 Files skipped from review as they are similar to previous changes (1)

• CHANGELOG.md

---

Walkthrough

The CHANGELOG.md adds a 0.4.0 entry describing that mutations now apply effects to local data upon server acknowledgement (rather than after echo). Package dependency resolution and Package.swift were changed to reference ably-cocoa v1.2.59.

Changes

Cohort / File(s)	Summary
Changelog Documentation CHANGELOG.md	Added 0.4.0 entry: mutations now apply local effects on server acknowledgement instead of after echo; includes example, note of no public API changes, and "Other changes" list.
Swift Package manifest Package.swift	Replaced a pinned ably-cocoa revision with a version-based requirement from: "1.2.59" and removed the pin comment.
Resolved dependency files Package.resolved, AblyLiveObjects.xcworkspace/xcshareddata/swiftpm/Package.resolved	Updated ably-cocoa revision and added state.version: "1.2.59"; updated originHash values for dependency resolution.

Sequence Diagram(s)

sequenceDiagram
participant Client
participant LocalStore
participant Server
participant Echo

Client->>Server: send mutation
alt new behavior
Server-->>Client: acknowledgement (ack)
Client->>LocalStore: apply mutation (on ack)
Server->>Echo: broadcast mutation echo
Echo-->>Client: echo arrives later (no-op for local state)
end

Loading

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Poem

🐰 I hopped through lines both new and neat,
Acks now make the local state complete,
No more waiting for echoes to play,
The rabbits cheer — hooray, hooray! 🥕

🚥 Pre-merge checks | ✅ 3

✅ Passed checks (3 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title 'Release version 0.4.0' directly and accurately describes the main purpose of the changeset—creating a release for version 0.4.0.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

✨ Finishing Touches

• 📝 Generate docstrings (stacked PR)
• 📝 Generate docstrings (commit on current branch)

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Post copyable unit tests in a comment
• Commit unit tests in branch release/0.4.0

📝 Coding Plan

• Generate coding plan for human review comments

---

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

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