insightconnect-plugin-runtime 6.3.1__tar.gz → 6.3.3__tar.gz

{insightconnect_plugin_runtime-6.3.1/insightconnect_plugin_runtime.egg-info → insightconnect_plugin_runtime-6.3.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: insightconnect-plugin-runtime
-Version: 6.3.1
+Version: 6.3.3
 Summary: InsightConnect Plugin Runtime
 Home-page: https://github.com/rapid7/komand-plugin-sdk-python
 Author: Rapid7 Integrations Alliance
@@ -224,6 +224,8 @@ contributed. Black is installed as a test dependency and the hook can be initial
 after cloning this repository.
 
 ## Changelog
+* 6.3.3 - Add helper func for tracing context to preserve parent span in threadpools
+* 6.3.2 - Raise `APIException` from within the `response_handler` to easily access the status code within the plugin
 * 6.3.1 - Improved filtering for `custom_config` parameters for plugin tasks
 * 6.3.0 - Add Tracing Instrumentation
 * 6.2.6 - Remove setuptools after installation

{insightconnect_plugin_runtime-6.3.1 → insightconnect_plugin_runtime-6.3.3}/README.md

@@ -182,6 +182,8 @@ contributed. Black is installed as a test dependency and the hook can be initial
 after cloning this repository.
 
 ## Changelog
+* 6.3.3 - Add helper func for tracing context to preserve parent span in threadpools
+* 6.3.2 - Raise `APIException` from within the `response_handler` to easily access the status code within the plugin
 * 6.3.1 - Improved filtering for `custom_config` parameters for plugin tasks
 * 6.3.0 - Add Tracing Instrumentation
 * 6.2.6 - Remove setuptools after installation

{insightconnect_plugin_runtime-6.3.1 → insightconnect_plugin_runtime-6.3.3}/insightconnect_plugin_runtime/helper.py

@@ -262,7 +262,10 @@ def response_handler(
 ) -> None:
     """
     Check response status codes and return a generic PluginException preset if a HTTPError is raised.
-    Excetion cause, assistance, and data can be overwritten by supplied parameters.
+    Exception cause, assistance, and data can be overwritten by supplied parameters.
+
+    When we receive a common status code that we typically handle in the plugin, we raise an APIException
+    so that the status_code attribute can be easily accessed and raised further up the chain.
 
     :param response: Response object whose status should be checked.
     :type Response:
@@ -304,7 +307,7 @@ def response_handler(
             if hasattr(exception, "data") and data is not None:
                 exception.data = data
         elif status_code_preset:
-            exception = PluginException(preset=status_code_preset)
+            exception = APIException(preset=status_code_preset, status_code=status_code)
             exception.data = data
 
         raise exception

{insightconnect_plugin_runtime-6.3.1 → insightconnect_plugin_runtime-6.3.3}/insightconnect_plugin_runtime/telemetry.py

@@ -1,7 +1,8 @@
-import functools
+import contextvars
+from functools import wraps, partial
 from typing import Any, Callable
-from flask.app import Flask
 
+from flask.app import Flask
 from opentelemetry import trace
 from opentelemetry.exporter.otlp.proto.http.trace_exporter import OTLPSpanExporter
 from opentelemetry.instrumentation.flask import FlaskInstrumentor
@@ -53,7 +54,7 @@ def auto_instrument(func: Callable) -> Callable:
     :return:
     """
 
-    @functools.wraps(func)
+    @wraps(func)
     def wrapper(*args, **kwargs):
         tracer = trace.get_tracer(__name__)
         with tracer.start_as_current_span(func.__name__):
@@ -71,3 +72,23 @@ def create_post_fork(app_getter: Callable, plugin_getter: Callable, config_gette
             init_tracing(app, plugin, endpoint)
 
     return post_fork
+
+
+def with_context(context: contextvars.Context, function: Callable) -> Callable:
+    """
+    Creates a wrapper function that executes the target function with the specified context.
+
+    :param context: The Context object to apply when executing the function
+    :type context: contextvars.Context
+
+    :param function: The function to wrap with the specified context
+    :type function: Callable
+
+    :return: A wrapper function that applies the context when called
+    :rtype: Callable
+    """
+
+    def _wrapper(context_: contextvars.Context, function_: Callable, *args, **kwargs):
+        return context_.copy().run(function_, *args, **kwargs)
+
+    return partial(_wrapper, context, function)

{insightconnect_plugin_runtime-6.3.1 → insightconnect_plugin_runtime-6.3.3/insightconnect_plugin_runtime.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: insightconnect-plugin-runtime
-Version: 6.3.1
+Version: 6.3.3
 Summary: InsightConnect Plugin Runtime
 Home-page: https://github.com/rapid7/komand-plugin-sdk-python
 Author: Rapid7 Integrations Alliance
@@ -224,6 +224,8 @@ contributed. Black is installed as a test dependency and the hook can be initial
 after cloning this repository.
 
 ## Changelog
+* 6.3.3 - Add helper func for tracing context to preserve parent span in threadpools
+* 6.3.2 - Raise `APIException` from within the `response_handler` to easily access the status code within the plugin
 * 6.3.1 - Improved filtering for `custom_config` parameters for plugin tasks
 * 6.3.0 - Add Tracing Instrumentation
 * 6.2.6 - Remove setuptools after installation

{insightconnect_plugin_runtime-6.3.1 → insightconnect_plugin_runtime-6.3.3}/setup.py

@@ -5,7 +5,7 @@ with open("README.md", "r") as fh:
 
 setup(
     name="insightconnect-plugin-runtime",
-    version="6.3.1",
+    version="6.3.3",
     description="InsightConnect Plugin Runtime",
     long_description=long_description,
     long_description_content_type="text/markdown",