Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Viewer must be trusted for ssr templates to be supported #25520

Closed
wants to merge 3 commits into from
Closed

Viewer must be trusted for ssr templates to be supported #25520

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
d8cdcf7
Runtime: Viewer must be trusted for ssr templates to be supported
samouri Nov 11, 2019
7e9d32b
fix assert, soln stinks
samouri Nov 14, 2019
203a9f6
do not merge yet, fixes tests, but im concerned potentially broke act…
samouri Nov 14, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
13 changes: 7 additions & 6 deletions build-system/tasks/presubmit-checks.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -427,15 +427,16 @@ const forbiddenTerms = {
message: requiresReviewPrivacy,
whitelist: [
'extensions/amp-bind/0.1/bind-impl.js',
'extensions/amp-viewer-assistance/0.1/amp-viewer-assistance.js',
'src/error.js',
'src/utils/xhr-utils.js',
'src/service/viewer-impl.js',
'src/service/viewer-interface.js',
'src/service/viewer-cid-api.js',
'src/impression.js',
'src/inabox/inabox-viewer.js',
'src/service/cid-impl.js',
'src/impression.js',
'extensions/amp-viewer-assistance/0.1/amp-viewer-assistance.js',
'src/service/viewer-cid-api.js',
'src/service/viewer-impl.js',
'src/service/viewer-interface.js',
'src/ssr-template-helper.js',
'src/utils/xhr-utils.js',
],
},
'prerenderSafe': {
Expand Down
93 changes: 50 additions & 43 deletions extensions/amp-form/0.1/amp-form.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -385,32 +385,36 @@ export class AmpForm {
);

// Form verification is not supported when SSRing templates is enabled.
if (!this.ssrTemplateHelper_.isSupported()) {
this.form_.addEventListener('change', e => {
this.verifier_.onCommit().then(({updatedElements, errors}) => {
updatedElements.forEach(checkUserValidityAfterInteraction_);
// Tell the validation to reveal any input.validationMessage added
// by the form verifier.
this.validator_.onBlur(e);

// Only make the verify XHR if the user hasn't pressed submit.
if (this.state_ === FormState.VERIFYING) {
if (errors.length) {
this.setState_(FormState.VERIFY_ERROR);
this.renderTemplate_(dict({'verifyErrors': errors})).then(() => {
this.triggerAction_(FormEvents.VERIFY_ERROR, errors);
});
} else {
this.setState_(FormState.INITIAL);
this.ssrTemplateHelper_.isSupported().then(isSSRSupported => {
if (!isSSRSupported) {
this.form_.addEventListener('change', e => {
this.verifier_.onCommit().then(({updatedElements, errors}) => {
updatedElements.forEach(checkUserValidityAfterInteraction_);
// Tell the validation to reveal any input.validationMessage added
// by the form verifier.
this.validator_.onBlur(e);

// Only make the verify XHR if the user hasn't pressed submit.
if (this.state_ === FormState.VERIFYING) {
if (errors.length) {
this.setState_(FormState.VERIFY_ERROR);
this.renderTemplate_(dict({'verifyErrors': errors})).then(
() => {
this.triggerAction_(FormEvents.VERIFY_ERROR, errors);
}
);
} else {
this.setState_(FormState.INITIAL);
}
}
}
});
});
});
}
}

this.form_.addEventListener('input', e => {
checkUserValidityAfterInteraction_(dev().assertElement(e.target));
this.validator_.onInput(e);
this.form_.addEventListener('input', e => {
checkUserValidityAfterInteraction_(dev().assertElement(e.target));
this.validator_.onInput(e);
});
});
}

Expand Down Expand Up @@ -674,20 +678,22 @@ export class AmpForm {
* @return {!Promise}
*/
handleXhrSubmit_(trust) {
let p;
if (this.ssrTemplateHelper_.isSupported()) {
p = this.handleSsrTemplate_(trust);
} else {
this.submittingWithTrust_(trust);
p = this.doActionXhr_().then(
response => this.handleXhrSubmitSuccess_(response),
error => this.handleXhrSubmitFailure_(error)
);
}
if (getMode().test) {
this.xhrSubmitPromise_ = p;
}
return p;
return this.ssrTemplateHelper_.isSupported().then(isSSRSupported => {
let p;
if (isSSRSupported) {
p = this.handleSsrTemplate_(trust);
} else {
this.submittingWithTrust_(trust);
p = this.doActionXhr_().then(
response => this.handleXhrSubmitSuccess_(response),
error => this.handleXhrSubmitFailure_(error)
);
}
if (getMode().test) {
this.xhrSubmitPromise_ = p;
}
return p;
});
}

/**
Expand Down Expand Up @@ -1007,12 +1013,13 @@ export class AmpForm {
* @private
*/
assertSsrTemplate_(value, msg) {
const supported = this.ssrTemplateHelper_.isSupported();
userAssert(
supported === value,
'[amp-form]: viewerRenderTemplate | %s',
msg
);
this.ssrTemplateHelper_.isSupported().then(supported => {
userAssert(
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This has changed from a sync assert (a throw) to a possibly rejected promise. You need to wait on the value.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah, I just spotted this as well. When I wrote this, I didn't know that userAssert throws. Working on it now 👍

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

meh, my solution stinks. I'll take another look tomorrow to see if I can make it cleaner.

supported === value,
'[amp-form]: viewerRenderTemplate | %s',
msg
);
});
}

/**
Expand Down
72 changes: 35 additions & 37 deletions extensions/amp-list/0.1/amp-list.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -555,26 +555,26 @@ export class AmpList extends AMP.BaseElement {
return Promise.resolve();
}
let fetch;
if (this.ssrTemplateHelper_.isSupported()) {
fetch = this.ssrTemplate_(opt_refresh);
} else {
fetch = this.prepareAndSendFetch_(opt_refresh).then(data => {
const items = this.computeListItems_(data);
if (this.loadMoreEnabled_) {
this.updateLoadMoreSrc_(/** @type {!JsonObject} */ (data));
}
return this.scheduleRender_(
items,
/*opt_append*/ false,
data
).then(() => this.maybeSetLoadMore_());
});
}
return this.ssrTemplateHelper_.isSupported().then(isSSRSupported => {
if (isSSRSupported) {
fetch = this.ssrTemplate_(opt_refresh);
} else {
fetch = this.prepareAndSendFetch_(opt_refresh).then(data => {
const items = this.computeListItems_(data);
if (this.loadMoreEnabled_) {
this.updateLoadMoreSrc_(/** @type {!JsonObject} */ (data));
}
return this.scheduleRender_(items, /*opt_append*/ false, data).then(
() => this.maybeSetLoadMore_()
);
});
}

return fetch.catch(error => {
this.triggerFetchErrorEvent_(error);
this.showFallback_();
throw error;
return fetch.catch(error => {
this.triggerFetchErrorEvent_(error);
this.showFallback_();
throw error;
});
});
}

Expand Down Expand Up @@ -622,10 +622,10 @@ export class AmpList extends AMP.BaseElement {

/**
* Proxies the template rendering to the viewer.
* @param {boolean} refresh
* @param {boolean=} refresh
* @return {!Promise}
*/
ssrTemplate_(refresh) {
ssrTemplate_(refresh = false) {
let request;
// Construct the fetch init data that would be called by the viewer
// passed in as the 'originalRequest'.
Expand Down Expand Up @@ -746,18 +746,19 @@ export class AmpList extends AMP.BaseElement {
scheduleNextPass();
current.rejecter();
};
const isSSR = this.ssrTemplateHelper_.isSupported();
let renderPromise = this.ssrTemplateHelper_
.applySsrOrCsrTemplate(this.element, current.data)
.then(result => this.updateBindings_(result, current.append))
.then(elements => this.render_(elements, current.append));
if (!isSSR) {
const payload = /** @type {!JsonObject} */ (current.payload);
renderPromise = renderPromise.then(() =>
this.maybeRenderLoadMoreTemplates_(payload)
);
}
renderPromise.then(onFulfilledCallback, onRejectedCallback);
this.ssrTemplateHelper_.isSupported().then(isSSR => {
let renderPromise = this.ssrTemplateHelper_
.applySsrOrCsrTemplate(this.element, current.data)
.then(result => this.updateBindings_(result, current.append))
.then(elements => this.render_(elements, current.append));
if (!isSSR) {
const payload = /** @type {!JsonObject} */ (current.payload);
renderPromise = renderPromise.then(() =>
this.maybeRenderLoadMoreTemplates_(payload)
);
}
renderPromise.then(onFulfilledCallback, onRejectedCallback);
});
}

/**
Expand Down Expand Up @@ -845,10 +846,7 @@ export class AmpList extends AMP.BaseElement {
// Forward elements to chained promise on success or failure.
return bind
.rescan(elements, removedElements, {'fast': true, 'update': true})
.then(
() => elements,
() => elements
);
.then(() => elements, () => elements);
};

// binding=refresh: Only do render-blocking update after initial render.
Expand Down
64 changes: 36 additions & 28 deletions src/ssr-template-helper.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,17 +51,23 @@ export class SsrTemplateHelper {
* Whether the viewer can 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}
* @return {Promise<boolean>}
*/
isSupported() {
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');
}
if (!ampdoc.isSingleDoc()) {
return Promise.resolve(false);
}
return false;
return this.viewer_.isTrustedViewer().then(isTrusted => {
if (!isTrusted) {
return false;
}
const htmlElement = ampdoc.getRootNode().documentElement;
return (
htmlElement.hasAttribute('allow-viewer-render-template') &&
this.viewer_.hasCapability('viewerRenderTemplate')
);
});
}

/**
Expand Down Expand Up @@ -100,28 +106,30 @@ export class SsrTemplateHelper {
*/
applySsrOrCsrTemplate(element, data) {
let renderTemplatePromise;
if (this.isSupported()) {
userAssert(
typeof data['html'] === 'string',
'Server side html response must be defined'
);
renderTemplatePromise = 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 this.isSupported().then(isSupported => {
if (isSupported) {
userAssert(
typeof data['html'] === 'string',
'Server side html response must be defined'
);
renderTemplatePromise = 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;
return renderTemplatePromise;
});
}

/**
Expand Down