canvas 0.34.0__py3-none-any.whl → 0.35.0__py3-none-any.whl

plugin_runner/sandbox.py

@@ -206,6 +206,9 @@ STANDARD_LIBRARY_MODULES = {
         "Type",
         "TypedDict",
     },
+    "urllib": {
+        "parse",
+    },
     "urllib.parse": {
         "urlencode",
         "quote",
@@ -214,6 +217,9 @@ STANDARD_LIBRARY_MODULES = {
         "uuid4",
         "UUID",
     },
+    "zoneinfo": {
+        "ZoneInfo",
+    },
 }
 
 
@@ -309,6 +315,22 @@ def _find_folder_in_path(file_path: Path, target_folder_name: str) -> Path | Non
     return _find_folder_in_path(file_path.parent, target_folder_name)
 
 
+def node_name(node: ast.AST) -> str:
+    """
+    Given an AST node, return its name.
+    """
+    if isinstance(node, ast.Call):
+        return ".".join(node_name(arg) for arg in node.args)
+
+    if isinstance(node, ast.Constant):
+        return str(node.value)
+
+    if isinstance(node, ast.Name):
+        return str(node.id)
+
+    return "__unknown__"
+
+
 class Sandbox:
     """A restricted sandbox for safely executing arbitrary Python code."""
 
@@ -483,7 +505,7 @@ class Sandbox:
                     func=ast.Name("_write_", ast.Load()),
                     args=[
                         node.value,
-                        ast.Constant(node.value.id if isinstance(node.value, ast.Name) else None),
+                        ast.Constant(node_name(node.value)),
                         ast.Constant(node.attr),
                     ],
                     keywords=[],
@@ -497,6 +519,55 @@ class Sandbox:
                 # Impossible Case only ctx Load, Store and Del are defined in ast.
                 raise NotImplementedError(f"Unknown ctx type: {type(node.ctx)}")
 
+        def visit_Subscript(self, node: ast.Subscript) -> ast.AST:
+            """Transforms all kinds of subscripts.
+
+            'foo[bar]' becomes '_getitem_(foo, bar)'
+            'foo[:ab]' becomes '_getitem_(foo, slice(None, ab, None))'
+            'foo[ab:]' becomes '_getitem_(foo, slice(ab, None, None))'
+            'foo[a:b]' becomes '_getitem_(foo, slice(a, b, None))'
+            'foo[a:b:c]' becomes '_getitem_(foo, slice(a, b, c))'
+            'foo[a, b:c] becomes '_getitem_(foo, (a, slice(b, c, None)))'
+            'foo[a] = c' becomes '_write_(foo)[a] = c'
+            'del foo[a]' becomes 'del _write_(foo)[a]'
+
+            The _write_ function should return a security proxy.
+            """
+            node = self.node_contents_visit(node)
+
+            # 'AugStore' and 'AugLoad' are defined in 'Python.asdl' as possible
+            # 'expr_context'. However, according to Python/ast.c
+            # they are NOT used by the implementation => No need to worry here.
+            # Instead ast.c creates 'AugAssign' nodes, which can be visited.
+            if isinstance(node.ctx, ast.Load):
+                new_node = ast.Call(
+                    func=ast.Name("_getitem_", ast.Load()),
+                    args=[node.value, self.transform_slice(node.slice)],
+                    keywords=[],
+                )
+
+                copy_locations(new_node, node)
+
+                return new_node
+            elif isinstance(node.ctx, ast.Del | ast.Store):
+                new_value = ast.Call(
+                    func=ast.Name("_write_", ast.Load()),
+                    args=[
+                        node.value,
+                        ast.Constant(node_name(node.value)),
+                        ast.Constant(node_name(node.slice)),
+                    ],
+                    keywords=[],
+                )
+
+                copy_locations(new_value, node)
+                node.value = new_value
+
+                return node
+            else:  # pragma: no cover
+                # Impossible Case only ctx Load, Store and Del are defined in ast.
+                raise NotImplementedError(f"Unknown ctx type: {type(node.ctx)}")
+
     def __init__(
         self,
         source_code: Path,
@@ -655,7 +726,12 @@ class Sandbox:
         """
         return bool(self.base_path) and module.split(".")[0] == self.package_name
 
-    def _safe_write(self, _ob: Any, name: str | None = None, attribute: str | None = None) -> Any:
+    def _safe_write(
+        self,
+        _ob: Any,
+        name: str | None = None,
+        attribute: str | int | None = None,
+    ) -> Any:
         """Check if the given obj belongs to a protected resource."""
         is_module = isinstance(_ob, types.ModuleType)
 
@@ -664,14 +740,30 @@ class Sandbox:
                 raise AttributeError(f"Forbidden assignment to a module attribute: {_ob.__name__}.")
         elif isinstance(_ob, type):
             full_name = f"{_ob.__module__}.{_ob.__qualname__}"
+            module_name = _ob.__module__
+        else:
+            full_name = f"{_ob.__class__.__module__}.{_ob.__class__.__qualname__}"
+            module_name = _ob.__class__.__module__
+
+        if attribute is not None:
+            if isinstance(_ob, dict):
+                value = dict.get(_ob, attribute)
+            elif isinstance(_ob, list | tuple) and isinstance(attribute, int):
+                value = _ob.__getitem__(attribute)
+            elif isinstance(attribute, str):
+                value = getattr(_ob, attribute, None)
+            else:
+                value = None
         else:
-            full_name = f"{_ob.__module__}.{_ob.__class__.__qualname__}"
+            value = None
 
-        if not self._same_module(_ob.__module__) and (
+        if not self._same_module(module_name) and (
             # deny if it was anything imported
-            name in self.imported_names["names"]
+            (name and name.split(".")[0] in self.imported_names["names"])
             # deny if it's anything callable
-            or (attribute is not None and callable(getattr(_ob, attribute)))
+            or callable(value)
+            # deny writes to dictionary underscore keys
+            or (isinstance(_ob, dict) and isinstance(attribute, str) and attribute.startswith("_"))
         ):
             raise AttributeError(
                 f"Forbidden assignment to a non-module attribute: {full_name} "
@@ -704,7 +796,7 @@ class Sandbox:
         is_module = isinstance(_ob, types.ModuleType)
 
         if is_module:
-            module = _ob.__name__.split(".")[0]
+            module = _ob.__name__
         elif isinstance(_ob, type):
             module = _ob.__module__.split(".")[0]
         else:
@@ -743,7 +835,9 @@ class Sandbox:
             if name not in exports:
                 raise AttributeError(f'"{name}" is an invalid attribute name (not in __exports__)')
         elif is_module and (module not in ALLOWED_MODULES or name not in ALLOWED_MODULES[module]):
-            raise AttributeError(f'"{name}" is an invalid attribute name (not in ALLOWED_MODULES)')
+            raise AttributeError(
+                f'"{module}.{name}" is an invalid attribute name (not in ALLOWED_MODULES)'
+            )
 
         return getattr(_ob, name, default)
 

protobufs/canvas_generated/messages/effects.proto

@@ -169,6 +169,12 @@ enum EffectType {
   COMMIT_REFER_COMMAND = 142;
   ENTER_IN_ERROR_REFER_COMMAND = 143;
 
+  ORIGINATE_CHANGE_MEDICATION_COMMAND = 150;
+  EDIT_CHANGE_MEDICATION_COMMAND = 151;
+  DELETE_CHANGE_MEDICATION_COMMAND = 152;
+  COMMIT_CHANGE_MEDICATION_COMMAND = 153;
+  ENTER_IN_ERROR_CHANGE_MEDICATION_COMMAND = 154;
+
   CREATE_QUESTIONNAIRE_RESULT = 138;
 
   ANNOTATE_PATIENT_CHART_CONDITION_RESULTS = 200;
@@ -256,6 +262,12 @@ enum EffectType {
   SIMPLE_API_RESPONSE = 4000;
 
   UPDATE_USER = 5000;
+
+  CREATE_NOTE = 6000;
+  CREATE_APPOINTMENT = 6001;
+  CREATE_SCHEDULE_EVENT = 6002;
+
+  CREATE_PATIENT = 6003;
 }
 
 message Effect {
@@ -263,6 +275,7 @@ message Effect {
   string payload = 2;
   string plugin_name = 3;
   string classname = 4;
+  string handler_name = 5;
   //Oneof effect_payload {
   //  ...
   //}

protobufs/canvas_generated/messages/events.proto

@@ -1028,6 +1028,22 @@ enum EventType {
   DEFER_CODING_GAP_COMMAND__POST_EXECUTE_ACTION = 60011;
   DEFER_CODING_GAP_COMMAND__POST_INSERTED_INTO_NOTE = 60012;
 
+  CHANGE_MEDICATION_COMMAND__PRE_ORIGINATE = 61000;
+  CHANGE_MEDICATION_COMMAND__POST_ORIGINATE = 61001;
+  CHANGE_MEDICATION_COMMAND__PRE_UPDATE = 61002;
+  CHANGE_MEDICATION_COMMAND__POST_UPDATE = 61003;
+  CHANGE_MEDICATION_COMMAND__PRE_COMMIT = 61004;
+  CHANGE_MEDICATION_COMMAND__POST_COMMIT = 61005;
+  CHANGE_MEDICATION_COMMAND__PRE_DELETE = 61006;
+  CHANGE_MEDICATION_COMMAND__POST_DELETE = 61007;
+  CHANGE_MEDICATION_COMMAND__PRE_ENTER_IN_ERROR = 61008;
+  CHANGE_MEDICATION_COMMAND__POST_ENTER_IN_ERROR = 61009;
+  CHANGE_MEDICATION_COMMAND__PRE_EXECUTE_ACTION = 61010;
+  CHANGE_MEDICATION_COMMAND__POST_EXECUTE_ACTION = 61011;
+  CHANGE_MEDICATION_COMMAND__POST_INSERTED_INTO_NOTE = 61012;
+  CHANGE_MEDICATION__MEDICATION__PRE_SEARCH = 61013;
+  CHANGE_MEDICATION__MEDICATION__POST_SEARCH = 61014;
+
   SHOW_NOTE_HEADER_BUTTON = 70000;
   SHOW_NOTE_FOOTER_BUTTON = 70001;
   ACTION_BUTTON_CLICKED = 70002;

settings.py

@@ -14,6 +14,7 @@ ENV = os.getenv("ENV", "development")
 IS_PRODUCTION = ENV == "production"
 IS_PRODUCTION_CUSTOMER = env_to_bool("IS_PRODUCTION_CUSTOMER", IS_PRODUCTION)
 IS_TESTING = env_to_bool("IS_TESTING", "pytest" in sys.argv[0] or sys.argv[0] == "-c")
+IS_SCRIPT = env_to_bool("IS_SCRIPT", "plugin_runner.py" not in sys.argv[0])
 CUSTOMER_IDENTIFIER = os.getenv("CUSTOMER_IDENTIFIER", "local")
 APP_NAME = os.getenv("APP_NAME")
 
@@ -24,6 +25,9 @@ INTEGRATION_TEST_CLIENT_SECRET = os.getenv("INTEGRATION_TEST_CLIENT_SECRET")
 GRAPHQL_ENDPOINT = os.getenv("GRAPHQL_ENDPOINT", "http://localhost:8000/plugins-graphql")
 REDIS_ENDPOINT = os.getenv("REDIS_ENDPOINT", f"redis://{APP_NAME}-redis:6379")
 
+
+METRICS_ENABLED = env_to_bool("PLUGINS_METRICS_ENABLED", not IS_SCRIPT)
+
 INSTALLED_APPS = [
     "canvas_sdk.v1",
 ]

canvas_sdk/utils/stats.py

@@ -1,74 +0,0 @@
-from datetime import timedelta
-from time import time
-from typing import Any
-
-from statsd.defaults.env import statsd as default_statsd_client
-
-
-def get_duration_ms(start_time: float) -> int:
-    """Get the duration in milliseconds since the given start time."""
-    return int((time() - start_time) * 1000)
-
-
-LINE_PROTOCOL_TRANSLATION = str.maketrans(
-    {
-        ",": r"\,",
-        "=": r"\=",
-        " ": r"\ ",
-        ":": r"__",
-    }
-)
-
-
-def tags_to_line_protocol(tags: dict[str, Any]) -> str:
-    """Generate a tags string compatible with the InfluxDB line protocol.
-
-    See: https://docs.influxdata.com/influxdb/v1.1/write_protocols/line_protocol_tutorial/
-    """
-    return ",".join(
-        f"{tag_name}={str(tag_value).translate(LINE_PROTOCOL_TRANSLATION)}"
-        for tag_name, tag_value in tags.items()
-    )
-
-
-STATS_ENABLED = True
-
-
-class StatsDClientProxy:
-    """Proxy for a StatsD client."""
-
-    def __init__(self) -> None:
-        self.client = default_statsd_client
-
-    def gauge(self, metric_name: str, value: float, tags: dict[str, str]) -> None:
-        """Sends a gauge metric to StatsD with properly formatted tags.
-
-        Args:
-            metric_name (str): The name of the metric.
-            value (float): The value to report.
-            tags (dict[str, str]): Dictionary of tags to attach to the metric.
-        """
-        if not STATS_ENABLED:
-            return
-
-        statsd_tags = tags_to_line_protocol(tags)
-        self.client.gauge(f"{metric_name},{statsd_tags}", value)
-
-    def timing(self, metric_name: str, delta: float | timedelta, tags: dict[str, str]) -> None:
-        """Sends a timing metric to StatsD with properly formatted tags.
-
-        Args:
-            metric_name (str): The name of the metric.
-            delta (float | timedelta): The value to report.
-            tags (dict[str, str]): Dictionary of tags to attach to the metric.
-        """
-        if not STATS_ENABLED:
-            return
-
-        statsd_tags = tags_to_line_protocol(tags)
-        self.client.timing(f"{metric_name},{statsd_tags}", delta)
-
-
-statsd_client = StatsDClientProxy()
-
-__exports__ = ()