omnata-plugin-runtime 0.10.31__tar.gz → 0.10.32__tar.gz

{omnata_plugin_runtime-0.10.31 → omnata_plugin_runtime-0.10.32}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: omnata-plugin-runtime
-Version: 0.10.31
+Version: 0.10.32
 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.10.31 → omnata_plugin_runtime-0.10.32}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "omnata-plugin-runtime"
-version = "0.10.31"
+version = "0.10.32"
 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.10.31 → omnata_plugin_runtime-0.10.32}/src/omnata_plugin_runtime/api.py

@@ -108,9 +108,9 @@ class OutboundSyncRequestPayload(BaseModel):
     Encapsulates the payload that is sent to the plugin when it is invoked to perform an outbound sync.
     """
 
-    sync_id: int  # only used by log handler
+    sync_id: int
     sync_branch_name: str = 'main'
-    sync_branch_id: Optional[int]  # only used by log handler
+    sync_branch_id: Optional[int]
     connection_id: int  # only used by log handler
     run_id: int  # used by log handler and for reporting back run status updates
     source_app_name: str  # the name of the app which is invoking this plugin
@@ -139,8 +139,8 @@ class InboundSyncRequestPayload(BaseModel):
     Encapsulates the payload that is sent to the plugin when it is invoked to perform an inbound sync.
     """
 
-    sync_id: int  # only used by log handler
-    sync_branch_name: str = 'main' # only used by rate limit updater
+    sync_id: int
+    sync_branch_name: str = 'main'
     sync_branch_id: Optional[int] = None  # only used by log handler
     connection_id: int  # only used by log handler
     run_id: int  # used by log handler and for reporting back run status updates

{omnata_plugin_runtime-0.10.31 → omnata_plugin_runtime-0.10.32}/src/omnata_plugin_runtime/omnata_plugin.py

@@ -289,6 +289,8 @@ class SyncRequest(ABC):
         run_deadline: datetime.datetime,
         development_mode: bool = False,
         test_replay_mode: bool = False,
+        sync_id: Optional[int] = None,
+        branch_name: Optional[str] = None
     ):
         """
         Constructs a SyncRequest.
@@ -314,6 +316,8 @@ class SyncRequest(ABC):
             self.plugin_instance._sync_request = self
         self._session: Session = session
         self._run_id = run_id
+        self._sync_id = sync_id
+        self._branch_name = branch_name
         self.api_limits = api_limits
         self.rate_limit_state_all = rate_limit_state_all
         self.rate_limit_state_this_sync_and_branch = rate_limit_state_this_sync_and_branch
@@ -692,6 +696,8 @@ class OutboundSyncRequest(SyncRequest):
         run_deadline: datetime.datetime,
         development_mode: bool = False,
         test_replay_mode: bool = False,
+        sync_id: Optional[int] = None,
+        branch_name: Optional[str] = None
     ):
         """
         Constructs an OutboundSyncRequest.
@@ -717,7 +723,9 @@ class OutboundSyncRequest(SyncRequest):
             rate_limit_state_this_sync_and_branch=rate_limit_state_this_sync_and_branch,
             run_deadline=run_deadline,
             development_mode=development_mode,
-            test_replay_mode=test_replay_mode
+            test_replay_mode=test_replay_mode,
+            sync_id=sync_id,
+            branch_name=branch_name
         )
         self._full_records_table_name = (
             f"{source_app_name}.{records_schema_name}.{records_table_name}"
@@ -1018,6 +1026,8 @@ class InboundSyncRequest(SyncRequest):
         omnata_log_handler:OmnataPluginLogHandler,
         development_mode: bool = False,
         test_replay_mode: bool = False,
+        sync_id: Optional[int] = None,
+        branch_name: Optional[str] = None
     ):
         """
         Constructs a record apply request.
@@ -1071,7 +1081,9 @@ class InboundSyncRequest(SyncRequest):
             rate_limit_state_this_sync_and_branch=rate_limit_state_this_sync_and_branch,
             run_deadline=run_deadline,
             development_mode=development_mode,
-            test_replay_mode=test_replay_mode
+            test_replay_mode=test_replay_mode,
+            sync_id=sync_id,
+            branch_name=branch_name
         )
         # named by convention, see SyncRunProcessor.enqueue
         self._criteria_deletes_table_name = (

{omnata_plugin_runtime-0.10.31 → omnata_plugin_runtime-0.10.32}/src/omnata_plugin_runtime/plugin_entrypoints.py

@@ -184,7 +184,9 @@ class PluginEntrypoint:
                 rate_limit_state_this_sync_and_branch=rate_limit_state_this_branch,
                 run_deadline=datetime.datetime.now(datetime.timezone.utc) + datetime.timedelta(minutes=request.time_limit_mins),
                 # for now, use the development mode flag to disable background workers
-                development_mode=self._plugin_instance.disable_background_workers
+                development_mode=self._plugin_instance.disable_background_workers,
+                sync_id=request.sync_id,
+                sync_branch_name=request.sync_branch_name
             )
             try:
                 self._plugin_instance._configuration_parameters = parameters
@@ -240,7 +242,9 @@ class PluginEntrypoint:
                 # for now, use the development mode flag to disable background workers
                 development_mode=self._plugin_instance.disable_background_workers,
                 streams=list(request.streams_configuration.included_streams.values()),
-                omnata_log_handler=omnata_log_handler
+                omnata_log_handler=omnata_log_handler,
+                sync_id=request.sync_id,
+                sync_branch_name=request.sync_branch_name
             )
             try:
                 self._plugin_instance._configuration_parameters = parameters