Skip to content
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

skip calling notify method if there are no recipients #2835

Merged
merged 2 commits into from
Dec 19, 2024
Merged

skip calling notify method if there are no recipients #2835

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
0653ea1
skip calling notify method if there are no recipients
havetisyan Dec 19, 2024
0688737
update test case for SES Email provider
havetisyan Dec 19, 2024
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
2 changes: 1 addition & 1 deletion ...mon/src/test/java/io/athenz/server/aws/common/notification/impl/SESEmailProviderTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -180,7 +180,7 @@ public void testNotify() {
NotificationToEmailConverter notificationToEmailConverter = notificationToConvert -> {
String subject = "test subject";
String body = "test body";
return new NotificationEmail(subject, body, new HashSet<>());
return new NotificationEmail(subject, body, Collections.singleton("[email protected]"));
};

NotificationToMetricConverter notificationToMetricConverter =
Expand Down
3 changes: 2 additions & 1 deletion .../java/com/yahoo/athenz/common/server/notification/NotificationToEmailConverterCommon.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@
package com.yahoo.athenz.common.server.notification;

import com.yahoo.athenz.auth.Authority;
import org.eclipse.jetty.util.StringUtil;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

Expand Down Expand Up @@ -257,7 +258,7 @@ public Set<String> getFullyQualifiedEmailAddresses(Set<String> recipients) {
.map(userName -> {
if (notificationUserAuthority != null) {
String email = notificationUserAuthority.getUserEmail(userName);
if (email != null) {
if (!StringUtil.isEmpty(email)) {
return email;
}
}
Expand Down
11 changes: 10 additions & 1 deletion .../main/java/com/yahoo/athenz/common/server/notification/impl/EmailNotificationService.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -97,7 +97,16 @@ public boolean notify(Notification notification) {
final String subject = notificationAsEmail.getSubject();
final String body = notificationAsEmail.getBody();
Set<String> recipients = notificationAsEmail.getFullyQualifiedRecipientsEmail();
if (sendEmail(recipients, subject, body)) {

// if our list of recipients is empty then we have nothing to do,
// but we want to log it for debugging purposes

if (recipients.isEmpty()) {
LOGGER.error("No recipients specified in the notification. Subject={}", subject);
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should this be warn instead of error?

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

we should treat it as an error since we're trying to send a notification but we don't have recipients.

return false;
}

if (sendEmail(recipients, subject, body)) {
LOGGER.info("Successfully sent email notification. Subject={}, Recipients={}", subject, recipients);
return true;
} else {
Expand Down
19 changes: 19 additions & 0 deletions ...t/java/com/yahoo/athenz/common/server/notification/impl/EmailNotificationServiceTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,11 +17,18 @@
package com.yahoo.athenz.common.server.notification.impl;

import com.yahoo.athenz.common.server.notification.EmailProvider;
import com.yahoo.athenz.common.server.notification.Notification;
import com.yahoo.athenz.common.server.notification.NotificationEmail;
import org.testng.annotations.AfterMethod;
import org.testng.annotations.BeforeMethod;
import org.testng.annotations.Test;

import java.util.Collection;
import java.util.Collections;
import java.util.Set;

import static org.mockito.Mockito.mock;
import static org.mockito.Mockito.when;
import static org.testng.Assert.*;

public class EmailNotificationServiceTest {
Expand Down Expand Up @@ -58,4 +65,16 @@ public void testReadBinaryFromFileNull() {
assertNull(svc.readBinaryFromFile("resources/non-existent"));
}

@Test
public void testNotifyNoRecipients() {
EmailProvider emailProvider = mock(EmailProvider.class);
EmailNotificationService svc = new EmailNotificationService(emailProvider);

Notification notification = mock(Notification.class);
NotificationEmail notificationAsEmail = new NotificationEmail("subject", "body", Collections.emptySet());
when(notification.getNotificationAsEmail()).thenReturn(notificationAsEmail);

boolean status = svc.notify(notification);
assertFalse(status);
}
}
Loading