Iris: Add event service

src/main/java/de/tum/in/www1/artemis/domain/iris/settings/IrisCourseSettings.java

@@ -32,6 +32,10 @@ public class IrisCourseSettings extends IrisSettings {
     @JoinColumn(name = "iris_lecture_ingestion_settings_id")
     private IrisLectureIngestionSubSettings irisLectureIngestionSettings;
 
+    @OneToOne(cascade = CascadeType.ALL, orphanRemoval = true, fetch = FetchType.EAGER, optional = false)
+    @JoinColumn(name = "iris_proactivity_settings_id")
+    private IrisProactivitySubSettings irisProactivitySettings;
+
     @OneToOne(cascade = CascadeType.ALL, orphanRemoval = true, fetch = FetchType.EAGER)
     @JoinColumn(name = "iris_hestia_settings_id")
     private IrisHestiaSubSettings irisHestiaSettings;
@@ -63,6 +67,16 @@ public void setIrisLectureIngestionSettings(IrisLectureIngestionSubSettings iris
         this.irisLectureIngestionSettings = irisLectureIngestionSettings;
     }
 
+    @Override
+    public IrisProactivitySubSettings getIrisProactivitySettings() {
+        return irisProactivitySettings;
+    }
+
+    @Override
+    public void setIrisProactivitySettings(IrisProactivitySubSettings irisProactivitySettings) {
+        this.irisProactivitySettings = irisProactivitySettings;
+    }
+
     @Override
     public IrisChatSubSettings getIrisChatSettings() {
         return irisChatSettings;

src/main/java/de/tum/in/www1/artemis/domain/iris/settings/IrisExerciseSettings.java

@@ -50,6 +50,15 @@ public IrisLectureIngestionSubSettings getIrisLectureIngestionSettings() {
     public void setIrisLectureIngestionSettings(IrisLectureIngestionSubSettings irisLectureIngestionSettings) {
     }
 
+    @Override
+    public IrisProactivitySubSettings getIrisProactivitySettings() {
+        return null;
+    }
+
+    @Override
+    public void setIrisProactivitySettings(IrisProactivitySubSettings irisProactivitySettings) {
+    }
+
     @Override
     public IrisChatSubSettings getIrisChatSettings() {
         return irisChatSettings;

src/main/java/de/tum/in/www1/artemis/domain/iris/settings/IrisGlobalSettings.java

@@ -34,6 +34,9 @@ public class IrisGlobalSettings extends IrisSettings {
     @Column(name = "enable_auto_update_lecture_ingestion")
     private boolean enableAutoUpdateLectureIngestion;
 
+    @Column(name = "enable_auto_update_proactivity")
+    private boolean enableAutoUpdateProactivity;
+
     @Column(name = "enable_auto_update_competency_generation")
     private boolean enableAutoUpdateCompetencyGeneration;
 
@@ -45,6 +48,10 @@ public class IrisGlobalSettings extends IrisSettings {
     @JoinColumn(name = "iris_lecture_ingestion_settings_id")
     private IrisLectureIngestionSubSettings irisLectureIngestionSettings;
 
+    @OneToOne(cascade = CascadeType.ALL, orphanRemoval = true, fetch = FetchType.EAGER, optional = false)
+    @JoinColumn(name = "iris_proactivity_settings_id")
+    private IrisProactivitySubSettings irisProactivitySettings;
+
     @OneToOne(cascade = CascadeType.ALL, orphanRemoval = true, fetch = FetchType.EAGER, optional = false)
     @JoinColumn(name = "iris_hestia_settings_id")
     private IrisHestiaSubSettings irisHestiaSettings;
@@ -62,7 +69,9 @@ public boolean isValid() {
         var competencyGenerationSettingsValid = !Hibernate.isInitialized(irisCompetencyGenerationSettings) || irisCompetencyGenerationSettings == null
                 || (irisCompetencyGenerationSettings.getTemplate() != null && irisCompetencyGenerationSettings.getTemplate().getContent() != null
                         && !irisCompetencyGenerationSettings.getTemplate().getContent().isEmpty());
-        return chatSettingsValid && hestiaSettingsValid && competencyGenerationSettingsValid;
+        var proactivitySettingsValid = !Hibernate.isInitialized(irisProactivitySettings) || irisProactivitySettings == null
+                || (irisProactivitySettings.getEventSettings() != null && !irisProactivitySettings.getEventSettings().isEmpty());
+        return chatSettingsValid && hestiaSettingsValid && competencyGenerationSettingsValid && proactivitySettingsValid;
     }
 
     public int getCurrentVersion() {
@@ -105,6 +114,22 @@ public void setEnableAutoUpdateCompetencyGeneration(boolean enableAutoUpdateComp
         this.enableAutoUpdateCompetencyGeneration = enableAutoUpdateCompetencyGeneration;
     }
 
+    public boolean isEnableAutoUpdateProactivity() {
+        return enableAutoUpdateProactivity;
+    }
+
+    public void setEnableAutoUpdateProactivity(boolean enableAutoUpdateProactivity) {
+        this.enableAutoUpdateProactivity = enableAutoUpdateProactivity;
+    }
+
+    public IrisProactivitySubSettings getIrisProactivitySettings() {
+        return irisProactivitySettings;
+    }
+
+    public void setIrisProactivitySettings(IrisProactivitySubSettings irisProactivitySettings) {
+        this.irisProactivitySettings = irisProactivitySettings;
+    }
+
     @Override
     public IrisLectureIngestionSubSettings getIrisLectureIngestionSettings() {
         return irisLectureIngestionSettings;

src/main/java/de/tum/in/www1/artemis/domain/iris/settings/IrisProactivitySubSettings.java

@@ -0,0 +1,35 @@
+package de.tum.in.www1.artemis.domain.iris.settings;
+
+import java.util.HashSet;
+import java.util.Set;
+
+import jakarta.persistence.CascadeType;
+import jakarta.persistence.DiscriminatorValue;
+import jakarta.persistence.Entity;
+import jakarta.persistence.FetchType;
+import jakarta.persistence.OneToMany;
+
+import com.fasterxml.jackson.annotation.JsonInclude;
+
+import de.tum.in.www1.artemis.domain.iris.settings.event.IrisEventSettings;
+
+/**
+ * Represents the specific ingestion sub-settings of lectures for Iris.
+ * This class extends {@link IrisSubSettings} to provide settings required for lecture data ingestion.
+ */
+@Entity
+@DiscriminatorValue("PROACTIVITY")
+@JsonInclude(JsonInclude.Include.NON_EMPTY)
+public class IrisProactivitySubSettings extends IrisSubSettings {
+
+    @OneToMany(mappedBy = "proactivitySubSettings", cascade = CascadeType.ALL, orphanRemoval = true, fetch = FetchType.EAGER)
+    private Set<IrisEventSettings> eventSettings = new HashSet<>();
+
+    public Set<IrisEventSettings> getEventSettings() {
+        return eventSettings;
+    }
+
+    public void setEventSettings(Set<IrisEventSettings> proactivityStatuses) {
+        this.eventSettings = proactivityStatuses;
+    }
+}

src/main/java/de/tum/in/www1/artemis/domain/iris/settings/IrisSettings.java

@@ -49,6 +49,10 @@ public abstract class IrisSettings extends DomainObject {
 
     public abstract void setIrisLectureIngestionSettings(IrisLectureIngestionSubSettings irisLectureIngestionSettings);
 
+    public abstract IrisProactivitySubSettings getIrisProactivitySettings();
+
+    public abstract void setIrisProactivitySettings(IrisProactivitySubSettings irisProactivitySettings);
+
     public abstract IrisHestiaSubSettings getIrisHestiaSettings();
 
     public abstract void setIrisHestiaSettings(IrisHestiaSubSettings irisHestiaSettings);

src/main/java/de/tum/in/www1/artemis/domain/iris/settings/IrisSubSettings.java

@@ -42,7 +42,8 @@
     @JsonSubTypes.Type(value = IrisChatSubSettings.class, name = "chat"),
     @JsonSubTypes.Type(value = IrisLectureIngestionSubSettings.class, name = "lecture-ingestion"),
     @JsonSubTypes.Type(value = IrisHestiaSubSettings.class, name = "hestia"),
-    @JsonSubTypes.Type(value = IrisCompetencyGenerationSubSettings.class, name = "competency-generation")
+    @JsonSubTypes.Type(value = IrisCompetencyGenerationSubSettings.class, name = "competency-generation"),
+    @JsonSubTypes.Type(value = IrisProactivitySubSettings.class, name = "proactivity")
 })
 // @formatter:on
 @JsonInclude(JsonInclude.Include.NON_EMPTY)

src/main/java/de/tum/in/www1/artemis/domain/iris/settings/IrisSubSettingsType.java

@@ -1,5 +1,5 @@
 package de.tum.in.www1.artemis.domain.iris.settings;
 
 public enum IrisSubSettingsType {
-    CHAT, HESTIA, COMPETENCY_GENERATION, LECTURE_INGESTION
+    CHAT, HESTIA, COMPETENCY_GENERATION, LECTURE_INGESTION, PROACTIVITY
 }

src/main/java/de/tum/in/www1/artemis/domain/iris/settings/event/IrisEventLevel.java

@@ -0,0 +1,5 @@
+package de.tum.in.www1.artemis.domain.iris.settings.event;
+
+public enum IrisEventLevel {
+    EXERCISE, COURSE
+}

src/main/java/de/tum/in/www1/artemis/domain/iris/settings/event/IrisEventSettings.java

@@ -0,0 +1,145 @@
+package de.tum.in.www1.artemis.domain.iris.settings.event;
+
+import java.time.ZonedDateTime;
+
+import jakarta.persistence.Column;
+import jakarta.persistence.DiscriminatorColumn;
+import jakarta.persistence.DiscriminatorType;
+import jakarta.persistence.Entity;
+import jakarta.persistence.EnumType;
+import jakarta.persistence.Enumerated;
+import jakarta.persistence.Inheritance;
+import jakarta.persistence.InheritanceType;
+import jakarta.persistence.JoinColumn;
+import jakarta.persistence.ManyToOne;
+import jakarta.persistence.PrePersist;
+import jakarta.persistence.PreUpdate;
+import jakarta.persistence.Table;
+
+import javax.annotation.Nullable;
+
+import org.hibernate.annotations.Cache;
+import org.hibernate.annotations.CacheConcurrencyStrategy;
+
+import com.fasterxml.jackson.annotation.JsonIgnore;
+import com.fasterxml.jackson.annotation.JsonInclude;
+import com.fasterxml.jackson.annotation.JsonSubTypes;
+import com.fasterxml.jackson.annotation.JsonTypeInfo;
+
+import de.tum.in.www1.artemis.domain.DomainObject;
+import de.tum.in.www1.artemis.domain.iris.settings.IrisProactivitySubSettings;
+
+@Entity
+@Table(name = "iris_event_settings")
+@Inheritance(strategy = InheritanceType.SINGLE_TABLE)
+@DiscriminatorColumn(name = "discriminator", discriminatorType = DiscriminatorType.STRING)
+@Cache(usage = CacheConcurrencyStrategy.NONSTRICT_READ_WRITE)
+@JsonTypeInfo(use = JsonTypeInfo.Id.NAME, property = "type")
+// @formatter:off
+@JsonSubTypes({
+    @JsonSubTypes.Type(value = IrisSubmissionSuccessfulEventSettings.class, name = "submission_successful"),
+    @JsonSubTypes.Type(value = IrisSubmissionFailedEventSettings.class, name = "submission_failed"),
+    @JsonSubTypes.Type(value = IrisJolEventSettings.class, name = "jol")
+})
+@JsonInclude(JsonInclude.Include.NON_EMPTY)
+public abstract class IrisEventSettings extends DomainObject {
+    // Is event active
+    @Column(name = "is_active", nullable = false)
+    private boolean isActive;
+
+    // The date until which the event is deferred
+    @Nullable
+    @Column(name = "deferred_until")
+    private ZonedDateTime deferredUntil;
+
+    @Nullable
+    @Column(name="last_triggered")
+    private ZonedDateTime lastTriggered;
+
+    // The variant of the pipeline the event is associated with
+    @Column(name = "pipeline_variant", nullable = false)
+    private String pipelineVariant;
+
+    // The priority of the event
+    @Column(name = "priority", nullable = false)
+    private int priority;
+
+    // The level of the event which type of session the event will be triggered in
+    @Nullable
+    @Enumerated(EnumType.STRING)
+    @Column(name = "level")
+    private IrisEventLevel level;
+
+    @JsonIgnore
+    @ManyToOne
+    @JoinColumn(name = "iris_proactivity_settings_id")
+    private IrisProactivitySubSettings proactivitySubSettings;
+
+    @PrePersist
+    @PreUpdate
+    protected void onCreate() {
+        if (level == null) {
+            level = getDefaultLevel();
+        }
+        if (pipelineVariant == null) {
+            pipelineVariant = getDefaultPipelineVariant();
+        }
+    }
+
+    public IrisProactivitySubSettings getProactivitySubSettings() {
+        return proactivitySubSettings;
+    }
+
+    public void setProactivitySubSettings(IrisProactivitySubSettings proactivitySubSettings) {
+        this.proactivitySubSettings = proactivitySubSettings;
+    }
+
+    public boolean isActive() {
+        return isActive;
+    }
+
+    public void setActive(boolean active) {
+        isActive = active;
+    }
+
+    public ZonedDateTime getDeferredUntil() {
+        return deferredUntil;
+    }
+
+    public void setDeferredUntil(ZonedDateTime deferredUntil) {
+        this.deferredUntil = deferredUntil;
+    }
+
+    public String getPipelineVariant() {
+        return pipelineVariant;
+    }
+
+    public void setPipelineVariant(String pipelineVariant) {
+        this.pipelineVariant = pipelineVariant;
+    }
+
+    public int getPriority() {
+        return priority;
+    }
+
+    public void setPriority(int priority) {
+        this.priority = priority;
+    }
+
+    public IrisEventLevel getLevel() {
+        return level;
+    }
+
+    public void setLevel(IrisEventLevel level) {
+        this.level = level;
+    }
+
+    // Check if the event can be triggered
+    public boolean canBeTriggered() {
+        return isActive && (deferredUntil == null || deferredUntil.isBefore(ZonedDateTime.now()));
+    }
+
+    public abstract IrisEventLevel getDefaultLevel();
+
+    public abstract String getDefaultPipelineVariant();
+}

src/main/java/de/tum/in/www1/artemis/domain/iris/settings/event/IrisEventType.java

@@ -0,0 +1,5 @@
+package de.tum.in.www1.artemis.domain.iris.settings.event;
+
+public enum IrisEventType {
+    SUBMISSION_FAILED, SUBMISSION_SUCCESSFUL, JOL
+}

src/main/java/de/tum/in/www1/artemis/domain/iris/settings/event/IrisJolEventSettings.java

@@ -0,0 +1,22 @@
+package de.tum.in.www1.artemis.domain.iris.settings.event;
+
+import jakarta.persistence.DiscriminatorValue;
+import jakarta.persistence.Entity;
+
+import com.fasterxml.jackson.annotation.JsonInclude;
+
+@Entity
+@DiscriminatorValue("JOL")
+@JsonInclude(JsonInclude.Include.NON_EMPTY)
+public class IrisJolEventSettings extends IrisEventSettings {
+
+    @Override
+    public IrisEventLevel getDefaultLevel() {
+        return IrisEventLevel.COURSE;
+    }
+
+    @Override
+    public String getDefaultPipelineVariant() {
+        return "jol";
+    }
+}

src/main/java/de/tum/in/www1/artemis/domain/iris/settings/event/IrisSubmissionFailedEventSettings.java

@@ -0,0 +1,49 @@
+package de.tum.in.www1.artemis.domain.iris.settings.event;
+
+import jakarta.persistence.Column;
+import jakarta.persistence.DiscriminatorValue;
+import jakarta.persistence.Entity;
+
+import javax.annotation.Nullable;
+
+import com.fasterxml.jackson.annotation.JsonInclude;
+
+@Entity
+@DiscriminatorValue("SUBMISSION_FAILED")
+@JsonInclude(JsonInclude.Include.NON_EMPTY)
+public class IrisSubmissionFailedEventSettings extends IrisEventSettings {
+
+    // The number of failed attempts for the event to be triggered
+    @Column(name = "number_of_failed_attempts")
+    private Integer numberOfFailedAttempts;
+
+    @Nullable
+    @Column(name = "success_threshold")
+    private Double successThreshold;
+
+    public Integer getNumberOfFailedAttempts() {
+        return numberOfFailedAttempts;
+    }
+
+    public void setNumberOfFailedAttempts(Integer numberOfFailedAttempts) {
+        this.numberOfFailedAttempts = numberOfFailedAttempts;
+    }
+
+    public Double getSuccessThreshold() {
+        return successThreshold;
+    }
+
+    public void setSuccessThreshold(Double successThreshold) {
+        this.successThreshold = successThreshold;
+    }
+
+    @Override
+    public IrisEventLevel getDefaultLevel() {
+        return IrisEventLevel.EXERCISE;
+    }
+
+    @Override
+    public String getDefaultPipelineVariant() {
+        return "submission_failed";
+    }
+}