MSC2346: Bridge information state event #2346

Half-Shot · 2019-11-05T15:29:32Z

Riot POC
Slack Bridge POC
IRC Bridge POC

proposals/2346-bridge-info-state-event.md

proposals/xxxx-bridge-info-state-event.md

Half-Shot · 2019-12-01T14:06:46Z

Note: I also want to modify publicRooms to return information in these state events, since it's useful information to anyone wanting to join a room.

Half-Shot · 2019-12-02T15:11:34Z

This is probably ready for review now.

uhoreg

Largely looks good, but have added some bikeshedding and nit picking.

proposals/2346-bridge-info-state-event.md

uhoreg · 2019-12-02T20:59:26Z

proposals/2346-bridge-info-state-event.md

+`external_url` works for bridged messages in the AS spec.
+
+In terms of hierachy, the protocol can contain many networks, which can contain many channels.
+


Can we have examples of the protocol.id/network.id/channel.id part of the state key? e.g. for XMPP, would it be XMPP/xsf@muc.xmpp.org or XMPP//xsf@muc.xmpp.org (i.e. do we drop a / if there's no network field? What if there are more levels (e.g. protocol, network, community, room)? Is the network supposed to be human-readable like "Freenode" or something more like "freenode.org"? Maybe it would be better to just say that it's a path representing the hierarchy starting from the protocol and ending in the room? And then instead of hard-coding protocol, network, and channel as keys in the content, make it an array where the first element is the protocol and the last element is the channel?

Also, if a protocol/network name has a / in it, does it get escaped?

I have added several examples of the event body to the description that might help make this more understandable.

And then instead of hard-coding protocol, network, and channel as keys in the content, make it an array where the first element is the protocol and the last element is the channel.

Potentially, though I am worried this might make it harder for clients to show a sensible UI. How would riot render:

["Github", "matrix-org", "matrix-doc", "2346"]
vs
{"protocol": "GitHub", "network": "matrix-org/matrix-doc", "channel": "2346"}

(Simplified for readability, and using a deliberately complex example).

In the first example, there are 4 keys and it's hard for a client to decide how to format this in a settings page. Joining them with a delimiter is too ugly (to me). There are probably examples which are restricted by the 3 component limit, but I am struggling to come up with any?

Does the client actually need to care about the state key? The information embedded into the state key is already available in the body, and clients would want to use a more friendly name anyways. I think we can just use an empty state key and let clients figure it out.

If you're running multiple bridges off the same bridge bot, don't.

If you're running multiple bridges off the same bridge bot, don't.

Or if you are running several bridges off different bridge bots, you will still need different state events and therefore different keys.

Why can't we use user_ids? We could, but that does forever tie your bridge to using one user_id for life when the actual thing the bridge is "keyed" off is the protocol,network and channel.

The client doesn't need to give a heck about the state key, other than it being more readable for those who want to work on it. Given there isn't really a downside to having a schema for the state key, and it gives more readability, I don't see why not.

I would much rather that we don't prescribe the state key. Just say that it needs to start with the bridge ID (unique prefix) and the rest is implementation defined. Any meaningful values should be delegated to the context of the state object.

Co-Authored-By: Hubert Chathi <hubert@uhoreg.ca>

proposals/2346-bridge-info-state-event.md

benparsons

two small points

proposals/2346-bridge-info-state-event.md

uhoreg

Some more nit picking

proposals/2346-bridge-info-state-event.md

Co-Authored-By: Hubert Chathi <hubert@uhoreg.ca>

Half-Shot · 2019-12-04T15:12:09Z

Added a Slack bridge POC. This means that we now have full implementation for both sides :)

proposals/2346-bridge-info-state-event.md

proposals/xxxx-bridge-info-state-event.md

proposals/2346-bridge-info-state-event.md

Co-authored-by: Tulir Asokan <tulir@maunium.net>

erikjohnston · 2021-07-13T16:20:01Z

proposals/2346-bridge-info-state-event.md

+
+There exists a way to do this in a local setting, by using the
+[/thirdparty/location](https://matrix.org/docs/spec/application_service/r0.1.2#get-matrix-app-v1-thirdparty-protocol-protocol)
+API but this creates a splitbrain view across the federation and is an unnacceptable situation.


This MSC doesn't solve what the /thirdparty APIs are trying to do though, as they're trying to answer the question of "what third party networks are bridged on the server and what are their rooms", whereas this MSC is trying to answer the question of "which room is this bridged to?".

turt2live

overall this is feeling fine, but the further exposure of the awful third party network API is a bit worrying.

kevincox · 2021-07-16T11:51:43Z

proposals/2346-bridge-info-state-event.md

+            "avatar_url": "mxc://foo/bar", // Optional
+            "external_url": "irc://chat.freenode.net" // Optional
+        },
+        "channel": {


Nit: Why are we calling this a channel? In Matrix we call these rooms so doesn't it make sense to use the local terminology. Basically "the thing in the source protocol which maps to a room in Matrix". For example if the remote network has groups and Matrix has rooms why are we calling the field channel?

kevincox · 2021-07-16T11:52:36Z

proposals/2346-bridge-info-state-event.md

+```
+
+The `state_key` must be comprised of the bridge's prefix, followed by the `protocol.id`, followed by the `network.id`, 
+followed by the `channel.id`. Any `/`s must be escaped into `%2F`. The bridge prefix can be anything, but should uniquely 


We also need to escape % to %25.

I guess we should say that the IDs should be URL-encoded, including encoding / to %2F?

kevincox · 2021-07-16T11:53:51Z

proposals/2346-bridge-info-state-event.md

+    "state_key": "org.matrix.appservice-irc://{protocol.id}/{network.id}/{channel.id}",
+    "type": "m.bridge",
+    "content": {
+        "bridgebot": "@appservice-irc:matrix.org",


Should this also be optional? You can imagine that some bridges could just use the bridge users as bridge bots. For example if you bridge a 1:1 chat from Telegram you can just use the remote user as the "bridge bot".

kevincox · 2021-07-16T11:56:26Z

proposals/2346-bridge-info-state-event.md

+`external_url` works for bridged messages in the AS spec.
+
+In terms of hierachy, the protocol can contain many networks, which can contain many channels.
+


I would much rather that we don't prescribe the state key. Just say that it needs to start with the bridge ID (unique prefix) and the rest is implementation defined. Any meaningful values should be delegated to the context of the state object.

richvdh · 2021-08-03T16:04:06Z

This looks to be back with @Half-Shot.

uhoreg · 2021-08-03T18:00:18Z

proposals/2346-bridge-info-state-event.md

+
+```js
+{
+    "state_key": "org.matrix.appservice-irc://{protocol.id}/{network.id}/{channel.id}",


What should be the format of the state key if network ID/channel ID are omitted? e.g. foo.bar.appservice-skype://skype//someid or foo.bar.appservice-skype://skype/someid? (do we just drop the component and keep all the slashes, or do we collapse slashes?)

I probably makes sense for the format of what comes after :// to be dependent on the value before ://. Here {protocol.id}/{network.id}/{channel.id} would be the format for org.matrix.appservice-irc://; but for foo.bar.appservice-skype:// it would always be {protocol.id}/{chat.id}

Half-Shot added 2 commits November 5, 2019 15:28

Initial WIP of proposal

fa30188

2346

e5daeb9

Half-Shot changed the title ~~MSC 2346: Bridge information state event~~ [WIP] MSC 2346: Bridge information state event Nov 5, 2019

Half-Shot changed the title ~~[WIP] MSC 2346: Bridge information state event~~ [WIP] MSC2346: Bridge information state event Nov 5, 2019

turt2live added the proposal A matrix spec change proposal label Nov 5, 2019

turt2live reviewed Nov 5, 2019

View reviewed changes

proposals/2346-bridge-info-state-event.md Outdated Show resolved Hide resolved

Half-Shot mentioned this pull request Nov 5, 2019

Proposal for Rich Bridging #1410

Closed

zeratax reviewed Nov 14, 2019

View reviewed changes

proposals/xxxx-bridge-info-state-event.md Outdated Show resolved Hide resolved

Various updates to take this out of WIP

e13cbec

Half-Shot changed the title ~~[WIP] MSC2346: Bridge information state event~~ MSC2346: Bridge information state event Dec 2, 2019

Half-Shot added the proposal-in-review label Dec 2, 2019

turt2live self-requested a review December 2, 2019 16:03

Half-Shot mentioned this pull request Dec 2, 2019

Bridge info settings tab matrix-org/matrix-react-sdk#3693

Merged

uhoreg reviewed Dec 2, 2019

View reviewed changes

Half-Shot and others added 5 commits December 2, 2019 21:20

Backticks around location header

e887a08

Co-Authored-By: Hubert Chathi <hubert@uhoreg.ca>

Clarify fields

dfba42d

Add some example event bodys

38e635a

Small fixes

0103c30

C&P fail

ffc98ce

Half-Shot commented Dec 3, 2019

View reviewed changes

proposals/2346-bridge-info-state-event.md Outdated Show resolved Hide resolved

benparsons requested changes Dec 3, 2019

View reviewed changes

proposals/2346-bridge-info-state-event.md Outdated Show resolved Hide resolved

proposals/2346-bridge-info-state-event.md Show resolved Hide resolved

Fix content in mastodon example.

ef21d6b

uhoreg reviewed Dec 4, 2019

View reviewed changes

proposals/2346-bridge-info-state-event.md Outdated Show resolved Hide resolved

proposals/2346-bridge-info-state-event.md Outdated Show resolved Hide resolved

@uhoreg nit picks

542dfa7

Co-Authored-By: Hubert Chathi <hubert@uhoreg.ca>

Half-Shot mentioned this pull request Dec 4, 2019

Implement MSC2346: Bridge information state event matrix-org/matrix-appservice-slack#333

Open

Half-Shot commented Dec 4, 2019

View reviewed changes

proposals/2346-bridge-info-state-event.md Show resolved Hide resolved

Half-Shot commented Dec 4, 2019

View reviewed changes

proposals/2346-bridge-info-state-event.md Show resolved Hide resolved

mweinelt reviewed May 28, 2020

View reviewed changes

proposals/xxxx-bridge-info-state-event.md Outdated Show resolved Hide resolved

tulir reviewed Jul 3, 2020

View reviewed changes

proposals/2346-bridge-info-state-event.md Outdated Show resolved Hide resolved

Update proposals/2346-bridge-info-state-event.md

62afef8

Co-authored-by: Tulir Asokan <tulir@maunium.net>

MadLittleMods mentioned this pull request Nov 10, 2020

Gitter feature parity overview issue element-hq/roadmap#26

Open

48 tasks

Half-Shot mentioned this pull request Nov 30, 2020

Room directory should flag what networks rooms are bridged to element-hq/element-meta#1205

Open

MurzNN mentioned this pull request Dec 25, 2020

Bridge info settings tab: Clickable url to targeted room from external_url field is disappeared element-hq/element-web#16032

Closed

Half-Shot mentioned this pull request Jan 4, 2021

Implement rendering MSC2346 (bridge info state) matrix-org/cerulean#38

Open

turt2live added this to Awaiting SCT input in Spec Core Team Backlog Apr 27, 2021

turt2live moved this from Awaiting initial idea feedback to Proposed for FCP readiness in Spec Core Team Backlog Jun 15, 2021

erikjohnston reviewed Jul 13, 2021

View reviewed changes

turt2live reviewed Jul 14, 2021

View reviewed changes

turt2live added the application services label Jul 14, 2021

kevincox reviewed Jul 16, 2021

View reviewed changes

richvdh removed this from Proposed for FCP readiness in Spec Core Team Backlog Aug 3, 2021

uhoreg reviewed Aug 3, 2021

View reviewed changes

turt2live force-pushed the old_master branch from e895827 to dca99ee Compare August 30, 2021 22:34

tulir mentioned this pull request Sep 7, 2021

show server in fuzzy search tulir/gomuks#303

Open

MadLittleMods mentioned this pull request Sep 24, 2021

Open IRCS links element-hq/element-meta#1854

Open

Half-Shot mentioned this pull request May 13, 2020

Publicly advertise bridged accounts and rooms matrix-org/matrix-spec#620

Open

5 tasks

MTRNord mentioned this pull request May 20, 2021

Ability to disable richer features per room or space. matrix-org/matrix-spec#836

Open

anoadragon453 mentioned this pull request Mar 9, 2022

Event got sent but not synced back down everywhere matrix-org/synapse#9424

Closed

turt2live removed the proposal-in-review label May 5, 2022

This was referenced May 20, 2022

Identify the host of a bridge somehow. matrix-org/matrix-appservice-irc#599

Closed

there should be a way to know ircd software and version running when joining a server. matrix-org/matrix-appservice-irc#582

Open

deepbluev7 mentioned this pull request Jun 29, 2022

Support thirdparty network queries over federation matrix-org/matrix-spec#1152

Open

ginnyTheCat mentioned this pull request Aug 3, 2022

Show bridges active in room in settings cinnyapp/cinny#713

Closed

7 tasks

clokep mentioned this pull request Feb 25, 2023

MSC3969: Size limits #3969

Closed

Mikaela mentioned this pull request Jun 1, 2023

Part/leave rooms after archive is not checked for a while matrix-org/matrix-viewer#260

Open

BrainDamage mentioned this pull request Jun 5, 2024

Feature Request: flag rooms with bridge information [MSC2346] hifi/heisenbridge#288

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

MSC2346: Bridge information state event #2346

MSC2346: Bridge information state event #2346

Half-Shot commented Nov 5, 2019 •

edited

Half-Shot commented Dec 1, 2019

Half-Shot commented Dec 2, 2019

uhoreg left a comment

uhoreg Dec 2, 2019

Half-Shot Dec 3, 2019

Half-Shot Dec 3, 2019

turt2live Feb 5, 2020

Half-Shot Feb 5, 2020

Half-Shot Feb 5, 2020

kevincox Jul 16, 2021

benparsons left a comment

uhoreg left a comment

Half-Shot commented Dec 4, 2019 •

edited

erikjohnston Jul 13, 2021

turt2live left a comment

kevincox Jul 16, 2021

kevincox Jul 16, 2021

uhoreg Aug 3, 2021

kevincox Jul 16, 2021

kevincox Jul 16, 2021

richvdh commented Aug 3, 2021

uhoreg Aug 3, 2021

progval Feb 25, 2023

		`external_url` works for bridged messages in the AS spec.

		In terms of hierachy, the protocol can contain many networks, which can contain many channels.

MSC2346: Bridge information state event #2346

Are you sure you want to change the base?

MSC2346: Bridge information state event #2346

Conversation

Half-Shot commented Nov 5, 2019 • edited

Half-Shot commented Dec 1, 2019

Half-Shot commented Dec 2, 2019

uhoreg left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

benparsons left a comment

Choose a reason for hiding this comment

uhoreg left a comment

Choose a reason for hiding this comment

Half-Shot commented Dec 4, 2019 • edited

Choose a reason for hiding this comment

turt2live left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

richvdh commented Aug 3, 2021

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Half-Shot commented Nov 5, 2019 •

edited

Half-Shot commented Dec 4, 2019 •

edited