chrome-devtools-frontend/front_end/panels/security/CookieReportView.test.ts

Chrome DevTools UI

// Copyright 2024 The Chromium Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

import type * as SDK from '../../core/sdk/sdk.js';
import * as Protocol from '../../generated/protocol.js';
import * as IssuesManager from '../../models/issues_manager/issues_manager.js';
import {createFakeSetting, createTarget} from '../../testing/EnvironmentHelpers.js';
import {describeWithMockConnection} from '../../testing/MockConnection.js';
import {getMainFrame, navigate} from '../../testing/ResourceTreeHelpers.js';
import {createViewFunctionStub, type ViewFunctionStub} from '../../testing/ViewFunctionHelpers.js';

import * as Security from './security.js';

function getTestCookieIssue(
    readCookie?: boolean, exclusionReason?: Protocol.Audits.CookieExclusionReason,
    warningReason?: Protocol.Audits.CookieWarningReason, cookieName?: string): Protocol.Audits.InspectorIssue {
  // if no exclusion or warning reason provided, use a default
  if (!exclusionReason && !warningReason) {
    exclusionReason = Protocol.Audits.CookieExclusionReason.ExcludeThirdPartyPhaseout;
  }

  return {
    code: Protocol.Audits.InspectorIssueCode.CookieIssue,
    details: {
      cookieIssueDetails: {
        cookie: {
          name: cookieName + 'test',
          path: '/',
          domain: 'a.' + cookieName + 'test',
        },
        cookieExclusionReasons: exclusionReason ? [exclusionReason] : [],
        cookieWarningReasons: warningReason ? [warningReason] : [],
        operation: readCookie ? Protocol.Audits.CookieOperation.ReadCookie : Protocol.Audits.CookieOperation.SetCookie,
        cookieUrl: 'a.' + cookieName + 'test',
      },
    },
  };
}

describeWithMockConnection('CookieReportView', () => {
  let mockView: ViewFunctionStub<typeof Security.CookieReportView.CookieReportView>;
  let target: SDK.Target.Target;

  beforeEach(() => {
    mockView = createViewFunctionStub(Security.CookieReportView.CookieReportView);
    target = createTarget();
    const showThirdPartyIssuesSetting = createFakeSetting('third party flag', true);
    IssuesManager.IssuesManager.IssuesManager.instance({
      forceNew: false,
      ensureFirst: false,
      showThirdPartyIssuesSetting,
    });
  });

  it('should contain no rows if no issues were created', async () => {
    const view = new Security.CookieReportView.CookieReportView(undefined, mockView);

    await view.updateComplete;
    assert.lengthOf(mockView.input.cookieRows, 0);
  });

  it('should have row when there was a preexisting cookie issue', async () => {
    // @ts-expect-error
    globalThis.addIssueForTest(getTestCookieIssue());

    const view = new Security.CookieReportView.CookieReportView(undefined, mockView);
    await view.updateComplete;

    assert.lengthOf(mockView.input.cookieRows, 1);
  });

  it('should add row when issue added after view creation', async () => {
    const view = new Security.CookieReportView.CookieReportView(undefined, mockView);
    await view.updateComplete;

    assert.lengthOf(mockView.input.cookieRows, 0);

    // @ts-expect-error
    globalThis.addIssueForTest(getTestCookieIssue());
    await view.updateComplete;

    assert.lengthOf(mockView.input.cookieRows, 1);
  });

  it('should ignore non-third-party-cookie related exclusionReason', async () => {
    const view = new Security.CookieReportView.CookieReportView(undefined, mockView);

    // @ts-expect-error
    globalThis.addIssueForTest(
        getTestCookieIssue(undefined, Protocol.Audits.CookieExclusionReason.ExcludeSameSiteNoneInsecure));
    await view.updateComplete;

    assert.lengthOf(mockView.input.cookieRows, 0);

    // Make sure ExcludeThirdPartyPhaseout (default) is added.
    // @ts-expect-error
    globalThis.addIssueForTest(getTestCookieIssue());
    await view.updateComplete;

    assert.lengthOf(mockView.input.cookieRows, 1);
    assert.strictEqual(mockView.input.cookieRows[0].status, IssuesManager.CookieIssue.CookieStatus.BLOCKED);
  });

  it('should ignore non-third-party-cookie related warningReason', async () => {
    const view = new Security.CookieReportView.CookieReportView(undefined, mockView);

    // @ts-expect-error
    globalThis.addIssueForTest(
        getTestCookieIssue(undefined, undefined, Protocol.Audits.CookieWarningReason.WarnSameSiteLaxCrossDowngradeLax));
    await view.updateComplete;

    assert.lengthOf(mockView.input.cookieRows, 0);

    // Make sure warning 3pc warning reasons are added
    // @ts-expect-error
    globalThis.addIssueForTest(getTestCookieIssue(
        undefined, undefined, Protocol.Audits.CookieWarningReason.WarnDeprecationTrialMetadata, 'metadata'));
    // @ts-expect-error
    globalThis.addIssueForTest(getTestCookieIssue(
        undefined, undefined, Protocol.Audits.CookieWarningReason.WarnThirdPartyCookieHeuristic, 'heuristic'));
    // @ts-expect-error
    globalThis.addIssueForTest(getTestCookieIssue(
        undefined, undefined, Protocol.Audits.CookieWarningReason.WarnThirdPartyPhaseout, 'phaseout'));
    await view.updateComplete;

    assert.lengthOf(mockView.input.cookieRows, 3);
    assert.strictEqual(
        mockView.input.cookieRows[0].status, IssuesManager.CookieIssue.CookieStatus.ALLOWED_BY_GRACE_PERIOD);
    assert.strictEqual(
        mockView.input.cookieRows[1].status, IssuesManager.CookieIssue.CookieStatus.ALLOWED_BY_HEURISTICS);
    assert.strictEqual(mockView.input.cookieRows[2].status, IssuesManager.CookieIssue.CookieStatus.ALLOWED);
  });

  it('should only have a single entry for same cookie with a read and a write operations', async () => {
    const view = new Security.CookieReportView.CookieReportView(undefined, mockView);

    // @ts-expect-error
    globalThis.addIssueForTest(getTestCookieIssue(true));
    // @ts-expect-error
    globalThis.addIssueForTest(getTestCookieIssue(false));
    await view.updateComplete;

    assert.lengthOf(mockView.input.cookieRows, 1);
  });

  it('should have zero entries after the primary page was changed', async () => {
    const view = new Security.CookieReportView.CookieReportView(undefined, mockView);

    // @ts-expect-error
    globalThis.addIssueForTest(getTestCookieIssue(true));
    await view.updateComplete;

    assert.lengthOf(mockView.input.cookieRows, 1);

    navigate(getMainFrame(target));
    await view.updateComplete;

    assert.lengthOf(mockView.input.cookieRows, 0);
  });
});