Extract shared display text normalization utility

Co-authored-by: Shri Sukhani <shrisukhani@users.noreply.github.com>

Author: cursoragent

hyperbrowser/client/managers/response_utils.py

@@ -1,55 +1,32 @@
 from typing import Any, Type, TypeVar
 
+from hyperbrowser.display_utils import normalize_display_text
 from hyperbrowser.exceptions import HyperbrowserError
 from hyperbrowser.mapping_utils import read_string_key_mapping
 
 T = TypeVar("T")
 _MAX_OPERATION_NAME_DISPLAY_LENGTH = 120
-_TRUNCATED_OPERATION_NAME_SUFFIX = "... (truncated)"
 _MAX_KEY_DISPLAY_LENGTH = 120
-_TRUNCATED_KEY_DISPLAY_SUFFIX = "... (truncated)"
 
 
 def _normalize_operation_name_for_error(operation_name: str) -> str:
-    try:
-        normalized_name = "".join(
-            "?" if ord(character) < 32 or ord(character) == 127 else character
-            for character in operation_name
-        ).strip()
-        if type(normalized_name) is not str:
-            raise TypeError("normalized operation name must be a string")
-    except Exception:
-        return "operation"
+    normalized_name = normalize_display_text(
+        operation_name,
+        max_length=_MAX_OPERATION_NAME_DISPLAY_LENGTH,
+    )
     if not normalized_name:
         return "operation"
-    if len(normalized_name) <= _MAX_OPERATION_NAME_DISPLAY_LENGTH:
-        return normalized_name
-    available_length = _MAX_OPERATION_NAME_DISPLAY_LENGTH - len(
-        _TRUNCATED_OPERATION_NAME_SUFFIX
-    )
-    if available_length <= 0:
-        return _TRUNCATED_OPERATION_NAME_SUFFIX
-    return f"{normalized_name[:available_length]}{_TRUNCATED_OPERATION_NAME_SUFFIX}"
+    return normalized_name
 
 
 def _normalize_response_key_for_error(key: str) -> str:
-    try:
-        normalized_key = "".join(
-            "?" if ord(character) < 32 or ord(character) == 127 else character
-            for character in key
-        ).strip()
-        if type(normalized_key) is not str:
-            raise TypeError("normalized response key must be a string")
-    except Exception:
-        return "<unreadable key>"
+    normalized_key = normalize_display_text(
+        key,
+        max_length=_MAX_KEY_DISPLAY_LENGTH,
+    )
     if not normalized_key:
         return "<blank key>"
-    if len(normalized_key) <= _MAX_KEY_DISPLAY_LENGTH:
-        return normalized_key
-    available_length = _MAX_KEY_DISPLAY_LENGTH - len(_TRUNCATED_KEY_DISPLAY_SUFFIX)
-    if available_length <= 0:
-        return _TRUNCATED_KEY_DISPLAY_SUFFIX
-    return f"{normalized_key[:available_length]}{_TRUNCATED_KEY_DISPLAY_SUFFIX}"
+    return normalized_key
 
 
 def parse_response_model(

hyperbrowser/display_utils.py

@@ -0,0 +1,21 @@
+_TRUNCATED_DISPLAY_SUFFIX = "... (truncated)"
+
+
+def normalize_display_text(value: str, *, max_length: int) -> str:
+    try:
+        sanitized_value = "".join(
+            "?" if ord(character) < 32 or ord(character) == 127 else character
+            for character in value
+        ).strip()
+        if type(sanitized_value) is not str:
+            return ""
+        if not sanitized_value:
+            return ""
+        if len(sanitized_value) <= max_length:
+            return sanitized_value
+        available_length = max_length - len(_TRUNCATED_DISPLAY_SUFFIX)
+        if available_length <= 0:
+            return _TRUNCATED_DISPLAY_SUFFIX
+        return f"{sanitized_value[:available_length]}{_TRUNCATED_DISPLAY_SUFFIX}"
+    except Exception:
+        return ""

hyperbrowser/transport/base.py

@@ -1,37 +1,17 @@
 from abc import ABC, abstractmethod
 from typing import Generic, Mapping, Optional, Type, TypeVar, Union
 
+from hyperbrowser.display_utils import normalize_display_text
 from hyperbrowser.exceptions import HyperbrowserError
 from hyperbrowser.mapping_utils import read_string_key_mapping
 
 T = TypeVar("T")
-_TRUNCATED_DISPLAY_SUFFIX = "... (truncated)"
 _MAX_MODEL_NAME_DISPLAY_LENGTH = 120
 _MAX_MAPPING_KEY_DISPLAY_LENGTH = 120
 _MIN_HTTP_STATUS_CODE = 100
 _MAX_HTTP_STATUS_CODE = 599
 
 
-def _sanitize_display_text(value: str, *, max_length: int) -> str:
-    try:
-        sanitized_value = "".join(
-            "?" if ord(character) < 32 or ord(character) == 127 else character
-            for character in value
-        ).strip()
-        if type(sanitized_value) is not str:
-            return ""
-        if not sanitized_value:
-            return ""
-        if len(sanitized_value) <= max_length:
-            return sanitized_value
-        available_length = max_length - len(_TRUNCATED_DISPLAY_SUFFIX)
-        if available_length <= 0:
-            return _TRUNCATED_DISPLAY_SUFFIX
-        return f"{sanitized_value[:available_length]}{_TRUNCATED_DISPLAY_SUFFIX}"
-    except Exception:
-        return ""
-
-
 def _safe_model_name(model: object) -> str:
     try:
         model_name = getattr(model, "__name__", "response model")
@@ -40,7 +20,7 @@ def _safe_model_name(model: object) -> str:
     if type(model_name) is not str:
         return "response model"
     try:
-        normalized_model_name = _sanitize_display_text(
+        normalized_model_name = normalize_display_text(
             model_name, max_length=_MAX_MODEL_NAME_DISPLAY_LENGTH
         )
     except Exception:
@@ -51,7 +31,7 @@ def _safe_model_name(model: object) -> str:
 
 
 def _format_mapping_key_for_error(key: str) -> str:
-    normalized_key = _sanitize_display_text(
+    normalized_key = normalize_display_text(
         key, max_length=_MAX_MAPPING_KEY_DISPLAY_LENGTH
     )
     if normalized_key:

tests/test_display_utils.py

@@ -0,0 +1,30 @@
+from hyperbrowser.display_utils import normalize_display_text
+
+
+def test_normalize_display_text_keeps_valid_input():
+    assert normalize_display_text("hello", max_length=20) == "hello"
+
+
+def test_normalize_display_text_replaces_control_characters_and_trims():
+    assert (
+        normalize_display_text(" \nhello\tworld\r ", max_length=50)
+        == "?hello?world?"
+    )
+
+
+def test_normalize_display_text_truncates_long_values():
+    assert (
+        normalize_display_text("abcdefghij", max_length=7) == "... (truncated)"
+    )
+
+
+def test_normalize_display_text_returns_empty_for_unreadable_inputs():
+    class _BrokenString(str):
+        def __iter__(self):  # type: ignore[override]
+            raise RuntimeError("cannot iterate")
+
+    assert normalize_display_text(_BrokenString("value"), max_length=20) == ""
+
+
+def test_normalize_display_text_returns_empty_for_non_string_inputs():
+    assert normalize_display_text(123, max_length=20) == ""  # type: ignore[arg-type]