feat: Read list of main room participants, do not redirect them. (#1227)

bgrozev · web-flow · commit 860b63954e18 · 2025-05-29T15:33:02.000-05:00
* feat: Read conference request token.

* feat: Parse mainRoomParticipants from metadata.

* feat: Send main room participants to main room.

* chore: Bump jicoco.
diff --git a/jicofo-common/src/main/kotlin/org/jitsi/jicofo/xmpp/muc/ChatRoom.kt b/jicofo-common/src/main/kotlin/org/jitsi/jicofo/xmpp/muc/ChatRoom.kt
@@ -73,6 +73,8 @@ interface ChatRoom {
     /** Returns the number of members that currently have their video sources unmuted. */
     var videoSendersCount: Int
 
+    val mainRoomParticipants: List<String>
+
     /**
      * Joins this chat room with the preconfigured nickname. Returns the fields read from the MUC config form after
      * joining.
diff --git a/jicofo-common/src/main/kotlin/org/jitsi/jicofo/xmpp/muc/ChatRoomImpl.kt b/jicofo-common/src/main/kotlin/org/jitsi/jicofo/xmpp/muc/ChatRoomImpl.kt
@@ -163,6 +163,9 @@ class ChatRoomImpl(
             }
         }
 
+    override var mainRoomParticipants: List<String> = emptyList()
+        private set
+
     private val avModerationByMediaType = ConcurrentHashMap<MediaType, AvModerationForMediaType>()
 
     /** The emitter used to fire events. */
@@ -279,6 +282,7 @@ class ChatRoomImpl(
 
     override fun setRoomMetadata(roomMetadata: RoomMetadata) {
         visitorsLive = roomMetadata.metadata?.visitors?.live == true
+        mainRoomParticipants = roomMetadata.metadata?.mainMeetingParticipants ?: emptyList()
         roomMetadata.metadata?.startMuted?.let {
             eventEmitter.fireEvent { startMutedChanged(it.audio == true, it.video == true) }
         }
diff --git a/jicofo-common/src/main/kotlin/org/jitsi/jicofo/xmpp/muc/RoomMetadata.kt b/jicofo-common/src/main/kotlin/org/jitsi/jicofo/xmpp/muc/RoomMetadata.kt
@@ -35,7 +35,11 @@ data class RoomMetadata(
     val metadata: Metadata?
 ) {
     @JsonIgnoreProperties(ignoreUnknown = true)
-    data class Metadata(val visitors: Visitors?, val startMuted: StartMuted?) {
+    data class Metadata(
+        val visitors: Visitors?,
+        val startMuted: StartMuted?,
+        val mainMeetingParticipants: List<String>?
+    ) {
         @JsonIgnoreProperties(ignoreUnknown = true)
         data class Visitors(val live: Boolean?)
 
diff --git a/jicofo-common/src/test/kotlin/org/jitsi/jicofo/xmpp/muc/RoomMetadataTest.kt b/jicofo-common/src/test/kotlin/org/jitsi/jicofo/xmpp/muc/RoomMetadataTest.kt
@@ -19,6 +19,7 @@ package org.jitsi.jicofo.xmpp.muc
 
 import io.kotest.assertions.throwables.shouldThrow
 import io.kotest.core.spec.style.ShouldSpec
+import io.kotest.matchers.nulls.shouldNotBeNull
 import io.kotest.matchers.shouldBe
 import io.kotest.matchers.types.shouldBeInstanceOf
 
@@ -61,6 +62,44 @@ class RoomMetadataTest : ShouldSpec() {
                 parsed.shouldBeInstanceOf<RoomMetadata>()
                 parsed.metadata!!.visitors shouldBe null
             }
+            context("With visitors, mainMeetingParticipants, and startMuted") {
+                RoomMetadata.parse(
+                    """
+                    {
+                        "metadata": {
+                            "transcriberType": "EGHT_WHISPER",
+                            "visitors": {
+                                "live": true
+                            },
+                            "mainMeetingParticipants": [
+                                "user_id_1",
+                                "user_id_2"
+                            ],
+                            "startMuted": {
+                                "audio": true
+                            }
+                        },
+                        "type": "room_metadata"
+                    }
+                    """.trimIndent()
+                ).apply {
+                    shouldBeInstanceOf<RoomMetadata>()
+                    metadata.apply {
+                        shouldNotBeNull()
+                        visitors.apply {
+                            shouldNotBeNull()
+                            live shouldBe true
+                        }
+                        mainMeetingParticipants shouldBe listOf("user_id_1", "user_id_2")
+                        startMuted.apply {
+                            shouldNotBeNull()
+                            audio shouldBe true
+                            video shouldBe null
+                        }
+                    }
+                    type shouldBe "room_metadata"
+                }
+            }
         }
         context("Invalid") {
             context("Missing type") {
diff --git a/jicofo/pom.xml b/jicofo/pom.xml
@@ -84,20 +84,24 @@
     <!-- org.jitsi -->
     <dependency>
       <groupId>${project.groupId}</groupId>
-      <artifactId>jicoco-health-checker</artifactId>
+      <artifactId>jicoco-config</artifactId>
     </dependency>
     <dependency>
       <groupId>${project.groupId}</groupId>
-      <artifactId>jicoco-config</artifactId>
+      <artifactId>jicoco-health-checker</artifactId>
     </dependency>
     <dependency>
       <groupId>${project.groupId}</groupId>
-      <artifactId>jicoco-metrics</artifactId>
+      <artifactId>jicoco-jwt</artifactId>
     </dependency>
     <dependency>
       <groupId>${project.groupId}</groupId>
       <artifactId>jitsi-metaconfig</artifactId>
     </dependency>
+    <dependency>
+      <groupId>${project.groupId}</groupId>
+      <artifactId>jicoco-metrics</artifactId>
+    </dependency>
     <dependency>
       <groupId>${project.groupId}</groupId>
       <artifactId>jitsi-utils</artifactId>
@@ -117,7 +121,6 @@
     <dependency>
         <groupId>com.fasterxml.jackson.module</groupId>
         <artifactId>jackson-module-kotlin</artifactId>
-        <version>2.14.1</version>
     </dependency>
     <!-- https://mvnrepository.com/artifact/com.github.spotbugs/spotbugs-annotations -->
     <dependency>
diff --git a/jicofo/src/main/java/org/jitsi/jicofo/conference/JitsiMeetConferenceImpl.java b/jicofo/src/main/java/org/jitsi/jicofo/conference/JitsiMeetConferenceImpl.java
@@ -1799,7 +1799,7 @@ public int moveEndpoints(@NotNull Bridge bridge, int numEps)
      * @return the name of the visitor node if it should be redirected, and null otherwise.
      */
     @Nullable
-    public String redirectVisitor(boolean visitorRequested)
+    public String redirectVisitor(boolean visitorRequested, @Nullable String userId)
         throws Exception
     {
         if (!VisitorsConfig.config.getEnabled())
@@ -1809,9 +1809,14 @@ public String redirectVisitor(boolean visitorRequested)
 
         // We don't support both visitors and a lobby. Once a lobby is enabled we don't use visitors anymore.
         ChatRoom chatRoom = this.chatRoom;
-        if (chatRoom != null && (chatRoom.getLobbyEnabled() || Boolean.FALSE.equals(chatRoom.getVisitorsEnabled())))
+        if (chatRoom != null)
         {
-            return null;
+            if (chatRoom.getLobbyEnabled()
+                    || Boolean.FALSE.equals(chatRoom.getVisitorsEnabled())
+                    || (userId != null && chatRoom.getMainRoomParticipants().contains(userId)))
+            {
+                return null;
+            }
         }
         if (VisitorsConfig.config.getRequireMucConfigFlag())
         {
diff --git a/jicofo/src/main/kotlin/org/jitsi/jicofo/ConferenceRequest.kt b/jicofo/src/main/kotlin/org/jitsi/jicofo/ConferenceRequest.kt
@@ -17,6 +17,7 @@
  */
 package org.jitsi.jicofo
 
+import com.fasterxml.jackson.annotation.JsonIgnoreProperties
 import com.fasterxml.jackson.annotation.JsonInclude
 import com.fasterxml.jackson.core.JsonProcessingException
 import com.fasterxml.jackson.databind.JsonMappingException
@@ -30,6 +31,7 @@ import kotlin.jvm.Throws
  * The initial request to create or join a conference, a generic version of [ConferenceIq].
  */
 @JsonInclude(JsonInclude.Include.NON_EMPTY)
+@JsonIgnoreProperties(ignoreUnknown = true)
 class ConferenceRequest(
     var room: String? = null,
     var ready: Boolean? = null,
@@ -41,7 +43,7 @@ class ConferenceRequest(
     val properties: MutableMap<String, String> = mutableMapOf()
 ) {
     @Throws(XmppStringprepException::class)
-    fun toConferenceIq() = ConferenceIq().apply {
+    fun toConferenceIq(token: String? = null) = ConferenceIq().apply {
         this@ConferenceRequest.room?.let {
             room = JidCreate.entityBareFrom(it)
         }
@@ -63,6 +65,9 @@ class ConferenceRequest(
         this@ConferenceRequest.vnode?.let {
             vnode = it
         }
+        token?.let {
+            setToken(it)
+        }
         this@ConferenceRequest.properties.forEach { (k, v) -> addProperty(k, v) }
     }
 
diff --git a/jicofo/src/main/kotlin/org/jitsi/jicofo/ktor/Application.kt b/jicofo/src/main/kotlin/org/jitsi/jicofo/ktor/Application.kt
@@ -33,6 +33,7 @@ import io.ktor.server.response.respond
 import io.ktor.server.response.respondText
 import io.ktor.server.routing.Route
 import io.ktor.server.routing.RoutingCall
+import io.ktor.server.routing.RoutingRequest
 import io.ktor.server.routing.get
 import io.ktor.server.routing.options
 import io.ktor.server.routing.post
@@ -160,8 +161,10 @@ class Application(
                     throw BadRequest(e.message)
                 }
 
+                val token = call.request.getToken()
+
                 val response: IQ = try {
-                    conferenceIqHandler.handleConferenceIq(request.toConferenceIq())
+                    conferenceIqHandler.handleConferenceIq(request.toConferenceIq(token))
                 } catch (e: XmppStringprepException) {
                     throw BadRequest("Invalid room name: ${e.message}")
                 } catch (e: Exception) {
@@ -351,3 +354,13 @@ private fun translateException(block: () -> MoveResult): MoveResult {
         }
     }
 }
+
+private fun RoutingRequest.getToken(): String? {
+    return this.headers["Authorization"]?.let {
+        if (it.startsWith("Bearer ")) {
+            it.substring("Bearer ".length)
+        } else {
+            it
+        }
+    }
+}
diff --git a/jicofo/src/main/kotlin/org/jitsi/jicofo/xmpp/ConferenceIqHandler.kt b/jicofo/src/main/kotlin/org/jitsi/jicofo/xmpp/ConferenceIqHandler.kt
@@ -23,6 +23,7 @@ import org.jitsi.jicofo.auth.AuthenticationAuthority
 import org.jitsi.jicofo.auth.ErrorFactory
 import org.jitsi.jicofo.metrics.JicofoMetricsContainer
 import org.jitsi.jicofo.visitors.VisitorsConfig
+import org.jitsi.jwt.JitsiToken
 import org.jitsi.utils.OrderedJsonObject
 import org.jitsi.utils.logging2.createLogger
 import org.jitsi.xmpp.extensions.jitsimeet.ConferenceIq
@@ -85,7 +86,7 @@ class ConferenceIqHandler(
             focusJid = focusAuthJid
         }
 
-        logger.info("Conference request for room $room, from ${query.from}")
+        logger.info("Conference request for room $room, from ${query.from}, token=${query.token != null}")
         conferenceRequestCounter.inc()
         val conference = focusManager.getConference(room)
         val roomExists = conference != null
@@ -110,7 +111,7 @@ class ConferenceIqHandler(
             return response
         }
         val vnode = if (visitorSupported && visitorsManager.enabled) {
-            conference?.redirectVisitor(visitorRequested)
+            conference?.redirectVisitor(visitorRequested, query.token.readUserId())
         } else {
             null
         }
@@ -236,3 +237,17 @@ class ConferenceIqHandler(
         )
     }
 }
+
+/**
+ * Read context.user.id from an unparsed token. Note that no validation is performed on the token, this is intentional.
+ * Validation will be performed when the user attempts to login to XMPP.
+ */
+private fun String?.readUserId(): String? = if (this.isNullOrEmpty()) {
+    null
+} else {
+    try {
+        JitsiToken.parseWithoutValidation(this).context?.user?.id
+    } catch (e: Throwable) {
+        null
+    }
+}
diff --git a/pom.xml b/pom.xml
@@ -42,8 +42,9 @@
     <ktor.version>3.0.0</ktor.version>
     <kotest.version>5.7.2</kotest.version>
     <slf4j.version>1.7.32</slf4j.version>
+    <jackson.version>2.19.0</jackson.version>
     <jitsi.utils.version>1.0-127-g6c65524</jitsi.utils.version>
-    <jicoco.version>1.1-159-gf9c2712</jicoco.version>
+    <jicoco.version>1.1-160-g4ad2288</jicoco.version>
     <ktlint-maven-plugin.version>3.0.0</ktlint-maven-plugin.version>
     <spotbugs.version>4.8.6</spotbugs.version>
     <spotbugs-maven-plugin.version>4.8.6.6</spotbugs-maven-plugin.version>
@@ -152,6 +153,11 @@
         <artifactId>jicoco-health-checker</artifactId>
         <version>${jicoco.version}</version>
       </dependency>
+      <dependency>
+        <groupId>${project.groupId}</groupId>
+        <artifactId>jicoco-jwt</artifactId>
+        <version>${jicoco.version}</version>
+      </dependency>
       <dependency>
         <groupId>${project.groupId}</groupId>
         <artifactId>jicoco-metrics</artifactId>
@@ -170,7 +176,7 @@
       <dependency>
         <groupId>${project.groupId}</groupId>
         <artifactId>jitsi-xmpp-extensions</artifactId>
-        <version>1.0-95-ge113e35</version>
+        <version>1.0-96-gb0509fc</version>
       </dependency>
       <dependency>
         <groupId>org.slf4j</groupId>
@@ -185,7 +191,7 @@
       <dependency>
           <groupId>com.fasterxml.jackson.module</groupId>
           <artifactId>jackson-module-kotlin</artifactId>
-          <version>2.14.1</version>
+          <version>${jackson.version}</version>
       </dependency>
       <!-- https://mvnrepository.com/artifact/com.github.spotbugs/spotbugs-annotations -->
       <dependency>

Original file line number	Diff line number	Diff line change
`@@ -163,6 +163,9 @@ class ChatRoomImpl(`
`163`	`163`	`}`
`164`	`164`	`}`
`165`	`165`
	`166`	`+ override var mainRoomParticipants: List<String> = emptyList()`
	`167`	`+ private set`
	`168`	`+`
`166`	`169`	`private val avModerationByMediaType = ConcurrentHashMap<MediaType, AvModerationForMediaType>()`
`167`	`170`
`168`	`171`	`/** The emitter used to fire events. */`
`@@ -279,6 +282,7 @@ class ChatRoomImpl(`
`279`	`282`
`280`	`283`	`override fun setRoomMetadata(roomMetadata: RoomMetadata) {`
`281`	`284`	`visitorsLive = roomMetadata.metadata?.visitors?.live == true`
	`285`	`+ mainRoomParticipants = roomMetadata.metadata?.mainMeetingParticipants ?: emptyList()`
`282`	`286`	`roomMetadata.metadata?.startMuted?.let {`
`283`	`287`	`eventEmitter.fireEvent { startMutedChanged(it.audio == true, it.video == true) }`
`284`	`288`	`}`
Original file line number	Diff line number	Diff line change
`@@ -1799,7 +1799,7 @@ public int moveEndpoints(@NotNull Bridge bridge, int numEps)`
`1799`	`1799`	`* @return the name of the visitor node if it should be redirected, and null otherwise.`
`1800`	`1800`	`*/`
`1801`	`1801`	`@Nullable`
`1802`		`- public String redirectVisitor(boolean visitorRequested)`
	`1802`	`+ public String redirectVisitor(boolean visitorRequested, @Nullable String userId)`
`1803`	`1803`	`throws Exception`
`1804`	`1804`	`{`
`1805`	`1805`	`if (!VisitorsConfig.config.getEnabled())`
`@@ -1809,9 +1809,14 @@ public String redirectVisitor(boolean visitorRequested)`
`1809`	`1809`
`1810`	`1810`	`// We don't support both visitors and a lobby. Once a lobby is enabled we don't use visitors anymore.`
`1811`	`1811`	`ChatRoom chatRoom = this.chatRoom;`
`1812`		`- if (chatRoom != null && (chatRoom.getLobbyEnabled() \|\| Boolean.FALSE.equals(chatRoom.getVisitorsEnabled())))`
	`1812`	`+ if (chatRoom != null)`
`1813`	`1813`	`{`
`1814`		`- return null;`
	`1814`	`+ if (chatRoom.getLobbyEnabled()`
	`1815`	`+ \|\| Boolean.FALSE.equals(chatRoom.getVisitorsEnabled())`
	`1816`	`+ \|\| (userId != null && chatRoom.getMainRoomParticipants().contains(userId)))`
	`1817`	`+ {`
	`1818`	`+ return null;`
	`1819`	`+ }`
`1815`	`1820`	`}`
`1816`	`1821`	`if (VisitorsConfig.config.getRequireMucConfigFlag())`
`1817`	`1822`	`{`