Require concrete api-key strip normalization outputs

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

Author: cursoragent

hyperbrowser/client/base.py

@@ -40,7 +40,7 @@ def __init__(
                 raise HyperbrowserError("api_key must be a string")
             try:
                 normalized_resolved_api_key = resolved_api_key.strip()
-                if not isinstance(normalized_resolved_api_key, str):
+                if type(normalized_resolved_api_key) is not str:
                     raise TypeError("normalized api_key must be a string")
             except HyperbrowserError:
                 raise

hyperbrowser/config.py

@@ -36,7 +36,7 @@ def normalize_api_key(
             raise HyperbrowserError("api_key must be a string")
         try:
             normalized_api_key = api_key.strip()
-            if not isinstance(normalized_api_key, str):
+            if type(normalized_api_key) is not str:
                 raise TypeError("normalized api_key must be a string")
         except HyperbrowserError:
             raise

hyperbrowser/transport/base.py

@@ -69,7 +69,7 @@ def _normalize_transport_api_key(api_key: str) -> str:
 
     try:
         normalized_api_key = api_key.strip()
-        if not isinstance(normalized_api_key, str):
+        if type(normalized_api_key) is not str:
             raise TypeError("normalized api_key must be a string")
     except HyperbrowserError:
         raise

tests/test_client_api_key.py

@@ -240,11 +240,10 @@ def strip(self, chars=None):  # type: ignore[override]
 
 
 @pytest.mark.parametrize("client_class", [Hyperbrowser, AsyncHyperbrowser])
-def test_client_wraps_api_key_empty_check_length_failures(client_class):
+def test_client_wraps_api_key_string_subclass_strip_results(client_class):
     class _BrokenLengthApiKey(str):
         class _NormalizedKey(str):
-            def __len__(self):
-                raise RuntimeError("api key length exploded")
+            pass
 
         def strip(self, chars=None):  # type: ignore[override]
             _ = chars
@@ -253,23 +252,10 @@ def strip(self, chars=None):  # type: ignore[override]
     with pytest.raises(HyperbrowserError, match="Failed to normalize api_key") as exc_info:
         client_class(api_key=_BrokenLengthApiKey("test-key"))
 
-    assert isinstance(exc_info.value.original_error, RuntimeError)
+    assert isinstance(exc_info.value.original_error, TypeError)
 
 
 @pytest.mark.parametrize("client_class", [Hyperbrowser, AsyncHyperbrowser])
-def test_client_preserves_hyperbrowser_api_key_empty_check_length_failures(
-    client_class,
-):
-    class _BrokenLengthApiKey(str):
-        class _NormalizedKey(str):
-            def __len__(self):
-                raise HyperbrowserError("custom length failure")
-
-        def strip(self, chars=None):  # type: ignore[override]
-            _ = chars
-            return self._NormalizedKey("test-key")
-
-    with pytest.raises(HyperbrowserError, match="custom length failure") as exc_info:
-        client_class(api_key=_BrokenLengthApiKey("test-key"))
-
-    assert exc_info.value.original_error is None
+def test_client_rejects_blank_api_key_input(client_class):
+    with pytest.raises(HyperbrowserError, match="api_key must not be empty"):
+        client_class(api_key="   ")

tests/test_config.py

@@ -400,11 +400,10 @@ def strip(self, chars=None):  # type: ignore[override]
     assert isinstance(exc_info.value.original_error, TypeError)
 
 
-def test_client_config_wraps_api_key_empty_check_length_failures():
+def test_client_config_wraps_api_key_string_subclass_strip_results():
     class _BrokenApiKey(str):
         class _NormalizedKey(str):
-            def __len__(self):
-                raise RuntimeError("api key length exploded")
+            pass
 
         def strip(self, chars=None):  # type: ignore[override]
             _ = chars
@@ -413,55 +412,12 @@ def strip(self, chars=None):  # type: ignore[override]
     with pytest.raises(HyperbrowserError, match="Failed to normalize api_key") as exc_info:
         ClientConfig(api_key=_BrokenApiKey("test-key"))
 
-    assert isinstance(exc_info.value.original_error, RuntimeError)
-
-
-def test_client_config_preserves_hyperbrowser_api_key_empty_check_length_failures():
-    class _BrokenApiKey(str):
-        class _NormalizedKey(str):
-            def __len__(self):
-                raise HyperbrowserError("custom length failure")
-
-        def strip(self, chars=None):  # type: ignore[override]
-            _ = chars
-            return self._NormalizedKey("test-key")
-
-    with pytest.raises(HyperbrowserError, match="custom length failure") as exc_info:
-        ClientConfig(api_key=_BrokenApiKey("test-key"))
-
-    assert exc_info.value.original_error is None
-
-
-def test_client_config_wraps_api_key_iteration_runtime_errors():
-    class _BrokenApiKey(str):
-        def strip(self, chars=None):  # type: ignore[override]
-            _ = chars
-            return self
-
-        def __iter__(self):
-            raise RuntimeError("api key iteration exploded")
-
-    with pytest.raises(
-        HyperbrowserError, match="Failed to validate api_key characters"
-    ) as exc_info:
-        ClientConfig(api_key=_BrokenApiKey("test-key"))
-
-    assert isinstance(exc_info.value.original_error, RuntimeError)
-
-
-def test_client_config_preserves_hyperbrowser_api_key_iteration_errors():
-    class _BrokenApiKey(str):
-        def strip(self, chars=None):  # type: ignore[override]
-            _ = chars
-            return self
+    assert isinstance(exc_info.value.original_error, TypeError)
 
-        def __iter__(self):
-            raise HyperbrowserError("custom iteration failure")
 
-    with pytest.raises(HyperbrowserError, match="custom iteration failure") as exc_info:
-        ClientConfig(api_key=_BrokenApiKey("test-key"))
-
-    assert exc_info.value.original_error is None
+def test_client_config_rejects_blank_api_key_values():
+    with pytest.raises(HyperbrowserError, match="api_key must not be empty"):
+        ClientConfig(api_key="   ")
 
 
 def test_client_config_rejects_empty_or_invalid_base_url():

tests/test_transport_api_key.py

@@ -45,29 +45,10 @@ def strip(self, chars=None):  # type: ignore[override]
 
 
 @pytest.mark.parametrize("transport_class", [SyncTransport, AsyncTransport])
-def test_transport_wraps_api_key_character_iteration_failures(transport_class):
-    class _BrokenIterApiKey(str):
-        def strip(self, chars=None):  # type: ignore[override]
-            _ = chars
-            return self
-
-        def __iter__(self):
-            raise RuntimeError("api key iteration exploded")
-
-    with pytest.raises(
-        HyperbrowserError, match="Failed to validate api_key characters"
-    ) as exc_info:
-        transport_class(api_key=_BrokenIterApiKey("test-key"))
-
-    assert isinstance(exc_info.value.original_error, RuntimeError)
-
-
-@pytest.mark.parametrize("transport_class", [SyncTransport, AsyncTransport])
-def test_transport_wraps_api_key_empty_check_length_failures(transport_class):
+def test_transport_wraps_api_key_string_subclass_strip_results(transport_class):
     class _BrokenLengthApiKey(str):
         class _NormalizedKey(str):
-            def __len__(self):
-                raise RuntimeError("api key length exploded")
+            pass
 
         def strip(self, chars=None):  # type: ignore[override]
             _ = chars
@@ -76,41 +57,10 @@ def strip(self, chars=None):  # type: ignore[override]
     with pytest.raises(HyperbrowserError, match="Failed to normalize api_key") as exc_info:
         transport_class(api_key=_BrokenLengthApiKey("test-key"))
 
-    assert isinstance(exc_info.value.original_error, RuntimeError)
-
-
-@pytest.mark.parametrize("transport_class", [SyncTransport, AsyncTransport])
-def test_transport_preserves_hyperbrowser_api_key_empty_check_length_failures(
-    transport_class,
-):
-    class _BrokenLengthApiKey(str):
-        class _NormalizedKey(str):
-            def __len__(self):
-                raise HyperbrowserError("custom length failure")
-
-        def strip(self, chars=None):  # type: ignore[override]
-            _ = chars
-            return self._NormalizedKey("test-key")
-
-    with pytest.raises(HyperbrowserError, match="custom length failure") as exc_info:
-        transport_class(api_key=_BrokenLengthApiKey("test-key"))
-
-    assert exc_info.value.original_error is None
+    assert isinstance(exc_info.value.original_error, TypeError)
 
 
 @pytest.mark.parametrize("transport_class", [SyncTransport, AsyncTransport])
-def test_transport_preserves_hyperbrowser_api_key_character_iteration_failures(
-    transport_class,
-):
-    class _BrokenIterApiKey(str):
-        def strip(self, chars=None):  # type: ignore[override]
-            _ = chars
-            return self
-
-        def __iter__(self):
-            raise HyperbrowserError("custom iteration failure")
-
-    with pytest.raises(HyperbrowserError, match="custom iteration failure") as exc_info:
-        transport_class(api_key=_BrokenIterApiKey("test-key"))
-
-    assert exc_info.value.original_error is None
+def test_transport_rejects_blank_normalized_api_keys(transport_class):
+    with pytest.raises(HyperbrowserError, match="api_key must not be empty"):
+        transport_class(api_key="   ")