fedora-hubs

#409 IRC: Riot.im integration for MVP
Opened by duffy. Modified

Open
Close Issue

As discussed in the 17 Oct 2017 meeting, we need mockups to show the new MVP version of IRC integration in hubs using links out to riot.im / matrix. Below is the log from the meeting describing the idea:

15:18:39 abompard: could we use this in the chat widget to provide a view of the room, > and have the button to link people over to riot to chat? https://view.matrix.org/room/!cURbafjkfsMDVwdRDQ:matrix.org/
15:19:04 mizmo: totally
15:19:20 mizmo: we only need to know how to get that room id
15:19:34 ok awesome. it'll work for team hubs but not users
15:19:45 abompard: maybe put that burden on the hub admins for now
15:19:59 abompard: admins fill the settings page
15:20:04 i can look them up manually in riot, eg this room is !pQKymaaQXBFBeuOxHn:matrix.org
15:20:05 I mean the matrix room id
15:20:30 that seems really doable
15:20:43 mizmo: yeah that's enough for a MVP, unless I find a magical API that gives me the answer easily
15:21:03 theres a js api for matrix, let me see if it lets you look up
15:21:54 mizmo: nope, you cannot do that using the js dsk
15:22:02 https://matrix.org/docs/api/client-server/#!/Room32directory/get_matrix_client_r0_directory_room_roomAlias
15:22:11 so the aliases are predictable, this should work
15:22:39 eg the alias for this room is #freenode_#fedora-hubs:matrix.org
15:22:50 so you take the base IRC room name, prepend #freenode_ and append :matrix.org
15:23:07 that's the alias that you put into this api call
15:23:08 mizmo: perfect
15:23:48 so we could just ask the hub admin for the irc channel name (as we were planning anyway), convert it to a matrix alias, then look up using the API call for the ID, and use that to pull in both the viewer and also to link over to riot
15:24:56 Yep!
15:25:59 \o/
15:26:11 sounds cool :)
15:26:11 i think that'll be good enough for mvp
15:26:17 yeah I think so too
15:26:34 and it doesnt tie us too tightly either in case something happens
15:28:04 yeah
15:28:45 cool so ill work on those mockups today and if needed tommorrow with the aim of having something to show tomm afternoon my time
15:29:10 BTW, it works: curl -X GET --header 'Accept: application/json' 'https://matrix.org:8448/matrix/client/r0/directory/room/%23freenode%23fedora-hubs%3Amatrix.org'

Team / Project Hub IRC Widget

Here's what this would look like for MVP. I'm not 100% sure if this is possible.

Pre-requisites

  • The IRC channel is configured in the admin panel for the widget
  • The matrix channel for the IRC channel has been set to public
  • The API will allow us to pull these specific data pieces out (it appears to make it possible?) instead of just popping up a view.matrix.org window in an iframe.

API info

  • Converting IRC channel to matrix roomid - first you need room alias, and then convert the room alias to the room id. To get the room alias, you prepend the IRC freenode name with "#freenode_" and append ":matrix.org" to it. So, for example, '#fedora-design' would become '#freenode_#fedora-design:matrix.org'. Then, TAke this matrix room alias and use this API call to convert to room id: get /_matrix/client/r0/directory/room/{roomAlias}
  • Who's Chatting: use get /_matrix/client/r0/rooms/{roomId}/members, return first 5, return total number of members - 5. For each member in the list of 5, use
    get /_matrix/client/r0/profile/{userId}/avatar_url to get avatar graphic.
  • Latest messages: Should display 5 most recent messages. Can use
    get /_matrix/client/r0/rooms/{roomId}/messages with the option to limit to 5 messages. If possible though, manipulation on timestamps to be age would be best since we then don't have to deal with time zones and the staleness of the channel will be clearer to users.
  • Launch designteam chat: Open a new window, remove menubars if possible, should open up to riot.im/app/#/room/!DgvjtOljKujDBrxyHk:matrix.org/ (replacing with correct roomID)

Other Notes

  • The "Hide this notification" link should shade the chat widget. To re-open, unshade the widget. (^ icon in upper right)
Edited by duffy

Metadata Update from @duffy:
- Issue priority set to: High

irc-riot-integration.png

Still working on the admin config side of this.

Ideally, what the config would look like:

hub-admin-enter.png

IRC-settings.png

Metadata Update from @ryanlerch:
- Issue set to the milestone: Production

Metadata Update from @ryanlerch:
- Issue set to the milestone: None (was: Production)
Metadata
None
None
None
None
Lowest
Static archive. pagure.io was sunset in 2026; this is a read-only snapshot.
Red Hat Logo

Fedora is sponsored by Red Hat. Learn more about the relationship between Red Hat and Fedora »

© Red Hat, Inc. and others.