canvas 0.24.0__py3-none-any.whl → 0.25.0__py3-none-any.whl

plugin_runner/plugin_runner.py

@@ -9,6 +9,7 @@ import time
 import traceback
 from collections import defaultdict
 from collections.abc import AsyncGenerator
+from http import HTTPStatus
 from typing import Any, TypedDict
 
 import grpc
@@ -23,6 +24,7 @@ from canvas_generated.services.plugin_runner_pb2_grpc import (
     add_PluginRunnerServicer_to_server,
 )
 from canvas_sdk.effects import Effect
+from canvas_sdk.effects.simple_api import Response
 from canvas_sdk.events import Event, EventRequest, EventResponse, EventType
 from canvas_sdk.protocols import ClinicalQualityMeasure
 from canvas_sdk.utils.stats import get_duration_ms, statsd_client
@@ -139,6 +141,7 @@ class PluginRunner(PluginRunnerServicer):
         event_type = event.type
         event_name = event.name
         relevant_plugins = EVENT_HANDLER_MAP[event_name]
+        relevant_plugin_handlers = []
 
         log.debug(f"Processing {relevant_plugins} for {event_name}")
 
@@ -149,6 +152,11 @@ class PluginRunner(PluginRunnerServicer):
             plugin_name = event.target.id
             # filter only for the plugin(s) that were created/updated
             relevant_plugins = [p for p in relevant_plugins if p.startswith(f"{plugin_name}:")]
+        elif event_type in {EventType.SIMPLE_API_AUTHENTICATE, EventType.SIMPLE_API_REQUEST}:
+            # The target plugin's name will be part of the URL path, so other plugins that respond
+            # to SimpleAPI request events are not relevant
+            plugin_name = event.context["plugin_name"]
+            relevant_plugins = [p for p in relevant_plugins if p.startswith(f"{plugin_name}:")]
 
         effect_list = []
 
@@ -164,6 +172,11 @@ class PluginRunner(PluginRunnerServicer):
 
             try:
                 handler = handler_class(event, secrets)
+
+                if not handler.accept_event():
+                    continue
+                relevant_plugin_handlers.append(handler_class)
+
                 classname = (
                     handler.__class__.__name__
                     if isinstance(handler, ClinicalQualityMeasure)
@@ -205,6 +218,20 @@ class PluginRunner(PluginRunnerServicer):
 
             effect_list += effects
 
+        # Special handling for SimpleAPI requests: if there were no relevant handlers (as determined
+        # by calling ignore_event on handlers), then set the effects list to be a single 404 Not
+        # Found response effect. If multiple handlers were able to respond, log an error and set the
+        # effects list to be a single 500 Internal Server Error response effect.
+        if event.type in {EventType.SIMPLE_API_AUTHENTICATE, EventType.SIMPLE_API_REQUEST}:
+            if len(relevant_plugin_handlers) == 0:
+                effect_list = [Response(status_code=HTTPStatus.NOT_FOUND).apply()]
+            elif len(relevant_plugin_handlers) > 1:
+                log.error(
+                    f"Multiple handlers responded to {EventType.Name(EventType.SIMPLE_API_REQUEST)}"
+                    f" {event.context['path']}"
+                )
+                effect_list = [Response(status_code=HTTPStatus.INTERNAL_SERVER_ERROR).apply()]
+
         event_duration = get_duration_ms(event_start_time)
 
         # Don't log anything if a plugin handler didn't actually run.

plugin_runner/sandbox.py

@@ -73,6 +73,7 @@ ALLOWED_MODULES = frozenset(
         "rapidfuzz",
         "re",
         "requests",
+        "secrets",
         "string",
         "time",
         "traceback",

plugin_runner/tests/fixtures/plugins/test_simple_api/CANVAS_MANIFEST.json

@@ -0,0 +1,47 @@
+{
+    "sdk_version": "0.1.4",
+    "plugin_version": "0.0.1",
+    "name": "test_simple_api",
+    "description": "Edit the description in CANVAS_MANIFEST.json",
+    "components": {
+        "protocols": [
+            {
+                "class": "test_simple_api.protocols.my_protocol:Route",
+                "description": "A protocol that does xyz...",
+                "data_access": {
+                    "event": "",
+                    "read": [],
+                    "write": []
+                }
+            },
+            {
+                "class": "test_simple_api.protocols.my_protocol:ErrorRoute1",
+                "description": "A protocol that does xyz...",
+                "data_access": {
+                    "event": "",
+                    "read": [],
+                    "write": []
+                }
+            },
+            {
+                "class": "test_simple_api.protocols.my_protocol:ErrorRoute2",
+                "description": "A protocol that does xyz...",
+                "data_access": {
+                    "event": "",
+                    "read": [],
+                    "write": []
+                }
+            }
+        ],
+        "commands": [],
+        "content": [],
+        "effects": [],
+        "views": []
+    },
+    "secrets": [],
+    "tags": {},
+    "references": [],
+    "license": "",
+    "diagram": false,
+    "readme": "./README.md"
+}

plugin_runner/tests/fixtures/plugins/test_simple_api/README.md

@@ -0,0 +1,11 @@
+test_simple_api
+===============
+
+## Description
+
+A description of this plugin
+
+### Important Note!
+
+The CANVAS_MANIFEST.json is used when installing your plugin. Please ensure it
+gets updated if you add, remove, or rename protocols.

plugin_runner/tests/fixtures/plugins/test_simple_api/protocols/my_protocol.py

@@ -0,0 +1,43 @@
+from http import HTTPStatus
+
+from canvas_sdk.effects import Effect
+from canvas_sdk.effects.simple_api import Response
+from canvas_sdk.handlers.simple_api import Credentials, SimpleAPIRoute
+
+
+class NoAuth(SimpleAPIRoute):
+    """SimpleAPIRoute base class to bypass authentication."""
+
+    def authenticate(self, credentials: Credentials) -> bool:
+        """Authenticate the request."""
+        return True
+
+
+class Route(NoAuth):
+    """Handler for /route."""
+
+    PATH = "/route"
+
+    def get(self) -> list[Response | Effect]:
+        """Handler method for GET."""
+        return [Response(status_code=HTTPStatus.OK)]
+
+
+class ErrorRoute1(NoAuth):
+    """Handler #1 for /error."""
+
+    PATH = "/error"
+
+    def get(self) -> list[Response | Effect]:
+        """Handler method for GET."""
+        return [Response(status_code=HTTPStatus.OK)]
+
+
+class ErrorRoute2(NoAuth):
+    """Handler #2 for /error."""
+
+    PATH = "/error"
+
+    def get(self) -> list[Response | Effect]:
+        """Handler method for GET."""
+        return [Response(status_code=HTTPStatus.OK)]

plugin_runner/tests/test_plugin_runner.py

@@ -1,14 +1,19 @@
 import asyncio
+import json
 import logging
 import pickle
 import shutil
+from base64 import b64encode
+from http import HTTPStatus
 from pathlib import Path
+from typing import Any
 from unittest.mock import AsyncMock, MagicMock, patch
 
 import pytest
 
 from canvas_generated.messages.effects_pb2 import EffectType
 from canvas_generated.messages.plugins_pb2 import ReloadPluginsRequest
+from canvas_sdk.effects.simple_api import Response
 from canvas_sdk.events import Event, EventRequest, EventType
 from plugin_runner.plugin_runner import (
     EVENT_HANDLER_MAP,
@@ -24,7 +29,7 @@ from plugin_runner.plugin_runner import (
 def plugin_runner() -> PluginRunner:
     """Fixture to initialize PluginRunner with mocks."""
     runner = PluginRunner()
-    runner.statsd_client = MagicMock()
+    runner.statsd_client = MagicMock()  # type: ignore[attr-defined]
     return runner
 
 
@@ -316,3 +321,68 @@ def import_me() -> str:
     assert len(result[0].effects) == 1
     assert result[0].effects[0].type == EffectType.LOG
     assert result[0].effects[0].payload == "Successfully changed!"
+
+
+@pytest.mark.asyncio
+@pytest.mark.parametrize(
+    argnames="context,status_code",
+    argvalues=[
+        (
+            {
+                "plugin_name": "test_simple_api",
+                "method": "GET",
+                "path": "/route",
+                "query_string": "",
+                "body": b64encode(b"").decode(),
+                "headers": {},
+            },
+            HTTPStatus.OK,
+        ),
+        (
+            {
+                "plugin_name": "test_simple_api",
+                "method": "GET",
+                "path": "/notfound",
+                "query_string": "",
+                "body": b64encode(b"").decode(),
+                "headers": {},
+            },
+            HTTPStatus.NOT_FOUND,
+        ),
+        (
+            {
+                "plugin_name": "test_simple_api",
+                "method": "GET",
+                "path": "/error",
+                "query_string": "",
+                "body": b64encode(b"").decode(),
+                "headers": {},
+            },
+            HTTPStatus.INTERNAL_SERVER_ERROR,
+        ),
+    ],
+    ids=["success", "not found error", "multiple handlers error"],
+)
+@pytest.mark.parametrize("install_test_plugin", ["test_simple_api"], indirect=True)
+async def test_simple_api(
+    install_test_plugin: Path,
+    load_test_plugins: None,
+    plugin_runner: PluginRunner,
+    context: dict[str, Any],
+    status_code: HTTPStatus,
+) -> None:
+    """Test that the PluginRunner returns responses to SimpleAPI request events."""
+    event = EventRequest(
+        type=EventType.SIMPLE_API_REQUEST,
+        context=json.dumps(context),
+    )
+
+    result = []
+    async for response in plugin_runner.HandleEvent(event, None):
+        result.append(response)
+
+    expected_response = Response(status_code=status_code).apply()
+    if status_code == HTTPStatus.OK:
+        expected_response.plugin_name = "test_simple_api"
+
+    assert result[0].effects == [expected_response]

protobufs/canvas_generated/messages/effects.proto

@@ -249,6 +249,8 @@ enum EffectType {
   PORTAL_WIDGET = 2101;
 
   LAUNCH_MODAL = 3000;
+
+  SIMPLE_API_RESPONSE = 4000;
 }
 
 message Effect {

protobufs/canvas_generated/messages/events.proto

@@ -254,6 +254,7 @@ enum EventType {
   // CHART_SECTION_REVIEW_COMMAND__PRE_EXECUTE_ACTION = 9010;
   // CHART_SECTION_REVIEW_COMMAND__POST_EXECUTE_ACTION = 9011;
 
+
   CLIPBOARD_COMMAND__PRE_ORIGINATE = 53000;
   CLIPBOARD_COMMAND__POST_ORIGINATE = 53001;
   CLIPBOARD_COMMAND__PRE_UPDATE = 53002;
@@ -1064,6 +1065,9 @@ enum EventType {
   SHOW_CHART_SUMMARY_SURGICAL_HISTORY_SECTION_BUTTON = 120008;
   SHOW_CHART_SUMMARY_FAMILY_HISTORY_SECTION_BUTTON = 120009;
   SHOW_CHART_SUMMARY_CODING_GAPS_SECTION_BUTTON = 120010;
+
+  SIMPLE_API_AUTHENTICATE = 130000;
+  SIMPLE_API_REQUEST = 130001;
 }
 
 message Event {