Merge pull request #27 from aweiker/master

Upgrading GraphiQL to version 0.7.0
graphql-elixir · Apr 29, 2016 · 409e779 · 409e779
2 parents 2e568d9 + 86afe95
commit 409e779
Show file tree

Hide file tree

Showing 2 changed files with 113 additions and 89 deletions.
diff --git a/lib/graphql/plug/graphiql.ex b/lib/graphql/plug/graphiql.ex
@@ -19,7 +19,7 @@ defmodule GraphQL.Plug.GraphiQL do
 
   @behaviour Plug
 
-  @graphiql_version "0.6.1"
+  @graphiql_version "0.7.0"
   @graphiql_instructions """
   # Welcome to GraphQL Elixir!
   #
@@ -40,7 +40,7 @@ defmodule GraphQL.Plug.GraphiQL do
   require EEx
   EEx.function_from_file :defp, :graphiql_html,
     Path.absname(Path.relative_to_cwd("templates/graphiql.eex")),
-    [:graphiql_version, :query, :variables, :result]
+    [:graphiql_version, :query, :variables, :result, :operation_name]
 
   def init(opts) do
     allow_graphiql? = Keyword.get(opts, :allow_graphiql?, true)
@@ -62,6 +62,9 @@ defmodule GraphQL.Plug.GraphiQL do
     Endpoint.handle_error(conn, "GraphQL only supports GET and POST requests.")
   end
 
+  defp escape_string(nil) do
+    ""
+  end
   defp escape_string(s) do
     s
     |> String.replace(~r/\n/, "\\n")
@@ -76,7 +79,7 @@ defmodule GraphQL.Plug.GraphiQL do
     {:ok, variables} = Poison.encode(args.variables, pretty: true)
     {:ok, result}    = Poison.encode(data, pretty: true)
 
-    graphiql = graphiql_html(@graphiql_version, escape_string(query), escape_string(variables), escape_string(result))
+    graphiql = graphiql_html(@graphiql_version, escape_string(query), escape_string(variables), escape_string(result), escape_string(args.operation_name))
     conn
     |> put_resp_content_type("text/html")
     |> send_resp(200, graphiql)

diff --git a/templates/graphiql.eex b/templates/graphiql.eex
@@ -2,105 +2,126 @@
 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%;
-      margin: 0;
-      overflow: hidden;
-      width: 100%;
-    }
-  </style>
-  <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/0.14.7/react.min.js"></script>
-  <script src="//cdn.jsdelivr.net/react/0.14.7/react-dom.min.js"></script>
-  <script src="//cdn.jsdelivr.net/graphiql/<%= graphiql_version %>/graphiql.min.js"></script>
-</head>
-<body>
-  <script>
-    // Collect the URL parameters
-    var parameters = {};
-    window.location.search.substr(1).split('&').forEach(function (entry) {
-      var eq = entry.indexOf('=');
-      if (eq >= 0) {
-        parameters[decodeURIComponent(entry.slice(0, eq))] =
-          decodeURIComponent(entry.slice(eq + 1));
+  <head>
+    <style>
+      body {
+        height: 100%;
+        margin: 0;
+        width: 100%;
+        overflow: hidden;
+      }
+      #graphiql {
+        height: 100vh;
       }
-    });
+    </style>
+    <link rel="stylesheet" href="//cdn.jsdelivr.net/graphiql/<%= graphiql_version %>/graphiql.css" />
+    <script src="//cdn.jsdelivr.net/fetch/0.9.0/fetch.min.js"></script>
+    <script src="//cdn.jsdelivr.net/react/0.14.7/react.min.js"></script>
+    <script src="//cdn.jsdelivr.net/react/0.14.7/react-dom.min.js"></script>
+    <script src="//cdn.jsdelivr.net/graphiql/<%= graphiql_version %>/graphiql.min.js"></script>
+  </head>
+  <body>
+    <div id="graphiql">Loading...</div>
+    <script>
 
-    // Produce a Location query string from a parameter object.
-    function locationQuery(params) {
-      return '?' + Object.keys(params).map(function (key) {
-        return encodeURIComponent(key) + '=' +
-          encodeURIComponent(params[key]);
-      }).join('&');
-    }
+      /**
+       * This GraphiQL example illustrates how to use some of GraphiQL's props
+       * in order to enable reading and updating the URL parameters, making
+       * link sharing of queries a little bit easier.
+       *
+       * This is only one example of this kind of feature, GraphiQL exposes
+       * various React params to enable interesting integrations.
+       */
 
-    // Derive a fetch URL from the current URL, sans the GraphQL parameters.
-    var graphqlParamNames = {
-      query: true,
-      variables: true,
-      operationName: true
-    };
+      // Parse the search string to get url parameters.
+      var search = window.location.search;
+      var parameters = {};
+      search.substr(1).split('&').forEach(function (entry) {
+        var eq = entry.indexOf('=');
+        if (eq >= 0) {
+          parameters[decodeURIComponent(entry.slice(0, eq))] =
+            decodeURIComponent(entry.slice(eq + 1));
+        }
+      });
 
-    var otherParams = {};
-    for (var k in parameters) {
-      if (parameters.hasOwnProperty(k) && graphqlParamNames[k] !== true) {
-        otherParams[k] = parameters[k];
+      // if variables was provided, try to format it.
+      if (parameters.variables) {
+        try {
+          parameters.variables =
+            JSON.stringify(JSON.parse(parameters.variables), null, 2);
+        } catch (e) {
+          // Do nothing, we want to display the invalid JSON as a string, rather
+          // than present an error.
+        }
       }
-    }
-    var fetchURL = locationQuery(otherParams);
 
-    // Defines a GraphQL fetcher using the fetch API.
-    function graphQLFetcher(graphQLParams) {
-      return fetch(fetchURL, {
-        method: 'post',
-        headers: {
-          'Accept': 'application/json',
-          'Content-Type': 'application/json'
-        },
-        body: JSON.stringify(graphQLParams),
-        credentials: 'include',
-      }).then(function (response) {
-        return response.json();
-      });
-    }
+      // When the query and variables string is edited, update the URL bar so
+      // that it can be easily shared
+      function onEditQuery(newQuery) {
+        parameters.query = newQuery;
+        updateURL();
+      }
 
-    // When the query and variables string is edited, update the URL bar so
-    // that it can be easily shared.
-    function onEditQuery(newQuery) {
-      parameters.query = newQuery;
-      updateURL();
-    }
+      function onEditVariables(newVariables) {
+        parameters.variables = newVariables;
+        updateURL();
+      }
 
-    function onEditVariables(newVariables) {
-      parameters.variables = newVariables;
-      updateURL();
-    }
+      function onEditOperationName(newOperationName) {
+        parameters.operationName = newOperationName;
+        updateURL();
+      }
 
-    function updateURL() {
-      history.replaceState(null, null, locationQuery(parameters));
-    }
+      function updateURL() {
+        var newSearch = '?' + Object.keys(parameters).filter(function (key) {
+          return Boolean(parameters[key]);
+        }).map(function (key) {
+          return encodeURIComponent(key) + '=' +
+            encodeURIComponent(parameters[key]);
+        }).join('&');
+        history.replaceState(null, null, newSearch);
+      }
+
+      // Defines a GraphQL fetcher using the fetch API.
+      function graphQLFetcher(graphQLParams) {
+        return fetch(window.location.origin + '/graphql', {
+          method: 'post',
+          headers: {
+            'Accept': 'application/json',
+            'Content-Type': 'application/json',
+          },
+          body: JSON.stringify(graphQLParams),
+          credentials: 'include',
+        }).then(function (response) {
+          return response.text();
+        }).then(function (responseBody) {
+          try {
+            return JSON.parse(responseBody);
+          } catch (error) {
+            return responseBody;
+          }
+        });
+      }
 
-    // Render <GraphiQL /> into the body.
-    React.render(
-      React.createElement(GraphiQL, {
-        fetcher: graphQLFetcher,
-        onEditQuery: onEditQuery,
-        onEditVariables: onEditVariables,
-        query: '<%= query %>',
-        response: '<%= result %>',
-        variables: '<%= variables %>'
-      }),
-      document.body
-    );
-  </script>
-</body>
+      // Render <GraphiQL /> into the body.
+      ReactDOM.render(
+        React.createElement(GraphiQL, {
+          fetcher: graphQLFetcher,
+          onEditQuery: onEditQuery,
+          onEditVariables: onEditVariables,
+          onEditOperationName: onEditOperationName,
+          operationName: '<%= operation_name %>',
+          query: '<%= query %>',
+          response: '<%= result %>',
+          variables: '<%= variables %>'
+        }),
+        document.getElementById('graphiql')
+      );
+    </script>
+  </body>
 </html>