front_end/models/issues_manager/ClientHintIssue.ts

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

import * as i18n from '../../core/i18n/i18n.js';
import type * as SDK from '../../core/sdk/sdk.js';
import * as Protocol from '../../generated/protocol.js';

import {Issue, IssueCategory, IssueKind} from './Issue.js';
import {
  type LazyMarkdownIssueDescription,
  type MarkdownIssueDescription,
  resolveLazyDescription,
} from './MarkdownIssueDescription.js';

const UIStrings = {
  /**
   * @description Title for Client Hint specification url link
   */
  clientHintsInfrastructure: 'Client Hints Infrastructure',
} as const;
const str_ = i18n.i18n.registerUIStrings('models/issues_manager/ClientHintIssue.ts', UIStrings);
const i18nLazyString = i18n.i18n.getLazilyComputedLocalizedString.bind(undefined, str_);

export class ClientHintIssue extends Issue<Protocol.Audits.ClientHintIssueDetails> {
  constructor(issueDetails: Protocol.Audits.ClientHintIssueDetails, issuesModel: SDK.IssuesModel.IssuesModel|null) {
    super(
        {
          code: Protocol.Audits.InspectorIssueCode.ClientHintIssue,
          umaCode: [Protocol.Audits.InspectorIssueCode.ClientHintIssue, issueDetails.clientHintIssueReason].join('::'),
        },
        issueDetails, issuesModel);
  }

  getCategory(): IssueCategory {
    return IssueCategory.OTHER;
  }

  getDescription(): MarkdownIssueDescription|null {
    const description = issueDescriptions.get(this.details().clientHintIssueReason);
    if (!description) {
      return null;
    }
    return resolveLazyDescription(description);
  }

  override sources(): Iterable<Protocol.Audits.SourceCodeLocation> {
    return [this.details().sourceCodeLocation];
  }

  primaryKey(): string {
    return JSON.stringify(this.details());
  }

  getKind(): IssueKind {
    return IssueKind.BREAKING_CHANGE;
  }

  static fromInspectorIssue(
      issuesModel: SDK.IssuesModel.IssuesModel|null,
      inspectorIssue: Protocol.Audits.InspectorIssue): ClientHintIssue[] {
    const details = inspectorIssue.details.clientHintIssueDetails;
    if (!details) {
      console.warn('Client Hint issue without details received.');
      return [];
    }
    return [new ClientHintIssue(details, issuesModel)];
  }
}

const issueDescriptions = new Map<Protocol.Audits.ClientHintIssueReason, LazyMarkdownIssueDescription>([
  [
    Protocol.Audits.ClientHintIssueReason.MetaTagAllowListInvalidOrigin,
    {
      file: 'clientHintMetaTagAllowListInvalidOrigin.md',
      links: [{
        link: 'https://wicg.github.io/client-hints-infrastructure/',
        linkTitle: i18nLazyString(UIStrings.clientHintsInfrastructure),
      }],
    },
  ],
  [
    Protocol.Audits.ClientHintIssueReason.MetaTagModifiedHTML,
    {
      file: 'clientHintMetaTagModifiedHTML.md',
      links: [{
        link: 'https://wicg.github.io/client-hints-infrastructure/',
        linkTitle: i18nLazyString(UIStrings.clientHintsInfrastructure),
      }],
    },
  ],
]);