-
Notifications
You must be signed in to change notification settings - Fork 13
fix(cwv): filter out 4xx URLs from CWV opportunities (SITES-40803) #2034
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.
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
tathagat2241
wants to merge
2
commits into
main
Choose a base branch
from
cwv-filter-4xx-urls
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+233
−5
Open
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or 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 hidden or 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 hidden or 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 hidden or 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,138 @@ | ||
| /* | ||
| * Copyright 2025 Adobe. All rights reserved. | ||
| * This file is licensed to you 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 REPRESENTATIONS | ||
| * OF ANY KIND, either express or implied. See the License for the specific language | ||
| * governing permissions and limitations under the License. | ||
| */ | ||
|
|
||
| /* eslint-env mocha */ | ||
|
|
||
| import { expect } from 'chai'; | ||
| import sinon from 'sinon'; | ||
| import esmock from 'esmock'; | ||
| import { buildCWVAuditResult, isUrl4xxOrFailed } from '../../../src/cwv/cwv-audit-result.js'; | ||
|
|
||
| describe('CWV Audit Result', () => { | ||
| const sandbox = sinon.createSandbox(); | ||
| let fetchStub; | ||
| let log; | ||
|
|
||
| beforeEach(() => { | ||
| log = { | ||
| info: sandbox.stub(), | ||
| debug: sandbox.stub(), | ||
| warn: sandbox.stub(), | ||
| error: sandbox.stub(), | ||
| }; | ||
| fetchStub = sandbox.stub(globalThis, 'fetch'); | ||
| }); | ||
|
|
||
| afterEach(() => { | ||
| sandbox.restore(); | ||
| }); | ||
|
|
||
| describe('isUrl4xxOrFailed', () => { | ||
| it('returns true when response status is 404', async () => { | ||
| fetchStub.resolves({ status: 404 }); | ||
| const result = await isUrl4xxOrFailed('https://example.com/404', log); | ||
| expect(result).to.be.true; | ||
| expect(fetchStub.calledOnceWith('https://example.com/404', sinon.match.has('method', 'HEAD'))).to.be.true; | ||
| }); | ||
|
|
||
| it('returns true when response status is 403', async () => { | ||
| fetchStub.resolves({ status: 403 }); | ||
| const result = await isUrl4xxOrFailed('https://example.com/forbidden', log); | ||
| expect(result).to.be.true; | ||
| }); | ||
|
|
||
| it('returns true when response status is 410', async () => { | ||
| fetchStub.resolves({ status: 410 }); | ||
| const result = await isUrl4xxOrFailed('https://example.com/gone', log); | ||
| expect(result).to.be.true; | ||
| }); | ||
|
|
||
| it('returns false when response status is 200', async () => { | ||
| fetchStub.resolves({ status: 200 }); | ||
| const result = await isUrl4xxOrFailed('https://example.com/ok', log); | ||
| expect(result).to.be.false; | ||
| }); | ||
|
|
||
| it('returns false when response status is 500 (5xx not 4xx)', async () => { | ||
| fetchStub.resolves({ status: 500 }); | ||
| const result = await isUrl4xxOrFailed('https://example.com/error', log); | ||
| expect(result).to.be.false; | ||
| }); | ||
|
|
||
| it('returns true when fetch throws (e.g. timeout)', async () => { | ||
| fetchStub.rejects(new Error('network error')); | ||
| const result = await isUrl4xxOrFailed('https://example.com/timeout', log); | ||
| expect(result).to.be.true; | ||
| }); | ||
| }); | ||
|
|
||
| describe('buildCWVAuditResult', () => { | ||
| it('excludes URL entries that return 4xx from audit result', async () => { | ||
| const cwvDataFromRum = [ | ||
| { type: 'url', url: 'https://www.lexmark.com/ok', pageviews: 10000, organic: 5000, metrics: [] }, | ||
| { type: 'url', url: 'https://www.lexmark.com/etc.clientlibs/bad', pageviews: 8000, organic: 4000, metrics: [] }, | ||
| ]; | ||
| const mockRumClient = { query: sandbox.stub().resolves(cwvDataFromRum) }; | ||
| const mockRumClientClass = { createFrom: sandbox.stub().returns(mockRumClient) }; | ||
|
|
||
| fetchStub | ||
| .onFirstCall().resolves({ status: 200 }) | ||
| .onSecondCall().resolves({ status: 404 }); | ||
|
|
||
| const { buildCWVAuditResult: build } = await esmock('../../../src/cwv/cwv-audit-result.js', { | ||
| '@adobe/spacecat-shared-rum-api-client': { default: mockRumClientClass }, | ||
| }); | ||
|
|
||
| const site = { | ||
| getId: () => 'site-1', | ||
| getBaseURL: () => 'https://www.lexmark.com', | ||
| getConfig: () => ({ getGroupedURLs: () => [] }), | ||
| }; | ||
| const context = { site, finalUrl: 'www.lexmark.com', log, env: {} }; | ||
|
|
||
| const result = await build(context); | ||
|
|
||
| const cwvUrls = result.auditResult.cwv.filter((e) => e.type === 'url').map((e) => e.url); | ||
| expect(cwvUrls).to.include('https://www.lexmark.com/ok'); | ||
| expect(cwvUrls).to.not.include('https://www.lexmark.com/etc.clientlibs/bad'); | ||
| expect(result.auditResult.cwv).to.have.length(1); | ||
| }); | ||
|
|
||
| it('keeps group entries without HEAD check', async () => { | ||
| const cwvDataFromRum = [ | ||
| { type: 'url', url: 'https://www.example.com/', pageviews: 10000, organic: 5000, metrics: [] }, | ||
| { type: 'group', pattern: '/some/*', name: 'Some pages', pageviews: 5000, organic: 3000, metrics: [] }, | ||
| ]; | ||
| const mockRumClient = { query: sandbox.stub().resolves(cwvDataFromRum) }; | ||
| const mockRumClientClass = { createFrom: sandbox.stub().returns(mockRumClient) }; | ||
|
|
||
| fetchStub.resolves({ status: 200 }); | ||
|
|
||
| const { buildCWVAuditResult: build } = await esmock('../../../src/cwv/cwv-audit-result.js', { | ||
| '@adobe/spacecat-shared-rum-api-client': { default: mockRumClientClass }, | ||
| }); | ||
|
|
||
| const site = { | ||
| getId: () => 'site-1', | ||
| getBaseURL: () => 'https://www.example.com', | ||
| getConfig: () => ({ getGroupedURLs: () => [] }), | ||
| }; | ||
| const context = { site, finalUrl: 'www.example.com', log, env: {} }; | ||
|
|
||
| const result = await build(context); | ||
|
|
||
| expect(result.auditResult.cwv).to.have.length(2); | ||
| expect(result.auditResult.cwv.find((e) => e.type === 'group')).to.exist; | ||
| expect(fetchStub.callCount).to.equal(1); | ||
| }); | ||
| }); | ||
| }); |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I wonder if we should maybe centralize the user agents we use somewhere so everybody uses the same one.
I also noticed that the internal links also use a HEAD request approach to validate links:
spacecat-audit-worker/src/internal-links/helpers.js
Line 100 in 20a8470
Maybe worth thinking about creating a more centralized helper for both actually to avoid code duplication