omnata-plugin-runtime 0.4.3__tar.gz → 0.4.4__tar.gz

{omnata_plugin_runtime-0.4.3 → omnata_plugin_runtime-0.4.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: omnata-plugin-runtime
-Version: 0.4.3
+Version: 0.4.4
 Summary: Classes and common runtime components for building and running Omnata Plugins
 Author: James Weakley
 Author-email: james.weakley@omnata.com

{omnata_plugin_runtime-0.4.3 → omnata_plugin_runtime-0.4.4}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "omnata-plugin-runtime"
-version = "0.4.3"
+version = "0.4.4"
 description = "Classes and common runtime components for building and running Omnata Plugins"
 authors = ["James Weakley <james.weakley@omnata.com>"]
 readme = "README.md"

{omnata_plugin_runtime-0.4.3 → omnata_plugin_runtime-0.4.4}/src/omnata_plugin_runtime/omnata_plugin.py

@@ -427,7 +427,7 @@ class SyncRequest(ABC):
         """
         return not self._thread_cancellation_token.wait(seconds)
 
-    def update_activity(self, current_activity: str):
+    def update_activity(self, current_activity: str) -> Dict:
         """
         Provides an update to the user on what's happening inside the sync run. It should
         be used before commencing a potential long-running phase, like polling and waiting or
@@ -436,11 +436,11 @@ class SyncRequest(ABC):
         Avoid lengthy diagnostic messages, anything like this should be logged the normal way.
         """
         logger.info(f"Activity update: {current_activity}")
-        self._plugin_message(
+        return self._plugin_message(
             PluginMessageCurrentActivity(current_activity=current_activity)
         )
 
-    def _plugin_message(self, message: PluginMessage) -> Dict:
+    def _plugin_message(self, message: PluginMessage, ignore_errors:bool = True) -> Dict:
         """
         Sends a message back to the plugin. This is used to send back the results of a sync run.
         """
@@ -456,9 +456,13 @@ class SyncRequest(ABC):
                     ).collect()
                 )
             except Exception as e:
-                logger.error(
-                    f"Error sending plugin message: {e}", exc_info=True, stack_info=True
-                )
+                if ignore_errors:
+                    logger.error(
+                        f"Error sending plugin message: {e}", exc_info=True, stack_info=True
+                    )
+                    return None
+                else:
+                    raise e
 
 
 class HttpRateLimiting:
@@ -978,7 +982,7 @@ class InboundSyncRequest(SyncRequest):
         # so we need to make sure all the results are applied first
         self.apply_progress_updates()
     
-    def apply_progress_updates(self):
+    def apply_progress_updates(self, ignore_errors:bool = True):
         """
         Sends a message to the plugin with the current progress of the sync run, if it has changed since last time.
         """
@@ -989,10 +993,14 @@ class InboundSyncRequest(SyncRequest):
                 total_records_estimate=self._total_records_estimate
             )
         if self._last_stream_progress_update is None or new_progress_update != self._last_stream_progress_update:
-            self._plugin_message(
-                message=new_progress_update
+            result = self._plugin_message(
+                message=new_progress_update,
+                ignore_errors=ignore_errors
             )
+            if result is None:
+                return False
             self._last_stream_progress_update = new_progress_update
+        return True
 
     def apply_cancellation(self):
         """

{omnata_plugin_runtime-0.4.3 → omnata_plugin_runtime-0.4.4}/src/omnata_plugin_runtime/plugin_entrypoints.py

@@ -221,7 +221,8 @@ class PluginEntrypoint:
                     logger.info("Calling apply_rate_limit_state")
                     inbound_sync_request.apply_rate_limit_state()
                     logger.info("Calling apply_progress_updates")
-                    inbound_sync_request.apply_progress_updates()
+                    # we can't ignore errors here, because the sync engine needs to get the progress updates before we return
+                    inbound_sync_request.apply_progress_updates(ignore_errors=False)
                 if inbound_sync_request.deadline_reached:
                     # if we actually hit the deadline, this is flagged by the cancellation checking worker and the cancellation
                     # token is set. We throw it here as an error since that's currently how it flows back to the engine with a DELAYED state