forked from graphql-python/graphql-server
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathrender_graphiql.py
330 lines (290 loc) · 10.9 KB
/
render_graphiql.py
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
"""Based on (express-graphql)[https://github.com/graphql/express-graphql/blob/master/src/renderGraphiQL.js] and
(subscriptions-transport-ws)[https://github.com/apollographql/subscriptions-transport-ws]"""
import json
import re
from typing import Any, Dict, Optional, Tuple
from jinja2 import Environment
from typing_extensions import TypedDict
GRAPHIQL_VERSION = "1.0.3"
GRAPHIQL_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>
<meta charset="utf-8" />
<title>{{graphiql_html_title}}</title>
<meta name="robots" content="noindex" />
<meta name="referrer" content="origin" />
<meta name="viewport" content="width=device-width, initial-scale=1" />
<style>
body {
margin: 0;
overflow: hidden;
}
#graphiql {
height: 100vh;
}
</style>
<link href="//cdn.jsdelivr.net/npm/graphiql@{{graphiql_version}}/graphiql.css" rel="stylesheet" />
<script src="//cdn.jsdelivr.net/npm/[email protected]/dist/polyfill.min.js"></script>
<script src="//cdn.jsdelivr.net/npm/[email protected]/dist/unfetch.umd.js"></script>
<script src="//cdn.jsdelivr.net/npm/[email protected]/umd/react.production.min.js"></script>
<script src="//cdn.jsdelivr.net/npm/[email protected]/umd/react-dom.production.min.js"></script>
<script src="//cdn.jsdelivr.net/npm/graphiql@{{graphiql_version}}/graphiql.min.js"></script>
<script src="//cdn.jsdelivr.net/npm/[email protected]/browser/client.js"></script>
<script src="//cdn.jsdelivr.net/npm/[email protected]/browser/client.js"></script>
</head>
<body>
<div id="graphiql">Loading...</div>
<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));
}
});
// Produce a Location query string from a parameter object.
function locationQuery(params) {
return '?' + Object.keys(params).filter(function (key) {
return Boolean(params[key]);
}).map(function (key) {
return encodeURIComponent(key) + '=' +
encodeURIComponent(params[key]);
}).join('&');
}
// Derive a fetch URL from the current URL, sans the GraphQL parameters.
var graphqlParamNames = {
query: true,
variables: true,
operationName: true
};
var otherParams = {};
for (var k in parameters) {
if (parameters.hasOwnProperty(k) && graphqlParamNames[k] !== true) {
otherParams[k] = parameters[k];
}
}
// Configure the subscription client
let subscriptionsFetcher = null;
if ('{{subscription_url}}') {
let subscriptionsClient = new SubscriptionsTransportWs.SubscriptionClient(
'{{ subscription_url }}',
{ reconnect: true }
);
subscriptionsFetcher = GraphiQLSubscriptionsFetcher.graphQLFetcher(
subscriptionsClient,
graphQLFetcher
);
}
var fetchURL = locationQuery(otherParams);
// Defines a GraphQL fetcher using the fetch API.
function graphQLFetcher(graphQLParams, opts) {
return fetch(fetchURL, {
method: 'post',
headers: Object.assign(
{
'Accept': 'application/json',
'Content-Type': 'application/json'
},
opts && opts.headers,
),
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();
}
function onEditVariables(newVariables) {
parameters.variables = newVariables;
updateURL();
}
function onEditHeaders(newHeaders) {
parameters.headers = newHeaders;
updateURL();
}
function onEditOperationName(newOperationName) {
parameters.operationName = newOperationName;
updateURL();
}
function updateURL() {
history.replaceState(null, null, locationQuery(parameters));
}
// Render <GraphiQL /> into the body.
ReactDOM.render(
React.createElement(GraphiQL, {
fetcher: subscriptionsFetcher || graphQLFetcher,
onEditQuery: onEditQuery,
onEditVariables: onEditVariables,
onEditHeaders: onEditHeaders,
onEditOperationName: onEditOperationName,
query: {{query|tojson}},
response: {{result|tojson}},
variables: {{variables|tojson}},
headers: {{headers|tojson}},
operationName: {{operation_name|tojson}},
defaultQuery: {{default_query|tojson}},
headerEditorEnabled: {{header_editor_enabled|tojson}},
shouldPersistHeaders: {{should_persist_headers|tojson}}
}),
document.getElementById('graphiql')
);
</script>
</body>
</html>"""
class GraphiQLData(TypedDict):
"""GraphiQL ReactDom Data
Has the following attributes:
subscription_url
The GraphiQL socket endpoint for using subscriptions in graphql-ws.
headers
An optional GraphQL string to use as the initial displayed request headers,
if None is provided, the stored headers will be used.
"""
query: Optional[str]
variables: Optional[str]
operation_name: Optional[str]
result: Optional[str]
subscription_url: Optional[str]
headers: Optional[str]
class GraphiQLConfig(TypedDict):
"""GraphiQL Extra Config
Has the following attributes:
graphiql_version
The version of the provided GraphiQL package.
graphiql_template
Inject a Jinja template string to customize GraphiQL.
graphiql_html_title
Replace the default html title on the GraphiQL.
jinja_env
Sets jinja environment to be used to process GraphiQL template.
If Jinja’s async mode is enabled (by enable_async=True),
uses Template.render_async instead of Template.render.
If environment is not set, fallbacks to simple regex-based renderer.
"""
graphiql_version: Optional[str]
graphiql_template: Optional[str]
graphiql_html_title: Optional[str]
jinja_env: Optional[Environment]
class GraphiQLOptions(TypedDict):
"""GraphiQL options to display on the UI.
Has the following attributes:
default_query
An optional GraphQL string to use when no query is provided and no stored
query exists from a previous session. If None is provided, GraphiQL
will use its own default query.
header_editor_enabled
An optional boolean which enables the header editor when true.
Defaults to false.
should_persist_headers
An optional boolean which enables to persist headers to storage when true.
Defaults to false.
"""
default_query: Optional[str]
header_editor_enabled: Optional[bool]
should_persist_headers: Optional[bool]
def escape_js_value(value: Any) -> Any:
quotation = False
if value.startswith('"') and value.endswith('"'):
quotation = True
value = value[1 : len(value) - 1]
value = value.replace("\\\\n", "\\\\\\n").replace("\\n", "\\\\n")
if quotation:
value = '"' + value.replace('\\\\"', '"').replace('"', '\\"') + '"'
return value
def process_var(template: str, name: str, value: Any, jsonify=False) -> str:
pattern = r"{{\s*" + name + r"(\s*|[^}]+)*\s*}}"
if jsonify and value not in ["null", "undefined"]:
value = json.dumps(value)
value = escape_js_value(value)
return re.sub(pattern, value, template)
def simple_renderer(template: str, **values: Dict[str, Any]) -> str:
replace = [
"graphiql_version",
"graphiql_html_title",
"subscription_url",
"header_editor_enabled",
"should_persist_headers",
]
replace_jsonify = [
"query",
"result",
"variables",
"operation_name",
"default_query",
"headers",
]
for r in replace:
template = process_var(template, r, values.get(r, ""))
for r in replace_jsonify:
template = process_var(template, r, values.get(r, ""), True)
return template
def _render_graphiql(
data: GraphiQLData,
config: GraphiQLConfig,
options: Optional[GraphiQLOptions] = None,
) -> Tuple[str, Dict[str, Any]]:
"""When render_graphiql receives a request which does not Accept JSON, but does
Accept HTML, it may present GraphiQL, the in-browser GraphQL explorer IDE.
When shown, it will be pre-populated with the result of having executed
the requested query.
"""
graphiql_version = config.get("graphiql_version") or GRAPHIQL_VERSION
graphiql_template = config.get("graphiql_template") or GRAPHIQL_TEMPLATE
graphiql_html_title = config.get("graphiql_html_title") or "GraphiQL"
template_vars: Dict[str, Any] = {
"graphiql_version": graphiql_version,
"graphiql_html_title": graphiql_html_title,
"query": data.get("query"),
"variables": data.get("variables"),
"operation_name": data.get("operation_name"),
"result": data.get("result"),
"subscription_url": data.get("subscription_url") or "",
"headers": data.get("headers") or "",
"default_query": options and options.get("default_query") or "",
"header_editor_enabled": options
and options.get("header_editor_enabled")
or "true",
"should_persist_headers": options
and options.get("should_persist_headers")
or "false",
}
return graphiql_template, template_vars
async def render_graphiql_async(
data: GraphiQLData,
config: GraphiQLConfig,
options: Optional[GraphiQLOptions] = None,
) -> str:
graphiql_template, template_vars = _render_graphiql(data, config, options)
jinja_env: Optional[Environment] = config.get("jinja_env")
if jinja_env:
# This method returns a Template. See https://jinja.palletsprojects.com/en/2.11.x/api/#jinja2.Template
template = jinja_env.from_string(graphiql_template)
if jinja_env.is_async: # type: ignore
source = await template.render_async(**template_vars)
else:
source = template.render(**template_vars)
else:
source = simple_renderer(graphiql_template, **template_vars)
return source
def render_graphiql_sync(
data: GraphiQLData,
config: GraphiQLConfig,
options: Optional[GraphiQLOptions] = None,
) -> str:
graphiql_template, template_vars = _render_graphiql(data, config, options)
source = simple_renderer(graphiql_template, **template_vars)
return source