update python implementation

foxglove · Mar 18, 2024 · e4a1869 · e4a1869
1 parent be45d63
commit e4a1869
Show file tree

Hide file tree

Showing 4 changed files with 81 additions and 35 deletions.
diff --git a/python/src/foxglove_websocket/examples/json_server.py b/python/src/foxglove_websocket/examples/json_server.py
@@ -87,23 +87,35 @@ async def on_service_request(
         await server.add_service(
             {
                 "name": "example_set_bool",
-                "requestSchema": json.dumps(
-                    {
-                        "type": "object",
-                        "properties": {
-                            "data": {"type": "boolean"},
-                        },
-                    }
-                ),
-                "responseSchema": json.dumps(
-                    {
-                        "type": "object",
-                        "properties": {
-                            "success": {"type": "boolean"},
-                            "message": {"type": "string"},
-                        },
-                    }
-                ),
+                "request": {
+                    "encoding": "json",
+                    "schemaName": "requestSchema",
+                    "schemaEncoding": "jsonschema",
+                    "schema": json.dumps(
+                        {
+                            "type": "object",
+                            "properties": {
+                                "data": {"type": "boolean"},
+                            },
+                        }
+                    ),
+                },
+                "response": {
+                    "encoding": "json",
+                    "schemaName": "responseSchema",
+                    "schemaEncoding": "jsonschema",
+                    "schema": json.dumps(
+                        {
+                            "type": "object",
+                            "properties": {
+                                "success": {"type": "boolean"},
+                                "message": {"type": "string"},
+                            },
+                        }
+                    ),
+                },
+                "requestSchema": None,
+                "responseSchema": None,
                 "type": "example_set_bool",
             }
         )

diff --git a/python/src/foxglove_websocket/server/__init__.py b/python/src/foxglove_websocket/server/__init__.py
@@ -271,6 +271,15 @@ async def remove_channel(self, chan_id: ChannelId):
             )
 
     async def add_service(self, service: ServiceWithoutId) -> ServiceId:
+        if service.request is None and service.requestSchema is None:
+            raise ValueError(
+                f"Invalid service definition: Either 'request' or 'requestSchema' must be defined"
+            )
+        if service.response is None and service.responseSchema is None:
+            raise ValueError(
+                f"Invalid service definition: Either 'response' or 'responseSchema' must be defined"
+            )
+
         new_id = self._next_service_id
         self._next_service_id = ServiceId(new_id + 1)
         new_service = Service(id=new_id, **service)

diff --git a/python/src/foxglove_websocket/types.py b/python/src/foxglove_websocket/types.py
@@ -142,11 +142,24 @@ class Channel(ChannelWithoutId):
     id: ChannelId
 
 
+class ServiceRequestDefinition(TypedDict):
+    encoding: str
+    schemaName: str
+    schemaEncoding: str
+    schema: str
+
+
+class ServiceResponseDefinition(ServiceRequestDefinition):
+    pass
+
+
 class ServiceWithoutId(TypedDict):
     name: str
     type: str
-    requestSchema: str
-    responseSchema: str
+    request: Optional[ServiceRequestDefinition]
+    response: Optional[ServiceResponseDefinition]
+    requestSchema: Optional[str]
+    responseSchema: Optional[str]
 
 
 class Service(ServiceWithoutId):

diff --git a/python/tests/test_server.py b/python/tests/test_server.py
@@ -311,22 +311,34 @@ async def on_service_request(
         service: ServiceWithoutId = {
             "name": "set_bool",
             "type": "set_bool",
-            "requestSchema": json.dumps(
-                {
-                    "type": "object",
-                    "properties": {
-                        "data": {"type": "boolean"},
-                    },
-                }
-            ),
-            "responseSchema": json.dumps(
-                {
-                    "type": "object",
-                    "properties": {
-                        "success": {"type": "boolean"},
-                    },
-                }
-            ),
+            "request": {
+                "encoding": "json",
+                "schemaName": "requestSchema",
+                "schemaEncoding": "jsonschema",
+                "schema": json.dumps(
+                    {
+                        "type": "object",
+                        "properties": {
+                            "data": {"type": "boolean"},
+                        },
+                    }
+                ),
+            },
+            "response": {
+                "encoding": "json",
+                "schemaName": "responseSchema",
+                "schemaEncoding": "jsonschema",
+                "schema": json.dumps(
+                    {
+                        "type": "object",
+                        "properties": {
+                            "success": {"type": "boolean"},
+                        },
+                    }
+                ),
+            },
+            "requestSchema": None,
+            "responseSchema": None,
         }
         service_id = await server.add_service(service)