Plugin - Alert Messenger - Implement (I4I submission)

software/plugins/alert-messenger/build.gradle

@@ -20,12 +20,25 @@ dependencies {
     implementation 'io.quarkus:quarkus-config-yaml'
     implementation 'io.quarkus:quarkus-oidc'
     implementation 'io.quarkus:quarkus-qute'
+    implementation 'io.quarkus:quarkus-mailer'
+    implementation 'jakarta.persistence:jakarta.persistence-api:3.1.0'
+
+    // Added dependencies for database ORM and JWT for enhanced security and user management
+    implementation 'io.quarkus:quarkus-hibernate-orm-panache'
+    implementation 'io.quarkus:quarkus-jdbc-postgresql'
+    implementation 'io.quarkus:quarkus-smallrye-jwt'
+
+    // Add Quarkus REST Client dependency
+    implementation 'io.quarkus:quarkus-rest-client'
 
     implementation 'tech.ebp.oqm.lib:core-api-lib-quarkus:2.2.0-SNAPSHOT'
     implementation 'org.jboss.slf4j:slf4j-jboss-logmanager'
-
     testImplementation 'io.quarkus:quarkus-junit5'
     testImplementation 'io.rest-assured:rest-assured'
+
+    // Added Mockito for mocking in unit tests.
+    testImplementation 'org.mockito:mockito-core:5.4.0'
+
 }
 
 group 'tech.ebp.openQuarterMaster'
@@ -46,4 +59,4 @@ compileJava {
 
 compileTestJava {
     options.encoding = 'UTF-8'
-}
+}

software/plugins/alert-messenger/gradle.properties

@@ -1,6 +1,6 @@
 #Gradle properties
 quarkusPluginId=io.quarkus
-quarkusPluginVersion=3.13.2
+quarkusPluginVersion=3.13.3
+quarkusPlatformVersion=3.13.3
 quarkusPlatformGroupId=io.quarkus.platform
-quarkusPlatformArtifactId=quarkus-bom
-quarkusPlatformVersion=3.13.2
+quarkusPlatformArtifactId=quarkus-bom

software/plugins/alert-messenger/src/main/java/tech/ebp/oqm/plugin/alertMessenger/AlertConsumer.java

@@ -0,0 +1,128 @@
+package tech.ebp.oqm.plugin.alertMessenger;
+
+import com.fasterxml.jackson.databind.node.ObjectNode;
+import jakarta.annotation.PostConstruct;
+import jakarta.enterprise.context.ApplicationScoped;
+import jakarta.inject.Inject;
+import lombok.extern.slf4j.Slf4j;
+import org.eclipse.microprofile.reactive.messaging.Incoming;
+import org.eclipse.microprofile.reactive.messaging.Message;
+import tech.ebp.oqm.plugin.alertMessenger.model.UserPreferences;
+import tech.ebp.oqm.plugin.alertMessenger.repositories.UserPreferencesRepository;
+import tech.ebp.oqm.plugin.alertMessenger.repositories.UserRepository;
+import tech.ebp.oqm.plugin.alertMessenger.utils.EmailUtils;
+import tech.ebp.oqm.plugin.alertMessenger.utils.SlackUtils;
+
+import java.util.Optional;
+import java.util.UUID;
+import java.util.concurrent.CompletionStage;
+
+
+// AlertConsumer processes Kafka messages from the `oqm-core-all-events` topic 
+// and sends alerts via email and Slack based on user preferences.
+@Slf4j
+@ApplicationScoped
+public class AlertConsumer {
+
+    @Inject
+    private UserPreferencesRepository userPreferencesRepository;
+
+    @Inject
+    private UserRepository userRepository;
+
+    @Inject
+    private EmailUtils email;
+
+    @Inject
+    private SlackUtils slack;
+
+    // Initializes the AlertConsumer bean and logs startup information.
+    @PostConstruct
+    public void init() {
+        log.info("Starting AlertConsumer");
+    }
+
+    // Handles incoming Kafka messages, processes their payload, 
+    // and routes alerts based on user preferences.
+    @Incoming("oqm-core-all-events")
+    public CompletionStage<Void> receive(Message<ObjectNode> message) {
+        try {
+            ObjectNode payload = message.getPayload();
+            log.info("Received alert message: {}", payload);
+
+            processMessage(payload);
+
+            return message.ack();
+        } catch (Exception e) {
+            log.error("Error processing message: {}", e.getMessage(), e);
+            return message.nack(e);
+        }
+    }
+
+    // Validates the payload structure, retrieves user preferences, 
+    // and decides whether to send email or Slack notifications.
+    private void processMessage(ObjectNode payload) {
+        if (!payload.has("type") || !payload.has("details") || !payload.has("userId")) {
+            log.error("Invalid payload: {}", payload);
+            return;
+        }
+
+        String alertType = payload.get("type").asText();
+        String alertDetails = payload.get("details").asText();
+        UUID userId = UUID.fromString(payload.get("userId").asText());
+
+        Optional<UserPreferences> preferencesOptional = userPreferencesRepository.findByIdOptional(userId);
+        if (preferencesOptional.isEmpty()) {
+            log.warn("No user preferences found for user ID: {}", userId);
+            return;
+        }
+
+        UserPreferences preferences = preferencesOptional.get();
+
+        if ("yes".equalsIgnoreCase(preferences.getEmailNotifications())) {
+            handleEmailNotification(userId, alertType, alertDetails);
+        } else {
+            log.info("Email notifications not enabled for user ID: {}", userId);
+        }
+
+        if (preferences.getSlackWebhook() != null && !preferences.getSlackWebhook().isEmpty()) {
+            handleSlackNotification(userId, alertType, alertDetails);
+        } else {
+            log.info("Slack notifications not enabled for user ID: {}", userId);
+        }
+    }
+
+    // Sends email notifications using the EmailUtils class if the user's email is configured.
+    private void handleEmailNotification(UUID userId, String alertType, String alertDetails) {
+        var userInfo = userRepository.findById(userId);
+        if (userInfo == null || userInfo.getEmail() == null) {
+            log.warn("No email found for user ID: {}", userId);
+            return;
+        }
+        email.sendEmail(userInfo.getEmail(), alertType, alertDetails);
+        log.info("Email sent to user ID {}: {}", userId, userInfo.getEmail());
+    }
+
+    // Sends Slack notifications using the SlackUtils class if the user has a Slack webhook configured.
+    private void handleSlackNotification(UUID userId, String alertType, String alertDetails) {
+        slack.sendSlackMessage(userId, String.format("%s: \n%s", alertType, alertDetails));
+        log.info("Slack message sent to user ID {}", userId);
+    }
+
+    // Setter methods for testing
+    public void setUserPreferencesRepository(UserPreferencesRepository userPreferencesRepository) {
+        this.userPreferencesRepository = userPreferencesRepository;
+    }
+
+    public void setUserRepository(UserRepository userRepository) {
+        this.userRepository = userRepository;
+    }
+
+    public void setEmailUtils(EmailUtils email) {
+        this.email = email;
+    }
+
+    public void setSlackUtils(SlackUtils slack) {
+        this.slack = slack;
+    }
+}

software/plugins/alert-messenger/src/main/java/tech/ebp/oqm/plugin/alertMessenger/interfaces/ui/Home.java

@@ -2,23 +2,52 @@
 
 import io.quarkus.qute.Location;
 import io.quarkus.qute.Template;
+import io.quarkus.security.identity.SecurityIdentity;
 import jakarta.annotation.security.PermitAll;
 import jakarta.annotation.security.RolesAllowed;
 import jakarta.enterprise.context.RequestScoped;
 import jakarta.inject.Inject;
+import jakarta.ws.rs.Consumes;
+import jakarta.ws.rs.FormParam;
 import jakarta.ws.rs.GET;
+import jakarta.ws.rs.POST;
 import jakarta.ws.rs.Path;
 import jakarta.ws.rs.Produces;
 import jakarta.ws.rs.core.MediaType;
 import jakarta.ws.rs.core.Response;
+import jakarta.transaction.Transactional;
 import lombok.Getter;
 import lombok.extern.slf4j.Slf4j;
+import tech.ebp.oqm.plugin.alertMessenger.repositories.UserPreferencesRepository;
+import tech.ebp.oqm.plugin.alertMessenger.repositories.UserRepository;
+import tech.ebp.oqm.plugin.alertMessenger.AlertConsumer;
+import tech.ebp.oqm.plugin.alertMessenger.model.UserInfo;
+import tech.ebp.oqm.plugin.alertMessenger.model.UserPreferences;
+import jakarta.enterprise.context.ApplicationScoped;
+import jakarta.persistence.EntityManager;
+import jakarta.persistence.PersistenceContext;
+import io.quarkus.hibernate.orm.panache.PanacheRepository;
+
+import java.util.Set;
+import java.util.UUID;
+import java.util.concurrent.CompletableFuture;
+import java.util.concurrent.CompletionStage;
+
+import org.eclipse.microprofile.jwt.JsonWebToken;
 import org.eclipse.microprofile.openapi.annotations.tags.Tag;
 import org.eclipse.microprofile.openapi.annotations.tags.Tags;
 
+import com.fasterxml.jackson.databind.node.JsonNodeFactory;
+import com.fasterxml.jackson.databind.node.ObjectNode;
+
+/*
+ * Remove this after testing
+ */
+import org.eclipse.microprofile.reactive.messaging.Message;
+
 @Slf4j
 @Path("/")
-@Tags({@Tag(name = "UI")})
+@Tags({ @Tag(name = "UI") })
 @RequestScoped
 @Produces(MediaType.TEXT_HTML)
 public class Home extends UiInterface {
@@ -28,14 +57,107 @@ public class Home extends UiInterface {
 	@Location("webui/pages/index")
 	Template pageTemplate;
 
+	@Inject
+	JsonWebToken jwt; // Extracts claims from the JWT
+
+	@Inject
+	UserRepository userRepository; // Repository for database operations
+
+	@Inject
+	UserPreferencesRepository userPreferencesRepository;
+
+
+	@Inject
+	SecurityIdentity identity; // Provides user and role info
+
+
+	// Ensures the user is saved/updated in the database based on JWT claims
+	// and renders the home page with the user's information.
 	@GET
 	@RolesAllowed("inventoryView")
 	@Produces(MediaType.TEXT_HTML)
+	@Transactional // Ensures a transaction is active
 	public Response index() {
 		log.info("Got index page");
+
+		// Extract user details from the JWT
+		String idString = jwt.getClaim("sub"); // Extract the ID as a string
+		UUID id;
+		try {
+			id = UUID.fromString(idString); // Convert String to UUID
+		} catch (IllegalArgumentException e) {
+			log.error("Invalid UUID format in 'sub' claim: {}", idString);
+			return Response.status(Response.Status.BAD_REQUEST).entity("Invalid user ID format").build();
+		}
+
+		String name = jwt.getClaim("name");
+		String username = jwt.getClaim("preferred_username");
+		String email = jwt.getClaim("email");
+		Set<String> roles = identity.getRoles(); // Retrieves user roles
+
+		// Ensure the user is saved or updated in the database
+		UserInfo existingUser = userRepository.findById(id);
+		if (existingUser != null) {
+			existingUser.setName(name);
+			existingUser.setUsername(username);
+			existingUser.setEmail(email);
+			existingUser.getRoles().clear(); // Clear existing roles
+			existingUser.getRoles().addAll(roles); // Add new roles
+			// No need to merge; Hibernate automatically tracks changes to managed entities.
+		} else {
+			log.info("New user detected, saving to database: {}", username);
+			UserInfo newUser = UserInfo.builder()
+					.id(id)
+					.name(name)
+					.username(username)
+					.email(email)
+					.roles(roles)
+					.build();
+			userRepository.persist(newUser);
+		}
+
+		// Render the UI page
+
 		return Response.ok(
-			this.setupPageTemplate(this.pageTemplate)
-		).build();
+				this.setupPageTemplate(this.pageTemplate)).build();
 	}
 
+	// Updates user notification preferences (email and Slack webhook) in the database.
+	@POST
+	@Path("/updatePreferences")
+	@PermitAll
+	@Transactional
+	@Consumes(MediaType.APPLICATION_FORM_URLENCODED)
+	public Response updatePreferences(@FormParam("id") String idString,
+									  @FormParam("emailNotifications") String emailNotifications,
+									  @FormParam("slackWebhook") String slackWebhook) {
+
+		log.info("Received data: id={}, emailNotifications={}, slackWebhook={}", idString, emailNotifications, slackWebhook);
+
+		UUID id;
+		try {
+			id = UUID.fromString(idString);
+		} catch (IllegalArgumentException e) {
+			log.error("Invalid UUID format for ID: {}", idString);
+			return Response.status(Response.Status.BAD_REQUEST).entity("Invalid ID format").build();
+		}
+
+		// Retrieve or create the preferences record
+		UserPreferences preferences = userPreferencesRepository.findByIdOptional(id).orElseGet(() -> {
+			log.info("Creating new preferences record for user: {}", id);
+			UserPreferences newPreferences = new UserPreferences();
+			newPreferences.setId(id);
+			userPreferencesRepository.persist(newPreferences);
+			return newPreferences;
+		});
+
+		// Update preferences
+		preferences.setEmailNotifications(emailNotifications);
+		preferences.setSlackWebhook(slackWebhook);
+
+		// Persist updated preferences
+		userPreferencesRepository.persist(preferences);
+
+		return Response.ok("Preferences updated successfully!").build();
+	}
 }

software/plugins/alert-messenger/src/main/java/tech/ebp/oqm/plugin/alertMessenger/interfaces/ui/UiInterface.java

@@ -88,6 +88,11 @@ protected String getBearerHeaderStr() {
 
 	@PostConstruct
 	void initialLogAndEntityProcess() {
+		if (this.getUserToken() == null) {
+			log.warn("JWT token is null. Skipping user initialization.");
+			return;
+		}
+
 		this.oqmDatabases = this.oqmDatabaseService.getDatabases();
 		this.userInfo = JwtUtils.getUserInfo(this.getUserToken());
 
@@ -99,7 +104,6 @@ public String getSelectedDb() {
 			if(this.oqmDatabases == null || this.oqmDatabases.isEmpty()){
 				throw new IllegalStateException("Cannot have no databases.");
 			}
-			//TODO: this but smarter?
 			return this.getOqmDatabases().get(0).get("id").asText();
 		}
 		return this.oqmDb;