Update MatrixRTC implementation #1029
There are no files selected for viewing
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,6 @@ | ||
| --- | ||
| '@nordeck/matrix-neoboard-widget': minor | ||
| '@nordeck/matrix-neoboard-react-sdk': minor | ||
| --- | ||
|
|
||
| Update MatrixRTC implementation |
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
| Original file line number | Diff line number | Diff line change | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|
| @@ -1,25 +1,30 @@ | ||||||||||
| # MatrixRTC Events Data Model | ||||||||||
|
|
||||||||||
| Having the option to use MatrixRTC as an alternative to WebRTC introduces some | ||||||||||
| changes: | ||||||||||
|
|
||||||||||
| We replace the `net.nordeck.whiteboard` state event with the MatrixRTC `m.rtc.slot` state event | ||||||||||
| (or the unstable `org.matrix.msc4143.rtc.slot`). | ||||||||||
|
|
||||||||||
| We replace the `net.nordeck.whiteboard.sessions` state event with the | ||||||||||
| MatrixRTC `m.rtc.member` membership **sticky** event (or the unstable `org.matrix.msc4143.rtc.member`). | ||||||||||
|
Contributor
There was a problem hiding this comment. A link to the sticky events MSC would be helpful here, no? |
||||||||||
|
|
||||||||||
| We no longer need to use To Device Messages for establishing peer connections. | ||||||||||
| All signaling and connection logic is now handled by the LiveKit Client SDK and LiveKit Server backend. | ||||||||||
|
|
||||||||||
| ## Room Events | ||||||||||
|
|
||||||||||
| The whiteboard state and RTC membership is stored using the following events in a Matrix room: | ||||||||||
|
|
||||||||||
| ``` | ||||||||||
| ┌───────────────────────────────────────────────────┐ | ||||||||||
| │ │ | ||||||||||
| │ org.matrix.msc4143.rtc.slot │ ┌───────────────────────────────┐ | ||||||||||
| │ state_key: net.nordeck.whiteboard#<whiteboard-id> │ content.slot_id │ │ | ||||||||||
| │ content.status: open │◄───────────────────┤ org.matrix.msc4143.rtc.member │ | ||||||||||
| │ content.application.type: net.nordeck.whiteboard │ │ │ | ||||||||||
| │ │ └───────────────────────────────┘ | ||||||||||
| └──┬────────────────────────────────────────────────┘ | ||||||||||
| │ | ||||||||||
| │ content.documentId | ||||||||||
| │ | ||||||||||
|
|
@@ -34,65 +39,140 @@ The whiteboard state and RTC session membership is stored using the following ev | |||||||||
|
|
||||||||||
| All other events and relations remain as described in [Matrix Events](matrix-events.md) | ||||||||||
|
|
||||||||||
| ### `org.matrix.msc4143.rtc.slot` (State event) | ||||||||||
|
|
||||||||||
| This is a renamed `net.nordeck.whiteboard` event with [MSC4143: MatrixRTC][MSC4143] slot specific fields | ||||||||||
| added to the content: `status`, `applicaiton.type`. | ||||||||||
|
maheichyk marked this conversation as resolved.
Outdated
|
||||||||||
|
|
||||||||||
| #### Fields | ||||||||||
|
|
||||||||||
| | Field | Type | Description | | ||||||||||
| | ------------------------ | ------------------------ | -------------------------------------------------------- | | ||||||||||
| | `status` | `'open'` | A slot's status. | | ||||||||||
| | `application.type` | `net.nordeck.whiteboard` | Nordeck whiteboard application identifier. | | ||||||||||
|
Comment on lines
+43
to
+44
Contributor
There was a problem hiding this comment. We are mixing type and values here. For example, status can be
Suggested change
|
||||||||||
| | `application.documentId` | `string` | A `net.nordeck.whiteboard.document.create` room event id | | ||||||||||
|
|
||||||||||
| #### Example | ||||||||||
|
|
||||||||||
| ```json | ||||||||||
| { | ||||||||||
| "type": "org.matrix.msc4143.rtc.slot", | ||||||||||
| "sender": "@user-id:example.com", | ||||||||||
| "state_key": "<whiteboard-id>", | ||||||||||
|
maheichyk marked this conversation as resolved.
Outdated
|
||||||||||
| "content": { | ||||||||||
| "status": "open", | ||||||||||
| "application": { | ||||||||||
| "type": "net.nordeck.whiteboard", | ||||||||||
| "documentId": "$H1-nssrxUGbrMdKSDJcACCpmc4PrClb2WDSOrGUv6bs" | ||||||||||
| } | ||||||||||
| }, | ||||||||||
| "event_id": "$event-id", | ||||||||||
| "origin_server_ts": 1665134498391, | ||||||||||
| "room_id": "!room-id:example.com" | ||||||||||
| } | ||||||||||
| ``` | ||||||||||
|
|
||||||||||
| ### `org.matrix.msc4143.rtc.member` (Sticky event) with `join` membership | ||||||||||
|
|
||||||||||
| According to [MSC4143: MatrixRTC][MSC4143], a RTC application must keep it's membership data in | ||||||||||
| the sticky event of type `m.rtc.member` with `member.membership` to be `join`. | ||||||||||
|
|
||||||||||
| Sending a `m.rtc.member` event with `membership` equal to `join` for an opened slot opens a session. | ||||||||||
|
|
||||||||||
| #### Fields | ||||||||||
|
|
||||||||||
| | Field | Type | Description | | ||||||||||
| | --------------------------- | -------------------------- | ------------------------------------------------------------------------------- | | ||||||||||
| | `slot_id` | `string` | A MatrixRTC slot ID, example: `net.nordeck.whiteboard#whiteboard-id` | | ||||||||||
| | `member.id` | `string` | A unique user identifier for each join, even for the same user and device. | | ||||||||||
| | `member.membership` | `'join'` | Identifies membership event as `join`. | | ||||||||||
|
Contributor
There was a problem hiding this comment. Also mixing types and values here and I understand why you are doing it - still, I think this is not correct as is. |
||||||||||
| | `member.deviceId` | `string` | The Device ID of the user's client. | | ||||||||||
| | `application.type` | `'net.nordeck.whiteboard'` | Nordeck whiteboard application identifier. | | ||||||||||
| | `application.whiteboard_id` | `string` | A whiteboard id. | | ||||||||||
| | `transports.published[]` | `array` | Array of transports used by member to publis media, see MatrixRTC transports. | | ||||||||||
|
maheichyk marked this conversation as resolved.
Outdated
|
||||||||||
| | `transports.can_subscribe` | `array` | Array of transports member can subscribe to. At the moment: `['livekit']` only. | | ||||||||||
| | `msc4354_sticky_key` | `string` | The sticky key. Must be the same as `member.id`. | | ||||||||||
|
|
||||||||||
| #### Example | ||||||||||
|
|
||||||||||
| ```json | ||||||||||
| { | ||||||||||
| "type": "org.matrix.msc4143.rtc.member", | ||||||||||
| "sender": "@user-id:example.com", | ||||||||||
| "content": { | ||||||||||
| "slot_id": "net.nordeck.whiteboard#whiteboard-id", | ||||||||||
| "member": { | ||||||||||
| "id": "$member-id-0", | ||||||||||
| "membership": "join", | ||||||||||
| "device_id": "$device-id-0" | ||||||||||
|
Contributor
There was a problem hiding this comment. Where is the |
||||||||||
| }, | ||||||||||
| "application": { | ||||||||||
| "type": "net.nordeck.whiteboard", | ||||||||||
| "whiteboard_id": "whiteboard-id" | ||||||||||
| }, | ||||||||||
| "transports": { | ||||||||||
| "published": [ | ||||||||||
| { | ||||||||||
| "type": "livekit", | ||||||||||
| "livekit_service_url": "https://livekit-jwt.example.com" | ||||||||||
| } | ||||||||||
| ], | ||||||||||
| "can_subscribe": ["livekit"] | ||||||||||
| }, | ||||||||||
| "msc4354_sticky_key": "$member-id-0" | ||||||||||
| }, | ||||||||||
| "origin_server_ts": 0, | ||||||||||
| "event_id": "$event-id", | ||||||||||
| "room_id": "!room-id:example.com" | ||||||||||
| } | ||||||||||
| ``` | ||||||||||
|
|
||||||||||
| ### `org.matrix.msc4143.rtc.member` (Sticky event) with `leave` membership | ||||||||||
|
|
||||||||||
| A session is terminated when a `m.rtc.member` event with a `leave` `membership` is sent. | ||||||||||
|
|
||||||||||
| The `leave_reason.code` is set to `leave` when users leaves intentionally. | ||||||||||
|
|
||||||||||
| The `leave_reason.code` is set to `delayed_leave` when user's [MSC4140 delayed event][MSC4140] to leave is sent. | ||||||||||
|
|
||||||||||
| #### Fields | ||||||||||
|
|
||||||||||
| | Field | Type | Description | | ||||||||||
| | -------------------- | ---------------------------- | -------------------------------------------------------------------------- | | ||||||||||
| | `slot_id` | `string` | A MatrixRTC slot ID, example: `net.nordeck.whiteboard#whiteboard-id` | | ||||||||||
| | `member.id` | `string` | A unique user identifier for each join, even for the same user and device. | | ||||||||||
| | `member.membership` | `'leave'` | Idnentifies membership event as `leave`. | | ||||||||||
|
maheichyk marked this conversation as resolved.
Outdated
|
||||||||||
| | `member.deviceId` | `string` | The Device ID of the user's client. | | ||||||||||
| | `leave_reason.code` | `'leave' \| 'delayed_leave'` | Leave code. | | ||||||||||
| | `msc4354_sticky_key` | `string` | The sticky key. Must be the same as `member.id`. | | ||||||||||
|
|
||||||||||
| #### Example | ||||||||||
|
|
||||||||||
| ```json | ||||||||||
| { | ||||||||||
| "type": "org.matrix.msc4143.rtc.member", | ||||||||||
| "sender": "@user-id:example.com", | ||||||||||
| "content": { | ||||||||||
| "slot_id": "net.nordeck.whiteboard#whiteboard-id", | ||||||||||
| "member": { | ||||||||||
| "id": "$member-id-0", | ||||||||||
| "membership": "leave", | ||||||||||
| "device_id": "$device-id-0" | ||||||||||
| }, | ||||||||||
| "leave_reason": { | ||||||||||
| "code": "leave" | ||||||||||
| }, | ||||||||||
| "msc4354_sticky_key": "$member-id-0" | ||||||||||
| }, | ||||||||||
| "origin_server_ts": 0, | ||||||||||
| "event_id": "$event-id", | ||||||||||
| "room_id": "!room-id:example.com", | ||||||||||
| "msc4354_sticky": { | ||||||||||
| "duration_ms": 3600000 | ||||||||||
| } | ||||||||||
| } | ||||||||||
| ``` | ||||||||||
|
|
||||||||||
| [matrix-events]: ./matrix-events.md | ||||||||||
| [MSC4143]: https://github.com/matrix-org/matrix-spec-proposals/blob/toger5/matrixRTC/proposals/4143-matrix-rtc.md | ||||||||||
| [MSC4140]: https://github.com/matrix-org/matrix-spec-proposals/blob/toger5/expiring-events-keep-alive/proposals/4140-delayed-events-futures.md | ||||||||||
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
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
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
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
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Why? Aren't these two separate concepts?
One is indicating this room has whiteboard data in it which can be used by the standalone app or the widget, and the other is enabling realtime collaboration (which can be disabled, if the slot is closed).
I haven't checked yet the full PR but this has data migration implications.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
A very good question.
I somehow thought that would be useful and migration shouldn't be an issue and I addressed the PR to handle that. However I got other issues in standalone because of this decision.
I agree, that should be separated, that makes sense and makes everything much easier and consistent 👍
I have update PR to revert whiteboard to slot changes and add slot sending separately.