Implement getAllIssues on AggregatedIssue. Centralize issue details in

generic base Issue class.

The base `Issue` class is now  centralizes the `issueDetails` property,
providing improved type-safety and inference for all issue aubclasses. In
the future it will be easier to reuse that classes in the mcp

Fixed: 463602403
Change-Id: Ie9c8ce88aa455b768a056708ec1ad30da68cad38
Reviewed-on: https://chromium-review.googlesource.com/c/devtools/devtools-frontend/+/7206122
Reviewed-by: Alex Rudenko <[email protected]>
Commit-Queue: Alex Rudenko <[email protected]>

Author: Natallia Harshunova

front_end/models/issues_manager/AttributionReportingIssue.ts

@@ -89,13 +89,10 @@ const structuredHeaderLink = {
   linkTitle: 'Structured Headers RFC',
 };
 
-export class AttributionReportingIssue extends Issue<IssueCode> {
-  issueDetails: Readonly<Protocol.Audits.AttributionReportingIssueDetails>;
-
+export class AttributionReportingIssue extends Issue<Protocol.Audits.AttributionReportingIssueDetails, IssueCode> {
   constructor(
       issueDetails: Protocol.Audits.AttributionReportingIssueDetails, issuesModel: SDK.IssuesModel.IssuesModel|null) {
-    super(getIssueCode(issueDetails), issuesModel);
-    this.issueDetails = issueDetails;
+    super(getIssueCode(issueDetails), issueDetails, issuesModel);
   }
 
   getCategory(): IssueCategory {
@@ -106,8 +103,9 @@ export class AttributionReportingIssue extends Issue<IssueCode> {
     const url = new URL('https://wicg.github.io/attribution-reporting-api/validate-headers');
     url.searchParams.set('header', name);
 
-    if (this.issueDetails.invalidParameter) {
-      url.searchParams.set('json', this.issueDetails.invalidParameter);
+    const details = this.details();
+    if (details.invalidParameter) {
+      url.searchParams.set('json', details.invalidParameter);
     }
 
     return {
@@ -229,7 +227,7 @@ export class AttributionReportingIssue extends Issue<IssueCode> {
   }
 
   primaryKey(): string {
-    return JSON.stringify(this.issueDetails);
+    return JSON.stringify(this.details());
   }
 
   getKind(): IssueKind {

front_end/models/issues_manager/BounceTrackingIssue.ts

@@ -18,12 +18,9 @@ const UIStrings = {
 const str_ = i18n.i18n.registerUIStrings('models/issues_manager/BounceTrackingIssue.ts', UIStrings);
 const i18nString = i18n.i18n.getLocalizedString.bind(undefined, str_);
 
-export class BounceTrackingIssue extends Issue {
-  readonly #issueDetails: Protocol.Audits.BounceTrackingIssueDetails;
-
+export class BounceTrackingIssue extends Issue<Protocol.Audits.BounceTrackingIssueDetails> {
   constructor(issueDetails: Protocol.Audits.BounceTrackingIssueDetails, issuesModel: SDK.IssuesModel.IssuesModel|null) {
-    super(Protocol.Audits.InspectorIssueCode.BounceTrackingIssue, issuesModel);
-    this.#issueDetails = issueDetails;
+    super(Protocol.Audits.InspectorIssueCode.BounceTrackingIssue, issueDetails, issuesModel);
   }
 
   getCategory(): IssueCategory {
@@ -42,23 +39,16 @@ export class BounceTrackingIssue extends Issue {
     };
   }
 
-  details(): Protocol.Audits.BounceTrackingIssueDetails {
-    return this.#issueDetails;
-  }
-
   getKind(): IssueKind {
     return IssueKind.BREAKING_CHANGE;
   }
 
   primaryKey(): string {
-    return JSON.stringify(this.#issueDetails);
+    return JSON.stringify(this.details());
   }
 
   override trackingSites(): Iterable<string> {
-    if (this.#issueDetails.trackingSites) {
-      return this.#issueDetails.trackingSites;
-    }
-    return [];
+    return this.details().trackingSites;
   }
 
   static fromInspectorIssue(

front_end/models/issues_manager/ClientHintIssue.ts

@@ -22,41 +22,34 @@ const UIStrings = {
 const str_ = i18n.i18n.registerUIStrings('models/issues_manager/ClientHintIssue.ts', UIStrings);
 const i18nLazyString = i18n.i18n.getLazilyComputedLocalizedString.bind(undefined, str_);
 
-export class ClientHintIssue extends Issue {
-  private issueDetails: Protocol.Audits.ClientHintIssueDetails;
-
+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('::'),
         },
-        issuesModel);
-    this.issueDetails = issueDetails;
+        issueDetails, issuesModel);
   }
 
   getCategory(): IssueCategory {
     return IssueCategory.OTHER;
   }
 
-  details(): Protocol.Audits.ClientHintIssueDetails {
-    return this.issueDetails;
-  }
-
   getDescription(): MarkdownIssueDescription|null {
-    const description = issueDescriptions.get(this.issueDetails.clientHintIssueReason);
+    const description = issueDescriptions.get(this.details().clientHintIssueReason);
     if (!description) {
       return null;
     }
     return resolveLazyDescription(description);
   }
 
   override sources(): Iterable<Protocol.Audits.SourceCodeLocation> {
-    return [this.issueDetails.sourceCodeLocation];
+    return [this.details().sourceCodeLocation];
   }
 
   primaryKey(): string {
-    return JSON.stringify(this.issueDetails);
+    return JSON.stringify(this.details());
   }
 
   getKind(): IssueKind {

front_end/models/issues_manager/ContentSecurityPolicyIssue.ts

@@ -38,26 +38,23 @@ const UIStrings = {
 const str_ = i18n.i18n.registerUIStrings('models/issues_manager/ContentSecurityPolicyIssue.ts', UIStrings);
 const i18nLazyString = i18n.i18n.getLazilyComputedLocalizedString.bind(undefined, str_);
 
-export class ContentSecurityPolicyIssue extends Issue {
-  #issueDetails: Protocol.Audits.ContentSecurityPolicyIssueDetails;
-
+export class ContentSecurityPolicyIssue extends Issue<Protocol.Audits.ContentSecurityPolicyIssueDetails> {
   constructor(
       issueDetails: Protocol.Audits.ContentSecurityPolicyIssueDetails, issuesModel: SDK.IssuesModel.IssuesModel|null,
       issueId?: Protocol.Audits.IssueId) {
     const issueCode = [
       Protocol.Audits.InspectorIssueCode.ContentSecurityPolicyIssue,
       issueDetails.contentSecurityPolicyViolationType,
     ].join('::');
-    super(issueCode, issuesModel, issueId);
-    this.#issueDetails = issueDetails;
+    super(issueCode, issueDetails, issuesModel, issueId);
   }
 
   getCategory(): IssueCategory {
     return IssueCategory.CONTENT_SECURITY_POLICY;
   }
 
   primaryKey(): string {
-    return JSON.stringify(this.#issueDetails, [
+    return JSON.stringify(this.details(), [
       'blockedURL',
       'contentSecurityPolicyViolationType',
       'violatedDirective',
@@ -71,19 +68,15 @@ export class ContentSecurityPolicyIssue extends Issue {
   }
 
   getDescription(): MarkdownIssueDescription|null {
-    const description = issueDescriptions.get(this.#issueDetails.contentSecurityPolicyViolationType);
+    const description = issueDescriptions.get(this.details().contentSecurityPolicyViolationType);
     if (!description) {
       return null;
     }
     return resolveLazyDescription(description);
   }
 
-  details(): Protocol.Audits.ContentSecurityPolicyIssueDetails {
-    return this.#issueDetails;
-  }
-
   getKind(): IssueKind {
-    if (this.#issueDetails.isReportOnly) {
+    if (this.details().isReportOnly) {
       return IssueKind.IMPROVEMENT;
     }
     return IssueKind.PAGE_ERROR;

front_end/models/issues_manager/CookieDeprecationMetadataIssue.ts

@@ -19,29 +19,26 @@ const str_ = i18n.i18n.registerUIStrings('models/issues_manager/CookieDeprecatio
 const i18nString = i18n.i18n.getLocalizedString.bind(undefined, str_);
 
 /** TODO(b/305738703): Move this issue into a warning on CookieIssue. **/
-export class CookieDeprecationMetadataIssue extends Issue {
-  readonly #issueDetails: Protocol.Audits.CookieDeprecationMetadataIssueDetails;
-
+export class CookieDeprecationMetadataIssue extends Issue<Protocol.Audits.CookieDeprecationMetadataIssueDetails> {
   constructor(
       issueDetails: Protocol.Audits.CookieDeprecationMetadataIssueDetails,
       issuesModel: SDK.IssuesModel.IssuesModel|null) {
     // Set a distinct code for ReadCookie and SetCookie issues, so they are grouped separately.
     const issueCode = Protocol.Audits.InspectorIssueCode.CookieDeprecationMetadataIssue + '_' + issueDetails.operation;
-    super(issueCode, issuesModel);
-    this.#issueDetails = issueDetails;
+    super(issueCode, issueDetails, issuesModel);
   }
 
   getCategory(): IssueCategory {
     return IssueCategory.OTHER;
   }
 
   getDescription(): MarkdownIssueDescription {
-    const fileName = this.#issueDetails.operation === 'SetCookie' ? 'cookieWarnMetadataGrantSet.md' :
-                                                                    'cookieWarnMetadataGrantRead.md';
+    const fileName =
+        this.details().operation === 'SetCookie' ? 'cookieWarnMetadataGrantSet.md' : 'cookieWarnMetadataGrantRead.md';
 
     let optOutText = '';
-    if (this.#issueDetails.isOptOutTopLevel) {
-      optOutText = '\n\n (Top level site opt-out: ' + this.#issueDetails.optOutPercentage +
+    if (this.details().isOptOutTopLevel) {
+      optOutText = '\n\n (Top level site opt-out: ' + this.details().optOutPercentage +
           '% - [learn more](gracePeriodStagedControlExplainer))';
     }
 
@@ -59,16 +56,12 @@ export class CookieDeprecationMetadataIssue extends Issue {
     };
   }
 
-  details(): Protocol.Audits.CookieDeprecationMetadataIssueDetails {
-    return this.#issueDetails;
-  }
-
   getKind(): IssueKind {
     return IssueKind.BREAKING_CHANGE;
   }
 
   primaryKey(): string {
-    return JSON.stringify(this.#issueDetails);
+    return JSON.stringify(this.details());
   }
 
   static fromInspectorIssue(

front_end/models/issues_manager/CookieIssue.ts

@@ -68,27 +68,20 @@ export interface CookieReportInfo {
   insight?: Protocol.Audits.CookieIssueInsight;
 }
 
-export class CookieIssue extends Issue {
-  #issueDetails: Protocol.Audits.CookieIssueDetails;
-
-  constructor(
-      code: string, issueDetails: Protocol.Audits.CookieIssueDetails, issuesModel: SDK.IssuesModel.IssuesModel|null,
-      issueId: Protocol.Audits.IssueId|undefined) {
-    super(code, issuesModel, issueId);
-    this.#issueDetails = issueDetails;
-  }
-
+export class CookieIssue extends Issue<Protocol.Audits.CookieIssueDetails> {
   cookieId(): string {
-    if (this.#issueDetails.cookie) {
-      const {domain, path, name} = this.#issueDetails.cookie;
+    const details = this.details();
+    if (details.cookie) {
+      const {domain, path, name} = details.cookie;
       const cookieId = `${domain};${path};${name}`;
       return cookieId;
     }
-    return this.#issueDetails.rawCookieLine ?? 'no-cookie-info';
+    return this.details().rawCookieLine ?? 'no-cookie-info';
   }
 
   primaryKey(): string {
-    const requestId = this.#issueDetails.request ? this.#issueDetails.request.requestId : 'no-request';
+    const details = this.details();
+    const requestId = details.request ? details.request.requestId : 'no-request';
     return `${this.code()}-(${this.cookieId()})-(${requestId})`;
   }
 
@@ -210,22 +203,25 @@ export class CookieIssue extends Issue {
   }
 
   override cookies(): Iterable<Protocol.Audits.AffectedCookie> {
-    if (this.#issueDetails.cookie) {
-      return [this.#issueDetails.cookie];
+    const details = this.details();
+    if (details.cookie) {
+      return [details.cookie];
     }
     return [];
   }
 
   override rawCookieLines(): Iterable<string> {
-    if (this.#issueDetails.rawCookieLine) {
-      return [this.#issueDetails.rawCookieLine];
+    const details = this.details();
+    if (details.rawCookieLine) {
+      return [details.rawCookieLine];
     }
     return [];
   }
 
   override requests(): Iterable<Protocol.Audits.AffectedRequest> {
-    if (this.#issueDetails.request) {
-      return [this.#issueDetails.request];
+    const details = this.details();
+    if (details.request) {
+      return [details.request];
     }
     return [];
   }
@@ -244,27 +240,28 @@ export class CookieIssue extends Issue {
 
   override isCausedByThirdParty(): boolean {
     const outermostFrame = SDK.FrameManager.FrameManager.instance().getOutermostFrame();
-    return isCausedByThirdParty(outermostFrame, this.#issueDetails.cookieUrl, this.#issueDetails.siteForCookies);
+    return isCausedByThirdParty(outermostFrame, this.details().cookieUrl, this.details().siteForCookies);
   }
 
   getKind(): IssueKind {
-    if (this.#issueDetails.cookieExclusionReasons?.length > 0) {
+    if (this.details().cookieExclusionReasons?.length > 0) {
       return IssueKind.PAGE_ERROR;
     }
     return IssueKind.BREAKING_CHANGE;
   }
 
   makeCookieReportEntry(): CookieReportInfo|undefined {
-    const status = CookieIssue.getCookieStatus(this.#issueDetails);
-    if (this.#issueDetails.cookie && this.#issueDetails.cookieUrl && status !== undefined) {
-      const entity = ThirdPartyWeb.ThirdPartyWeb.getEntity(this.#issueDetails.cookieUrl);
+    const status = CookieIssue.getCookieStatus(this.details());
+    const details = this.details();
+    if (details.cookie && details.cookieUrl && status !== undefined) {
+      const entity = ThirdPartyWeb.ThirdPartyWeb.getEntity(details.cookieUrl);
       return {
-        name: this.#issueDetails.cookie.name,
-        domain: this.#issueDetails.cookie.domain,
+        name: details.cookie.name,
+        domain: details.cookie.domain,
         type: entity?.category,
         platform: entity?.name,
         status,
-        insight: this.#issueDetails.insight,
+        insight: this.details().insight,
       };
     }
 
@@ -332,8 +329,8 @@ export class CookieIssue extends Issue {
       return new SDK.ConsoleModel.ConsoleMessage(
           issuesModel.target().model(SDK.RuntimeModel.RuntimeModel), Common.Console.FrontendMessageSource.ISSUE_PANEL,
           Protocol.Log.LogEntryLevel.Warning, UIStrings.consoleTpcdErrorMessage, {
-            url: this.#issueDetails.request?.url as Platform.DevToolsPath.UrlString | undefined,
-            affectedResources: {requestId: this.#issueDetails.request?.requestId, issueId: this.issueId},
+            url: this.details().request?.url as Platform.DevToolsPath.UrlString | undefined,
+            affectedResources: {requestId: this.details().request?.requestId, issueId: this.issueId},
             isCookieReportIssue: true
           });
     }

front_end/models/issues_manager/CorsIssue.ts

@@ -115,26 +115,19 @@ function getIssueCode(details: Protocol.Audits.CorsIssueDetails): IssueCode {
   }
 }
 
-export class CorsIssue extends Issue<IssueCode> {
-  #issueDetails: Protocol.Audits.CorsIssueDetails;
-
+export class CorsIssue extends Issue<Protocol.Audits.CorsIssueDetails, IssueCode> {
   constructor(
       issueDetails: Protocol.Audits.CorsIssueDetails, issuesModel: SDK.IssuesModel.IssuesModel|null,
       issueId: Protocol.Audits.IssueId|undefined) {
-    super(getIssueCode(issueDetails), issuesModel, issueId);
-    this.#issueDetails = issueDetails;
+    super(getIssueCode(issueDetails), issueDetails, issuesModel, issueId);
   }
 
   getCategory(): IssueCategory {
     return IssueCategory.CORS;
   }
 
-  details(): Protocol.Audits.CorsIssueDetails {
-    return this.#issueDetails;
-  }
-
   getDescription(): MarkdownIssueDescription|null {
-    switch (getIssueCode(this.#issueDetails)) {
+    switch (getIssueCode(this.details())) {
       case IssueCode.INSECURE_PRIVATE_NETWORK:
         return {
           file: 'corsInsecurePrivateNetwork.md',
@@ -269,16 +262,14 @@ export class CorsIssue extends Issue<IssueCode> {
   }
 
   primaryKey(): string {
-    return JSON.stringify(this.#issueDetails);
+    return JSON.stringify(this.details());
   }
 
   getKind(): IssueKind {
-    if (this.#issueDetails.isWarning &&
-        (this.#issueDetails.corsErrorStatus.corsError === Protocol.Network.CorsError.InsecurePrivateNetwork ||
-         this.#issueDetails.corsErrorStatus.corsError ===
-             Protocol.Network.CorsError.PreflightMissingAllowPrivateNetwork ||
-         this.#issueDetails.corsErrorStatus.corsError ===
-             Protocol.Network.CorsError.PreflightInvalidAllowPrivateNetwork)) {
+    if (this.details().isWarning &&
+        (this.details().corsErrorStatus.corsError === Protocol.Network.CorsError.InsecurePrivateNetwork ||
+         this.details().corsErrorStatus.corsError === Protocol.Network.CorsError.PreflightMissingAllowPrivateNetwork ||
+         this.details().corsErrorStatus.corsError === Protocol.Network.CorsError.PreflightInvalidAllowPrivateNetwork)) {
       return IssueKind.BREAKING_CHANGE;
     }
     return IssueKind.PAGE_ERROR;