Development: Minimize messages response payload

src/main/java/de/tum/in/www1/artemis/domain/BaseExercise.java

@@ -8,6 +8,7 @@
 import javax.persistence.Enumerated;
 import javax.persistence.MappedSuperclass;
 
+import com.fasterxml.jackson.annotation.JsonIgnore;
 import com.fasterxml.jackson.annotation.JsonView;
 
 import de.tum.in.www1.artemis.domain.enumeration.AssessmentType;
@@ -241,6 +242,7 @@ protected static boolean isNotAfterAndNotNull(ZonedDateTime previousDate, ZonedD
      *
      * @return the sanitized exercise title
      **/
+    @JsonIgnore
     public String getSanitizedExerciseTitle() {
         if (title == null) {
             return "exercise";

src/main/java/de/tum/in/www1/artemis/domain/Exercise.java

@@ -707,6 +707,7 @@ public void setStudentAssignedTeamId(Long studentAssignedTeamIdTransient) {
         this.studentAssignedTeamIdTransient = studentAssignedTeamIdTransient;
     }
 
+    // TODO: do we really need this information in all places in the client? I doubt this, we should probably JsonIgnore this in most cases
     public boolean isStudentAssignedTeamIdComputed() {
         return studentAssignedTeamIdComputedTransient;
     }
@@ -715,6 +716,7 @@ public void setStudentAssignedTeamIdComputed(boolean studentAssignedTeamIdComput
         this.studentAssignedTeamIdComputedTransient = studentAssignedTeamIdComputedTransient;
     }
 
+    // TODO: do we really need this information in all places in the client? I doubt this, we should probably JsonIgnore this in most cases
     public boolean isGradingInstructionFeedbackUsed() {
         return isGradingInstructionFeedbackUsedTransient;
     }

src/main/java/de/tum/in/www1/artemis/domain/FileUploadExercise.java

@@ -5,7 +5,6 @@
 import javax.persistence.*;
 
 import com.fasterxml.jackson.annotation.JsonInclude;
-import com.fasterxml.jackson.annotation.JsonTypeName;
 
 import de.tum.in.www1.artemis.domain.enumeration.ExerciseType;
 
@@ -14,7 +13,6 @@
  */
 @Entity
 @DiscriminatorValue(value = "F")
-@JsonTypeName("file-upload")
 @JsonInclude(JsonInclude.Include.NON_EMPTY)
 public class FileUploadExercise extends Exercise {
 

src/main/java/de/tum/in/www1/artemis/domain/FileUploadSubmission.java

@@ -7,7 +7,6 @@
 import org.apache.commons.lang3.math.NumberUtils;
 
 import com.fasterxml.jackson.annotation.JsonInclude;
-import com.fasterxml.jackson.annotation.JsonTypeName;
 
 import de.tum.in.www1.artemis.exception.FilePathParsingException;
 import de.tum.in.www1.artemis.service.FilePathService;
@@ -18,7 +17,6 @@
  */
 @Entity
 @DiscriminatorValue(value = "F")
-@JsonTypeName("file-upload")
 @JsonInclude(JsonInclude.Include.NON_EMPTY)
 public class FileUploadSubmission extends Submission {
 

src/main/java/de/tum/in/www1/artemis/domain/ProgrammingExercise.java

@@ -36,7 +36,6 @@
  */
 @Entity
 @DiscriminatorValue(value = "P")
-@JsonTypeName("programming")
 @SecondaryTable(name = "programming_exercise_details")
 @JsonInclude(JsonInclude.Include.NON_EMPTY)
 public class ProgrammingExercise extends Exercise {

src/main/java/de/tum/in/www1/artemis/domain/ProgrammingSubmission.java

@@ -13,7 +13,6 @@
 
 import com.fasterxml.jackson.annotation.JsonIgnoreProperties;
 import com.fasterxml.jackson.annotation.JsonInclude;
-import com.fasterxml.jackson.annotation.JsonTypeName;
 
 import de.tum.in.www1.artemis.domain.enumeration.SubmissionType;
 import de.tum.in.www1.artemis.domain.participation.Participation;
@@ -24,7 +23,6 @@
  */
 @Entity
 @DiscriminatorValue(value = "P")
-@JsonTypeName("programming")
 @JsonInclude(JsonInclude.Include.NON_EMPTY)
 public class ProgrammingSubmission extends Submission {
 

src/main/java/de/tum/in/www1/artemis/domain/TextExercise.java

@@ -5,7 +5,6 @@
 import javax.persistence.*;
 
 import com.fasterxml.jackson.annotation.JsonInclude;
-import com.fasterxml.jackson.annotation.JsonTypeName;
 
 import de.tum.in.www1.artemis.domain.enumeration.AssessmentType;
 import de.tum.in.www1.artemis.domain.enumeration.ExerciseType;
@@ -15,7 +14,6 @@
  */
 @Entity
 @DiscriminatorValue(value = "T")
-@JsonTypeName("text")
 @SecondaryTable(name = "text_exercise_details")
 @JsonInclude(JsonInclude.Include.NON_EMPTY)
 public class TextExercise extends Exercise {

src/main/java/de/tum/in/www1/artemis/domain/TextSubmission.java

@@ -11,7 +11,6 @@
 import com.fasterxml.jackson.annotation.JsonIgnore;
 import com.fasterxml.jackson.annotation.JsonIgnoreProperties;
 import com.fasterxml.jackson.annotation.JsonInclude;
-import com.fasterxml.jackson.annotation.JsonTypeName;
 
 import de.tum.in.www1.artemis.domain.enumeration.Language;
 
@@ -20,7 +19,6 @@
  */
 @Entity
 @DiscriminatorValue(value = "T")
-@JsonTypeName("text")
 @JsonInclude(JsonInclude.Include.NON_EMPTY)
 public class TextSubmission extends Submission {
 

src/main/java/de/tum/in/www1/artemis/domain/modeling/ModelingExercise.java

@@ -8,7 +8,6 @@
 
 import com.fasterxml.jackson.annotation.JsonIgnore;
 import com.fasterxml.jackson.annotation.JsonInclude;
-import com.fasterxml.jackson.annotation.JsonTypeName;
 
 import de.tum.in.www1.artemis.domain.Exercise;
 import de.tum.in.www1.artemis.domain.enumeration.DiagramType;
@@ -19,7 +18,6 @@
  */
 @Entity
 @DiscriminatorValue(value = "M")
-@JsonTypeName("modeling")
 @SecondaryTable(name = "model_exercise_details")
 @JsonInclude(JsonInclude.Include.NON_EMPTY)
 public class ModelingExercise extends Exercise {

src/main/java/de/tum/in/www1/artemis/domain/modeling/ModelingSubmission.java

@@ -12,7 +12,6 @@
 import org.springframework.util.StringUtils;
 
 import com.fasterxml.jackson.annotation.JsonInclude;
-import com.fasterxml.jackson.annotation.JsonTypeName;
 import com.fasterxml.jackson.core.JsonProcessingException;
 import com.fasterxml.jackson.databind.ObjectMapper;
 import com.fasterxml.jackson.databind.annotation.JsonSerialize;
@@ -24,7 +23,6 @@
  */
 @Entity
 @DiscriminatorValue(value = "M")
-@JsonTypeName("modeling")
 @JsonInclude(JsonInclude.Include.NON_EMPTY)
 public class ModelingSubmission extends Submission {
 

src/main/java/de/tum/in/www1/artemis/domain/quiz/DragAndDropQuestion.java

@@ -9,7 +9,6 @@
 
 import com.fasterxml.jackson.annotation.JsonIgnore;
 import com.fasterxml.jackson.annotation.JsonInclude;
-import com.fasterxml.jackson.annotation.JsonTypeName;
 import com.fasterxml.jackson.annotation.JsonView;
 
 import de.tum.in.www1.artemis.config.Constants;
@@ -23,7 +22,6 @@
  */
 @Entity
 @DiscriminatorValue(value = "DD")
-@JsonTypeName("drag-and-drop")
 @JsonInclude(JsonInclude.Include.NON_EMPTY)
 public class DragAndDropQuestion extends QuizQuestion {
 

src/main/java/de/tum/in/www1/artemis/domain/quiz/DragAndDropQuestionStatistic.java

@@ -9,14 +9,12 @@
 import org.hibernate.annotations.CacheConcurrencyStrategy;
 
 import com.fasterxml.jackson.annotation.JsonInclude;
-import com.fasterxml.jackson.annotation.JsonTypeName;
 
 /**
  * A DragAndDropQuestionStatistic.
  */
 @Entity
 @DiscriminatorValue(value = "DD")
-@JsonTypeName("drag-and-drop")
 @JsonInclude(JsonInclude.Include.NON_EMPTY)
 public class DragAndDropQuestionStatistic extends QuizQuestionStatistic {
 

src/main/java/de/tum/in/www1/artemis/domain/quiz/DragAndDropSubmittedAnswer.java

@@ -10,7 +10,6 @@
 import org.hibernate.annotations.CacheConcurrencyStrategy;
 
 import com.fasterxml.jackson.annotation.JsonInclude;
-import com.fasterxml.jackson.annotation.JsonTypeName;
 import com.fasterxml.jackson.annotation.JsonView;
 
 import de.tum.in.www1.artemis.domain.quiz.compare.DnDMapping;
@@ -21,7 +20,6 @@
  */
 @Entity
 @DiscriminatorValue(value = "DD")
-@JsonTypeName("drag-and-drop")
 @JsonInclude(JsonInclude.Include.NON_EMPTY)
 public class DragAndDropSubmittedAnswer extends SubmittedAnswer {
 

src/main/java/de/tum/in/www1/artemis/domain/quiz/MultipleChoiceQuestion.java

@@ -9,7 +9,6 @@
 
 import com.fasterxml.jackson.annotation.JsonIgnore;
 import com.fasterxml.jackson.annotation.JsonInclude;
-import com.fasterxml.jackson.annotation.JsonTypeName;
 import com.fasterxml.jackson.annotation.JsonView;
 
 import de.tum.in.www1.artemis.domain.enumeration.ScoringType;
@@ -21,7 +20,6 @@
  */
 @Entity
 @DiscriminatorValue(value = "MC")
-@JsonTypeName("multiple-choice")
 @JsonInclude(JsonInclude.Include.NON_EMPTY)
 public class MultipleChoiceQuestion extends QuizQuestion {
 

src/main/java/de/tum/in/www1/artemis/domain/quiz/MultipleChoiceQuestionStatistic.java

@@ -9,14 +9,12 @@
 import org.hibernate.annotations.CacheConcurrencyStrategy;
 
 import com.fasterxml.jackson.annotation.JsonInclude;
-import com.fasterxml.jackson.annotation.JsonTypeName;
 
 /**
  * A MultipleChoiceQuestionStatistic.
  */
 @Entity
 @DiscriminatorValue(value = "MC")
-@JsonTypeName("multiple-choice")
 @JsonInclude(JsonInclude.Include.NON_EMPTY)
 public class MultipleChoiceQuestionStatistic extends QuizQuestionStatistic {
 

src/main/java/de/tum/in/www1/artemis/domain/quiz/MultipleChoiceSubmittedAnswer.java

@@ -11,7 +11,6 @@
 import org.hibernate.annotations.CacheConcurrencyStrategy;
 
 import com.fasterxml.jackson.annotation.JsonInclude;
-import com.fasterxml.jackson.annotation.JsonTypeName;
 import com.fasterxml.jackson.annotation.JsonView;
 
 import de.tum.in.www1.artemis.domain.DomainObject;
@@ -22,7 +21,6 @@
  */
 @Entity
 @DiscriminatorValue(value = "MC")
-@JsonTypeName("multiple-choice")
 @JsonInclude(JsonInclude.Include.NON_EMPTY)
 public class MultipleChoiceSubmittedAnswer extends SubmittedAnswer {
 

src/main/java/de/tum/in/www1/artemis/domain/quiz/QuizExercise.java

@@ -33,7 +33,6 @@
  */
 @Entity
 @DiscriminatorValue(value = "Q")
-@JsonTypeName("quiz")
 @JsonInclude(JsonInclude.Include.NON_EMPTY)
 public class QuizExercise extends Exercise implements QuizConfiguration {
 

src/main/java/de/tum/in/www1/artemis/domain/quiz/QuizQuestion.java

@@ -22,8 +22,13 @@
 @DiscriminatorValue(value = "Q")
 @Cache(usage = CacheConcurrencyStrategy.NONSTRICT_READ_WRITE)
 @JsonTypeInfo(use = JsonTypeInfo.Id.NAME, property = "type")
-@JsonSubTypes({ @JsonSubTypes.Type(value = MultipleChoiceQuestion.class, name = "multiple-choice"), @JsonSubTypes.Type(value = DragAndDropQuestion.class, name = "drag-and-drop"),
-        @JsonSubTypes.Type(value = ShortAnswerQuestion.class, name = "short-answer") })
+// @formatter:off
+@JsonSubTypes({
+    @JsonSubTypes.Type(value = MultipleChoiceQuestion.class, name = "multiple-choice"),
+    @JsonSubTypes.Type(value = DragAndDropQuestion.class, name = "drag-and-drop"),
+    @JsonSubTypes.Type(value = ShortAnswerQuestion.class, name = "short-answer") }
+)
+// @formatter:on
 @JsonInclude(JsonInclude.Include.NON_EMPTY)
 public abstract class QuizQuestion extends DomainObject {
 

src/main/java/de/tum/in/www1/artemis/domain/quiz/QuizSubmission.java

@@ -3,14 +3,12 @@
 import javax.persistence.*;
 
 import com.fasterxml.jackson.annotation.JsonInclude;
-import com.fasterxml.jackson.annotation.JsonTypeName;
 
 /**
  * A QuizSubmission.
  */
 @Entity
 @DiscriminatorValue(value = "Q")
-@JsonTypeName("quiz")
 @JsonInclude(JsonInclude.Include.NON_EMPTY)
 public class QuizSubmission extends AbstractQuizSubmission {
 

src/main/java/de/tum/in/www1/artemis/domain/quiz/ShortAnswerQuestion.java

@@ -9,7 +9,6 @@
 
 import com.fasterxml.jackson.annotation.JsonIgnore;
 import com.fasterxml.jackson.annotation.JsonInclude;
-import com.fasterxml.jackson.annotation.JsonTypeName;
 import com.fasterxml.jackson.annotation.JsonView;
 
 import de.tum.in.www1.artemis.domain.quiz.scoring.*;
@@ -20,7 +19,6 @@
  */
 @Entity
 @DiscriminatorValue(value = "SA")
-@JsonTypeName("short-answer")
 @JsonInclude(JsonInclude.Include.NON_EMPTY)
 public class ShortAnswerQuestion extends QuizQuestion {
 

src/main/java/de/tum/in/www1/artemis/domain/quiz/ShortAnswerQuestionStatistic.java

@@ -10,14 +10,12 @@
 import org.hibernate.annotations.CacheConcurrencyStrategy;
 
 import com.fasterxml.jackson.annotation.JsonInclude;
-import com.fasterxml.jackson.annotation.JsonTypeName;
 
 /**
  * A ShortAnswerQuestionStatistic.
  */
 @Entity
 @DiscriminatorValue(value = "SA")
-@JsonTypeName("short-answer")
 @JsonInclude(JsonInclude.Include.NON_EMPTY)
 public class ShortAnswerQuestionStatistic extends QuizQuestionStatistic {
 

src/main/java/de/tum/in/www1/artemis/domain/quiz/ShortAnswerSubmittedAnswer.java

@@ -11,7 +11,6 @@
 import org.hibernate.annotations.CacheConcurrencyStrategy;
 
 import com.fasterxml.jackson.annotation.JsonInclude;
-import com.fasterxml.jackson.annotation.JsonTypeName;
 import com.fasterxml.jackson.annotation.JsonView;
 
 import de.tum.in.www1.artemis.domain.quiz.compare.SAMapping;
@@ -22,7 +21,6 @@
  */
 @Entity
 @DiscriminatorValue(value = "SA")
-@JsonTypeName("short-answer")
 @JsonInclude(JsonInclude.Include.NON_EMPTY)
 public class ShortAnswerSubmittedAnswer extends SubmittedAnswer {
 

src/main/java/de/tum/in/www1/artemis/web/rest/metis/ConversationMessageResource.java

@@ -69,6 +69,13 @@ public ResponseEntity<Post> createMessage(@PathVariable Long courseId, @Valid @R
     public ResponseEntity<List<Post>> getMessages(@ApiParam Pageable pageable, PostContextFilter postContextFilter, Principal principal) {
         long timeNanoStart = System.nanoTime();
         Page<Post> coursePosts = conversationMessagingService.getMessages(pageable, postContextFilter);
+        // keep the data as small as possible and avoid unnecessary information sent to the client
+        // TODO: in the future we should set conversation to null
+        coursePosts.getContent().forEach(post -> {
+            if (post.getConversation() != null) {
+                post.getConversation().hideDetails();
+            }
+        });
         HttpHeaders headers = PaginationUtil.generatePaginationHttpHeaders(ServletUriComponentsBuilder.fromCurrentRequest(), coursePosts);
         logDuration(coursePosts.getContent(), principal, timeNanoStart);
         return new ResponseEntity<>(coursePosts.getContent(), headers, HttpStatus.OK);

src/main/java/de/tum/in/www1/artemis/web/rest/metis/conversation/ChannelResource.java

@@ -123,6 +123,9 @@ public ResponseEntity<Channel> getExerciseChannel(@PathVariable Long courseId, @
         var course = courseRepository.findByIdElseThrow(courseId);
         authorizationCheckService.checkHasAtLeastRoleInCourseElseThrow(Role.STUDENT, course, requestingUser);
         var channel = channelRepository.findChannelByExerciseId(exerciseId);
+        if (channel != null) {
+            channel.hideDetails();
+        }
 
         checkChannelMembership(channel, requestingUser.getId());
 
@@ -145,6 +148,9 @@ public ResponseEntity<Channel> getLectureChannel(@PathVariable Long courseId, @P
         var course = courseRepository.findByIdElseThrow(courseId);
         authorizationCheckService.checkHasAtLeastRoleInCourseElseThrow(Role.STUDENT, course, requestingUser);
         var channel = channelRepository.findChannelByLectureId(lectureId);
+        if (channel != null) {
+            channel.hideDetails();
+        }
 
         checkChannelMembership(channel, requestingUser.getId());
 

src/test/java/de/tum/in/www1/artemis/metis/ChannelIntegrationTest.java

@@ -780,7 +780,7 @@ void getExerciseChannel_asCourseStudent_shouldGetExerciseChannel() throws Except
 
         Channel exerciseChannel = request.get("/api/courses/" + exampleCourseId + "/exercises/" + exercise.getId() + "/channel", HttpStatus.OK, Channel.class);
         assertThat(exerciseChannel.getId()).isEqualTo(publicChannelWhereMember.getId());
-        assertThat(exerciseChannel.getExercise().getId()).isEqualTo(exercise.getId());
+        assertThat(exerciseChannel.getExercise()).isNull();
 
         conversationRepository.deleteById(publicChannelWhereMember.getId());
     }
@@ -806,7 +806,7 @@ void getLectureChannel_asCourseStudent_shouldGetLectureChannel() throws Exceptio
 
         Channel lectureChannel = request.get("/api/courses/" + exampleCourseId + "/lectures/" + lecture.getId() + "/channel", HttpStatus.OK, Channel.class);
         assertThat(lectureChannel.getId()).isEqualTo(publicChannelWhereMember.getId());
-        assertThat(lectureChannel.getLecture().getId()).isEqualTo(lecture.getId());
+        assertThat(lectureChannel.getLecture()).isNull();
 
         conversationRepository.deleteById(publicChannelWhereMember.getId());
         lectureRepository.deleteById(lecture.getId());

src/test/javascript/spec/helpers/sample/metis-sample-data.ts

@@ -281,8 +281,6 @@ export const metisExerciseChannel = {
     isAnnouncementChannel: false,
     isArchived: false,
     isPublic: true,
-    course: metisCourse,
-    exercise: metisExercise,
 } as Channel;
 
 export const metisLectureChannel = {
@@ -292,6 +290,4 @@ export const metisLectureChannel = {
     isAnnouncementChannel: false,
     isArchived: false,
     isPublic: true,
-    course: metisCourse,
-    exercise: metisLecture,
 } as Channel;