Centralize safe path display formatting for file inputs

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

Author: cursoragent

hyperbrowser/client/file_utils.py

@@ -6,6 +6,40 @@
 from hyperbrowser.exceptions import HyperbrowserError
 from hyperbrowser.type_utils import is_plain_string
 
+_MAX_FILE_PATH_DISPLAY_LENGTH = 200
+
+
+def format_file_path_for_error(
+    file_path: object,
+    *,
+    max_length: int = _MAX_FILE_PATH_DISPLAY_LENGTH,
+) -> str:
+    try:
+        path_value = (
+            os.fspath(file_path)
+            if is_plain_string(file_path) or isinstance(file_path, PathLike)
+            else file_path
+        )
+    except Exception:
+        return "<provided path>"
+    if not is_plain_string(path_value):
+        return "<provided path>"
+    try:
+        sanitized_path = "".join(
+            "?" if ord(character) < 32 or ord(character) == 127 else character
+            for character in path_value
+        )
+    except Exception:
+        return "<provided path>"
+    if not is_plain_string(sanitized_path):
+        return "<provided path>"
+    if len(sanitized_path) <= max_length:
+        return sanitized_path
+    truncated_length = max_length - 3
+    if truncated_length <= 0:
+        return "..."
+    return f"{sanitized_path[:truncated_length]}..."
+
 
 def _normalize_file_path_text(file_path: Union[str, PathLike[str]]) -> str:
     try:

hyperbrowser/client/managers/extension_create_utils.py

@@ -3,7 +3,7 @@
 from hyperbrowser.exceptions import HyperbrowserError
 from hyperbrowser.models.extension import CreateExtensionParams
 
-from ..file_utils import ensure_existing_file_path
+from ..file_utils import ensure_existing_file_path, format_file_path_for_error
 from .serialization_utils import serialize_model_dump_to_dict
 
 
@@ -26,9 +26,10 @@ def normalize_extension_create_input(params: Any) -> Tuple[str, Dict[str, Any]]:
     )
     payload.pop("filePath", None)
 
+    file_path_display = format_file_path_for_error(raw_file_path)
     file_path = ensure_existing_file_path(
         raw_file_path,
-        missing_file_message=f"Extension file not found at path: {raw_file_path}",
-        not_file_message=f"Extension file path must point to a file: {raw_file_path}",
+        missing_file_message=f"Extension file not found at path: {file_path_display}",
+        not_file_message=f"Extension file path must point to a file: {file_path_display}",
     )
     return file_path, payload

hyperbrowser/client/managers/session_upload_utils.py

@@ -6,26 +6,11 @@
 from hyperbrowser.exceptions import HyperbrowserError
 from hyperbrowser.type_utils import is_plain_string, is_string_subclass_instance
 
-from ..file_utils import ensure_existing_file_path, open_binary_file
-
-_MAX_FILE_PATH_DISPLAY_LENGTH = 200
-
-
-def _format_upload_path_for_error(raw_file_path: object) -> str:
-    if not is_plain_string(raw_file_path):
-        return "<provided path>"
-    try:
-        normalized_path = "".join(
-            "?" if ord(character) < 32 or ord(character) == 127 else character
-            for character in raw_file_path
-        )
-    except Exception:
-        return "<provided path>"
-    if not is_plain_string(normalized_path):
-        return "<provided path>"
-    if len(normalized_path) <= _MAX_FILE_PATH_DISPLAY_LENGTH:
-        return normalized_path
-    return f"{normalized_path[:_MAX_FILE_PATH_DISPLAY_LENGTH]}..."
+from ..file_utils import (
+    ensure_existing_file_path,
+    format_file_path_for_error,
+    open_binary_file,
+)
 
 
 def normalize_upload_file_input(
@@ -41,7 +26,7 @@ def normalize_upload_file_input(
                 "file_input path is invalid",
                 original_error=exc,
             ) from exc
-        file_path_display = _format_upload_path_for_error(raw_file_path)
+        file_path_display = format_file_path_for_error(raw_file_path)
         file_path = ensure_existing_file_path(
             raw_file_path,
             missing_file_message=f"Upload file not found at path: {file_path_display}",

tests/test_extension_create_utils.py

@@ -115,3 +115,18 @@ def test_normalize_extension_create_input_rejects_missing_file(tmp_path):
 
     with pytest.raises(HyperbrowserError, match="Extension file not found"):
         normalize_extension_create_input(params)
+
+
+def test_normalize_extension_create_input_rejects_control_character_path():
+    params = CreateExtensionParams(
+        name="bad-extension",
+        file_path="bad\tpath.zip",
+    )
+
+    with pytest.raises(
+        HyperbrowserError,
+        match="file_path must not contain control characters",
+    ) as exc_info:
+        normalize_extension_create_input(params)
+
+    assert exc_info.value.original_error is None

tests/test_file_utils.py

@@ -3,7 +3,11 @@
 import pytest
 
 import hyperbrowser.client.file_utils as file_utils
-from hyperbrowser.client.file_utils import ensure_existing_file_path, open_binary_file
+from hyperbrowser.client.file_utils import (
+    ensure_existing_file_path,
+    format_file_path_for_error,
+    open_binary_file,
+)
 from hyperbrowser.exceptions import HyperbrowserError
 
 
@@ -266,6 +270,38 @@ def test_ensure_existing_file_path_rejects_control_character_paths():
         )
 
 
+def test_format_file_path_for_error_sanitizes_control_characters():
+    display_path = format_file_path_for_error("bad\tpath\nvalue")
+
+    assert display_path == "bad?path?value"
+
+
+def test_format_file_path_for_error_truncates_long_paths():
+    display_path = format_file_path_for_error("abcdef", max_length=5)
+
+    assert display_path == "ab..."
+
+
+def test_format_file_path_for_error_falls_back_for_non_string_values():
+    assert format_file_path_for_error(object()) == "<provided path>"
+
+
+def test_format_file_path_for_error_falls_back_for_fspath_failures():
+    class _BrokenPathLike:
+        def __fspath__(self) -> str:
+            raise RuntimeError("bad fspath")
+
+    assert format_file_path_for_error(_BrokenPathLike()) == "<provided path>"
+
+
+def test_format_file_path_for_error_uses_pathlike_string_values():
+    class _PathLike:
+        def __fspath__(self) -> str:
+            return "/tmp/path-value"
+
+    assert format_file_path_for_error(_PathLike()) == "/tmp/path-value"
+
+
 def test_ensure_existing_file_path_wraps_invalid_path_os_errors(monkeypatch):
     def raising_exists(path: str) -> bool:
         raise OSError("invalid path")