Refactor SRIMessageSignatureIssue.

This CL doesn't introduce any behavioral change, but simply reworks the
implementation of `SRIMessageSignatureIssue` for clarity and concision.

Bug: 381044049
Change-Id: I726aa4e5f9249f1d2f1992f64c1b9821cf3ac8c0
Reviewed-on: https://chromium-review.googlesource.com/c/devtools/devtools-frontend/+/6395499
Commit-Queue: Mike West <[email protected]>
Reviewed-by: Simon Zünd <[email protected]>

Author: mikewest

front_end/models/issues_manager/SRIMessageSignatureIssue.ts

@@ -25,94 +25,9 @@ const UIStrings = {
 } as const;
 const str_ = i18n.i18n.registerUIStrings('models/issues_manager/SRIMessageSignatureIssue.ts', UIStrings);
 const i18nLazyString = i18n.i18n.getLazilyComputedLocalizedString.bind(undefined, str_);
-const specLinks = [
-  {
-    link: 'https://www.rfc-editor.org/rfc/rfc9421.html',
-    linkTitle: i18nLazyString(UIStrings.httpMessageSignatures),
-  },
-  {
-    link: 'https://wicg.github.io/signature-based-sri/',
-    linkTitle: i18nLazyString(UIStrings.signatureBasedIntegrity),
-  }
-];
-
-export const enum IssueCode {
-  MISSING_SIGNATURE_HEADER = 'SRIMessageSignatureIssue::MissingSignatureHeader',
-  MISSING_SIGNATURE_INPUT_HEADER = 'SRIMessageSignatureIssue::MissingSignatureInputHeader',
-  INVALID_SIGNATURE_HEADER = 'SRIMessageSignatureIssue::InvalidSignatureHeader',
-  INVALID_SIGNATURE_INPUT_HEADER = 'SRIMessageSignatureIssue::InvalidSignatureInputHeader',
-  SIGNATURE_HEADER_VALUE_IS_NOT_BYTE_SEQUENCE = 'SRIMessageSignatureIssue::SignatureHeaderValueIsNotByteSequence',
-  SIGNATURE_HEADER_VALUE_IS_PARAMETERIZED = 'SRIMessageSignatureIssue::SignatureHeaderValueIsParameterized',
-  SIGNATURE_HEADER_VALUE_IS_INCORRECT_LENGTH = 'SRIMessageSignatureIssue::SignatureHeaderValueIsIncorrectLength',
-  SIGNATURE_INPUT_HEADER_MISSING_LABEL = 'SRIMessageSignatureIssue::SignatureInputHeaderMissingLabel',
-  SIGNATURE_INPUT_HEADER_VALUE_NOT_INNER_LIST = 'SRIMessageSignatureIssue::SignatureInputHeaderValueNotInnerList',
-  SIGNATURE_INPUT_HEADER_VALUE_MISSING_COMPONENTS =
-      'SRIMessageSignatureIssue::SignatureInputHeaderValueMissingComponents',
-  SIGNATURE_INPUT_HEADER_INVALID_COMPONENT_TYPE = 'SRIMessageSignatureIssue::SignatureInputHeaderInvalidComponentType',
-  SIGNATURE_INPUT_HEADER_INVALID_COMPONENT_NAME = 'SRIMessageSignatureIssue::SignatureInputHeaderInvalidComponentName',
-  SIGNATURE_INPUT_HEADER_INVALID_HEADER_COMPONENT_PARAMETER =
-      'SRIMessageSignatureIssue::SignatureInputHeaderInvalidHeaderComponentParameter',
-  SIGNATURE_INPUT_HEADER_INVALID_DERIVED_COMPONENT_PARAMETER =
-      'SRIMessageSignatureIssue::SignatureInputHeaderInvalidDerivedComponentParameter',
-  SIGNATURE_INPUT_HEADER_KEY_ID_LENGTH = 'SRIMessageSignatureIssue::SignatureInputHeaderKeyIdLength',
-  SIGNATURE_INPUT_HEADER_INVALID_PARAMETER = 'SRIMessageSignatureIssue::SignatureInputHeaderInvalidParameter',
-  SIGNATURE_INPUT_HEADER_MISSING_REQUIRED_PARAMETERS =
-      'SRIMessageSignatureIssue::SignatureInputHeaderMissingRequiredParameters',
-  VALIDATION_FAILED_SIGNATURE_EXPIRED = 'SRIMessageSignatureIssue::ValidationFailedSignatureExpired',
-  VALIDATION_FAILED_INVALID_LENGTH = 'SRIMessageSignatureIssue::ValidationFailedInvalidLength',
-  VALIDATION_FAILED_SIGNATURE_MISMATCH = 'SRIMessageSignatureIssue::ValidationFailedSignatureMismatch',
-  VALIDATION_FAILED_INTEGRITY_MISMATCH = 'SRIMessageSignatureIssue::ValidationFailedIntegrityMismatch',
-}
-
-function errorToIssueCode(details: Protocol.Audits.SRIMessageSignatureIssueDetails): IssueCode {
-  switch (details.error) {
-    case Protocol.Audits.SRIMessageSignatureError.MissingSignatureHeader:
-      return IssueCode.MISSING_SIGNATURE_HEADER;
-    case Protocol.Audits.SRIMessageSignatureError.MissingSignatureInputHeader:
-      return IssueCode.MISSING_SIGNATURE_INPUT_HEADER;
-    case Protocol.Audits.SRIMessageSignatureError.InvalidSignatureHeader:
-      return IssueCode.INVALID_SIGNATURE_HEADER;
-    case Protocol.Audits.SRIMessageSignatureError.InvalidSignatureInputHeader:
-      return IssueCode.INVALID_SIGNATURE_INPUT_HEADER;
-    case Protocol.Audits.SRIMessageSignatureError.SignatureHeaderValueIsNotByteSequence:
-      return IssueCode.SIGNATURE_HEADER_VALUE_IS_NOT_BYTE_SEQUENCE;
-    case Protocol.Audits.SRIMessageSignatureError.SignatureHeaderValueIsParameterized:
-      return IssueCode.SIGNATURE_HEADER_VALUE_IS_PARAMETERIZED;
-    case Protocol.Audits.SRIMessageSignatureError.SignatureHeaderValueIsIncorrectLength:
-      return IssueCode.SIGNATURE_HEADER_VALUE_IS_INCORRECT_LENGTH;
-    case Protocol.Audits.SRIMessageSignatureError.SignatureInputHeaderMissingLabel:
-      return IssueCode.SIGNATURE_INPUT_HEADER_MISSING_LABEL;
-    case Protocol.Audits.SRIMessageSignatureError.SignatureInputHeaderValueNotInnerList:
-      return IssueCode.SIGNATURE_INPUT_HEADER_VALUE_NOT_INNER_LIST;
-    case Protocol.Audits.SRIMessageSignatureError.SignatureInputHeaderValueMissingComponents:
-      return IssueCode.SIGNATURE_INPUT_HEADER_VALUE_MISSING_COMPONENTS;
-    case Protocol.Audits.SRIMessageSignatureError.SignatureInputHeaderInvalidComponentType:
-      return IssueCode.SIGNATURE_INPUT_HEADER_INVALID_COMPONENT_TYPE;
-    case Protocol.Audits.SRIMessageSignatureError.SignatureInputHeaderInvalidComponentName:
-      return IssueCode.SIGNATURE_INPUT_HEADER_INVALID_COMPONENT_NAME;
-    case Protocol.Audits.SRIMessageSignatureError.SignatureInputHeaderInvalidHeaderComponentParameter:
-      return IssueCode.SIGNATURE_INPUT_HEADER_INVALID_HEADER_COMPONENT_PARAMETER;
-    case Protocol.Audits.SRIMessageSignatureError.SignatureInputHeaderInvalidDerivedComponentParameter:
-      return IssueCode.SIGNATURE_INPUT_HEADER_INVALID_DERIVED_COMPONENT_PARAMETER;
-    case Protocol.Audits.SRIMessageSignatureError.SignatureInputHeaderKeyIdLength:
-      return IssueCode.SIGNATURE_INPUT_HEADER_KEY_ID_LENGTH;
-    case Protocol.Audits.SRIMessageSignatureError.SignatureInputHeaderInvalidParameter:
-      return IssueCode.SIGNATURE_INPUT_HEADER_INVALID_PARAMETER;
-    case Protocol.Audits.SRIMessageSignatureError.SignatureInputHeaderMissingRequiredParameters:
-      return IssueCode.SIGNATURE_INPUT_HEADER_MISSING_REQUIRED_PARAMETERS;
-    case Protocol.Audits.SRIMessageSignatureError.ValidationFailedSignatureExpired:
-      return IssueCode.VALIDATION_FAILED_SIGNATURE_EXPIRED;
-    case Protocol.Audits.SRIMessageSignatureError.ValidationFailedInvalidLength:
-      return IssueCode.VALIDATION_FAILED_INVALID_LENGTH;
-    case Protocol.Audits.SRIMessageSignatureError.ValidationFailedSignatureMismatch:
-      return IssueCode.VALIDATION_FAILED_SIGNATURE_MISMATCH;
-    case Protocol.Audits.SRIMessageSignatureError.ValidationFailedIntegrityMismatch:
-      return IssueCode.VALIDATION_FAILED_INTEGRITY_MISMATCH;
-  }
-}
 
 function generateGroupingIssueCode(details: Protocol.Audits.SRIMessageSignatureIssueDetails): string {
-  const issueCode = errorToIssueCode(details);
+  const issueCode = `${Protocol.Audits.InspectorIssueCode.SRIMessageSignatureIssue}::${details.error}`;
   if (details.error === Protocol.Audits.SRIMessageSignatureError.ValidationFailedSignatureMismatch) {
     // Signature mismatch errors should be grouped by "signature base".
     return issueCode + details.signatureBase;
@@ -126,60 +41,67 @@ function generateGroupingIssueCode(details: Protocol.Audits.SRIMessageSignatureI
   return issueCode;
 }
 
-export class SRIMessageSignatureIssue extends Issue {
+export class SRIMessageSignatureIssue extends Issue<string> {
   readonly #issueDetails: Protocol.Audits.SRIMessageSignatureIssueDetails;
 
   constructor(issueDetails: Protocol.Audits.SRIMessageSignatureIssueDetails, issuesModel: SDK.IssuesModel.IssuesModel) {
     super(
         {
           code: generateGroupingIssueCode(issueDetails),
-          umaCode: [
-            Protocol.Audits.InspectorIssueCode.SRIMessageSignatureIssue,
-            issueDetails.error,
-          ].join('::'),
+          umaCode: `${Protocol.Audits.InspectorIssueCode.SRIMessageSignatureIssue}::${issueDetails.error}`,
         },
         issuesModel);
     this.#issueDetails = issueDetails;
   }
 
-  override requests(): Iterable<Protocol.Audits.AffectedRequest> {
-    if (this.#issueDetails.request) {
-      return [this.#issueDetails.request];
-    }
-    return [];
-  }
-
-  getCategory(): IssueCategory {
-    return IssueCategory.OTHER;
-  }
-
   details(): Protocol.Audits.SRIMessageSignatureIssueDetails {
     return this.#issueDetails;
   }
 
-  getDescription(): MarkdownIssueDescription|null {
-    const description = issueDescriptions.get(this.#issueDetails.error);
-    if (!description) {
-      return null;
+  // Overriding `Issue<String>`:
+  override primaryKey(): string {
+    return JSON.stringify(this.details());
+  }
+
+  override getDescription(): MarkdownIssueDescription|null {
+    const description: LazyMarkdownIssueDescription = {
+      file: `sri${this.details().error}.md`,
+      links: [
+        {
+          link: 'https://www.rfc-editor.org/rfc/rfc9421.html',
+          linkTitle: i18nLazyString(UIStrings.httpMessageSignatures),
+        },
+        {
+          link: 'https://wicg.github.io/signature-based-sri/',
+          linkTitle: i18nLazyString(UIStrings.signatureBasedIntegrity),
+        }
+      ],
+      substitutions: new Map()
+    };
+    if (this.#issueDetails.error === Protocol.Audits.SRIMessageSignatureError.ValidationFailedSignatureMismatch) {
+      description.substitutions?.set('PLACEHOLDER_signatureBase', () => this.#issueDetails.signatureBase);
     }
-    if (this.#issueDetails.signatureBase !== '') {
-      description.substitutions = new Map([['PLACEHOLDER_signatureBase', () => this.#issueDetails.signatureBase]]);
-    } else if (this.#issueDetails.integrityAssertions.length) {
-      description.substitutions = new Map([
-        ['PLACEHOLDER_integrityAssertions', () => '\n<li>' + this.#issueDetails.integrityAssertions.join('\n<li>')]
-      ]);
+    if (this.#issueDetails.error === Protocol.Audits.SRIMessageSignatureError.ValidationFailedIntegrityMismatch) {
+      description.substitutions?.set('PLACEHOLDER_integrityAssertions', () => {
+        const prefix = '\n<li>';
+        return prefix + this.details().integrityAssertions.join(prefix);
+      });
     }
     return resolveLazyDescription(description);
   }
 
-  primaryKey(): string {
-    return JSON.stringify(this.#issueDetails);
+  override getCategory(): IssueCategory {
+    return IssueCategory.OTHER;
   }
 
-  getKind(): IssueKind {
+  override getKind(): IssueKind {
     return IssueKind.PAGE_ERROR;
   }
 
+  override requests(): Iterable<Protocol.Audits.AffectedRequest> {
+    return this.details().request ? [this.details().request] : [];
+  }
+
   static fromInspectorIssue(issuesModel: SDK.IssuesModel.IssuesModel, inspectorIssue: Protocol.Audits.InspectorIssue):
       SRIMessageSignatureIssue[] {
     const details = inspectorIssue.details.sriMessageSignatureIssueDetails;
@@ -190,153 +112,3 @@ export class SRIMessageSignatureIssue extends Issue {
     return [new SRIMessageSignatureIssue(details, issuesModel)];
   }
 }
-
-const issueDescriptions = new Map<Protocol.Audits.SRIMessageSignatureError, LazyMarkdownIssueDescription>([
-  [
-    Protocol.Audits.SRIMessageSignatureError.MissingSignatureHeader,
-    {
-      file: 'sriMissingSignatureHeader.md',
-      links: specLinks,
-    },
-  ],
-  [
-    Protocol.Audits.SRIMessageSignatureError.MissingSignatureInputHeader,
-    {
-      file: 'sriMissingSignatureInputHeader.md',
-      links: specLinks,
-    },
-  ],
-  [
-    Protocol.Audits.SRIMessageSignatureError.InvalidSignatureHeader,
-    {
-      file: 'sriInvalidSignatureHeader.md',
-      links: specLinks,
-    },
-  ],
-  [
-    Protocol.Audits.SRIMessageSignatureError.InvalidSignatureInputHeader,
-    {
-      file: 'sriInvalidSignatureInputHeader.md',
-      links: specLinks,
-    },
-  ],
-  [
-    Protocol.Audits.SRIMessageSignatureError.SignatureHeaderValueIsNotByteSequence,
-    {
-      file: 'sriSignatureHeaderValueIsNotByteSequence.md',
-      links: specLinks,
-    },
-  ],
-  [
-    Protocol.Audits.SRIMessageSignatureError.SignatureHeaderValueIsParameterized,
-    {
-      file: 'sriSignatureHeaderValueIsParameterized.md',
-      links: specLinks,
-    },
-  ],
-  [
-    Protocol.Audits.SRIMessageSignatureError.SignatureHeaderValueIsIncorrectLength,
-    {
-      file: 'sriSignatureHeaderValueIsIncorrectLength.md',
-      links: specLinks,
-    },
-  ],
-  [
-    Protocol.Audits.SRIMessageSignatureError.SignatureInputHeaderMissingLabel,
-    {
-      file: 'sriSignatureInputHeaderMissingLabel.md',
-      links: specLinks,
-    },
-  ],
-  [
-    Protocol.Audits.SRIMessageSignatureError.SignatureInputHeaderValueNotInnerList,
-    {
-      file: 'sriSignatureInputHeaderValueNotInnerList.md',
-      links: specLinks,
-    },
-  ],
-  [
-    Protocol.Audits.SRIMessageSignatureError.SignatureInputHeaderValueMissingComponents,
-    {
-      file: 'sriSignatureInputHeaderValueMissingComponents.md',
-      links: specLinks,
-    },
-  ],
-  [
-    Protocol.Audits.SRIMessageSignatureError.SignatureInputHeaderInvalidComponentType,
-    {
-      file: 'sriSignatureInputHeaderInvalidComponentType.md',
-      links: specLinks,
-    },
-  ],
-  [
-    Protocol.Audits.SRIMessageSignatureError.SignatureInputHeaderInvalidComponentName,
-    {
-      file: 'sriSignatureInputHeaderInvalidComponentName.md',
-      links: specLinks,
-    },
-  ],
-  [
-    Protocol.Audits.SRIMessageSignatureError.SignatureInputHeaderInvalidHeaderComponentParameter,
-    {
-      file: 'sriSignatureInputHeaderInvalidHeaderComponentParameter.md',
-      links: specLinks,
-    },
-  ],
-  [
-    Protocol.Audits.SRIMessageSignatureError.SignatureInputHeaderInvalidDerivedComponentParameter,
-    {
-      file: 'sriSignatureInputHeaderInvalidDerivedComponentParameter.md',
-      links: specLinks,
-    },
-  ],
-  [
-    Protocol.Audits.SRIMessageSignatureError.SignatureInputHeaderKeyIdLength,
-    {
-      file: 'sriSignatureInputHeaderKeyIdLength.md',
-      links: specLinks,
-    },
-  ],
-  [
-    Protocol.Audits.SRIMessageSignatureError.SignatureInputHeaderInvalidParameter,
-    {
-      file: 'sriSignatureInputHeaderInvalidParameter.md',
-      links: specLinks,
-    },
-  ],
-  [
-    Protocol.Audits.SRIMessageSignatureError.SignatureInputHeaderMissingRequiredParameters,
-    {
-      file: 'sriSignatureInputHeaderMissingRequiredParameters.md',
-      links: specLinks,
-    },
-  ],
-  [
-    Protocol.Audits.SRIMessageSignatureError.ValidationFailedSignatureExpired,
-    {
-      file: 'sriValidationFailedSignatureExpired.md',
-      links: specLinks,
-    },
-  ],
-  [
-    Protocol.Audits.SRIMessageSignatureError.ValidationFailedInvalidLength,
-    {
-      file: 'sriValidationFailedInvalidLength.md',
-      links: specLinks,
-    },
-  ],
-  [
-    Protocol.Audits.SRIMessageSignatureError.ValidationFailedIntegrityMismatch,
-    {
-      file: 'sriValidationFailedIntegrityMismatch.md',
-      links: specLinks,
-    },
-  ],
-  [
-    Protocol.Audits.SRIMessageSignatureError.ValidationFailedSignatureMismatch,
-    {
-      file: 'sriValidationFailedSignatureMismatch.md',
-      links: specLinks,
-    },
-  ],
-]);