Centralize file-path missing/not-file message formatting

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

Author: cursoragent

hyperbrowser/client/file_utils.py

@@ -10,6 +10,34 @@
 _DEFAULT_OPEN_ERROR_MESSAGE_PREFIX = "Failed to open file at path"
 
 
+def _normalize_error_prefix(prefix: object, *, default_prefix: str) -> str:
+    normalized_default_prefix = default_prefix
+    if not is_plain_string(normalized_default_prefix):
+        normalized_default_prefix = _DEFAULT_OPEN_ERROR_MESSAGE_PREFIX
+    else:
+        try:
+            stripped_default_prefix = normalized_default_prefix.strip()
+        except Exception:
+            stripped_default_prefix = _DEFAULT_OPEN_ERROR_MESSAGE_PREFIX
+        if not is_plain_string(stripped_default_prefix) or not stripped_default_prefix:
+            normalized_default_prefix = _DEFAULT_OPEN_ERROR_MESSAGE_PREFIX
+        else:
+            normalized_default_prefix = stripped_default_prefix
+    if not is_plain_string(prefix):
+        return normalized_default_prefix
+    try:
+        sanitized_prefix = "".join(
+            "?" if ord(character) < 32 or ord(character) == 127 else character
+            for character in prefix
+        )
+        stripped_prefix = sanitized_prefix.strip()
+    except Exception:
+        stripped_prefix = normalized_default_prefix
+    if not is_plain_string(stripped_prefix) or not stripped_prefix:
+        return normalized_default_prefix
+    return stripped_prefix
+
+
 def format_file_path_for_error(
     file_path: object,
     *,
@@ -44,27 +72,25 @@ def format_file_path_for_error(
     return f"{sanitized_path[:truncated_length]}..."
 
 
-def build_open_file_error_message(file_path: object, *, prefix: str) -> str:
-    normalized_prefix = prefix
-    if not is_plain_string(normalized_prefix):
-        normalized_prefix = _DEFAULT_OPEN_ERROR_MESSAGE_PREFIX
-    else:
-        try:
-            sanitized_prefix = "".join(
-                "?" if ord(character) < 32 or ord(character) == 127 else character
-                for character in normalized_prefix
-            )
-            stripped_prefix = sanitized_prefix.strip()
-        except Exception:
-            stripped_prefix = _DEFAULT_OPEN_ERROR_MESSAGE_PREFIX
-        if not is_plain_string(stripped_prefix) or not stripped_prefix:
-            normalized_prefix = _DEFAULT_OPEN_ERROR_MESSAGE_PREFIX
-        else:
-            normalized_prefix = stripped_prefix
+def build_file_path_error_message(
+    file_path: object,
+    *,
+    prefix: str,
+    default_prefix: str,
+) -> str:
+    normalized_prefix = _normalize_error_prefix(prefix, default_prefix=default_prefix)
     file_path_display = format_file_path_for_error(file_path)
     return f"{normalized_prefix}: {file_path_display}"
 
 
+def build_open_file_error_message(file_path: object, *, prefix: str) -> str:
+    return build_file_path_error_message(
+        file_path,
+        prefix=prefix,
+        default_prefix=_DEFAULT_OPEN_ERROR_MESSAGE_PREFIX,
+    )
+
+
 def _normalize_file_path_text(file_path: Union[str, PathLike[str]]) -> str:
     try:
         normalized_path = os.fspath(file_path)

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, format_file_path_for_error
+from ..file_utils import build_file_path_error_message, ensure_existing_file_path
 from .serialization_utils import serialize_model_dump_to_dict
 
 
@@ -26,10 +26,17 @@ 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: {file_path_display}",
-        not_file_message=f"Extension file path must point to a file: {file_path_display}",
+        missing_file_message=build_file_path_error_message(
+            raw_file_path,
+            prefix="Extension file not found at path",
+            default_prefix="Extension file not found at path",
+        ),
+        not_file_message=build_file_path_error_message(
+            raw_file_path,
+            prefix="Extension file path must point to a file",
+            default_prefix="Extension file path must point to a file",
+        ),
     )
     return file_path, payload

hyperbrowser/client/managers/session_upload_utils.py

@@ -7,9 +7,9 @@
 from hyperbrowser.type_utils import is_plain_string, is_string_subclass_instance
 
 from ..file_utils import (
+    build_file_path_error_message,
     build_open_file_error_message,
     ensure_existing_file_path,
-    format_file_path_for_error,
     open_binary_file,
 )
 
@@ -27,11 +27,18 @@ def normalize_upload_file_input(
                 "file_input path is invalid",
                 original_error=exc,
             ) from exc
-        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}",
-            not_file_message=f"Upload file path must point to a file: {file_path_display}",
+            missing_file_message=build_file_path_error_message(
+                raw_file_path,
+                prefix="Upload file not found at path",
+                default_prefix="Upload file not found at path",
+            ),
+            not_file_message=build_file_path_error_message(
+                raw_file_path,
+                prefix="Upload file path must point to a file",
+                default_prefix="Upload file path must point to a file",
+            ),
         )
         return file_path, None
 

tests/test_file_path_display_helper_import_boundary.py

@@ -6,34 +6,34 @@
 pytestmark = pytest.mark.architecture
 
 
-EXPECTED_FORMAT_FILE_PATH_IMPORTERS = (
+EXPECTED_FILE_PATH_ERROR_MESSAGE_IMPORTERS = (
     "hyperbrowser/client/managers/extension_create_utils.py",
     "hyperbrowser/client/managers/session_upload_utils.py",
     "tests/test_file_utils.py",
 )
 
 
-def _imports_format_file_path_for_error(module_text: str) -> bool:
+def _imports_build_file_path_error_message(module_text: str) -> bool:
     module_ast = ast.parse(module_text)
     for node in module_ast.body:
         if not isinstance(node, ast.ImportFrom):
             continue
-        if any(alias.name == "format_file_path_for_error" for alias in node.names):
+        if any(alias.name == "build_file_path_error_message" for alias in node.names):
             return True
     return False
 
 
-def test_format_file_path_for_error_imports_are_centralized():
+def test_build_file_path_error_message_imports_are_centralized():
     discovered_modules: list[str] = []
 
     for module_path in sorted(Path("hyperbrowser").rglob("*.py")):
         module_text = module_path.read_text(encoding="utf-8")
-        if _imports_format_file_path_for_error(module_text):
+        if _imports_build_file_path_error_message(module_text):
             discovered_modules.append(module_path.as_posix())
 
     for module_path in sorted(Path("tests").glob("test_*.py")):
         module_text = module_path.read_text(encoding="utf-8")
-        if _imports_format_file_path_for_error(module_text):
+        if _imports_build_file_path_error_message(module_text):
             discovered_modules.append(module_path.as_posix())
 
-    assert discovered_modules == list(EXPECTED_FORMAT_FILE_PATH_IMPORTERS)
+    assert discovered_modules == list(EXPECTED_FILE_PATH_ERROR_MESSAGE_IMPORTERS)

tests/test_file_path_display_helper_usage.py

@@ -14,5 +14,6 @@
 def test_file_path_error_messages_use_shared_display_helper():
     for module_path in FILE_PATH_DISPLAY_MODULES:
         module_text = Path(module_path).read_text(encoding="utf-8")
-        assert "format_file_path_for_error(" in module_text
+        assert "build_file_path_error_message(" in module_text
+        assert "format_file_path_for_error(" not in module_text
         assert "ord(character) < 32" not in module_text

tests/test_file_utils.py

@@ -4,6 +4,7 @@
 
 import hyperbrowser.client.file_utils as file_utils
 from hyperbrowser.client.file_utils import (
+    build_file_path_error_message,
     build_open_file_error_message,
     ensure_existing_file_path,
     format_file_path_for_error,
@@ -331,6 +332,36 @@ def test_build_open_file_error_message_uses_prefix_and_sanitized_path():
     assert message == "Failed to open upload file at path: bad?path.txt"
 
 
+def test_build_file_path_error_message_uses_prefix_and_sanitized_path():
+    message = build_file_path_error_message(
+        "bad\tpath.txt",
+        prefix="Upload file not found at path",
+        default_prefix="Upload file not found at path",
+    )
+
+    assert message == "Upload file not found at path: bad?path.txt"
+
+
+def test_build_file_path_error_message_uses_default_for_non_string_prefix():
+    message = build_file_path_error_message(
+        "/tmp/path.txt",
+        prefix=123,  # type: ignore[arg-type]
+        default_prefix="Upload file not found at path",
+    )
+
+    assert message == "Upload file not found at path: /tmp/path.txt"
+
+
+def test_build_file_path_error_message_uses_open_default_when_default_prefix_invalid():
+    message = build_file_path_error_message(
+        "/tmp/path.txt",
+        prefix=123,  # type: ignore[arg-type]
+        default_prefix="   ",
+    )
+
+    assert message == "Failed to open file at path: /tmp/path.txt"
+
+
 def test_build_open_file_error_message_uses_default_prefix_for_non_string():
     message = build_open_file_error_message(
         "/tmp/path.txt",