omnata-plugin-runtime 0.1.95__py3-none-any.whl → 0.1.97__py3-none-any.whl

omnata_plugin_runtime/forms.py

@@ -176,22 +176,6 @@ class FormSliderField(SubscriptableBaseModel):
     step_size: int = 1
 
 
-class StreamLister(SubscriptableBaseModel):
-    """
-    A class for managing the listing of Streams. Can depend on other form fields to delay rendering
-    """
-
-    source_function: Union[
-        Callable[[InboundSyncConfigurationParameters], List[StreamConfiguration]], str
-    ]
-    label: str = "Select Objects"
-    depends_on: Optional[str] = None
-
-    @validator("source_function", always=True)
-    def function_name_convertor(cls, v) -> str:
-        return v.__name__ if isinstance(v, MethodType) else v
-
-
 class FormJinjaTemplate(SubscriptableBaseModel):
     """
     Uses text area to allow the user to create a template, which can include column values from the source
@@ -392,12 +376,11 @@ class OutboundSyncConfigurationForm(ConfigurationFormBase):
 
 class InboundSyncConfigurationForm(ConfigurationFormBase):
     """
-    Defines a form for configuring an inbound sync.
-    Includes the zero or more form fields from the base class, and then a means of displaying stream information.
+    Defines a form for configuring an inbound sync, prior to stream selection.
+    The form values provided via these fields are passed into the inbound_list_streams function.
     """
 
     fields: List[FormFieldBase] = Field(default_factory=list)
-    stream_lister: StreamLister
 
 class SecurityIntegrationTemplate(BaseModel):
     """

omnata_plugin_runtime/omnata_plugin.py

@@ -1158,6 +1158,21 @@ class OmnataPlugin(ABC):
         raise NotImplementedError(
             "Your plugin class must implement the inbound_configuration_form method"
         )
+    
+    def inbound_stream_list(
+        self, parameters: InboundSyncConfigurationParameters
+    ) -> List[StreamConfiguration]:
+        """
+        Returns a list of streams which can be sync'd from the app. This function is called after the form returned by inbound_configuration_form
+        has been completed, so that collected information can be used to build the list.
+
+        :param InboundSyncConfigurationParameters parameters the parameters of the sync
+        :return A list of streams which can be sync'd from the app. This may vary based on the parameters provided.
+        :rtype List[StreamConfiguration]
+        """
+        raise NotImplementedError(
+            "Your plugin class must implement the inbound_stream_list method"
+        )
 
     @abstractmethod
     def connect(self, parameters: ConnectionConfigurationParameters) -> ConnectResponse:
@@ -1562,13 +1577,13 @@ def managed_inbound_processing(concurrency: int):
             logger.info(f"method_kwargs: {method_kwargs}")
             if self._sync_request is None:
                 raise ValueError(
-                    "To use the managed_inbound_processing decorator, you must attach an apply request to the plugin instance (via the outbound_sync_request property)"
+                    "To use the managed_inbound_processing decorator, you must attach an apply request to the plugin instance (via the _sync_request property)"
                 )
             # if self._sync_request.api_limits is None:
             #    raise ValueError('To use the managed_inbound_processing decorator, API constraints must be defined. These can be provided in the response to the connect method')
             if len(method_args) == 0:
                 raise ValueError(
-                    "You must provide at least one method argument, and the first argument must be a DataFrame or DataFrame generator (from outbound_sync_request.get_records_to_*)"
+                    "You must provide at least one method argument, and the first argument must be a list of StoredStreamConfigurations (from inbound_sync_request.streams)"
                 )
             first_arg: List[StoredStreamConfiguration] = method_args[0]
             logger.info(first_arg.__class__.__name__)
@@ -1586,7 +1601,7 @@ def managed_inbound_processing(concurrency: int):
                 streams_queue.put(stream)
 
             tasks = []
-            logger.info(f"Creating {concurrency} worker(s) for applying records")
+            logger.info(f"Creating {concurrency} worker(s) for retrieving records")
 
             for i in range(concurrency):
                 # the dataframe/generator was put on the queue, so we remove it from the method args

omnata_plugin_runtime/plugin_entrypoints.py

@@ -150,66 +150,7 @@ class PluginEntrypoint:
                 sync_parameters=request.sync_parameters,
                 current_form_parameters={},
             )
-
-            # build streams object from parameters
-            streams_list: List[StoredStreamConfiguration] = []
-            streams_list = streams_list + list(
-                request.streams_configuration.included_streams.values()
-            )
-
-            # if new streams are included, we need to fetch the list first to find them
-            if request.streams_configuration.include_new_streams:
-                # we have to invoke the inbound_configuration_form to get the StreamLister, as the list
-                # of streams may vary based on the sync parameters
-                form = self._plugin_instance.inbound_configuration_form(parameters)
-                if form.stream_lister is None:
-                    logger.info(
-                        "No stream lister defined, skipping new stream detection"
-                    )
-                else:
-                    all_streams: List[StreamConfiguration] = getattr(
-                        self._plugin_instance, form.stream_lister.source_function
-                    )(parameters)
-                    for s in all_streams:
-                        if (
-                            s.stream_name
-                            not in request.streams_configuration.included_streams
-                            and s.stream_name
-                            not in request.streams_configuration.excluded_streams
-                        ):
-                            if (
-                                request.streams_configuration.new_stream_sync_strategy
-                                not in s.supported_sync_strategies
-                            ):
-                                raise ValueError(
-                                    f"New object {s.stream_name} was found, but does not support the defined sync strategy {request.streams_configuration}"
-                                )
-
-                            new_stream = StoredStreamConfiguration(
-                                stream_name=s.stream_name,
-                                cursor_field=s.source_defined_cursor,
-                                primary_key_field=s.source_defined_primary_key,
-                                latest_state={},
-                                storage_behaviour=request.streams_configuration.new_stream_storage_behaviour,
-                                stream=s,
-                                sync_strategy=request.streams_configuration.new_stream_sync_strategy,
-                            )
-                            streams_list.append(new_stream)
-
-            for stream in streams_list:
-                if stream.stream_name in request.latest_stream_state:
-                    stream.latest_state = request.latest_stream_state[
-                        stream.stream_name
-                    ]
-                    logger.info(
-                        f"Updating stream state for {stream.stream_name}: {stream.latest_state}"
-                    )
-                else:
-                    logger.info(
-                        f"Existing stream state for {stream.stream_name} not found"
-                    )
-            logger.info(f"streams list: {streams_list}")
-            logger.info(f"streams config: {request.streams_configuration}")
+            
             inbound_sync_request = InboundSyncRequest(
                 run_id=request.run_id,
                 session=self._session,
@@ -221,7 +162,7 @@ class PluginEntrypoint:
                 rate_limit_state=request.rate_limits_state,
                 run_deadline=datetime.datetime.now() + datetime.timedelta(hours=4),
                 development_mode=False,
-                streams=streams_list,
+                streams=request.streams_configuration.included_streams,
             )
 
             inbound_sync_request.update_activity("Invoking plugin")
@@ -237,7 +178,6 @@ class PluginEntrypoint:
             inbound_sync_request._thread_cancellation_token.set()  # pylint: disable=protected-access
             inbound_sync_request._apply_results_task.join()  # pylint: disable=protected-access
             inbound_sync_request._cancel_checking_task.join()  # pylint: disable=protected-access
-            return_dict["streams"] = [s.dict() for s in streams_list]
             return_dict["errored_streams"] = list(
                 omnata_log_handler.stream_has_errors.keys()
             )
@@ -312,7 +252,6 @@ class PluginEntrypoint:
         connection_parameters: Dict,
         oauth_secret_name: Optional[str],
         other_secrets_name: Optional[str],
-        function_name: str,
         sync_parameters: Dict,
         selected_streams: Optional[List[str]], # None to return all streams without requiring schema
     ):
@@ -335,11 +274,7 @@ class PluginEntrypoint:
             currently_selected_streams=selected_streams
         )
 
-        the_function = getattr(
-            self._plugin_instance,
-            function_name,
-        )
-        script_result = the_function(parameters)
+        script_result = self._plugin_instance.inbound_stream_list(parameters)
         if isinstance(script_result, BaseModel):
             script_result = script_result.dict()
         elif isinstance(script_result, List):

{omnata_plugin_runtime-0.1.95.dist-info → omnata_plugin_runtime-0.1.97.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: omnata-plugin-runtime
-Version: 0.1.95
+Version: 0.1.97
 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.1.97.dist-info/RECORD

@@ -0,0 +1,12 @@
+omnata_plugin_runtime/__init__.py,sha256=w63LVME5nY-hQ4BBzfacy9kvTunwqHGs8iiSPGAX2ns,1214
+omnata_plugin_runtime/api.py,sha256=vCDTCxPZ5rIhi8aSM6Z0TXWHtGpbCoNvCnM3mKa-47Q,5591
+omnata_plugin_runtime/configuration.py,sha256=kYvHt_CYn_GZDwkjRVJMqGNbmcO0uEFgHz3B8Fi1JAc,30309
+omnata_plugin_runtime/forms.py,sha256=a76q0mZep-Q1XYw0c0uXA0_qbYLwQGAwHZMpZ8125Is,15235
+omnata_plugin_runtime/logging.py,sha256=ne1sLh5cBkjdRS54B30PGc5frABgjy0sF1_2RMcJ_Tk,3012
+omnata_plugin_runtime/omnata_plugin.py,sha256=62ChwLXpvXN6Q9mIlCGnTuAtjEGUnkbGLdgiamLPd7s,75032
+omnata_plugin_runtime/plugin_entrypoints.py,sha256=ZARuAavN8s9oqVGyTnx5eYudaoCFuwwtcPm0UgTKUQw,20821
+omnata_plugin_runtime/rate_limiting.py,sha256=OnFnCdMenpMpAZYumpe6mypRnMmDl1Q02vzlgmQgiw0,10733
+omnata_plugin_runtime-0.1.97.dist-info/LICENSE,sha256=IMF9i4xIpgCADf0U-V1cuf9HBmqWQd3qtI3FSuyW4zE,26526
+omnata_plugin_runtime-0.1.97.dist-info/METADATA,sha256=XaD-UnfuV03ktHekYHHQr7URn75BcSaw_sVONMHh0lM,1086
+omnata_plugin_runtime-0.1.97.dist-info/WHEEL,sha256=d2fvjOD7sXsVzChCqf0Ty0JbHKBaLYwDbGQDwQTnJ50,88
+omnata_plugin_runtime-0.1.97.dist-info/RECORD,,

omnata_plugin_runtime-0.1.95.dist-info/RECORD

@@ -1,12 +0,0 @@
-omnata_plugin_runtime/__init__.py,sha256=w63LVME5nY-hQ4BBzfacy9kvTunwqHGs8iiSPGAX2ns,1214
-omnata_plugin_runtime/api.py,sha256=vCDTCxPZ5rIhi8aSM6Z0TXWHtGpbCoNvCnM3mKa-47Q,5591
-omnata_plugin_runtime/configuration.py,sha256=kYvHt_CYn_GZDwkjRVJMqGNbmcO0uEFgHz3B8Fi1JAc,30309
-omnata_plugin_runtime/forms.py,sha256=BVo7aQ5HUac-KoJ7gmsZFgGzByxPYslQ1iWw5CtAzZY,15770
-omnata_plugin_runtime/logging.py,sha256=ne1sLh5cBkjdRS54B30PGc5frABgjy0sF1_2RMcJ_Tk,3012
-omnata_plugin_runtime/omnata_plugin.py,sha256=x4Vvd1a8FNNiQNiURFuhp8s7FIuJgX03xR5d_iNTxK0,74287
-omnata_plugin_runtime/plugin_entrypoints.py,sha256=XS28q3IEQkvmNrMGMs90R_I48g5DmByIfsrSi1aeIzs,24170
-omnata_plugin_runtime/rate_limiting.py,sha256=OnFnCdMenpMpAZYumpe6mypRnMmDl1Q02vzlgmQgiw0,10733
-omnata_plugin_runtime-0.1.95.dist-info/LICENSE,sha256=IMF9i4xIpgCADf0U-V1cuf9HBmqWQd3qtI3FSuyW4zE,26526
-omnata_plugin_runtime-0.1.95.dist-info/METADATA,sha256=WgtNnDGExrpJ1NRZ-O20M8AmlC8DTaPCe74V4pEGb6I,1086
-omnata_plugin_runtime-0.1.95.dist-info/WHEEL,sha256=d2fvjOD7sXsVzChCqf0Ty0JbHKBaLYwDbGQDwQTnJ50,88
-omnata_plugin_runtime-0.1.95.dist-info/RECORD,,