Skip to content

Commit

Permalink
Update SwG version to 0.1.22.45 (ampproject#21055)
Browse files Browse the repository at this point in the history
  • Loading branch information
@dparikh
dparikh authored and Noran Azmy committed Mar 22, 2019
1 parent b3e7e19 commit d3a1839
Show file tree
Hide file tree
Showing 2 changed files with 97 additions and 34 deletions.
125 changes: 94 additions & 31 deletions third_party/subscriptions-project/config.js
View file
Expand Up @@ -13,7 +13,7 @@
* See the License for the specific language governing permissions and
* limitations under the License.
*/
/** Version: 0.1.22.44 */
/** Version: 0.1.22.45 */
/**
* Copyright 2018 The Subscribe with Google Authors. All Rights Reserved.
*
Expand Down Expand Up @@ -507,6 +507,21 @@ function tryParseJson(json, opt_onFailed) {

const ALREADY_SEEN = '__SWG-SEEN__';

const ALLOWED_TYPES = [
'CreativeWork',
'Article',
'NewsArticle',
'Blog',
'Comment',
'Course',
'HowTo',
'Message',
'Review',
'WebPage',
];

// RegExp for quickly scanning LD+JSON for allowed types
const RE_ALLOWED_TYPES = new RegExp(ALLOWED_TYPES.join('|'));

/**
*/
Expand Down Expand Up @@ -573,6 +588,60 @@ class PageConfigResolver {
}
}

class TypeChecker {
constructor() {
}

/**
* Check value from json
* @param {?Array|string} value
* @param {Array<string>} expectedTypes
* @return {boolean}
*/
checkValue(value, expectedTypes) {
if (!value) {
return false;
}
return this.checkArray(this.toArray_(value), expectedTypes);
}

/**
* Checks space delimited list of types
* @param {?string} itemtype
* @param {Array<string>} expectedTypes
* @return {boolean}
*/
checkString(itemtype, expectedTypes) {
if (!itemtype) {
return false;
}
return this.checkArray(itemtype.split(/\s+/), expectedTypes);
}

/**
* @param {Array<?string>} typeArray
* @param {Array<string>} expectedTypes
* @return {boolean}
*/
checkArray(typeArray, expectedTypes) {
let found = false;
typeArray.forEach(candidateType => {
found = found || expectedTypes.includes(
candidateType.replace(/^http:\/\/schema.org\//i,'')
);
});
return found;
}

/*
* @param {?Array|string} value
* @return {Array}
* @private
*/
toArray_(value) {
return isArray(value) ? value : [value];
}
}

class MetaParser {
/**
Expand Down Expand Up @@ -617,6 +686,8 @@ class JsonLdParser {
constructor(doc) {
/** @private @const {!Doc} */
this.doc_ = doc;
/** @private @const @function */
this.checkType_ = new TypeChecker();
}

/**
Expand All @@ -641,7 +712,7 @@ class JsonLdParser {
continue;
}
element[ALREADY_SEEN] = true;
if (element.textContent.indexOf('NewsArticle') == -1) {
if (!RE_ALLOWED_TYPES.test(element.textContent)) {
continue;
}
const possibleConfig = this.tryExtractConfig_(element);
Expand All @@ -662,8 +733,8 @@ class JsonLdParser {
return null;
}

// Must be a NewsArticle.
if (!this.checkType_(json, 'NewsArticle')) {
// Must be an ALLOWED_TYPE
if (!this.checkType_.checkValue(json['@type'], ALLOWED_TYPES)) {
return null;
}

Expand Down Expand Up @@ -720,7 +791,7 @@ class JsonLdParser {
*/
discoverProductId_(json) {
// Must have type `Product`.
if (!this.checkType_(json, 'Product')) {
if (!this.checkType_.checkValue(json['@type'], ['Product'])) {
return null;
}
return /** @type {?string} */ (this.singleValue_(json, 'productID'));
Expand Down Expand Up @@ -749,20 +820,6 @@ class JsonLdParser {
const value = valueArray && valueArray[0];
return (value == null || value === '') ? null : value;
}

/**
* @param {!Object} json
* @param {string} expectedType
* @return {boolean}
*/
checkType_(json, expectedType) {
const typeArray = this.valueArray_(json, '@type');
if (!typeArray) {
return false;
}
return (typeArray.includes(expectedType) ||
typeArray.includes('http://schema.org/' + expectedType));
}
}

class MicrodataParser {
Expand All @@ -776,11 +833,13 @@ class MicrodataParser {
this.access_ = null;
/** @private {?string} */
this.productId_ = null;
/** @private @const @function */
this.checkType_ = new TypeChecker();
}

/**
* Returns false if access is restricted, otherwise true
* @param {!Element} root An element that is an item of type 'NewsArticle'
* @param {!Element} root An element that is an item of type in ALLOWED_TYPES list
* @return {?boolean} locked access
* @private
*/
Expand Down Expand Up @@ -809,7 +868,7 @@ class MicrodataParser {

/**
* Verifies if an element is valid based on the following
* - child of an item of type 'NewsArticle'
* - child of an item of one the the ALLOWED_TYPES
* - not a child of an item of any other type
* - not seen before, marked using the alreadySeen tag
* @param {?Element} current the element to be verified
Expand All @@ -822,25 +881,22 @@ class MicrodataParser {
for (let node = current;
node && !node[alreadySeen]; node = node.parentNode) {
node[alreadySeen] = true;
if (node.hasAttribute('itemscope')) {
// document nodes don't have hasAttribute
if (node.hasAttribute && node.hasAttribute('itemscope')) {
/**{?string} */
const type = node.getAttribute('itemtype');
if (type.indexOf('http://schema.org/NewsArticle') >= 0) {
return true;
} else {
return false;
}
return this.checkType_.checkString(type, ALLOWED_TYPES);
}
}
return false;
}

/**
* Obtains the product ID that meets the requirements
* - child of an item of type 'NewsArticle'
* - child of an item of one of ALLOWED_TYPES
* - Not a child of an item of type 'Section'
* - child of an item of type 'productID'
* @param {!Element} root An element that is an item of type 'NewsArticle'
* @param {!Element} root An element that is an item of an ALLOWED_TYPES
* @return {?string} product ID, if found
* @private
*/
Expand Down Expand Up @@ -890,8 +946,15 @@ class MicrodataParser {
if (config) {
return config;
}
const nodeList = this.doc_.getRootNode().querySelectorAll(
'[itemscope][itemtype*="http://schema.org/NewsArticle"]');

// Grab all the nodes with an itemtype and filter for our allowed types
const nodeList = Array.prototype.slice.call(
this.doc_.getRootNode().querySelectorAll('[itemscope][itemtype]')
).filter(
node => this.checkType_.checkString(
node.getAttribute('itemtype'), ALLOWED_TYPES)
);

for (let i = 0; nodeList[i] && config == null; i++) {
const element = nodeList[i];
if (this.access_ == null) {
Expand Down
6 changes: 3 additions & 3 deletions third_party/subscriptions-project/swg.js
View file
Expand Up @@ -13,7 +13,7 @@
* See the License for the specific language governing permissions and
* limitations under the License.
*/
/** Version: 0.1.22.44 */
/** Version: 0.1.22.45 */
/**
* @license
* Copyright 2017 The Web Activities Authors. All Rights Reserved.
Expand Down Expand Up @@ -1524,7 +1524,7 @@ class ActivityPorts {
*/
constructor(win) {
/** @const {string} */
this.version = '1.21';
this.version = '1.22';

/** @private @const {!Window} */
this.win_ = win;
Expand Down Expand Up @@ -4392,7 +4392,7 @@ function feCached(url) {
*/
function feArgs(args) {
return Object.assign(args, {
'_client': 'SwG 0.1.22.44',
'_client': 'SwG 0.1.22.45',
});
}

Expand Down

0 comments on commit d3a1839

Please sign in to comment.