[backend] feat: add connector instance logs (#3528)

Signed-off-by: Marine LM <[email protected]>

Author: MarineLeM

openaev-api/src/main/java/io/openaev/migration/V4_51__Add_Connector_Instance_Logs.java

@@ -0,0 +1,39 @@
+package io.openaev.migration;
+
+import java.sql.Statement;
+import org.flywaydb.core.api.migration.BaseJavaMigration;
+import org.flywaydb.core.api.migration.Context;
+import org.springframework.stereotype.Component;
+
+@Component
+public class V4_51__Add_Connector_Instance_Logs extends BaseJavaMigration {
+
+  @Override
+  public void migrate(Context context) throws Exception {
+    try (Statement select = context.getConnection().createStatement()) {
+      select.execute(
+          """
+            CREATE TABLE connector_instance_logs(
+                connector_instance_log_id VARCHAR(255) NOT NULL CONSTRAINT connector_instance_logs_pkey PRIMARY KEY,
+                connector_instance_log TEXT NOT NULL,
+                connector_configuration_created_at TIMESTAMP WITH TIME ZONE DEFAULT now(),
+                connector_instance_id VARCHAR(255) NOT NULL REFERENCES connector_instances(connector_instance_id) ON DELETE CASCADE
+            );
+            """);
+
+      select.execute(
+          """
+         CREATE TYPE connector_instance_current_status_type AS ENUM ('started','stopped');
+         CREATE TYPE connector_instance_requested_status_type AS ENUM ('starting','stopping');
+         """);
+      select.execute(
+          """
+        ALTER TABLE connector_instances
+        DROP COLUMN IF EXISTS connector_instance_current_status,
+        DROP COLUMN IF EXISTS connector_instance_requested_status,
+        ADD COLUMN connector_instance_current_status connector_instance_current_status_type NOT NULL,
+        ADD COLUMN connector_instance_requested_status connector_instance_requested_status_type NOT NULL
+        """);
+    }
+  }
+}

openaev-api/src/main/java/io/openaev/rest/connector_instance/service/ConnectorInstanceLogService.java

@@ -0,0 +1,14 @@
+package io.openaev.rest.connector_instance.service;
+
+import io.openaev.database.repository.ConnectorInstanceLogRepository;
+import lombok.RequiredArgsConstructor;
+import lombok.extern.slf4j.Slf4j;
+import org.springframework.stereotype.Service;
+
+@Slf4j
+@Service
+@RequiredArgsConstructor
+public class ConnectorInstanceLogService {
+
+  private final ConnectorInstanceLogRepository connectorInstanceLogRepository;
+}

openaev-model/src/main/java/io/openaev/database/model/CatalogConnector.java

@@ -64,7 +64,7 @@ public enum CONNECTOR_TYPE {
   @Type(ListArrayType.class)
   @Column(name = "catalog_connector_use_cases")
   @JsonProperty("catalog_connector_use_cases")
-  @Schema(description = "Connector use_cases")
+  @Schema(description = "Connector use cases")
   private Set<String> useCases = new HashSet<>();
 
   @Column(name = "catalog_connector_verified")

openaev-model/src/main/java/io/openaev/database/model/ConnectorInstance.java

@@ -19,6 +19,16 @@
 @EntityListeners(ModelBaseListener.class)
 public class ConnectorInstance implements Base {
 
+  public enum CURRENT_STATUS_TYPE {
+    started,
+    stopped
+  }
+
+  public enum REQUESTED_STATUS_TYPE {
+    starting,
+    stopping
+  }
+
   @Id
   @Column(name = "connector_instance_id")
   @GeneratedValue(generator = "UUID")
@@ -33,14 +43,16 @@ public class ConnectorInstance implements Base {
   @NotNull
   private CatalogConnector catalogConnector;
 
+  @Enumerated(EnumType.STRING)
   @Column(name = "connector_instance_current_status")
   @JsonProperty("connector_instance_current_status")
   @NotBlank
-  private String currentStatus;
+  private CURRENT_STATUS_TYPE currentStatus;
 
+  @Enumerated(EnumType.STRING)
   @Column(name = "connector_instance_requested_status")
   @JsonProperty("connector_instance_requested_status")
-  private String requestedStatus;
+  private REQUESTED_STATUS_TYPE requestedStatus;
 
   @Column(name = "connector_instance_restart_count")
   @JsonProperty("connector_instance_restart_count")
@@ -62,4 +74,13 @@ public class ConnectorInstance implements Base {
   @JsonProperty("connector_instance_configurations")
   @NotNull
   private Set<ConnectorInstanceConfiguration> configurations = new HashSet<>();
+
+  @OneToMany(
+      mappedBy = "connectorInstance",
+      fetch = FetchType.LAZY,
+      cascade = CascadeType.ALL,
+      orphanRemoval = true)
+  @JsonProperty("connector_instance_logs")
+  @NotNull
+  private Set<ConnectorInstanceLog> logs = new HashSet<>();
 }

openaev-model/src/main/java/io/openaev/database/model/ConnectorInstanceLog.java

@@ -0,0 +1,41 @@
+package io.openaev.database.model;
+
+import com.fasterxml.jackson.annotation.JsonIgnore;
+import com.fasterxml.jackson.annotation.JsonProperty;
+import com.fasterxml.jackson.databind.annotation.JsonSerialize;
+import io.openaev.database.audit.ModelBaseListener;
+import io.openaev.helper.MonoIdDeserializer;
+import io.swagger.v3.oas.annotations.media.Schema;
+import jakarta.persistence.*;
+import jakarta.validation.constraints.NotBlank;
+import jakarta.validation.constraints.NotNull;
+import lombok.Getter;
+import lombok.Setter;
+import org.hibernate.annotations.UuidGenerator;
+
+@Getter
+@Setter
+@Entity
+@Table(name = "connector_instance_logs")
+@EntityListeners(ModelBaseListener.class)
+public class ConnectorInstanceLog implements Base {
+  @Id
+  @Column(name = "connector_instance_log_id")
+  @GeneratedValue(generator = "UUID")
+  @UuidGenerator
+  @JsonProperty("connector_instance_log_id")
+  @NotBlank
+  private String id;
+
+  @Column(name = "connector_instance_log")
+  @JsonProperty("connector_instance_log")
+  @Schema(description = "Connector instance log")
+  private String log;
+
+  @ManyToOne(fetch = FetchType.LAZY)
+  @JoinColumn(name = "connector_instance_id", nullable = false)
+  @JsonIgnore
+  @NotNull
+  @JsonSerialize(using = MonoIdDeserializer.class)
+  private ConnectorInstance connectorInstance;
+}

openaev-model/src/main/java/io/openaev/database/repository/ConnectorInstanceLogRepository.java

@@ -0,0 +1,11 @@
+package io.openaev.database.repository;
+
+import io.openaev.database.model.ConnectorInstanceLog;
+import org.springframework.data.jpa.repository.JpaSpecificationExecutor;
+import org.springframework.data.repository.CrudRepository;
+import org.springframework.stereotype.Repository;
+
+@Repository
+public interface ConnectorInstanceLogRepository
+    extends CrudRepository<ConnectorInstanceLog, String>,
+        JpaSpecificationExecutor<ConnectorInstanceLog> {}