Merge pull request #2000 from kili-technology/feature/lab-4118-aau-when-i-use-the-sdk-and-it-calls-a-graphql-deprecated

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

Author: stchabi

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
@@ -325,6 +326,7 @@ def _raw_execute(
             res = self._gql_client.execute(
                 document=document,
                 variable_values=variables,
+                get_execution_result=True,
                 extra_args={
                     "headers": {
                         **(self._gql_transport.headers or {}),
@@ -333,9 +335,24 @@ def _raw_execute(
                 },
                 **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')}"
+                    )
+
             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
+
+            if res.data is None:
+                raise kili.exceptions.GraphQLError(
+                    error="GraphQL response contains no data",
+                )
+
+            return res.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,7 +148,10 @@ def test_complexity_increases_with_calls(
     mocker: pytest_mock.MockerFixture,
 ):
     graphql_mock = mocker.MagicMock()
-    graphql_mock.execute.return_value = {"data": 1}
+    graphql_mock.execute.return_value = ExecutionResult(
+        data={"data": 1},
+        extensions=None,
+    )
     graphql_mock.transport.response_headers = {"x-complexity": "125"}
 
     # Given
@@ -172,7 +176,10 @@ def test_complexity_compatibility_with_legacy(
     mocker: pytest_mock.MockerFixture,
 ):
     graphql_mock = mocker.MagicMock()
-    graphql_mock.execute.return_value = {"data": 1}
+    graphql_mock.execute.return_value = ExecutionResult(
+        data={"data": 1},
+        extensions=None,
+    )
     graphql_mock.transport.response_headers = {}
 
     # Given

tests/unit/test_graphql_client.py

@@ -5,6 +5,7 @@
 import pytest_mock
 from gql import Client
 from gql.transport import exceptions
+from graphql import ExecutionResult
 from pyrate_limiter import Duration, Rate
 from pyrate_limiter.limiter import Limiter
 
@@ -88,9 +89,11 @@ def mock_execute(*args, **kwargs):
         nonlocal before_last_call_timestamp
         before_last_call_timestamp = last_call_timestamp
         last_call_timestamp = time()
+        return ExecutionResult({"data": 1}, extensions=None)
 
     client._gql_client = mocker.MagicMock()
     client._gql_client.execute.side_effect = mock_execute
+    client._gql_client.transport.response_headers = {}
 
     # first calls should not be rate limited
     for _ in range(MAX_CALLS_PER_MINUTE):
@@ -162,7 +165,7 @@ def mocked_backend_response(*args, **kwargs):
         nonlocal nb_times_called
         nb_times_called += 1
         if nb_times_called > 2:
-            return {"data": "all good"}
+            return ExecutionResult({"data": "all good"}, extensions=None)
         raise exceptions.TransportQueryError(
             msg=(
                 "[unexpectedRetrieving] Unexpected error when retrieving runtime information."