WIP: Plugin loading & reloading

canvas_cli/templates/plugins/default/{{ cookiecutter.project_slug }}/pyproject.toml

@@ -0,0 +1,14 @@
+[tool.poetry]
+classifiers = ["Environment :: Canvas :: Plugins"]
+name = "{{ cookiecutter.project_name.lower().strip().replace(' ', '_') }}"
+version = "{{ cookiecutter.version }}"
+description = ""
+authors = ["Beau Gunderson <beau@beaugunderson.com>"]
+readme = "README.md"
+
+[tool.poetry.dependencies]
+python = "^3.11"
+
+[build-system]
+requires = ["poetry-core"]
+build-backend = "poetry.core.masonry.api"

custom-plugins/my_first_plugin/CANVAS_MANIFEST.json

@@ -0,0 +1,27 @@
+{
+    "sdk_version": "0.1.4",
+    "plugin_version": "0.1.0",
+    "name": "My First Plugin",
+    "description": "A plugin to interact with a Canvas Instance",
+    "components": {
+        "protocols": [
+            {
+                "class": "my_first_plugin.protocols.protocol:Protocol",
+                "description": "A protocol that does xyz...",
+                "data_access": {
+                    "event": "assess_condition_selected",
+                    "read": [
+                        "conditions"
+                    ],
+                    "write": [
+                        "commands"
+                    ]
+                }
+            }
+        ],
+        "commands": [],
+        "content": [],
+        "effects": [],
+        "views": []
+    }
+}

custom-plugins/my_first_plugin/README.md

@@ -0,0 +1,18 @@
+===============
+My First Plugin
+===============
+
+A plugin to interact with a Canvas Instance
+
+## Structure
+
+```
+my_first_plugin/
+├── commands/
+├── content/
+├── effects/
+├── protocols/
+├── views/
+├── CANVAS_MANIFEST.json
+└── README.md
+```

custom-plugins/my_first_plugin/protocols/protocol.py

@@ -0,0 +1,22 @@
+import json
+
+
+class Protocol:
+    RESPONDS_TO = "ASSESS_COMMAND__CONDITION_SELECTED"
+
+    NARRATIVE_STRING = "monkey"
+
+    def __init__(self, event) -> None:
+        self.event = event
+        self.payload = json.loads(event.target)
+
+    def compute(self):
+        return [
+            {
+                "effect_type": "ADD_PLAN_COMMAND",
+                "payload": {
+                    "note": {"uuid": self.payload["note"]["uuid"]},
+                    "data": {"narrative": self.NARRATIVE_STRING},
+                },
+            }
+        ]

custom-plugins/my_second_plugin/CANVAS_MANIFEST.json

@@ -0,0 +1,27 @@
+{
+    "sdk_version": "0.1.4",
+    "plugin_version": "0.1.0",
+    "name": "My Second Plugin",
+    "description": "A plugin to interact with a Canvas Instance",
+    "components": {
+        "protocols": [
+            {
+                "class": "my_second_plugin.protocols.protocol:Protocol",
+                "description": "A protocol that does xyz...",
+                "data_access": {
+                    "event": "assess_condition_selected",
+                    "read": [
+                        "conditions"
+                    ],
+                    "write": [
+                        "commands"
+                    ]
+                }
+            }
+        ],
+        "commands": [],
+        "content": [],
+        "effects": [],
+        "views": []
+    }
+}

custom-plugins/my_second_plugin/README.md

@@ -0,0 +1,18 @@
+================
+My Second Plugin
+================
+
+A plugin to interact with a Canvas Instance
+
+## Structure
+
+```
+my_second_plugin/
+├── commands/
+├── content/
+├── effects/
+├── protocols/
+├── views/
+├── CANVAS_MANIFEST.json
+└── README.md
+```

custom-plugins/my_second_plugin/protocols/protocol.py

@@ -0,0 +1,14 @@
+import json
+
+
+class Protocol:
+    RESPONDS_TO = "SOMETHING_ELSE"
+
+    NARRATIVE_STRING = ""
+
+    def __init__(self, event) -> None:
+        self.event = event
+        self.payload = json.loads(event.target)
+
+    def compute(self):
+        return [{"effect_type": "ANOTHER_COMMAND_ADDITION", "payload": {}}]

plugin_runner/generated/messages/plugins_pb2.pyi

@@ -0,0 +1,15 @@
+from google.protobuf import descriptor as _descriptor
+from google.protobuf import message as _message
+from typing import ClassVar as _ClassVar, Optional as _Optional
+
+DESCRIPTOR: _descriptor.FileDescriptor
+
+class ReloadPluginsRequest(_message.Message):
+    __slots__ = ()
+    def __init__(self) -> None: ...
+
+class ReloadPluginsResponse(_message.Message):
+    __slots__ = ("success",)
+    SUCCESS_FIELD_NUMBER: _ClassVar[int]
+    success: bool
+    def __init__(self, success: bool = ...) -> None: ...

plugin_runner/generated/messages/plugins_pb2_grpc.py

@@ -0,0 +1,4 @@
+# Generated by the gRPC Python protocol compiler plugin. DO NOT EDIT!
+"""Client and server classes corresponding to protobuf-defined services."""
+import grpc
+

plugin_runner/generated/services/plugin_runner_pb2.pyi

@@ -1,4 +1,5 @@
 from generated.messages import events_pb2 as _events_pb2
+from generated.messages import plugins_pb2 as _plugins_pb2
 from google.protobuf import descriptor as _descriptor
 from typing import ClassVar as _ClassVar
 

plugin_runner/generated/services/plugin_runner_pb2_grpc.py

@@ -3,6 +3,7 @@
 import grpc
 
 from generated.messages import events_pb2 as generated_dot_messages_dot_events__pb2
+from generated.messages import plugins_pb2 as generated_dot_messages_dot_plugins__pb2
 
 
 class PluginRunnerStub(object):
@@ -19,6 +20,11 @@ def __init__(self, channel):
                 request_serializer=generated_dot_messages_dot_events__pb2.Event.SerializeToString,
                 response_deserializer=generated_dot_messages_dot_events__pb2.EventResponse.FromString,
                 )
+        self.ReloadPlugins = channel.unary_stream(
+                '/canvas.PluginRunner/ReloadPlugins',
+                request_serializer=generated_dot_messages_dot_plugins__pb2.ReloadPluginsRequest.SerializeToString,
+                response_deserializer=generated_dot_messages_dot_plugins__pb2.ReloadPluginsResponse.FromString,
+                )
 
 
 class PluginRunnerServicer(object):
@@ -30,6 +36,12 @@ def HandleEvent(self, request, context):
         context.set_details('Method not implemented!')
         raise NotImplementedError('Method not implemented!')
 
+    def ReloadPlugins(self, request, context):
+        """Missing associated documentation comment in .proto file."""
+        context.set_code(grpc.StatusCode.UNIMPLEMENTED)
+        context.set_details('Method not implemented!')
+        raise NotImplementedError('Method not implemented!')
+
 
 def add_PluginRunnerServicer_to_server(servicer, server):
     rpc_method_handlers = {
@@ -38,6 +50,11 @@ def add_PluginRunnerServicer_to_server(servicer, server):
                     request_deserializer=generated_dot_messages_dot_events__pb2.Event.FromString,
                     response_serializer=generated_dot_messages_dot_events__pb2.EventResponse.SerializeToString,
             ),
+            'ReloadPlugins': grpc.unary_stream_rpc_method_handler(
+                    servicer.ReloadPlugins,
+                    request_deserializer=generated_dot_messages_dot_plugins__pb2.ReloadPluginsRequest.FromString,
+                    response_serializer=generated_dot_messages_dot_plugins__pb2.ReloadPluginsResponse.SerializeToString,
+            ),
     }
     generic_handler = grpc.method_handlers_generic_handler(
             'canvas.PluginRunner', rpc_method_handlers)
@@ -64,3 +81,20 @@ def HandleEvent(request,
             generated_dot_messages_dot_events__pb2.EventResponse.FromString,
             options, channel_credentials,
             insecure, call_credentials, compression, wait_for_ready, timeout, metadata)
+
+    @staticmethod
+    def ReloadPlugins(request,
+            target,
+            options=(),
+            channel_credentials=None,
+            call_credentials=None,
+            insecure=False,
+            compression=None,
+            wait_for_ready=None,
+            timeout=None,
+            metadata=None):
+        return grpc.experimental.unary_stream(request, target, '/canvas.PluginRunner/ReloadPlugins',
+            generated_dot_messages_dot_plugins__pb2.ReloadPluginsRequest.SerializeToString,
+            generated_dot_messages_dot_plugins__pb2.ReloadPluginsResponse.FromString,
+            options, channel_credentials,
+            insecure, call_credentials, compression, wait_for_ready, timeout, metadata)