Iris: Integrate Memiris into the course chat (#11219)

Author: Hialus

src/main/java/de/tum/cit/aet/artemis/core/domain/User.java

@@ -198,6 +198,10 @@ public class User extends AbstractAuditingEntity implements Participant {
     @Column(name = "external_llm_usage_accepted")
     private ZonedDateTime externalLLMUsageAccepted = null;
 
+    @NotNull
+    @Column(name = "memiris_enabled", nullable = false)
+    private boolean memirisEnabled = false;
+
     @OneToOne(fetch = FetchType.LAZY, cascade = CascadeType.ALL, orphanRemoval = true)
     @JsonIgnoreProperties("user")
     @JoinColumn(name = "learner_profile_id")
@@ -526,4 +530,12 @@ public Bytes getExternalId() {
         }
         return BytesConverter.longToBytes(this.getId());
     }
+
+    public boolean isMemirisEnabled() {
+        return memirisEnabled;
+    }
+
+    public void setMemirisEnabled(boolean memirisEnabled) {
+        this.memirisEnabled = memirisEnabled;
+    }
 }

src/main/java/de/tum/cit/aet/artemis/core/dto/UserDTO.java

@@ -83,19 +83,21 @@ public class UserDTO extends AuditingEntityDTO {
 
     private ZonedDateTime externalLLMUsageAccepted;
 
+    private boolean memirisEnabled = false;
+
     public UserDTO() {
         // Empty constructor needed for Jackson.
     }
 
     public UserDTO(User user) {
         this(user.getId(), user.getLogin(), user.getName(), user.getFirstName(), user.getLastName(), user.getEmail(), user.getVisibleRegistrationNumber(), user.getActivated(),
                 user.getImageUrl(), user.getLangKey(), user.isInternal(), user.getCreatedBy(), user.getCreatedDate(), user.getLastModifiedBy(), user.getLastModifiedDate(),
-                user.getAuthorities(), user.getGroups(), user.getOrganizations(), user.getExternalLLMUsageAcceptedTimestamp());
+                user.getAuthorities(), user.getGroups(), user.getOrganizations(), user.getExternalLLMUsageAcceptedTimestamp(), user.isMemirisEnabled());
     }
 
     public UserDTO(Long id, String login, String name, String firstName, String lastName, String email, String visibleRegistrationNumber, boolean activated, String imageUrl,
             String langKey, boolean internal, String createdBy, Instant createdDate, String lastModifiedBy, Instant lastModifiedDate, Set<Authority> authorities,
-            Set<String> groups, Set<Organization> organizations, ZonedDateTime externalLLMUsageAccepted) {
+            Set<String> groups, Set<Organization> organizations, ZonedDateTime externalLLMUsageAccepted, boolean memirisEnabled) {
 
         this.id = id;
         this.login = login;
@@ -118,6 +120,7 @@ public UserDTO(Long id, String login, String name, String firstName, String last
         this.groups = groups;
         this.organizations = organizations;
         this.externalLLMUsageAccepted = externalLLMUsageAccepted;
+        this.memirisEnabled = memirisEnabled;
     }
 
     public Long getId() {
@@ -253,13 +256,6 @@ public boolean getAskToSetupPasskey() {
         return askToSetupPasskey;
     }
 
-    @Override
-    public String toString() {
-        return "UserDTO{" + "login='" + login + '\'' + ", firstName='" + firstName + '\'' + ", lastName='" + lastName + '\'' + ", email='" + email + '\'' + ", imageUrl='"
-                + imageUrl + '\'' + ", activated=" + activated + ", langKey='" + langKey + '\'' + ", createdBy=" + getCreatedBy() + ", createdDate=" + getCreatedDate()
-                + ", lastModifiedBy='" + getLastModifiedBy() + '\'' + ", lastModifiedDate=" + getLastModifiedDate() + ", authorities=" + authorities + "}";
-    }
-
     public boolean isInternal() {
         return internal;
     }
@@ -275,4 +271,19 @@ public ZonedDateTime getExternalLLMUsageAccepted() {
     public void setExternalLLMUsageAccepted(ZonedDateTime externalLLMUsageAccepted) {
         this.externalLLMUsageAccepted = externalLLMUsageAccepted;
     }
+
+    public boolean isMemirisEnabled() {
+        return memirisEnabled;
+    }
+
+    public void setMemirisEnabled(boolean memirisEnabled) {
+        this.memirisEnabled = memirisEnabled;
+    }
+
+    @Override
+    public String toString() {
+        return "UserDTO{" + "login='" + login + '\'' + ", firstName='" + firstName + '\'' + ", lastName='" + lastName + '\'' + ", email='" + email + '\'' + ", imageUrl='"
+                + imageUrl + '\'' + ", activated=" + activated + ", langKey='" + langKey + '\'' + ", createdBy=" + getCreatedBy() + ", createdDate=" + getCreatedDate()
+                + ", lastModifiedBy='" + getLastModifiedBy() + '\'' + ", lastModifiedDate=" + getLastModifiedDate() + ", authorities=" + authorities + "}";
+    }
 }

src/main/java/de/tum/cit/aet/artemis/core/repository/UserRepository.java

@@ -742,6 +742,15 @@ void updateUserVcsAccessToken(@Param("userId") long userId, @Param("vcsAccessTok
             """)
     void updateExternalLLMUsageAcceptedToDate(@Param("userId") long userId, @Param("acceptDatetime") ZonedDateTime acceptDatetime);
 
+    @Modifying
+    @Transactional // ok because of modifying query
+    @Query("""
+            UPDATE User user
+            SET user.memirisEnabled = :memirisEnabled
+            WHERE user.id = :userId
+            """)
+    void updateMemirisEnabled(@Param("userId") long userId, @Param("memirisEnabled") boolean memirisEnabled);
+
     @Query("""
             SELECT DISTINCT team.students AS student
             FROM Team team

src/main/java/de/tum/cit/aet/artemis/core/service/feature/Feature.java

@@ -2,5 +2,5 @@
 
 // Must be the same as FeatureToggle in feature-toggle.service.ts on the client side
 public enum Feature {
-    ProgrammingExercises, PlagiarismChecks, Exports, LearningPaths, Science, StandardizedCompetencies, StudentCourseAnalyticsDashboard, TutorSuggestions
+    ProgrammingExercises, PlagiarismChecks, Exports, LearningPaths, Science, StandardizedCompetencies, StudentCourseAnalyticsDashboard, TutorSuggestions, Memiris
 }

src/main/java/de/tum/cit/aet/artemis/core/service/feature/FeatureToggleService.java

@@ -75,9 +75,9 @@ private void initFeatures() {
         features = hazelcastInstance.getMap("features");
 
         // Features that are neither enabled nor disabled should be enabled by default
-        // This ensures that all features (except the Science API and TutorSuggestions) are enabled once the system starts up
+        // This ensures that all features (except the Science API, TutorSuggestions, and Memiris) are enabled once the system starts up
         for (Feature feature : Feature.values()) {
-            if (!features.containsKey(feature) && feature != Feature.Science && feature != Feature.TutorSuggestions) {
+            if (!features.containsKey(feature) && feature != Feature.Science && feature != Feature.TutorSuggestions && feature != Feature.Memiris) {
                 features.put(feature, true);
             }
         }
@@ -89,6 +89,10 @@ private void initFeatures() {
         if (!features.containsKey(Feature.TutorSuggestions)) {
             features.put(Feature.TutorSuggestions, false);
         }
+
+        if (!features.containsKey(Feature.Memiris)) {
+            features.put(Feature.Memiris, false);
+        }
     }
 
     /**

src/main/java/de/tum/cit/aet/artemis/core/web/AccountResource.java

@@ -255,4 +255,18 @@ public ResponseEntity<Void> removeProfilePicture() throws URISyntaxException {
         }
         return ResponseEntity.ok().build();
     }
+
+    /**
+     * PUT account/enable-memiris : sets the memirisEnabled flag for the user to true or false.
+     *
+     * @param memirisEnabled the boolean indicating whether Memiris is enabled or not
+     * @return the ResponseEntity with status 200 (OK)
+     */
+    @PutMapping("account/enable-memiris")
+    @EnforceAtLeastStudent
+    public ResponseEntity<Void> setMemirisEnabled(@RequestBody boolean memirisEnabled) {
+        User user = userRepository.getUser();
+        userRepository.updateMemirisEnabled(user.getId(), memirisEnabled);
+        return ResponseEntity.ok().build();
+    }
 }

src/main/java/de/tum/cit/aet/artemis/iris/domain/message/IrisMessage.java

@@ -20,13 +20,16 @@
 
 import org.hibernate.annotations.Cache;
 import org.hibernate.annotations.CacheConcurrencyStrategy;
+import org.hibernate.annotations.JdbcTypeCode;
+import org.hibernate.type.SqlTypes;
 
 import com.fasterxml.jackson.annotation.JsonIgnore;
 import com.fasterxml.jackson.annotation.JsonInclude;
 import com.fasterxml.jackson.annotation.JsonProperty;
 
 import de.tum.cit.aet.artemis.core.domain.DomainObject;
 import de.tum.cit.aet.artemis.iris.domain.session.IrisSession;
+import de.tum.cit.aet.artemis.iris.dto.MemirisMemoryDTO;
 
 /**
  * An IrisMessage represents a single message in an IrisSession.
@@ -59,6 +62,14 @@ public class IrisMessage extends DomainObject {
     @OneToMany(mappedBy = "message", fetch = FetchType.EAGER, cascade = CascadeType.ALL, orphanRemoval = true)
     private List<IrisMessageContent> content = new ArrayList<>();
 
+    @JdbcTypeCode(SqlTypes.JSON)
+    @Column(name = "accessed_memories", columnDefinition = "json")
+    private List<MemirisMemoryDTO> accessedMemories = new ArrayList<>();
+
+    @JdbcTypeCode(SqlTypes.JSON)
+    @Column(name = "created_memories", columnDefinition = "json")
+    private List<MemirisMemoryDTO> createdMemories = 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
 
@@ -111,6 +122,22 @@ public void addContent(IrisMessageContent... content) {
         }
     }
 
+    public List<MemirisMemoryDTO> getAccessedMemories() {
+        return accessedMemories;
+    }
+
+    public void setAccessedMemories(List<MemirisMemoryDTO> accessedMemories) {
+        this.accessedMemories = accessedMemories;
+    }
+
+    public List<MemirisMemoryDTO> getCreatedMemories() {
+        return createdMemories;
+    }
+
+    public void setCreatedMemories(List<MemirisMemoryDTO> createdMemories) {
+        this.createdMemories = createdMemories;
+    }
+
     @JsonProperty
     public Integer getMessageDifferentiator() {
         return messageDifferentiator;

src/main/java/de/tum/cit/aet/artemis/iris/dto/MemirisMemoryDTO.java

@@ -0,0 +1,9 @@
+package de.tum.cit.aet.artemis.iris.dto;
+
+import java.util.List;
+
+import com.fasterxml.jackson.annotation.JsonInclude;
+
+@JsonInclude(JsonInclude.Include.NON_EMPTY)
+public record MemirisMemoryDTO(String id, String title, String content, List<String> learnings, List<String> connections, boolean slept_on, boolean deleted) {
+}

src/main/java/de/tum/cit/aet/artemis/iris/service/pyris/PyrisJobService.java

@@ -103,14 +103,14 @@ public String createTokenForJob(Function<String, PyrisJob> tokenToJobFunction) {
 
     public String addExerciseChatJob(Long courseId, Long exerciseId, Long sessionId) {
         var token = generateJobIdToken();
-        var job = new ExerciseChatJob(token, courseId, exerciseId, sessionId, null);
+        var job = new ExerciseChatJob(token, courseId, exerciseId, sessionId, null, null, null);
         getPyrisJobMap().put(token, job);
         return token;
     }
 
-    public String addCourseChatJob(Long courseId, Long sessionId) {
+    public String addCourseChatJob(Long courseId, Long sessionId, Long userMessageId) {
         var token = generateJobIdToken();
-        var job = new CourseChatJob(token, courseId, sessionId, null);
+        var job = new CourseChatJob(token, courseId, sessionId, null, userMessageId, null);
         getPyrisJobMap().put(token, job);
         return token;
     }
@@ -125,7 +125,7 @@ public String addCourseChatJob(Long courseId, Long sessionId) {
      */
     public String addTutorSuggestionJob(Long postId, Long courseId, Long sessionId) {
         var token = generateJobIdToken();
-        var job = new TutorSuggestionJob(token, postId, courseId, sessionId, null);
+        var job = new TutorSuggestionJob(token, postId, courseId, sessionId, null, null, null);
         getPyrisJobMap().put(token, job);
         return token;
     }

src/main/java/de/tum/cit/aet/artemis/iris/service/pyris/PyrisPipelineService.java

@@ -28,6 +28,8 @@
 import de.tum.cit.aet.artemis.core.domain.Course;
 import de.tum.cit.aet.artemis.core.repository.UserRepository;
 import de.tum.cit.aet.artemis.core.service.course.CourseLoadService;
+import de.tum.cit.aet.artemis.core.service.feature.Feature;
+import de.tum.cit.aet.artemis.core.service.feature.FeatureToggleService;
 import de.tum.cit.aet.artemis.exercise.domain.Exercise;
 import de.tum.cit.aet.artemis.exercise.domain.participation.StudentParticipation;
 import de.tum.cit.aet.artemis.exercise.repository.StudentParticipationRepository;
@@ -81,12 +83,14 @@ public class PyrisPipelineService {
 
     private final UserRepository userRepository;
 
+    private final FeatureToggleService featureToggleService;
+
     @Value("${server.url}")
     private String artemisBaseUrl;
 
     public PyrisPipelineService(PyrisConnectorService pyrisConnectorService, PyrisJobService pyrisJobService, PyrisDTOService pyrisDTOService,
             IrisChatWebsocketService irisChatWebsocketService, Optional<LearningMetricsApi> learningMetricsApi, StudentParticipationRepository studentParticipationRepository,
-            UserRepository userRepository, CourseLoadService courseLoadService) {
+            UserRepository userRepository, CourseLoadService courseLoadService, FeatureToggleService featureToggleService) {
         this.pyrisConnectorService = pyrisConnectorService;
         this.pyrisJobService = pyrisJobService;
         this.pyrisDTOService = pyrisDTOService;
@@ -95,6 +99,7 @@ public PyrisPipelineService(PyrisConnectorService pyrisConnectorService, PyrisJo
         this.studentParticipationRepository = studentParticipationRepository;
         this.userRepository = userRepository;
         this.courseLoadService = courseLoadService;
+        this.featureToggleService = featureToggleService;
     }
 
     /**
@@ -210,13 +215,17 @@ private <T, U> void executeCourseChatPipeline(String variant, String customInstr
         var api = learningMetricsApi.orElseThrow(() -> new AtlasNotPresentException(LearningMetricsApi.class));
 
         // @formatter:off
+        var lastMessageId = !session.getMessages().isEmpty() ? session.getMessages().getLast().getId() : null;
         executePipeline(
             "course-chat",
             variant,
             eventVariant,
-            pyrisJobService.addCourseChatJob(courseId, session.getId()), executionDto -> {
+            pyrisJobService.addCourseChatJob(courseId, session.getId(), lastMessageId), executionDto -> {
                 var fullCourse = loadCourseWithParticipationOfStudent(courseId, studentId);
                 var user = userRepository.findByIdElseThrow(studentId);
+                if (!featureToggleService.isFeatureEnabled(Feature.Memiris)) {
+                    user.setMemirisEnabled(false);
+                }
                 return new PyrisCourseChatPipelineExecutionDTO<>(
                     PyrisExtendedCourseDTO.of(fullCourse),
                     api.getStudentCourseMetrics(studentId, courseId),