Support different operation names (#21)

Cito · Cito · commit 3c0bb272ccf6 · 2020-05-16T15:12:54.000+02:00
diff --git a/gql/client.py b/gql/client.py
@@ -29,19 +29,19 @@ def __init__(
     ):
         assert not (
             type_def and introspection
-        ), "Cant provide introspection type definition at the same time"
+        ), "Can't provide introspection type definition at the same time"
         if transport and fetch_schema_from_transport:
             assert (
                 not schema
-            ), "Cant fetch the schema from transport if is already provided"
+            ), "Can't fetch the schema from transport if is already provided"
             introspection = transport.execute(parse(introspection_query)).data
         if introspection:
-            assert not schema, "Cant provide introspection and schema at the same time"
+            assert not schema, "Can't provide introspection and schema at the same time"
             schema = build_client_schema(introspection)
         elif type_def:
             assert (
                 not schema
-            ), "Cant provide Type definition and schema at the same time"
+            ), "Can't provide Type definition and schema at the same time"
             type_def_ast = parse(type_def)
             schema = build_ast_schema(type_def_ast)
         elif schema and not transport:
diff --git a/gql/transport/requests.py b/gql/transport/requests.py
@@ -76,8 +76,10 @@ def __init__(
             for prefix in "http://", "https://":
                 self.session.mount(prefix, adapter)
 
-    def execute(self, document, variable_values=None, timeout=None):
-        # type: (Document, Dict, int) -> ExecutionResult
+    def execute(
+        self, document, variable_values=None, operation_name=None, timeout=None
+    ):
+        # type: (Document, Dict, str, int) -> ExecutionResult
         """Execute the provided document AST against the configured remote server.
         This uses the requests library to perform a HTTP POST request to the remote server.
 
@@ -88,7 +90,11 @@ def execute(self, document, variable_values=None, timeout=None):
             occurred, and is a non-empty array if an error occurred.
         """
         query_str = print_ast(document)
-        payload = {"query": query_str, "variables": variable_values or {}}
+        payload = {"query": query_str}  # type: Dict
+        if variable_values:
+            payload["variables"] = variable_values
+        if operation_name:
+            payload["operationName"] = operation_name
 
         data_key = "json" if self.use_json else "data"
         post_args = {
diff --git a/tests/fixtures/vcr_cassettes/execute.yaml b/tests/fixtures/vcr_cassettes/execute.yaml
@@ -1,23 +1,14 @@
 interactions:
 - request:
-    body: query=%7B%0A++myFavoriteFilm%3A+film%28id%3A+%22RmlsbToz%22%29+%7B%0A++++id%0A++++title%0A++++episodeId%0A++++characters%28first%3A+5%29+%7B%0A++++++edges+%7B%0A++++++++node+%7B%0A++++++++++name%0A++++++++%7D%0A++++++%7D%0A++++%7D%0A++%7D%0A%7D%0A
+    body: '{"query": "{\n  myFavoriteFilm: film(id: \"RmlsbToz\") {\n    id\n    title\n    episodeId\n    characters(first:
+      5) {\n      edges {\n        node {\n          name\n        }\n      }\n    }\n  }\n}\n"}'
     headers:
       Accept:
       - '*/*'
-      Accept-Encoding:
-      - gzip, deflate
-      Connection:
-      - keep-alive
-      Content-Length:
-      - '247'
       Content-Type:
-      - application/x-www-form-urlencoded
-      Cookie:
-      - csrftoken=hRIez34v4hg2Wbl8XhrbshvDIB3HmLR2L9WNTJ3SdrIQHxAKtoukxiuwQlwRJewz
+      - application/json
       User-Agent:
-      - python-requests/2.22.0
-      x-csrftoken:
-      - hRIez34v4hg2Wbl8XhrbshvDIB3HmLR2L9WNTJ3SdrIQHxAKtoukxiuwQlwRJewz
+      - python-requests/2.23.0
     method: POST
     uri: http://127.0.0.1:8000/graphql
   response:
@@ -30,17 +21,6 @@ interactions:
       - '264'
       Content-Type:
       - application/json
-      Date:
-      - Tue, 03 Dec 2019 08:23:58 GMT
-      Server:
-      - WSGIServer/0.1 Python/2.7.16
-      Set-Cookie:
-      - csrftoken=hRIez34v4hg2Wbl8XhrbshvDIB3HmLR2L9WNTJ3SdrIQHxAKtoukxiuwQlwRJewz;
-        expires=Tue, 01-Dec-2020 08:23:58 GMT; Max-Age=31449600; Path=/
-      Vary:
-      - Cookie
-      X-Frame-Options:
-      - SAMEORIGIN
     status:
       code: 200
       message: OK
diff --git a/tests/fixtures/vcr_cassettes/execute2.yaml b/tests/fixtures/vcr_cassettes/execute2.yaml
@@ -0,0 +1,26 @@
+interactions:
+- request:
+    body: '{"query": "query Planet1 {\n  planet(id: \"UGxhbmV0OjEw\") {\n    id\n    name\n  }\n}\n\nquery
+      Planet2 {\n  planet(id: \"UGxhbmV0OjEx\") {\n    id\n    name\n  }\n}\n", "operationName":
+      "Planet2"}'
+    headers:
+      Accept:
+      - '*/*'
+      Content-Type:
+      - application/json
+      User-Agent:
+      - python-requests/2.23.0
+    method: POST
+    uri: http://127.0.0.1:8000/graphql
+  response:
+    body:
+      string: '{"data":{"planet":{"id":"UGxhbmV0OjEx","name":"Geonosis"}}}'
+    headers:
+      Content-Length:
+      - '59'
+      Content-Type:
+      - application/json
+    status:
+      code: 200
+      message: OK
+version: 1
diff --git a/tests/test_client.py b/tests/test_client.py
@@ -40,19 +40,19 @@ def test_retries(execute_mock):
 
     client = Client(
         retries=expected_retries,
-        transport=RequestsHTTPTransport(url="http://swapi.graphene-python.org/graphql"),
+        transport=RequestsHTTPTransport(url="http://127.0.0.1:8000/graphql"),
     )
 
     query = gql(
         """
-    {
-      myFavoriteFilm: film(id:"RmlsbToz") {
-        id
-        title
-        episodeId
-      }
-    }
-    """
+        {
+          myFavoriteFilm: film(id:"RmlsbToz") {
+            id
+            title
+            episodeId
+          }
+        }
+        """
     )
 
     with pytest.raises(Exception):
@@ -73,20 +73,20 @@ def test_retries_on_transport(execute_mock):
         "Should be HTTPConnection", "Fake connection error"
     )
     transport = RequestsHTTPTransport(
-        url="http://localhost:9999", retries=expected_retries,
+        url="http://127.0.0.1:8000/graphql", retries=expected_retries,
     )
     client = Client(transport=transport)
 
     query = gql(
         """
-    {
-      myFavoriteFilm: film(id:"RmlsbToz") {
-        id
-        title
-        episodeId
-      }
-    }
-    """
+        {
+          myFavoriteFilm: film(id:"RmlsbToz") {
+            id
+            title
+            episodeId
+          }
+        }
+        """
     )
     with client:  # We're using the client as context manager
         with pytest.raises(Exception):
@@ -116,14 +116,14 @@ def test_execute_result_error():
 
     failing_query = gql(
         """
-    query getContinents {
-      continents {
-        code
-        name
-        id
-      }
-    }
-    """
+        query getContinents {
+          continents {
+            code
+            name
+            id
+          }
+        }
+        """
     )
 
     with pytest.raises(Exception) as exc_info:
@@ -206,7 +206,7 @@ def test_gql():
             username
           }
         }
-    """
+        """
     )
     result = client.execute(query)
     client.close()
diff --git a/tests/test_transport.py b/tests/test_transport.py
@@ -1,22 +1,34 @@
+import os
+
 import pytest
 import requests
 import vcr
 
 from gql import Client, gql
 from gql.transport.requests import RequestsHTTPTransport
 
-# https://github.com/graphql-python/swapi-graphene
+# We serve https://github.com/graphql-python/swapi-graphene locally:
 URL = "http://127.0.0.1:8000/graphql"
 
 
+def use_cassette(name):
+
+    return vcr.use_cassette(
+        os.path.join(
+            os.path.dirname(__file__), "fixtures", "vcr_cassettes", name + ".yaml"
+        ),
+        record_mod="new_episodes",
+    )
+
+
 @pytest.fixture
 def client():
-    with vcr.use_cassette("tests/fixtures/vcr_cassettes/client.yaml"):
-        request = requests.get(
+    with use_cassette("client"):
+        response = requests.get(
             URL, headers={"Host": "swapi.graphene-python.org", "Accept": "text/html"}
         )
-        request.raise_for_status()
-        csrf = request.cookies["csrftoken"]
+        response.raise_for_status()
+        csrf = response.cookies["csrftoken"]
 
         return Client(
             transport=RequestsHTTPTransport(
@@ -29,21 +41,21 @@ def client():
 def test_hero_name_query(client):
     query = gql(
         """
-    {
-      myFavoriteFilm: film(id:"RmlsbToz") {
-        id
-        title
-        episodeId
-        characters(first:5) {
-          edges {
-            node {
-              name
+        {
+          myFavoriteFilm: film(id:"RmlsbToz") {
+            id
+            title
+            episodeId
+            characters(first:5) {
+              edges {
+                node {
+                  name
+                }
+              }
             }
           }
         }
-      }
-    }
-    """
+        """
     )
     expected = {
         "myFavoriteFilm": {
@@ -61,6 +73,29 @@ def test_hero_name_query(client):
             },
         }
     }
-    with vcr.use_cassette("tests/fixtures/vcr_cassettes/execute.yaml"):
+    with use_cassette("execute"):
         result = client.execute(query)
         assert result == expected
+
+
+def test_planet_names_query(client):
+    query = gql(
+        """
+        query Planet1 {
+          planet(id: "UGxhbmV0OjEw") {
+            id
+            name
+          }
+        }
+        query Planet2 {
+          planet(id: "UGxhbmV0OjEx") {
+            id
+            name
+          }
+        }
+        """
+    )
+    expected = {"planet": {"id": "UGxhbmV0OjEx", "name": "Geonosis"}}
+    with use_cassette("execute2"):
+        result = client.execute(query, operation_name="Planet2")
+        assert result == expected
