Using GraphQLRequest instead of DocumentNode for gql, execute, subscribe methods

[leszekhanusz]

Breaking change:

• gql and dsl_gql methods now returns a GraphQLRequest instead of a DocumentNode
• all execute and subscribe methods of Client and sessions now expects a GraphQLRequest instead of a DocumentNode

A GraphQLRequest is an object which contains optional variable_values and operation_name in addition to the document.

Because of that double change, the simple code examples do not need to be changed, but if you're using external methods on the result from the gql method, like print_ast which expects a DocumentNode, then you will need to use the document attribute of the request.

Before:

query = gql("{balance}")
print_ast(query)

After:

query = gql("{balance}")
print_ast(query.document)

Deprecated variable_values and operation_name in execute and subscribe methods

The new way to add variable_values is to set it as a property of the GraphQLRequest, and not as an argument of execute or subscribe methods:

    query = gql(
        """
        query getContinentName ($code: ID!) {
          continent (code: $code) {
            name
          }
        }
    """
    )

    query.variable_values = {"code": "EU"}

    # Get name of continent with code "EU"
    result = client.execute(query)

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 100.00%. Comparing base (7fb869a) to head (4ef394d).
Report is 19 commits behind head on master.

Additional details and impacted files

@@            Coverage Diff             @@
##            master      #556    +/-   ##
==========================================
  Coverage   100.00%   100.00%            
==========================================
  Files           38        40     +2     
  Lines         2908      3103   +195     
==========================================
+ Hits          2908      3103   +195     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.