-
Notifications
You must be signed in to change notification settings - Fork 3.9k
/
ssr-template-helper.js
181 lines (164 loc) · 5.14 KB
/
ssr-template-helper.js
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
import {isArray} from '#core/types';
import {userAssert} from '#utils/log';
import {toStructuredCloneable} from './utils/xhr-utils';
/**
* @typedef {{
* successTemplate: ?(Element|JsonObject|undefined),
* errorTemplate: ?(Element|JsonObject|undefined)
* }}
*/
export let SsrTemplateDef;
/**
* Helper, that manages the proxying of template rendering to the viewer.
*/
export class SsrTemplateHelper {
/**
* @param {string} sourceComponent
* @param {!./service/viewer-interface.ViewerInterface} viewer
* @param {!./service/template-impl.Templates} templates
*/
constructor(sourceComponent, viewer, templates) {
/** @private @const */
this.viewer_ = viewer;
/** @private @const */
this.templates_ = templates;
/** @private @const */
this.sourceComponent_ = sourceComponent;
}
/**
* Whether the viewer should render templates. A doc-level opt in as
* trusted viewers must set this capability explicitly, as a security
* measure for potential abuse of feature.
* @return {boolean}
*/
isEnabled() {
const ampdoc = this.viewer_.getAmpDoc();
if (ampdoc.isSingleDoc()) {
const htmlElement = ampdoc.getRootNode().documentElement;
if (htmlElement.hasAttribute('allow-viewer-render-template')) {
return this.viewer_.hasCapability('viewerRenderTemplate');
}
}
return false;
}
/**
* Asserts that the viewer is from a trusted origin.
*
* @param {!Element} element
* @return {!Promise}
*/
assertTrustedViewer(element) {
return this.viewer_.isTrustedViewer().then((trusted) => {
userAssert(
trusted,
'Refused to attempt SSR in untrusted viewer: ',
element
);
});
}
/**
* Proxies xhr and template rendering to the viewer.
* Returns the renderable response, for use with applySsrOrCsrTemplate.
* @param {!Element} element
* @param {!FetchRequestDef} request The fetch/XHR related data.
* @param {?SsrTemplateDef=} opt_templates Response templates to pass into
* the payload. If provided, finding the template in the passed in
* element is not attempted.
* @param {!Object=} opt_attributes Additional JSON to send to viewer.
* @return {!Promise<?JsonObject|string|undefined>}
*/
ssr(element, request, opt_templates = null, opt_attributes = {}) {
let mustacheTemplate;
if (!opt_templates) {
mustacheTemplate = this.templates_.maybeFindTemplate(element);
}
return this.assertTrustedViewer(element).then(() => {
return this.viewer_.sendMessageAwaitResponse(
'viewerRenderTemplate',
this.buildPayload_(
request,
mustacheTemplate,
opt_templates,
opt_attributes
)
);
});
}
/**
* Render provided data for the template in the given element.
* If SSR is supported, data is assumed to be from ssr() above.
* @param {!Element} element
* @param {(?JsonObject|string|undefined|!Array)} data
* @return {!Promise<(!Element|!Array<!Element>)>}
*/
applySsrOrCsrTemplate(element, data) {
let renderTemplatePromise;
if (this.isEnabled()) {
userAssert(
typeof data['html'] === 'string',
'Skipping template rendering due to failed fetch'
);
renderTemplatePromise = this.assertTrustedViewer(element).then(() => {
return this.templates_.findAndSetHtmlForTemplate(
element,
/** @type {string} */ (data['html'])
);
});
} else if (isArray(data)) {
renderTemplatePromise = this.templates_.findAndRenderTemplateArray(
element,
/** @type {!Array} */ (data)
);
} else {
renderTemplatePromise = this.templates_.findAndRenderTemplate(
element,
/** @type {!JsonObject} */ (data)
);
}
return renderTemplatePromise;
}
/**
* @param {!FetchRequestDef} request
* @param {?Element|undefined} mustacheTemplate
* @param {?SsrTemplateDef=} opt_templates
* @param {!Object=} opt_attributes
* @return {!JsonObject}
* @private
*/
buildPayload_(request, mustacheTemplate, opt_templates, opt_attributes = {}) {
const ampComponent = {'type': this.sourceComponent_};
const successTemplateKey = 'successTemplate';
const successTemplate =
opt_templates && opt_templates[successTemplateKey]
? opt_templates[successTemplateKey]
: mustacheTemplate;
if (successTemplate) {
ampComponent[successTemplateKey] = {
'type': 'amp-mustache',
'payload': successTemplate./*REVIEW*/ innerHTML,
};
}
const errorTemplateKey = 'errorTemplate';
const errorTemplate =
opt_templates && opt_templates[errorTemplateKey]
? opt_templates[errorTemplateKey]
: null;
if (errorTemplate) {
ampComponent[errorTemplateKey] = {
'type': 'amp-mustache',
'payload': errorTemplate./*REVIEW*/ innerHTML,
};
}
if (opt_attributes) {
Object.assign(ampComponent, opt_attributes);
}
const data = {
'originalRequest': toStructuredCloneable(
request.xhrUrl,
request.fetchOpt
),
'ampComponent': ampComponent,
};
return data;
}
}