canvas 0.16.0__py3-none-any.whl → 0.18.0__py3-none-any.whl

plugin_runner/plugin_runner.py

@@ -2,17 +2,17 @@ import asyncio
 import json
 import os
 import pathlib
+import pickle
 import pkgutil
-import signal
 import sys
 import time
 import traceback
 from collections import defaultdict
 from collections.abc import AsyncGenerator
-from types import FrameType
 from typing import Any, TypedDict
 
 import grpc
+import redis.asyncio as redis
 import statsd
 
 from canvas_generated.messages.effects_pb2 import EffectType
@@ -30,9 +30,15 @@ from canvas_sdk.protocols import ClinicalQualityMeasure
 from canvas_sdk.utils.stats import get_duration_ms, tags_to_line_protocol
 from logger import log
 from plugin_runner.authentication import token_for_plugin
-from plugin_runner.plugin_synchronizer import publish_message
+from plugin_runner.plugin_installer import install_plugins
 from plugin_runner.sandbox import Sandbox
-from settings import MANIFEST_FILE_NAME, PLUGIN_DIRECTORY, SECRETS_FILE_NAME
+from settings import (
+    CHANNEL_NAME,
+    MANIFEST_FILE_NAME,
+    PLUGIN_DIRECTORY,
+    REDIS_ENDPOINT,
+    SECRETS_FILE_NAME,
+)
 
 # when we import plugins we'll use the module name directly so we need to add the plugin
 # directory to the path
@@ -192,14 +198,50 @@ class PluginRunner(PluginRunnerServicer):
         self, request: ReloadPluginsRequest, context: Any
     ) -> AsyncGenerator[ReloadPluginsResponse, None]:
         """This is invoked when we need to reload plugins."""
+        log.info("Reloading plugins...")
         try:
-            publish_message({"action": "restart"})
+            await publish_message(message={"action": "reload"})
         except ImportError:
             yield ReloadPluginsResponse(success=False)
         else:
             yield ReloadPluginsResponse(success=True)
 
 
+async def synchronize_plugins(max_iterations: None | int = None) -> None:
+    """Listen for messages on the pubsub channel that will indicate it is necessary to reinstall and reload plugins."""
+    client, pubsub = get_client()
+    await pubsub.psubscribe(CHANNEL_NAME)
+    log.info("Listening for messages on pubsub channel")
+    iterations: int = 0
+    while (
+        max_iterations is None or iterations < max_iterations
+    ):  # max_iterations == -1 means infinite iterations
+        iterations += 1
+        message = await pubsub.get_message(ignore_subscribe_messages=True, timeout=None)
+        if message is not None:
+            log.info("Received message from pubsub channel")
+
+            message_type = message.get("type", "")
+
+            if message_type != "pmessage":
+                continue
+
+            data = pickle.loads(message.get("data", pickle.dumps({})))
+
+            if "action" not in data:
+                continue
+
+            if data["action"] == "reload":
+                try:
+                    log.info(
+                        "plugin-synchronizer: installing and reloading plugins after receiving command"
+                    )
+                    install_plugins()
+                    load_plugins()
+                except Exception as e:
+                    print("plugin-synchronizer: `install_plugins` failed:", e)
+
+
 def validate_effects(effects: list[Effect]) -> list[Effect]:
     """Validates the effects based on predefined rules.
     Keeps only the first AUTOCOMPLETE_SEARCH_RESULTS effect and preserve all non-search-related effects.
@@ -237,12 +279,6 @@ def apply_effects_to_context(effects: list[Effect], event: Event) -> Event:
     return event
 
 
-def handle_hup_cb(_signum: int, _frame: FrameType | None) -> None:
-    """handle_hup_cb."""
-    log.info("Received SIGHUP, reloading plugins...")
-    load_plugins()
-
-
 def find_modules(base_path: pathlib.Path, prefix: str | None = None) -> list[str]:
     """Find all modules in the specified package path."""
     modules: list[str] = []
@@ -273,6 +309,22 @@ def sandbox_from_module(base_path: pathlib.Path, module_name: str) -> Any:
     return sandbox.execute()
 
 
+async def publish_message(message: dict) -> None:
+    """Publish a message to the pubsub channel."""
+    log.info("Publishing message to pubsub channel")
+    client, _ = get_client()
+
+    await client.publish(CHANNEL_NAME, pickle.dumps(message))
+
+
+def get_client() -> tuple[redis.Redis, redis.client.PubSub]:
+    """Return an async Redis client and pubsub object."""
+    client = redis.Redis.from_url(REDIS_ENDPOINT)
+    pubsub = client.pubsub()
+
+    return client, pubsub
+
+
 def load_or_reload_plugin(path: pathlib.Path) -> None:
     """Given a path, load or reload a plugin."""
     log.info(f"Loading {path}")
@@ -415,6 +467,7 @@ async def serve(specified_plugin_paths: list[str] | None = None) -> None:
 
     log.info(f"Starting server, listening on port {port}")
 
+    install_plugins()
     load_plugins(specified_plugin_paths)
 
     await server.start()
@@ -434,10 +487,10 @@ def run_server(specified_plugin_paths: list[str] | None = None) -> None:
 
     asyncio.set_event_loop(loop)
 
-    signal.signal(signal.SIGHUP, handle_hup_cb)
-
     try:
-        loop.run_until_complete(serve(specified_plugin_paths))
+        loop.run_until_complete(
+            asyncio.gather(serve(specified_plugin_paths), synchronize_plugins())
+        )
     except KeyboardInterrupt:
         pass
     finally:

plugin_runner/tests/test_plugin_runner.py

@@ -1,7 +1,9 @@
+import asyncio
 import logging
+import pickle
 import shutil
 from pathlib import Path
-from unittest.mock import MagicMock, patch
+from unittest.mock import AsyncMock, MagicMock, patch
 
 import pytest
 
@@ -14,6 +16,7 @@ from plugin_runner.plugin_runner import (
     PluginRunner,
     load_or_reload_plugin,
     load_plugins,
+    synchronize_plugins,
 )
 
 
@@ -229,24 +232,53 @@ async def test_handle_plugin_event_returns_expected_result(
 
 
 @pytest.mark.asyncio
-@pytest.mark.parametrize("install_test_plugin", ["example_plugin"], indirect=True)
 async def test_reload_plugins_event_handler_successfully_publishes_message(
-    install_test_plugin: Path, plugin_runner: PluginRunner
+    plugin_runner: PluginRunner,
 ) -> None:
     """Test ReloadPlugins Event handler successfully publishes a message with restart action."""
-    with patch("plugin_runner.plugin_runner.publish_message", MagicMock()) as mock_publish_message:
+    with patch(
+        "plugin_runner.plugin_runner.publish_message", new_callable=AsyncMock
+    ) as mock_publish_message:
         request = ReloadPluginsRequest()
 
         result = []
         async for response in plugin_runner.ReloadPlugins(request, None):
             result.append(response)
 
-        mock_publish_message.assert_called_once_with({"action": "restart"})
+        mock_publish_message.assert_called_once_with(message={"action": "reload"})
 
     assert len(result) == 1
     assert result[0].success is True
 
 
+@pytest.mark.asyncio
+async def test_synchronize_plugins_calls_install_and_load_plugins() -> None:
+    """Test that synchronize_plugins calls install_plugins and load_plugins."""
+    with (
+        patch("plugin_runner.plugin_runner.get_client", new_callable=MagicMock) as mock_get_client,
+        patch(
+            "plugin_runner.plugin_runner.install_plugins", new_callable=AsyncMock
+        ) as mock_install_plugins,
+        patch(
+            "plugin_runner.plugin_runner.load_plugins", new_callable=AsyncMock
+        ) as mock_load_plugins,
+    ):
+        mock_client = AsyncMock()
+        mock_pubsub = AsyncMock()
+        mock_get_client.return_value = (mock_client, mock_pubsub)
+        mock_pubsub.get_message.return_value = {
+            "type": "pmessage",
+            "data": pickle.dumps({"action": "reload"}),
+        }
+
+        task = asyncio.create_task(synchronize_plugins(max_iterations=1))
+        await asyncio.sleep(0.1)  # Give some time for the coroutine to run
+        task.cancel()
+
+        mock_install_plugins.assert_called_once()
+        mock_load_plugins.assert_called_once()
+
+
 @pytest.mark.asyncio
 @pytest.mark.parametrize("install_test_plugin", ["test_module_imports_plugin"], indirect=True)
 async def test_changes_to_plugin_modules_should_be_reflected_after_reload(

protobufs/canvas_generated/messages/effects.proto

@@ -0,0 +1,225 @@
+syntax = 'proto3';
+
+package canvas;
+
+enum EffectType {
+  UNKNOWN_EFFECT = 0;
+
+  LOG = 1;
+  ADD_PLAN_COMMAND = 2;
+
+  AUTOCOMPLETE_SEARCH_RESULTS = 3;
+
+  ADD_BANNER_ALERT = 4;
+  REMOVE_BANNER_ALERT = 5;
+
+  ORIGINATE_ASSESS_COMMAND = 6;
+  EDIT_ASSESS_COMMAND = 7;
+  DELETE_ASSESS_COMMAND = 8;
+  COMMIT_ASSESS_COMMAND = 9;
+  ENTER_IN_ERROR_ASSESS_COMMAND = 10;
+
+  ORIGINATE_DIAGNOSE_COMMAND = 11;
+  EDIT_DIAGNOSE_COMMAND = 12;
+  DELETE_DIAGNOSE_COMMAND = 13;
+  COMMIT_DIAGNOSE_COMMAND = 14;
+  ENTER_IN_ERROR_DIAGNOSE_COMMAND = 15;
+
+  ORIGINATE_GOAL_COMMAND = 16;
+  EDIT_GOAL_COMMAND = 17;
+  DELETE_GOAL_COMMAND = 18;
+  COMMIT_GOAL_COMMAND = 19;
+  ENTER_IN_ERROR_GOAL_COMMAND = 20;
+
+  ORIGINATE_HPI_COMMAND = 21;
+  EDIT_HPI_COMMAND = 22;
+  DELETE_HPI_COMMAND = 23;
+  COMMIT_HPI_COMMAND = 24;
+  ENTER_IN_ERROR_HPI_COMMAND = 25;
+
+  ORIGINATE_MEDICATION_STATEMENT_COMMAND = 26;
+  EDIT_MEDICATION_STATEMENT_COMMAND = 27;
+  DELETE_MEDICATION_STATEMENT_COMMAND = 28;
+  COMMIT_MEDICATION_STATEMENT_COMMAND = 29;
+  ENTER_IN_ERROR_MEDICATION_STATEMENT_COMMAND = 30;
+
+  ORIGINATE_PLAN_COMMAND = 31;
+  EDIT_PLAN_COMMAND = 32;
+  DELETE_PLAN_COMMAND = 33;
+  COMMIT_PLAN_COMMAND = 34;
+  ENTER_IN_ERROR_PLAN_COMMAND = 35;
+
+  ORIGINATE_PRESCRIBE_COMMAND = 36;
+  EDIT_PRESCRIBE_COMMAND = 37;
+  DELETE_PRESCRIBE_COMMAND = 38;
+  COMMIT_PRESCRIBE_COMMAND = 39;
+  ENTER_IN_ERROR_PRESCRIBE_COMMAND = 40;
+
+  ORIGINATE_QUESTIONNAIRE_COMMAND = 41;
+  EDIT_QUESTIONNAIRE_COMMAND = 42;
+  DELETE_QUESTIONNAIRE_COMMAND = 43;
+  COMMIT_QUESTIONNAIRE_COMMAND = 44;
+  ENTER_IN_ERROR_QUESTIONNAIRE_COMMAND = 45;
+
+  ORIGINATE_REASON_FOR_VISIT_COMMAND = 46;
+  EDIT_REASON_FOR_VISIT_COMMAND = 47;
+  DELETE_REASON_FOR_VISIT_COMMAND = 48;
+  COMMIT_REASON_FOR_VISIT_COMMAND = 49;
+  ENTER_IN_ERROR_REASON_FOR_VISIT_COMMAND = 50;
+
+  ORIGINATE_STOP_MEDICATION_COMMAND = 51;
+  EDIT_STOP_MEDICATION_COMMAND = 52;
+  DELETE_STOP_MEDICATION_COMMAND = 53;
+  COMMIT_STOP_MEDICATION_COMMAND = 54;
+  ENTER_IN_ERROR_STOP_MEDICATION_COMMAND = 55;
+
+  ORIGINATE_UPDATE_GOAL_COMMAND = 56;
+  EDIT_UPDATE_GOAL_COMMAND = 57;
+  DELETE_UPDATE_GOAL_COMMAND = 58;
+  COMMIT_UPDATE_GOAL_COMMAND = 59;
+  ENTER_IN_ERROR_UPDATE_GOAL_COMMAND = 60;
+
+  ORIGINATE_PERFORM_COMMAND = 61;
+  EDIT_PERFORM_COMMAND = 62;
+  DELETE_PERFORM_COMMAND = 63;
+  COMMIT_PERFORM_COMMAND = 64;
+  ENTER_IN_ERROR_PERFORM_COMMAND = 65;
+
+  ORIGINATE_INSTRUCT_COMMAND = 66;
+  EDIT_INSTRUCT_COMMAND = 67 ;
+  DELETE_INSTRUCT_COMMAND = 68;
+  COMMIT_INSTRUCT_COMMAND = 69;
+  ENTER_IN_ERROR_INSTRUCT_COMMAND = 70;
+
+  ORIGINATE_LAB_ORDER_COMMAND = 71;
+  EDIT_LAB_ORDER_COMMAND = 72;
+  DELETE_LAB_ORDER_COMMAND = 73;
+  COMMIT_LAB_ORDER_COMMAND = 74;
+  ENTER_IN_ERROR_LAB_ORDER_COMMAND = 75;
+
+  ORIGINATE_FAMILY_HISTORY_COMMAND = 76;
+  EDIT_FAMILY_HISTORY_COMMAND = 77;
+  DELETE_FAMILY_HISTORY_COMMAND = 78;
+  COMMIT_FAMILY_HISTORY_COMMAND = 79;
+  ENTER_IN_ERROR_FAMILY_HISTORY_COMMAND = 80;
+
+  ORIGINATE_ALLERGY_COMMAND = 81;
+  EDIT_ALLERGY_COMMAND = 82;
+  DELETE_ALLERGY_COMMAND = 83;
+  COMMIT_ALLERGY_COMMAND = 84;
+  ENTER_IN_ERROR_ALLERGY_COMMAND = 85;
+
+  ORIGINATE_REMOVE_ALLERGY_COMMAND = 86;
+  EDIT_REMOVE_ALLERGY_COMMAND = 87;
+  DELETE_REMOVE_ALLERGY_COMMAND = 88;
+  COMMIT_REMOVE_ALLERGY_COMMAND = 89;
+  ENTER_IN_ERROR_REMOVE_ALLERGY_COMMAND = 90;
+
+  ORIGINATE_SURGICAL_HISTORY_COMMAND = 91;
+  EDIT_SURGICAL_HISTORY_COMMAND = 92;
+  DELETE_SURGICAL_HISTORY_COMMAND = 93;
+  COMMIT_SURGICAL_HISTORY_COMMAND = 94;
+  ENTER_IN_ERROR_SURGICAL_HISTORY_COMMAND = 95;
+
+  CREATE_TASK = 100;
+  UPDATE_TASK = 101;
+  CREATE_TASK_COMMENT = 102;
+
+  ORIGINATE_MEDICAL_HISTORY_COMMAND = 103;
+  EDIT_MEDICAL_HISTORY_COMMAND = 104;
+  DELETE_MEDICAL_HISTORY_COMMAND = 105;
+  COMMIT_MEDICAL_HISTORY_COMMAND = 106;
+  ENTER_IN_ERROR_MEDICAL_HISTORY_COMMAND = 107;
+
+  ADD_OR_UPDATE_PROTOCOL_CARD = 110;
+
+  ORIGINATE_TASK_COMMAND = 133;
+  EDIT_TASK_COMMAND = 134;
+  DELETE_TASK_COMMAND = 135;
+  COMMIT_TASK_COMMAND = 136;
+  ENTER_IN_ERROR_TASK_COMMAND = 137;
+
+  ORIGINATE_REFILL_COMMAND = 113;
+  EDIT_REFILL_COMMAND = 114;
+  DELETE_REFILL_COMMAND = 115;
+  COMMIT_REFILL_COMMAND = 116;
+  ENTER_IN_ERROR_REFILL_COMMAND = 117;
+
+  ORIGINATE_VITALS_COMMAND = 118;
+  EDIT_VITALS_COMMAND = 119;
+  DELETE_VITALS_COMMAND = 120;
+  COMMIT_VITALS_COMMAND = 121;
+  ENTER_IN_ERROR_VITALS_COMMAND = 122;
+
+  ORIGINATE_UPDATE_DIAGNOSIS_COMMAND = 123;
+  EDIT_UPDATE_DIAGNOSIS_COMMAND = 124;
+  DELETE_UPDATE_DIAGNOSIS_COMMAND = 125;
+  COMMIT_UPDATE_DIAGNOSIS_COMMAND = 126;
+  ENTER_IN_ERROR_UPDATE_DIAGNOSIS_COMMAND = 127;
+
+  ORIGINATE_CLOSE_GOAL_COMMAND = 128;
+  EDIT_CLOSE_GOAL_COMMAND = 129;
+  DELETE_CLOSE_GOAL_COMMAND = 130;
+  COMMIT_CLOSE_GOAL_COMMAND = 131;
+  ENTER_IN_ERROR_CLOSE_GOAL_COMMAND = 132;
+
+  CREATE_QUESTIONNAIRE_RESULT = 138;
+
+  ANNOTATE_PATIENT_CHART_CONDITION_RESULTS = 200;
+
+  ANNOTATE_CLAIM_CONDITION_RESULTS = 300;
+
+  SHOW_PATIENT_CHART_SUMMARY_SECTIONS = 400;
+
+  SHOW_PATIENT_PROFILE_SECTIONS = 500;
+
+  PATIENT_PROFILE__ADD_PHARMACY__POST_SEARCH_RESULTS = 501;
+
+  SEND_SURESCRIPTS_ELIGIBILITY_REQUEST = 600;
+  SEND_SURESCRIPTS_MEDICATION_HISTORY_REQUEST = 601;
+  SEND_SURESCRIPTS_BENEFITS_REQUEST = 602;
+
+  ORIGINATE_EXAM_COMMAND = 700;
+  EDIT_EXAM_COMMAND = 701;
+  DELETE_EXAM_COMMAND = 702;
+  COMMIT_EXAM_COMMAND = 703;
+  ENTER_IN_ERROR_EXAM_COMMAND = 704;
+
+  ORIGINATE_ROS_COMMAND = 800;
+  EDIT_ROS_COMMAND = 801;
+  DELETE_ROS_COMMAND = 802;
+  COMMIT_ROS_COMMAND = 803;
+  ENTER_IN_ERROR_ROS_COMMAND = 804;
+
+  ORIGINATE_STRUCTURED_ASSESSMENT_COMMAND = 900;
+  EDIT_STRUCTURED_ASSESSMENT_COMMAND = 901;
+  DELETE_STRUCTURED_ASSESSMENT_COMMAND = 902;
+  COMMIT_STRUCTURED_ASSESSMENT_COMMAND = 903;
+  ENTER_IN_ERROR_STRUCTURED_ASSESSMENT_COMMAND = 904;
+
+  SHOW_ACTION_BUTTON = 1000;
+
+  PATIENT_PORTAL__INTAKE_FORM_RESULTS = 2000;
+  PATIENT_PORTAL__APPOINTMENT_IS_CANCELABLE = 2001;
+  PATIENT_PORTAL__APPOINTMENT_IS_RESCHEDULABLE = 2002;
+
+  PATIENT_PORTAL__APPOINTMENTS__SLOTS__POST_SEARCH_RESULTS = 2005;
+  PATIENT_PORTAL__APPOINTMENTS__FORM_APPOINTMENT_TYPES__PRE_SEARCH_RESULTS = 2006;
+  PATIENT_PORTAL__APPOINTMENTS__FORM_APPOINTMENT_TYPES__POST_SEARCH_RESULTS = 2007;
+  PATIENT_PORTAL__APPOINTMENTS__FORM_LOCATIONS__PRE_SEARCH_RESULTS = 2008;
+  PATIENT_PORTAL__APPOINTMENTS__FORM_LOCATIONS__POST_SEARCH_RESULTS = 2009;
+  PATIENT_PORTAL__APPOINTMENTS__FORM_PROVIDERS__PRE_SEARCH_RESULTS = 2010;
+  PATIENT_PORTAL__APPOINTMENTS__FORM_PROVIDERS__POST_SEARCH_RESULTS = 2011;
+
+  LAUNCH_MODAL = 3000;
+}
+
+message Effect {
+  EffectType type = 1;
+  string payload = 2;
+  string plugin_name = 3;
+  string classname = 4;
+  //Oneof effect_payload {
+  //  ...
+  //}
+}