gooddata-flight-server 1.40.1.dev2__py3-none-any.whl → 1.40.1.dev4__py3-none-any.whl

gooddata_flight_server/errors/error_info.py

@@ -1,13 +1,29 @@
 #  (C) 2024 GoodData Corporation
 import base64
 import traceback
-from typing import Callable, Optional, Union
+from typing import Callable, Optional, Union, cast
 
 import orjson
 import pyarrow.flight
 
 from gooddata_flight_server.errors.error_code import ErrorCode
 
+_ERROR_INFO_MAX_MSG = 256
+_ERROR_INFO_MAX_DETAIL = 512
+
+
+def _truncate_str_value(val: Optional[str], max_len: int) -> Optional[str]:
+    if val is None:
+        return None
+
+    if len(val) <= max_len:
+        return val
+
+    # no big deal that the actual max length is slightly exceeded
+    # all this truncating happens because ErrorInfo is eventually
+    # passed via gRPC headers which have 16k hard limit
+    return val[:max_len] + " [truncated]"
+
 
 class ErrorInfo:
     """
@@ -22,15 +38,15 @@ class ErrorInfo:
         body: Optional[bytes] = None,
         code: int = 0,
     ) -> None:
-        self._msg = msg
-        self._detail: Optional[str] = detail
+        self._msg = cast(str, _truncate_str_value(msg, _ERROR_INFO_MAX_MSG))
+        self._detail: Optional[str] = _truncate_str_value(detail, _ERROR_INFO_MAX_DETAIL)
         self._body: Optional[bytes] = body
         self._code: int = code
 
     @property
     def msg(self) -> str:
         """
-        :return: human readable error message
+        :return: human-readable error message
         """
         return self._msg
 
@@ -60,26 +76,36 @@ class ErrorInfo:
         """
         Updates error message.
 
-        :param msg: new message
+        :param msg: new message, up to 256 characters; will be truncated if the limit is exceeded
         :return: self, for call chaining sakes
         """
-        self._msg = msg
+        self._msg = cast(str, _truncate_str_value(msg, _ERROR_INFO_MAX_MSG))
+
         return self
 
     def with_detail(self, detail: Optional[str] = None) -> "ErrorInfo":
         """
         Updates or resets the error detail.
 
-        :param detail: detail to set; if None, the detail stored in the meta will be removed; default is None
+        :param detail: detail to set; if None, the detail stored in the meta will be removed; default is None;
+         detail can be up to 512 characters; will be truncated if the limit is exceeded
         :return: self, for call chaining sakes
         """
-        self._detail = detail
+        self._detail = _truncate_str_value(detail, _ERROR_INFO_MAX_DETAIL)
+
         return self
 
     def with_body(self, body: Optional[Union[bytes, str]]) -> "ErrorInfo":
         """
         Updates or resets the error body.
 
+        IMPORTANT: the ErrorInfo (and thus the contents of `body`) are passed out via FlightError.extra_info
+        property. The Flight RPC implementations pass the `extra_info` via gRPC headers. In turn, the gRPC headers
+        do have size limit. Keep this in mind when designing the value of `body`.
+
+        If you set body that is too large, you will run into problems like this:
+         https://github.com/grpc/grpc/issues/37852.
+
         :param body: body to set; if None, the body stored in the meta will be removed; default is None
         :return: self, for call chaining sakes
         """

{gooddata_flight_server-1.40.1.dev2.dist-info → gooddata_flight_server-1.40.1.dev4.dist-info}/METADATA

@@ -1,11 +1,11 @@
 Metadata-Version: 2.4
 Name: gooddata-flight-server
-Version: 1.40.1.dev2
+Version: 1.40.1.dev4
 Summary: Flight RPC server to host custom functions
 Author: GoodData
 Author-email: support@gooddata.com
 License: MIT
-Project-URL: Documentation, https://gooddata-flight-server.readthedocs.io/en/v1.40.1.dev2
+Project-URL: Documentation, https://gooddata-flight-server.readthedocs.io/en/v1.40.1.dev4
 Project-URL: Source, https://github.com/gooddata/gooddata-python-sdk
 Keywords: gooddata,flight,rpc,flight rpc,custom functions,analytics,headless,business,intelligence,headless-bi,cloud,native,semantic,layer,sql,metrics
 Classifier: Development Status :: 4 - Beta

{gooddata_flight_server-1.40.1.dev2.dist-info → gooddata_flight_server-1.40.1.dev4.dist-info}/RECORD

@@ -8,7 +8,7 @@ gooddata_flight_server/config/__init__.py,sha256=QL4TGz0QQfsNakkgMkve9k8wiR73dfo
 gooddata_flight_server/config/config.py,sha256=vMdBzGnBrxPCAsfJgpOxQKjxXl5xjEFNu32_4Bk5Qdw,17108
 gooddata_flight_server/errors/__init__.py,sha256=QL4TGz0QQfsNakkgMkve9k8wiR73dfoOF2_18ESSPRE,33
 gooddata_flight_server/errors/error_code.py,sha256=s7wcNlsGKG0PSPXNMBMQMekViZeaoJKWVboEL12kogE,5808
-gooddata_flight_server/errors/error_info.py,sha256=blpMWCABxSj5j4mLuL7PW4mXKmWBeywKNMLp70WAd44,17599
+gooddata_flight_server/errors/error_info.py,sha256=akYJk-QT0O2GQno__yc67YAxG5iBm-Fz4JDG2MQ6y4I,18852
 gooddata_flight_server/health/__init__.py,sha256=QL4TGz0QQfsNakkgMkve9k8wiR73dfoOF2_18ESSPRE,33
 gooddata_flight_server/health/health_check_http_server.py,sha256=A-wJ5L22s4PtJisNSOolrABp703w-0rhvDKKev_iN9I,3393
 gooddata_flight_server/health/server_health_monitor.py,sha256=vDe3Z5u5SPPG3RWGtrexzoJJ4HLFl7A38_hA6LfS71I,2690
@@ -41,9 +41,9 @@ gooddata_flight_server/utils/libc_utils.py,sha256=_ZwKeeB0lk2xh-gSC_7rc9felHu_hq
 gooddata_flight_server/utils/logging.py,sha256=3sip4Xte5YHjZNyQEQVo96rCsknxG1JPj7cIbnz0iBo,6081
 gooddata_flight_server/utils/methods_discovery.py,sha256=ZcBJU5dHBsnZD5zDXajE5merwCISfjHGcIlIWCQtNLY,3618
 gooddata_flight_server/utils/otel_tracing.py,sha256=MfKFh0TkVSUmPC6f8Oobp5XSCYxAsQyS0UaSJQF1nCw,4540
-gooddata_flight_server-1.40.1.dev2.data/scripts/gooddata-flight-server,sha256=cXl4cF_pNme_0ns-Dap825C_L-0ovWs9hmlNl7kN9kU,239
-gooddata_flight_server-1.40.1.dev2.dist-info/licenses/LICENSE.txt,sha256=o90MhGat28171lD8r77bLXsSnvDVu9CQAsWxAzx1Z2E,1064
-gooddata_flight_server-1.40.1.dev2.dist-info/METADATA,sha256=ADCGUg46gGlu66oX39QfmKKq0W9LxOq2TOfhaaiUAfs,30269
-gooddata_flight_server-1.40.1.dev2.dist-info/WHEEL,sha256=CmyFI0kx5cdEMTLiONQRbGQwjIoR1aIYB7eCAQ4KPJ0,91
-gooddata_flight_server-1.40.1.dev2.dist-info/top_level.txt,sha256=fkhUrPUK9CeUzu3qMaEXJbY-HVuY-sqUx8ct7AtZH0s,23
-gooddata_flight_server-1.40.1.dev2.dist-info/RECORD,,
+gooddata_flight_server-1.40.1.dev4.data/scripts/gooddata-flight-server,sha256=cXl4cF_pNme_0ns-Dap825C_L-0ovWs9hmlNl7kN9kU,239
+gooddata_flight_server-1.40.1.dev4.dist-info/licenses/LICENSE.txt,sha256=o90MhGat28171lD8r77bLXsSnvDVu9CQAsWxAzx1Z2E,1064
+gooddata_flight_server-1.40.1.dev4.dist-info/METADATA,sha256=PwM73ShpGNKInPXDVQWwsV0rbEVYJoApmXVt_87symE,30269
+gooddata_flight_server-1.40.1.dev4.dist-info/WHEEL,sha256=CmyFI0kx5cdEMTLiONQRbGQwjIoR1aIYB7eCAQ4KPJ0,91
+gooddata_flight_server-1.40.1.dev4.dist-info/top_level.txt,sha256=fkhUrPUK9CeUzu3qMaEXJbY-HVuY-sqUx8ct7AtZH0s,23
+gooddata_flight_server-1.40.1.dev4.dist-info/RECORD,,