Skip to content

feat(realtime): introduce message-based protocol for subscriptions#2934

Merged
atharvadeosthale merged 7 commits intomainfrom
feat/realtime-message-based-sdk-announcement
Apr 29, 2026
Merged

feat(realtime): introduce message-based protocol for subscriptions#2934
atharvadeosthale merged 7 commits intomainfrom
feat/realtime-message-based-sdk-announcement

Conversation

@eldadfux
Copy link
Copy Markdown
Member

  • Added a new blog post detailing the transition to a single persistent WebSocket for Appwrite Realtime, allowing for incremental subscription changes without reconnecting.
  • Updated changelog to reflect the new Realtime features, including per-subscription lifecycle management and in-place updates.
  • Enhanced documentation across various SDKs to clarify subscription management and lifecycle handling.

This update improves performance and usability for developers using Appwrite's Realtime features.

What does this PR do?

(Provide a description of what this PR does.)

Test Plan

(Write your test plan here. If you changed any code, please provide us with clear instructions on how you verified your changes work.)

Related PRs and Issues

(If this PR is related to any other PR or resolves any issue or related to any issue link all related PR and issues here.)

Have you read the Contributing Guidelines on issues?

(Write your answer here.)

- Added a new blog post detailing the transition to a single persistent WebSocket for Appwrite Realtime, allowing for incremental subscription changes without reconnecting.
- Updated changelog to reflect the new Realtime features, including per-subscription lifecycle management and in-place updates.
- Enhanced documentation across various SDKs to clarify subscription management and lifecycle handling.

This update improves performance and usability for developers using Appwrite's Realtime features.
@greptile-apps
Copy link
Copy Markdown
Contributor

greptile-apps Bot commented Apr 28, 2026

Greptile Summary

This PR introduces a new blog post and changelog entry announcing the message-based Realtime protocol (single persistent WebSocket with incremental subscription changes), and updates the Realtime docs (subscribe, channels, queries, overview) to reflect the new update(), unsubscribe(), and disconnect() lifecycle APIs. It also corrects the Android Kotlin import path from io.appwrite.extensions.Channel to io.appwrite.Channel across all affected doc pages.

Confidence Score: 5/5

Safe to merge — only documentation and blog content changes, no production code affected

All findings are P2 style suggestions. The single inconsistency (missing await on disconnect() in the blog post Web snippet) is a docs-only issue and does not affect any runtime behaviour.

No files require special attention beyond the one inline suggestion on the blog post

Important Files Changed

Filename Overview
src/routes/blog/post/announcing-message-based-realtime-sdk/+page.markdoc New announcement blog post covering message-based realtime protocol; one Web example omits await on disconnect() inconsistently with all other platforms
src/routes/changelog/(entries)/2026-04-29.markdoc New changelog entry summarising the persistent-WebSocket and message-based subscription changes; content is accurate and well-scoped
src/routes/docs/apis/realtime/+page.markdoc Updated Android Kotlin import path (io.appwrite.Channel replaces io.appwrite.extensions.Channel) and minor prose clarifications; no issues
src/routes/docs/apis/realtime/channels/+page.markdoc Import path update only (io.appwrite.Channel); no issues
src/routes/docs/apis/realtime/queries/+page.markdoc Import path update only (io.appwrite.Channel); no issues
src/routes/docs/apis/realtime/subscribe/+page.markdoc Significant documentation update: new Update/Unsubscribe/Disconnect sections, import path corrections, and Apple unsubscribe example completed with endpoint/project; all platforms look consistent

Reviews (4): Last reviewed commit: "optimize" | Re-trigger Greptile

Comment thread src/routes/docs/apis/realtime/subscribe/+page.markdoc Outdated
Resolve Realtime docs conflicts: keep main subscribe/authentication pages,
merge subscription-changes copy on the Realtime overview, and restore the
intro sentence on subscribe about shared WebSocket and update/disconnect.

Made-with: Cursor
Comment thread src/routes/blog/post/announcing-message-based-realtime-sdk/+page.markdoc Outdated
@atharvadeosthale atharvadeosthale merged commit 2778aac into main Apr 29, 2026
6 checks passed
@atharvadeosthale atharvadeosthale deleted the feat/realtime-message-based-sdk-announcement branch April 29, 2026 16:06
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants