Merge pull request #85 from fnareoh/garancegourdel/scrt-3925-fix-ggshield-creating-too-large-payloads

feat(metadata): add general server payload maximum to secret scan preferences

Author: agateau-gg

changelog.d/20240110_095013_fnareoh_scrt_3925_fix_ggshield_creating_too_large_payloads.md

@@ -0,0 +1,3 @@
+### Added
+
+- Added maximum payload size as a property of GGClient

pygitguardian/client.py

@@ -12,7 +12,12 @@
 import requests
 from requests import Response, Session, codes
 
-from .config import DEFAULT_API_VERSION, DEFAULT_BASE_URI, DEFAULT_TIMEOUT
+from .config import (
+    DEFAULT_API_VERSION,
+    DEFAULT_BASE_URI,
+    DEFAULT_TIMEOUT,
+    MAXIMUM_PAYLOAD_SIZE,
+)
 from .iac_models import (
     IaCDiffScanResult,
     IaCScanParameters,
@@ -206,6 +211,7 @@ def __init__(
                 "Authorization": f"Token {api_key}",
             },
         )
+        self.maximum_payload_size = MAXIMUM_PAYLOAD_SIZE
         self.secret_scan_preferences = SecretScanPreferences()
 
     def request(
@@ -617,7 +623,9 @@ def read_metadata(self) -> Optional[Detail]:
             result.status_code = resp.status_code
             return result
         metadata = ServerMetadata.from_dict(resp.json())
-
+        self.maximum_payload_size = metadata.preferences.get(
+            "general__maximum_payload_size", MAXIMUM_PAYLOAD_SIZE
+        )
         self.secret_scan_preferences = metadata.secret_scan_preferences
         return None
 

pygitguardian/config.py

@@ -4,3 +4,4 @@
 
 MULTI_DOCUMENT_LIMIT = 20
 DOCUMENT_SIZE_THRESHOLD_BYTES = 1048576  # 1MB
+MAXIMUM_PAYLOAD_SIZE = 2621440  # 25MB