Merge branch 'develop' into feature-1957/decline-received-feedback-request

Author: thelenw

README.md

@@ -1,4 +1,4 @@
-[![Gradle Build & Deploy - Develop](https://github.com/objectcomputing/check-ins/actions/workflows/gradle-build-development.yml/badge.svg)](https://github.com/objectcomputing/check-ins/actions/workflows/gradle-build-development.yml)
+[![Gradle Build & Deploy - Develop](https://github.com/objectcomputing/check-ins/actions/workflows/gradle-build-develop.yml/badge.svg)](https://github.com/objectcomputing/check-ins/actions/workflows/gradle-build-develop.yml)
 [![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-2.1-4baaaa.svg)](CODE_OF_CONDUCT.md)
 
 <!-- TOC -->
@@ -29,99 +29,9 @@ This web application is written in [Micronaut](https://micronaut.io) for uploadi
 
 See [Setting up your environment](https://objectcomputing.github.io/check-ins/getting-started/setup/) for instructions on setting up your development environment.
 
-# Project setup
-
-There are two files required to run the application successfully. Both of which must be created and placed in
-`src/main/resources/secrets`.
-
-### directory.json
-
-This is a simple JSON file containing the identifier for the Google Drive folder into which the uploaded files are to be deposited.
-
-```json
-{
-  "upload-directory-id": "GOOGLE_DRIVE_FOLDER_ID"
-}
-```
-
-### credentials.json
-
-This JSON file should create the generated credentials for a service account that has access to write to the identified Google Drive folder. Information on configuring GCP service account credentials can be [found here](https://cloud.google.com/iam/docs/creating-managing-service-account-keys).
-
-Note: Be sure that the target Google Drive folder has edit access granted to the service account.
-
-<!-- the two required files are no longer needed -->
-
 ## Running the application
 
-#### Installs
-
-- [Podman](https://podman.io/)
-- [Podman-Compose](https://github.com/containers/podman-compose)
-
-#### Building
-
-1. Start the database in a Podman container:
-   - Initialize and start a Podman VM:
-     ```shell
-     $ podman machine init
-     $ podman machine start
-     ```
-   - Start the Podman container:
-     ```shell
-     $ podman-compose up
-     ```
-2. In a different terminal, execute the following commands :
-
-   - On Bash/Zsh -
-
-     ```sh
-     $ OAUTH_CLIENT_ID=<Insert_Client_ID> OAUTH_CLIENT_SECRET=<Insert_Client_Secret> MICRONAUT_ENVIRONMENTS=local ./gradlew build
-     ```
-
-     ```sh
-     $ ./gradlew assemble
-     ```
-
-     ```sh
-     $ OAUTH_CLIENT_ID=<Insert_Client_ID> OAUTH_CLIENT_SECRET=<Insert_Client_Secret> MICRONAUT_ENVIRONMENTS=local ./gradlew run
-     ```
-
-   - On Powershell/Command-Line -
-     Set the following environment variables -
-     ```sh
-     MICRONAUT_ENVIRONMENTS=local
-     OAUTH_CLIENT_ID=<Client_ID>
-     OAUTH_CLIENT_SECRET=<Client_Secret>
-     ```
-     Build and run the application -
-     ```sh
-     $ gradlew build
-     ```
-     ```sh
-     $ gradlew assemble
-     ```
-     ```sh
-     $ gradlew run
-     ```
-
-3. Open the browser to run the application at `http://localhost:8080`
-4. Access swagger-UI at - `http://localhost:8080/swagger-ui`
-
-# Testing
-
-1. To run the server tests, run the following:
-    ```sh
-    $ ./gradlew :server:check
-    ```
-2. To run the UI tests, run the following:
-    ```sh
-    $ ./gradlew :web-ui:check
-    ```
-3. To update snapshots, run the following:
-    ```sh
-    $ cd web-ui && yarn test -u
-    ```
+See [Running the Application](https://objectcomputing.github.io/check-ins/getting-started/running/) for instructions on running the application locally.
 
 # Contributing
 

server/build.gradle

@@ -115,6 +115,8 @@ dependencies {
     implementation("io.micronaut.reactor:micronaut-reactor")
     implementation("io.micrometer:context-propagation")
 
+    implementation 'ch.digitalfondue.mjml4j:mjml4j:1.0.3'
+
     testRuntimeOnly "org.seleniumhq.selenium:selenium-chrome-driver:$seleniumVersion"
     testRuntimeOnly "org.seleniumhq.selenium:selenium-firefox-driver:$seleniumVersion"
 
@@ -213,3 +215,5 @@ java {
 }
 
 run.jvmArgs('-Dcom.sun.management.jmxremote', '-agentlib:jdwp=transport=dt_socket,server=y,suspend=n,address=8000')
+
+

server/src/main/java/com/objectcomputing/checkins/notifications/email/MailJetFactory.java

@@ -14,6 +14,7 @@
 public class MailJetFactory {
 
     public static final String HTML_FORMAT = "html";
+    public static final String MJML_FORMAT = "mjml";
     public static final String TEXT_FORMAT = "text";
 
     @Bean
@@ -34,6 +35,13 @@ EmailSender getHtmlSender(MailJetSender sender) {
         return sender;
     }
 
+    @Singleton
+    @Named(MJML_FORMAT)
+    EmailSender getMjmlSender(MailJetSender sender) {
+        sender.setEmailFormat(MailJetSender.MJMLPART);
+        return sender;
+    }
+
     @Singleton
     @Named(TEXT_FORMAT)
     EmailSender getTextSender(MailJetSender sender) {

server/src/main/java/com/objectcomputing/checkins/notifications/email/MailJetSender.java

@@ -5,6 +5,7 @@
 import com.mailjet.client.MailjetResponse;
 import com.mailjet.client.errors.MailjetException;
 import com.mailjet.client.resource.Emailv31;
+import ch.digitalfondue.mjml4j.Mjml4j;
 import com.objectcomputing.checkins.exceptions.BadArgException;
 import io.micronaut.context.annotation.Prototype;
 import io.micronaut.context.annotation.Requires;
@@ -20,6 +21,7 @@
 @Prototype
 @Requires(bean = MailJetConfiguration.class)
 public class MailJetSender implements EmailSender {
+    public static final String MJMLPART = "MJMLPART";
 
     private static final Logger LOG = LoggerFactory.getLogger(MailJetSender.class);
     private final MailjetClient client;
@@ -94,6 +96,16 @@ public void sendEmail(String fromName, String fromAddress, String subject, Strin
                 .put("Email", fromAddress)
                 .put("Name", fromName);
 
+        String modifiedEmailFormat = emailFormat;
+        if (modifiedEmailFormat.equals(MJMLPART)) {
+            // Convert the MJML to HTML and update the local email format.
+            var configuration = new Mjml4j.Configuration("en");
+            content = Mjml4j.render(content, configuration);
+            modifiedEmailFormat = Emailv31.Message.HTMLPART;
+        }
+        final String localEmailFormat = modifiedEmailFormat;
+        final String localContent = content;
+
         emailBatches.forEach((recipientList) -> {
             MailjetRequest request = new MailjetRequest(Emailv31.resource)
                     .property(Emailv31.MESSAGES, new JSONArray()
@@ -102,7 +114,7 @@ public void sendEmail(String fromName, String fromAddress, String subject, Strin
                                     .put(Emailv31.Message.TO, new JSONArray().put(sender))
                                     .put(Emailv31.Message.BCC, recipientList)
                                     .put(Emailv31.Message.SUBJECT, subject)
-                                    .put(emailFormat, content)));
+                                    .put(localEmailFormat, localContent)));
             try {
                 MailjetResponse response = client.post(request);
                 LOG.info("Mailjet response status: {}", response.getStatus());
@@ -134,10 +146,12 @@ public boolean sendEmailReceivesStatus(String fromName, String fromAddress, Stri
 
     @Override
     public void setEmailFormat(String format) {
-        if (format.equals(Emailv31.Message.HTMLPART) || format.equals(Emailv31.Message.TEXTPART)) {
+        if (format.equals(MJMLPART) ||
+            format.equals(Emailv31.Message.HTMLPART) ||
+            format.equals(Emailv31.Message.TEXTPART)) {
             this.emailFormat = format;
         } else {
-            throw new BadArgException(String.format("Email format must be either HTMLPART or TEXTPART, got %s", format));
+            throw new BadArgException(String.format("Email format must be either HTMLPART, MJMLPART or TEXTPART, got %s", format));
         }
     }
 }

server/src/main/java/com/objectcomputing/checkins/services/email/AutomatedEmail.java

@@ -0,0 +1,41 @@
+package com.objectcomputing.checkins.services.email;
+
+import io.micronaut.data.annotation.TypeDef;
+import io.micronaut.data.model.DataType;
+import io.swagger.v3.oas.annotations.media.Schema;
+import jakarta.persistence.Column;
+import jakarta.persistence.Entity;
+import jakarta.persistence.Id;
+import jakarta.persistence.Table;
+import jakarta.validation.constraints.NotNull;
+import lombok.AllArgsConstructor;
+import lombok.Getter;
+import lombok.Setter;
+
+import java.util.Objects;
+
+@Setter
+@Getter
+@Entity
+@AllArgsConstructor
+@Table(name = "automated_email_sent")
+public class AutomatedEmail {
+    @Id
+    @Column(name = "id")
+    @TypeDef(type = DataType.STRING)
+    @Schema(description = "id of the email")
+    private String id;
+
+    @Override
+    public boolean equals(Object o) {
+        if (this == o) return true;
+        if (o == null || getClass() != o.getClass()) return false;
+        AutomatedEmail email = (AutomatedEmail) o;
+        return id.equals(email.id);
+    }
+
+    @Override
+    public int hashCode() {
+        return id.hashCode();
+    }
+}

server/src/main/java/com/objectcomputing/checkins/services/email/AutomatedEmailRepository.java

@@ -0,0 +1,15 @@
+package com.objectcomputing.checkins.services.email;
+
+import io.micronaut.data.jdbc.annotation.JdbcRepository;
+import io.micronaut.data.model.query.builder.sql.Dialect;
+import io.micronaut.data.repository.CrudRepository;
+import jakarta.validation.Valid;
+import jakarta.validation.constraints.NotNull;
+
+@JdbcRepository(dialect = Dialect.POSTGRES)
+public interface AutomatedEmailRepository extends CrudRepository<AutomatedEmail, String> {
+
+    @Override
+    <S extends AutomatedEmail> S save(@Valid @NotNull S entity);
+
+}