Skip to content

Fix: Re-enable no-broken-links and ignore rel=nofollow #5994

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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Fix: Re-enable no-broken-links and ignore rel=nofollow #5994

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions packages/configuration-web-recommended/index.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,7 @@
"meta-charset-utf-8",
"meta-viewport",
"no-bom",
"no-broken-links",
"no-disallowed-headers",
"no-friendly-error-pages",
"no-html-only-headers",
Expand Down
10 changes: 10 additions & 0 deletions packages/hint-no-broken-links/src/hint.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -218,6 +218,16 @@ export default class NoBrokenLinksHint implements IHint {
const requests: Promise<void>[] = [];

for (const url of urls) {
// Skip anchor links with rel="nofollow".
if (element.nodeName === 'A') {
const rel = element.getAttribute('rel');

if (rel && rel.toLowerCase().includes('nofollow')) {
debug(`Skipping URL ${url} due to rel="nofollow"`);
continue;
}
}

/*
* If the URL is not HTTP or HTTPS (e.g. `mailto:`),
* there is no need to validate.
Expand Down
76 changes: 76 additions & 0 deletions packages/hint-no-broken-links/tests/tests.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -91,6 +91,30 @@ const bodyWithInvalidDomainPreconnectLinkTag = `<div>
<link rel="preconnect" href="https://invalid.domain/">
</div>`;

// Snippets for nofollow tests
const bodyWithNoFollowBrokenLink = `<div>
<a href='/404' rel='nofollow'>Broken NoFollow</a>
</div>`;

const bodyWithNoFollowValidLink = `<div>
<a href='/valid' rel='nofollow'>Valid NoFollow</a>
</div>`;

const bodyWithNoFollowMultipleRel = `<div>
<a href='/404' rel='noopener nofollow'>Broken NoFollow Multiple</a>
</div>`;

const bodyWithMixedLinks = `<div>
<a href='/404-nofollow' rel='nofollow'>Broken NoFollow</a>
<a href='/404-regular'>Broken Regular</a>
</div>`;

const bodyWithNoFollowAndRegularBroken = `<div>
<a href='/404-anchor' rel='nofollow'>Broken Anchor NoFollow</a>
<img src='/404.png'>
</div>`;


const tests: HintTest[] = [
{
name: `This test should pass as it has links with valid href value`,
Expand Down Expand Up @@ -288,6 +312,58 @@ const tests: HintTest[] = [
}],
serverConfig: generateHTMLPage('', bodyWithInvalidDomainPreconnectLinkTag)
},
// New tests for rel="nofollow"
{
name: `Anchor with rel="nofollow" pointing to a 404 should not report an error`,
serverConfig: {
'/': { content: generateHTMLPage('', bodyWithNoFollowBrokenLink) },
'/404': { status: 404 }
}
// No reports expected
},
{
name: `Anchor with rel="nofollow" pointing to a valid resource should not report an error`,
serverConfig: {
'/': { content: generateHTMLPage('', bodyWithNoFollowValidLink) },
'/valid': { content: 'Valid page' }
}
// No reports expected
},
{
name: `Anchor with multiple rel values including "nofollow" pointing to a 404 should not report an error`,
serverConfig: {
'/': { content: generateHTMLPage('', bodyWithNoFollowMultipleRel) },
'/404': { status: 404 }
}
// No reports expected
},
{
name: `Mixed content: Regular broken link should report, nofollow broken link should not`,
reports: [{
message: `Broken link found (404 response).`,
severity: Severity.error,
location: { column: 50, line: 2 } // Location of the regular link
}],
serverConfig: {
'/': { content: generateHTMLPage('', bodyWithMixedLinks) },
'/404-nofollow': { status: 404 },
'/404-regular': { status: 404 }
}
},
{
name: `Mixed content: Broken image should report, nofollow broken anchor should not`,
reports: [{
message: `Broken link found (404 response).`,
severity: Severity.error,
location: { column: 8, line: 3 } // Location of the image tag
}],
serverConfig: {
'/': { content: generateHTMLPage('', bodyWithNoFollowAndRegularBroken) },
'/404-anchor': { status: 404 },
'/404.png': { status: 404 }
}
},
// End of new tests for rel="nofollow"
{
name: `This test should fail as it has a loop`,
reports: [
Expand Down
Loading