Enforce concrete key types in shared response parsers

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

Author: cursoragent

hyperbrowser/client/managers/extension_utils.py

@@ -125,7 +125,7 @@ def parse_extension_list_response_data(response_data: Any) -> List[ExtensionResp
                 original_error=exc,
             ) from exc
         for key in extension_keys:
-            if isinstance(key, str):
+            if type(key) is str:
                 continue
             raise HyperbrowserError(
                 f"Expected extension object keys to be strings at index {index}"

hyperbrowser/client/managers/response_utils.py

@@ -89,7 +89,7 @@ def parse_response_model(
             original_error=exc,
         ) from exc
     for key in response_keys:
-        if isinstance(key, str):
+        if type(key) is str:
             continue
         raise HyperbrowserError(
             f"Expected {normalized_operation_name} response object keys to be strings"

hyperbrowser/client/managers/session_utils.py

@@ -76,7 +76,7 @@ def parse_session_recordings_response_data(
                 original_error=exc,
             ) from exc
         for key in recording_keys:
-            if isinstance(key, str):
+            if type(key) is str:
                 continue
             raise HyperbrowserError(
                 f"Expected session recording object keys to be strings at index {index}"

hyperbrowser/transport/base.py

@@ -146,7 +146,7 @@ def from_json(
                 original_error=exc,
             ) from exc
         for key in response_keys:
-            if isinstance(key, str):
+            if type(key) is str:
                 continue
             key_type_name = type(key).__name__
             raise HyperbrowserError(

tests/test_extension_utils.py

@@ -321,6 +321,23 @@ def test_parse_extension_list_response_data_rejects_non_string_extension_keys():
         )
 
 
+def test_parse_extension_list_response_data_rejects_string_subclass_extension_keys():
+    class _Key(str):
+        pass
+
+    with pytest.raises(
+        HyperbrowserError,
+        match="Expected extension object keys to be strings at index 0",
+    ):
+        parse_extension_list_response_data(
+            {
+                "extensions": [
+                    {_Key("name"): "invalid-key-type"},
+                ]
+            }
+        )
+
+
 def test_parse_extension_list_response_data_wraps_extension_value_read_failures():
     class _BrokenValueLookupMapping(Mapping[str, object]):
         def __iter__(self) -> Iterator[str]:
@@ -367,7 +384,7 @@ def __getitem__(self, key: str) -> object:
     assert exc_info.value.original_error is not None
 
 
-def test_parse_extension_list_response_data_falls_back_for_unreadable_value_read_keys():
+def test_parse_extension_list_response_data_rejects_string_subclass_value_read_keys():
     class _BrokenKey(str):
         class _BrokenRenderedKey(str):
             def __iter__(self):
@@ -389,13 +406,13 @@ def __getitem__(self, key: str) -> object:
 
     with pytest.raises(
         HyperbrowserError,
-        match="Failed to read extension object value for key '<unprintable _BrokenKey>' at index 0",
+        match="Expected extension object keys to be strings at index 0",
     ) as exc_info:
         parse_extension_list_response_data(
             {"extensions": [_BrokenValueLookupMapping()]}
         )
 
-    assert exc_info.value.original_error is not None
+    assert exc_info.value.original_error is None
 
 
 def test_parse_extension_list_response_data_preserves_hyperbrowser_value_read_errors():

tests/test_response_utils.py

@@ -194,6 +194,21 @@ def test_parse_response_model_rejects_non_string_keys():
         )
 
 
+def test_parse_response_model_rejects_string_subclass_keys():
+    class _Key(str):
+        pass
+
+    with pytest.raises(
+        HyperbrowserError,
+        match="Expected basic operation response object keys to be strings",
+    ):
+        parse_response_model(
+            {_Key("success"): True},
+            model=BasicResponse,
+            operation_name="basic operation",
+        )
+
+
 def test_parse_response_model_sanitizes_operation_name_in_errors():
     with pytest.raises(
         HyperbrowserError,
@@ -303,7 +318,7 @@ def test_parse_response_model_truncates_operation_name_in_errors():
         )
 
 
-def test_parse_response_model_falls_back_for_unreadable_key_display():
+def test_parse_response_model_rejects_string_subclass_keys_before_value_reads():
     class _BrokenKey(str):
         def __iter__(self):
             raise RuntimeError("key iteration exploded")
@@ -321,15 +336,15 @@ def __getitem__(self, key: str) -> object:
 
     with pytest.raises(
         HyperbrowserError,
-        match="Failed to read basic operation response value for key '<unreadable key>'",
+        match="Expected basic operation response object keys to be strings",
     ) as exc_info:
         parse_response_model(
             _BrokenValueLookupMapping(),
             model=BasicResponse,
             operation_name="basic operation",
         )
 
-    assert isinstance(exc_info.value.original_error, RuntimeError)
+    assert exc_info.value.original_error is None
 
 
 def test_parse_response_model_wraps_mapping_read_failures():

tests/test_session_recording_utils.py

@@ -237,6 +237,21 @@ def test_parse_session_recordings_response_data_rejects_non_string_recording_key
         )
 
 
+def test_parse_session_recordings_response_data_rejects_string_subclass_recording_keys():
+    class _Key(str):
+        pass
+
+    with pytest.raises(
+        HyperbrowserError,
+        match="Expected session recording object keys to be strings at index 0",
+    ):
+        parse_session_recordings_response_data(
+            [
+                {_Key("type"): "bad-key"},
+            ]
+        )
+
+
 def test_parse_session_recordings_response_data_wraps_recording_value_read_failures():
     class _BrokenValueLookupMapping(Mapping[str, object]):
         def __iter__(self) -> Iterator[str]:
@@ -282,7 +297,7 @@ def __getitem__(self, key: str) -> object:
     assert exc_info.value.original_error is not None
 
 
-def test_parse_session_recordings_response_data_falls_back_for_unreadable_recording_keys():
+def test_parse_session_recordings_response_data_rejects_string_subclass_recording_keys_before_value_reads():
     class _BrokenKey(str):
         def __iter__(self):
             raise RuntimeError("cannot iterate recording key")
@@ -300,14 +315,11 @@ def __getitem__(self, key: str) -> object:
 
     with pytest.raises(
         HyperbrowserError,
-        match=(
-            "Failed to read session recording object value "
-            "for key '<unreadable key>' at index 0"
-        ),
+        match="Expected session recording object keys to be strings at index 0",
     ) as exc_info:
         parse_session_recordings_response_data([_BrokenValueLookupMapping()])
 
-    assert exc_info.value.original_error is not None
+    assert exc_info.value.original_error is None
 
 
 def test_parse_session_recordings_response_data_preserves_hyperbrowser_value_read_errors():

tests/test_transport_base.py

@@ -184,6 +184,23 @@ def test_api_response_from_json_rejects_non_string_mapping_keys() -> None:
         )
 
 
+def test_api_response_from_json_rejects_string_subclass_mapping_keys() -> None:
+    class _Key(str):
+        pass
+
+    with pytest.raises(
+        HyperbrowserError,
+        match=(
+            "Failed to parse response data for _SampleResponseModel: "
+            "expected string keys but received _Key"
+        ),
+    ):
+        APIResponse.from_json(
+            {_Key("name"): "job-1"},
+            _SampleResponseModel,
+        )
+
+
 def test_api_response_from_json_wraps_non_hyperbrowser_errors() -> None:
     with pytest.raises(
         HyperbrowserError,
@@ -298,14 +315,14 @@ def test_api_response_from_json_sanitizes_and_truncates_mapping_keys_in_errors()
         APIResponse.from_json(_BrokenLongKeyValueMapping(), _SampleResponseModel)
 
 
-def test_api_response_from_json_falls_back_for_unreadable_mapping_keys_in_errors() -> (
+def test_api_response_from_json_rejects_string_subclass_mapping_keys_before_value_reads() -> (
     None
 ):
     with pytest.raises(
         HyperbrowserError,
         match=(
             "Failed to parse response data for _SampleResponseModel: "
-            "unable to read value for key '<unreadable key>'"
+            "expected string keys but received _BrokenRenderedMappingKey"
         ),
     ):
         APIResponse.from_json(_BrokenRenderedKeyValueMapping(), _SampleResponseModel)