feat(notifications): Add WebSocket and Server-Sent Event channels#162
Draft
laurensdeb wants to merge 14 commits into
Draft
feat(notifications): Add WebSocket and Server-Sent Event channels#162laurensdeb wants to merge 14 commits into
laurensdeb wants to merge 14 commits into
Conversation
Introduce a notifications subsystem for LWS with three channels: Server-Sent Events, WebSocket, and Webhooks. Key design decisions: - Single NotificationService with subscriptionType array - LWS-specific envelope wrapping Activity Streams 2.0 events - phase property (post-commit) for future admission controller extensibility - topic property for subscription targets (avoids items collision) - Webhook authentication via HTTP Message Signatures (RFC 9421) - inbox aligned with access-request-grant-proposal pattern Files: - lws10-notifications/index.html: New subspecification - lws10-core/Discovery.html: Updated NotificationService example - README.md: Added notifications to specs list
- Clarify MAY support / MUST advertise pattern for notifications - Make phase OPTIONAL, use PascalCase (PostCommit) - Remove forward references to future specifications - Add Subscriber to terminology, use consistently throughout - Add Subscription Scope section (recursive container subscriptions) - Add Subscription Authorization section (delivery-time authz, subcontainer filtering, authorization change handling) - Tighten object structure normatively (nested id/type requirements) - Add authentication verification relationship per CID 1.0 - Add Activity Streams 2.0 terms to vocabulary table - Add PostCommit as vocabulary term - Source external terms from CID-1.0 instead of generic Security Vocab
Replace the Webhook Endpoint term with Inbox — a URL controlled by a subscriber or other agent to which a server delivers notifications via HTTP POST. This aligns with the inbox concept used in the access-request-grant-proposal and makes the term reusable across LWS subspecifications.
Reference the lws10-notifications specification with a summary of the three notification channels (SSE, WebSocket, Webhooks) and shared data model.
Remove WebSocket and Server-Sent Event notification channels from the base notifications specification. These client-server streaming channels will be introduced in a separate specification. Remove the phase property from the notification envelope and subscription request. This concept may be re-introduced at a later point.
Introduce client-server streaming notification channels: - WebSocket: persistent bidirectional connection for real-time events - Server-Sent Events (EventSource): persistent HTTP stream for real-time events Both channels use capability URLs for connection establishment and share the common notification envelope defined in the base specification.
Contributor
Author
|
See preview |
Member
|
@laurensdeb I think this one needs a rebase |
Member
|
I see three main options here, two of them are included in this PR
Each one comes with some trade-offs. One of main limiting factor is how currently subscription is defined in https://w3c.github.io/lws-protocol/lws10-notifications/#subscriptions Websockets👍
👎
SSE👍
👎
Streaming HTTP👍
👎
With Streaming HTTP I only implemented streams with a single topic via GET, where URL can be discovered via link header and it doesn't use subscription step thanks to @CxRes has more experience with |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This is a class 4 change to the protocol. It will need discussion and a WG vote before merging.
This PR adds client-server streaming notification channels on top of the base notifications specification (#161):
Both channels use capability URLs for connection establishment and share the common notification envelope defined in the base specification.
Depends on #161
Preview | Diff