Merge pull request #370 from ASFHyP3/fix-non-asf-host-token

Do not update cookie domain for non-asf hosts when token is given

Author: jtherrmann

CHANGELOG.md

@@ -6,6 +6,11 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [PEP 440](https://www.python.org/dev/peps/pep-0440/)
 and uses [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [7.7.2]
+
+### Fixed
+* `HyP3.__init__` no longer attempts to update the domain of the `asf-urs` cookie for non-`.asf.alaska.edu` API URLs when the `token` parameter is given. Fixes https://github.com/ASFHyP3/hyp3-sdk/issues/369
+
 ## [7.7.1]
 
 ### Changed

src/hyp3_sdk/hyp3.py

@@ -70,7 +70,7 @@ def __init__(
 
         hostname = urlsplit(self.url).hostname
         assert hostname is not None
-        if not hostname.endswith('.asf.alaska.edu'):
+        if not hostname.endswith('.asf.alaska.edu') and 'asf-urs' in self.session.cookies:
             self.session.cookies.set('asf-urs', self.session.cookies['asf-urs'], domain=hostname)
 
     def _get_endpoint_url(self, endpoint: str) -> str:

tests/conftest.py

@@ -14,15 +14,20 @@
 @pytest.fixture(autouse=True)
 def get_mock_hyp3():
     def mock_get_authenticated_session(username, password, token):
-        session = requests.Session()
-        session.cookies.set('asf-urs', 'test-cookie', domain='.asf.alaska.edu')
-        return session
+        s = requests.Session()
 
-    def default_hyp3(api_url: str = 'https://dummy-api.asf.alaska.edu'):
+        if token is not None:
+            s.headers.update({'Authorization': f'Bearer {token}'})
+            return s
+
+        s.cookies.set('asf-urs', 'test-cookie', domain='.asf.alaska.edu')
+        return s
+
+    def mock_hyp3(api_url: str = 'https://dummy-api.asf.alaska.edu', token: str | None = None):
         with patch('hyp3_sdk.util.get_authenticated_session', mock_get_authenticated_session):
-            return HyP3(api_url=api_url)
+            return HyP3(api_url=api_url, token=token)
 
-    return default_hyp3
+    return mock_hyp3
 
 
 @pytest.fixture(autouse=True)

tests/test_hyp3.py

@@ -608,6 +608,11 @@ def test_update_cookie(get_mock_hyp3):
     assert api.session.cookies.get('asf-urs', domain='.asf.alaska.edu') == 'test-cookie'
     assert api.session.cookies.get('asf-urs', domain='foo.example.com') == 'test-cookie'
 
+    api = get_mock_hyp3(api_url='https://foo.example.com:8000/api', token='test-token')
+    assert api.session.headers['Authorization'] == 'Bearer test-token'
+    assert api.session.cookies.get('asf-urs', domain='.asf.alaska.edu') is None
+    assert api.session.cookies.get('asf-urs', domain='foo.example.com') is None
+
     api = get_mock_hyp3(api_url='https://foo.asf.alaska.edu:8000/api')
     assert api.session.cookies.get('asf-urs', domain='.asf.alaska.edu') == 'test-cookie'
     assert api.session.cookies.get('asf-urs', domain='foo.asf.alaska.edu') is None