Fixed executor bug. Moved graphiql to be remote-hosted

Author: syrusakbary

flask_graphql/__init__.py

@@ -1,5 +1,4 @@
 from .blueprint import GraphQL
-from .graphiqlview import GraphiQLView
 from .graphqlview import GraphQLView
 
-__all__ = ['GraphQL', 'GraphQLView', 'GraphiQLView']
+__all__ = ['GraphQL', 'GraphQLView']

flask_graphql/blueprint.py

@@ -1,19 +1,18 @@
+import warnings
+
 from flask import Blueprint
 
-from .graphiqlview import GraphiQLView
 from .graphqlview import GraphQLView
 
 
 class GraphQL(object):
     def __init__(self, app, schema, **options):
         self.app = app
+        warnings.warn('GraphQL Blueprint is now deprecated, please use GraphQLView directly')
         self.blueprint = Blueprint('graphql', __name__,
-                                   template_folder='templates',
-                                   static_url_path='/static/graphql',
-                                   static_folder='static/graphql/')
+                                   template_folder='templates')
 
         default_query = options.pop('default_query', None)
         app.add_url_rule('/graphql', view_func=GraphQLView.as_view('graphql', schema=schema, **options))
-        app.add_url_rule('/graphiql', view_func=GraphiQLView.as_view('graphiql', default_query=default_query))
 
         self.app.register_blueprint(self.blueprint)

flask_graphql/graphiqlview.py

@@ -12,6 +12,8 @@
 from graphql.type.schema import GraphQLSchema
 from graphql.utils.get_operation_ast import get_operation_ast
 
+from .render_graphiql import render_graphiql
+
 
 class HttpError(Exception):
     def __init__(self, response, message=None, *args, **kwargs):
@@ -23,9 +25,11 @@ def __init__(self, response, message=None, *args, **kwargs):
 class GraphQLView(View):
     schema = None
     executor = None
-    execute = None
     root_value = None
+    context = None
     pretty = False
+    graphiql = False
+    graphiql_version = None
 
     methods = ['GET', 'POST', 'PUT', 'DELETE']
 
@@ -36,7 +40,8 @@ def __init__(self, **kwargs):
                 setattr(self, key, value)
 
         inner_schema = getattr(self.schema, 'schema', None)
-        self._execute = getattr(self.schema, 'execute', None)
+        if not self.executor:
+            self.executor = getattr(self.schema, 'executor', None)
 
         if inner_schema:
             self.schema = inner_schema
@@ -55,21 +60,47 @@ def dispatch_request(self):
             if request.method.lower() not in ('get', 'post'):
                 raise HttpError(MethodNotAllowed(['GET', 'POST'], 'GraphQL only supports GET and POST requests.'))
 
-            execution_result = self.execute_graphql_request(request)
-            response = {}
+            data = self.parse_body(request)
+            show_graphiql = self.graphiql and self.can_display_graphiql(data)
+
+            query, variables, operation_name = self.get_graphql_params(request, data)
+
+            execution_result = self.execute_graphql_request(
+                data,
+                query,
+                variables,
+                operation_name,
+                show_graphiql
+            )
+
+            if execution_result:
+                response = {}
 
-            if execution_result.errors:
-                response['errors'] = [self.format_error(e) for e in execution_result.errors]
+                if execution_result.errors:
+                    response['errors'] = [self.format_error(e) for e in execution_result.errors]
 
-            if execution_result.invalid:
-                status_code = 400
+                if execution_result.invalid:
+                    status_code = 400
+                else:
+                    status_code = 200
+                    response['data'] = execution_result.data
+
+                result = self.json_encode(request, response)
             else:
-                status_code = 200
-                response['data'] = execution_result.data
+                result = None
+
+            if show_graphiql:
+                return render_graphiql(
+                    graphiql_version=self.graphiql_version,
+                    query=query,
+                    variables=variables,
+                    operation_name=operation_name,
+                    result=result
+                )
 
             return Response(
                 status=status_code,
-                response=self.json_encode(request, response),
+                response=result,
                 content_type='application/json'
             )
 
@@ -113,21 +144,18 @@ def parse_body(self, request):
         return {}
 
     def execute(self, *args, **kwargs):
-        if self._execute:
-            return self._execute(*args, **kwargs)
         return execute(self.schema, *args, **kwargs)
 
-    def execute_graphql_request(self, request):
-        query, variables, operation_name = self.get_graphql_params(request, self.parse_body(request))
-
+    def execute_graphql_request(self, data, query, variables, operation_name, show_graphiql=False):
         if not query:
+            if show_graphiql:
+                return None
             raise HttpError(BadRequest('Must provide query string.'))
 
-        source = Source(query, name='GraphQL request')
-
         try:
-            document_ast = parse(source)
-            validation_errors = validate(self.schema, document_ast)
+            source = Source(query, name='GraphQL request')
+            ast = parse(source)
+            validation_errors = validate(self.schema, ast)
             if validation_errors:
                 return ExecutionResult(
                     errors=validation_errors,
@@ -137,23 +165,39 @@ def execute_graphql_request(self, request):
             return ExecutionResult(errors=[e], invalid=True)
 
         if request.method.lower() == 'get':
-            operation_ast = get_operation_ast(document_ast, operation_name)
+            operation_ast = get_operation_ast(ast, operation_name)
             if operation_ast and operation_ast.operation != 'query':
+                if show_graphiql:
+                    return None
                 raise HttpError(MethodNotAllowed(
                     ['POST'], 'Can only perform a {} operation from a POST request.'.format(operation_ast.operation)
                 ))
 
         try:
             return self.execute(
-                document_ast,
+                ast,
                 root_value=self.get_root_value(request),
-                variable_values=variables,
+                variable_values=variables or {},
                 operation_name=operation_name,
-                context_value=self.get_context(request)
+                context_value=self.get_context(request),
+                executor=self.executor
             )
         except Exception as e:
             return ExecutionResult(errors=[e], invalid=True)
 
+    @classmethod
+    def can_display_graphiql(cls, data):
+        raw = 'raw' in request.args or 'raw' in data
+        return not raw and cls.request_wants_html(request)
+
+    @classmethod
+    def request_wants_html(cls, request):
+        best = request.accept_mimetypes \
+            .best_match(['application/json', 'text/html'])
+        return best == 'text/html' and \
+            request.accept_mimetypes[best] > \
+            request.accept_mimetypes['application/json']
+
     @staticmethod
     def get_graphql_params(request, data):
         query = request.args.get('query') or data.get('query')

flask_graphql/graphqlview.py

@@ -1,5 +1,18 @@
+from flask import render_template_string
+
+
+GRAPHIQL_VERSION = '0.7.1'
+
+TEMPLATE = '''<!--
+The request to this GraphQL server provided the header "Accept: text/html"
+and as a result has been presented GraphiQL - an in-browser IDE for
+exploring GraphQL.
+If you wish to receive JSON, provide the header "Accept: application/json" or
+add "&raw" to the end of the URL within a browser.
+-->
 <!DOCTYPE html>
 <html>
+<head>
   <style>
     html, body {
       height: 100%;
@@ -8,13 +21,12 @@
       width: 100%;
     }
   </style>
-  <head>
-    <link rel="stylesheet" href="{{ url_for("graphql.static", filename="graphiql.css") }}" />
-    <script src="{{ url_for("graphql.static", filename="fetch.min.js") }}"></script>
-    <script src="{{ url_for("graphql.static", filename="react.min.js") }}"></script>
-    <script src="{{ url_for("graphql.static", filename="react-dom.min.js") }}"></script>
-    <script src="{{ url_for("graphql.static", filename="graphiql.min.js") }}"></script>
-  </head>
+  <link href="//cdn.jsdelivr.net/graphiql/{{graphiql_version}}/graphiql.css" rel="stylesheet" />
+  <script src="//cdn.jsdelivr.net/fetch/0.9.0/fetch.min.js"></script>
+  <script src="//cdn.jsdelivr.net/react/15.0.0/react.min.js"></script>
+  <script src="//cdn.jsdelivr.net/react/15.0.0/react-dom.min.js"></script>
+  <script src="//cdn.jsdelivr.net/graphiql/{{graphiql_version}}/graphiql.min.js"></script>
+</head>
 <body>
   <script>
     // Collect the URL parameters
@@ -48,7 +60,7 @@
         otherParams[k] = parameters[k];
       }
     }
-    var fetchURL = "{{ url_for('graphql') }}";
+    var fetchURL = locationQuery(otherParams);
 
     // Defines a GraphQL fetcher using the fetch API.
     function graphQLFetcher(graphQLParams) {
@@ -93,23 +105,26 @@
     }
 
     // Render <GraphiQL /> into the body.
-    React.render(
+    ReactDOM.render(
       React.createElement(GraphiQL, {
         fetcher: graphQLFetcher,
         onEditQuery: onEditQuery,
         onEditVariables: onEditVariables,
         onEditOperationName: onEditOperationName,
-{%- if default_query %}
-          defaultQuery: {{ default_query|tojson }},
-{%- endif %}
-        query: null,
-        response: null,
-        variables: null,
-        operationName: null,
+        query: {{ query|tojson }},
+        response: {{ result|tojson }},
+        variables: {{ variables|tojson }},
+        operationName: {{ operation_name|tojson }},
       }),
       document.body
     );
   </script>
 </body>
-</html>
+</html>'''
+
+
+def render_graphiql(graphiql_version=None, **kwargs):
+    if not graphiql_version:
+        graphiql_version = GRAPHIQL_VERSION
 
+    return render_template_string(TEMPLATE, graphiql_version=graphiql_version, **kwargs)