-
Notifications
You must be signed in to change notification settings - Fork 38
/
react.py
executable file
·280 lines (211 loc) · 7.44 KB
/
react.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
"""
This module contains tags for including react components into templates.
"""
import json
import uuid
from django import template
from django.conf import settings
from django.template import Node
from django.utils.module_loading import import_string
from django_react_templatetags.encoders import json_encoder_cls_factory
register = template.Library()
CONTEXT_KEY = "REACT_COMPONENTS"
DEFAULT_SSR_HEADERS = {
"Content-type": "application/json",
"Accept": "text/plain",
}
def get_uuid():
return uuid.uuid4().hex
def has_ssr(request):
if request and request.META.get("HTTP_X_DISABLE_SSR"):
return False
return hasattr(settings, "REACT_RENDER_HOST") and settings.REACT_RENDER_HOST
def get_ssr_headers():
if not hasattr(settings, "REACT_RENDER_HEADERS"):
return DEFAULT_SSR_HEADERS
return settings.REACT_RENDER_HEADERS
def load_from_ssr(component, ssr_context=None):
ssr_service = _get_ssr_service()()
return ssr_service.load_or_empty(
component,
headers=get_ssr_headers(),
ssr_context=ssr_context,
)
def _get_ssr_service():
"""
Loads a custom React Tag Manager if provided in Django Settings.
"""
class_path = getattr(settings, "REACT_SSR_SERVICE", "")
if not class_path:
from django_react_templatetags.ssr.default import SSRService
return SSRService
return import_string(class_path)
class ReactTagManager(Node):
"""
Handles the printing of react placeholders and queueing, is invoked by
react_render.
"""
def __init__(
self,
identifier,
component,
data=None,
css_class=None,
props=None,
ssr_context=None,
no_placeholder=None,
):
component_prefix = ""
if hasattr(settings, "REACT_COMPONENT_PREFIX"):
component_prefix = settings.REACT_COMPONENT_PREFIX
self.identifier = identifier
self.component = component
self.component_prefix = component_prefix
self.data = data
self.css_class = css_class
self.props = props
self.ssr_context = ssr_context
self.no_placeholder = no_placeholder
def render(self, context):
qualified_component_name = self.get_qualified_name(context)
identifier = self.get_identifier(context, qualified_component_name)
component_props = self.get_component_props(context)
json_str = self.props_to_json(component_props, context)
component = {
"identifier": identifier,
"data_identifier": "{}_data".format(identifier),
"name": qualified_component_name,
"json": json_str,
"json_obj": json.loads(json_str),
}
placeholder_attr = (
("id", identifier),
("class", self.resolve_template_variable(self.css_class, context)),
)
placeholder_attr = [x for x in placeholder_attr if x[1] is not None]
component_html = ""
if has_ssr(context.get("request", None)):
ssr_resp = load_from_ssr(
component,
ssr_context=self.get_ssr_context(context),
)
component_html = ssr_resp["html"]
component["ssr_params"] = ssr_resp["params"]
components = context.get(CONTEXT_KEY, [])
components.append(component)
context[CONTEXT_KEY] = components
if self.no_placeholder:
return component_html
return self.render_placeholder(placeholder_attr, component_html)
def get_qualified_name(self, context):
component_name = self.resolve_template_variable(self.component, context)
return "{}{}".format(self.component_prefix, component_name)
def get_identifier(self, context, qualified_component_name):
identifier = self.resolve_template_variable(self.identifier, context)
if identifier:
return identifier
return "{}_{}".format(qualified_component_name, get_uuid())
def get_component_props(self, context):
resolved_data = self.resolve_template_variable_else_none(self.data, context)
resolved_data = resolved_data if resolved_data else {}
for prop in self.props:
data = self.resolve_template_variable_else_none(
self.props[prop],
context,
)
resolved_data[prop] = data
return resolved_data
def get_ssr_context(self, context):
if not self.ssr_context:
return {}
return self.resolve_template_variable(self.ssr_context, context)
@staticmethod
def resolve_template_variable(value, context):
if isinstance(value, template.Variable):
return value.resolve(context)
return value
@staticmethod
def resolve_template_variable_else_none(value, context):
try:
data = value.resolve(context)
except template.VariableDoesNotExist:
data = None
except AttributeError:
data = None
return data
@staticmethod
def props_to_json(resolved_data, context):
cls = json_encoder_cls_factory(context)
return json.dumps(resolved_data, cls=cls)
@staticmethod
def render_placeholder(attributes, component_html=""):
attr_pairs = map(lambda x: '{}="{}"'.format(*x), attributes)
return "<div {}>{}</div>".format(
" ".join(attr_pairs),
component_html,
)
@register.tag
def react_render(parser, token):
"""
Renders a react placeholder and adds it to the global render queue.
Example:
{% react_render component="ListRestaurants" data=restaurants %}
"""
values = _prepare_args(parser, token)
tag_manager = _get_tag_manager()
return tag_manager(**values)
def _prepare_args(parses, token):
"""
Normalize token arguments that can be passed along to node renderer
"""
values = {
"identifier": None,
"css_class": None,
"data": None,
"props": {},
}
key_mapping = {
"id": "identifier",
"class": "css_class",
"props": "data",
}
args = token.split_contents()
method = args[0]
for arg in args[1:]:
key, value = arg.split(
r"=",
)
key = key_mapping.get(key, key)
is_standalone_prop = key.startswith("prop_")
if is_standalone_prop:
key = key[5:]
value = template.Variable(value)
if is_standalone_prop:
values["props"][key] = value
else:
values[key] = value
assert "component" in values, "{} is missing component value".format(method) # NOQA
return values
def _get_tag_manager():
"""
Loads a custom React Tag Manager if provided in Django Settings.
"""
class_path = getattr(settings, "REACT_RENDER_TAG_MANAGER", "")
if not class_path:
return ReactTagManager
return import_string(class_path)
@register.inclusion_tag("react_print.html", takes_context=True)
def react_print(context):
"""
Generates ReactDOM.hydate calls based on REACT_COMPONENT queue,
this needs to be run after react has been loaded.
The queue will be cleared after beeing called.
Example:
{% react_print %}
"""
components = context.get(CONTEXT_KEY, [])
context[CONTEXT_KEY] = []
new_context = context.__copy__()
new_context["ssr_available"] = has_ssr(context.get("request", None))
new_context["components"] = components
return new_context