fix(LAB-4118): add a warning log to inform the user he uses a deprecated field

Author: Sihem Tchabi

src/kili/core/graphql/graphql_client.py

@@ -4,6 +4,7 @@
 import os
 import threading
 import time
+import warnings
 from pathlib import Path
 from typing import Any, Optional, Union
 from urllib.parse import urlparse
@@ -322,20 +323,48 @@ def _raw_execute(
         log_context = LogContext()
         log_context.set_client_name(self.client_name)
         with _execute_lock:
-            res = self._gql_client.execute(
-                document=document,
-                variable_values=variables,
-                extra_args={
-                    "headers": {
-                        **(self._gql_transport.headers or {}),
-                        **log_context,
-                    }
-                },
-                **kwargs,
-            )
-            transport = self._gql_client.transport
-            if transport:
-                headers = transport.response_headers  # pyright: ignore[reportAttributeAccessIssue]
-                returned_complexity = int(headers.get("x-complexity", 0)) if headers else 0
-                self.complexity_consumed += returned_complexity
-            return res
+            with self._gql_client as session:
+                transport = session.transport
+                if transport is None:
+                    raise RuntimeError("GraphQL transport not initialized")
+
+                res = transport.execute(
+                    document=document,
+                    variable_values=variables,
+                    extra_args={
+                        "headers": {
+                            **(self._gql_transport.headers or {}),
+                            **log_context,
+                        }
+                    },
+                    **kwargs,
+                )
+
+                extensions = getattr(res, "extensions", None)
+                if isinstance(extensions, dict):
+                    for item in extensions.get("deprecations", []) or []:
+                        warnings.warn(
+                            f"[Kili SDK] Deprecated GraphQL field used: "
+                            f"{item.get('path')} – {item.get('reason')}"
+                        )
+
+                headers = getattr(transport, "response_headers", None)
+                if isinstance(headers, dict) and "x-complexity" in headers:
+                    try:
+                        self.complexity_consumed += int(headers["x-complexity"])
+                    except (TypeError, ValueError):
+                        pass
+
+                if isinstance(res, dict):
+                    return res
+
+                data = getattr(res, "data", None)
+                if data is None:
+                    raise kili.exceptions.GraphQLError(
+                        error="GraphQL response contains no data",
+                    )
+
+                if isinstance(data, dict) and "data" in data:
+                    return data
+
+                return {"data": data}

tests/integration/entrypoints/client/test_client.py

@@ -7,6 +7,7 @@
 import pytest
 import pytest_mock
 from filelock import FileLock
+from graphql import ExecutionResult
 
 from kili.adapters.kili_api_gateway.kili_api_gateway import KiliAPIGateway
 from kili.client import Kili
@@ -147,10 +148,11 @@ def test_complexity_increases_with_calls(
     mocker: pytest_mock.MockerFixture,
 ):
     graphql_mock = mocker.MagicMock()
-    graphql_mock.execute.return_value = {"data": 1}
-    graphql_mock.transport.response_headers = {"x-complexity": "125"}
+    graphql_mock.__enter__.return_value.transport.execute.return_value = ExecutionResult(
+        data={"data": 1}, extensions=None
+    )
+    graphql_mock.__enter__.return_value.transport.response_headers = {"x-complexity": "125"}
 
-    # Given
     mocker.patch("kili.client.is_api_key_valid", return_value=True)
     mocker.patch.object(ApiKeyUseCases, "check_expiry_of_key_is_close")
     mocker.patch(
@@ -172,8 +174,10 @@ def test_complexity_compatibility_with_legacy(
     mocker: pytest_mock.MockerFixture,
 ):
     graphql_mock = mocker.MagicMock()
-    graphql_mock.execute.return_value = {"data": 1}
-    graphql_mock.transport.response_headers = {}
+    graphql_mock.__enter__.return_value.transport.execute.return_value = ExecutionResult(
+        data={"data": 1}, extensions=None
+    )
+    graphql_mock.__enter__.return_value.transport.response_headers = {}
 
     # Given
     mocker.patch("kili.client.is_api_key_valid", return_value=True)

tests/unit/test_graphql_client.py

@@ -3,7 +3,6 @@
 
 import pytest
 import pytest_mock
-from gql import Client
 from gql.transport import exceptions
 from pyrate_limiter import Duration, Rate
 from pyrate_limiter.limiter import Limiter
@@ -88,9 +87,20 @@ def mock_execute(*args, **kwargs):
         nonlocal before_last_call_timestamp
         before_last_call_timestamp = last_call_timestamp
         last_call_timestamp = time()
+        return {"data": 1}
 
-    client._gql_client = mocker.MagicMock()
-    client._gql_client.execute.side_effect = mock_execute
+    transport_mock = mocker.MagicMock()
+    transport_mock.execute.side_effect = mock_execute
+    transport_mock.response_headers = {}
+
+    session_mock = mocker.MagicMock()
+    session_mock.transport = transport_mock
+
+    gql_client_mock = mocker.MagicMock()
+    gql_client_mock.__enter__.return_value = session_mock
+    gql_client_mock.__exit__.return_value = None
+
+    client._gql_client = gql_client_mock
 
     # first calls should not be rate limited
     for _ in range(MAX_CALLS_PER_MINUTE):
@@ -130,7 +140,15 @@ def mocked_backend_response(*args, **kwargs):
             extensions=None,
         )
 
-    mocked_execute = mocker.patch.object(Client, "execute", side_effect=mocked_backend_response)
+    transport_mock = mocker.MagicMock()
+    transport_mock.execute.side_effect = mocked_backend_response
+
+    session_mock = mocker.MagicMock()
+    session_mock.transport = transport_mock
+
+    gql_client_mock = mocker.MagicMock()
+    gql_client_mock.__enter__.return_value = session_mock
+    gql_client_mock.__exit__.return_value = None
 
     # Given
     client = GraphQLClient(
@@ -143,12 +161,13 @@ def mocked_backend_response(*args, **kwargs):
         enable_schema_caching=False,
     )
 
+    client._gql_client = gql_client_mock
     with pytest.raises(
         GraphQLError, match=r'Variable "(\$\w+)" of required type "(\w+!)" was not provided.'
     ):
         client.execute(query="fake_query")  # When
 
-    assert mocked_execute.call_count == nb_times_called == 1
+    assert nb_times_called == 1
 
 
 def test_given_gql_client_when_the_server_returns_flagsmith_error_then_it_retries(
@@ -207,7 +226,15 @@ def mocked_backend_response(*args, **kwargs):
             data={"data": None},
         )
 
-    mocked_execute = mocker.patch.object(Client, "execute", side_effect=mocked_backend_response)
+    transport_mock = mocker.MagicMock()
+    transport_mock.execute.side_effect = mocked_backend_response
+
+    session_mock = mocker.MagicMock()
+    session_mock.transport = transport_mock
+
+    gql_client_mock = mocker.MagicMock()
+    gql_client_mock.__enter__.return_value = session_mock
+    gql_client_mock.__exit__.return_value = None
 
     # Given
     client = GraphQLClient(
@@ -220,12 +247,13 @@ def mocked_backend_response(*args, **kwargs):
         enable_schema_caching=False,
     )
 
+    client._gql_client = gql_client_mock
     # When
     result = client.execute(query="fake_query")
 
     # Then
     assert result["data"] == "all good"
-    assert mocked_execute.call_count == nb_times_called == 3
+    assert nb_times_called == 3
 
 
 @pytest.mark.parametrize(