canvas 0.22.0__tar.gz → 0.22.1__tar.gz

{canvas-0.22.0 → canvas-0.22.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: canvas
-Version: 0.22.0
+Version: 0.22.1
 Summary: SDK to customize event-driven actions in your Canvas instance
 Author-email: Canvas Team <engineering@canvasmedical.com>
 License-Expression: MIT

{canvas-0.22.0 → canvas-0.22.1}/canvas_sdk/commands/tests/protocol/tests.py

@@ -49,7 +49,16 @@ def write_and_install_protocol_and_clean_up(
         f"Loading plugin '{plugin_name}",
     )
     install_plugin(plugin_name, token)
-    message_received_event.wait(timeout=5.0)
+    message_received_event.wait(timeout=15.0)
+
+    # unfortunately sometimes the log websocket just doesn't return any
+    # messages, so asserting on the state of the timeout here causes failures
+    # even though the delay itself will cause the waiting test to pass (because
+    # the plugin has been loaded).
+    # timeout_not_hit = message_received_event.wait(timeout=15.0)
+    # if not timeout_not_hit:
+    #     ws.close()
+    # assert timeout_not_hit, f"plugin loading message timeout hit: Loading plugin '{plugin_name}"
 
     yield
 

{canvas-0.22.0 → canvas-0.22.1}/canvas_sdk/commands/tests/test_utils.py

@@ -367,6 +367,9 @@ def wait_for_log(
     thread = threading.Thread(target=ws.run_forever)
     thread.start()
 
-    connected_event.wait(timeout=5.0)
+    timeout_not_hit = connected_event.wait(timeout=5.0)
+    if not timeout_not_hit:
+        ws.close()
+    assert timeout_not_hit, "connection timeout hit"
 
     return message_received_event, thread, ws

{canvas-0.22.0 → canvas-0.22.1}/canvas_sdk/effects/banner_alert/tests.py

@@ -107,8 +107,16 @@ class Protocol(BaseProtocol):
         )
         response.raise_for_status()
 
-        message_received_event.wait(timeout=5.0)
-
+        message_received_event.wait(timeout=15.0)
+
+        # unfortunately sometimes the log websocket just doesn't return any
+        # messages, so asserting on the state of the timeout here causes failures
+        # even though the delay itself will cause the waiting test to pass (because
+        # the plugin has been loaded).
+        # timeout_not_hit = message_received_event.wait(timeout=15.0)
+        # if not timeout_not_hit:
+        #     ws.close()
+        # assert timeout_not_hit, f"plugin loading message timeout hit: Loading plugin '{plugin_name}"
     yield
 
     ws.close()

{canvas-0.22.0 → canvas-0.22.1}/plugin_runner/installation.py

@@ -137,7 +137,7 @@ def download_plugin(plugin_package: str) -> Generator[Path, None, None]:
 def install_plugin(plugin_name: str, attributes: PluginAttributes) -> None:
     """Install the given Plugin's package into the runtime."""
     try:
-        log.info(f'Installing plugin "{plugin_name}"')
+        log.info(f'Installing plugin "{plugin_name}", version {attributes["version"]}')
 
         plugin_installation_path = Path(PLUGIN_DIRECTORY) / plugin_name
 
@@ -224,7 +224,6 @@ def install_plugins() -> None:
 
     for plugin_name, attributes in enabled_plugins().items():
         try:
-            log.info(f'Installing plugin "{plugin_name}", version {attributes["version"]}')
             install_plugin(plugin_name, attributes)
         except PluginInstallationError:
             disable_plugin(plugin_name)

{canvas-0.22.0 → canvas-0.22.1}/plugin_runner/plugin_runner.py

@@ -13,6 +13,8 @@ from typing import Any, TypedDict
 
 import grpc
 import redis.asyncio as redis
+from asgiref.sync import sync_to_async
+from django.db import connections
 
 from canvas_generated.messages.effects_pb2 import EffectType
 from canvas_generated.messages.plugins_pb2 import ReloadPluginsRequest, ReloadPluginsResponse
@@ -30,6 +32,7 @@ from plugin_runner.installation import install_plugins
 from plugin_runner.sandbox import Sandbox
 from settings import (
     CHANNEL_NAME,
+    IS_TESTING,
     MANIFEST_FILE_NAME,
     PLUGIN_DIRECTORY,
     REDIS_ENDPOINT,
@@ -103,6 +106,25 @@ class PluginManifest(TypedDict):
     readme: str
 
 
+@sync_to_async
+def reconnect_if_needed() -> None:
+    """
+    Reconnect to the database if the connection has been closed.
+
+    NOTE: Django database functions are not async-safe and must be called
+    via e.g. sync_to_async. They will silently fail and block the handler
+    if called in an async context directly.
+    """
+    if IS_TESTING:
+        return
+
+    connection = connections["default"]
+
+    if not connection.is_usable():
+        log.debug("Connection was unusable, reconnecting...")
+        connection.connect()
+
+
 class PluginRunner(PluginRunnerServicer):
     """This process runs provided plugins that register interest in incoming events."""
 
@@ -118,6 +140,11 @@ class PluginRunner(PluginRunnerServicer):
         event_name = event.name
         relevant_plugins = EVENT_HANDLER_MAP[event_name]
 
+        log.debug(f"Processing {relevant_plugins} for {event_name}")
+
+        if relevant_plugins:
+            await reconnect_if_needed()
+
         if event_type in [EventType.PLUGIN_CREATED, EventType.PLUGIN_UPDATED]:
             plugin_name = event.target.id
             # filter only for the plugin(s) that were created/updated
@@ -126,6 +153,8 @@ class PluginRunner(PluginRunnerServicer):
         effect_list = []
 
         for plugin_name in relevant_plugins:
+            log.debug(f"Processing {plugin_name}")
+
             plugin = LOADED_PLUGINS[plugin_name]
             handler_class = plugin["class"]
             base_plugin_name = plugin_name.split(":")[0]
@@ -142,7 +171,7 @@ class PluginRunner(PluginRunnerServicer):
                 )
 
                 compute_start_time = time.time()
-                _effects = await asyncio.get_running_loop().run_in_executor(None, handler.compute)
+                _effects = await sync_to_async(handler.compute)()
                 effects = [
                     Effect(
                         type=effect.type,
@@ -166,9 +195,12 @@ class PluginRunner(PluginRunnerServicer):
                     tags={"plugin": plugin_name},
                 )
             except Exception as e:
+                log.error(f"Encountered exception in plugin {plugin_name}:")
+
                 for error_line_with_newlines in traceback.format_exception(e):
                     for error_line in error_line_with_newlines.split("\n"):
                         log.error(error_line)
+
                 continue
 
             effect_list += effects
@@ -204,7 +236,7 @@ async def synchronize_plugins(run_once: bool = False) -> None:
     """
     log.info(f'synchronize_plugins: listening for messages on pubsub channel "{CHANNEL_NAME}"')
 
-    client, pubsub = get_client()
+    _, pubsub = get_client()
     await pubsub.psubscribe(CHANNEL_NAME)
 
     while True:

{canvas-0.22.0 → canvas-0.22.1}/pyproject.toml

@@ -50,7 +50,7 @@ license = "MIT"
 name = "canvas"
 readme = "README.md"
 requires-python = ">=3.11,<3.13"
-version = "0.22.0"
+version = "0.22.1"
 
 [project.scripts]
 canvas = "canvas_cli.main:app"