WIP Refactor and addressing review feedback.

* Rename webhook_listner to Wwebhook server
* Override the webhook server method in the TenantController
  * Disallow instantiating server in tenant controller
* make is_multitenant intrinsic (default True) tenant class attr instead
of passed param.
* TODO Decide on potential base class (possibly abstract) For the
controller to inherit from.

Author: morrieinmaas

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

@@ -20,7 +20,7 @@
 from .controllers.action_menu import ActionMenuController
 from .controllers.revocation import RevocationController
 
-from .aries_webhook_listener import AriesWebhookListener
+from .aries_webhook_server import AriesWebhookServer
 
 import logging
 
@@ -135,7 +135,7 @@ def __post_init__(self):
             self.client_session
         )
 
-    def webhook_listener(
+    def webhook_server(
                         self,
                         webhook_host: str = None,
                         webhook_port: str = None,
@@ -151,7 +151,7 @@ def webhook_listener(
         webhook_base : str
             The base url for webhooks (default is "")
         """
-        self.webhook_listener: AriesWebhookListener = AriesWebhookListener(
+        self.webhook_server: AriesWebhookServer = AriesWebhookServer(
             webhook_host=webhook_host,
             webhook_port=webhook_port,
             webhook_base=webhook_base,
@@ -266,7 +266,7 @@ def remove_all_listeners(self, topic: str = None):
 
     async def listen_webhooks(self):
         try:
-            await self.webhook_listener.listen_webhooks()
+            await self.webhook_server.listen_webhooks()
         except AttributeError:
             logger.warning("Missing webhook listener.")
         except Exception as exc:
@@ -276,7 +276,7 @@ async def listen_webhooks(self):
     async def terminate(self):
         await self.client_session.close()
         try:
-            await self.webhook_listener.terminate()
+            await self.webhook_server.terminate()
         except AttributeError:
             # There is no webhook listener
             return

libs/aries-basic-controller/aries_basic_controller/aries_multitenant_controller.py renamed to libs/aries-basic-controller/aries_basic_controller/aries_tenant_controller.py

@@ -5,28 +5,25 @@
 
 import logging
 
-logger = logging.getLogger("aries_controller")
+logger = logging.getLogger("aries_tenant_controller")
 
 
 @dataclass
-class AriesMultitenantController(AriesAgentController):
+class AriesTenantController(AriesAgentController):
     """The Aries Agent Controller class
 
     This class allows you to interact with Aries by exposing the aca-py API. 
 
     Attributes:
     ----------
     wallet_id : str
-        The tenant wallet identifier (default is None)
-    is_multitenant : bool
-        Initialise the multitenant interface (default is True)
+        The tenant wallet identifier
     tenant_jwt : str
-        The tenant JW token (default is None)
+        The tenant JW token
     """
 
-    wallet_id: str = None
-    is_multitenant: bool = True
-    tenant_jwt: str = None
+    wallet_id: str
+    tenant_jwt: str
 
     def __post_init__(self):
         """Constructs additional attributes,
@@ -35,6 +32,8 @@ def __post_init__(self):
 
         super().__post_init__()
 
+        self.is_multitenant: bool = True
+
         if self.api_key:
             self.headers.update({"X-API-Key": self.api_key})
 
@@ -46,6 +45,10 @@ def __post_init__(self):
         # Update the current client session instantiated in the parent class
         self.client_session.headers.update(self.headers)
 
+    def webhook_server():
+        raise NotImplementedError(
+            "Please, use an AriesAgentController to start a webhook server.")
+
     def add_listener(self, listener):
         """Subscribe to a listeners for a topic
         Overrides parent method and uses the tenant's wallet ID to

libs/aries-basic-controller/aries_basic_controller/aries_webhook_listener.py renamed to libs/aries-basic-controller/aries_basic_controller/aries_webhook_server.py

@@ -6,11 +6,11 @@
 from pubsub import pub
 import logging
 
-logger = logging.getLogger("aries_webhook_listener")
+logger = logging.getLogger("aries_webhook_server")
 
 
 @dataclass
-class AriesWebhookListener:
+class AriesWebhookServer:
     """The Aries Webhook Listener class
 
     This class allows you to interact with Aries by exposing the aca-py API.