Iris: Add chatbot to code editor page for exercise creation assistance

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

@@ -15,7 +15,7 @@
 
 /**
  * An IrisTemplate represents a handlebars template for Iris.
- * It is send to the Iris Python server to generate a response.
+ * It is sent to the Iris Python server to generate a response.
  */
 @Entity
 @Table(name = "iris_template")

src/main/java/de/tum/in/www1/artemis/domain/iris/message/ExerciseComponent.java

@@ -0,0 +1,5 @@
+package de.tum.in.www1.artemis.domain.iris.message;
+
+public enum ExerciseComponent {
+    PROBLEM_STATEMENT, SOLUTION_REPOSITORY, TEMPLATE_REPOSITORY, TEST_REPOSITORY
+}

src/main/java/de/tum/in/www1/artemis/domain/iris/message/IrisExercisePlanComponent.java

@@ -0,0 +1,63 @@
+package de.tum.in.www1.artemis.domain.iris.message;
+
+import javax.persistence.*;
+import javax.validation.constraints.NotNull;
+
+import com.fasterxml.jackson.annotation.JsonIgnore;
+import com.fasterxml.jackson.annotation.JsonInclude;
+
+import de.tum.in.www1.artemis.domain.DomainObject;
+
+@Entity
+@Table(name = "iris_exercise_plan_component")
+@JsonInclude(JsonInclude.Include.NON_EMPTY)
+public class IrisExercisePlanComponent extends DomainObject {
+
+    @ManyToOne
+    @JoinColumn(name = "exercise_plan_id")
+    @JsonIgnore
+    private IrisExercisePlanMessageContent exercisePlan;
+
+    @NotNull
+    @Enumerated(value = EnumType.STRING)
+    @Column(name = "exercise_component")
+    private ExerciseComponent component;
+
+    @NotNull
+    @Column(name = "instructions")
+    private String instructions;
+
+    public IrisExercisePlanComponent() {
+    }
+
+    public IrisExercisePlanComponent(IrisExercisePlanMessageContent exercisePlan, ExerciseComponent component, String instructions) {
+        this.exercisePlan = exercisePlan;
+        this.component = component;
+        this.instructions = instructions;
+    }
+
+    public IrisExercisePlanMessageContent getExercisePlan() {
+        return exercisePlan;
+    }
+
+    public void setExercisePlan(IrisExercisePlanMessageContent plan) {
+        this.exercisePlan = plan;
+    }
+
+    public ExerciseComponent getComponent() {
+        return component;
+    }
+
+    public void setComponent(ExerciseComponent component) {
+        this.component = component;
+    }
+
+    public String getInstructions() {
+        return instructions;
+    }
+
+    public void setInstructions(String instructions) {
+        this.instructions = instructions;
+    }
+
+}

src/main/java/de/tum/in/www1/artemis/domain/iris/message/IrisExercisePlanMessageContent.java

@@ -0,0 +1,80 @@
+package de.tum.in.www1.artemis.domain.iris.message;
+
+import java.util.Iterator;
+import java.util.List;
+
+import javax.persistence.*;
+
+import com.fasterxml.jackson.annotation.JsonInclude;
+
+/**
+ * An IrisExercisePlanMessageContent represents an Iris-generated plan to make changes to an exercise.
+ * The plans may or may not have been edited by the user before execution.
+ */
+@Entity
+@Table(name = "iris_exercise_plan_message_content")
+@DiscriminatorValue(value = "EXERCISE_PLAN")
+@JsonInclude(JsonInclude.Include.NON_EMPTY)
+public class IrisExercisePlanMessageContent extends IrisMessageContent implements Iterator<IrisExercisePlanComponent> {
+
+    @OneToMany(mappedBy = "exercisePlan", cascade = CascadeType.ALL, orphanRemoval = true, fetch = FetchType.EAGER)
+    private List<IrisExercisePlanComponent> components;
+
+    @Column(name = "current_component_index")
+    private short currentComponentIndex = 0;
+
+    @Transient
+    private boolean executing = false;
+
+    public List<IrisExercisePlanComponent> getComponents() {
+        return components;
+    }
+
+    public void setComponents(List<IrisExercisePlanComponent> components) {
+        this.components = components;
+    }
+
+    public short getCurrentComponentIndex() {
+        return currentComponentIndex;
+    }
+
+    public void setCurrentComponentIndex(short currentInstructionIndex) {
+        this.currentComponentIndex = currentInstructionIndex;
+    }
+
+    public boolean isExecuting() {
+        return executing;
+    }
+
+    public void setExecuting(boolean executing) {
+        this.executing = executing;
+    }
+
+    @Override
+    public boolean hasNext() {
+        return currentComponentIndex < components.size();
+    }
+
+    @Override
+    public IrisExercisePlanComponent next() {
+        if (!hasNext()) {
+            throw new IllegalStateException("No more instructions available");
+        }
+        return components.get(currentComponentIndex++);
+    }
+
+    @Override
+    public String getContentAsString() {
+        var sb = new StringBuilder("Exercise plan:\n");
+        for (var entry : components) {
+            sb.append(entry.getComponent().toString()).append(": \"").append(entry.getInstructions()).append("\"\n");
+        }
+        return sb.toString();
+    }
+
+    @Override
+    public String toString() {
+        return "IrisExercisePlanMessageContent{" + "message=" + (message == null ? "null" : message.getId()) + ", components=" + components + ", currentInstructionIndex="
+                + currentComponentIndex + '}';
+    }
+}

src/main/java/de/tum/in/www1/artemis/domain/iris/IrisMessage.java → src/main/java/de/tum/in/www1/artemis/domain/iris/message/IrisMessage.java

@@ -1,4 +1,4 @@
-package de.tum.in.www1.artemis.domain.iris;
+package de.tum.in.www1.artemis.domain.iris.message;
 
 import java.time.ZonedDateTime;
 import java.util.ArrayList;
@@ -19,8 +19,7 @@
 
 /**
  * An IrisMessage represents a single message in an IrisSession.
- * A message can be created by either the user, an LLM, or Artemis.
- * Artemis messages are used to give commands to the bot and are not displayed to the user.
+ * The message may contain multiple pieces of content with different types.
  */
 @Entity
 @Table(name = "iris_message")
@@ -34,7 +33,7 @@
 
     @Nullable
     @Column(name = "sent_at")
-    private ZonedDateTime sentAt;
+    private ZonedDateTime sentAt = ZonedDateTime.now();
 
     @Nullable
     @Column(name = "helpful")
@@ -44,13 +43,13 @@
     @Enumerated(EnumType.STRING)
     private IrisMessageSender sender;
 
-    @Transient
-    private Integer messageDifferentiator; // is supposed to be only a part of the dto and helps the client application to differentiate messages it should add to the message store
-
     @OrderColumn(name = "iris_message_content_order")
-    @OneToMany(mappedBy = "message", fetch = FetchType.LAZY, cascade = CascadeType.ALL, orphanRemoval = true)
+    @OneToMany(mappedBy = "message", fetch = FetchType.EAGER, cascade = CascadeType.ALL, orphanRemoval = true)
     private List<IrisMessageContent> content = new ArrayList<>();
 
+    @Transient
+    private Integer messageDifferentiator; // is supposed to be only a part of the dto and helps the client application to differentiate messages it should add to the message store
+
     public IrisSession getSession() {
         return session;
     }
@@ -93,6 +92,10 @@
         this.content = content;
     }
 
+    public void addContent(IrisMessageContent content) {
+        this.content.add(content);
+    }
+
     @JsonProperty
     public Integer getMessageDifferentiator() {
         return messageDifferentiator;

src/main/java/de/tum/in/www1/artemis/domain/iris/message/IrisMessageContent.java

@@ -0,0 +1,47 @@
+package de.tum.in.www1.artemis.domain.iris.message;
+
+import javax.annotation.Nullable;
+import javax.persistence.*;
+
+import org.hibernate.annotations.Cache;
+import org.hibernate.annotations.CacheConcurrencyStrategy;
+
+import com.fasterxml.jackson.annotation.*;
+
+import de.tum.in.www1.artemis.domain.*;
+
+@Entity
+@Table(name = "iris_message_content")
+@Inheritance(strategy = InheritanceType.JOINED)
+@DiscriminatorColumn(name = "discriminator")
+@Cache(usage = CacheConcurrencyStrategy.NONSTRICT_READ_WRITE)
+@JsonTypeInfo(use = JsonTypeInfo.Id.NAME, property = "type")
+@JsonSubTypes({ @JsonSubTypes.Type(value = IrisTextMessageContent.class, name = "text"),
+        @JsonSubTypes.Type(value = IrisExercisePlanMessageContent.class, name = "exercise-plan"), })
+@JsonInclude(JsonInclude.Include.NON_EMPTY)
+public abstract class IrisMessageContent extends DomainObject {
+
+    @ManyToOne
+    @JsonIgnore
+    IrisMessage message;
+
+    // Required by JPA
+    public IrisMessageContent() {
+    }
+
+    public IrisMessageContent(IrisMessage irisMessage) {
+        this.message = irisMessage;
+    }
+
+    public IrisMessage getMessage() {
+        return message;
+    }
+
+    public void setMessage(IrisMessage message) {
+        this.message = message;
+    }
+
+    @Nullable
+    public abstract String getContentAsString();
+
+}

src/main/java/de/tum/in/www1/artemis/domain/iris/message/IrisMessageSender.java

@@ -0,0 +1,11 @@
+package de.tum.in.www1.artemis.domain.iris.message;
+
+/**
+ * This enum represents the different senders of Iris messages.
+ * USER: A message sent by a user of the system
+ * LLM: A message generated by a large language model
+ * ARTEMIS: A message generated by the system itself
+ */
+public enum IrisMessageSender {
+    USER, LLM, ARTEMIS
+}