Merge pull request #690 from FlorentinD/check-aura-api-expiry

Warn about aura api endpoint expiration

Author: FlorentinD

graphdatascience/session/aura_api.py

@@ -3,6 +3,7 @@
 import logging
 import os
 import time
+import warnings
 from typing import Any, Dict, List, Optional, Tuple
 from urllib.parse import urlparse
 
@@ -65,7 +66,7 @@ def create_session(self, name: str, dbid: str, pwd: str, memory: SessionMemoryVa
             json={"name": name, "instance_id": dbid, "password": pwd, "memory": memory.value},
         )
 
-        self._check_code(response)
+        self._check_resp(response)
 
         return SessionDetails.fromJson(response.json())
 
@@ -77,7 +78,7 @@ def list_session(self, session_id: str, dbid: str) -> Optional[SessionDetails]:
         if response.status_code == 404:
             return None
 
-        self._check_code(response)
+        self._check_resp(response)
 
         return SessionDetails.fromJson(response.json())
 
@@ -86,7 +87,7 @@ def list_sessions(self, dbid: str) -> List[SessionDetails]:
             f"{self._base_uri}/v1beta5/data-science/sessions?instanceId={dbid}",
         )
 
-        self._check_code(response)
+        self._check_resp(response)
 
         return [SessionDetails.fromJson(s) for s in response.json()]
 
@@ -125,12 +126,13 @@ def delete_session(self, session_id: str, dbid: str) -> bool:
             json={"instance_id": dbid},
         )
 
+        self._check_endpoint_expiry(response)
+
         if response.status_code == 404:
             return False
         elif response.status_code == 202:
             return True
-
-        self._check_code(response)
+        self._check_endpoint_expiry(response)
 
         return False
 
@@ -151,7 +153,7 @@ def create_instance(
 
         response = self._request_session.post(f"{self._base_uri}/v1/instances", json=data)
 
-        self._check_code(response)
+        self._check_resp(response)
 
         return InstanceCreateDetails.from_json(response.json()["data"])
 
@@ -161,14 +163,14 @@ def delete_instance(self, instance_id: str) -> Optional[InstanceSpecificDetails]
         if response.status_code == 404:
             return None
 
-        self._check_code(response)
+        self._check_resp(response)
 
         return InstanceSpecificDetails.fromJson(response.json()["data"])
 
     def list_instances(self) -> List[InstanceDetails]:
         response = self._request_session.get(f"{self._base_uri}/v1/instances", params={"tenantId": self._tenant_id})
 
-        self._check_code(response)
+        self._check_resp(response)
 
         raw_data = response.json()["data"]
 
@@ -180,7 +182,7 @@ def list_instance(self, instance_id: str) -> Optional[InstanceSpecificDetails]:
         if response.status_code == 404:
             return None
 
-        self._check_code(response)
+        self._check_resp(response)
 
         raw_data = response.json()["data"]
 
@@ -221,13 +223,13 @@ def estimate_size(
         }
 
         response = self._request_session.post(f"{self._base_uri}/v1/instances/sizing", json=data)
-        self._check_code(response)
+        self._check_resp(response)
 
         return EstimationDetails.from_json(response.json()["data"])
 
     def _get_tenant_id(self) -> str:
         response = self._request_session.get(f"{self._base_uri}/v1/tenants")
-        self._check_code(response)
+        self._check_resp(response)
 
         raw_data = response.json()["data"]
 
@@ -242,17 +244,30 @@ def _get_tenant_id(self) -> str:
     def tenant_details(self) -> TenantDetails:
         if not self._tenant_details:
             response = self._request_session.get(f"{self._base_uri}/v1/tenants/{self._tenant_id}")
-            self._check_code(response)
+            self._check_resp(response)
             self._tenant_details = TenantDetails.from_json(response.json()["data"])
         return self._tenant_details
 
-    def _check_code(self, resp: requests.Response) -> None:
+    def _check_resp(self, resp: requests.Response) -> None:
+        self._check_status_code(resp)
+        self._check_endpoint_expiry(resp)
+
+    def _check_status_code(self, resp: requests.Response) -> None:
         if resp.status_code >= 400:
             raise AuraApiError(
                 f"Request for {resp.url} failed with status code {resp.status_code} - {resp.reason}: {resp.text}",
                 status_code=resp.status_code,
             )
 
+    def _check_endpoint_expiry(self, resp: requests.Response) -> None:
+        expiry_date = resp.headers.get("X-Tyk-Api-Expires")
+        if expiry_date:
+            warnings.warn(
+                f"The endpoint is deprecated and will be removed on {expiry_date}."
+                " Please update to a newer version of this client.",
+                DeprecationWarning,
+            )
+
     def _instance_type(self) -> str:
         return "enterprise-ds" if not self._dev_env else "professional-ds"
 

graphdatascience/tests/unit/test_aura_api.py

@@ -20,6 +20,13 @@
 from graphdatascience.session.session_sizes import SESSION_MEMORY_VALUE_UNKNOWN
 
 
+def mock_auth_token(requests_mock: Mocker) -> None:
+    requests_mock.post(
+        "https://api.neo4j.io/oauth/token",
+        json={"access_token": "very_short_token", "expires_in": 500, "token_type": "Bearer"},
+    )
+
+
 def test_create_session(requests_mock: Mocker) -> None:
     api = AuraApi(client_id="", client_secret="", tenant_id="some-tenant")
 
@@ -366,6 +373,20 @@ def test_create_instance(requests_mock: Mocker) -> None:
     assert requested_data["region"] == "leipzig-1"
 
 
+def test_warn_about_expirying_endpoint(requests_mock: Mocker) -> None:
+    api = AuraApi(client_id="", client_secret="", tenant_id="some-tenant")
+
+    mock_auth_token(requests_mock)
+    requests_mock.delete(
+        "https://api.neo4j.io/v1beta5/data-science/sessions/id0",
+        status_code=202,
+        headers={"X-Tyk-Api-Expires": "Mon, 03 Mar 2025 00:00:00 UTC"},
+    )
+
+    with pytest.warns(DeprecationWarning):
+        api.delete_session("id0", "dbid-1")
+
+
 def test_auth_token(requests_mock: Mocker) -> None:
     api = AuraApi(client_id="", client_secret="", tenant_id="some-tenant")
 
@@ -508,13 +529,6 @@ def test_list_missing_instance(requests_mock: Mocker) -> None:
     assert api.list_instance("id0") is None
 
 
-def mock_auth_token(requests_mock: Mocker) -> None:
-    requests_mock.post(
-        "https://api.neo4j.io/oauth/token",
-        json={"access_token": "very_short_token", "expires_in": 500, "token_type": "Bearer"},
-    )
-
-
 def test_dont_wait_forever(requests_mock: Mocker, caplog: LogCaptureFixture) -> None:
     mock_auth_token(requests_mock)
     requests_mock.get(