Skip to content
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

core(inspector-issues): update sameSiteCookie to cookie #13708

Merged
merged 2 commits into from
Feb 28, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
12 changes: 6 additions & 6 deletions lighthouse-core/audits/dobetterweb/inspector-issues.js
Original file line number Diff line number Diff line change
Expand Up @@ -71,19 +71,19 @@ class IssuesPanelEntries extends Audit {
}

/**
* @param {Array<LH.Crdp.Audits.SameSiteCookieIssueDetails>} sameSiteCookieIssues
* @param {Array<LH.Crdp.Audits.CookieIssueDetails>} CookieIssues
* @return {LH.Audit.Details.TableItem}
*/
static getSameSiteCookieRow(sameSiteCookieIssues) {
static getCookieRow(CookieIssues) {
const requestUrls = new Set();
for (const issue of sameSiteCookieIssues) {
for (const issue of CookieIssues) {
const requestUrl = (issue.request?.url) || issue.cookieUrl;
if (requestUrl) {
requestUrls.add(requestUrl);
}
}
return {
issueType: 'SameSite cookie',
issueType: 'Cookie',
subItems: {
type: 'subitems',
items: Array.from(requestUrls).map(url => {
Expand Down Expand Up @@ -164,8 +164,8 @@ class IssuesPanelEntries extends Audit {
if (issues.mixedContentIssue.length) {
items.push(this.getMixedContentRow(issues.mixedContentIssue));
}
if (issues.sameSiteCookieIssue.length) {
items.push(this.getSameSiteCookieRow(issues.sameSiteCookieIssue));
if (issues.cookieIssue.length) {
items.push(this.getCookieRow(issues.cookieIssue));
}
if (issues.blockedByResponseIssue.length) {
items.push(this.getBlockedByResponseRow(issues.blockedByResponseIssue));
Expand Down
2 changes: 1 addition & 1 deletion lighthouse-core/gather/gatherers/inspector-issues.js
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,7 @@ class InspectorIssues extends FRGatherer {
mixedContentIssue: [],
navigatorUserAgentIssue: [],
quirksModeIssue: [],
sameSiteCookieIssue: [],
cookieIssue: [],
sharedArrayBufferIssue: [],
twaQualityEnforcement: [],
};
Expand Down
10 changes: 5 additions & 5 deletions lighthouse-core/test/audits/dobetterweb/inspector-issues-test.js
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ describe('Has inspector issues audit', () => {
mixedContentIssue: [],
navigatorUserAgentIssue: [],
quirksModeIssue: [],
sameSiteCookieIssue: [],
cookieIssue: [],
sharedArrayBufferIssue: [],
twaQualityEnforcement: [],
};
Expand Down Expand Up @@ -81,8 +81,8 @@ describe('Has inspector issues audit', () => {
});
});

it('correctly displays SameSite cookie issues', () => {
const samesiteIssues = [
it('correctly displays cookie issues', () => {
const cookieIssues = [
{
cookieUrl: 'www.samesitecookies.com',
},
Expand All @@ -93,14 +93,14 @@ describe('Has inspector issues audit', () => {
},
},
];
issues.sameSiteCookieIssue.push(...samesiteIssues);
issues.cookieIssue.push(...cookieIssues);

const auditResult = InspectorIssuesAudit.audit({
InspectorIssues: issues,
});
expect(auditResult.score).toBe(0);
expect(auditResult.details.items[0]).toMatchObject({
issueType: 'SameSite cookie',
issueType: 'Cookie',
subItems: {
type: 'subitems',
items: [
Expand Down
30 changes: 15 additions & 15 deletions lighthouse-core/test/gather/gatherers/inspector-issues-test.js
Original file line number Diff line number Diff line change
Expand Up @@ -54,14 +54,14 @@ function mockMixedContent(details) {
}

/**
* @param {Partial<LH.Crdp.Audits.SameSiteCookieIssueDetails>=} details
* @param {Partial<LH.Crdp.Audits.CookieIssueDetails>=} details
* @return {LH.Crdp.Audits.InspectorIssue} partial
*/
function mockSameSiteCookie(details) {
function mockCookie(details) {
return {
code: 'SameSiteCookieIssue',
code: 'CookieIssue',
details: {
sameSiteCookieIssueDetails: {
cookieIssueDetails: {
cookie: {
name: 'name',
path: 'path',
Expand Down Expand Up @@ -156,11 +156,11 @@ describe('instrumentation', () => {
it('collects inspector issues', async () => {
const mockContext = createMockContext();
const mockMixedContentIssue = mockMixedContent({resourceType: 'Audio'});
const mockSameSiteCookieIssue =
mockSameSiteCookie({cookieWarningReasons: ['WarnSameSiteNoneInsecure']});
const mockCookieIssue =
mockCookie({cookieWarningReasons: ['WarnSameSiteNoneInsecure']});
mockContext.driver.defaultSession.on
.mockEvent('Audits.issueAdded', {issue: mockMixedContentIssue})
.mockEvent('Audits.issueAdded', {issue: mockSameSiteCookieIssue});
.mockEvent('Audits.issueAdded', {issue: mockCookieIssue});
mockContext.driver.defaultSession.sendCommand
.mockResponse('Audits.enable')
.mockResponse('Audits.disable');
Expand All @@ -172,7 +172,7 @@ describe('instrumentation', () => {

expect(gatherer._issues).toEqual([
mockMixedContentIssue,
mockSameSiteCookieIssue,
mockCookieIssue,
]);
});
});
Expand All @@ -182,7 +182,7 @@ describe('_getArtifact', () => {
const gatherer = new InspectorIssues();
gatherer._issues = [
mockMixedContent({request: {requestId: '1'}}),
mockSameSiteCookie({request: {requestId: '2'}}),
mockCookie({request: {requestId: '2'}}),
mockBlockedByResponse({request: {requestId: '3'}}),
mockHeavyAd(),
mockCSP(),
Expand All @@ -203,7 +203,7 @@ describe('_getArtifact', () => {
insecureURL: 'https://example.com',
mainResourceURL: 'https://example.com',
}],
sameSiteCookieIssue: [{
cookieIssue: [{
request: {requestId: '2'},
cookie: {
name: 'name',
Expand Down Expand Up @@ -257,8 +257,8 @@ describe('_getArtifact', () => {
gatherer._issues = [
mockMixedContent({request: {requestId: '1'}}),
mockMixedContent({request: {requestId: '2'}}),
mockSameSiteCookie({request: {requestId: '3'}}),
mockSameSiteCookie({request: {requestId: '4'}}),
mockCookie({request: {requestId: '3'}}),
mockCookie({request: {requestId: '4'}}),
mockBlockedByResponse({request: {requestId: '5'}}),
mockBlockedByResponse({request: {requestId: '6'}}),
];
Expand All @@ -277,7 +277,7 @@ describe('_getArtifact', () => {
insecureURL: 'https://example.com',
mainResourceURL: 'https://example.com',
}],
sameSiteCookieIssue: [{
cookieIssue: [{
request: {requestId: '3'},
cookie: {
name: 'name',
Expand Down Expand Up @@ -351,7 +351,7 @@ describe('FR compat', () => {
insecureURL: 'https://example.com',
mainResourceURL: 'https://example.com',
}],
sameSiteCookieIssue: [],
cookieIssue: [],
blockedByResponseIssue: [],
heavyAdIssue: [],
clientHintIssue: [],
Expand Down Expand Up @@ -387,7 +387,7 @@ describe('FR compat', () => {
insecureURL: 'https://example.com',
mainResourceURL: 'https://example.com',
}],
sameSiteCookieIssue: [],
cookieIssue: [],
blockedByResponseIssue: [],
clientHintIssue: [],
heavyAdIssue: [],
Expand Down
2 changes: 1 addition & 1 deletion lighthouse-core/test/results/artifacts/artifacts.json
Original file line number Diff line number Diff line change
Expand Up @@ -12323,7 +12323,7 @@
}
],
"quirksModeIssue": [],
"sameSiteCookieIssue": [],
"cookieIssue": [],
"sharedArrayBufferIssue": [],
"twaQualityEnforcement": []
},
Expand Down
4 changes: 2 additions & 2 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -140,7 +140,7 @@
"cpy": "^8.1.2",
"cross-env": "^7.0.2",
"csv-validator": "^0.0.3",
"devtools-protocol": "0.0.964215",
"devtools-protocol": "0.0.975298",
"es-main": "^1.0.2",
"eslint": "^8.4.1",
"eslint-config-google": "^0.14.0",
Expand Down Expand Up @@ -213,7 +213,7 @@
"yargs-parser": "^21.0.0"
},
"resolutions": {
"puppeteer/**/devtools-protocol": "0.0.964215"
"puppeteer/**/devtools-protocol": "0.0.975298"
},
"repository": "GoogleChrome/lighthouse",
"keywords": [
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,7 @@ Array [
"blockedByResponseIssueDetails",
"clientHintIssueDetails",
"contentSecurityPolicyIssueDetails",
"cookieIssueDetails",
"corsIssueDetails",
"deprecationIssueDetails",
"federatedAuthRequestIssueDetails",
Expand All @@ -47,7 +48,6 @@ Array [
"mixedContentIssueDetails",
"navigatorUserAgentIssueDetails",
"quirksModeIssueDetails",
"sameSiteCookieIssueDetails",
"sharedArrayBufferIssueDetails",
"twaQualityEnforcementDetails",
]
Expand Down
2 changes: 1 addition & 1 deletion types/artifacts.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -566,7 +566,7 @@ declare module Artifacts {
mixedContentIssue: LH.Crdp.Audits.MixedContentIssueDetails[];
navigatorUserAgentIssue: LH.Crdp.Audits.NavigatorUserAgentIssueDetails[];
quirksModeIssue: LH.Crdp.Audits.QuirksModeIssueDetails[];
sameSiteCookieIssue: LH.Crdp.Audits.SameSiteCookieIssueDetails[];
cookieIssue: LH.Crdp.Audits.CookieIssueDetails[];
sharedArrayBufferIssue: LH.Crdp.Audits.SharedArrayBufferIssueDetails[];
twaQualityEnforcement: LH.Crdp.Audits.TrustedWebActivityIssueDetails[];
}
Expand Down
8 changes: 4 additions & 4 deletions yarn.lock
Original file line number Diff line number Diff line change
Expand Up @@ -3217,10 +3217,10 @@ detect-newline@^3.0.0:
resolved "https://registry.yarnpkg.com/detect-newline/-/detect-newline-3.1.0.tgz#576f5dfc63ae1a192ff192d8ad3af6308991b651"
integrity sha512-TLz+x/vEXm/Y7P7wn1EJFNLxYpUD4TgMosxY6fAVJUnJMbupHBOncxyWUG9OpTaH9EBD7uFI5LfEgmMOc54DsA==

devtools-protocol@0.0.901419, devtools-protocol@0.0.964215:
version "0.0.964215"
resolved "https://registry.yarnpkg.com/devtools-protocol/-/devtools-protocol-0.0.964215.tgz#4e5b09f9b4478ef63076fa79bae9704442212f2b"
integrity sha512-7xjHbM16/gh0Y6OZK7viLyttNWfWTSm/gT2wDW98kyslYrUBRMcDkcfpjohmZDQMlEQj+S3xcm+5OYkMoUNEDg==
devtools-protocol@0.0.901419, devtools-protocol@0.0.975298:
version "0.0.975298"
resolved "https://registry.yarnpkg.com/devtools-protocol/-/devtools-protocol-0.0.975298.tgz#b134e8c98324f12bb57ad660639e73bc77649821"
integrity sha512-RNQxbC4gOlaojOPc47YJvwhx9LsmVBBgmCw0BoNRnC2Q83wqMuc/nJd+jeXQe0kcu+R2O6f83OmaE+gUejQQOw==

diff-sequences@^27.4.0:
version "27.4.0"
Expand Down