canvas 0.56.0__py3-none-any.whl → 0.57.1__py3-none-any.whl

{canvas-0.56.0.dist-info → canvas-0.57.1.dist-info}/METADATA

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

{canvas-0.56.0.dist-info → canvas-0.57.1.dist-info}/RECORD

@@ -1,6 +1,6 @@
 settings.py,sha256=Yu4LE0PcohXgxqO8-W0b5uoXMJ20p-NpUj1lNFCdB8I,6296
 canvas_cli/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-canvas_cli/main.py,sha256=L6JQkt1yxy30cA3-M9v7JD8WMW4i0M5GPr9kZetAito,2728
+canvas_cli/main.py,sha256=INnlb8THwC0kbUJY94FVFq4UtDRGRyBBm6jASTzV0mU,3111
 canvas_cli/apps/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 canvas_cli/apps/auth/__init__.py,sha256=gIwJ2qWvRlLqbiRkudrGqTKV-orlb8OTkG487qoRda4,105
 canvas_cli/apps/auth/storage.py,sha256=D5zZaZo_kDCxXmyjtHsPJOatD0fP5eO1OoHFdxwCxH4,1656
@@ -67,8 +67,8 @@ canvas_cli/apps/emit/event_fixtures/VITAL_SIGN_CREATED.ndjson,sha256=p5XQozktqGA
 canvas_cli/apps/emit/event_fixtures/VITAL_SIGN_UPDATED.ndjson,sha256=Er0aUWIYkqbL9JdCaiNBuzizuHiOmFQr5Q2uYTtWj8I,36764
 canvas_cli/apps/logs/__init__.py,sha256=ehY9SRb6nBw81xZF50yyBlUZJtNR2VeVSNI5sFuWJ7o,64
 canvas_cli/apps/logs/logs.py,sha256=BFpZ-2OF2Rs1EMLePo5UjqC9fKQeqm8qZobNTFNCL_M,1972
-canvas_cli/apps/plugin/__init__.py,sha256=G_nLsu6cdko5OjatnbqUyEboGcNlGGLwpZmCBxMKdfo,236
-canvas_cli/apps/plugin/plugin.py,sha256=RqjNdP8Lzy5XaaQFx4eu1AnT2L_KHWQs2XvzRLCTdDs,17551
+canvas_cli/apps/plugin/__init__.py,sha256=GB6hBwbajm5cOs-DbJh3q6smPfAaIMa99tSbkvDtbqs,341
+canvas_cli/apps/plugin/plugin.py,sha256=vlnd61nPt98NnYUPAeZMogcRPgv1pdDqBtey13H_Tug,20817
 canvas_cli/apps/run_plugins/__init__.py,sha256=iAMgX_6D3CdjQodGx_azwhSjouaxquOm8Z8QVXnlTFE,117
 canvas_cli/apps/run_plugins/run_plugins.py,sha256=w4JTsXFiHckZahvbSOJAqZo3jWwedxlHLiXct1j_6cY,392
 canvas_cli/templates/plugins/application/cookiecutter.json,sha256=cI4Wpj68TkKeBP3P16PrjKacTHzsTIpl_rDdzyUpwz4,129
@@ -309,7 +309,7 @@ plugin_runner/exceptions.py,sha256=ltqn56SMTg-T5miSh5hux4ojwx0hZGSWaB7BxyAmcAo,5
 plugin_runner/generate_allowed_imports.py,sha256=LQuVxL_j5n0Sj-KgR4Q8D9mj0xfuDqzO69kBfZUqwGE,2565
 plugin_runner/installation.py,sha256=2KTDWWsQ97WIN2k9tC4d50zN77WWK_1D5obXlhLfWw8,8536
 plugin_runner/load_all_plugins.py,sha256=4T2gW2YljhIx4xfwf1c0F_8oIbE1ubsLj0ShkHRtlVY,5847
-plugin_runner/plugin_runner.py,sha256=oGYaYox_yG45N0IQ2DjgMMCpNEP_aGCwClIeadVFJ8Q,26402
+plugin_runner/plugin_runner.py,sha256=RpcZoXXzGEflJGuHJaAOCP24mWb4fG1bLw3ryA6n88k,26623
 plugin_runner/sandbox.py,sha256=A5iaxQePwA5FERK232MArq2VzZzHKM5ydrfTDFeXcLg,30232
 protobufs/canvas_generated/messages/effects.proto,sha256=wQBRk0_XN8ssIjDtRttxsEG6pZJbYS8czGzdvpx3g6M,9756
 protobufs/canvas_generated/messages/events.proto,sha256=21qM3Ct9-iIG_T7O-XoFPWpnVafocYJ1KGiZ2nn1CFM,52047
@@ -317,7 +317,7 @@ protobufs/canvas_generated/messages/plugins.proto,sha256=xJyEeTwM6wWja3vGECLsIzf
 protobufs/canvas_generated/services/plugin_runner.proto,sha256=PZ0Ts11b9tdA5Gkg2M05JVEKAm0R4LFEwrGRS-TQ16E,466
 pubsub/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 pubsub/pubsub.py,sha256=PHIvJ5SD3M-jQSYeGGSj1FuG6CvP6BQffAoGax9Uudk,1423
-canvas-0.56.0.dist-info/METADATA,sha256=-OXQE3WANI18Q4p8n403Ijs7sXqBaeuML85LW7ZKT68,4645
-canvas-0.56.0.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-canvas-0.56.0.dist-info/entry_points.txt,sha256=0Vs_9GmTVUNniH6eDBlRPgofmADMV4BES6Ao26M4AbM,47
-canvas-0.56.0.dist-info/RECORD,,
+canvas-0.57.1.dist-info/METADATA,sha256=MPYJjyR4mKewN9sbDrqzm3N0WSDY1ZY47gIRtCpqUbE,4645
+canvas-0.57.1.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+canvas-0.57.1.dist-info/entry_points.txt,sha256=0Vs_9GmTVUNniH6eDBlRPgofmADMV4BES6Ao26M4AbM,47
+canvas-0.57.1.dist-info/RECORD,,

canvas_cli/apps/plugin/__init__.py

@@ -4,8 +4,20 @@ from canvas_cli.apps.plugin.plugin import (
     init,
     install,
     list,
+    list_secrets,
+    set_secrets,
     uninstall,
     validate_manifest,
 )
 
-__all__ = ("uninstall", "enable", "disable", "init", "validate_manifest", "install", "list")
+__all__ = (
+    "list_secrets",
+    "set_secrets",
+    "disable",
+    "enable",
+    "init",
+    "install",
+    "list",
+    "uninstall",
+    "validate_manifest",
+)

canvas_cli/apps/plugin/plugin.py

@@ -1,9 +1,12 @@
 import ast
+import base64
+import builtins
 import json
 import tarfile
 import tempfile
 from collections.abc import Iterable
 from pathlib import Path
+from pprint import pprint
 from typing import Any, cast
 from urllib.parse import urljoin
 
@@ -160,17 +163,17 @@ def _get_meta_properties(protocol_path: Path, classname: str) -> dict[str, str]:
         if isinstance(meta_b.value, ast.Constant):
             value = meta_b.value.value
         elif isinstance(meta_b.value, ast.List):
-            value = [cast(ast.Constant, e).value for e in meta_b.value.elts]
+            value = [cast(ast.Constant, e).value for e in meta_b.value.elts]  # type: ignore[assignment]
         elif isinstance(meta_b.value, ast.Dict):
             keys = meta_b.value.keys
             values = meta_b.value.values
-            value = {
+            value = {  # type: ignore[assignment]
                 cast(ast.Constant, k).value: cast(ast.Constant, values[i]).value
                 for i, k in enumerate(keys)
             }
         else:
             value = None
-        meta[target_id] = value
+        meta[target_id] = value  # type: ignore[assignment]
 
     return meta
 
@@ -204,6 +207,18 @@ def get_base_plugin_template_path(plugin_type: str) -> Path:
             return context.plugin_template_dir / context.default_plugin_template_name
 
 
+def parse_secrets(secrets: builtins.list[str]) -> builtins.list[str]:
+    """Parse secrets from the command line, expecting them in the format Key=value."""
+    parsed_secrets = []
+
+    for secret in secrets:
+        if "=" not in secret:
+            raise typer.BadParameter(f"Invalid secret format: '{secret}'. Use key=value.")
+        parsed_secrets.append(secret)
+
+    return parsed_secrets
+
+
 def init(
     plugin_type: str = typer.Argument(
         "protocol",
@@ -222,6 +237,9 @@ def init(
 
 def install(
     plugin_name: Path = typer.Argument(..., help="Path to plugin to install"),
+    secrets: builtins.list[str] = typer.Option(
+        [], "--secret", callback=parse_secrets, help="Secrets to set, e.g. Key=value"
+    ),
     host: str | None = typer.Option(
         callback=get_default_host,
         help="Canvas instance to connect to",
@@ -243,6 +261,11 @@ def install(
     else:
         raise typer.BadParameter(f"Plugin '{plugin_name}' needs to be a valid directory")
 
+    encoded_secrets = []
+    for pair in secrets:
+        encoded = base64.b64encode(pair.encode()).decode()
+        encoded_secrets.append(("secret", encoded))
+
     print(f"Installing plugin: {built_package_path} into {host}")
 
     url = plugin_url(host)
@@ -250,10 +273,11 @@ def install(
     print(f"Posting {built_package_path.absolute()} to {url}")
 
     try:
+        data = [("is_enabled", True)] + encoded_secrets
         with open(built_package_path, "rb") as package:
             r = requests.post(
                 url,
-                data={"is_enabled": True},
+                data=data,
                 files={"package": package},
                 headers={"Authorization": f"Bearer {token}"},
             )
@@ -270,7 +294,7 @@ def install(
         package_name := _get_name_from_metadata(host, token, built_package_path)
     ):
         print(f"Plugin {package_name} already exists, updating instead...")
-        update(package_name, built_package_path, is_enabled=True, host=host)
+        update(package_name, built_package_path, is_enabled=True, secrets=secrets, host=host)
     else:
         print(f"Status code {r.status_code}: {r.text}")
         raise typer.Exit(1)
@@ -427,6 +451,58 @@ def list(
         raise typer.Exit(1)
 
 
+def list_secrets(
+    plugin: str = typer.Argument(..., help="Plugin name to list secrets for"),
+    host: str | None = typer.Option(
+        callback=get_default_host,
+        help="Canvas instance to connect to",
+        default=None,
+    ),
+) -> None:
+    """List all secrets from a plugin on a Canvas instance."""
+    if not host:
+        raise typer.BadParameter("Please specify a host or add one to the configuration file")
+
+    url = plugin_url(host, plugin, "metadata")
+
+    token = get_or_request_api_token(host)
+
+    try:
+        r = requests.get(
+            url,
+            headers={"Authorization": f"Bearer {token}"},
+        )
+    except requests.exceptions.RequestException:
+        print(f"Failed to connect to {host}")
+        raise typer.Exit(1) from None
+
+    if r.status_code == requests.codes.ok:
+        secrets = r.json().get("secrets", [])
+
+        if secrets:
+            pprint(secrets)
+        else:
+            print("No secrets configured.")
+    else:
+        print(f"Status code {r.status_code}: {r.text}")
+        raise typer.Exit(1)
+
+
+def set_secrets(
+    plugin: str = typer.Argument(..., help="Plugin name to configure"),
+    host: str | None = typer.Option(
+        callback=get_default_host,
+        help="Canvas instance to connect to",
+        default=None,
+    ),
+    secrets: builtins.list[str] = typer.Argument(
+        ..., callback=parse_secrets, help="Secrets to set, e.g. Key=value"
+    ),
+) -> None:
+    """Configure plugin secrets on a Canvas instance."""
+    update(name=plugin, package_path=None, secrets=secrets, host=host, is_enabled=None)
+
+
 def validate_manifest(
     plugin_name: Path = typer.Argument(..., help="Path to plugin to validate"),
 ) -> None:
@@ -473,6 +549,9 @@ def update(
     is_enabled: bool | None = typer.Option(
         None, "--enable/--disable", show_default=False, help="Enable/disable the plugin"
     ),
+    secrets: builtins.list[str] = typer.Option(
+        [], "--secret", callback=parse_secrets, help="Secrets to set, e.g. Key=value"
+    ),
     host: str | None = typer.Option(
         callback=get_default_host,
         help="Canvas instance to connect to",
@@ -488,12 +567,27 @@ def update(
 
     token = get_or_request_api_token(host)
 
-    print(f"Updating plugin {name} from {host} with {is_enabled=}, {package_path=}")
+    encoded_secrets = []
+    for pair in secrets:
+        encoded = base64.b64encode(pair.encode()).decode()
+        encoded_secrets.append(("secret", encoded))
+
+    args = [
+        *((f"is_enabled={is_enabled}",) if is_enabled is not None else ()),
+        *((f"package_path={package_path}",) if package_path is not None else ()),
+        *((f"secrets={','.join([s.split('=')[0] for s in secrets])}",) if secrets else ()),
+    ]
+
+    print(f"Updating plugin {name} from {host}" + (f" with {', '.join(args)}" if args else ""))
 
     url = plugin_url(host, name)
 
     try:
-        data = {"is_enabled": is_enabled} if is_enabled is not None else {}
+        data = (
+            [("is_enabled", is_enabled)] + encoded_secrets
+            if is_enabled is not None
+            else encoded_secrets
+        )
         headers = {"Authorization": f"Bearer {token}"}
 
         if package_path:
@@ -515,7 +609,10 @@ def update(
         raise typer.Exit(1) from None
 
     if r.status_code == requests.codes.ok:
-        print("New plugin version uploaded! Check logs for more details.")
+        if package_path:
+            print("New plugin version uploaded! Check logs for more details.")
+        elif secrets:
+            print("Plugin secrets successfully updated.")
 
     else:
         print(f"Status code {r.status_code}: {r.text}")

canvas_cli/main.py

@@ -29,6 +29,16 @@ app.command(
 app.command(short_help="Run the specified plugins for local development.")(run_plugins)
 app.command(short_help="Run the specified plugin for local development.")(run_plugin)
 
+# Config app
+config_app = typer.Typer(help="Manage plugin secrets.", rich_markup_mode=None, add_completion=False)
+app.add_typer(config_app, name="config")
+config_app.command(name="list", short_help="List plugin secrets on a Canvas instance.")(
+    plugin.list_secrets
+)
+config_app.command(name="set", short_help="Set plugin secrets on a Canvas instance.")(
+    plugin.set_secrets
+)
+
 # Our current version
 __version__ = importlib.metadata.version("canvas")
 

plugin_runner/plugin_runner.py

@@ -731,7 +731,14 @@ def main(specified_plugin_paths: list[str] | None = None) -> None:
     port = "50051"
 
     executor = ThreadPoolExecutor(max_workers=settings.PLUGIN_RUNNER_MAX_WORKERS)
-    server = grpc.server(thread_pool=executor)
+    server = grpc.server(
+        thread_pool=executor,
+        options=(
+            # set max message lengths to 64mb
+            ("grpc.max_receive_message_length", 64 * 1024 * 1024),
+            ("grpc.max_send_message_length", 64 * 1024 * 1024),
+        ),
+    )
     server.add_insecure_port("127.0.0.1:" + port)
 
     add_PluginRunnerServicer_to_server(PluginRunner(), server)