From f3347be928fa27fbfa5df2bb721b6ff10ee4f3dd Mon Sep 17 00:00:00 2001 From: Umar Hansa Date: Wed, 29 Apr 2020 00:09:23 +0100 Subject: [PATCH] new_audit(anchor-href): adds anchor-href audit --- .../test/cli/__snapshots__/index-test.js.snap | 8 ++ lighthouse-core/audits/seo/anchor-href.js | 86 +++++++++++++++++++ lighthouse-core/config/default-config.js | 2 + .../gather/gatherers/anchor-elements.js | 2 + .../test/audits/seo/anchor-href-test.js | 44 ++++++++++ lighthouse-core/test/results/sample_v2.json | 83 +++++++++++++++++- types/artifacts.d.ts | 1 + 7 files changed, 225 insertions(+), 1 deletion(-) create mode 100644 lighthouse-core/audits/seo/anchor-href.js create mode 100644 lighthouse-core/test/audits/seo/anchor-href-test.js diff --git a/lighthouse-cli/test/cli/__snapshots__/index-test.js.snap b/lighthouse-cli/test/cli/__snapshots__/index-test.js.snap index e106723d1b59..be5a56018aad 100644 --- a/lighthouse-cli/test/cli/__snapshots__/index-test.js.snap +++ b/lighthouse-cli/test/cli/__snapshots__/index-test.js.snap @@ -402,6 +402,9 @@ Object { Object { "path": "seo/link-text", }, + Object { + "path": "seo/anchor-href", + }, Object { "path": "seo/is-crawlable", }, @@ -1084,6 +1087,11 @@ Object { "id": "link-text", "weight": 1, }, + Object { + "group": "seo-crawl", + "id": "anchor-href", + "weight": 1, + }, Object { "group": "seo-crawl", "id": "is-crawlable", diff --git a/lighthouse-core/audits/seo/anchor-href.js b/lighthouse-core/audits/seo/anchor-href.js new file mode 100644 index 000000000000..f8958f160b14 --- /dev/null +++ b/lighthouse-core/audits/seo/anchor-href.js @@ -0,0 +1,86 @@ +/** + * @license Copyright 2020 The Lighthouse Authors. 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.js'); +const i18n = require('../../lib/i18n/i18n.js'); + +const UIStrings = { + /** Title of a Lighthouse audit that provides detail on whether anchors have hyperlinks which can be crawled by search engines. This descriptive title is shown when all hyperlinks on the page are crawlable. */ + title: 'Anchors have crawlable hyperlinks', + /** Descriptive title of a Lighthouse audit that provides detail on whether anchors have hyperlinks which can be crawled by search engines. This descriptive title is shown when there are hyperlinks which are not crawlable by search engines. */ + failureTitle: 'Anchors do not have crawlable hyperlinks', + /** Description of a Lighthouse audit that tells the user why hyperlinks should be crawlable. This is displayed after a user expands the section to see more. 'Learn More' becomes link text to additional documentation. */ + description: 'Search engines use hyperlinks to crawl websites', + /** Label for a column in a data table; entries will be the HTML anchor elements that failed the audit. Anchors are DOM elements that are links. */ + columnFailingAnchors: 'Failing Anchor Elements', +}; + +const str_ = i18n.createMessageInstanceIdFn(__filename, UIStrings); + +class AnchorHref extends Audit { + /** + * @return {LH.Audit.Meta} + */ + static get meta() { + return { + id: 'anchor-href', + title: str_(UIStrings.title), + failureTitle: str_(UIStrings.failureTitle), + description: str_(UIStrings.description), + requiredArtifacts: ['AnchorElements'], + }; + } + + /** + * @param {LH.Artifacts} artifacts + * @return {LH.Audit.Product} + */ + static audit({AnchorElements: anchorElements}) { + const failingAnchorHrefs = anchorElements.filter(({rawHref}) => { + if (!rawHref) { + return true; + } + + if (rawHref === '#') { + return true; + } + + if (rawHref.startsWith('javascript:')) { + return true; + } + + if (rawHref.startsWith('file:')) { + return true; + } + }); + + /** @type {LH.Audit.Details.Table['headings']} */ + const headings = [{ + key: 'node', + itemType: 'node', + text: str_(UIStrings.columnFailingAnchors), + }]; + + /** @type {LH.Audit.Details.Table['items']} */ + const itemsToDisplay = failingAnchorHrefs.map(node => { + return { + node: { + type: 'node', + snippet: node.outerHTML + node.text, + }, + }; + }); + + return { + score: Number(failingAnchorHrefs.length === 0), + details: Audit.makeTableDetails(headings, itemsToDisplay), + }; + } +} + +module.exports = AnchorHref; +module.exports.UIStrings = UIStrings; diff --git a/lighthouse-core/config/default-config.js b/lighthouse-core/config/default-config.js index b1f282c1c36e..eb987da7bdba 100644 --- a/lighthouse-core/config/default-config.js +++ b/lighthouse-core/config/default-config.js @@ -306,6 +306,7 @@ const defaultConfig = { 'seo/http-status-code', 'seo/font-size', 'seo/link-text', + 'seo/anchor-href', 'seo/is-crawlable', 'seo/robots-txt', 'seo/tap-targets', @@ -534,6 +535,7 @@ const defaultConfig = { {id: 'meta-description', weight: 1, group: 'seo-content'}, {id: 'http-status-code', weight: 1, group: 'seo-crawl'}, {id: 'link-text', weight: 1, group: 'seo-content'}, + {id: 'anchor-href', weight: 1, group: 'seo-crawl'}, {id: 'is-crawlable', weight: 1, group: 'seo-crawl'}, {id: 'robots-txt', weight: 1, group: 'seo-crawl'}, {id: 'image-alt', weight: 1, group: 'seo-content'}, diff --git a/lighthouse-core/gather/gatherers/anchor-elements.js b/lighthouse-core/gather/gatherers/anchor-elements.js index 21caa97eefa5..8df1c281707f 100644 --- a/lighthouse-core/gather/gatherers/anchor-elements.js +++ b/lighthouse-core/gather/gatherers/anchor-elements.js @@ -47,6 +47,7 @@ function collectAnchorElements() { if (node instanceof HTMLAnchorElement) { return { href: node.href, + rawHref: node.getAttribute('href') || '', text: node.innerText, // we don't want to return hidden text, so use innerText rel: node.rel, target: node.target, @@ -59,6 +60,7 @@ function collectAnchorElements() { return { href: resolveURLOrEmpty(node.href.baseVal), + rawHref: node.getAttribute('href') || '', text: node.textContent || '', rel: '', target: node.target.baseVal || '', diff --git a/lighthouse-core/test/audits/seo/anchor-href-test.js b/lighthouse-core/test/audits/seo/anchor-href-test.js new file mode 100644 index 000000000000..2f8ed345cd01 --- /dev/null +++ b/lighthouse-core/test/audits/seo/anchor-href-test.js @@ -0,0 +1,44 @@ +/** + * @license Copyright 2020 The Lighthouse Authors. 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 AnchorHrefAudit = require('../../../audits/seo/anchor-href.js'); +const assert = require('assert'); + +/* eslint-env jest */ + +function runAudit(rawHref) { + const {score} = AnchorHrefAudit.audit({ + AnchorElements: [{ + rawHref, + }], + }); + + return score; +} + +describe('SEO: Anchor Href audit', () => { + it('allows crawlable hrefs', () => { + assert.equal(runAudit('#top'), 1, 'hash fragment identifier'); + assert.equal(runAudit('mailto:name@example.com'), 1, 'email link with a mailto URI'); + assert.equal(runAudit('https://example.com'), 1, 'absolute HTTPs URL'); + assert.equal(runAudit('foo'), 1, 'relative URL'); + assert.equal(runAudit('/foo'), 1, 'relative URL'); + assert.equal(runAudit('#:~:text=string'), 1, 'hyperlink with a text fragment'); + assert.equal(runAudit('ftp://myname@host.dom'), 1, 'an FTP hyperlink'); + assert.equal(runAudit('http://172.217.20.78'), 1, 'IP address based link'); + assert.equal(runAudit('//example.com'), 1, 'protocol relative link'); + assert.equal(runAudit('?query=string'), 1, 'relative link which specifies a query string'); + assert.equal(runAudit('tel:5555555'), 1, 'email link with a tel URI'); + }); + + it('disallows uncrawlable hrefs', () => { + assert.equal(runAudit(''), 0, 'link empty quotes for the href attribute'); + assert.equal(runAudit('#'), 0, 'link with only a hash symbol'); + assert.equal(runAudit('javascript:void(0)'), 0, 'hyperlink with a javascript URI'); + assert.equal(runAudit('file:///image.png'), 0, 'hyperlink with a javascript URI'); + }); +}); diff --git a/lighthouse-core/test/results/sample_v2.json b/lighthouse-core/test/results/sample_v2.json index a1c2b25cd9f4..bf79ae786992 100644 --- a/lighthouse-core/test/results/sample_v2.json +++ b/lighthouse-core/test/results/sample_v2.json @@ -3449,6 +3449,67 @@ "summary": {} } }, + "anchor-href": { + "id": "anchor-href", + "title": "Anchors do not have crawlable hyperlinks", + "description": "Search engines use hyperlinks to crawl websites", + "score": 0, + "scoreDisplayMode": "binary", + "details": { + "type": "table", + "headings": [ + { + "key": "node", + "itemType": "node", + "text": "Failing Anchor Elements" + } + ], + "items": [ + { + "node": { + "type": "node", + "snippet": "Helloexternal link" + } + }, + { + "node": { + "type": "node", + "snippet": "HelloHello" + } + }, + { + "node": { + "type": "node", + "snippet": "Helloexternal link that uses noopener" + } + }, + { + "node": { + "type": "node", + "snippet": "Helloexternal link that uses nofollow" + } + }, + { + "node": { + "type": "node", + "snippet": "undefinedinternal link is ok" + } + }, + { + "node": { + "type": "node", + "snippet": "undefined" + } + }, + { + "node": { + "type": "node", + "snippet": "undefined" + } + } + ] + } + }, "is-crawlable": { "id": "is-crawlable", "title": "Page isn’t blocked from indexing", @@ -4272,6 +4333,11 @@ "weight": 1, "group": "seo-content" }, + { + "id": "anchor-href", + "weight": 1, + "group": "seo-crawl" + }, { "id": "is-crawlable", "weight": 1, @@ -4318,7 +4384,7 @@ } ], "id": "seo", - "score": 0.73 + "score": 0.67 }, "pwa": { "title": "Progressive Web App", @@ -5528,6 +5594,12 @@ "duration": 100, "entryType": "measure" }, + { + "startTime": 0, + "name": "lh:audit:anchor-href", + "duration": 100, + "entryType": "measure" + }, { "startTime": 0, "name": "lh:audit:is-crawlable", @@ -6784,6 +6856,15 @@ "lighthouse-core/audits/seo/link-text.js | description": [ "audits[link-text].description" ], + "lighthouse-core/audits/seo/anchor-href.js | failureTitle": [ + "audits[anchor-href].title" + ], + "lighthouse-core/audits/seo/anchor-href.js | description": [ + "audits[anchor-href].description" + ], + "lighthouse-core/audits/seo/anchor-href.js | columnFailingAnchors": [ + "audits[anchor-href].details.headings[0].text" + ], "lighthouse-core/audits/seo/is-crawlable.js | title": [ "audits[is-crawlable].title" ], diff --git a/types/artifacts.d.ts b/types/artifacts.d.ts index 6a4b8394c5c4..8f0fc1c23020 100644 --- a/types/artifacts.d.ts +++ b/types/artifacts.d.ts @@ -317,6 +317,7 @@ declare global { export interface AnchorElement { rel: string href: string + rawHref: string text: string target: string devtoolsNodePath: string