canvas 0.63.0__py3-none-any.whl → 0.89.0__py3-none-any.whl

plugin_runner/generate_allowed_imports.py

@@ -7,6 +7,7 @@ from typing import Any
 
 CANVAS_TOP_LEVEL_MODULES = (
     "canvas_sdk.caching",
+    "canvas_sdk.clients",
     "canvas_sdk.commands",
     "canvas_sdk.effects",
     "canvas_sdk.events",

plugin_runner/installation.py

@@ -170,7 +170,7 @@ def install_plugin(plugin_name: str, attributes: PluginAttributes) -> None:
 
         install_plugin_secrets(plugin_name=plugin_name, secrets=attributes["secrets"])
     except Exception as e:
-        log.error(f'Failed to install plugin "{plugin_name}", version {attributes["version"]}: {e}')
+        log.exception(f'Failed to install plugin "{plugin_name}", version {attributes["version"]}')
 
         sentry_sdk.capture_exception(e)
 
@@ -190,7 +190,7 @@ def extract_plugin(plugin_file_path: Path, plugin_installation_path: Path) -> No
                     archive = tarfile.TarFile.open(fileobj=file)
                     archive.extractall(plugin_installation_path, filter="data")
             except tarfile.ReadError as e:
-                log.error(f"Unreadable tar archive: '{plugin_file_path}'")
+                log.exception(f"Unreadable tar archive: '{plugin_file_path}'")
                 sentry_sdk.capture_exception(e)
 
                 raise InvalidPluginFormat from e

plugin_runner/plugin_runner.py

@@ -6,7 +6,6 @@ import pickle
 import pkgutil
 import sys
 import threading
-import traceback
 from collections import defaultdict
 from collections.abc import Iterable
 from concurrent.futures import ThreadPoolExecutor
@@ -42,6 +41,7 @@ from canvas_sdk.effects.simple_api import Response
 from canvas_sdk.events import Event, EventRequest, EventResponse, EventType
 from canvas_sdk.handlers.simple_api.websocket import DenyConnection
 from canvas_sdk.protocols import ClinicalQualityMeasure
+from canvas_sdk.templates.utils import _engine_for_plugin
 from canvas_sdk.utils import metrics
 from canvas_sdk.utils.metrics import measured
 from logger import log
@@ -96,10 +96,6 @@ if SENTRY_DSN:
     global_scope.set_tag("source", "plugin-runner")
     global_scope.set_tag("production_customer", "yes" if IS_PRODUCTION_CUSTOMER else "no")
 
-# when we import plugins we'll use the module name directly so we need to add the plugin
-# directory to the path
-sys.path.append(PLUGIN_DIRECTORY)
-
 Plugin = TypedDict(
     "Plugin",
     {
@@ -231,7 +227,7 @@ class PluginRunner(PluginRunnerServicer):
                         p for p in relevant_plugins if p.startswith(f"{plugin_name}:")
                     ]
                 except Exception as ex:
-                    log.error(
+                    log.exception(
                         f"Failed to decode identifier for event {event_name} with context {event.context}"
                     )
                     sentry_sdk.capture_exception(ex)
@@ -281,6 +277,8 @@ class PluginRunner(PluginRunnerServicer):
                                 plugin_name=base_plugin_name,
                                 classname=classname,
                                 handler_name=handler_name,
+                                actor=event.actor.id,
+                                source=event.source,
                             )
                             for effect in _effects
                         ]
@@ -292,12 +290,7 @@ class PluginRunner(PluginRunnerServicer):
                         log.info(f"{plugin_name}.compute() completed.")
 
                 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)
-
+                    log.exception(f"Encountered exception in plugin {plugin_name}")
                     sentry_sdk.capture_exception(e)
                     continue
 
@@ -419,6 +412,9 @@ def synchronize_plugins(run_once: bool = False) -> None:
         if "action" not in data:
             continue
 
+        # clear the template engine cache so that any template changes
+        # from plugins are picked up
+        _engine_for_plugin.cache_clear()
         plugin_name = data.get("plugin", None)
         try:
             if data["action"] == "reload":
@@ -429,6 +425,7 @@ def synchronize_plugins(run_once: bool = False) -> None:
                         log.info(
                             f'synchronize_plugins: installing/reloading plugin "{plugin_name}" for action=reload'
                         )
+                        unload_plugin(plugin_name)
                         install_plugin(plugin_name, attributes=plugin)
                         plugin_dir = pathlib.Path(PLUGIN_DIRECTORY) / plugin_name
                         load_plugin(plugin_dir.resolve())
@@ -451,7 +448,7 @@ def synchronize_plugins(run_once: bool = False) -> None:
             if plugin_name:
                 message += f' for plugin "{plugin_name}"'
 
-            log.error(f"synchronize_plugins: {message}: {e}")
+            log.exception(f"synchronize_plugins: {message}")
             sentry_sdk.capture_exception(e)
 
         if run_once:
@@ -468,7 +465,7 @@ def synchronize_plugins_and_report_errors() -> None:
         try:
             synchronize_plugins()
         except Exception as e:
-            log.error(f"synchronize_plugins: error: {e}")
+            log.exception("synchronize_plugins: error")
             sentry_sdk.capture_exception(e)
 
         # don't crush redis if we're retrying in a tight loop
@@ -569,7 +566,7 @@ def load_or_reload_plugin(path: pathlib.Path) -> bool:
     try:
         manifest_json: PluginManifest = json.loads(manifest_json_str)
     except Exception as e:
-        log.error(f'Unable to load plugin "{name}": {e}')
+        log.exception(f'Unable to load plugin "{name}"')
         sentry_sdk.capture_exception(e)
 
         return False
@@ -581,7 +578,7 @@ def load_or_reload_plugin(path: pathlib.Path) -> bool:
         try:
             secrets_json = json.load(secrets_file.open())
         except Exception as e:
-            log.error(f'Unable to load secrets for plugin "{name}": {str(e)}')
+            log.exception(f'Unable to load secrets for plugin "{name}"')
             sentry_sdk.capture_exception(e)
 
     # TODO add existing schema validation from Michela here
@@ -590,7 +587,7 @@ def load_or_reload_plugin(path: pathlib.Path) -> bool:
             "components"
         ].get("applications", [])
     except Exception as e:
-        log.error(f'Unable to load plugin "{name}": {str(e)}')
+        log.exception(f'Unable to load plugin "{name}"')
         sentry_sdk.capture_exception(e)
 
         return False
@@ -604,7 +601,7 @@ def load_or_reload_plugin(path: pathlib.Path) -> bool:
             handler_module, handler_class = handler["class"].split(":")
             name_and_class = f"{name}:{handler_module}:{handler_class}"
         except ValueError as e:
-            log.error(f'Unable to parse class for plugin "{name}": "{handler["class"]}"')
+            log.exception(f'Unable to parse class for plugin "{name}": "{handler["class"]}"')
             sentry_sdk.capture_exception(e)
 
             any_failed = True
@@ -634,13 +631,8 @@ def load_or_reload_plugin(path: pathlib.Path) -> bool:
                     "secrets": secrets_json,
                 }
         except Exception as e:
-            log.error(f'Error importing module "{name_and_class}": {e}')
-
-            for error_line in traceback.format_exception(e):
-                log.error(error_line)
-
+            log.exception(f"Error importing module '{name_and_class}'")
             sentry_sdk.capture_exception(e)
-
             any_failed = True
 
     return not any_failed
@@ -698,6 +690,11 @@ def load_plugins(specified_plugin_paths: list[str] | None = None) -> None:
             path_to_append = pathlib.Path(".") / plugin_path.parent
             sys.path.append(path_to_append.as_posix())
     else:
+        # Add plugin directory to path only when actually loading plugins (not at module import time)
+        # to avoid polluting Python's import cache during test collection
+        if PLUGIN_DIRECTORY not in sys.path:
+            sys.path.append(PLUGIN_DIRECTORY)
+
         candidates = os.listdir(PLUGIN_DIRECTORY)
 
         # convert to Paths

plugin_runner/sandbox.py

@@ -90,6 +90,18 @@ STANDARD_LIBRARY_MODULES = {
         "Counter",
         "defaultdict",
     },
+    "dataclasses": {
+        "asdict",
+        "astuple",
+        "dataclass",
+        "field",
+        "Field",
+        "fields",
+        "InitVar",
+        "is_dataclass",
+        "make_dataclass",
+        "replace",
+    },
     "datetime": {
         "date",
         "datetime",
@@ -126,6 +138,7 @@ STANDARD_LIBRARY_MODULES = {
     "json": {
         "dumps",
         "loads",
+        "JSONDecodeError",
     },
     "operator": {
         "and_",
@@ -168,6 +181,7 @@ STANDARD_LIBRARY_MODULES = {
         "Tuple",
         "Type",
         "TypedDict",
+        "TypeGuard",
         "Union",
     },
     "urllib": {
@@ -181,6 +195,9 @@ STANDARD_LIBRARY_MODULES = {
         "uuid4",
         "UUID",
     },
+    "defusedxml.ElementTree": {
+        "fromstring",
+    },
     "zoneinfo": {
         "ZoneInfo",
     },
@@ -194,23 +211,39 @@ THIRD_PARTY_MODULES = {
         "utcnow",
     },
     "django.db.models": {
+        "Avg",
         "BigIntegerField",
         "Case",
         "CharField",
         "Count",
+        "Exists",
         "F",
         "IntegerField",
+        "Max",
+        "Min",
         "Model",  # remove when hyperscribe no longer needs it
+        "OuterRef",
+        "Prefetch",
         "Q",
+        "Subquery",
+        "Sum",
         "Value",
         "When",
     },
     "django.db.models.expressions": {
         "Case",
+        "Exists",
+        "OuterRef",
+        "Subquery",
         "Value",
         "When",
     },
+    "django.db.models.functions": {
+        "Coalesce",
+        "Trim",
+    },
     "django.db.models.query": {
+        "Prefetch",
         "QuerySet",
     },
     "django.utils.functional": {
@@ -658,6 +691,7 @@ class Sandbox:
                 "property": builtins.property,
                 "reversed": builtins.reversed,
                 "staticmethod": builtins.staticmethod,
+                "sum": builtins.sum,
                 "super": builtins.super,
                 "vars": builtins.vars,
             },

protobufs/canvas_generated/messages/effects.proto

@@ -55,6 +55,7 @@ enum EffectType {
   COMMIT_PRESCRIBE_COMMAND = 39;
   ENTER_IN_ERROR_PRESCRIBE_COMMAND = 40;
   SEND_PRESCRIBE_COMMAND = 1305;
+  REVIEW_PRESCRIBE_COMMAND = 1309;
 
   ORIGINATE_QUESTIONNAIRE_COMMAND = 41;
   EDIT_QUESTIONNAIRE_COMMAND = 42;
@@ -126,6 +127,7 @@ enum EffectType {
   CREATE_TASK = 100;
   UPDATE_TASK = 101;
   CREATE_TASK_COMMENT = 102;
+  UPSERT_TASK_METADATA = 111;
 
   ORIGINATE_MEDICAL_HISTORY_COMMAND = 103;
   EDIT_MEDICAL_HISTORY_COMMAND = 104;
@@ -147,6 +149,7 @@ enum EffectType {
   COMMIT_REFILL_COMMAND = 116;
   ENTER_IN_ERROR_REFILL_COMMAND = 117;
   SEND_REFILL_COMMAND = 1308;
+  REVIEW_REFILL_COMMAND = 1310;
 
   ORIGINATE_VITALS_COMMAND = 118;
   EDIT_VITALS_COMMAND = 119;
@@ -181,6 +184,7 @@ enum EffectType {
   CREATE_QUESTIONNAIRE_RESULT = 138;
 
   ANNOTATE_PATIENT_CHART_CONDITION_RESULTS = 200;
+  ANNOTATE_PATIENT_CHART_DETECTED_ISSUE_RESULTS = 201;
 
   ANNOTATE_CLAIM_CONDITION_RESULTS = 300;
 
@@ -236,6 +240,7 @@ enum EffectType {
   COMMIT_ADJUST_PRESCRIPTION_COMMAND = 1303;
   ENTER_IN_ERROR_ADJUST_PRESCRIPTION_COMMAND = 1304;
   SEND_ADJUST_PRESCRIPTION_COMMAND = 1307;
+  REVIEW_ADJUST_PRESCRIPTION_COMMAND = 1311;
 
   ORIGINATE_CHART_SECTION_REVIEW_COMMAND = 1400;
 
@@ -245,7 +250,32 @@ enum EffectType {
   COMMIT_IMMUNIZATION_STATEMENT_COMMAND = 1503;
   ENTER_IN_ERROR_IMMUNIZATION_STATEMENT_COMMAND = 1504;
 
+  ORIGINATE_LAB_REVIEW_COMMAND = 1505;
+  EDIT_LAB_REVIEW_COMMAND = 1506;
+  DELETE_LAB_REVIEW_COMMAND = 1507;
+  COMMIT_LAB_REVIEW_COMMAND = 1508;
+  ENTER_IN_ERROR_LAB_REVIEW_COMMAND = 1509;
+
+  ORIGINATE_IMAGING_REVIEW_COMMAND = 1510;
+  EDIT_IMAGING_REVIEW_COMMAND = 1511;
+  DELETE_IMAGING_REVIEW_COMMAND = 1512;
+  COMMIT_IMAGING_REVIEW_COMMAND = 1513;
+  ENTER_IN_ERROR_IMAGING_REVIEW_COMMAND = 1514;
+
+  ORIGINATE_REFERRAL_REVIEW_COMMAND = 1515;
+  EDIT_REFERRAL_REVIEW_COMMAND = 1516;
+  DELETE_REFERRAL_REVIEW_COMMAND = 1517;
+  COMMIT_REFERRAL_REVIEW_COMMAND = 1518;
+  ENTER_IN_ERROR_REFERRAL_REVIEW_COMMAND = 1519;
+
+  ORIGINATE_UNCATEGORIZED_DOCUMENT_REVIEW_COMMAND = 1520;
+  EDIT_UNCATEGORIZED_DOCUMENT_REVIEW_COMMAND = 1521;
+  DELETE_UNCATEGORIZED_DOCUMENT_REVIEW_COMMAND = 1522;
+  COMMIT_UNCATEGORIZED_DOCUMENT_REVIEW_COMMAND = 1523;
+  ENTER_IN_ERROR_UNCATEGORIZED_DOCUMENT_REVIEW_COMMAND = 1524;
+
   COMMAND_AVAILABLE_ACTIONS_RESULTS = 1600;
+  COMMAND_VALIDATION_ERRORS = 1601;
 
   SHOW_ACTION_BUTTON = 1000;
 
@@ -254,6 +284,7 @@ enum EffectType {
   PATIENT_PORTAL__APPOINTMENT_IS_RESCHEDULABLE = 2002;
   PATIENT_PORTAL__APPOINTMENT_SHOW_MEETING_LINK = 2003;
   PATIENT_PORTAL__SEND_INVITE = 2004;
+  PATIENT_PORTAL__SEND_CONTACT_VERIFICATION = 2013;
 
   PATIENT_PORTAL__APPOINTMENTS__SLOTS__POST_SEARCH_RESULTS = 2005;
   PATIENT_PORTAL__APPOINTMENTS__FORM_APPOINTMENT_TYPES__PRE_SEARCH_RESULTS = 2006;
@@ -264,10 +295,22 @@ enum EffectType {
   PATIENT_PORTAL__APPOINTMENTS__FORM_PROVIDERS__POST_SEARCH_RESULTS = 2011;
   PATIENT_PORTAL__APPLICATION_CONFIGURATION = 2012;
 
+  ADD_APPOINTMENT_LABEL = 2015;
+  REMOVE_APPOINTMENT_LABEL = 2016;
+
   ADD_BILLING_LINE_ITEM = 2030;
   UPDATE_BILLING_LINE_ITEM = 2031;
   REMOVE_BILLING_LINE_ITEM = 2032;
 
+  POST_CLAIM_PAYMENT = 2040;
+  POST_CLAIMS_REMIT = 2041;
+
+  MOVE_CLAIM_TO_QUEUE = 2060;
+  ADD_CLAIM_LABEL = 2050;
+  REMOVE_CLAIM_LABEL = 2051;
+
+  UPDATE_CLAIM_LINE_ITEM = 2080;
+
   SHOW_PATIENT_PORTAL_MENU_ITEMS = 2100;
   PORTAL_WIDGET = 2101;
 
@@ -282,13 +325,22 @@ enum EffectType {
 
   CREATE_NOTE = 6000;
   UPDATE_NOTE = 6013;
+  PUSH_NOTE_CHARGES = 5500;
+  FAX_NOTE = 6019;
+  LOCK_NOTE = 6025;
+  UNLOCK_NOTE = 6026;
+  SIGN_NOTE = 6027;
+  CHECK_IN_NOTE = 6028;
+  NO_SHOW_NOTE = 6029;
 
   CREATE_APPOINTMENT = 6001;
   UPDATE_APPOINTMENT = 6014;
+  RESCHEDULE_APPOINTMENT = 6022;
   CANCEL_APPOINTMENT = 6015;
   CREATE_SCHEDULE_EVENT = 6002;
   UPDATE_SCHEDULE_EVENT = 6016;
   DELETE_SCHEDULE_EVENT = 6017;
+  RESCHEDULE_SCHEDULE_EVENT = 6023;
 
   CREATE_PATIENT = 6003;
   UPDATE_PATIENT = 6008;
@@ -305,6 +357,9 @@ enum EffectType {
   CREATE_COMPOUND_MEDICATION = 6020;
   UPDATE_COMPOUND_MEDICATION = 6021;
 
+  CREATE_OBSERVATION = 6031;
+  UPDATE_OBSERVATION = 6032;
+
   PATIENT_CHART__GROUP_ITEMS = 6030;
 
   APPOINTMENT__FORM__PROVIDERS__PRE_SEARCH_RESULTS = 6040;
@@ -323,6 +378,8 @@ enum EffectType {
 
   UPSERT_APPOINTMENT_METADATA = 6052;
 
+  APPOINTMENT__SLOTS__POST_SEARCH_RESULTS = 6053;
+
   SHOW_PANEL_SECTIONS = 6100;
 
   REDIRECT_CONTEXT = 6200;
@@ -336,8 +393,14 @@ enum EffectType {
 
   GENERATE_FULL_CHART_PDF = 6101;
 
+  BATCH_ORIGINATE_COMMANDS = 6024;
+
   CALENDAR__CREATE = 8001;
   CALENDAR__EVENT__CREATE = 8002;
+  CALENDAR__EVENT__UPDATE = 8003;
+  CALENDAR__EVENT__DELETE = 8004;
+
+  ORIGINATE_CUSTOM_COMMAND_COMMAND = 8005;
 }
 
 message Effect {
@@ -346,6 +409,8 @@ message Effect {
   string plugin_name = 3;
   string classname = 4;
   string handler_name = 5;
+  string actor = 6;
+  string source = 7;
   //Oneof effect_payload {
   //  ...
   //}