many: pass data directly to event handler & add more tests for subscribe object

Author: Mahad-10

tests/codec_test.py

@@ -4,11 +4,11 @@
 from typing import Type, TypeVar, Any
 
 import capnp
+import pytest
 from google.protobuf.message import Message
 
 from xconn.client import connect_anonymous
 from xconn import codec
-from xconn.types import Event
 from tests.schemas.profile_pb2 import ProfileCreate, ProfileGet
 
 
@@ -82,12 +82,63 @@ def test_pubsub_object():
     session = connect_anonymous("ws://localhost:8080/ws", "realm1")
     session.set_payload_codec(Base64Codec())
 
-    def event_handler(event: Event):
-        assert event.args[0] == "hello"
+    def event_handler(data: String):
+        assert data == "hello"
 
-    session.subscribe_object("io.xconn.object", event_handler, String)
+    session.subscribe_object("io.xconn.object", event_handler)
 
-    session.publish_object("io.xconn.object", String("hello"))
+    session.publish_object("io.xconn.object", String("hello"), {"acknowledge": True})
+
+    session.leave()
+
+
+def test_subscribe_object_without_codec():
+    session = connect_anonymous("ws://localhost:8080/ws", "realm1")
+
+    def event_handler(user: ProfileCreate):
+        pass
+
+    with pytest.raises(ValueError, match="no payload codec set"):
+        session.subscribe_object("io.xconn.object", event_handler)
+
+    session.leave()
+
+
+def test_subscribe_object_without_args():
+    session = connect_anonymous("ws://localhost:8080/ws", "realm1")
+    session.set_payload_codec(Base64Codec())
+
+    def event_handler():
+        pass
+
+    with pytest.raises(ValueError, match="event handler must accept 1 argument"):
+        session.subscribe_object("io.xconn.object", event_handler)
+
+    session.leave()
+
+
+def test_subscribe_object_with_multiple_args():
+    session = connect_anonymous("ws://localhost:8080/ws", "realm1")
+    session.set_payload_codec(ProtobufCodec())
+
+    def event_handler(user: ProfileCreate, a):
+        pass
+
+    with pytest.raises(ValueError, match="event handler must accept 1 argument"):
+        session.subscribe_object("io.xconn.object", event_handler)
+
+    session.leave()
+
+
+def test_subscribe_object_without_annotation():
+    session = connect_anonymous("ws://localhost:8080/ws", "realm1")
+    session.set_payload_codec(ProtobufCodec())
+
+    def event_handler(user):
+        pass
+
+    with pytest.raises(TypeError, match="event handler parameter must have a type annotation"):
+        session.subscribe_object("io.xconn.object", event_handler)
 
     session.leave()
 
@@ -96,16 +147,15 @@ def test_pubsub_protobuf():
     session = connect_anonymous("ws://localhost:8080/ws", "realm1")
     session.set_payload_codec(ProtobufCodec())
 
-    def event_handler(event: Event):
-        user: ProfileCreate = event.args[0]
+    def event_handler(user: ProfileCreate):
         assert user.username == "john"
         assert user.email == "[email protected]"
         assert user.age == 25
 
-    session.subscribe_object("io.xconn.object", event_handler, ProfileCreate)
+    session.subscribe_object("io.xconn.object", event_handler)
 
     create_msg = ProfileCreate(username="john", email="[email protected]", age=25)
-    session.publish_object("io.xconn.object", create_msg)
+    session.publish_object("io.xconn.object", create_msg, {"acknowledge": True})
 
     session.leave()
 
@@ -239,19 +289,18 @@ def test_pubsub_capnproto():
     session = connect_anonymous("ws://localhost:8080/ws", "realm1")
     session.set_payload_codec(CapnpProtoCodec())
 
-    def event_handler(event: Event):
-        user: UserCreate = event.args[0]
+    def event_handler(user: UserCreate):
         assert user.name == "alice"
         assert user.email == "[email protected]"
         assert user.age == 21
 
-    session.subscribe_object("io.xconn.object", event_handler, UserCreate)
+    session.subscribe_object("io.xconn.object", event_handler)
 
     new_user = UserCreate.new_message()
     new_user.name = "alice"
     new_user.email = "[email protected]"
     new_user.age = 21
 
-    session.publish_object("io.xconn.object", new_user)
+    session.publish_object("io.xconn.object", new_user, {"acknowledge": True})
 
     session.leave()

xconn/session.py

@@ -195,26 +195,37 @@ def call_object(self, procedure: str, request: TReq = None, return_type: Type[TR
 
         return None
 
-    def subscribe_object(self, topic: str, event_handler: Callable[[types.Event], None], return_type: Type[TRes]):
+    def subscribe_object(self, topic: str, event_handler: Callable[[TReq], None]):
         if self._payload_codec is None:
             raise ValueError("no payload codec set")
 
+        sig = inspect.signature(event_handler)
+
+        params = list(sig.parameters.values())
+        if len(params) != 1:
+            raise ValueError("event handler must accept 1 argument")
+
+        param_type = params[0].annotation
+        if param_type is inspect._empty:
+            raise TypeError("event handler parameter must have a type annotation")
+
         def _event_handler(event: types.Event):
-            if len(event.args) != 1:
+            if len(event.args) != 1 or len(event.kwargs) != 0:
                 raise ValueError("only one argument expected in event")
 
             data = event.args[0]
-            d = self._payload_codec.decode(data, return_type)
-            event_handler(types.Event(args=[d], kwargs={}, details={}))
+            request_obj = self._payload_codec.decode(data, param_type)
+            event_handler(request_obj)
 
         return self.subscribe(topic, _event_handler)
 
-    def publish_object(self, topic: str, request: TReq):
+    def publish_object(self, topic: str, request: TReq, options: dict[str, Any] | None = None):
         if self._payload_codec is None:
             raise ValueError("no payload codec set")
 
         encoded = self._payload_codec.encode(request)
-        return self.publish(topic, [encoded])
+
+        return self.publish(topic, [encoded], options=options)
 
     def register_object(
         self,