googlechrome
/
lighthouse
зеркало из https://github.com/GoogleChrome/lighthouse.git
1
0
Форкнуть 0
Код Задачи Пакеты Проекты Релизы Вики Активность

new_audit(hreflang): document has a valid hreflang code (#3815)

This commit is contained in:
Konrad Dzwinel 2017-11-29 03:18:28 +01:00 коммит произвёл Paul Irish
Родитель e4248c26c2
Коммит 6910f5d2f6
11 изменённых файлов: 359 добавлений и 5 удалений
Показать статистику Скачать Patch файл Скачать Diff файл Показать все файлы Свернуть все файлы

4
lighthouse-cli/test/fixtures/seo/seo-failure-cases.html поставляемый
Просмотреть файл

@ -12,6 +12,10 @@
<meta name="viewport" content="invalid-content=should_have_looked_it_up">
<!-- no <meta name="description" content=""> -->
<meta name="robots" content="nofollow, NOINDEX, all">
<!-- FAIL(hreflang): invalid language code -->
<link rel="alternate" hreflang="xx" href="https://xx.example.com" />
<!-- FAIL(hreflang): spece before a valid code -->
<link rel="alternate" href="http://example.com/" hreflang=" x-default" />
</head>
<body>
<h1>SEO</h1>

6
lighthouse-cli/test/fixtures/seo/seo-tester.html поставляемый
Просмотреть файл

@ -11,6 +11,12 @@
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0, minimum-scale=1.0">
<meta name="Description" content="The premiere destination for testing your SEO audit gathering">
<!-- PASS(hreflang): valid language codes -->
<link rel="alternate" hreflang="es" href="https://lat.example.com" />
<link rel="alternate" Hreflang="en-PH" href="https://ph.example.com" />
<LINK REL="ALTERNATE" HREFLANG="ru-RU" HREF="https://ru.example.com" />
<LINK REL="alternate" HREFLANG="zh-Hans-TW" HREF="https://zh.example.com" />
<link rel="alternate" href="http://example.com/" hreflang="x-default" />
</head>
<body>
<h1>SEO</h1>

2
lighthouse-cli/test/fixtures/static-server.js поставляемый
Просмотреть файл

@ -12,7 +12,7 @@ const path = require('path');
const fs = require('fs');
const parseQueryString = require('querystring').parse;
const parseURL = require('url').parse;
const HEADER_SAFELIST = new Set(['x-robots-tag']);
const HEADER_SAFELIST = new Set(['x-robots-tag', 'link']);
const lhRootDirPath = path.join(__dirname, '../../../');

34
lighthouse-cli/test/smokehouse/seo/expectations.js
Просмотреть файл

@ -4,14 +4,29 @@
* 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 BASE_URL = 'http://localhost:10200/seo/';
function headersParam(headers) {
return headers
.map(({name, value}) => `extra_header=${name}:${encodeURI(value)}`)
.join('&');
}
const failureHeaders = headersParam([{
name: 'x-robots-tag',
value: 'none',
}, {
name: 'link',
value: '<http://example.com>;rel="alternate";hreflang="xx"',
}]);
/**
* Expected Lighthouse audit values for seo tests
*/
module.exports = [
{
initialUrl: 'http://localhost:10200/seo/seo-tester.html',
url: 'http://localhost:10200/seo/seo-tester.html',
initialUrl: BASE_URL + 'seo-tester.html',
url: BASE_URL + 'seo-tester.html',
audits: {
'viewport': {
score: true,
@ -31,11 +46,14 @@ module.exports = [
'is-crawlable': {
score: true,
},
'hreflang': {
score: true,
},
},
},
{
initialUrl: 'http://localhost:10200/seo/seo-failure-cases.html?status_code=403&extra_header=x-robots-tag:none',
url: 'http://localhost:10200/seo/seo-failure-cases.html?status_code=403&extra_header=x-robots-tag:none',
initialUrl: BASE_URL + 'seo-failure-cases.html?status_code=403&' + failureHeaders,
url: BASE_URL + 'seo-failure-cases.html?status_code=403&' + failureHeaders,
audits: {
'viewport': {
score: false,
@ -72,6 +90,14 @@ module.exports = [
},
},
},
'hreflang': {
score: false,
details: {
items: {
length: 3,
},
},
},
},
},
];

112
lighthouse-core/audits/seo/hreflang.js Normal file
Просмотреть файл

@ -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;

2
lighthouse-core/config/default.js
Просмотреть файл

@ -39,6 +39,7 @@ module.exports = {
'seo/meta-description',
'seo/crawlable-links',
'seo/meta-robots',
'seo/hreflang',
],
},
{
@ -165,6 +166,7 @@ module.exports = {
'seo/http-status-code',
'seo/link-text',
'seo/is-crawlable',
'seo/hreflang',
],
groups: {

3
lighthouse-core/config/seo.js
Просмотреть файл

@ -13,6 +13,7 @@ module.exports = {
'seo/meta-description',
'seo/crawlable-links',
'seo/meta-robots',
'seo/hreflang',
],
}],
audits: [
@ -20,6 +21,7 @@ module.exports = {
'seo/http-status-code',
'seo/link-text',
'seo/is-crawlable',
'seo/hreflang',
],
groups: {
'seo-mobile': {
@ -47,6 +49,7 @@ module.exports = {
{id: 'http-status-code', weight: 1, group: 'seo-crawl'},
{id: 'link-text', weight: 1, group: 'seo-content'},
{id: 'is-crawlable', weight: 1, group: 'seo-crawl'},
{id: 'hreflang', weight: 1, group: 'seo-content'},
],
},
},

32
lighthouse-core/gather/gatherers/seo/hreflang.js Normal file
Просмотреть файл

@ -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;

164
lighthouse-core/test/audits/seo/hreflang.js Normal file
Просмотреть файл

@ -0,0 +1,164 @@
/**
* @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 HreflangAudit = require('../../../audits/seo/hreflang.js');
const assert = require('assert');
/* eslint-env mocha */
describe('SEO: Document has valid hreflang code', () => {
it('fails when language code provided in hreflang via link element is invalid', () => {
const hreflangValues = [
'xx',
'XX-be',
'XX-be-Hans',
'',
' es',
];
const allRuns = hreflangValues.map(hreflangValue => {
const mainResource = {
responseHeaders: [],
};
const artifacts = {
devtoolsLogs: {[HreflangAudit.DEFAULT_PASS]: []},
requestMainResource: () => Promise.resolve(mainResource),
Hreflang: [{
hreflang: hreflangValue,
href: 'https://example.com',
}],
};
return HreflangAudit.audit(artifacts).then(auditResult => {
assert.equal(auditResult.rawValue, false);
assert.equal(auditResult.details.items.length, 1);
});
});
return Promise.all(allRuns);
});
it('succeeds when language code provided via link element is valid', () => {
const mainResource = {
responseHeaders: [],
};
const artifacts = {
devtoolsLogs: {[HreflangAudit.DEFAULT_PASS]: []},
requestMainResource: () => Promise.resolve(mainResource),
Hreflang: [
{hreflang: 'pl'},
{hreflang: 'nl-be'},
{hreflang: 'zh-Hans'},
{hreflang: 'x-default'},
{hreflang: 'FR-BE'},
],
};
return HreflangAudit.audit(artifacts).then(auditResult => {
assert.equal(auditResult.rawValue, true);
});
});
it('succeeds when there are no rel=alternate link elements nor headers', () => {
const mainResource = {
responseHeaders: [],
};
const artifacts = {
devtoolsLogs: {[HreflangAudit.DEFAULT_PASS]: []},
requestMainResource: () => Promise.resolve(mainResource),
Hreflang: [],
};
return HreflangAudit.audit(artifacts).then(auditResult => {
assert.equal(auditResult.rawValue, true);
});
});
it('fails when language code provided in hreflang via header is invalid', () => {
const linkHeaders = [
[
{name: 'Link', value: '<http://es.example.com/>; rel="alternate"; hreflang="xx"'},
],
[
{name: 'link', value: '<http://es.example.com/>; rel="alternate"; hreflang=""'},
],
[
{name: 'LINK', value: '<http://es.example.com/>; rel="alternate"'},
],
[
{name: 'Link', value: '<http://es.example.com/>; rel="alternate"; hreflang="es",<http://xx.example.com/>; rel="alternate"; Hreflang="xx"'},
],
[
{name: 'link', value: '<http://es.example.com/>; rel="alternate"; hreflang="es"'},
{name: 'Link', value: '<http://xx.example.com/>; rel="alternate"; hreflang="x"'},
],
];
const allRuns = linkHeaders.map(headers => {
const mainResource = {
responseHeaders: headers,
};
const artifacts = {
devtoolsLogs: {[HreflangAudit.DEFAULT_PASS]: []},
requestMainResource: () => Promise.resolve(mainResource),
Hreflang: null,
};
return HreflangAudit.audit(artifacts).then(auditResult => {
assert.equal(auditResult.rawValue, false);
assert.equal(auditResult.details.items.length, 1);
});
});
return Promise.all(allRuns);
});
it('succeeds when language codes provided via Link header are valid', () => {
const mainResource = {
responseHeaders: [
{name: 'link', value: ''},
{name: 'link', value: 'garbage'},
{name: 'link', value: '<http://es.example.com/>; rel="example"; hreflang="xx"'},
{name: 'link', value: '<http://es.example.com/>; rel="alternate"; hreflang="es"'},
{name: 'Link', value: '<http://fr.example.com/>; rel="alternate"; hreflang="fr-be"'},
{name: 'LINK', value: '<http://es.example.com/>; rel="alternate"; hreflang="es",<http://fr.example.com/>; rel="alternate"; Hreflang="fr-be"'},
],
};
const artifacts = {
devtoolsLogs: {[HreflangAudit.DEFAULT_PASS]: []},
requestMainResource: () => Promise.resolve(mainResource),
Hreflang: null,
};
return HreflangAudit.audit(artifacts).then(auditResult => {
assert.equal(auditResult.rawValue, true);
});
});
it('returns all failing items', () => {
const mainResource = {
responseHeaders: [
{name: 'link', value: '<http://xx1.example.com/>; rel="alternate"; hreflang="xx1"'},
{name: 'Link', value: '<http://xx2.example.com/>; rel="alternate"; hreflang="xx2"'},
],
};
const artifacts = {
devtoolsLogs: {[HreflangAudit.DEFAULT_PASS]: []},
requestMainResource: () => Promise.resolve(mainResource),
Hreflang: [{
hreflang: 'xx3',
}, {
hreflang: 'xx4',
}],
};
return HreflangAudit.audit(artifacts).then(auditResult => {
assert.equal(auditResult.rawValue, false);
assert.equal(auditResult.details.items.length, 4);
});
});
});

1
package.json
Просмотреть файл

@ -81,6 +81,7 @@
"chrome-launcher": "0.8.1",
"configstore": "^3.1.1",
"devtools-timeline-model": "1.1.6",
"http-link-header": "^0.8.0",
"inquirer": "^3.3.0",
"jpeg-js": "0.1.2",
"js-library-detector": "^4.0.0",

4
yarn.lock
Просмотреть файл

@ -2028,6 +2028,10 @@ html-encoding-sniffer@^1.0.1:
dependencies:
whatwg-encoding "^1.0.1"
http-link-header@^0.8.0:
version "0.8.0"
resolved "https://registry.npmjs.org/http-link-header/-/http-link-header-0.8.0.tgz#a22b41a0c9b1e2d8fac1bf1b697c6bd532d5f5e4"
http-signature@~1.1.0:
version "1.1.1"
resolved "https://registry.yarnpkg.com/http-signature/-/http-signature-1.1.1.tgz#df72e267066cd0ac67fb76adf8e134a8fbcf91bf"