Merge pull request #571 from JJSphar/master

Add operation_name parameter to Graphql.execute

Author: mllemango

README.md

@@ -183,6 +183,45 @@ This library also supports Shopify's new [GraphQL API](https://help.shopify.com/
 result = shopify.GraphQL().execute('{ shop { name id } }')
 ```
 
+You can perform more complex operations using the `variables` and `operation_name` parameters of `execute`.
+
+For example, this GraphQL document uses a fragment to construct two named queries - one for a single order, and one for multiple orders:
+
+```graphql
+    # ./order_queries.graphql
+
+    fragment OrderInfo on Order {
+        id
+        name
+        createdAt
+    }
+
+    query GetOneOrder($order_id: ID!){
+        node(id: $order_id){
+            ...OrderInfo
+        }
+    }
+
+    query GetManyOrders($order_ids: [ID]!){
+        nodes(ids: $order_ids){
+           ...OrderInfo
+        }
+    }
+```
+
+Now you can choose which operation to execute:
+
+```python
+# Load the document with both queries
+document = Path("./order_queries.graphql").read_text()
+
+# Specify the named operation to execute, and the parameters for the query
+result = shopify.GraphQL().execute(
+    query=document,
+    variables={"order_id": "gid://shopify/Order/12345"},
+    operation_name="GetOneOrder",
+)
+```
 
 ## Using Development Version
 

shopify/resources/graphql.py

@@ -15,11 +15,11 @@ def merge_headers(self, *headers):
             merged_headers.update(header)
         return merged_headers
 
-    def execute(self, query, variables=None):
+    def execute(self, query, variables=None, operation_name=None):
         endpoint = self.endpoint
         default_headers = {"Accept": "application/json", "Content-Type": "application/json"}
         headers = self.merge_headers(default_headers, self.headers)
-        data = {"query": query, "variables": variables}
+        data = {"query": query, "variables": variables, "operationName": operation_name}
 
         req = urllib.request.Request(self.endpoint, json.dumps(data).encode("utf-8"), headers)
 

test/graphql_test.py

@@ -9,7 +9,7 @@ def setUp(self):
         shopify.ApiVersion.define_known_versions()
         shopify_session = shopify.Session("this-is-my-test-show.myshopify.com", "unstable", "token")
         shopify.ShopifyResource.activate_session(shopify_session)
-        client = shopify.GraphQL()
+        self.client = shopify.GraphQL()
         self.fake(
             "graphql",
             method="POST",
@@ -20,6 +20,8 @@ def setUp(self):
                 "Content-Type": "application/json",
             },
         )
+
+    def test_fetch_shop_with_graphql(self):
         query = """
             {
                 shop {
@@ -28,7 +30,17 @@ def setUp(self):
                 }
             }
         """
-        self.result = client.execute(query)
+        result = self.client.execute(query)
+        self.assertTrue(json.loads(result)["shop"]["name"] == "Apple Computers")
 
-    def test_fetch_shop_with_graphql(self):
-        self.assertTrue(json.loads(self.result)["shop"]["name"] == "Apple Computers")
+    def test_specify_operation_name(self):
+        query = """
+            query GetShop{
+                shop {
+                    name
+                    id
+                }
+            }
+        """
+        result = self.client.execute(query, operation_name="GetShop")
+        self.assertTrue(json.loads(result)["shop"]["name"] == "Apple Computers")