forked from RedHatInsights/notifications-backend
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
RHCLOUD-29896 Change the OCM email sender name based on the source env (
RedHatInsights#2389) * RHCLOUD-29896 Change the OCM email sender name based on the source env * Fix test * Prevent NPEs * Apply review suggestion
- Loading branch information
Showing
9 changed files
with
193 additions
and
55 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
2 changes: 2 additions & 0 deletions
2
database/src/main/resources/db/migration/V1.90.0__RHCLOUD-29896_source_env_in_event.sql
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,2 @@ | ||
| ALTER TABLE event | ||
| ADD COLUMN source_environment TEXT; |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
48 changes: 48 additions & 0 deletions
48
engine/src/main/java/com/redhat/cloud/notifications/events/KafkaHeadersExtractor.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,48 @@ | ||
| package com.redhat.cloud.notifications.events; | ||
|
|
||
| import io.quarkus.logging.Log; | ||
| import io.smallrye.reactive.messaging.kafka.api.KafkaMessageMetadata; | ||
| import jakarta.enterprise.context.ApplicationScoped; | ||
| import org.apache.kafka.common.header.Header; | ||
| import org.eclipse.microprofile.reactive.messaging.Message; | ||
|
|
||
| import java.util.HashMap; | ||
| import java.util.Iterator; | ||
| import java.util.Map; | ||
| import java.util.Optional; | ||
|
|
||
| import static java.nio.charset.StandardCharsets.UTF_8; | ||
|
|
||
| @ApplicationScoped | ||
| public class KafkaHeadersExtractor { | ||
|
|
||
| public <T> Map<String, Optional<String>> extract(Message<T> message, String... headerKeys) { | ||
| Map<String, Optional<String>> headers = new HashMap<>(); | ||
| if (headerKeys.length > 0) { | ||
| Optional<KafkaMessageMetadata> metadata = message.getMetadata(KafkaMessageMetadata.class); | ||
| if (metadata.isPresent()) { | ||
| for (String headerKey : headerKeys) { | ||
| Iterator<Header> headerValues = metadata.get().getHeaders().headers(headerKey).iterator(); | ||
| if (headerValues.hasNext()) { | ||
| Header header = headerValues.next(); | ||
| if (header.value() != null) { | ||
| String headerValue = new String(header.value(), UTF_8); | ||
| headers.put(headerKey, Optional.of(headerValue)); | ||
| } | ||
| if (headerValues.hasNext()) { | ||
| Log.warnf( | ||
| "Processed a Kafka payload with multiple [%s] header values. The emitter of that payload must change their integration and send only one value. Payload: %s", | ||
| headerKey, | ||
| message.getPayload()); | ||
| } | ||
| } | ||
| } | ||
| } | ||
| } | ||
| // The returned Map always contains all header keys to prevent NPE. | ||
| for (String headerKey : headerKeys) { | ||
| headers.putIfAbsent(headerKey, Optional.empty()); | ||
| } | ||
| return headers; | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -11,7 +11,10 @@ public class EmailActorsResolver { | |
| * ConsoleDot applications will use. | ||
| */ | ||
| public static final String RH_INSIGHTS_SENDER = "\"Red Hat Insights\" [email protected]"; | ||
| public static final String OPENSHIFT_SENDER = "\"Red Hat OpenShift\" [email protected]"; | ||
| public static final String OPENSHIFT_SENDER_STAGE = "\"Red Hat OpenShift (staging)\" [email protected]"; | ||
| public static final String OPENSHIFT_SENDER_PROD = "\"Red Hat OpenShift\" [email protected]"; | ||
|
|
||
| private static final String STAGE_ENVIRONMENT = "stage"; | ||
|
|
||
| /** | ||
| * Determines which sender should be set in the email from the given event. | ||
|
|
@@ -26,7 +29,11 @@ public String getEmailSender(final Event event) { | |
| String bundle = event.getEventType().getApplication().getBundle().getName(); | ||
| String application = event.getEventType().getApplication().getName(); | ||
| if ("openshift".equals(bundle) && "cluster-manager".equals(application)) { | ||
| return OPENSHIFT_SENDER; | ||
| if (STAGE_ENVIRONMENT.equals(event.getSourceEnvironment())) { | ||
| return OPENSHIFT_SENDER_STAGE; | ||
| } else { | ||
| return OPENSHIFT_SENDER_PROD; | ||
| } | ||
| } else { | ||
| return RH_INSIGHTS_SENDER; | ||
| } | ||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
63 changes: 63 additions & 0 deletions
63
engine/src/test/java/com/redhat/cloud/notifications/events/KafkaHeadersExtractorTest.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,63 @@ | ||
| package com.redhat.cloud.notifications.events; | ||
|
|
||
| import io.quarkus.test.junit.QuarkusTest; | ||
| import io.smallrye.reactive.messaging.kafka.api.OutgoingKafkaRecordMetadata; | ||
| import jakarta.inject.Inject; | ||
| import org.apache.kafka.common.header.Headers; | ||
| import org.apache.kafka.common.header.internals.RecordHeaders; | ||
| import org.eclipse.microprofile.reactive.messaging.Message; | ||
| import org.junit.jupiter.api.Test; | ||
|
|
||
| import java.util.Map; | ||
| import java.util.Optional; | ||
| import java.util.UUID; | ||
|
|
||
| import static java.nio.charset.StandardCharsets.UTF_8; | ||
| import static org.junit.jupiter.api.Assertions.assertEquals; | ||
| import static org.junit.jupiter.api.Assertions.assertTrue; | ||
|
|
||
| @QuarkusTest | ||
| public class KafkaHeadersExtractorTest { | ||
|
|
||
| @Inject | ||
| KafkaHeadersExtractor kafkaHeadersExtractor; | ||
|
|
||
| @Test | ||
| void testWithNoHeaderKeys() { | ||
| assertTrue(kafkaHeadersExtractor.extract(Message.of("{}")).isEmpty()); | ||
| } | ||
|
|
||
| @Test | ||
| void test() { | ||
| String messageId = UUID.randomUUID().toString(); | ||
| String sourceEnvironment = "stage"; | ||
|
|
||
| Message<String> message = buildMessageWithHeaders(Map.of( | ||
| "rh-message-id", messageId, | ||
| "rh-source-environment", sourceEnvironment, | ||
| "rh-unused-header", "whatever" | ||
| )); | ||
|
|
||
| Map<String, Optional<String>> extractedHeaders = kafkaHeadersExtractor.extract(message, | ||
| "rh-message-id", | ||
| "rh-unknown-header", | ||
| "rh-source-environment" | ||
| ); | ||
|
|
||
| assertEquals(messageId, extractedHeaders.get("rh-message-id").get()); | ||
| assertTrue(extractedHeaders.get("rh-unknown-header").isEmpty()); | ||
| assertEquals(sourceEnvironment, extractedHeaders.get("rh-source-environment").get()); | ||
| } | ||
|
|
||
| private static Message<String> buildMessageWithHeaders(Map<String, String> headers) { | ||
| Headers recordHeaders = new RecordHeaders(); | ||
| for (Map.Entry<String, String> header : headers.entrySet()) { | ||
| recordHeaders.add(header.getKey(), header.getValue().getBytes(UTF_8)); | ||
| } | ||
| OutgoingKafkaRecordMetadata<String> metadata = OutgoingKafkaRecordMetadata.<String>builder() | ||
| .withHeaders(recordHeaders) | ||
| .build(); | ||
| return Message.of("{}") | ||
| .addMetadata(metadata); | ||
| } | ||
| } |
Oops, something went wrong.