rename rtc/services to rtc/transports

Author: fkwp

docs/usage/configuration/config_documentation.md

@@ -2580,14 +2580,14 @@ turn_allow_guests: false
 Options related to advertise MatrixRTC backend infrastructure like SFUs.
 
 ---
-### `services`
+### `transports`
 
 *(array|null)*
 
 Example configuration:
 ```
 matrix_rtc:
-  services:
+  transports::
     - type: livekit
       livekit_service_url: https://matrix-rtc.example.com/livekit/jwt
 ```

synapse/config/matrixrtc.py

@@ -32,13 +32,18 @@ class MatrixRtcConfig(Config):
     def read_config(
         self, config: JsonDict, allow_secrets_in_config: bool, **kwargs: Any
     ) -> None:
+
         matrix_rtc: JsonDict = config.get("matrix_rtc", {})
-        self.services = matrix_rtc.get("services", [])
+        self.transports = matrix_rtc.get("transports", [])
 
-        if not isinstance(self.services, list):
+        if not isinstance(self.transports, list):
             raise ConfigError(
-                "MatrixRTC endpoints needs to be an array of endpoints", ("matrix_rtc",)
+                "MatrixRTC transports needs to be an array of transports",
+                ("matrix_rtc",)
             )
 
-        if any(("type" not in e for e in self.services)):
-            raise ConfigError("MatrixRTC endpoint is missing type", ("matrix_rtc",))
+        if any(("type" not in e for e in self.transports)):
+            raise ConfigError(
+                "MatrixRTC transport is missing type",
+                ("matrix_rtc",)
+            )

synapse/rest/client/matrixrtc.py

@@ -35,7 +35,7 @@
 
 
 class MatrixRTCRestServlet(RestServlet):
-    PATTERNS = client_patterns(r"/org\.matrix\.msc4143/rtc/services$", releases=())
+    PATTERNS = client_patterns(r"/org\.matrix\.msc4143/rtc/transports$", releases=())
     CATEGORY = "Client API requests"
 
     def __init__(self, hs: "HomeServer"):
@@ -47,10 +47,10 @@ async def on_GET(self, request: SynapseRequest) -> Tuple[int, JsonDict]:
         requester = await self.auth.get_user_by_req(request)
         logger.debug("hello %s", requester.user)
 
-        services = self.hs.config.matrix_rtc.services
+        transports = self.hs.config.matrix_rtc.transports
 
-        if services:
-            return 200, {"rtc_services": services}
+        if transports:
+            return 200, {"rtc_transports": transports}
         else:
             return 200, {}
 

tests/rest/client/test_matrixrtc.py

@@ -31,7 +31,7 @@
 RTC_ENDPOINT = {"type": "focusA", "required_field": "theField"}
 
 class MatrixRtcTestCase(unittest.HomeserverTestCase):
-    """Tests /rtc/endpoints REST API."""
+    """Tests /rtc/transports REST API."""
 
     servlets = [
         admin.register_servlets,
@@ -41,15 +41,15 @@ class MatrixRtcTestCase(unittest.HomeserverTestCase):
         matrixrtc.register_servlets
     ]
 
-    @unittest.override_config({"matrix_rtc": {"services": [RTC_ENDPOINT]}})
+    @unittest.override_config({"matrix_rtc": {"transports": [RTC_ENDPOINT]}})
     def test_matrixrtc_endpoints(self) -> None:
-        channel = self.make_request("GET", f"{PATH_PREFIX}/rtc/services")
+        channel = self.make_request("GET", f"{PATH_PREFIX}/rtc/transports")
         self.assertEqual(401, channel.code)
 
         self.register_user("user", "password")
         tok = self.login("user", "password")
-        channel = self.make_request("GET", f"{PATH_PREFIX}/rtc/services", access_token=tok)
+        channel = self.make_request("GET", f"{PATH_PREFIX}/rtc/transports", access_token=tok)
         self.assertEqual(200, channel.code)
 
-        self.assert_dict({"rtc_services": [RTC_ENDPOINT]}, channel.json_body)
+        self.assert_dict({"rtc_transports": [RTC_ENDPOINT]}, channel.json_body)