Add ability to set room configuration on access token (#105)

Author: davidliu

.changeset/poor-dolphins-explain.md

@@ -0,0 +1,5 @@
+---
+"server-sdk-kotlin": patch
+---
+
+Add ability to set room configuration on access token

.gitignore

@@ -13,6 +13,9 @@ local.properties
 .idea/kotlinScripting.xml
 .idea/libraries/
 .idea/migrations.xml
+.idea/protoeditor.xml
+.idea/runConfigurations.xml
+.idea/caches/
 .idea/**/gradle.xml
 *.iws
 *.iml

.idea/misc.xml

@@ -19,6 +19,7 @@ repositories {
     mavenCentral()
 }
 apply(from = "gradle/gradle-mvn-push.gradle")
+apply(plugin = "idea")
 
 plugins {
     kotlin("jvm") version "1.9.0"
@@ -30,7 +31,6 @@ plugins {
     id("com.diffplug.spotless") version "6.21.0"
 }
 
-
 java {
     withJavadocJar()
     withSourcesJar()

build.gradle.kts

@@ -1,5 +1,7 @@
 distributionBase=GRADLE_USER_HOME
 distributionPath=wrapper/dists
-distributionUrl=https\://services.gradle.org/distributions/gradle-7.4.2-bin.zip
+distributionUrl=https\://services.gradle.org/distributions/gradle-8.9-bin.zip
+networkTimeout=10000
+validateDistributionUrl=true
 zipStoreBase=GRADLE_USER_HOME
-zipStorePath=wrapper/dists
+zipStorePath=wrapper/dists

gradle/wrapper/gradle-wrapper.jar

@@ -15,6 +15,8 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 #
+# SPDX-License-Identifier: Apache-2.0
+#
 
 ##############################################################################
 #
@@ -55,7 +57,7 @@
 #       Darwin, MinGW, and NonStop.
 #
 #   (3) This script is generated from the Groovy template
-#       https://github.com/gradle/gradle/blob/master/subprojects/plugins/src/main/resources/org/gradle/api/internal/plugins/unixStartScript.txt
+#       https://github.com/gradle/gradle/blob/HEAD/platforms/jvm/plugins-application/src/main/resources/org/gradle/api/internal/plugins/unixStartScript.txt
 #       within the Gradle project.
 #
 #       You can find Gradle at https://github.com/gradle/gradle/.
@@ -80,13 +82,12 @@ do
     esac
 done
 
-APP_HOME=$( cd "${APP_HOME:-./}" && pwd -P ) || exit
-
-APP_NAME="Gradle"
+# This is normally unused
+# shellcheck disable=SC2034
 APP_BASE_NAME=${0##*/}
-
-# Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script.
-DEFAULT_JVM_OPTS='"-Xmx64m" "-Xms64m"'
+# Discard cd standard output in case $CDPATH is set (https://github.com/gradle/gradle/issues/25036)
+APP_HOME=$( cd -P "${APP_HOME:-./}" > /dev/null && printf '%s
+' "$PWD" ) || exit
 
 # Use the maximum available, or set MAX_FD != -1 to use that value.
 MAX_FD=maximum
@@ -133,22 +134,29 @@ location of your Java installation."
     fi
 else
     JAVACMD=java
-    which java >/dev/null 2>&1 || die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH.
+    if ! command -v java >/dev/null 2>&1
+    then
+        die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH.
 
 Please set the JAVA_HOME variable in your environment to match the
 location of your Java installation."
+    fi
 fi
 
 # Increase the maximum file descriptors if we can.
 if ! "$cygwin" && ! "$darwin" && ! "$nonstop" ; then
     case $MAX_FD in #(
       max*)
+        # In POSIX sh, ulimit -H is undefined. That's why the result is checked to see if it worked.
+        # shellcheck disable=SC2039,SC3045
         MAX_FD=$( ulimit -H -n ) ||
             warn "Could not query maximum file descriptor limit"
     esac
     case $MAX_FD in  #(
       '' | soft) :;; #(
       *)
+        # In POSIX sh, ulimit -n is undefined. That's why the result is checked to see if it worked.
+        # shellcheck disable=SC2039,SC3045
         ulimit -n "$MAX_FD" ||
             warn "Could not set maximum file descriptor limit to $MAX_FD"
     esac
@@ -193,18 +201,28 @@ if "$cygwin" || "$msys" ; then
     done
 fi
 
-# Collect all arguments for the java command;
-#   * $DEFAULT_JVM_OPTS, $JAVA_OPTS, and $GRADLE_OPTS can contain fragments of
-#     shell script including quotes and variable substitutions, so put them in
-#     double quotes to make sure that they get re-expanded; and
-#   * put everything else in single quotes, so that it's not re-expanded.
+
+# Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script.
+DEFAULT_JVM_OPTS='"-Xmx64m" "-Xms64m"'
+
+# Collect all arguments for the java command:
+#   * DEFAULT_JVM_OPTS, JAVA_OPTS, JAVA_OPTS, and optsEnvironmentVar are not allowed to contain shell fragments,
+#     and any embedded shellness will be escaped.
+#   * For example: A user cannot expect ${Hostname} to be expanded, as it is an environment variable and will be
+#     treated as '${Hostname}' itself on the command line.
 
 set -- \
         "-Dorg.gradle.appname=$APP_BASE_NAME" \
         -classpath "$CLASSPATH" \
         org.gradle.wrapper.GradleWrapperMain \
         "$@"
 
+# Stop when "xargs" is not available.
+if ! command -v xargs >/dev/null 2>&1
+then
+    die "xargs is not available"
+fi
+
 # Use "xargs" to parse quoted args.
 #
 # With -n1 it outputs one arg per line, with the quotes and backslashes removed.

gradle/wrapper/gradle-wrapper.properties

@@ -13,8 +13,10 @@
 @rem See the License for the specific language governing permissions and
 @rem limitations under the License.
 @rem
+@rem SPDX-License-Identifier: Apache-2.0
+@rem
 
-@if "%DEBUG%" == "" @echo off
+@if "%DEBUG%"=="" @echo off
 @rem ##########################################################################
 @rem
 @rem  Gradle startup script for Windows
@@ -25,7 +27,8 @@
 if "%OS%"=="Windows_NT" setlocal
 
 set DIRNAME=%~dp0
-if "%DIRNAME%" == "" set DIRNAME=.
+if "%DIRNAME%"=="" set DIRNAME=.
+@rem This is normally unused
 set APP_BASE_NAME=%~n0
 set APP_HOME=%DIRNAME%
 
@@ -40,13 +43,13 @@ if defined JAVA_HOME goto findJavaFromJavaHome
 
 set JAVA_EXE=java.exe
 %JAVA_EXE% -version >NUL 2>&1
-if "%ERRORLEVEL%" == "0" goto execute
+if %ERRORLEVEL% equ 0 goto execute
 
-echo.
-echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH.
-echo.
-echo Please set the JAVA_HOME variable in your environment to match the
-echo location of your Java installation.
+echo. 1>&2
+echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. 1>&2
+echo. 1>&2
+echo Please set the JAVA_HOME variable in your environment to match the 1>&2
+echo location of your Java installation. 1>&2
 
 goto fail
 
@@ -56,11 +59,11 @@ set JAVA_EXE=%JAVA_HOME%/bin/java.exe
 
 if exist "%JAVA_EXE%" goto execute
 
-echo.
-echo ERROR: JAVA_HOME is set to an invalid directory: %JAVA_HOME%
-echo.
-echo Please set the JAVA_HOME variable in your environment to match the
-echo location of your Java installation.
+echo. 1>&2
+echo ERROR: JAVA_HOME is set to an invalid directory: %JAVA_HOME% 1>&2
+echo. 1>&2
+echo Please set the JAVA_HOME variable in your environment to match the 1>&2
+echo location of your Java installation. 1>&2
 
 goto fail
 
@@ -75,13 +78,15 @@ set CLASSPATH=%APP_HOME%\gradle\wrapper\gradle-wrapper.jar
 
 :end
 @rem End local scope for the variables with windows NT shell
-if "%ERRORLEVEL%"=="0" goto mainEnd
+if %ERRORLEVEL% equ 0 goto mainEnd
 
 :fail
 rem Set variable GRADLE_EXIT_CONSOLE if you need the _script_ return code instead of
 rem the _cmd.exe /c_ return code!
-if  not "" == "%GRADLE_EXIT_CONSOLE%" exit 1
-exit /b 1
+set EXIT_CODE=%ERRORLEVEL%
+if %EXIT_CODE% equ 0 set EXIT_CODE=1
+if not ""=="%GRADLE_EXIT_CONSOLE%" exit %EXIT_CODE%
+exit /b %EXIT_CODE%
 
 :mainEnd
 if "%OS%"=="Windows_NT" endlocal

gradlew

@@ -1,5 +1,5 @@
 /*
- * Copyright 2024 LiveKit, Inc.
+ * Copyright 2024-2025 LiveKit, Inc.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -19,6 +19,8 @@ package io.livekit.server
 import com.auth0.jwt.JWT
 import com.auth0.jwt.JWTCreator
 import com.auth0.jwt.algorithms.Algorithm
+import com.google.protobuf.MessageOrBuilder
+import livekit.LivekitRoom.RoomConfiguration
 import java.time.Instant
 import java.util.Date
 import java.util.concurrent.TimeUnit
@@ -84,6 +86,18 @@ class AccessToken(
      */
     val attributes = mutableMapOf<String, String>()
 
+    /**
+     * Use a named preset room configuration.
+     *
+     * Any options set in [roomConfiguration] will take precedence.
+     */
+    var roomPreset: String? = null
+
+    /**
+     * Configuration for when creating a room.
+     */
+    var roomConfiguration: RoomConfiguration? = null
+
     /**
      * Add [VideoGrant] to this token.
      */
@@ -166,11 +180,14 @@ class AccessToken(
             name?.let { claimsMap["name"] = it }
             metadata?.let { claimsMap["metadata"] = it }
             sha256?.let { claimsMap["sha256"] = it }
+            roomPreset?.let { claimsMap["roomPreset"] = it }
             attributes.toMap().let { attributesCopy ->
                 if (attributesCopy.isNotEmpty()) {
                     claimsMap["attributes"] = attributesCopy
                 }
             }
+            roomConfiguration?.let { claimsMap["roomConfig"] = it.toMap() }
+
             claimsMap["video"] = videoGrantsMap
             claimsMap["sip"] = sipGrantsMap
 
@@ -202,3 +219,17 @@ internal fun JWTCreator.Builder.withClaimAny(name: String, value: Any) {
         }
     }
 }
+
+internal fun MessageOrBuilder.toMap(): Map<String, *> {
+    val map = mutableMapOf<String, Any>()
+
+    for ((field, value) in allFields) {
+        if (value is MessageOrBuilder) {
+            map[field.name] = value.toMap()
+        } else {
+            map[field.name] = value
+        }
+    }
+
+    return map
+}

gradlew.bat

@@ -1,5 +1,5 @@
 /*
- * Copyright 2024 LiveKit, Inc.
+ * Copyright 2024-2025 LiveKit, Inc.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -18,6 +18,7 @@ package io.livekit.server
 
 import com.auth0.jwt.JWT
 import com.auth0.jwt.algorithms.Algorithm
+import livekit.LivekitRoom.RoomConfiguration
 import org.junit.jupiter.api.Test
 import java.util.Date
 import kotlin.test.assertEquals
@@ -34,12 +35,32 @@ class AccessTokenTest {
     fun createToken() {
         val token = AccessToken(KEY, SECRET)
 
+        val roomConfig = with(RoomConfiguration.newBuilder()) {
+            name = "name"
+            emptyTimeout = 1
+            departureTimeout = 2
+            maxParticipants = 3
+            minPlayoutDelay = 4
+            maxPlayoutDelay = 5
+            egress = with(egressBuilder) {
+                room = with(roomBuilder) {
+                    roomName = "name"
+                    buildPartial()
+                }
+                buildPartial()
+            }
+            syncStreams = true
+            build()
+        }
+
         token.expiration = Date(33254282804000) // 10/15/3023
         token.name = "name"
         token.identity = "identity"
         token.metadata = "metadata"
         token.sha256 = "gfedcba"
         token.attributes["key"] = "value"
+        token.roomPreset = "roomPreset"
+        token.roomConfiguration = roomConfig
 
         token.addGrants(RoomName("room_name"))
         token.addGrants(CanPublishSources(listOf("camera", "microphone")))
@@ -60,8 +81,10 @@ class AccessTokenTest {
         assertEquals(token.identity, claims["jti"]?.asString())
         assertEquals(token.metadata, claims["metadata"]?.asString())
         assertEquals(token.sha256, claims["sha256"]?.asString())
+        assertEquals(token.roomPreset, claims["roomPreset"]?.asString())
         assertEquals(token.expiration, decodedJWT.expiresAt)
         assertEquals(token.attributes["key"], claims["attributes"]?.asMap()?.get("key"))
+        assertEquals(token.roomConfiguration?.toMap(), claims["roomConfig"]?.asMap())
 
         val videoGrants = claims["video"]?.asMap()
         assertNotNull(videoGrants)
@@ -72,4 +95,30 @@ class AccessTokenTest {
         assertNotNull(sipGrants)
         assertEquals(true, sipGrants["admin"])
     }
+
+    @Test
+    fun protobufMapConversion() {
+        val roomConfig = with(RoomConfiguration.newBuilder()) {
+            name = "name"
+            emptyTimeout = 1
+            departureTimeout = 2
+            maxParticipants = 3
+            minPlayoutDelay = 4
+            maxPlayoutDelay = 5
+            egress = with(egressBuilder) {
+                room = with(roomBuilder) {
+                    roomName = "name"
+                    buildPartial()
+                }
+                buildPartial()
+            }
+            syncStreams = true
+            build()
+        }
+
+        val map = roomConfig.toMap()
+
+        assertEquals(roomConfig.emptyTimeout, map["empty_timeout"])
+        assertEquals(roomConfig.egress.room.roomName, ((map["egress"] as Map<*, *>)["room"] as Map<*, *>)["room_name"])
+    }
 }