Make invisible issues

The new 3p related cookie issues do not need to be surfaced to the
user in the issue pane. Instead, they are going to be shown in the
new Cookie Report. They still need a description to be properly
added by the issuesManager, so this is why a placeholder description
was added. The issueAggregator will exclude these issues so that
the issue pane does not show them, while still making the issues
accessible via the issuesManager.

Bug: 365737493
Change-Id: Ib7c4b918935b7604cf57b0a1dcebb90c0297f4b2
Reviewed-on: https://chromium-review.googlesource.com/c/devtools/devtools-frontend/+/5950123
Reviewed-by: Danil Somsikov <[email protected]>
Commit-Queue: Joshua Thomas <[email protected]>
Reviewed-by: Shuran Huang <[email protected]>

Author: masnoble

config/gni/devtools_grd_files.gni

@@ -471,6 +471,7 @@ grd_files_release_sources = [
   "front_end/models/issues_manager/descriptions/genericResponseWasBlockedByORB.md",
   "front_end/models/issues_manager/descriptions/heavyAd.md",
   "front_end/models/issues_manager/descriptions/mixedContent.md",
+  "front_end/models/issues_manager/descriptions/placeholderDescriptionForInvisibleIssues.md",
   "front_end/models/issues_manager/descriptions/propertyRuleInvalidNameIssue.md",
   "front_end/models/issues_manager/descriptions/propertyRuleIssue.md",
   "front_end/models/issues_manager/descriptions/sharedArrayBuffer.md",

front_end/models/issues_manager/BUILD.gn

@@ -196,6 +196,7 @@ devtools_issue_description_files = [
   "sharedDictionaryWriteErrorShuttingDown.md",
   "sharedDictionaryWriteErrorTooLongIdField.md",
   "sharedDictionaryWriteErrorUnsupportedType.md",
+  "placeholderDescriptionForInvisibleIssues.md",
 ]
 
 devtools_pre_built("descriptions") {

front_end/models/issues_manager/CookieIssue.ts

@@ -542,6 +542,14 @@ const cookieCrossSiteRedirectDowngrade: LazyMarkdownIssueDescription = {
   }],
 };
 
+// This description will be used by cookie issues that need to be added to the
+// issueManager, but aren't intended to be surfaced in the issues pane. This
+// is why they are using a placeholder description
+const placeholderDescriptionForInvisibleIssues: LazyMarkdownIssueDescription = {
+  file: 'placeholderDescriptionForInvisibleIssues.md',
+  links: [],
+};
+
 const issueDescriptions: Map<string, LazyMarkdownIssueDescription> = new Map([
   // These two don't have a deprecation date yet, but they need to be fixed eventually.
   ['CookieIssue::WarnSameSiteUnspecifiedLaxAllowUnsafe::ReadCookie', sameSiteUnspecifiedWarnRead],
@@ -585,6 +593,10 @@ const issueDescriptions: Map<string, LazyMarkdownIssueDescription> = new Map([
   ],
   ['CookieIssue::WarnThirdPartyPhaseout::ReadCookie', cookieWarnThirdPartyPhaseoutRead],
   ['CookieIssue::WarnThirdPartyPhaseout::SetCookie', cookieWarnThirdPartyPhaseoutSet],
+  ['CookieIssue::WarnDeprecationTrialMetadata::ReadCookie', placeholderDescriptionForInvisibleIssues],
+  ['CookieIssue::WarnDeprecationTrialMetadata::SetCookie', placeholderDescriptionForInvisibleIssues],
+  ['CookieIssue::WarnThirdPartyCookieHeuristic::ReadCookie', placeholderDescriptionForInvisibleIssues],
+  ['CookieIssue::WarnThirdPartyCookieHeuristic::SetCookie', placeholderDescriptionForInvisibleIssues],
   ['CookieIssue::ExcludeThirdPartyPhaseout::ReadCookie', cookieExcludeThirdPartyPhaseoutRead],
   ['CookieIssue::ExcludeThirdPartyPhaseout::SetCookie', cookieExcludeThirdPartyPhaseoutSet],
   ['CookieIssue::CrossSiteRedirectDowngradeChangesInclusion', cookieCrossSiteRedirectDowngrade],

front_end/models/issues_manager/descriptions/placeholderDescriptionForInvisibleIssues.md

@@ -0,0 +1,3 @@
+# This is a placeholder issue description
+
+This description is used for issues that are not intended to be shown to the user. This means there is no need for a useful description.

front_end/panels/issues/IssueAggregator.ts

@@ -3,8 +3,8 @@
 // found in the LICENSE file.
 
 import * as Common from '../../core/common/common.js';
+import * as Protocol from '../../generated/protocol.js';
 import * as IssuesManager from '../../models/issues_manager/issues_manager.js';
-import type * as Protocol from '../../generated/protocol.js';
 
 type AggregationKeyTag = {
   aggregationKeyTag: undefined,
@@ -268,6 +268,15 @@ export class IssueAggregator extends Common.ObjectWrapper.ObjectWrapper<EventTyp
   }
 
   #onIssueAdded(event: Common.EventTarget.EventTargetEvent<IssuesManager.IssuesManager.IssueAddedEvent>): void {
+    const excludeFromAggregate = [
+      Protocol.Audits.CookieWarningReason.WarnThirdPartyCookieHeuristic,
+      Protocol.Audits.CookieWarningReason.WarnDeprecationTrialMetadata,
+    ];
+
+    if (excludeFromAggregate.some(exclude => event.data.issue.code().includes(exclude))) {
+      return;
+    }
+
     this.#aggregateIssue(event.data.issue);
   }