insightconnect-plugin-runtime 6.2.3__tar.gz → 6.2.4__tar.gz

{insightconnect_plugin_runtime-6.2.3/insightconnect_plugin_runtime.egg-info → insightconnect_plugin_runtime-6.2.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: insightconnect-plugin-runtime
-Version: 6.2.3
+Version: 6.2.4
 Summary: InsightConnect Plugin Runtime
 Home-page: https://github.com/rapid7/komand-plugin-sdk-python
 Author: Rapid7 Integrations Alliance
@@ -219,6 +219,7 @@ contributed. Black is installed as a test dependency and the hook can be initial
 after cloning this repository.
 
 ## Changelog
+* 6.2.4 - Update `make_request` helper to support extra parameter of `max_response_size` to cap the response
 * 6.2.3 - Updated dockerfiles for both `slim` and `full` SDK types to use Python 3.11.11 | Updated dependencies | Removed `pkg_resources` usage due to deprecation
 * 6.2.2 - Fix instances where logging errors would lead to duplicate entries being output | Add option to hash only on provided keys for `hash_sha1` function
 * 6.2.1 - Fix instances where logging would lead to duplicate entries being output

{insightconnect_plugin_runtime-6.2.3 → insightconnect_plugin_runtime-6.2.4}/README.md

@@ -182,6 +182,7 @@ contributed. Black is installed as a test dependency and the hook can be initial
 after cloning this repository.
 
 ## Changelog
+* 6.2.4 - Update `make_request` helper to support extra parameter of `max_response_size` to cap the response
 * 6.2.3 - Updated dockerfiles for both `slim` and `full` SDK types to use Python 3.11.11 | Updated dependencies | Removed `pkg_resources` usage due to deprecation
 * 6.2.2 - Fix instances where logging errors would lead to duplicate entries being output | Add option to hash only on provided keys for `hash_sha1` function
 * 6.2.1 - Fix instances where logging would lead to duplicate entries being output

{insightconnect_plugin_runtime-6.2.3 → insightconnect_plugin_runtime-6.2.4}/insightconnect_plugin_runtime/helper.py

@@ -21,6 +21,7 @@ from insightconnect_plugin_runtime.exceptions import (
     PluginException,
     HTTPStatusCodes,
     ResponseExceptionData,
+    APIException
 )
 
 CAMEL_CASE_REGEX = r"\b[a-z0-9]+([A-Z][a-z]+[0-9]*)*\b"
@@ -111,6 +112,7 @@ def make_request(
     exception_custom_configs: Dict[int, Exception] = {},
     exception_data_location: str = None,
     allowed_status_codes: List[str] = [],
+    max_response_size: int = None,
 ) -> Tuple[requests.Response, Dict]:
     """
     Makes a HTTP request while checking for RequestErrors and JSONDecodeErrors
@@ -133,6 +135,8 @@ def make_request(
     :type str:
     :param allowed_status_codes: Status codes that will not raise an exception.
     :type List[str]:
+    :param max_response_size: Raise an error if the stream content is bigger than this specified size
+    :type int:
 
     :return: The request response and the response JSON.
     :rtype: Tuple[Response, Dict]
@@ -148,6 +152,19 @@ def make_request(
                 cert=cert,
                 stream=stream,
             )
+
+            # Before we close this session check and download all content, check if the returned content is too large.
+            # This may not be supported on all APIs as they need to support streaming and return the content-length
+            # header but adding this extra check will be beneficial for memory usage to those that do support it.
+            if stream and max_response_size:
+                resp_size = response.headers.get("content-length", "0")
+                if int(resp_size) > max_response_size:
+                    raise APIException(
+                        status_code=400,
+                        cause=f"API response is exceeding allowed limit of {max_response_size} bytes.",
+                        assistance="Please update the parameters to reduce the size of the data being returned.",
+                        data=f"Content length returned was {resp_size} and max allowed is {max_response_size}",
+                    )
     except requests.exceptions.Timeout as exception:
         raise PluginException(
             preset=PluginException.Preset.TIMEOUT, data=str(exception)

{insightconnect_plugin_runtime-6.2.3 → insightconnect_plugin_runtime-6.2.4/insightconnect_plugin_runtime.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: insightconnect-plugin-runtime
-Version: 6.2.3
+Version: 6.2.4
 Summary: InsightConnect Plugin Runtime
 Home-page: https://github.com/rapid7/komand-plugin-sdk-python
 Author: Rapid7 Integrations Alliance
@@ -219,6 +219,7 @@ contributed. Black is installed as a test dependency and the hook can be initial
 after cloning this repository.
 
 ## Changelog
+* 6.2.4 - Update `make_request` helper to support extra parameter of `max_response_size` to cap the response
 * 6.2.3 - Updated dockerfiles for both `slim` and `full` SDK types to use Python 3.11.11 | Updated dependencies | Removed `pkg_resources` usage due to deprecation
 * 6.2.2 - Fix instances where logging errors would lead to duplicate entries being output | Add option to hash only on provided keys for `hash_sha1` function
 * 6.2.1 - Fix instances where logging would lead to duplicate entries being output

{insightconnect_plugin_runtime-6.2.3 → insightconnect_plugin_runtime-6.2.4}/setup.py

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

{insightconnect_plugin_runtime-6.2.3 → insightconnect_plugin_runtime-6.2.4}/tests/unit/test_helpers.py

@@ -4,6 +4,7 @@ from insightconnect_plugin_runtime.exceptions import (
     HTTPStatusCodes,
     ResponseExceptionData,
     PluginException,
+    APIException
 )
 import requests
 import os
@@ -378,16 +379,39 @@ class TestRequestsHelpers(TestCase):
             json={"sample": "value"},
             headers={"Content-Type": "application/json"},
         )
-        response = helper.make_request(_request=request)
+        response = helper.make_request(_request=request, stream=True, max_response_size=100)
         expected = {
             "json": {"example": "sample"},
             "status_code": 200,
             "content": b"example",
             "url": "https://example.com/success",
+            "content-length": "1",
         }
         self.assertEqual(response.content, expected.get("content"))
         self.assertEqual(response.status_code, expected.get("status_code"))
         self.assertEqual(response.url, expected.get("url"))
+        self.assertEqual(response.headers.get("content-length"), expected.get("content-length"))
+
+    @patch("requests.Session.send")
+    def test_make_request_enforces_max_response_size(self, mocked_request):
+        returned_max_size, test_max_size = "5000", 1527
+
+        response = requests.Response()
+        response.headers = {"content-length": returned_max_size, "content-type": "application/json"}
+        mocked_request.return_value = response
+
+        test_request = requests.Request(method="GET", url="https://event_source.com/api/v1/logs")
+
+        with self.assertRaises(APIException) as api_err:
+            helper.make_request(_request=test_request, stream=True, max_response_size=test_max_size)
+
+        self.assertEqual(400, api_err.exception.status_code)
+        exp_err_cause = f"API response is exceeding allowed limit of {test_max_size} bytes."
+        exp_err_data = f"Content length returned was {returned_max_size} and max allowed is {test_max_size}"
+        self.assertEqual(400, api_err.exception.status_code)
+        self.assertEqual(exp_err_cause, api_err.exception.cause)
+        self.assertEqual(exp_err_data, api_err.exception.data)
+
 
     @parameterized.expand(
         [

{insightconnect_plugin_runtime-6.2.3 → insightconnect_plugin_runtime-6.2.4}/tests/unit/utils.py

@@ -34,6 +34,7 @@ def get_mock_response(
     response._content = bytes_string
     response.url = url
     response.reason = reason
+    response.headers = {"content-length": "1", "content-type": "application/json"}
 
     def return_json():
         return data