feat: WIP Load in Protocol Registry V2

Signed-off-by: Colton Wolkins (Laptop) <[email protected]>

Author: TheTechmage

acapy_agent/config/default_context.py

@@ -8,6 +8,7 @@
 from ..core.plugin_registry import PluginRegistry
 from ..core.profile import ProfileManager, ProfileManagerProvider
 from ..core.protocol_registry import ProtocolRegistry
+from ..didcomm_v2.protocol_registry import V2ProtocolRegistry
 from ..protocols.actionmenu.v1_0.base_service import BaseMenuService
 from ..protocols.actionmenu.v1_0.driver_service import DriverMenuService
 from ..protocols.introduction.v0_1.base_service import BaseIntroductionService
@@ -45,6 +46,7 @@ async def build_context(self) -> InjectionContext:
 
         # Global protocol registry
         context.injector.bind_instance(ProtocolRegistry, ProtocolRegistry())
+        context.injector.bind_instance(V2ProtocolRegistry, V2ProtocolRegistry())
 
         # Global goal code registry
         context.injector.bind_instance(GoalCodeRegistry, GoalCodeRegistry())
@@ -129,6 +131,7 @@ async def load_plugins(self, context: InjectionContext):
         # Register standard protocol plugins
         if not self.settings.get("transport.disabled"):
             plugin_registry.register_package("acapy_agent.protocols")
+            plugin_registry.register_package("acapy_agent.protocols_v2")
 
         # Currently providing admin routes only
         plugin_registry.register_plugin("acapy_agent.holder")

acapy_agent/core/plugin_registry.py

@@ -11,6 +11,7 @@
 from .error import ProtocolDefinitionValidationError
 from .goal_code_registry import GoalCodeRegistry
 from .protocol_registry import ProtocolRegistry
+from ..didcomm_v2.protocol_registry import V2ProtocolRegistry
 
 LOGGER = logging.getLogger(__name__)
 
@@ -218,8 +219,14 @@ async def load_protocol_version(
         version_definition: Optional[dict] = None,
     ):
         """Load a particular protocol version."""
+        v2_protocol_registry = context.inject(V2ProtocolRegistry)
         protocol_registry = context.inject(ProtocolRegistry)
         goal_code_registry = context.inject(GoalCodeRegistry)
+        if hasattr(mod, "HANDLERS"):
+            for message_type, handler in mod.HANDLERS:
+                v2_protocol_registry.register_handler(
+                    message_type, handler
+                )
         if hasattr(mod, "MESSAGE_TYPES"):
             protocol_registry.register_message_types(
                 mod.MESSAGE_TYPES, version_definition=version_definition

acapy_agent/protocols_v2/__init__.py

@@ -0,0 +1,10 @@
+"""Version definitions for this protocol."""
+
+versions = [
+    {
+        "major_version": 1,
+        "minimum_minor_version": 0,
+        "current_minor_version": 0,
+        "path": "v1_0",
+    }
+]

acapy_agent/protocols_v2/trustping/__init__.py

@@ -0,0 +1,49 @@
+"""Ping handler."""
+
+from .....messaging.base_handler import BaseHandler, BaseResponder, RequestContext
+from ..messages.ping import Ping
+from ..messages.ping_response import PingResponse
+
+
+class PingHandler(BaseHandler):
+    """Ping handler class."""
+
+    async def handle(self, context: RequestContext, responder: BaseResponder):
+        """Handle ping message.
+
+        Args:
+            context: Request context
+            responder: Responder used to reply
+
+        """
+        self._logger.debug(f"PingHandler called with context {context}")
+        assert isinstance(context.message, Ping)
+
+        self._logger.info(
+            "Received trust ping from: %s", context.message_receipt.sender_did
+        )
+
+        if not context.connection_ready:
+            self._logger.info(
+                "Connection not active, skipping ping response: %s",
+                context.message_receipt.sender_did,
+            )
+            return
+
+        if context.message.response_requested:
+            reply = PingResponse()
+            reply.assign_thread_from(context.message)
+            reply.assign_trace_from(context.message)
+            await responder.send_reply(reply)
+
+        if context.settings.get("debug.monitor_ping"):
+            await context.profile.notify(
+                "acapy::ping::received",
+                {
+                    "comment": context.message.comment,
+                    "connection_id": context.message_receipt.connection_id,
+                    "responded": context.message.response_requested,
+                    "state": "received",
+                    "thread_id": context.message._thread_id,
+                },
+            )

acapy_agent/protocols_v2/trustping/definition.py

@@ -0,0 +1,37 @@
+"""Ping response handler."""
+
+from .....messaging.base_handler import BaseHandler, BaseResponder, RequestContext
+from ..messages.ping_response import PingResponse
+
+
+class PingResponseHandler(BaseHandler):
+    """Ping response handler class."""
+
+    async def handle(self, context: RequestContext, responder: BaseResponder):
+        """Handle ping response message.
+
+        Args:
+            context: Request context
+            responder: Responder used to reply
+
+        """
+
+        self._logger.debug("PingResponseHandler called with context: %s", context)
+        assert isinstance(context.message, PingResponse)
+
+        self._logger.info(
+            "Received trust ping response from: %s", context.message_receipt.sender_did
+        )
+
+        if context.settings.get("debug.monitor_ping"):
+            await context.profile.notify(
+                "acapy::ping::response_received",
+                {
+                    "comment": context.message.comment,
+                    "connection_id": context.message_receipt.connection_id,
+                    "state": "response_received",
+                    "thread_id": context.message._thread_id,
+                },
+            )
+
+        # Nothing to do, Connection should be automatically promoted to 'active'