Refactor and separate mutltitenant controller from AriesAgentController

entirely

* All functionality for multitenancy now in its own class
* AriesAgentController can not be used for multitenancy
* AriesAgentController simplified args only admin api required
* Webhook handling now optional
** Webhook URL etc only need to be and can be passed when webhook
listener method is invoked

Author: morrieinmaas

libs/aries-basic-controller/aries_basic_controller/aries_controller.py

@@ -37,38 +37,23 @@ class AriesAgentController:
     ----------
     admin_url : str
         The URL for the Admin API
-    webhook_host : str
-        The url of the webhook host
-    webhook_port : int
-        The exposed port for webhooks on the host
-    webhook_base : str
-        The base url for webhooks (default is "")
     is_multitenant : bool
         Initialise the multitenant interface (default is False)
     mediation : bool
         Initialise the mediation interface (default is False)
     api_key : str
         The API key (default is None)
-    wallet_id : str
-        The tenant wallet identifier (default is None)
     """
 
-    # TODO rethink how to initialise. Too many args?
-    # We can factor out webhook host etc further in future versions
-    # We could also remove the wallet id from this class if we wanted
-    # and enforce use of multitenant controller for multitenant use entirely
     admin_url: str
-    webhook_host: str = None
-    webhook_port: int = None
-    webhook_base: str = ""
     is_multitenant: bool = False
     mediation: bool = False
     api_key: str = None
-    wallet_id: str = None
 
     def __post_init__(self):
-        """Constructs additional attributes,
-        and logic defined by attributes set during initial instantiation
+        """Constructs additional attributes and logic
+        Creates headers, instantiates a client sessions and initialises
+        the controller interfaces for the aries swagger API.
         """
 
         self.webhook_site = None
@@ -83,12 +68,6 @@ def __post_init__(self):
         self.client_session: ClientSession = ClientSession(
             headers=self.headers)
 
-        self.webhook_listener: AriesWebhookListener = AriesWebhookListener(
-            webhook_host=self.webhook_host,
-            webhook_port=self.webhook_port,
-            webhook_base=self.webhook_base,
-            is_multitenant=self.is_multitenant)
-
         # Instantiate controllers
         self.connections = ConnectionsController(
             self.admin_url,
@@ -156,19 +135,27 @@ def __post_init__(self):
             self.client_session
         )
 
-    # TODO: Consider whether we want this to only be available in the
-    # multitennant controller. This still required here to update the
-    # base wallet for the current tutorials
-    def update_wallet_id(self, wallet_id: str):
-        """This wallet_id is used to register for webhooks
-        specific to this sub_wallet
+    def webhook_listener(
+                        self,
+                        webhook_host: str = None,
+                        webhook_port: str = None,
+                        webhook_base: str = ""):
+        """Create a webhooklisteners
 
         Args:
         ----
-        wallet_id : str
-            The tenant wallet identifier
+        webhook_host : str
+            The url of the webhook host (default is None)
+        webhook_port : int
+            The exposed port for webhooks on the host (default is None)
+        webhook_base : str
+            The base url for webhooks (default is "")
         """
-        self.wallet_id = wallet_id
+        self.webhook_listener: AriesWebhookListener = AriesWebhookListener(
+            webhook_host=webhook_host,
+            webhook_port=webhook_port,
+            webhook_base=webhook_base,
+            is_multitenant=self.is_multitenant)
 
     def update_api_key(self, api_key: str):
         """Update the API Key attribute and the header
@@ -234,11 +221,8 @@ def add_listener(self, listener):
         """
         try:
             pub_topic_path = listener['topic']
-            if self.wallet_id:
-                pub_topic_path = f"{self.wallet_id}.{pub_topic_path}"
             print("Subscribing too: " + pub_topic_path)
             pub.subscribe(listener["handler"], pub_topic_path)
-
             logger.debug("Lister added for topic : ", pub_topic_path)
         except Exception as exc:
             logger.warning(
@@ -281,12 +265,21 @@ def remove_all_listeners(self, topic: str = None):
                 f"Removing all webhooks listeners failed! {exc!r} occurred.")
 
     async def listen_webhooks(self):
-        if self.webhook_listener:
+        try:
             await self.webhook_listener.listen_webhooks()
+        except AttributeError:
+            logger.warning("Missing webhook listener.")
+        except Exception as exc:
+            logger.warning(
+                f"Listening webhooks failed! {exc!r} occurred.")
 
     async def terminate(self):
         await self.client_session.close()
         try:
             await self.webhook_listener.terminate()
         except AttributeError:
-            pass
+            # There is no webhook listener
+            return
+        except Exception as exc:
+            logger.warning(
+                f"Terminate webhooks listener exception!\n {exc!r} occurred.")

libs/aries-basic-controller/aries_basic_controller/aries_multitenant_controller.py

@@ -1,4 +1,5 @@
 from dataclasses import dataclass
+from pubsub import pub
 
 from .aries_controller import AriesAgentController
 
@@ -15,18 +16,6 @@ class AriesMultitenantController(AriesAgentController):
 
     Attributes:
     ----------
-    admin_url : str
-        The URL for the Admin API
-    webhook_host : str
-        The url of the webhook host
-    webhook_port : int
-        The exposed port for webhooks on the host
-    webhook_base : str
-        The base url for webhooks (default is "")
-    mediation : bool
-        Initialise the mediation interface (default is False)
-    api_key : str
-        The API key (default is None)
     wallet_id : str
         The tenant wallet identifier (default is None)
     is_multitenant : bool
@@ -35,6 +24,7 @@ class AriesMultitenantController(AriesAgentController):
         The tenant JW token (default is None)
     """
 
+    wallet_id: str = None
     is_multitenant: bool = True
     tenant_jwt: str = None
 
@@ -56,6 +46,40 @@ def __post_init__(self):
         # Update the current client session instantiated in the parent class
         self.client_session.headers.update(self.headers)
 
+    def add_listener(self, listener):
+        """Subscribe to a listeners for a topic
+        Overrides parent method and uses the tenant's wallet ID to
+        listen for that wallet's webhooks under the url defined
+        by the wallet ID.
+        Args:
+        ----
+        listener : dict
+            A dictionary comprised of "handler": handler (fct) and
+            "topic":"topicname" key-value pairs
+        """
+        try:
+            pub_topic_path = listener['topic']
+            if self.wallet_id:
+                pub_topic_path = f"{self.wallet_id}.{pub_topic_path}"
+            print("Subscribing too: " + pub_topic_path)
+            pub.subscribe(listener["handler"], pub_topic_path)
+
+            logger.debug("Lister added for topic : ", pub_topic_path)
+        except Exception as exc:
+            logger.warning(
+                f"Adding webhooks listener failed! {exc!r} occurred.")
+
+    def update_wallet_id(self, wallet_id: str):
+        """This wallet_id is used to register for webhooks
+        specific to this sub_wallet
+
+        Args:
+        ----
+        wallet_id : str
+            The tenant wallet identifier
+        """
+        self.wallet_id = wallet_id
+
     def update_tenant_jwt(self, tenant_jwt: str, wallet_id: str):
         """Update the tenant JW token attribute and the header
 

tutorials/4. Multitenancy/notebooks/external/Configure External Agent.ipynb

@@ -50,11 +50,19 @@
    "outputs": [],
    "source": [
     "# Based on the aca-py agent you wish to control\n",
-    "agent_controller = AriesAgentController(webhook_host=WEBHOOK_HOST, webhook_port=WEBHOOK_PORT,\n",
-    "                                       webhook_base=WEBHOOK_BASE, admin_url=ADMIN_URL)\n",
+    "agent_controller = AriesAgentController(admin_url=ADMIN_URL)\n",
     "    "
    ]
   },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "agent_controller.webhook_listener(webhook_host=WEBHOOK_HOST, webhook_port=WEBHOOK_PORT, webhook_base=WEBHOOK_BASE)"
+   ]
+  },
   {
    "cell_type": "markdown",
    "metadata": {},

tutorials/4. Multitenancy/notebooks/mediator/Configure Mediator.ipynb

@@ -32,17 +32,9 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 1,
+   "execution_count": null,
    "metadata": {},
-   "outputs": [
-    {
-     "name": "stdout",
-     "output_type": "stream",
-     "text": [
-      "IPython autoawait is `on`, and set to use `asyncio`\n"
-     ]
-    }
-   ],
+   "outputs": [],
    "source": [
     "%autoawait\n",
     "import time\n",
@@ -64,7 +56,7 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 2,
+   "execution_count": null,
    "metadata": {},
    "outputs": [],
    "source": [
@@ -78,13 +70,21 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 3,
+   "execution_count": null,
    "metadata": {},
    "outputs": [],
    "source": [
     "# Based on the aca-py agent you wish to control\n",
-    "agent_controller = AriesAgentController(webhook_host=WEBHOOK_HOST, webhook_port=WEBHOOK_PORT,\n",
-    "                                       webhook_base=WEBHOOK_BASE, admin_url=ADMIN_URL, mediation=True)"
+    "agent_controller = AriesAgentController(admin_url=ADMIN_URL, mediation=True)"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "agent_controller.webhook_listener(webhook_host=WEBHOOK_HOST, webhook_port=WEBHOOK_PORT, webhook_base=WEBHOOK_BASE)"
    ]
   },
   {
@@ -102,19 +102,10 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 4,
+   "execution_count": null,
    "metadata": {},
-   "outputs": [
-    {
-     "name": "stdout",
-     "output_type": "stream",
-     "text": [
-      "Subscribing too: connections\n"
-     ]
-    }
-   ],
+   "outputs": [],
    "source": [
-    "\n",
     "loop = asyncio.get_event_loop()\n",
     "loop.create_task(agent_controller.webhook_listener.listen_webhooks())\n",
     "\n",
@@ -147,34 +138,9 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 5,
+   "execution_count": null,
    "metadata": {},
-   "outputs": [
-    {
-     "name": "stdout",
-     "output_type": "stream",
-     "text": [
-      "Connection ID 96d27a0d-5eaa-45fe-89ed-de9117021758\n",
-      "Invitation\n",
-      "{'@type': 'did:sov:BzCbsNYhMrjHiqZDTUASHg;spec/connections/1.0/invitation', '@id': '290a620f-39a9-4d59-8f80-7f1a66fab9ec', 'recipientKeys': ['6jZbv5zZp8pmsqrG66BwXzqrr3NpEReHgpxuwLcaoxiP'], 'serviceEndpoint': 'https://eb407795fda3.ngrok.io', 'label': 'MEDIATOR'}\n",
-      "wallet None\n",
-      "Connection Handler Called\n",
-      "Connection 96d27a0d-5eaa-45fe-89ed-de9117021758 in State invitation\n",
-      "wallet None\n",
-      "Connection Handler Called\n",
-      "Connection a6e57fd2-7f5a-46be-a3b4-a008e4b958ae in State invitation\n",
-      "wallet None\n",
-      "Connection Handler Called\n",
-      "Connection a6e57fd2-7f5a-46be-a3b4-a008e4b958ae in State request\n",
-      "wallet None\n",
-      "Connection Handler Called\n",
-      "Connection a6e57fd2-7f5a-46be-a3b4-a008e4b958ae in State response\n",
-      "wallet None\n",
-      "Connection Handler Called\n",
-      "Connection a6e57fd2-7f5a-46be-a3b4-a008e4b958ae in State active\n"
-     ]
-    }
-   ],
+   "outputs": [],
    "source": [
     "# Create Invitation\n",
     "invite = await agent_controller.connections.create_invitation(multi_use=\"true\")\n",
@@ -217,23 +183,13 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 6,
+   "execution_count": null,
    "metadata": {
     "pycharm": {
      "name": "#%%\n"
     }
    },
-   "outputs": [
-    {
-     "name": "stdout",
-     "output_type": "stream",
-     "text": [
-      "Mediation Record\n",
-      "connection_id 49431565-9d12-42e9-8341-8699834fc785\n",
-      "State request\n"
-     ]
-    }
-   ],
+   "outputs": [],
    "source": [
     "response = await agent_controller.mediation.get_mediation_records()\n",
     "\n",