Skip to content

Feat: Support Limiting To Tags For Scheduled Summary Notifications #5975

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
mkobel wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Feat: Support Limiting To Tags For Scheduled Summary Notifications #5975

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 11 additions & 11 deletions docs/_docs/integrations/notifications.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@ multiple levels, while others can only ever have a single level.
| SYSTEM | USER_CREATED | Event | INFORMATIONAL | Notifications generated as a result of a user creation |
| SYSTEM | USER_DELETED | Event | INFORMATIONAL | Notifications generated as a result of a user deletion |
| PORTFOLIO | NEW_VULNERABILITY | Event | INFORMATIONAL | Notifications generated whenever a new vulnerability is identified |
| PORTFOLIO | NEW_VULNERABILITIES_SUMMARY | Schedule | INFORMATIONAL | Summaries of new vulnerabilities identified in a set of projects |
| PORTFOLIO | NEW_VULNERABILITIES_SUMMARY | Schedule | INFORMATIONAL | Summaries of new vulnerabilities identified in a set of projects and/or tags |
| PORTFOLIO | NEW_VULNERABLE_DEPENDENCY | Event | INFORMATIONAL | Notifications generated as a result of a vulnerable component becoming a dependency of a project |
| PORTFOLIO | GLOBAL_AUDIT_CHANGE | Event | INFORMATIONAL | Notifications generated whenever an analysis or suppression state has changed on a finding from a component (global) |
| PORTFOLIO | PROJECT_AUDIT_CHANGE | Event | INFORMATIONAL | Notifications generated whenever an analysis or suppression state has changed on a finding from a project |
Expand All @@ -71,7 +71,7 @@ multiple levels, while others can only ever have a single level.
| PORTFOLIO | BOM_PROCESSING_FAILED | Event | ERROR | Notifications generated whenever a BOM upload process fails |
| PORTFOLIO | BOM_VALIDATION_FAILED | Event | ERROR | Notifications generated whenever an invalid BOM is uploaded |
| PORTFOLIO | POLICY_VIOLATION | Event | INFORMATIONAL | Notifications generated whenever a policy violation is identified |
| PORTFOLIO | NEW_POLICY_VIOLATIONS_SUMMARY | Schedule | INFORMATIONAL | Summary of new policy violations identified in a set of projects |
| PORTFOLIO | NEW_POLICY_VIOLATIONS_SUMMARY | Schedule | INFORMATIONAL | Summary of new policy violations identified in a set of projects and/or tags |

## Configuring Publishers

Expand Down Expand Up @@ -179,13 +179,13 @@ This type of notification will always contain:

#### NEW_VULNERABILITIES_SUMMARY

A summary of new vulnerabilities identified in a set of projects. "New" in this context refers to vulnerabilities
identified *since the notification was last triggered*. For example, if the notification is scheduled to trigger
every day at 8AM (cron expression: `0 8 * * *`) it will always contain newly identified vulnerabilities since
A summary of new vulnerabilities identified in a set of projects and/or tags. "New" in this context refers to
vulnerabilities identified *since the notification was last triggered*. For example, if the notification is scheduled to
trigger every day at 8AM (cron expression: `0 8 * * *`) it will always contain newly identified vulnerabilities since
the last day at 8AM.

Note that this notification can not be configured to cover the entire portfolio, but only a limited set of
projects. This limitation exists to prevent payloads from growing too large.
projects and/or tags. This limitation exists to prevent payloads from growing too large.

```json
{
Expand Down Expand Up @@ -506,13 +506,13 @@ This type of notification will always contain:

#### NEW_POLICY_VIOLATIONS_SUMMARY

A summary of new policy violations identified in a set of projects. "New" in this context refers to violations
identified *since the notification was last triggered*. For example, if the notification is scheduled to trigger
every day at 8AM (cron expression: `0 8 * * *`) it will always contain newly identified violations since
A summary of new policy violations identified in a set of projects and/or tags. "New" in this context refers to
violations identified *since the notification was last triggered*. For example, if the notification is scheduled to
trigger every day at 8AM (cron expression: `0 8 * * *`) it will always contain newly identified violations since
the last day at 8AM.

Note that this notification can not be configured to cover the entire portfolio, but only a limited set of
projects. This limitation exists to prevent payloads from growing too large.
projects and/or tags. This limitation exists to prevent payloads from growing too large.

```json
{
Expand Down Expand Up @@ -761,7 +761,7 @@ Both the last successful, and the next planned trigger timestamp can be viewed i
To further reduce the noise produced by the system, users can opt into skipping the publishing of a notification,
if no new data has been identified since the last time it triggered.

Certain notification groups may require the alert to be limited to specific projects.
Certain notification groups may require the alert to be limited to specific projects and/or tags.
This is to protect the system from generating payloads that are too resource intensive to compute,
or too large for receiving systems to accept.

Expand Down
66 changes: 53 additions & 13 deletions src/main/java/org/dependencytrack/tasks/ScheduledNotificationDispatchTask.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@
import alpine.event.framework.Subscriber;
import alpine.notification.Notification;
import alpine.notification.NotificationLevel;
import alpine.persistence.PaginatedResult;
import alpine.server.util.DbUtil;
import org.dependencytrack.event.ScheduledNotificationDispatchEvent;
import org.dependencytrack.model.AnalysisState;
Expand All @@ -32,6 +33,7 @@
import org.dependencytrack.model.PolicyCondition;
import org.dependencytrack.model.PolicyViolation;
import org.dependencytrack.model.Project;
import org.dependencytrack.model.Tag;
import org.dependencytrack.model.ViolationAnalysisState;
import org.dependencytrack.model.VulnIdAndSource;
import org.dependencytrack.model.Vulnerability;
Expand Down Expand Up @@ -70,7 +72,6 @@
* @since 4.13.0
*/
public class ScheduledNotificationDispatchTask implements Subscriber {

private static final Logger LOGGER = Logger.getLogger(ScheduledNotificationDispatchTask.class);

@Override
Expand Down Expand Up @@ -152,9 +153,10 @@ private void processRule(final QueryManager qm, final NotificationRule rule) {
}

private Notification createNewVulnerabilitiesNotification(final QueryManager qm, final NotificationRule rule) {
if (rule.getProjects() == null || rule.getProjects().isEmpty()) {
if ((rule.getProjects() == null || rule.getProjects().isEmpty())
&& (rule.getTags() == null || rule.getTags().isEmpty())) {
throw new IllegalStateException(
"Scheduled notifications for group %s must be limited to at least one project".formatted(
"Scheduled notifications for group %s must be limited to at least one project or tag".formatted(
NotificationGroup.NEW_VULNERABILITIES_SUMMARY));
}

Expand Down Expand Up @@ -243,9 +245,10 @@ private Notification createNewVulnerabilitiesNotification(final QueryManager qm,
}

private Notification createNewPolicyViolationsNotification(final QueryManager qm, final NotificationRule rule) {
if (rule.getProjects() == null || rule.getProjects().isEmpty()) {
if ((rule.getProjects() == null || rule.getProjects().isEmpty())
&& (rule.getTags() == null || rule.getTags().isEmpty())) {
throw new IllegalStateException(
"Scheduled notifications for group %s must be limited to at least one project".formatted(
"Scheduled notifications for group %s must be limited to at least one project or tag".formatted(
NotificationGroup.NEW_POLICY_VIOLATIONS_SUMMARY));
}

Expand Down Expand Up @@ -326,24 +329,61 @@ private Notification createNewPolicyViolationsNotification(final QueryManager qm
}

private Set<Long> getApplicableProjectIds(final QueryManager qm, final NotificationRule rule) {
if (rule.getProjects() == null || rule.getProjects().isEmpty()) {
final boolean hasProjects = rule.getProjects() != null && !rule.getProjects().isEmpty();
final boolean hasTags = rule.getTags() != null && !rule.getTags().isEmpty();

if (!hasProjects && !hasTags) {
return Collections.emptySet();
}

// TODO: This should be solved with a recursive CTE,
// but it's too much of a hassle getting it to work across
// all the RDBMSes we have to support still.

final var projectIds = new HashSet<Long>();
for (final Project project : rule.getProjects()) {
if (!project.isActive()) {
continue;
final Set<Long> projectIdsFromProjects;
if (hasProjects) {
projectIdsFromProjects = new HashSet<>();
for (final Project project : rule.getProjects()) {
if (!project.isActive()) {
continue;
}

projectIdsFromProjects.add(project.getId());

if (rule.isNotifyChildren()) {
projectIdsFromProjects.addAll(getActiveChildProjectIds(qm, project.getId()));
}
}
} else {
projectIdsFromProjects = null;
}

final Set<Long> projectIdsFromTags;
if (hasTags) {
projectIdsFromTags = getProjectIdsByTags(qm, rule.getTags(), rule.isNotifyChildren());
} else {
projectIdsFromTags = null;
}

projectIds.add(project.getId());
// When both projects and tags are defined, return the intersection.
// When only one is defined, return that set.
if (projectIdsFromProjects != null && projectIdsFromTags != null) {
projectIdsFromProjects.retainAll(projectIdsFromTags);
return projectIdsFromProjects;
} else if (projectIdsFromProjects != null) {
return projectIdsFromProjects;
} else {
return projectIdsFromTags;
}
}

private Set<Long> getProjectIdsByTags(final QueryManager qm, final Set<Tag> tags, final boolean notifyChildren) {
final var projectIds = new HashSet<Long>();

if (rule.isNotifyChildren()) {
projectIds.addAll(getActiveChildProjectIds(qm, project.getId()));
for (final Tag tag : tags) {
PaginatedResult paginatedResult = qm.getProjects(tag, false, true, !notifyChildren);
for (Project project : paginatedResult.getList(Project.class)) {
projectIds.add(project.getId());
}
}

Expand Down
Loading