-
Notifications
You must be signed in to change notification settings - Fork 9.4k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
new_audit(hreflang): document has a valid hreflang code (#3815)
- Loading branch information
Showing
11 changed files
with
359 additions
and
5 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,112 @@ | ||
| /** | ||
| * @license Copyright 2017 Google Inc. All Rights Reserved. | ||
| * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 | ||
| * Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. | ||
| */ | ||
| 'use strict'; | ||
|
|
||
| const Audit = require('../audit'); | ||
| const LinkHeader = require('http-link-header'); | ||
| const VALID_LANGS = importValidLangs(); | ||
| const LINK_HEADER = 'link'; | ||
| const NO_LANGUAGE = 'x-default'; | ||
|
|
||
| /** | ||
| * Import list of valid languages from axe core without including whole axe-core package | ||
| * This is a huge array of language codes that can be stored more efficiently if we will need to | ||
| * shrink the bundle size. | ||
| */ | ||
| function importValidLangs() { | ||
| const axeCache = global.axe; | ||
| global.axe = {utils: {}}; | ||
| require('axe-core/lib/commons/utils/valid-langs.js'); | ||
| const validLangs = global.axe.utils.validLangs(); | ||
| global.axe = axeCache; | ||
|
|
||
| return validLangs; | ||
| } | ||
|
|
||
| /** | ||
| * @param {string} hreflang | ||
| * @returns {boolean} | ||
| */ | ||
| function isValidHreflang(hreflang) { | ||
| if (hreflang.toLowerCase() === NO_LANGUAGE) { | ||
| return true; | ||
| } | ||
|
|
||
| // hreflang can consist of language-script-region, we are validating only language | ||
| const [lang] = hreflang.split('-'); | ||
| return VALID_LANGS.includes(lang.toLowerCase()); | ||
| } | ||
|
|
||
| /** | ||
| * @param {string} headerValue | ||
| * @returns {boolean} | ||
| */ | ||
| function headerHasValidHreflangs(headerValue) { | ||
| const linkHeader = LinkHeader.parse(headerValue); | ||
|
|
||
| return linkHeader.get('rel', 'alternate') | ||
| .every(link => link.hreflang && isValidHreflang(link.hreflang)); | ||
| } | ||
|
|
||
| class Hreflang extends Audit { | ||
| /** | ||
| * @return {!AuditMeta} | ||
| */ | ||
| static get meta() { | ||
| return { | ||
| name: 'hreflang', | ||
| description: 'Document has a valid `hreflang`', | ||
| failureDescription: 'Document doesn\'t have a valid `hreflang`', | ||
| helpText: 'hreflang allows crawlers to discover alternate translations of the ' + | ||
| 'page content. [Learn more]' + | ||
| '(https://support.google.com/webmasters/answer/189077).', | ||
| requiredArtifacts: ['Hreflang'], | ||
| }; | ||
| } | ||
|
|
||
| /** | ||
| * @param {!Artifacts} artifacts | ||
| * @return {!AuditResult} | ||
| */ | ||
| static audit(artifacts) { | ||
| const devtoolsLogs = artifacts.devtoolsLogs[Audit.DEFAULT_PASS]; | ||
|
|
||
| return artifacts.requestMainResource(devtoolsLogs) | ||
| .then(mainResource => { | ||
| /** @type {Array<{source: string|{type: string, snippet: string}}>} */ | ||
| const invalidHreflangs = []; | ||
|
|
||
| if (artifacts.Hreflang) { | ||
| artifacts.Hreflang.forEach(({href, hreflang}) => { | ||
| if (!isValidHreflang(hreflang)) { | ||
| invalidHreflangs.push({ | ||
| source: { | ||
| type: 'node', | ||
| snippet: `<link name="alternate" hreflang="${hreflang}" href="${href}" />`, | ||
| }, | ||
| }); | ||
| } | ||
| }); | ||
| } | ||
|
|
||
| mainResource.responseHeaders | ||
| .filter(h => h.name.toLowerCase() === LINK_HEADER && !headerHasValidHreflangs(h.value)) | ||
| .forEach(h => invalidHreflangs.push({source: `${h.name}: ${h.value}`})); | ||
|
|
||
| const headings = [ | ||
| {key: 'source', itemType: 'code', text: 'Source'}, | ||
| ]; | ||
| const details = Audit.makeTableDetails(headings, invalidHreflangs); | ||
|
|
||
| return { | ||
| rawValue: invalidHreflangs.length === 0, | ||
| details, | ||
| }; | ||
| }); | ||
| } | ||
| } | ||
|
|
||
| module.exports = Hreflang; |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,32 @@ | ||
| /** | ||
| * @license Copyright 2017 Google Inc. All Rights Reserved. | ||
| * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 | ||
| * Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. | ||
| */ | ||
| 'use strict'; | ||
|
|
||
| const Gatherer = require('../gatherer'); | ||
|
|
||
| class Hreflang extends Gatherer { | ||
| /** | ||
| * @param {{driver: !Object}} options Run options | ||
| * @return {!Promise<!Array<{href: string, hreflang: string}>>} Array with hreflang and href values of all link[rel=alternate] nodes found in HEAD | ||
| */ | ||
| afterPass(options) { | ||
| const driver = options.driver; | ||
|
|
||
| return driver.querySelectorAll('head link[rel="alternate" i][hreflang]') | ||
| .then(nodes => Promise.all(nodes.map(node => | ||
| Promise.all([node.getAttribute('href'), node.getAttribute('hreflang')])) | ||
| ) | ||
| ).then(attributeValues => attributeValues && | ||
| attributeValues.map(values => { | ||
| const [href, hreflang] = values; | ||
| return {href, hreflang}; | ||
| }) | ||
| ); | ||
| } | ||
| } | ||
|
|
||
| module.exports = Hreflang; | ||
|
|
Oops, something went wrong.