add pluggy on rasa_sdk

README.md

@@ -89,7 +89,6 @@ RUN pip install --no-cache-dir <A_REQUIRED_PACKAGE_ON_PYPI>
 USER 1001
 ```
 
-
 ## Building from source
 
 Rasa SDK uses Poetry for packaging and dependency management. If you want to build it from source,

changelog/970.feature.md

@@ -0,0 +1 @@
+Add pluggy to provide ability to create sanic extensions in rasa-sdk

pyproject.toml

@@ -92,6 +92,7 @@ Sanic-Cors = "^2.0.0"
 prompt-toolkit = "^3.0,<3.0.29"
 "ruamel.yaml" = ">=0.16.5,<0.18.0"
 websockets = ">=10.0,<11.0"
+pluggy = "^1.0.0"
 
 [tool.poetry.dev-dependencies]
 pytest-cov = "^4.0.0"

rasa_sdk/__init__.py

@@ -2,6 +2,7 @@
 
 import rasa_sdk.cli
 import rasa_sdk.version
+import rasa_sdk.plugin
 from rasa_sdk.interfaces import Tracker, Action, ActionExecutionRejection  # noqa: F401
 from rasa_sdk.forms import ValidationAction, FormValidationAction  # noqa: F401
 

rasa_sdk/endpoint.py

@@ -17,6 +17,7 @@
 from rasa_sdk.constants import DEFAULT_SERVER_PORT
 from rasa_sdk.executor import ActionExecutor
 from rasa_sdk.interfaces import ActionExecutionRejection, ActionNotFoundException
+from rasa_sdk.plugin import plugin_manager
 
 logger = logging.getLogger(__name__)
 
@@ -156,6 +157,9 @@ def run(
     app = create_app(
         action_package_name, cors_origins=cors_origins, auto_reload=auto_reload
     )
+    ## Attach additional sanic extensions: listeners, middleware and routing
+    logger.info("Starting plugins...")
+    plugin_manager().hook.attach_sanic_app_extensions(app=app)
     ssl_context = create_ssl_context(ssl_certificate, ssl_keyfile, ssl_password)
     protocol = "https" if ssl_context else "http"
     host = os.environ.get("SANIC_HOST", "0.0.0.0")

rasa_sdk/plugin.py

@@ -0,0 +1,36 @@
+import functools
+import sys
+import logging
+import pluggy
+
+from sanic import Sanic
+
+hookspec = pluggy.HookspecMarker("rasa_sdk")
+logger = logging.getLogger(__name__)
+
+
+@functools.lru_cache(maxsize=2)
+def plugin_manager() -> pluggy.PluginManager:
+    """Initialises a plugin manager which registers hook implementations."""
+    _plugin_manager = pluggy.PluginManager("rasa_sdk")
+    _plugin_manager.add_hookspecs(sys.modules["rasa_sdk.plugin"])
+    _discover_plugins(_plugin_manager)
+
+    return _plugin_manager
+
+
+def _discover_plugins(manager: pluggy.PluginManager) -> None:
+    try:
+        # rasa_sdk_plugin is a custom package
+        # which extends existing functionality on rasa action server via plugins
+        import rasa_sdk_plugins
+
+        rasa_sdk_plugins.init_hooks(manager)
+    except ModuleNotFoundError as e:
+        logger.info("No plugins found", exc_info=e)
+        pass
+
+
+@hookspec
+def attach_sanic_app_extensions(app: Sanic) -> None:
+    """Hook specification for attaching sanic listeners, routes and middlewares."""

tests/test_plugin.py

@@ -0,0 +1,40 @@
+import warnings
+
+from pytest import MonkeyPatch
+from pluggy import PluginManager
+from unittest.mock import MagicMock
+
+from rasa_sdk import endpoint
+from rasa_sdk.plugin import plugin_manager
+
+
+def test_plugin_manager() -> None:
+    manager = plugin_manager()
+    assert isinstance(manager, PluginManager)
+
+    manager_2 = plugin_manager()
+    assert manager_2 == manager
+
+
+def test_plugin_attach_sanic_app_extension(
+    monkeypatch: MonkeyPatch,
+) -> None:
+    manager = plugin_manager()
+    monkeypatch.setattr(
+        manager.hook, "attach_sanic_app_extensions", MagicMock(return_value=None)
+    )
+    app_mock = MagicMock()
+
+    # Create a MagicMock object to replace the create_app() method
+    create_app_mock = MagicMock(return_value=app_mock)
+
+    # Set the create_app() method to return create_app_mock
+    monkeypatch.setattr("rasa_sdk.endpoint.create_app", create_app_mock)
+
+    # Set the return value of app_mock.run() to None
+    app_mock.run.return_value = None
+
+    with warnings.catch_warnings():
+        warnings.simplefilter("error")
+        endpoint.run("actions")
+    manager.hook.attach_sanic_app_extensions.assert_called_once_with(app=app_mock)