diff --git a/src/main/java/de/tum/cit/aet/artemis/assessment/domain/Result.java b/src/main/java/de/tum/cit/aet/artemis/assessment/domain/Result.java index 77c01c6fae19..88d5d44e5271 100644 --- a/src/main/java/de/tum/cit/aet/artemis/assessment/domain/Result.java +++ b/src/main/java/de/tum/cit/aet/artemis/assessment/domain/Result.java @@ -108,8 +108,12 @@ public class Result extends DomainObject implements Comparable { @JsonView(QuizView.Before.class) private List feedbacks = new ArrayList<>(); + /** + * @deprecated: Will be removed for 8.0, please use submission.participation instead + */ @ManyToOne @JsonView(QuizView.Before.class) + @Deprecated(since = "7.7", forRemoval = true) private Participation participation; @ManyToOne(fetch = FetchType.LAZY) @@ -385,15 +389,31 @@ private boolean feedbackTextHasChanged(String existingText, String newText) { return !Objects.equals(existingText, newText); } + /** + * @deprecated: Will be removed for 8.0, please use submission.participation instead + * @return the participation + */ + @Deprecated(since = "7.7", forRemoval = true) public Participation getParticipation() { return participation; } + /** + * @deprecated: Will be removed for 8.0, please use submission.participation instead + * @param participation the participation to set + * @return the result + */ + @Deprecated(since = "7.7", forRemoval = true) public Result participation(Participation participation) { this.participation = participation; return this; } + /** + * @deprecated: Will be removed for 8.0, please use submission.participation instead + * @param participation the participation to set + */ + @Deprecated(since = "7.7", forRemoval = true) public void setParticipation(Participation participation) { this.participation = participation; } diff --git a/src/main/java/de/tum/cit/aet/artemis/assessment/service/ResultService.java b/src/main/java/de/tum/cit/aet/artemis/assessment/service/ResultService.java index 50576953916b..1f62ef78665b 100644 --- a/src/main/java/de/tum/cit/aet/artemis/assessment/service/ResultService.java +++ b/src/main/java/de/tum/cit/aet/artemis/assessment/service/ResultService.java @@ -692,4 +692,15 @@ public void deleteLongFeedback(List feedbackList, Result result) { List feedbacks = new ArrayList<>(feedbackList); result.updateAllFeedbackItems(feedbacks, true); } + + /** + * Retrieves the number of students affected by a specific feedback detail text for a given exercise. + * + * @param exerciseId for which the affected student count is requested. + * @param detailText used to filter affected students. + * @return the total number of distinct students affected by the feedback detail text. + */ + public long getAffectedStudentCountByFeedbackDetailText(long exerciseId, String detailText) { + return studentParticipationRepository.countAffectedStudentsByFeedbackDetailText(exerciseId, detailText); + } } diff --git a/src/main/java/de/tum/cit/aet/artemis/assessment/web/ResultResource.java b/src/main/java/de/tum/cit/aet/artemis/assessment/web/ResultResource.java index 431fb66373e8..ed6bc5ce12d3 100644 --- a/src/main/java/de/tum/cit/aet/artemis/assessment/web/ResultResource.java +++ b/src/main/java/de/tum/cit/aet/artemis/assessment/web/ResultResource.java @@ -373,4 +373,18 @@ public ResponseEntity> getAffectedStudentsWithF return ResponseEntity.ok(participation); } + + /** + * GET /exercises/{exerciseId}/feedback-detail/affected-students : Retrieves the count of students affected by a specific feedback detail text. + * + * @param exerciseId The ID of the exercise for which affected students are counted. + * @param detailText The feedback detail text to filter by. + * @return A {@link ResponseEntity} containing the count of affected students. + */ + @GetMapping("exercises/{exerciseId}/feedback-detail/affected-students") + @EnforceAtLeastEditorInExercise + public ResponseEntity countAffectedStudentsByFeedbackDetailText(@PathVariable long exerciseId, @RequestParam("detailText") String detailText) { + long affectedStudentCount = resultService.getAffectedStudentCountByFeedbackDetailText(exerciseId, detailText); + return ResponseEntity.ok(affectedStudentCount); + } } diff --git a/src/main/java/de/tum/cit/aet/artemis/buildagent/service/SharedQueueProcessingService.java b/src/main/java/de/tum/cit/aet/artemis/buildagent/service/SharedQueueProcessingService.java index 2c2e8b8e16bb..8b43315ab01b 100644 --- a/src/main/java/de/tum/cit/aet/artemis/buildagent/service/SharedQueueProcessingService.java +++ b/src/main/java/de/tum/cit/aet/artemis/buildagent/service/SharedQueueProcessingService.java @@ -360,7 +360,9 @@ private BuildAgentInformation getUpdatedLocalBuildAgentInformation(BuildJobQueue } private List getProcessingJobsOfNode(String memberAddress) { - return processingJobs.values().stream().filter(job -> Objects.equals(job.buildAgent().memberAddress(), memberAddress)).toList(); + // NOTE: we should not use streams with IMap, because it can be unstable, when many items are added at the same time and there is a slow network condition + List processingJobsList = new ArrayList<>(processingJobs.values()); + return processingJobsList.stream().filter(job -> Objects.equals(job.buildAgent().memberAddress(), memberAddress)).toList(); } private void removeOfflineNodes() { diff --git a/src/main/java/de/tum/cit/aet/artemis/communication/domain/AnswerPost.java b/src/main/java/de/tum/cit/aet/artemis/communication/domain/AnswerPost.java index aaedef17af0a..9469d9e6d818 100644 --- a/src/main/java/de/tum/cit/aet/artemis/communication/domain/AnswerPost.java +++ b/src/main/java/de/tum/cit/aet/artemis/communication/domain/AnswerPost.java @@ -10,14 +10,18 @@ import jakarta.persistence.ManyToOne; import jakarta.persistence.OneToMany; import jakarta.persistence.Table; +import jakarta.persistence.Transient; import org.hibernate.annotations.Cache; import org.hibernate.annotations.CacheConcurrencyStrategy; +import org.hibernate.annotations.SQLRestriction; +import com.fasterxml.jackson.annotation.JsonIgnore; import com.fasterxml.jackson.annotation.JsonInclude; import com.fasterxml.jackson.annotation.JsonIncludeProperties; import com.fasterxml.jackson.annotation.JsonProperty; +import de.tum.cit.aet.artemis.communication.domain.conversation.Conversation; import de.tum.cit.aet.artemis.core.domain.Course; /** @@ -35,10 +39,20 @@ public class AnswerPost extends Posting { @OneToMany(mappedBy = "answerPost", cascade = CascadeType.REMOVE, orphanRemoval = true, fetch = FetchType.EAGER) private Set reactions = new HashSet<>(); + /*** + * The value 1 represents an answer post, given by the enum {{@link PostingType}} + */ + @OneToMany(mappedBy = "postId", cascade = CascadeType.REMOVE, orphanRemoval = true, fetch = FetchType.LAZY) + @SQLRestriction("post_type = 1") + private Set savedPosts = new HashSet<>(); + @ManyToOne @JsonIncludeProperties({ "id", "exercise", "lecture", "course", "courseWideContext", "conversation", "author" }) private Post post; + @Transient + private boolean isSaved = false; + @JsonProperty("resolvesPost") public Boolean doesResolvePost() { return resolvesPost; @@ -76,6 +90,25 @@ public void setPost(Post post) { this.post = post; } + @JsonIgnore + public Set getSavedPosts() { + return savedPosts; + } + + @JsonProperty("isSaved") + public boolean getIsSaved() { + return isSaved; + } + + public void setIsSaved(boolean isSaved) { + this.isSaved = isSaved; + } + + @JsonIgnore + public Conversation getConversation() { + return getPost().getConversation(); + } + /** * Helper method to extract the course an AnswerPost belongs to, which is found in different locations based on the parent Post's context * diff --git a/src/main/java/de/tum/cit/aet/artemis/communication/domain/Post.java b/src/main/java/de/tum/cit/aet/artemis/communication/domain/Post.java index 4ff2d48fedf5..3bb92cb6a540 100644 --- a/src/main/java/de/tum/cit/aet/artemis/communication/domain/Post.java +++ b/src/main/java/de/tum/cit/aet/artemis/communication/domain/Post.java @@ -16,14 +16,17 @@ import jakarta.persistence.OneToMany; import jakarta.persistence.OneToOne; import jakarta.persistence.Table; +import jakarta.persistence.Transient; import jakarta.validation.constraints.Size; import org.hibernate.annotations.Cache; import org.hibernate.annotations.CacheConcurrencyStrategy; +import org.hibernate.annotations.SQLRestriction; import com.fasterxml.jackson.annotation.JsonIgnore; import com.fasterxml.jackson.annotation.JsonInclude; import com.fasterxml.jackson.annotation.JsonIncludeProperties; +import com.fasterxml.jackson.annotation.JsonProperty; import de.tum.cit.aet.artemis.communication.domain.conversation.Conversation; import de.tum.cit.aet.artemis.core.domain.Course; @@ -54,6 +57,13 @@ public class Post extends Posting { @OneToMany(mappedBy = "post", cascade = CascadeType.REMOVE, orphanRemoval = true, fetch = FetchType.EAGER) private Set answers = new HashSet<>(); + /*** + * The value 0 represents a post, given by the enum {{@link PostingType}} + */ + @OneToMany(mappedBy = "postId", cascade = CascadeType.REMOVE, orphanRemoval = true, fetch = FetchType.LAZY) + @SQLRestriction("post_type = 0") + private Set savedPosts = new HashSet<>(); + @ElementCollection(fetch = FetchType.EAGER) @CollectionTable(name = "post_tag", joinColumns = @JoinColumn(name = "post_id")) @Column(name = "text") @@ -96,6 +106,9 @@ public class Post extends Posting { @Column(name = "vote_count") private int voteCount; + @Transient + private boolean isSaved = false; + public Post() { } @@ -222,6 +235,20 @@ public void setVoteCount(Integer voteCount) { this.voteCount = voteCount != null ? voteCount : 0; } + @JsonIgnore + public Set getSavedPosts() { + return savedPosts; + } + + @JsonProperty("isSaved") + public boolean getIsSaved() { + return isSaved; + } + + public void setIsSaved(boolean isSaved) { + this.isSaved = isSaved; + } + /** * Helper method to extract the course a Post belongs to, which is found in different locations based on the Post's context * diff --git a/src/main/java/de/tum/cit/aet/artemis/communication/domain/Posting.java b/src/main/java/de/tum/cit/aet/artemis/communication/domain/Posting.java index ad60a1130916..4ae7c6fe800e 100644 --- a/src/main/java/de/tum/cit/aet/artemis/communication/domain/Posting.java +++ b/src/main/java/de/tum/cit/aet/artemis/communication/domain/Posting.java @@ -18,6 +18,7 @@ import com.fasterxml.jackson.annotation.JsonIncludeProperties; import com.fasterxml.jackson.annotation.JsonProperty; +import de.tum.cit.aet.artemis.communication.domain.conversation.Conversation; import de.tum.cit.aet.artemis.core.domain.Course; import de.tum.cit.aet.artemis.core.domain.DomainObject; import de.tum.cit.aet.artemis.core.domain.User; @@ -118,4 +119,6 @@ public void setAuthorRole(UserRole authorRole) { @Transient public abstract Course getCoursePostingBelongsTo(); + + public abstract Conversation getConversation(); } diff --git a/src/main/java/de/tum/cit/aet/artemis/communication/domain/PostingType.java b/src/main/java/de/tum/cit/aet/artemis/communication/domain/PostingType.java new file mode 100644 index 000000000000..aedad4d1b55c --- /dev/null +++ b/src/main/java/de/tum/cit/aet/artemis/communication/domain/PostingType.java @@ -0,0 +1,23 @@ +package de.tum.cit.aet.artemis.communication.domain; + +import java.util.Arrays; + +public enum PostingType { + + POST((short) 0), ANSWER((short) 1); + + private final short databaseKey; + + PostingType(short databaseKey) { + this.databaseKey = databaseKey; + } + + public short getDatabaseKey() { + return databaseKey; + } + + public static PostingType fromDatabaseKey(short databaseKey) { + return Arrays.stream(PostingType.values()).filter(type -> type.getDatabaseKey() == databaseKey).findFirst() + .orElseThrow(() -> new IllegalArgumentException("Unknown database key: " + databaseKey)); + } +} diff --git a/src/main/java/de/tum/cit/aet/artemis/communication/domain/SavedPost.java b/src/main/java/de/tum/cit/aet/artemis/communication/domain/SavedPost.java new file mode 100644 index 000000000000..88d1c79b96c4 --- /dev/null +++ b/src/main/java/de/tum/cit/aet/artemis/communication/domain/SavedPost.java @@ -0,0 +1,83 @@ +package de.tum.cit.aet.artemis.communication.domain; + +import java.time.ZonedDateTime; + +import jakarta.persistence.Column; +import jakarta.persistence.Entity; +import jakarta.persistence.Enumerated; +import jakarta.persistence.JoinColumn; +import jakarta.persistence.ManyToOne; +import jakarta.persistence.Table; + +import de.tum.cit.aet.artemis.core.domain.DomainObject; +import de.tum.cit.aet.artemis.core.domain.User; + +@Entity +@Table(name = "saved_post") +public class SavedPost extends DomainObject { + + @ManyToOne + @JoinColumn(name = "user_id", nullable = false) + private User user; + + @Column(name = "post_id", nullable = false) + private Long postId; + + @Enumerated + @Column(name = "post_type", nullable = false) + private PostingType postType; + + @Enumerated + @Column(name = "status", nullable = false) + private SavedPostStatus status; + + @Column(name = "completed_at") + private ZonedDateTime completedAt; + + public SavedPost() { + } + + public SavedPost(User user, Long postId, PostingType postType, SavedPostStatus status, ZonedDateTime completedAt) { + this.user = user; + this.postId = postId; + this.postType = postType; + this.status = status; + this.completedAt = completedAt; + } + + public Long getPostId() { + return postId; + } + + public void setPostId(Long postId) { + this.postId = postId; + } + + public void setStatus(SavedPostStatus status) { + this.status = status; + } + + public User getUser() { + return user; + } + + public SavedPostStatus getStatus() { + return status; + } + + public void setCompletedAt(ZonedDateTime completedAt) { + this.completedAt = completedAt; + } + + public void setPostType(PostingType postType) { + this.postType = postType; + } + + public PostingType getPostType() { + return postType; + } + + public ZonedDateTime getCompletedAt() { + return completedAt; + } +} diff --git a/src/main/java/de/tum/cit/aet/artemis/communication/domain/SavedPostStatus.java b/src/main/java/de/tum/cit/aet/artemis/communication/domain/SavedPostStatus.java new file mode 100644 index 000000000000..b2fd523277be --- /dev/null +++ b/src/main/java/de/tum/cit/aet/artemis/communication/domain/SavedPostStatus.java @@ -0,0 +1,23 @@ +package de.tum.cit.aet.artemis.communication.domain; + +import java.util.Arrays; + +public enum SavedPostStatus { + + IN_PROGRESS((short) 0), COMPLETED((short) 1), ARCHIVED((short) 2); + + private final short databaseKey; + + SavedPostStatus(short databaseKey) { + this.databaseKey = databaseKey; + } + + public short getDatabaseKey() { + return databaseKey; + } + + public static SavedPostStatus fromDatabaseKey(short databaseKey) { + return Arrays.stream(SavedPostStatus.values()).filter(type -> type.getDatabaseKey() == databaseKey).findFirst() + .orElseThrow(() -> new IllegalArgumentException("Unknown database key: " + databaseKey)); + } +} diff --git a/src/main/java/de/tum/cit/aet/artemis/communication/dto/AuthorDTO.java b/src/main/java/de/tum/cit/aet/artemis/communication/dto/AuthorDTO.java new file mode 100644 index 000000000000..8feb1dd746c1 --- /dev/null +++ b/src/main/java/de/tum/cit/aet/artemis/communication/dto/AuthorDTO.java @@ -0,0 +1,13 @@ +package de.tum.cit.aet.artemis.communication.dto; + +import com.fasterxml.jackson.annotation.JsonInclude; + +import de.tum.cit.aet.artemis.core.domain.User; + +@JsonInclude(JsonInclude.Include.NON_EMPTY) +public record AuthorDTO(Long id, String name, String imageUrl) { + + public AuthorDTO(User user) { + this(user.getId(), user.getName(), user.getImageUrl()); + } +} diff --git a/src/main/java/de/tum/cit/aet/artemis/communication/dto/FeedbackChannelRequestDTO.java b/src/main/java/de/tum/cit/aet/artemis/communication/dto/FeedbackChannelRequestDTO.java new file mode 100644 index 000000000000..d38b1c1d90f2 --- /dev/null +++ b/src/main/java/de/tum/cit/aet/artemis/communication/dto/FeedbackChannelRequestDTO.java @@ -0,0 +1,7 @@ +package de.tum.cit.aet.artemis.communication.dto; + +import com.fasterxml.jackson.annotation.JsonInclude; + +@JsonInclude(JsonInclude.Include.NON_EMPTY) +public record FeedbackChannelRequestDTO(ChannelDTO channel, String feedbackDetailText) { +} diff --git a/src/main/java/de/tum/cit/aet/artemis/communication/dto/PostingConversationDTO.java b/src/main/java/de/tum/cit/aet/artemis/communication/dto/PostingConversationDTO.java new file mode 100644 index 000000000000..9c93cd4d47e5 --- /dev/null +++ b/src/main/java/de/tum/cit/aet/artemis/communication/dto/PostingConversationDTO.java @@ -0,0 +1,34 @@ +package de.tum.cit.aet.artemis.communication.dto; + +import de.tum.cit.aet.artemis.communication.domain.ConversationType; +import de.tum.cit.aet.artemis.communication.domain.conversation.Channel; +import de.tum.cit.aet.artemis.communication.domain.conversation.Conversation; +import de.tum.cit.aet.artemis.communication.domain.conversation.GroupChat; + +public record PostingConversationDTO(Long id, String title, ConversationType type) { + + public PostingConversationDTO(Conversation conversation) { + this(conversation.getId(), determineTitle(conversation), determineType(conversation)); + } + + private static String determineTitle(Conversation conversation) { + if (conversation instanceof Channel) { + return ((Channel) conversation).getName(); + } + else if (conversation instanceof GroupChat) { + return ((GroupChat) conversation).getName(); + } + else { + return "Chat"; + } + } + + private static ConversationType determineType(Conversation conversation) { + if (conversation instanceof Channel) { + return ConversationType.CHANNEL; + } + else { + return ConversationType.DIRECT; + } + } +} diff --git a/src/main/java/de/tum/cit/aet/artemis/communication/dto/PostingDTO.java b/src/main/java/de/tum/cit/aet/artemis/communication/dto/PostingDTO.java new file mode 100644 index 000000000000..a394237230c0 --- /dev/null +++ b/src/main/java/de/tum/cit/aet/artemis/communication/dto/PostingDTO.java @@ -0,0 +1,40 @@ +package de.tum.cit.aet.artemis.communication.dto; + +import java.time.ZonedDateTime; +import java.util.List; + +import com.fasterxml.jackson.annotation.JsonInclude; + +import de.tum.cit.aet.artemis.communication.domain.AnswerPost; +import de.tum.cit.aet.artemis.communication.domain.Posting; +import de.tum.cit.aet.artemis.communication.domain.PostingType; +import de.tum.cit.aet.artemis.communication.domain.UserRole; + +@JsonInclude(JsonInclude.Include.NON_EMPTY) +public record PostingDTO(Long id, AuthorDTO author, UserRole role, ZonedDateTime creationDate, ZonedDateTime updatedDate, String content, boolean isSaved, short savedPostStatus, + List reactions, PostingConversationDTO conversation, short postingType, Long referencePostId) { + + public PostingDTO(Posting post, boolean isSaved, short savedPostStatus) { + this(post.getId(), new AuthorDTO(post.getAuthor()), post.getAuthorRole(), post.getCreationDate(), post.getUpdatedDate(), post.getContent(), isSaved, savedPostStatus, + post.getReactions().stream().map(ReactionDTO::new).toList(), new PostingConversationDTO(post.getConversation()), getSavedPostType(post).getDatabaseKey(), + getReferencePostId(post)); + } + + static PostingType getSavedPostType(Posting posting) { + if (posting instanceof AnswerPost) { + return PostingType.ANSWER; + } + else { + return PostingType.POST; + } + } + + static Long getReferencePostId(Posting posting) { + if (posting instanceof AnswerPost) { + return ((AnswerPost) posting).getPost().getId(); + } + else { + return posting.getId(); + } + } +} diff --git a/src/main/java/de/tum/cit/aet/artemis/communication/dto/ReactionDTO.java b/src/main/java/de/tum/cit/aet/artemis/communication/dto/ReactionDTO.java new file mode 100644 index 000000000000..a81a00799ece --- /dev/null +++ b/src/main/java/de/tum/cit/aet/artemis/communication/dto/ReactionDTO.java @@ -0,0 +1,12 @@ +package de.tum.cit.aet.artemis.communication.dto; + +import java.time.ZonedDateTime; + +import de.tum.cit.aet.artemis.communication.domain.Reaction; + +public record ReactionDTO(Long id, AuthorDTO user, ZonedDateTime creationDate, String emojiId) { + + public ReactionDTO(Reaction reaction) { + this(reaction.getId(), new AuthorDTO(reaction.getUser()), reaction.getCreationDate(), reaction.getEmojiId()); + } +} diff --git a/src/main/java/de/tum/cit/aet/artemis/communication/repository/AnswerPostRepository.java b/src/main/java/de/tum/cit/aet/artemis/communication/repository/AnswerPostRepository.java index db61138b3a73..43ac921f2d8a 100644 --- a/src/main/java/de/tum/cit/aet/artemis/communication/repository/AnswerPostRepository.java +++ b/src/main/java/de/tum/cit/aet/artemis/communication/repository/AnswerPostRepository.java @@ -31,5 +31,12 @@ default AnswerPost findAnswerMessageByIdElseThrow(Long answerPostId) { return getValueElseThrow(findById(answerPostId).filter(answerPost -> answerPost.getPost().getConversation() != null), answerPostId); } + @NotNull + default AnswerPost findAnswerPostOrMessageByIdElseThrow(Long answerPostId) { + return getValueElseThrow(findById(answerPostId), answerPostId); + } + long countAnswerPostsByPostIdIn(List postIds); + + List findByIdIn(List idList); } diff --git a/src/main/java/de/tum/cit/aet/artemis/communication/repository/ConversationMessageRepository.java b/src/main/java/de/tum/cit/aet/artemis/communication/repository/ConversationMessageRepository.java index 2952c5213432..16c5be3aedc8 100644 --- a/src/main/java/de/tum/cit/aet/artemis/communication/repository/ConversationMessageRepository.java +++ b/src/main/java/de/tum/cit/aet/artemis/communication/repository/ConversationMessageRepository.java @@ -114,6 +114,7 @@ private PageImpl findPostsWithSpecification(Pageable pageable, Specificati LEFT JOIN FETCH p.conversation LEFT JOIN FETCH p.reactions LEFT JOIN FETCH p.tags + LEFT JOIN FETCH p.savedPosts LEFT JOIN FETCH p.answers a LEFT JOIN FETCH a.reactions LEFT JOIN FETCH a.post diff --git a/src/main/java/de/tum/cit/aet/artemis/communication/repository/PostRepository.java b/src/main/java/de/tum/cit/aet/artemis/communication/repository/PostRepository.java index aacfbc33d179..1ea95f1d6657 100644 --- a/src/main/java/de/tum/cit/aet/artemis/communication/repository/PostRepository.java +++ b/src/main/java/de/tum/cit/aet/artemis/communication/repository/PostRepository.java @@ -49,4 +49,6 @@ default Post findPostOrMessagePostByIdElseThrow(Long postId) throws EntityNotFou List findAllByConversationId(Long conversationId); List findAllByCourseId(Long courseId); + + List findByIdIn(List idList); } diff --git a/src/main/java/de/tum/cit/aet/artemis/communication/repository/SavedPostRepository.java b/src/main/java/de/tum/cit/aet/artemis/communication/repository/SavedPostRepository.java new file mode 100644 index 000000000000..e0a00a5896aa --- /dev/null +++ b/src/main/java/de/tum/cit/aet/artemis/communication/repository/SavedPostRepository.java @@ -0,0 +1,143 @@ +package de.tum.cit.aet.artemis.communication.repository; + +import static de.tum.cit.aet.artemis.core.config.Constants.PROFILE_CORE; + +import java.time.ZonedDateTime; +import java.util.List; + +import org.springframework.cache.annotation.CacheConfig; +import org.springframework.cache.annotation.CacheEvict; +import org.springframework.cache.annotation.Cacheable; +import org.springframework.cache.annotation.Caching; +import org.springframework.context.annotation.Profile; +import org.springframework.data.jpa.repository.Query; +import org.springframework.data.repository.query.Param; +import org.springframework.stereotype.Repository; + +import de.tum.cit.aet.artemis.communication.domain.PostingType; +import de.tum.cit.aet.artemis.communication.domain.SavedPost; +import de.tum.cit.aet.artemis.communication.domain.SavedPostStatus; +import de.tum.cit.aet.artemis.core.repository.base.ArtemisJpaRepository; + +@Profile(PROFILE_CORE) +@Repository +@CacheConfig(cacheNames = "savedPosts") +public interface SavedPostRepository extends ArtemisJpaRepository { + + /*** + * Get the amount of saved posts of a user. E.g. for checking if maximum allowed bookmarks are reached. + * Cached by user id. + * + * @param userId to query for + * + * @return The amount of bookmarks of the user. + */ + @Cacheable(key = "'saved_post_count_' + #userId") + Long countByUserId(Long userId); + + /*** + * Get a single saved post by user id, connected post/answer post id and posting type. Not cached. + * + * @param userId of the bookmark + * @param postId of the bookmark + * @param postType of the bookmark + * + * @return The saved post if exists, null otherwise. + */ + SavedPost findSavedPostByUserIdAndPostIdAndPostType(Long userId, Long postId, PostingType postType); + + /*** + * Query all post ids that a user has saved by a certain posting type. Cached by user id and post type. + * + * @param userId of the bookmarks + * @param postType of the bookmarks + * + * @return List of ids of posts/answer posts of the given user, filtered by the given post type. + */ + @Query(""" + SELECT s.postId + FROM SavedPost s + WHERE s.user.id = :userId AND s.postType = :postType + """) + @Cacheable(key = "'saved_post_type_' + #postType.getDatabaseKey() + '_' + #userId") + List findSavedPostIdsByUserIdAndPostType(@Param("userId") Long userId, @Param("postType") PostingType postType); + + /*** + * Query all saved posts of a user by status. E.g. for displaying the saved posts. Cached by user id and status. + * + * @param userId of the bookmarks + * @param status of the bookmarks + * + * @return List of saved posts of the given user, filtered by the given status. + */ + @Cacheable(key = "'saved_post_status_' + #status.getDatabaseKey() + '_' + #userId") + List findSavedPostsByUserIdAndStatusOrderByCompletedAtDescIdDesc(Long userId, SavedPostStatus status); + + /*** + * Query all SavedPosts for a certain user. Not cached. + * + * @param userId of the bookmarks + * + * @return List of saved posts of the given user. + */ + List findSavedPostsByUserId(Long userId); + + /*** + * Query to get all SavedPosts that are completed before a certain cutoff date. E.g. for cleanup. + * + * @param cutoffDate the date from where to query the saved posts + * + * @return List of saved posts which were completed before the given date + */ + List findByCompletedAtBefore(ZonedDateTime cutoffDate); + + /*** + * Saving should clear the cached queries for a given user + * The value "saved_post_type_0" represents a post, given by the enum {{@link PostingType}} + * The value "saved_post_type_1" represents an answer post, given by the enum {{@link PostingType}} + * The value "saved_post_status_0" represents in progress, given by the enum {{@link SavedPostStatus}} + * The value "saved_post_status_1" represents in completed, given by the enum {{@link SavedPostStatus}} + * The value "saved_post_status_2" represents in archived, given by the enum {{@link SavedPostStatus}} + * + * @param savedPost to create / update + * + * @return Newly stored saved post + */ + @Caching(evict = { @CacheEvict(key = "'saved_post_type_0_' + #savedPost.user.id"), @CacheEvict(key = "'saved_post_type_1_' + #savedPost.user.id"), + @CacheEvict(key = "'saved_post_status_0_' + #savedPost.user.id"), @CacheEvict(key = "'saved_post_status_1_' + #savedPost.user.id"), + @CacheEvict(key = "'saved_post_status_2_' + #savedPost.user.id"), @CacheEvict(key = "'saved_post_count_' + #savedPost.user.id"), }) + @Override + S save(S savedPost); + + /*** + * Deleting should clear the cached queries for a given user + * The value "saved_post_type_0" represents a post, given by the enum {{@link PostingType}} + * The value "saved_post_type_1" represents an answer post, given by the enum {{@link PostingType}} + * The value "saved_post_status_0" represents in progress, given by the enum {{@link SavedPostStatus}} + * The value "saved_post_status_1" represents in completed, given by the enum {{@link SavedPostStatus}} + * The value "saved_post_status_2" represents in archived, given by the enum {{@link SavedPostStatus}} + * + * @param savedPost to delete + */ + @Caching(evict = { @CacheEvict(key = "'saved_post_type_0_' + #savedPost.user.id"), @CacheEvict(key = "'saved_post_type_1_' + #savedPost.user.id"), + @CacheEvict(key = "'saved_post_status_0_' + #savedPost.user.id"), @CacheEvict(key = "'saved_post_status_1_' + #savedPost.user.id"), + @CacheEvict(key = "'saved_post_status_2_' + #savedPost.user.id"), @CacheEvict(key = "'saved_post_count_' + #savedPost.user.id"), }) + @Override + void delete(SavedPost savedPost); + + /*** + * The value "sp.postType = 0" represents a post, given by the enum {{@link PostingType}} + * + * @return List of saved posts that do not have a post entity connected to them + */ + @Query("SELECT sp FROM SavedPost sp " + "LEFT JOIN Post p ON sp.postId = p.id " + "WHERE sp.postType = 0 AND p.id IS NULL") + List findOrphanedPostReferences(); + + /*** + * The value "sp.postType = 1" represents an answer post, given by the enum {{@link PostingType}} + * + * @return List of saved posts that do not have an answer post entity connected to them + */ + @Query("SELECT sp FROM SavedPost sp " + "LEFT JOIN AnswerPost ap ON sp.postId = ap.id " + "WHERE sp.postType = 1 AND ap.id IS NULL") + List findOrphanedAnswerReferences(); +} diff --git a/src/main/java/de/tum/cit/aet/artemis/communication/service/AnswerMessageService.java b/src/main/java/de/tum/cit/aet/artemis/communication/service/AnswerMessageService.java index fa370edc0737..f7645c202f63 100644 --- a/src/main/java/de/tum/cit/aet/artemis/communication/service/AnswerMessageService.java +++ b/src/main/java/de/tum/cit/aet/artemis/communication/service/AnswerMessageService.java @@ -21,6 +21,7 @@ import de.tum.cit.aet.artemis.communication.repository.ConversationMessageRepository; import de.tum.cit.aet.artemis.communication.repository.ConversationParticipantRepository; import de.tum.cit.aet.artemis.communication.repository.PostRepository; +import de.tum.cit.aet.artemis.communication.repository.SavedPostRepository; import de.tum.cit.aet.artemis.communication.repository.conversation.ConversationRepository; import de.tum.cit.aet.artemis.communication.service.conversation.ConversationService; import de.tum.cit.aet.artemis.communication.service.conversation.auth.ChannelAuthorizationService; @@ -59,10 +60,11 @@ public class AnswerMessageService extends PostingService { @SuppressWarnings("PMD.ExcessiveParameterList") public AnswerMessageService(SingleUserNotificationService singleUserNotificationService, CourseRepository courseRepository, AuthorizationCheckService authorizationCheckService, UserRepository userRepository, AnswerPostRepository answerPostRepository, ConversationMessageRepository conversationMessageRepository, - ConversationService conversationService, ExerciseRepository exerciseRepository, LectureRepository lectureRepository, + ConversationService conversationService, ExerciseRepository exerciseRepository, LectureRepository lectureRepository, SavedPostRepository savedPostRepository, WebsocketMessagingService websocketMessagingService, ConversationParticipantRepository conversationParticipantRepository, ChannelAuthorizationService channelAuthorizationService, PostRepository postRepository, ConversationRepository conversationRepository) { - super(courseRepository, userRepository, exerciseRepository, lectureRepository, authorizationCheckService, websocketMessagingService, conversationParticipantRepository); + super(courseRepository, userRepository, exerciseRepository, lectureRepository, authorizationCheckService, websocketMessagingService, conversationParticipantRepository, + savedPostRepository); this.answerPostRepository = answerPostRepository; this.conversationMessageRepository = conversationMessageRepository; this.conversationService = conversationService; @@ -205,6 +207,7 @@ public void deleteAnswerMessageById(Long courseId, Long answerMessageId) { // delete answerPostRepository.deleteById(answerMessageId); + preparePostForBroadcast(updatedMessage); broadcastForPost(new PostDTO(updatedMessage, MetisCrudAction.UPDATE), course.getId(), null, null); } diff --git a/src/main/java/de/tum/cit/aet/artemis/communication/service/ConversationMessagingService.java b/src/main/java/de/tum/cit/aet/artemis/communication/service/ConversationMessagingService.java index a54058431b76..06f9409bddc0 100644 --- a/src/main/java/de/tum/cit/aet/artemis/communication/service/ConversationMessagingService.java +++ b/src/main/java/de/tum/cit/aet/artemis/communication/service/ConversationMessagingService.java @@ -40,6 +40,7 @@ import de.tum.cit.aet.artemis.communication.dto.PostDTO; import de.tum.cit.aet.artemis.communication.repository.ConversationMessageRepository; import de.tum.cit.aet.artemis.communication.repository.ConversationParticipantRepository; +import de.tum.cit.aet.artemis.communication.repository.SavedPostRepository; import de.tum.cit.aet.artemis.communication.repository.SingleUserNotificationRepository; import de.tum.cit.aet.artemis.communication.service.conversation.ConversationService; import de.tum.cit.aet.artemis.communication.service.conversation.auth.ChannelAuthorizationService; @@ -78,9 +79,10 @@ public class ConversationMessagingService extends PostingService { protected ConversationMessagingService(CourseRepository courseRepository, ExerciseRepository exerciseRepository, LectureRepository lectureRepository, ConversationMessageRepository conversationMessageRepository, AuthorizationCheckService authorizationCheckService, WebsocketMessagingService websocketMessagingService, UserRepository userRepository, ConversationService conversationService, ConversationParticipantRepository conversationParticipantRepository, - ConversationNotificationService conversationNotificationService, ChannelAuthorizationService channelAuthorizationService, + ConversationNotificationService conversationNotificationService, ChannelAuthorizationService channelAuthorizationService, SavedPostRepository savedPostRepository, GroupNotificationService groupNotificationService, SingleUserNotificationRepository singleUserNotificationRepository) { - super(courseRepository, userRepository, exerciseRepository, lectureRepository, authorizationCheckService, websocketMessagingService, conversationParticipantRepository); + super(courseRepository, userRepository, exerciseRepository, lectureRepository, authorizationCheckService, websocketMessagingService, conversationParticipantRepository, + savedPostRepository); this.conversationService = conversationService; this.conversationMessageRepository = conversationMessageRepository; this.conversationNotificationService = conversationNotificationService; @@ -154,6 +156,7 @@ public void notifyAboutMessageCreation(CreatedConversationMessage createdConvers Set recipientSummaries; ConversationNotification notification = conversationNotificationService.createNotification(createdMessage, conversation, course, createdConversationMessage.mentionedUsers()); + preparePostForBroadcast(createdMessage); PostDTO postDTO = new PostDTO(createdMessage, MetisCrudAction.CREATE, notification); createdMessage.getConversation().hideDetails(); if (createdConversationMessage.completeConversation() instanceof Channel channel && channel.getIsCourseWide()) { @@ -284,7 +287,6 @@ private Set filterNotificationRecipients(User author, Conversation convers public Page getMessages(Pageable pageable, @Valid PostContextFilterDTO postContextFilter, User requestingUser, Long courseId) { conversationService.isMemberOrCreateForCourseWideElseThrow(postContextFilter.conversationId(), requestingUser, Optional.of(ZonedDateTime.now())); - // The following query loads posts, answerPosts and reactions to avoid too many database calls (due to eager references) Page conversationPosts = conversationMessageRepository.findMessages(postContextFilter, pageable, requestingUser.getId()); setAuthorRoleOfPostings(conversationPosts.getContent(), courseId); @@ -342,6 +344,7 @@ public Post updateMessage(Long courseId, Long postId, Post messagePost) { updatedPost.setConversation(conversation); // emit a post update via websocket + preparePostForBroadcast(updatedPost); broadcastForPost(new PostDTO(updatedPost, MetisCrudAction.UPDATE), course.getId(), null, null); return updatedPost; @@ -369,7 +372,7 @@ public void deleteMessageById(Long courseId, Long postId) { conversation = conversationService.getConversationById(conversation.getId()); conversationService.notifyAllConversationMembersAboutUpdate(conversation); - + preparePostForBroadcast(post); broadcastForPost(new PostDTO(post, MetisCrudAction.DELETE), course.getId(), null, null); } @@ -400,6 +403,8 @@ public Post changeDisplayPriority(Long courseId, Long postId, DisplayPriority di Post updatedMessage = conversationMessageRepository.save(message); message.getConversation().hideDetails(); + preparePostForBroadcast(message); + preparePostForBroadcast(updatedMessage); broadcastForPost(new PostDTO(message, MetisCrudAction.UPDATE), course.getId(), null, null); return updatedMessage; } diff --git a/src/main/java/de/tum/cit/aet/artemis/communication/service/PostingService.java b/src/main/java/de/tum/cit/aet/artemis/communication/service/PostingService.java index f3a01dab6ba6..786675a38986 100644 --- a/src/main/java/de/tum/cit/aet/artemis/communication/service/PostingService.java +++ b/src/main/java/de/tum/cit/aet/artemis/communication/service/PostingService.java @@ -21,6 +21,7 @@ import de.tum.cit.aet.artemis.communication.domain.ConversationNotificationRecipientSummary; import de.tum.cit.aet.artemis.communication.domain.Post; import de.tum.cit.aet.artemis.communication.domain.Posting; +import de.tum.cit.aet.artemis.communication.domain.PostingType; import de.tum.cit.aet.artemis.communication.domain.UserRole; import de.tum.cit.aet.artemis.communication.domain.conversation.Channel; import de.tum.cit.aet.artemis.communication.domain.conversation.Conversation; @@ -29,6 +30,7 @@ import de.tum.cit.aet.artemis.communication.dto.MetisCrudAction; import de.tum.cit.aet.artemis.communication.dto.PostDTO; import de.tum.cit.aet.artemis.communication.repository.ConversationParticipantRepository; +import de.tum.cit.aet.artemis.communication.repository.SavedPostRepository; import de.tum.cit.aet.artemis.core.domain.Course; import de.tum.cit.aet.artemis.core.domain.CourseInformationSharingConfiguration; import de.tum.cit.aet.artemis.core.domain.User; @@ -53,6 +55,8 @@ public abstract class PostingService { protected final LectureRepository lectureRepository; + protected final SavedPostRepository savedPostRepository; + protected final ConversationParticipantRepository conversationParticipantRepository; protected final AuthorizationCheckService authorizationCheckService; @@ -65,7 +69,7 @@ public abstract class PostingService { protected PostingService(CourseRepository courseRepository, UserRepository userRepository, ExerciseRepository exerciseRepository, LectureRepository lectureRepository, AuthorizationCheckService authorizationCheckService, WebsocketMessagingService websocketMessagingService, - ConversationParticipantRepository conversationParticipantRepository) { + ConversationParticipantRepository conversationParticipantRepository, SavedPostRepository savedPostRepository) { this.courseRepository = courseRepository; this.userRepository = userRepository; this.exerciseRepository = exerciseRepository; @@ -73,6 +77,28 @@ protected PostingService(CourseRepository courseRepository, UserRepository userR this.authorizationCheckService = authorizationCheckService; this.websocketMessagingService = websocketMessagingService; this.conversationParticipantRepository = conversationParticipantRepository; + this.savedPostRepository = savedPostRepository; + } + + /** + * Helper method to prepare the post included in the websocket message and initiate the broadcasting + * + * @param post post that should be broadcast + */ + public void preparePostForBroadcast(Post post) { + try { + var user = userRepository.getUser(); + var savedPostIds = savedPostRepository.findSavedPostIdsByUserIdAndPostType(user.getId(), PostingType.POST); + post.setIsSaved(savedPostIds.contains(post.getId())); + var savedAnswerIds = savedPostRepository.findSavedPostIdsByUserIdAndPostType(user.getId(), PostingType.ANSWER); + post.getAnswers().forEach(answer -> answer.setIsSaved(savedAnswerIds.contains(answer.getId()))); + } + catch (Exception e) { + post.setIsSaved(false); + post.getAnswers().forEach(answer -> { + answer.setIsSaved(false); + }); + } } /** @@ -89,6 +115,7 @@ protected void preparePostAndBroadcast(AnswerPost updatedAnswerPost, Course cour // we need to remove the existing AnswerPost (based on unchanged id in updatedAnswerPost) and add the updatedAnswerPost afterwards updatedPost.removeAnswerPost(updatedAnswerPost); updatedPost.addAnswerPost(updatedAnswerPost); + preparePostForBroadcast(updatedPost); broadcastForPost(new PostDTO(updatedPost, MetisCrudAction.UPDATE, notification), course.getId(), null, null); } diff --git a/src/main/java/de/tum/cit/aet/artemis/communication/service/ReactionService.java b/src/main/java/de/tum/cit/aet/artemis/communication/service/ReactionService.java index a1b9b2b71ec8..562e30dfd48b 100644 --- a/src/main/java/de/tum/cit/aet/artemis/communication/service/ReactionService.java +++ b/src/main/java/de/tum/cit/aet/artemis/communication/service/ReactionService.java @@ -138,6 +138,7 @@ public void deleteReactionById(Long reactionId, Long courseId) { updatedPost.removeAnswerPost(updatedAnswerPost); updatedPost.addAnswerPost(updatedAnswerPost); } + plagiarismPostService.preparePostForBroadcast(updatedPost); plagiarismPostService.broadcastForPost(new PostDTO(updatedPost, MetisCrudAction.UPDATE), course.getId(), null, null); reactionRepository.deleteById(reactionId); } @@ -201,6 +202,7 @@ private Reaction createReactionForPost(Reaction reaction, Post posting, User use Post updatedPost = postRepository.save(post); updatedPost.setConversation(post.getConversation()); + plagiarismPostService.preparePostForBroadcast(post); plagiarismPostService.broadcastForPost(new PostDTO(post, MetisCrudAction.UPDATE), course.getId(), null, null); return savedReaction; } diff --git a/src/main/java/de/tum/cit/aet/artemis/communication/service/SavedPostScheduleService.java b/src/main/java/de/tum/cit/aet/artemis/communication/service/SavedPostScheduleService.java new file mode 100644 index 000000000000..25e5922031f5 --- /dev/null +++ b/src/main/java/de/tum/cit/aet/artemis/communication/service/SavedPostScheduleService.java @@ -0,0 +1,68 @@ +package de.tum.cit.aet.artemis.communication.service; + +import static de.tum.cit.aet.artemis.core.config.Constants.PROFILE_SCHEDULING; + +import java.time.ZonedDateTime; +import java.util.List; + +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; +import org.springframework.context.annotation.Profile; +import org.springframework.scheduling.annotation.Scheduled; +import org.springframework.stereotype.Service; + +import de.tum.cit.aet.artemis.communication.domain.SavedPost; +import de.tum.cit.aet.artemis.communication.repository.SavedPostRepository; + +@Service +@Profile(PROFILE_SCHEDULING) +public class SavedPostScheduleService { + + private static final int DAYS_UNTIL_ARCHIVED_ARE_DELETED = 100; + + private static final Logger log = LoggerFactory.getLogger(SavedPostScheduleService.class); + + private final SavedPostRepository savedPostRepository; + + public SavedPostScheduleService(SavedPostRepository savedPostRepository) { + this.savedPostRepository = savedPostRepository; + } + + /** + * Cleans up all archived/completed posts that are older than specified cutoff date + */ + @Scheduled(cron = "0 0 0 * * *") + public void cleanupArchivedSavedPosts() { + ZonedDateTime cutoffDate = ZonedDateTime.now().minusDays(DAYS_UNTIL_ARCHIVED_ARE_DELETED); + + List oldPosts = savedPostRepository.findByCompletedAtBefore(cutoffDate); + if (!oldPosts.isEmpty()) { + savedPostRepository.deleteAll(oldPosts); + log.info("Deleted {} archived saved posts", oldPosts.size()); + } + } + + /** + * Cleans up all saved posts where the post entity does not exist anymore + */ + @Scheduled(cron = "0 0 0 * * *") + public void cleanupOrphanedSavedPosts() { + List orphanedPosts = savedPostRepository.findOrphanedPostReferences(); + if (!orphanedPosts.isEmpty()) { + savedPostRepository.deleteAll(orphanedPosts); + log.info("Deleted {} orphaned post references", orphanedPosts.size()); + } + } + + /** + * Cleans up all saved posts where the answer post entity does not exist anymore + */ + @Scheduled(cron = "0 0 0 * * *") + public void cleanupOrphanedSavedAnswerPosts() { + List orphanedPosts = savedPostRepository.findOrphanedAnswerReferences(); + if (!orphanedPosts.isEmpty()) { + savedPostRepository.deleteAll(orphanedPosts); + log.info("Deleted {} orphaned answer post references", orphanedPosts.size()); + } + } +} diff --git a/src/main/java/de/tum/cit/aet/artemis/communication/service/SavedPostService.java b/src/main/java/de/tum/cit/aet/artemis/communication/service/SavedPostService.java new file mode 100644 index 000000000000..14172c6d3d05 --- /dev/null +++ b/src/main/java/de/tum/cit/aet/artemis/communication/service/SavedPostService.java @@ -0,0 +1,123 @@ +package de.tum.cit.aet.artemis.communication.service; + +import static de.tum.cit.aet.artemis.core.config.Constants.PROFILE_CORE; + +import java.time.ZonedDateTime; +import java.util.List; + +import org.springframework.context.annotation.Profile; +import org.springframework.stereotype.Service; + +import de.tum.cit.aet.artemis.communication.domain.Post; +import de.tum.cit.aet.artemis.communication.domain.Posting; +import de.tum.cit.aet.artemis.communication.domain.PostingType; +import de.tum.cit.aet.artemis.communication.domain.SavedPost; +import de.tum.cit.aet.artemis.communication.domain.SavedPostStatus; +import de.tum.cit.aet.artemis.communication.repository.SavedPostRepository; +import de.tum.cit.aet.artemis.core.repository.UserRepository; + +@Profile(PROFILE_CORE) +@Service +public class SavedPostService { + + private static final int MAX_SAVED_POSTS_PER_USER = 100; + + private final SavedPostRepository savedPostRepository; + + private final UserRepository userRepository; + + public SavedPostService(SavedPostRepository savedPostRepository, UserRepository userRepository) { + this.savedPostRepository = savedPostRepository; + this.userRepository = userRepository; + } + + /** + * Saves a post for the currently logged-in user, if post is already saved it returns + * + * @param post post to save + */ + public void savePostForCurrentUser(Posting post) { + var existingSavedPost = this.getSavedPostForCurrentUser(post); + + if (existingSavedPost != null) { + return; + } + + PostingType type = post instanceof Post ? PostingType.POST : PostingType.ANSWER; + var author = userRepository.getUser(); + var savedPost = new SavedPost(author, post.getId(), type, SavedPostStatus.IN_PROGRESS, null); + savedPostRepository.save(savedPost); + } + + /** + * Removes a bookmark of a post for the currently logged-in user, if post is not saved it returns + * + * @param post post to remove from bookmarks + * @return false if the saved post was not found, true if post was found and deleted + */ + public boolean removeSavedPostForCurrentUser(Posting post) { + var existingSavedPost = this.getSavedPostForCurrentUser(post); + + if (existingSavedPost == null) { + return false; + } + + savedPostRepository.delete(existingSavedPost); + + return true; + } + + /** + * Updates the status of a bookmark, will return if no bookmark is present + * + * @param post post to change status + * @param status status to change towards + */ + public void updateStatusOfSavedPostForCurrentUser(Posting post, SavedPostStatus status) { + var existingSavedPost = this.getSavedPostForCurrentUser(post); + + if (existingSavedPost == null) { + return; + } + + existingSavedPost.setStatus(status); + existingSavedPost.setCompletedAt(status == SavedPostStatus.IN_PROGRESS ? null : ZonedDateTime.now()); + savedPostRepository.save(existingSavedPost); + } + + /** + * Retrieve the saved posts for a given status + * + * @param status status to query + * @return a list of all saved posts of the current user with the given status + */ + public List getSavedPostsForCurrentUserByStatus(SavedPostStatus status) { + var currentUser = userRepository.getUser(); + + return savedPostRepository.findSavedPostsByUserIdAndStatusOrderByCompletedAtDescIdDesc(currentUser.getId(), status); + } + + /** + * Checks if maximum amount of saved posts limit is reached + * + * @return true if max saved post it reached, false otherwise + */ + public boolean isMaximumSavedPostsReached() { + var currentUser = userRepository.getUser(); + + return MAX_SAVED_POSTS_PER_USER <= savedPostRepository.countByUserId(currentUser.getId()); + } + + /** + * Helper method to retrieve a bookmark for the current user + * + * @param post post to search bookmark for + * @return The saved post for the given posting if present + */ + private SavedPost getSavedPostForCurrentUser(Posting post) { + PostingType type = post instanceof Post ? PostingType.POST : PostingType.ANSWER; + var author = userRepository.getUser(); + + return savedPostRepository.findSavedPostByUserIdAndPostIdAndPostType(author.getId(), post.getId(), type); + } +} diff --git a/src/main/java/de/tum/cit/aet/artemis/communication/service/conversation/ChannelService.java b/src/main/java/de/tum/cit/aet/artemis/communication/service/conversation/ChannelService.java index c78f44893d8e..791847b75670 100644 --- a/src/main/java/de/tum/cit/aet/artemis/communication/service/conversation/ChannelService.java +++ b/src/main/java/de/tum/cit/aet/artemis/communication/service/conversation/ChannelService.java @@ -17,18 +17,21 @@ import org.springframework.util.StringUtils; import de.tum.cit.aet.artemis.communication.domain.ConversationParticipant; +import de.tum.cit.aet.artemis.communication.domain.NotificationType; import de.tum.cit.aet.artemis.communication.domain.conversation.Channel; import de.tum.cit.aet.artemis.communication.dto.ChannelDTO; import de.tum.cit.aet.artemis.communication.dto.MetisCrudAction; import de.tum.cit.aet.artemis.communication.repository.ConversationParticipantRepository; import de.tum.cit.aet.artemis.communication.repository.conversation.ChannelRepository; import de.tum.cit.aet.artemis.communication.service.conversation.errors.ChannelNameDuplicateException; +import de.tum.cit.aet.artemis.communication.service.notifications.SingleUserNotificationService; import de.tum.cit.aet.artemis.core.domain.Course; import de.tum.cit.aet.artemis.core.domain.User; import de.tum.cit.aet.artemis.core.exception.BadRequestAlertException; import de.tum.cit.aet.artemis.core.repository.UserRepository; import de.tum.cit.aet.artemis.exam.domain.Exam; import de.tum.cit.aet.artemis.exercise.domain.Exercise; +import de.tum.cit.aet.artemis.exercise.repository.StudentParticipationRepository; import de.tum.cit.aet.artemis.lecture.domain.Lecture; @Profile(PROFILE_CORE) @@ -47,12 +50,18 @@ public class ChannelService { private final UserRepository userRepository; + private final StudentParticipationRepository studentParticipationRepository; + + private final SingleUserNotificationService singleUserNotificationService; + public ChannelService(ConversationParticipantRepository conversationParticipantRepository, ChannelRepository channelRepository, ConversationService conversationService, - UserRepository userRepository) { + UserRepository userRepository, StudentParticipationRepository studentParticipationRepository, SingleUserNotificationService singleUserNotificationService) { this.conversationParticipantRepository = conversationParticipantRepository; this.channelRepository = channelRepository; this.conversationService = conversationService; this.userRepository = userRepository; + this.studentParticipationRepository = studentParticipationRepository; + this.singleUserNotificationService = singleUserNotificationService; } /** @@ -405,4 +414,40 @@ private static String generateChannelNameFromTitle(@NotNull String prefix, Optio } return channelName; } + + /** + * Creates a feedback-specific channel for an exercise within a course. + * + * @param course in which the channel is being created. + * @param exerciseId of the exercise associated with the feedback channel. + * @param channelDTO containing the properties of the channel to be created, such as name, description, and visibility. + * @param feedbackDetailText used to identify the students affected by the feedback. + * @param requestingUser initiating the channel creation request. + * @return the created {@link Channel} object with its properties. + * @throws BadRequestAlertException if the channel name starts with an invalid prefix (e.g., "$"). + */ + public Channel createFeedbackChannel(Course course, Long exerciseId, ChannelDTO channelDTO, String feedbackDetailText, User requestingUser) { + Channel channelToCreate = new Channel(); + channelToCreate.setName(channelDTO.getName()); + channelToCreate.setIsPublic(channelDTO.getIsPublic()); + channelToCreate.setIsAnnouncementChannel(channelDTO.getIsAnnouncementChannel()); + channelToCreate.setIsArchived(false); + channelToCreate.setDescription(channelDTO.getDescription()); + + if (channelToCreate.getName() != null && channelToCreate.getName().trim().startsWith("$")) { + throw new BadRequestAlertException("User generated channels cannot start with $", "channel", "channelNameInvalid"); + } + + Channel createdChannel = createChannel(course, channelToCreate, Optional.of(requestingUser)); + + List userLogins = studentParticipationRepository.findAffectedLoginsByFeedbackDetailText(exerciseId, feedbackDetailText); + + if (userLogins != null && !userLogins.isEmpty()) { + var registeredUsers = registerUsersToChannel(false, false, false, userLogins, course, createdChannel); + registeredUsers.forEach(user -> singleUserNotificationService.notifyClientAboutConversationCreationOrDeletion(createdChannel, user, requestingUser, + NotificationType.CONVERSATION_ADD_USER_CHANNEL)); + } + + return createdChannel; + } } diff --git a/src/main/java/de/tum/cit/aet/artemis/communication/service/notifications/MailService.java b/src/main/java/de/tum/cit/aet/artemis/communication/service/notifications/MailService.java index fc6f7e9e1256..88926325aa4e 100644 --- a/src/main/java/de/tum/cit/aet/artemis/communication/service/notifications/MailService.java +++ b/src/main/java/de/tum/cit/aet/artemis/communication/service/notifications/MailService.java @@ -5,6 +5,8 @@ import static de.tum.cit.aet.artemis.core.config.Constants.PROFILE_CORE; import java.net.URL; +import java.util.HashMap; +import java.util.List; import java.util.Locale; import java.util.Set; @@ -64,6 +66,8 @@ public class MailService implements InstantNotificationService { private final MailSendingService mailSendingService; + private final List markdownCustomRendererServices; + // notification related variables private static final String NOTIFICATION = "notification"; @@ -89,11 +93,16 @@ public class MailService implements InstantNotificationService { private static final String WEEKLY_SUMMARY_NEW_EXERCISES = "weeklySummaryNewExercises"; - public MailService(MessageSource messageSource, SpringTemplateEngine templateEngine, TimeService timeService, MailSendingService mailSendingService) { + private final HashMap renderedPosts; + + public MailService(MessageSource messageSource, SpringTemplateEngine templateEngine, TimeService timeService, MailSendingService mailSendingService, + MarkdownCustomLinkRendererService markdownCustomLinkRendererService, MarkdownCustomReferenceRendererService markdownCustomReferenceRendererService) { this.messageSource = messageSource; this.templateEngine = templateEngine; this.timeService = timeService; this.mailSendingService = mailSendingService; + markdownCustomRendererServices = List.of(markdownCustomLinkRendererService, markdownCustomReferenceRendererService); + renderedPosts = new HashMap<>(); } /** @@ -266,14 +275,30 @@ public void sendNotification(Notification notification, User user, Object notifi // Render markdown content of post to html try { - Parser parser = Parser.builder().build(); - HtmlRenderer renderer = HtmlRenderer.builder().build(); - String postContent = post.getContent(); - String renderedPostContent = renderer.render(parser.parse(postContent)); + String renderedPostContent; + + // To avoid having to re-render the same post multiple times we store it in a hash map + if (renderedPosts.containsKey(post.getId())) { + renderedPostContent = renderedPosts.get(post.getId()); + } + else { + Parser parser = Parser.builder().build(); + HtmlRenderer renderer = HtmlRenderer.builder() + .attributeProviderFactory(attributeContext -> new MarkdownRelativeToAbsolutePathAttributeProvider(artemisServerUrl.toString())) + .nodeRendererFactory(new MarkdownImageBlockRendererFactory(artemisServerUrl.toString())).build(); + String postContent = post.getContent(); + renderedPostContent = markdownCustomRendererServices.stream().reduce(renderer.render(parser.parse(postContent)), (s, service) -> service.render(s), + (s1, s2) -> s2); + if (post.getId() != null) { + renderedPosts.put(post.getId(), renderedPostContent); + } + } + post.setContent(renderedPostContent); } catch (Exception e) { // In case something goes wrong, leave content of post as-is + log.error("Error while parsing post content", e); } } else { diff --git a/src/main/java/de/tum/cit/aet/artemis/communication/service/notifications/MarkdownCustomLinkRendererService.java b/src/main/java/de/tum/cit/aet/artemis/communication/service/notifications/MarkdownCustomLinkRendererService.java new file mode 100644 index 000000000000..1f06aef2404c --- /dev/null +++ b/src/main/java/de/tum/cit/aet/artemis/communication/service/notifications/MarkdownCustomLinkRendererService.java @@ -0,0 +1,71 @@ +package de.tum.cit.aet.artemis.communication.service.notifications; + +import static de.tum.cit.aet.artemis.core.config.Constants.PROFILE_CORE; + +import java.net.URL; +import java.util.Set; +import java.util.regex.Matcher; +import java.util.regex.Pattern; + +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; +import org.springframework.beans.factory.annotation.Value; +import org.springframework.context.annotation.Profile; +import org.springframework.stereotype.Service; +import org.springframework.web.util.UriComponentsBuilder; + +/** + * This service implements the rendering of markdown tags that represent a link. + * It takes the tag, transforms it into an tag, and sets the corresponding href. + */ +@Profile(PROFILE_CORE) +@Service +public class MarkdownCustomLinkRendererService implements MarkdownCustomRendererService { + + private static final Logger log = LoggerFactory.getLogger(MarkdownCustomLinkRendererService.class); + + private final Set supportedTags; + + @Value("${server.url}") + private URL artemisServerUrl; + + public MarkdownCustomLinkRendererService() { + this.supportedTags = Set.of("programming", "modeling", "quiz", "text", "file-upload", "lecture", "attachment", "lecture-unit", "slide", "faq"); + } + + /** + * Takes a string and replaces all occurrences of custom markdown tags (e.g. [programming], [faq], etc.) with a link + * + * @param content string to render + * + * @return the newly rendered string. + */ + public String render(String content) { + String tagPattern = String.join("|", supportedTags); + // The pattern checks for the occurrence of any tag and then extracts the link from it + Pattern pattern = Pattern.compile("\\[(" + tagPattern + ")\\](.*?)\\((.*?)\\)(.*?)\\[/\\1\\]"); + Matcher matcher = pattern.matcher(content); + String parsedContent = content; + + while (matcher.find()) { + try { + String textStart = matcher.group(2); + String link = matcher.group(3); + String textEnd = matcher.group(4); + String text = (textStart + " " + textEnd).trim(); + + String absoluteUrl = UriComponentsBuilder.fromUri(artemisServerUrl.toURI()).path(link).build().toUriString(); + + parsedContent = parsedContent.substring(0, matcher.start()) + "" + text + "" + parsedContent.substring(matcher.end()); + } + catch (Exception e) { + log.error("Not able to render tag. Replacing with empty.", e); + parsedContent = parsedContent.substring(0, matcher.start()) + parsedContent.substring(matcher.end()); + } + + matcher = pattern.matcher(parsedContent); + } + + return parsedContent; + } +} diff --git a/src/main/java/de/tum/cit/aet/artemis/communication/service/notifications/MarkdownCustomReferenceRendererService.java b/src/main/java/de/tum/cit/aet/artemis/communication/service/notifications/MarkdownCustomReferenceRendererService.java new file mode 100644 index 000000000000..3ff199e10b77 --- /dev/null +++ b/src/main/java/de/tum/cit/aet/artemis/communication/service/notifications/MarkdownCustomReferenceRendererService.java @@ -0,0 +1,72 @@ +package de.tum.cit.aet.artemis.communication.service.notifications; + +import static de.tum.cit.aet.artemis.core.config.Constants.PROFILE_CORE; + +import java.util.HashMap; +import java.util.Set; +import java.util.regex.Matcher; +import java.util.regex.Pattern; + +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; +import org.springframework.context.annotation.Profile; +import org.springframework.stereotype.Service; + +/** + * This service implements the rendering of markdown tags that represent a reference (to e.g. a user). + * These references cannot directly represent a link, so they are rendered as their text only. + */ +@Profile(PROFILE_CORE) +@Service +public class MarkdownCustomReferenceRendererService implements MarkdownCustomRendererService { + + private static final Logger log = LoggerFactory.getLogger(MarkdownCustomReferenceRendererService.class); + + private final Set supportedTags; + + private final HashMap startingCharacters; + + public MarkdownCustomReferenceRendererService() { + supportedTags = Set.of("user", "channel"); + startingCharacters = new HashMap<>(); + startingCharacters.put("user", "@"); + startingCharacters.put("channel", "#"); + } + + /** + * Takes a string and replaces all occurrences of custom markdown tags (e.g. [user], [channel], etc.) with text. + * To make it better readable, it prepends an appropriate character. (e.g. for users an @, for channels a #) + * + * @param content string to render + * + * @return the newly rendered string. + */ + @Override + public String render(String content) { + String tagPattern = String.join("|", supportedTags); + Pattern pattern = Pattern.compile("\\[(" + tagPattern + ")\\](.*?)\\((.*?)\\)(.*?)\\[/\\1\\]"); + Matcher matcher = pattern.matcher(content); + String parsedContent = content; + + while (matcher.find()) { + try { + String tag = matcher.group(1); + String startingCharacter = startingCharacters.get(tag); + startingCharacter = startingCharacter == null ? "" : startingCharacter; + String textStart = matcher.group(2); + String textEnd = matcher.group(4); + String text = startingCharacter + (textStart + " " + textEnd).trim(); + + parsedContent = parsedContent.substring(0, matcher.start()) + text + parsedContent.substring(matcher.end()); + } + catch (Exception e) { + log.error("Not able to render tag. Replacing with empty.", e); + parsedContent = parsedContent.substring(0, matcher.start()) + parsedContent.substring(matcher.end()); + } + + matcher = pattern.matcher(parsedContent); + } + + return parsedContent; + } +} diff --git a/src/main/java/de/tum/cit/aet/artemis/communication/service/notifications/MarkdownCustomRendererService.java b/src/main/java/de/tum/cit/aet/artemis/communication/service/notifications/MarkdownCustomRendererService.java new file mode 100644 index 000000000000..e96eaa8f7a01 --- /dev/null +++ b/src/main/java/de/tum/cit/aet/artemis/communication/service/notifications/MarkdownCustomRendererService.java @@ -0,0 +1,6 @@ +package de.tum.cit.aet.artemis.communication.service.notifications; + +public interface MarkdownCustomRendererService { + + String render(String content); +} diff --git a/src/main/java/de/tum/cit/aet/artemis/communication/service/notifications/MarkdownImageBlockRenderer.java b/src/main/java/de/tum/cit/aet/artemis/communication/service/notifications/MarkdownImageBlockRenderer.java new file mode 100644 index 000000000000..8653e90aa2ea --- /dev/null +++ b/src/main/java/de/tum/cit/aet/artemis/communication/service/notifications/MarkdownImageBlockRenderer.java @@ -0,0 +1,44 @@ +package de.tum.cit.aet.artemis.communication.service.notifications; + +import java.util.Map; +import java.util.Set; + +import org.commonmark.node.Image; +import org.commonmark.node.Node; +import org.commonmark.node.Text; +import org.commonmark.renderer.NodeRenderer; +import org.commonmark.renderer.html.HtmlNodeRendererContext; +import org.commonmark.renderer.html.HtmlWriter; + +public class MarkdownImageBlockRenderer implements NodeRenderer { + + private final String baseUrl; + + private final HtmlWriter html; + + MarkdownImageBlockRenderer(HtmlNodeRendererContext context, String baseUrl) { + html = context.getWriter(); + this.baseUrl = baseUrl; + } + + @Override + public Set> getNodeTypes() { + return Set.of(Image.class); + } + + @Override + public void render(Node node) { + Image image = (Image) node; + + html.tag("a", Map.of("href", baseUrl + image.getDestination())); + + try { + html.text(((Text) image.getFirstChild()).getLiteral()); + } + catch (Exception e) { + html.text(image.getDestination()); + } + + html.tag("/a"); + } +} diff --git a/src/main/java/de/tum/cit/aet/artemis/communication/service/notifications/MarkdownImageBlockRendererFactory.java b/src/main/java/de/tum/cit/aet/artemis/communication/service/notifications/MarkdownImageBlockRendererFactory.java new file mode 100644 index 000000000000..4516fc87af81 --- /dev/null +++ b/src/main/java/de/tum/cit/aet/artemis/communication/service/notifications/MarkdownImageBlockRendererFactory.java @@ -0,0 +1,19 @@ +package de.tum.cit.aet.artemis.communication.service.notifications; + +import org.commonmark.renderer.NodeRenderer; +import org.commonmark.renderer.html.HtmlNodeRendererContext; +import org.commonmark.renderer.html.HtmlNodeRendererFactory; + +public class MarkdownImageBlockRendererFactory implements HtmlNodeRendererFactory { + + private final String baseUrl; + + public MarkdownImageBlockRendererFactory(String baseUrl) { + this.baseUrl = baseUrl; + } + + @Override + public NodeRenderer create(HtmlNodeRendererContext context) { + return new MarkdownImageBlockRenderer(context, baseUrl); + } +} diff --git a/src/main/java/de/tum/cit/aet/artemis/communication/service/notifications/MarkdownRelativeToAbsolutePathAttributeProvider.java b/src/main/java/de/tum/cit/aet/artemis/communication/service/notifications/MarkdownRelativeToAbsolutePathAttributeProvider.java new file mode 100644 index 000000000000..de95f6cf3af7 --- /dev/null +++ b/src/main/java/de/tum/cit/aet/artemis/communication/service/notifications/MarkdownRelativeToAbsolutePathAttributeProvider.java @@ -0,0 +1,32 @@ +package de.tum.cit.aet.artemis.communication.service.notifications; + +import java.util.Map; + +import org.commonmark.node.Node; +import org.commonmark.renderer.html.AttributeProvider; + +public class MarkdownRelativeToAbsolutePathAttributeProvider implements AttributeProvider { + + private final String baseUrl; + + public MarkdownRelativeToAbsolutePathAttributeProvider(String baseUrl) { + this.baseUrl = baseUrl; + } + + /** + * We store images and attachments with relative urls, so when rendering we need to replace them with absolute ones + * + * @param node rendered Node, if Image or Link we try to replace the source + * @param attributes of the Node + * @param tagName of the html element + */ + @Override + public void setAttributes(Node node, String tagName, Map attributes) { + if ("a".equals(tagName)) { + String href = attributes.get("href"); + if (href != null && href.startsWith("/")) { + attributes.put("href", baseUrl + href); + } + } + } +} diff --git a/src/main/java/de/tum/cit/aet/artemis/communication/web/ConversationMessageResource.java b/src/main/java/de/tum/cit/aet/artemis/communication/web/ConversationMessageResource.java index bfa04d53cc5f..75c68fbec7a1 100644 --- a/src/main/java/de/tum/cit/aet/artemis/communication/web/ConversationMessageResource.java +++ b/src/main/java/de/tum/cit/aet/artemis/communication/web/ConversationMessageResource.java @@ -132,6 +132,8 @@ else if (postContextFilter.courseWideChannelIds() != null) { if (post.getConversation() != null) { post.getConversation().hideDetails(); } + + conversationMessagingService.preparePostForBroadcast(post); }); final var headers = PaginationUtil.generatePaginationHttpHeaders(ServletUriComponentsBuilder.fromCurrentRequest(), coursePosts); logDuration(coursePosts.getContent(), principal, timeNanoStart); diff --git a/src/main/java/de/tum/cit/aet/artemis/communication/web/SavedPostResource.java b/src/main/java/de/tum/cit/aet/artemis/communication/web/SavedPostResource.java new file mode 100644 index 000000000000..a7c6ba9c7faa --- /dev/null +++ b/src/main/java/de/tum/cit/aet/artemis/communication/web/SavedPostResource.java @@ -0,0 +1,218 @@ +package de.tum.cit.aet.artemis.communication.web; + +import static de.tum.cit.aet.artemis.core.config.Constants.PROFILE_CORE; + +import java.util.ArrayList; +import java.util.List; +import java.util.Objects; +import java.util.Optional; + +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; +import org.springframework.context.annotation.Profile; +import org.springframework.http.HttpStatus; +import org.springframework.http.ResponseEntity; +import org.springframework.web.bind.annotation.DeleteMapping; +import org.springframework.web.bind.annotation.GetMapping; +import org.springframework.web.bind.annotation.PathVariable; +import org.springframework.web.bind.annotation.PostMapping; +import org.springframework.web.bind.annotation.PutMapping; +import org.springframework.web.bind.annotation.RequestMapping; +import org.springframework.web.bind.annotation.RequestParam; +import org.springframework.web.bind.annotation.RestController; +import org.springframework.web.server.ResponseStatusException; + +import de.tum.cit.aet.artemis.communication.domain.AnswerPost; +import de.tum.cit.aet.artemis.communication.domain.Post; +import de.tum.cit.aet.artemis.communication.domain.Posting; +import de.tum.cit.aet.artemis.communication.domain.PostingType; +import de.tum.cit.aet.artemis.communication.domain.SavedPost; +import de.tum.cit.aet.artemis.communication.domain.SavedPostStatus; +import de.tum.cit.aet.artemis.communication.dto.PostingDTO; +import de.tum.cit.aet.artemis.communication.repository.AnswerPostRepository; +import de.tum.cit.aet.artemis.communication.repository.PostRepository; +import de.tum.cit.aet.artemis.communication.service.SavedPostService; +import de.tum.cit.aet.artemis.core.exception.BadRequestAlertException; +import de.tum.cit.aet.artemis.core.exception.EntityNotFoundException; +import de.tum.cit.aet.artemis.core.security.annotations.EnforceAtLeastStudent; +import de.tum.cit.aet.artemis.core.util.TimeLogUtil; + +/** + * REST controller for managing Message Posts. + */ +@Profile(PROFILE_CORE) +@RestController +@RequestMapping("api/") +public class SavedPostResource { + + private static final Logger log = LoggerFactory.getLogger(SavedPostResource.class); + + public static final String ENTITY_NAME = "savedPost"; + + private final SavedPostService savedPostService; + + private final PostRepository postRepository; + + private final AnswerPostRepository answerPostRepository; + + public SavedPostResource(SavedPostService savedPostService, PostRepository postRepository, AnswerPostRepository answerPostRepository) { + this.savedPostService = savedPostService; + this.postRepository = postRepository; + this.answerPostRepository = answerPostRepository; + } + + /** + * GET /saved-posts/{courseId}/{status} : Get saved posts of course with specific status + * + * @param courseId id of course to filter posts + * @param status saved post status (progress, completed, archived) + * @return ResponseEntity with status 200 (Success) if course id and status are ok, + * or with status 400 (Bad Request) if the checks on type or post validity fail + */ + @GetMapping("saved-posts/{courseId}/{status}") + @EnforceAtLeastStudent + public ResponseEntity> getSavedPosts(@PathVariable Long courseId, @PathVariable short status) { + log.debug("GET getSavedPosts invoked for course {} and status {}", courseId, status); + long start = System.nanoTime(); + + SavedPostStatus savedPostStatus; + try { + savedPostStatus = SavedPostStatus.fromDatabaseKey(status); + } + catch (IllegalArgumentException e) { + throw new BadRequestAlertException("The provided post status could not be found.", ENTITY_NAME, "savedPostStatusDoesNotExist"); + } + + var savedPosts = savedPostService.getSavedPostsForCurrentUserByStatus(savedPostStatus); + + List posts = postRepository.findByIdIn(savedPosts.stream().filter(savedPost -> savedPost.getPostType() == PostingType.POST).map(SavedPost::getPostId).toList()) + .stream().filter(post -> Objects.equals(post.getCoursePostingBelongsTo().getId(), courseId)).toList(); + List answerPosts = answerPostRepository + .findByIdIn(savedPosts.stream().filter(savedPost -> savedPost.getPostType() == PostingType.ANSWER).map(SavedPost::getPostId).toList()).stream() + .filter(post -> Objects.equals(post.getCoursePostingBelongsTo().getId(), courseId)).toList(); + List postingList = new ArrayList<>(); + + for (SavedPost savedPost : savedPosts) { + Optional posting; + if (savedPost.getPostType() == PostingType.ANSWER) { + posting = answerPosts.stream().filter(answerPost -> answerPost.getId().equals(savedPost.getPostId())).findFirst(); + } + else { + posting = posts.stream().filter(post -> post.getId().equals(savedPost.getPostId())).findFirst(); + } + if (posting.isPresent()) { + postingList.add(new PostingDTO((Posting) posting.get(), true, savedPost.getStatus().getDatabaseKey())); + } + } + + log.info("getSavedPosts took {}", TimeLogUtil.formatDurationFrom(start)); + return new ResponseEntity<>(postingList, null, HttpStatus.OK); + } + + /** + * POST /saved-posts/{postId}/{type} : Create a new saved post + * + * @param postId post to save + * @param type post type (post, answer) + * @return ResponseEntity with status 201 (Created) if successfully saved post, + * or with status 400 (Bad Request) if the checks on type or post validity fail + */ + @PostMapping("saved-posts/{postId}/{type}") + @EnforceAtLeastStudent + public ResponseEntity savePost(@PathVariable Long postId, @PathVariable short type) { + log.debug("POST savePost invoked for post {}", postId); + long start = System.nanoTime(); + + if (savedPostService.isMaximumSavedPostsReached()) { + throw new BadRequestAlertException("The maximum amount of saved posts was reached.", ENTITY_NAME, "savedPostMaxReached"); + } + + var post = retrievePostingElseThrow(postId, type); + + this.savedPostService.savePostForCurrentUser(post); + + log.info("savePost took {}", TimeLogUtil.formatDurationFrom(start)); + return new ResponseEntity<>(null, null, HttpStatus.CREATED); + } + + /** + * DELETE /saved-posts/{postId}/{type} : Remove a saved post + * + * @param postId post to save + * @param type post type (post, answer) + * @return ResponseEntity with status 204 (No content) if successfully deleted post, + * or with status 400 (Bad Request) if the checks on type or post validity fail + */ + @DeleteMapping("saved-posts/{postId}/{type}") + @EnforceAtLeastStudent + public ResponseEntity deleteSavedPost(@PathVariable Long postId, @PathVariable short type) { + log.debug("DELETE deletePost invoked for post {}", postId); + long start = System.nanoTime(); + + var post = retrievePostingElseThrow(postId, type); + + if (!this.savedPostService.removeSavedPostForCurrentUser(post)) { + throw new ResponseStatusException(HttpStatus.FORBIDDEN, "You are not allowed to delete this bookmark."); + } + + log.info("deletePost took {}", TimeLogUtil.formatDurationFrom(start)); + return new ResponseEntity<>(null, null, HttpStatus.NO_CONTENT); + } + + /** + * PUT /saved-posts/{postId}/{type} : Update the status of a saved post + * + * @param postId post to save + * @param type post type (post, answer) + * @param status saved post status (progress, answer) + * @return ResponseEntity with status 200 (Success) if successfully updated saved post status, + * or with status 400 (Bad Request) if the checks on type or post validity fail + */ + @PutMapping("saved-posts/{postId}/{type}") + @EnforceAtLeastStudent + public ResponseEntity putSavedPost(@PathVariable Long postId, @PathVariable short type, @RequestParam(name = "status") short status) { + log.debug("DELETE putSavedPost invoked for post {}", postId); + long start = System.nanoTime(); + + var post = retrievePostingElseThrow(postId, type); + + SavedPostStatus savedPostStatus; + try { + savedPostStatus = SavedPostStatus.fromDatabaseKey(status); + } + catch (IllegalArgumentException e) { + throw new BadRequestAlertException("The provided post status could not be found.", ENTITY_NAME, "savedPostStatusDoesNotExist"); + } + + this.savedPostService.updateStatusOfSavedPostForCurrentUser(post, savedPostStatus); + + log.info("putSavedPost took {}", TimeLogUtil.formatDurationFrom(start)); + return new ResponseEntity<>(null, null, HttpStatus.OK); + } + + private Posting retrievePostingElseThrow(long postId, short type) throws BadRequestAlertException { + PostingType postingType; + + try { + postingType = PostingType.fromDatabaseKey(type); + } + catch (IllegalArgumentException e) { + throw new BadRequestAlertException("The provided post type could not be found.", ENTITY_NAME, "savedPostTypeDoesNotExist"); + } + + Posting post; + try { + if (postingType == PostingType.POST) { + post = postRepository.findPostOrMessagePostByIdElseThrow(postId); + } + else { + post = answerPostRepository.findAnswerPostOrMessageByIdElseThrow(postId); + } + } + catch (EntityNotFoundException e) { + throw new BadRequestAlertException("The provided post could not be found.", ENTITY_NAME, "savedPostIdDoesNotExist"); + } + + return post; + } +} diff --git a/src/main/java/de/tum/cit/aet/artemis/communication/web/conversation/ChannelResource.java b/src/main/java/de/tum/cit/aet/artemis/communication/web/conversation/ChannelResource.java index 03c7445e02e0..cbb59c4b7e46 100644 --- a/src/main/java/de/tum/cit/aet/artemis/communication/web/conversation/ChannelResource.java +++ b/src/main/java/de/tum/cit/aet/artemis/communication/web/conversation/ChannelResource.java @@ -35,6 +35,7 @@ import de.tum.cit.aet.artemis.communication.domain.conversation.Channel; import de.tum.cit.aet.artemis.communication.dto.ChannelDTO; import de.tum.cit.aet.artemis.communication.dto.ChannelIdAndNameDTO; +import de.tum.cit.aet.artemis.communication.dto.FeedbackChannelRequestDTO; import de.tum.cit.aet.artemis.communication.repository.ConversationParticipantRepository; import de.tum.cit.aet.artemis.communication.repository.conversation.ChannelRepository; import de.tum.cit.aet.artemis.communication.service.conversation.ChannelService; @@ -42,6 +43,7 @@ import de.tum.cit.aet.artemis.communication.service.conversation.ConversationService; import de.tum.cit.aet.artemis.communication.service.conversation.auth.ChannelAuthorizationService; import de.tum.cit.aet.artemis.communication.service.notifications.SingleUserNotificationService; +import de.tum.cit.aet.artemis.core.domain.Course; import de.tum.cit.aet.artemis.core.domain.User; import de.tum.cit.aet.artemis.core.exception.AccessForbiddenAlertException; import de.tum.cit.aet.artemis.core.exception.BadRequestAlertException; @@ -50,7 +52,9 @@ import de.tum.cit.aet.artemis.core.repository.UserRepository; import de.tum.cit.aet.artemis.core.security.Role; import de.tum.cit.aet.artemis.core.security.annotations.EnforceAtLeastStudent; +import de.tum.cit.aet.artemis.core.security.annotations.enforceRoleInCourse.EnforceAtLeastEditorInCourse; import de.tum.cit.aet.artemis.core.service.AuthorizationCheckService; +import de.tum.cit.aet.artemis.exercise.repository.StudentParticipationRepository; import de.tum.cit.aet.artemis.tutorialgroup.service.TutorialGroupChannelManagementService; @Profile(PROFILE_CORE) @@ -80,10 +84,13 @@ public class ChannelResource extends ConversationManagementResource { private final ConversationParticipantRepository conversationParticipantRepository; + private final StudentParticipationRepository studentParticipationRepository; + public ChannelResource(ConversationParticipantRepository conversationParticipantRepository, SingleUserNotificationService singleUserNotificationService, ChannelService channelService, ChannelRepository channelRepository, ChannelAuthorizationService channelAuthorizationService, AuthorizationCheckService authorizationCheckService, ConversationDTOService conversationDTOService, CourseRepository courseRepository, UserRepository userRepository, - ConversationService conversationService, TutorialGroupChannelManagementService tutorialGroupChannelManagementService) { + ConversationService conversationService, TutorialGroupChannelManagementService tutorialGroupChannelManagementService, + StudentParticipationRepository studentParticipationRepository) { super(courseRepository); this.channelService = channelService; this.channelRepository = channelRepository; @@ -95,6 +102,7 @@ public ChannelResource(ConversationParticipantRepository conversationParticipant this.tutorialGroupChannelManagementService = tutorialGroupChannelManagementService; this.singleUserNotificationService = singleUserNotificationService; this.conversationParticipantRepository = conversationParticipantRepository; + this.studentParticipationRepository = studentParticipationRepository; } /** @@ -460,6 +468,34 @@ public ResponseEntity deregisterUsers(@PathVariable Long courseId, @PathVa return ResponseEntity.ok().build(); } + /** + * POST /api/courses/:courseId/channels/: Creates a new feedback-specific channel in a course. + * + * @param courseId where the channel is being created. + * @param exerciseId for which the feedback channel is being created. + * @param feedbackChannelRequest containing a DTO with the properties of the channel (e.g., name, description, visibility) + * and the feedback detail text used to determine the affected students to be added to the channel. + * @return ResponseEntity with status 201 (Created) and the body containing the details of the created channel. + * @throws URISyntaxException if the URI for the created resource cannot be constructed. + * @throws BadRequestAlertException if the channel name starts with an invalid prefix (e.g., "$"). + */ + @PostMapping("{courseId}/{exerciseId}/feedback-channel") + @EnforceAtLeastEditorInCourse + public ResponseEntity createFeedbackChannel(@PathVariable Long courseId, @PathVariable Long exerciseId, + @RequestBody FeedbackChannelRequestDTO feedbackChannelRequest) throws URISyntaxException { + log.debug("REST request to create feedback channel for course {} and exercise {} with properties: {}", courseId, exerciseId, feedbackChannelRequest); + + ChannelDTO channelDTO = feedbackChannelRequest.channel(); + String feedbackDetailText = feedbackChannelRequest.feedbackDetailText(); + + User requestingUser = userRepository.getUserWithGroupsAndAuthorities(); + Course course = courseRepository.findByIdElseThrow(courseId); + checkCommunicationEnabledElseThrow(course); + Channel createdChannel = channelService.createFeedbackChannel(course, exerciseId, channelDTO, feedbackDetailText, requestingUser); + + return ResponseEntity.created(new URI("/api/channels/" + createdChannel.getId())).body(conversationDTOService.convertChannelToDTO(requestingUser, createdChannel)); + } + private void checkEntityIdMatchesPathIds(Channel channel, Optional courseId, Optional conversationId) { courseId.ifPresent(courseIdValue -> { if (!channel.getCourse().getId().equals(courseIdValue)) { diff --git a/src/main/java/de/tum/cit/aet/artemis/core/domain/User.java b/src/main/java/de/tum/cit/aet/artemis/core/domain/User.java index 6498340f3bc2..2ef2478cf295 100644 --- a/src/main/java/de/tum/cit/aet/artemis/core/domain/User.java +++ b/src/main/java/de/tum/cit/aet/artemis/core/domain/User.java @@ -40,6 +40,7 @@ import de.tum.cit.aet.artemis.atlas.domain.competency.CompetencyProgress; import de.tum.cit.aet.artemis.atlas.domain.competency.LearningPath; +import de.tum.cit.aet.artemis.communication.domain.SavedPost; import de.tum.cit.aet.artemis.communication.domain.push_notification.PushNotificationDeviceConfiguration; import de.tum.cit.aet.artemis.core.config.Constants; import de.tum.cit.aet.artemis.core.exception.AccessForbiddenException; @@ -180,6 +181,9 @@ public class User extends AbstractAuditingEntity implements Participant { @OneToMany(mappedBy = "user", fetch = FetchType.LAZY, cascade = CascadeType.ALL, orphanRemoval = true) private Set guidedTourSettings = new HashSet<>(); + @OneToMany(mappedBy = "user", fetch = FetchType.LAZY, cascade = CascadeType.REMOVE, orphanRemoval = true) + private Set savedPosts = new HashSet<>(); + @ManyToMany @JoinTable(name = "jhi_user_authority", joinColumns = { @JoinColumn(name = "user_id", referencedColumnName = "id") }, inverseJoinColumns = { @JoinColumn(name = "authority_name", referencedColumnName = "name") }) diff --git a/src/main/java/de/tum/cit/aet/artemis/core/service/user/UserService.java b/src/main/java/de/tum/cit/aet/artemis/core/service/user/UserService.java index d06ecfec87af..31937ac6a5b6 100644 --- a/src/main/java/de/tum/cit/aet/artemis/core/service/user/UserService.java +++ b/src/main/java/de/tum/cit/aet/artemis/core/service/user/UserService.java @@ -39,6 +39,8 @@ import org.springframework.util.StringUtils; import de.tum.cit.aet.artemis.atlas.repository.ScienceEventRepository; +import de.tum.cit.aet.artemis.communication.domain.SavedPost; +import de.tum.cit.aet.artemis.communication.repository.SavedPostRepository; import de.tum.cit.aet.artemis.core.domain.Authority; import de.tum.cit.aet.artemis.core.domain.GuidedTourSetting; import de.tum.cit.aet.artemis.core.domain.User; @@ -113,11 +115,13 @@ public class UserService { private final ParticipationVcsAccessTokenService participationVCSAccessTokenService; + private final SavedPostRepository savedPostRepository; + public UserService(UserCreationService userCreationService, UserRepository userRepository, AuthorityService authorityService, AuthorityRepository authorityRepository, CacheManager cacheManager, Optional ldapUserService, GuidedTourSettingsRepository guidedTourSettingsRepository, PasswordService passwordService, Optional optionalVcsUserManagementService, Optional optionalCIUserManagementService, InstanceMessageSendService instanceMessageSendService, FileService fileService, ScienceEventRepository scienceEventRepository, - ParticipationVcsAccessTokenService participationVCSAccessTokenService) { + ParticipationVcsAccessTokenService participationVCSAccessTokenService, SavedPostRepository savedPostRepository) { this.userCreationService = userCreationService; this.userRepository = userRepository; this.authorityService = authorityService; @@ -132,6 +136,7 @@ public UserService(UserCreationService userCreationService, UserRepository userR this.fileService = fileService; this.scienceEventRepository = scienceEventRepository; this.participationVCSAccessTokenService = participationVCSAccessTokenService; + this.savedPostRepository = savedPostRepository; } /** @@ -493,6 +498,12 @@ protected void anonymizeUser(User user) { user.setActivated(false); user.setGroups(Collections.emptySet()); + List savedPostsOfUser = savedPostRepository.findSavedPostsByUserId(user.getId()); + + if (!savedPostsOfUser.isEmpty()) { + savedPostRepository.deleteAll(savedPostsOfUser); + } + userRepository.save(user); clearUserCaches(user); userRepository.flush(); diff --git a/src/main/java/de/tum/cit/aet/artemis/exercise/domain/participation/Participation.java b/src/main/java/de/tum/cit/aet/artemis/exercise/domain/participation/Participation.java index ce891aeb9093..9d8e8627635a 100644 --- a/src/main/java/de/tum/cit/aet/artemis/exercise/domain/participation/Participation.java +++ b/src/main/java/de/tum/cit/aet/artemis/exercise/domain/participation/Participation.java @@ -96,14 +96,19 @@ public abstract class Participation extends DomainObject implements Participatio protected Exercise exercise; /** - * Results are not cascaded through the participation because ideally we want the relationship between participations, submissions and results as follows: each participation - * has multiple submissions. For each submission there can be a result. Therefore, the result is persisted with the submission. Refer to Submission.result for cascading - * settings. + * @deprecated: Will be removed for 8.0, please use submissions.results instead + * + * Results are not cascaded through the participation because ideally we want the relationship between participations, submissions and results as follows: each + * participation + * has multiple submissions. For each submission there can be a result. Therefore, the result is persisted with the submission. Refer to Submission.result for + * cascading + * settings. */ @OneToMany(mappedBy = "participation") @JsonIgnoreProperties(value = "participation", allowSetters = true) @Cache(usage = CacheConcurrencyStrategy.NONSTRICT_READ_WRITE) @JsonView(QuizView.Before.class) + @Deprecated(since = "7.7", forRemoval = true) private Set results = new HashSet<>(); /** @@ -201,26 +206,52 @@ public void setPracticeMode(boolean practiceMode) { this.testRun = practiceMode; } + /** + * @deprecated: Will be removed for 8.0, please use submissions.results instead + * @return the results + */ + @Deprecated(since = "7.7", forRemoval = true) public Set getResults() { return results; } + /** + * @deprecated: Will be removed for 8.0, please use submissions.results instead + * @param results the results + * @return the results + */ + @Deprecated(since = "7.7", forRemoval = true) public Participation results(Set results) { this.results = results; return this; } + /** + * @deprecated: Will be removed for 8.0, please use submissions.results instead + * @param result the result + */ + @Deprecated(since = "7.7", forRemoval = true) @Override public void addResult(Result result) { this.results.add(result); result.setParticipation(this); } + /** + * @deprecated: Will be removed for 8.0, please use submissions.results instead + * @param result the result + */ + @Deprecated(since = "7.7", forRemoval = true) public void removeResult(Result result) { this.results.remove(result); result.setParticipation(null); } + /** + * @deprecated: Will be removed for 8.0, please use submissions.results instead + * @param results the results + */ + @Deprecated(since = "7.7", forRemoval = true) public void setResults(Set results) { this.results = results; } diff --git a/src/main/java/de/tum/cit/aet/artemis/exercise/repository/StudentParticipationRepository.java b/src/main/java/de/tum/cit/aet/artemis/exercise/repository/StudentParticipationRepository.java index 2c8e4e02eb7c..d9cb4a6e205a 100644 --- a/src/main/java/de/tum/cit/aet/artemis/exercise/repository/StudentParticipationRepository.java +++ b/src/main/java/de/tum/cit/aet/artemis/exercise/repository/StudentParticipationRepository.java @@ -1387,4 +1387,54 @@ SELECT MAX(pr.id) ORDER BY p.student.firstName ASC """) Page findAffectedStudentsByFeedbackId(@Param("exerciseId") long exerciseId, @Param("feedbackIds") List feedbackIds, Pageable pageable); + + /** + * Retrieves the logins of students affected by a specific feedback detail text in a given exercise. + * + * @param exerciseId The ID of the exercise for which affected students are requested. + * @param detailText The feedback detail text to filter by. + * @return A list of student logins affected by the given feedback detail text in the specified exercise. + */ + @Query(""" + SELECT DISTINCT p.student.login + FROM ProgrammingExerciseStudentParticipation p + INNER JOIN p.submissions s + INNER JOIN s.results r ON r.id = ( + SELECT MAX(pr.id) + FROM s.results pr + WHERE pr.participation.id = p.id + ) + INNER JOIN r.feedbacks f + WHERE p.exercise.id = :exerciseId + AND f.detailText = :detailText + AND p.testRun = FALSE + """) + List findAffectedLoginsByFeedbackDetailText(@Param("exerciseId") long exerciseId, @Param("detailText") String detailText); + + /** + * Counts the number of distinct students affected by a specific feedback detail text for a given programming exercise. + *

+ * This query identifies students whose submissions were impacted by feedback entries matching the provided detail text + * within the specified exercise. Only students with non-test run submissions and negative feedback entries are considered. + *

+ * + * @param exerciseId the ID of the programming exercise for which the count is calculated. + * @param detailText the feedback detail text used to filter the affected students. + * @return the total number of distinct students affected by the feedback detail text. + */ + @Query(""" + SELECT COUNT(DISTINCT p.student.id) + FROM ProgrammingExerciseStudentParticipation p + INNER JOIN p.submissions s + INNER JOIN s.results r ON r.id = ( + SELECT MAX(pr.id) + FROM s.results pr + WHERE pr.participation.id = p.id + ) + INNER JOIN r.feedbacks f + WHERE p.exercise.id = :exerciseId + AND f.detailText = :detailText + AND p.testRun = FALSE + """) + long countAffectedStudentsByFeedbackDetailText(@Param("exerciseId") long exerciseId, @Param("detailText") String detailText); } diff --git a/src/main/java/de/tum/cit/aet/artemis/plagiarism/service/PlagiarismAnswerPostService.java b/src/main/java/de/tum/cit/aet/artemis/plagiarism/service/PlagiarismAnswerPostService.java index 0c3ff1beb754..ec2f97befb23 100644 --- a/src/main/java/de/tum/cit/aet/artemis/plagiarism/service/PlagiarismAnswerPostService.java +++ b/src/main/java/de/tum/cit/aet/artemis/plagiarism/service/PlagiarismAnswerPostService.java @@ -15,6 +15,7 @@ import de.tum.cit.aet.artemis.communication.repository.AnswerPostRepository; import de.tum.cit.aet.artemis.communication.repository.ConversationParticipantRepository; import de.tum.cit.aet.artemis.communication.repository.PostRepository; +import de.tum.cit.aet.artemis.communication.repository.SavedPostRepository; import de.tum.cit.aet.artemis.communication.service.PostingService; import de.tum.cit.aet.artemis.communication.service.WebsocketMessagingService; import de.tum.cit.aet.artemis.core.domain.Course; @@ -40,8 +41,9 @@ public class PlagiarismAnswerPostService extends PostingService { protected PlagiarismAnswerPostService(CourseRepository courseRepository, AuthorizationCheckService authorizationCheckService, UserRepository userRepository, AnswerPostRepository answerPostRepository, PostRepository postRepository, ExerciseRepository exerciseRepository, LectureRepository lectureRepository, - WebsocketMessagingService websocketMessagingService, ConversationParticipantRepository conversationParticipantRepository) { - super(courseRepository, userRepository, exerciseRepository, lectureRepository, authorizationCheckService, websocketMessagingService, conversationParticipantRepository); + WebsocketMessagingService websocketMessagingService, ConversationParticipantRepository conversationParticipantRepository, SavedPostRepository savedPostRepository) { + super(courseRepository, userRepository, exerciseRepository, lectureRepository, authorizationCheckService, websocketMessagingService, conversationParticipantRepository, + savedPostRepository); this.answerPostRepository = answerPostRepository; this.postRepository = postRepository; } @@ -164,7 +166,7 @@ public void deleteAnswerPostById(Long courseId, Long answerPostId) { // delete answerPostRepository.deleteById(answerPostId); - + preparePostForBroadcast(post); broadcastForPost(new PostDTO(post, MetisCrudAction.UPDATE), course.getId(), null, null); } diff --git a/src/main/java/de/tum/cit/aet/artemis/plagiarism/service/PlagiarismPostService.java b/src/main/java/de/tum/cit/aet/artemis/plagiarism/service/PlagiarismPostService.java index fc5bda5882c3..a1034b96e335 100644 --- a/src/main/java/de/tum/cit/aet/artemis/plagiarism/service/PlagiarismPostService.java +++ b/src/main/java/de/tum/cit/aet/artemis/plagiarism/service/PlagiarismPostService.java @@ -16,6 +16,7 @@ import de.tum.cit.aet.artemis.communication.dto.PostDTO; import de.tum.cit.aet.artemis.communication.repository.ConversationParticipantRepository; import de.tum.cit.aet.artemis.communication.repository.PostRepository; +import de.tum.cit.aet.artemis.communication.repository.SavedPostRepository; import de.tum.cit.aet.artemis.communication.service.PostingService; import de.tum.cit.aet.artemis.communication.service.WebsocketMessagingService; import de.tum.cit.aet.artemis.core.domain.Course; @@ -42,9 +43,11 @@ public class PlagiarismPostService extends PostingService { private final PlagiarismCaseService plagiarismCaseService; protected PlagiarismPostService(CourseRepository courseRepository, AuthorizationCheckService authorizationCheckService, UserRepository userRepository, - PostRepository postRepository, ExerciseRepository exerciseRepository, LectureRepository lectureRepository, WebsocketMessagingService websocketMessagingService, - PlagiarismCaseService plagiarismCaseService, PlagiarismCaseRepository plagiarismCaseRepository, ConversationParticipantRepository conversationParticipantRepository) { - super(courseRepository, userRepository, exerciseRepository, lectureRepository, authorizationCheckService, websocketMessagingService, conversationParticipantRepository); + SavedPostRepository savedPostRepository, PostRepository postRepository, ExerciseRepository exerciseRepository, LectureRepository lectureRepository, + WebsocketMessagingService websocketMessagingService, PlagiarismCaseService plagiarismCaseService, PlagiarismCaseRepository plagiarismCaseRepository, + ConversationParticipantRepository conversationParticipantRepository) { + super(courseRepository, userRepository, exerciseRepository, lectureRepository, authorizationCheckService, websocketMessagingService, conversationParticipantRepository, + savedPostRepository); this.postRepository = postRepository; this.plagiarismCaseRepository = plagiarismCaseRepository; this.plagiarismCaseService = plagiarismCaseService; @@ -132,6 +135,7 @@ public Post updatePost(Long courseId, Long postId, Post post) { Post updatedPost = postRepository.save(existingPost); + preparePostForBroadcast(updatedPost); broadcastForPost(new PostDTO(updatedPost, MetisCrudAction.UPDATE), course.getId(), null, null); return updatedPost; } @@ -184,6 +188,7 @@ public void deletePostById(Long courseId, Long postId) { // delete postRepository.deleteById(postId); + preparePostForBroadcast(post); broadcastForPost(new PostDTO(post, MetisCrudAction.DELETE), course.getId(), null, null); } diff --git a/src/main/java/de/tum/cit/aet/artemis/programming/service/localci/SharedQueueManagementService.java b/src/main/java/de/tum/cit/aet/artemis/programming/service/localci/SharedQueueManagementService.java index 87b44d4872ba..059df76379da 100644 --- a/src/main/java/de/tum/cit/aet/artemis/programming/service/localci/SharedQueueManagementService.java +++ b/src/main/java/de/tum/cit/aet/artemis/programming/service/localci/SharedQueueManagementService.java @@ -108,36 +108,45 @@ public void pushDockerImageCleanupInfo() { } } + /** + * @return a copy of the queued build jobs as ArrayList + */ public List getQueuedJobs() { - return queue.stream().toList(); + // NOTE: we should not use streams with IQueue directly, because it can be unstable, when many items are added at the same time and there is a slow network condition + return new ArrayList<>(queue); } + /** + * @return a copy of the processing jobs as ArrayList + */ public List getProcessingJobs() { - return processingJobs.values().stream().toList(); + // NOTE: we should not use streams with IMap, because it can be unstable, when many items are added at the same time and there is a slow network condition + return new ArrayList<>(processingJobs.values()); } public List getQueuedJobsForCourse(long courseId) { - return queue.stream().filter(job -> job.courseId() == courseId).toList(); + return getQueuedJobs().stream().filter(job -> job.courseId() == courseId).toList(); } public List getProcessingJobsForCourse(long courseId) { - return processingJobs.values().stream().filter(job -> job.courseId() == courseId).toList(); + return getProcessingJobs().stream().filter(job -> job.courseId() == courseId).toList(); } public List getQueuedJobsForParticipation(long participationId) { - return queue.stream().filter(job -> job.participationId() == participationId).toList(); + return getQueuedJobs().stream().filter(job -> job.participationId() == participationId).toList(); } public List getProcessingJobsForParticipation(long participationId) { - return processingJobs.values().stream().filter(job -> job.participationId() == participationId).toList(); + return getProcessingJobs().stream().filter(job -> job.participationId() == participationId).toList(); } public List getBuildAgentInformation() { - return buildAgentInformation.values().stream().toList(); + // NOTE: we should not use streams with IMap, because it can be unstable, when many items are added at the same time and there is a slow network condition + return new ArrayList<>(buildAgentInformation.values()); } public List getBuildAgentInformationWithoutRecentBuildJobs() { - return buildAgentInformation.values().stream().map(agent -> new BuildAgentInformation(agent.buildAgent(), agent.maxNumberOfConcurrentBuildJobs(), + return getBuildAgentInformation().stream().map(agent -> new BuildAgentInformation(agent.buildAgent(), agent.maxNumberOfConcurrentBuildJobs(), agent.numberOfCurrentBuildJobs(), agent.runningBuildJobs(), agent.status(), null, null)).toList(); } @@ -156,9 +165,10 @@ public void resumeBuildAgent(String agent) { */ public void cancelBuildJob(String buildJobId) { // Remove build job if it is queued - if (queue.stream().anyMatch(job -> Objects.equals(job.id(), buildJobId))) { + List queuedJobs = getQueuedJobs(); + if (queuedJobs.stream().anyMatch(job -> Objects.equals(job.id(), buildJobId))) { List toRemove = new ArrayList<>(); - for (BuildJobQueueItem job : queue) { + for (BuildJobQueueItem job : queuedJobs) { if (Objects.equals(job.id(), buildJobId)) { toRemove.add(job); } @@ -197,7 +207,8 @@ public void cancelAllQueuedBuildJobs() { * Cancel all running build jobs. */ public void cancelAllRunningBuildJobs() { - for (BuildJobQueueItem buildJob : processingJobs.values()) { + List runningJobs = getProcessingJobs(); + for (BuildJobQueueItem buildJob : runningJobs) { cancelBuildJob(buildJob.id()); } } @@ -208,7 +219,7 @@ public void cancelAllRunningBuildJobs() { * @param agentName name of the agent */ public void cancelAllRunningBuildJobsForAgent(String agentName) { - processingJobs.values().stream().filter(job -> Objects.equals(job.buildAgent().name(), agentName)).forEach(job -> cancelBuildJob(job.id())); + getProcessingJobs().stream().filter(job -> Objects.equals(job.buildAgent().name(), agentName)).forEach(job -> cancelBuildJob(job.id())); } /** @@ -217,8 +228,9 @@ public void cancelAllRunningBuildJobsForAgent(String agentName) { * @param courseId id of the course */ public void cancelAllQueuedBuildJobsForCourse(long courseId) { + List queuedJobs = getQueuedJobs(); List toRemove = new ArrayList<>(); - for (BuildJobQueueItem job : queue) { + for (BuildJobQueueItem job : queuedJobs) { if (job.courseId() == courseId) { toRemove.add(job); } @@ -232,7 +244,8 @@ public void cancelAllQueuedBuildJobsForCourse(long courseId) { * @param courseId id of the course */ public void cancelAllRunningBuildJobsForCourse(long courseId) { - for (BuildJobQueueItem buildJob : processingJobs.values()) { + List runningJobs = getProcessingJobs(); + for (BuildJobQueueItem buildJob : runningJobs) { if (buildJob.courseId() == courseId) { cancelBuildJob(buildJob.id()); } @@ -246,14 +259,16 @@ public void cancelAllRunningBuildJobsForCourse(long courseId) { */ public void cancelAllJobsForParticipation(long participationId) { List toRemove = new ArrayList<>(); - for (BuildJobQueueItem queuedJob : queue) { + List queuedJobs = getQueuedJobs(); + for (BuildJobQueueItem queuedJob : queuedJobs) { if (queuedJob.participationId() == participationId) { toRemove.add(queuedJob); } } queue.removeAll(toRemove); - for (BuildJobQueueItem runningJob : processingJobs.values()) { + List runningJobs = getProcessingJobs(); + for (BuildJobQueueItem runningJob : runningJobs) { if (runningJob.participationId() == participationId) { cancelBuildJob(runningJob.id()); } diff --git a/src/main/resources/config/liquibase/changelog/20241101121000_changelog.xml b/src/main/resources/config/liquibase/changelog/20241101121000_changelog.xml new file mode 100644 index 000000000000..b8e12b77c118 --- /dev/null +++ b/src/main/resources/config/liquibase/changelog/20241101121000_changelog.xml @@ -0,0 +1,39 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/src/main/resources/config/liquibase/master.xml b/src/main/resources/config/liquibase/master.xml index 6a06b398b783..e29f09657055 100644 --- a/src/main/resources/config/liquibase/master.xml +++ b/src/main/resources/config/liquibase/master.xml @@ -33,6 +33,7 @@ + diff --git a/src/main/webapp/app/core/user/account.model.ts b/src/main/webapp/app/core/user/account.model.ts index ad1d36a2a18b..37f98ded0405 100644 --- a/src/main/webapp/app/core/user/account.model.ts +++ b/src/main/webapp/app/core/user/account.model.ts @@ -11,7 +11,7 @@ export class Account { public lastName?: string; public langKey?: string; public imageUrl?: string; - public guidedTourSettings: GuidedTourSetting[]; + public guidedTourSettings?: GuidedTourSetting[]; constructor( activated?: boolean, diff --git a/src/main/webapp/app/entities/metis/conversation/conversation.model.ts b/src/main/webapp/app/entities/metis/conversation/conversation.model.ts index ddb146f12d1f..841a8a5f53de 100644 --- a/src/main/webapp/app/entities/metis/conversation/conversation.model.ts +++ b/src/main/webapp/app/entities/metis/conversation/conversation.model.ts @@ -23,6 +23,7 @@ export abstract class Conversation implements BaseEntity { public creator?: User; public creationDate?: dayjs.Dayjs; public lastMessageDate?: dayjs.Dayjs; + public title?: string; protected constructor(type: ConversationType) { this.type = type; diff --git a/src/main/webapp/app/entities/metis/post.model.ts b/src/main/webapp/app/entities/metis/post.model.ts index 60adfe3c64c0..39950a74af0b 100644 --- a/src/main/webapp/app/entities/metis/post.model.ts +++ b/src/main/webapp/app/entities/metis/post.model.ts @@ -2,7 +2,6 @@ import { AnswerPost } from 'app/entities/metis/answer-post.model'; import { Posting } from 'app/entities/metis/posting.model'; import { DisplayPriority } from 'app/shared/metis/metis.util'; import { PlagiarismCase } from 'app/exercises/shared/plagiarism/types/PlagiarismCase'; -import { Conversation } from 'app/entities/metis/conversation/conversation.model'; export class Post extends Posting { public title?: string; @@ -10,7 +9,6 @@ export class Post extends Posting { public answers?: AnswerPost[]; public tags?: string[]; public plagiarismCase?: PlagiarismCase; - public conversation?: Conversation; public displayPriority?: DisplayPriority; public resolved?: boolean; public isConsecutive?: boolean = false; diff --git a/src/main/webapp/app/entities/metis/posting.model.ts b/src/main/webapp/app/entities/metis/posting.model.ts index fc7d5d206095..dff35c800654 100644 --- a/src/main/webapp/app/entities/metis/posting.model.ts +++ b/src/main/webapp/app/entities/metis/posting.model.ts @@ -3,13 +3,58 @@ import { User } from 'app/core/user/user.model'; import dayjs from 'dayjs/esm'; import { Reaction } from 'app/entities/metis/reaction.model'; import { UserRole } from 'app/shared/metis/metis.util'; +import { Conversation } from 'app/entities/metis/conversation/conversation.model'; + +export enum SavedPostStatus { + PROGRESS = 0, + COMPLETED = 1, + ARCHIVED = 2, +} + +export enum SavedPostStatusMap { + PROGRESS = 'progress', + COMPLETED = 'completed', + ARCHIVED = 'archived', +} + +export enum PostingType { + POST = 0, + ANSWER = 1, +} export abstract class Posting implements BaseEntity { public id?: number; + public referencePostId?: number; public author?: User; public authorRole?: UserRole; public creationDate?: dayjs.Dayjs; public updatedDate?: dayjs.Dayjs; public content?: string; + public isSaved?: boolean; + public savedPostStatus?: number; + public postingType?: number; public reactions?: Reaction[]; + public conversation?: Conversation; + + public static mapToStatus(map: SavedPostStatusMap) { + switch (map) { + case SavedPostStatusMap.COMPLETED: + return SavedPostStatus.COMPLETED; + case SavedPostStatusMap.ARCHIVED: + return SavedPostStatus.ARCHIVED; + default: + return SavedPostStatus.PROGRESS; + } + } + + public static statusToMap(status: SavedPostStatus) { + switch (status) { + case SavedPostStatus.COMPLETED: + return SavedPostStatusMap.COMPLETED; + case SavedPostStatus.ARCHIVED: + return SavedPostStatusMap.ARCHIVED; + default: + return SavedPostStatusMap.PROGRESS; + } + } } diff --git a/src/main/webapp/app/entities/participation/participation.model.ts b/src/main/webapp/app/entities/participation/participation.model.ts index 0dfd62e9865c..540aab6900cb 100644 --- a/src/main/webapp/app/entities/participation/participation.model.ts +++ b/src/main/webapp/app/entities/participation/participation.model.ts @@ -39,6 +39,9 @@ export abstract class Participation implements BaseEntity { public initializationDate?: dayjs.Dayjs; public individualDueDate?: dayjs.Dayjs; public presentationScore?: number; + /** + * @deprecated This property will be removed in Artemis 8.0. Use `submissions.results` instead. + */ public results?: Result[]; public submissions?: Submission[]; public exercise?: Exercise; diff --git a/src/main/webapp/app/entities/result.model.ts b/src/main/webapp/app/entities/result.model.ts index 47fff80fda31..cea278d8cb53 100644 --- a/src/main/webapp/app/entities/result.model.ts +++ b/src/main/webapp/app/entities/result.model.ts @@ -30,6 +30,9 @@ export class Result implements BaseEntity { public submission?: Submission; public assessor?: User; public feedbacks?: Feedback[]; + /** + * @deprecated This property will be removed in Artemis 8.0. Use `submission.participation` instead. + */ public participation?: Participation; // helper attributes diff --git a/src/main/webapp/app/exam/manage/exam-management.route.ts b/src/main/webapp/app/exam/manage/exam-management.route.ts index c6933eb74d2f..e9fda87890c7 100644 --- a/src/main/webapp/app/exam/manage/exam-management.route.ts +++ b/src/main/webapp/app/exam/manage/exam-management.route.ts @@ -65,6 +65,7 @@ import { RepositoryViewComponent } from 'app/localvc/repository-view/repository- import { LocalVCGuard } from 'app/localvc/localvc-guard.service'; import { CommitHistoryComponent } from 'app/localvc/commit-history/commit-history.component'; import { CommitDetailsViewComponent } from 'app/localvc/commit-details-view/commit-details-view.component'; +import { VcsRepositoryAccessLogViewComponent } from 'app/localvc/vcs-repository-access-log-view/vcs-repository-access-log-view.component'; export const examManagementRoute: Routes = [ { @@ -652,6 +653,30 @@ export const examManagementRoute: Routes = [ }, canActivate: [UserRouteAccessService, LocalVCGuard], }, + { + path: ':examId/exercise-groups/:exerciseGroupId/programming-exercises/:exerciseId/repository/:repositoryType/vcs-access-log', + component: VcsRepositoryAccessLogViewComponent, + data: { + authorities: [Authority.ADMIN, Authority.INSTRUCTOR], + pageTitle: 'artemisApp.repository.title', + flushRepositoryCacheAfter: 900000, // 15 min + participationCache: {}, + repositoryCache: {}, + }, + canActivate: [UserRouteAccessService, LocalVCGuard], + }, + { + path: ':examId/exercise-groups/:exerciseGroupId/programming-exercises/:exerciseId/repository/:repositoryType/repo/:repositoryId', + component: RepositoryViewComponent, + data: { + authorities: [Authority.ADMIN, Authority.INSTRUCTOR, Authority.EDITOR, Authority.TA], + pageTitle: 'artemisApp.repository.title', + flushRepositoryCacheAfter: 900000, // 15 min + participationCache: {}, + repositoryCache: {}, + }, + canActivate: [UserRouteAccessService, LocalVCGuard], + }, { path: ':examId/exercise-groups/:exerciseGroupId/programming-exercises/:exerciseId/repository/:repositoryType/commit-history', component: CommitHistoryComponent, @@ -688,6 +713,18 @@ export const examManagementRoute: Routes = [ }, canActivate: [UserRouteAccessService, LocalVCGuard], }, + { + path: ':examId/exercise-groups/:exerciseGroupId/programming-exercises/:exerciseId/participations/:participationId/repository/vcs-access-log', + component: VcsRepositoryAccessLogViewComponent, + data: { + authorities: [Authority.ADMIN, Authority.INSTRUCTOR], + pageTitle: 'artemisApp.repository.title', + flushRepositoryCacheAfter: 900000, // 15 min + participationCache: {}, + repositoryCache: {}, + }, + canActivate: [UserRouteAccessService, LocalVCGuard], + }, { path: ':examId/exercise-groups/:exerciseGroupId/programming-exercises/:exerciseId/participations/:participationId/repository/commit-history', component: CommitHistoryComponent, diff --git a/src/main/webapp/app/exam/manage/exercise-groups/exercise-groups.component.html b/src/main/webapp/app/exam/manage/exercise-groups/exercise-groups.component.html index 8b72a9f8f417..43cd6963ce39 100644 --- a/src/main/webapp/app/exam/manage/exercise-groups/exercise-groups.component.html +++ b/src/main/webapp/app/exam/manage/exercise-groups/exercise-groups.component.html @@ -242,7 +242,7 @@
{{ exerciseGroup.title }}
@for (exercise of exerciseGroup.exercises; track exercise) { - + @if (course.isAtLeastEditor) { +

+ + +
+

+
+
+ + +
diff --git a/src/main/webapp/app/exercises/programming/manage/grading/feedback-analysis/Modal/confirm-feedback-channel-creation-modal.component.ts b/src/main/webapp/app/exercises/programming/manage/grading/feedback-analysis/Modal/confirm-feedback-channel-creation-modal.component.ts new file mode 100644 index 000000000000..4a31192b6299 --- /dev/null +++ b/src/main/webapp/app/exercises/programming/manage/grading/feedback-analysis/Modal/confirm-feedback-channel-creation-modal.component.ts @@ -0,0 +1,23 @@ +import { Component, inject, input } from '@angular/core'; +import { NgbActiveModal } from '@ng-bootstrap/ng-bootstrap'; +import { ArtemisSharedCommonModule } from 'app/shared/shared-common.module'; + +@Component({ + selector: 'jhi-confirm-feedback-channel-creation-modal', + templateUrl: './confirm-feedback-channel-creation-modal.component.html', + imports: [ArtemisSharedCommonModule], + standalone: true, +}) +export class ConfirmFeedbackChannelCreationModalComponent { + protected readonly TRANSLATION_BASE = 'artemisApp.programmingExercise.configureGrading.feedbackAnalysis.feedbackDetailChannel.confirmationModal'; + affectedStudentsCount = input.required(); + private activeModal = inject(NgbActiveModal); + + confirm(): void { + this.activeModal.close(true); + } + + dismiss(): void { + this.activeModal.dismiss(); + } +} diff --git a/src/main/webapp/app/exercises/programming/manage/grading/feedback-analysis/Modal/feedback-detail-channel-modal.component.html b/src/main/webapp/app/exercises/programming/manage/grading/feedback-analysis/Modal/feedback-detail-channel-modal.component.html new file mode 100644 index 000000000000..36d5b08ed5b9 --- /dev/null +++ b/src/main/webapp/app/exercises/programming/manage/grading/feedback-analysis/Modal/feedback-detail-channel-modal.component.html @@ -0,0 +1,87 @@ +
+

+ +

+ +
+
+
+

+
+
+
+ + + @if (form.controls['name'].invalid && (form.controls['name'].dirty || form.controls['name'].touched)) { +
+ @if (form.get('name')?.errors?.['required']) { +
+ } + @if (form.get('name')?.errors?.['maxlength']) { +
+ } + @if (form.get('name')?.errors?.['pattern']) { +
+ } +
+ } +
+
+ + + @if (form.controls['description'].invalid && (form.controls['description'].dirty || form.controls['description'].touched)) { +
+ @if (form.get('description')?.errors?.['required']) { +
+ } + @if (form.get('description')?.errors?.['maxlength']) { +
+ } +
+ } +
+
+ +
+ + + + +
+
+
+ +
+ + + + +
+
+
+

+ +

+
+
+

+ + +

+

+ + +

+
+
+ + +
+
+
diff --git a/src/main/webapp/app/exercises/programming/manage/grading/feedback-analysis/Modal/feedback-detail-channel-modal.component.ts b/src/main/webapp/app/exercises/programming/manage/grading/feedback-analysis/Modal/feedback-detail-channel-modal.component.ts new file mode 100644 index 000000000000..e9b7963f0e78 --- /dev/null +++ b/src/main/webapp/app/exercises/programming/manage/grading/feedback-analysis/Modal/feedback-detail-channel-modal.component.ts @@ -0,0 +1,71 @@ +import { Component, inject, input, output, signal } from '@angular/core'; +import { FormBuilder, FormGroup, Validators } from '@angular/forms'; +import { NgbActiveModal, NgbModal } from '@ng-bootstrap/ng-bootstrap'; +import { ChannelDTO } from 'app/entities/metis/conversation/channel.model'; +import { FeedbackDetail } from 'app/exercises/programming/manage/grading/feedback-analysis/feedback-analysis.service'; +import { ConfirmFeedbackChannelCreationModalComponent } from 'app/exercises/programming/manage/grading/feedback-analysis/Modal/confirm-feedback-channel-creation-modal.component'; +import { ArtemisSharedCommonModule } from 'app/shared/shared-common.module'; +import { AlertService } from 'app/core/util/alert.service'; + +@Component({ + selector: 'jhi-feedback-detail-channel-modal', + templateUrl: './feedback-detail-channel-modal.component.html', + imports: [ArtemisSharedCommonModule], + standalone: true, +}) +export class FeedbackDetailChannelModalComponent { + protected readonly TRANSLATION_BASE = 'artemisApp.programmingExercise.configureGrading.feedbackAnalysis.feedbackDetailChannel'; + affectedStudentsCount = input.required(); + feedbackDetail = input.required(); + formSubmitted = output<{ channelDto: ChannelDTO; navigate: boolean }>(); + + isConfirmModalOpen = signal(false); + + private alertService = inject(AlertService); + private readonly formBuilder = inject(FormBuilder); + private readonly activeModal = inject(NgbActiveModal); + private readonly modalService = inject(NgbModal); + form: FormGroup = this.formBuilder.group({ + name: ['', [Validators.required, Validators.maxLength(30), Validators.pattern('^[a-z0-9-]{1}[a-z0-9-]{0,30}$')]], + description: ['', [Validators.required, Validators.maxLength(250)]], + isPublic: [true, Validators.required], + isAnnouncementChannel: [false, Validators.required], + }); + + async submitForm(navigate: boolean): Promise { + if (this.form.valid && !this.isConfirmModalOpen()) { + this.isConfirmModalOpen.set(true); + const result = await this.handleModal(); + if (result) { + const channelDTO = new ChannelDTO(); + channelDTO.name = this.form.get('name')?.value; + channelDTO.description = this.form.get('description')?.value; + channelDTO.isPublic = this.form.get('isPublic')?.value; + channelDTO.isAnnouncementChannel = this.form.get('isAnnouncementChannel')?.value; + + this.formSubmitted.emit({ channelDto: channelDTO, navigate }); + this.closeModal(); + } + this.isConfirmModalOpen.set(false); + } + } + + async handleModal(): Promise { + try { + const modalRef = this.modalService.open(ConfirmFeedbackChannelCreationModalComponent, { centered: true }); + modalRef.componentInstance.affectedStudentsCount = this.affectedStudentsCount; + return await modalRef.result; + } catch (error) { + this.alertService.error(error); + return false; + } + } + + closeModal(): void { + this.activeModal.close(); + } + + dismissModal(): void { + this.activeModal.dismiss(); + } +} diff --git a/src/main/webapp/app/exercises/programming/manage/grading/feedback-analysis/feedback-analysis.component.html b/src/main/webapp/app/exercises/programming/manage/grading/feedback-analysis/feedback-analysis.component.html index 20206a2c4ae3..2c1d01040253 100644 --- a/src/main/webapp/app/exercises/programming/manage/grading/feedback-analysis/feedback-analysis.component.html +++ b/src/main/webapp/app/exercises/programming/manage/grading/feedback-analysis/feedback-analysis.component.html @@ -60,8 +60,11 @@

{{ item.testCaseName }} {{ item.errorCategory }} - + + @if (isCommunicationEnabled()) { + + } } diff --git a/src/main/webapp/app/exercises/programming/manage/grading/feedback-analysis/feedback-analysis.component.ts b/src/main/webapp/app/exercises/programming/manage/grading/feedback-analysis/feedback-analysis.component.ts index 9026d7cbb1ec..14da1cbe4cce 100644 --- a/src/main/webapp/app/exercises/programming/manage/grading/feedback-analysis/feedback-analysis.component.ts +++ b/src/main/webapp/app/exercises/programming/manage/grading/feedback-analysis/feedback-analysis.component.ts @@ -1,8 +1,9 @@ import { Component, computed, effect, inject, input, signal, untracked } from '@angular/core'; -import { FeedbackAnalysisService, FeedbackDetail } from './feedback-analysis.service'; +import { FeedbackAnalysisService, FeedbackChannelRequestDTO, FeedbackDetail } from './feedback-analysis.service'; import { NgbModal } from '@ng-bootstrap/ng-bootstrap'; import { AlertService } from 'app/core/util/alert.service'; -import { faFilter, faSort, faSortDown, faSortUp, faUpRightAndDownLeftFromCenter, faUsers } from '@fortawesome/free-solid-svg-icons'; +import { faFilter, faMessage, faSort, faSortDown, faSortUp, faUsers } from '@fortawesome/free-solid-svg-icons'; +import { facDetails } from '../../../../../../content/icons/icons'; import { SearchResult, SortingOrder } from 'app/shared/table/pageable-table'; import { ArtemisSharedCommonModule } from 'app/shared/shared-common.module'; import { FeedbackModalComponent } from 'app/exercises/programming/manage/grading/feedback-analysis/Modal/feedback-modal.component'; @@ -11,6 +12,9 @@ import { LocalStorageService } from 'ngx-webstorage'; import { BaseApiHttpService } from 'app/course/learning-paths/services/base-api-http.service'; import { SortIconComponent } from 'app/shared/sort/sort-icon.component'; import { AffectedStudentsModalComponent } from 'app/exercises/programming/manage/grading/feedback-analysis/Modal/feedback-affected-students-modal.component'; +import { FeedbackDetailChannelModalComponent } from 'app/exercises/programming/manage/grading/feedback-analysis/Modal/feedback-detail-channel-modal.component'; +import { ChannelDTO } from 'app/entities/metis/conversation/channel.model'; +import { Router } from '@angular/router'; @Component({ selector: 'jhi-feedback-analysis', @@ -23,11 +27,14 @@ import { AffectedStudentsModalComponent } from 'app/exercises/programming/manage export class FeedbackAnalysisComponent { exerciseTitle = input.required(); exerciseId = input.required(); + courseId = input.required(); + isCommunicationEnabled = input.required(); private feedbackAnalysisService = inject(FeedbackAnalysisService); private alertService = inject(AlertService); private modalService = inject(NgbModal); private localStorage = inject(LocalStorageService); + private router = inject(Router); readonly page = signal(1); readonly pageSize = signal(25); @@ -44,8 +51,9 @@ export class FeedbackAnalysisComponent { readonly faSortUp = faSortUp; readonly faSortDown = faSortDown; readonly faFilter = faFilter; - readonly faUpRightAndDownLeftFromCenter = faUpRightAndDownLeftFromCenter; + readonly facDetails = facDetails; readonly faUsers = faUsers; + readonly faMessage = faMessage; readonly SortingOrder = SortingOrder; readonly MAX_FEEDBACK_DETAIL_TEXT_LENGTH = 200; @@ -60,6 +68,8 @@ export class FeedbackAnalysisComponent { readonly maxCount = signal(0); readonly errorCategories = signal([]); + private isFeedbackDetailChannelModalOpen = false; + private readonly debounceLoadData = BaseApiHttpService.debounce(this.loadData.bind(this), 300); constructor() { @@ -117,7 +127,7 @@ export class FeedbackAnalysisComponent { } openFeedbackModal(feedbackDetail: FeedbackDetail): void { - const modalRef = this.modalService.open(FeedbackModalComponent, { centered: true }); + const modalRef = this.modalService.open(FeedbackModalComponent, { centered: true, size: 'lg' }); modalRef.componentInstance.feedbackDetail = signal(feedbackDetail); } @@ -191,4 +201,40 @@ export class FeedbackAnalysisComponent { modalRef.componentInstance.exerciseId = this.exerciseId; modalRef.componentInstance.feedbackDetail = signal(feedbackDetail); } + + async openFeedbackDetailChannelModal(feedbackDetail: FeedbackDetail): Promise { + if (this.isFeedbackDetailChannelModalOpen) { + return; + } + this.isFeedbackDetailChannelModalOpen = true; + const modalRef = this.modalService.open(FeedbackDetailChannelModalComponent, { centered: true, size: 'lg' }); + modalRef.componentInstance.affectedStudentsCount = await this.feedbackAnalysisService.getAffectedStudentCount(this.exerciseId(), feedbackDetail.detailText); + modalRef.componentInstance.feedbackDetail = signal(feedbackDetail); + modalRef.componentInstance.formSubmitted.subscribe(async ({ channelDto, navigate }: { channelDto: ChannelDTO; navigate: boolean }) => { + try { + const feedbackChannelRequest: FeedbackChannelRequestDTO = { + channel: channelDto, + feedbackDetailText: feedbackDetail.detailText, + }; + const createdChannel = await this.feedbackAnalysisService.createChannel(this.courseId(), this.exerciseId(), feedbackChannelRequest); + const channelName = createdChannel.name; + this.alertService.success(this.TRANSLATION_BASE + '.channelSuccess', { channelName }); + if (navigate) { + const urlTree = this.router.createUrlTree(['courses', this.courseId(), 'communication'], { + queryParams: { conversationId: createdChannel.id }, + }); + await this.router.navigateByUrl(urlTree); + } + } catch (error) { + this.alertService.error(error); + } + }); + try { + await modalRef.result; + } catch { + // modal dismissed + } finally { + this.isFeedbackDetailChannelModalOpen = false; + } + } } diff --git a/src/main/webapp/app/exercises/programming/manage/grading/feedback-analysis/feedback-analysis.service.ts b/src/main/webapp/app/exercises/programming/manage/grading/feedback-analysis/feedback-analysis.service.ts index 214c9a4e4f4c..d034cc56a506 100644 --- a/src/main/webapp/app/exercises/programming/manage/grading/feedback-analysis/feedback-analysis.service.ts +++ b/src/main/webapp/app/exercises/programming/manage/grading/feedback-analysis/feedback-analysis.service.ts @@ -3,6 +3,7 @@ import { PageableResult, PageableSearch, SearchResult, SearchTermPageableSearch import { BaseApiHttpService } from 'app/course/learning-paths/services/base-api-http.service'; import { HttpHeaders, HttpParams } from '@angular/common/http'; import { FilterData } from 'app/exercises/programming/manage/grading/feedback-analysis/Modal/feedback-filter-modal.component'; +import { ChannelDTO } from 'app/entities/metis/conversation/channel.model'; export interface FeedbackAnalysisResponse { feedbackDetails: SearchResult; @@ -28,6 +29,10 @@ export interface FeedbackAffectedStudentDTO { login: string; repositoryURI: string; } +export interface FeedbackChannelRequestDTO { + channel: ChannelDTO; + feedbackDetailText: string; +} @Injectable() export class FeedbackAnalysisService extends BaseApiHttpService { search(pageable: SearchTermPageableSearch, options: { exerciseId: number; filters: FilterData }): Promise { @@ -62,4 +67,13 @@ export class FeedbackAnalysisService extends BaseApiHttpService { return this.get>(`exercises/${exerciseId}/feedback-details-participation`, { params, headers }); } + + createChannel(courseId: number, exerciseId: number, feedbackChannelRequest: FeedbackChannelRequestDTO): Promise { + return this.post(`courses/${courseId}/${exerciseId}/feedback-channel`, feedbackChannelRequest); + } + + getAffectedStudentCount(exerciseId: number, feedbackDetailText: string): Promise { + const params = new HttpParams().set('detailText', feedbackDetailText); + return this.get(`exercises/${exerciseId}/feedback-detail/affected-students`, { params }); + } } diff --git a/src/main/webapp/app/exercises/programming/manage/grading/programming-exercise-configure-grading.component.html b/src/main/webapp/app/exercises/programming/manage/grading/programming-exercise-configure-grading.component.html index 147c35adea2f..39014c0f5657 100644 --- a/src/main/webapp/app/exercises/programming/manage/grading/programming-exercise-configure-grading.component.html +++ b/src/main/webapp/app/exercises/programming/manage/grading/programming-exercise-configure-grading.component.html @@ -270,8 +270,13 @@

}
- @if (programmingExercise.isAtLeastEditor && activeTab === 'feedback-analysis') { - + @if (programmingExercise.isAtLeastEditor && activeTab === 'feedback-analysis' && programmingExercise.title && programmingExercise.id && course.id) { + }
} diff --git a/src/main/webapp/app/exercises/programming/manage/grading/programming-exercise-configure-grading.component.ts b/src/main/webapp/app/exercises/programming/manage/grading/programming-exercise-configure-grading.component.ts index c5ef675338f5..13ce8237d382 100644 --- a/src/main/webapp/app/exercises/programming/manage/grading/programming-exercise-configure-grading.component.ts +++ b/src/main/webapp/app/exercises/programming/manage/grading/programming-exercise-configure-grading.component.ts @@ -6,7 +6,7 @@ import { TranslateService } from '@ngx-translate/core'; import { AccountService } from 'app/core/auth/account.service'; import { AlertService } from 'app/core/util/alert.service'; import { CourseManagementService } from 'app/course/manage/course-management.service'; -import { Course } from 'app/entities/course.model'; +import { Course, isCommunicationEnabled } from 'app/entities/course.model'; import { IssuesMap, ProgrammingExerciseGradingStatistics } from 'app/entities/programming/programming-exercise-test-case-statistics.model'; import { ProgrammingExerciseTestCase, Visibility } from 'app/entities/programming/programming-exercise-test-case.model'; import { ProgrammingExercise, ProgrammingLanguage } from 'app/entities/programming/programming-exercise.model'; @@ -92,6 +92,7 @@ export class ProgrammingExerciseConfigureGradingComponent implements OnInit, OnD readonly RESET_TABLE = ProgrammingGradingChartsDirective.RESET_TABLE; readonly chartFilterType = ChartFilterType; readonly ProgrammingLanguage = ProgrammingLanguage; + protected readonly isCommunicationEnabled = isCommunicationEnabled; // We have to separate these test cases in order to separate the table and chart presentation if the table is filtered by the chart staticCodeAnalysisCategoriesForTable: StaticCodeAnalysisCategory[] = []; diff --git a/src/main/webapp/app/overview/course-conversations/course-conversations.component.html b/src/main/webapp/app/overview/course-conversations/course-conversations.component.html index 1e7b44fa6fb7..6b2bac7d8ada 100644 --- a/src/main/webapp/app/overview/course-conversations/course-conversations.component.html +++ b/src/main/webapp/app/overview/course-conversations/course-conversations.component.html @@ -38,7 +38,7 @@ [sidebarItemAlwaysShow]="DEFAULT_SHOW_ALWAYS" [collapseState]="DEFAULT_COLLAPSE_STATE" [inCommunication]="true" - [reEmitNonDistinctSidebarEvents]="isMobile" + [reEmitNonDistinctSidebarEvents]="true" /> @if (course && !activeConversation && isCodeOfConductPresented) { @@ -57,9 +57,15 @@ (openThread)="postInThread = $event" [course]="course" [searchbarCollapsed]="channelSearchCollapsed" + [focusPostId]="focusPostId" + [openThreadOnFocus]="openThreadOnFocus" /> } @else { - + @if (selectedSavedPostStatus === null) { + + } @else { + + } }
diff --git a/src/main/webapp/app/overview/course-conversations/course-conversations.component.ts b/src/main/webapp/app/overview/course-conversations/course-conversations.component.ts index 1b194b218bd3..f65878c794e1 100644 --- a/src/main/webapp/app/overview/course-conversations/course-conversations.component.ts +++ b/src/main/webapp/app/overview/course-conversations/course-conversations.component.ts @@ -1,4 +1,4 @@ -import { Component, ElementRef, EventEmitter, HostListener, OnDestroy, OnInit, ViewChild, ViewEncapsulation, inject } from '@angular/core'; +import { ChangeDetectorRef, Component, ElementRef, EventEmitter, HostListener, OnDestroy, OnInit, ViewChild, ViewEncapsulation, inject } from '@angular/core'; import { ConversationDTO } from 'app/entities/metis/conversation/conversation.model'; import { Post } from 'app/entities/metis/post.model'; import { ActivatedRoute, Router } from '@angular/router'; @@ -10,7 +10,21 @@ import { ChannelDTO, ChannelSubType, getAsChannelDTO } from 'app/entities/metis/ import { MetisService } from 'app/shared/metis/metis.service'; import { Course, isMessagingEnabled } from 'app/entities/course.model'; import { PageType, SortDirection } from 'app/shared/metis/metis.util'; -import { faBan, faComment, faComments, faFile, faFilter, faGraduationCap, faHeart, faList, faMessage, faPlus, faSearch, faTimes } from '@fortawesome/free-solid-svg-icons'; +import { + faBan, + faBookmark, + faComment, + faComments, + faFile, + faFilter, + faGraduationCap, + faHeart, + faList, + faMessage, + faPlus, + faSearch, + faTimes, +} from '@fortawesome/free-solid-svg-icons'; import { ButtonType } from 'app/shared/components/button.component'; import { CourseWideSearchComponent, CourseWideSearchConfig } from 'app/overview/course-conversations/course-wide-search/course-wide-search.component'; import { AccordionGroups, ChannelAccordionShowAdd, ChannelTypeIcons, CollapseState, SidebarCardElement, SidebarData, SidebarItemShowAlways } from 'app/types/sidebar'; @@ -25,6 +39,7 @@ import { ChannelsCreateDialogComponent } from 'app/overview/course-conversations import { CourseSidebarService } from 'app/overview/course-sidebar.service'; import { LayoutService } from 'app/shared/breakpoints/layout.service'; import { CustomBreakpointNames } from 'app/shared/breakpoints/breakpoints.service'; +import { Posting, PostingType, SavedPostStatus, SavedPostStatusMap } from 'app/entities/metis/posting.model'; const DEFAULT_CHANNEL_GROUPS: AccordionGroups = { favoriteChannels: { entityData: [] }, @@ -33,6 +48,7 @@ const DEFAULT_CHANNEL_GROUPS: AccordionGroups = { lectureChannels: { entityData: [] }, examChannels: { entityData: [] }, hiddenChannels: { entityData: [] }, + savedPosts: { entityData: [] }, }; const CHANNEL_TYPE_SHOW_ADD_OPTION: ChannelAccordionShowAdd = { @@ -44,6 +60,7 @@ const CHANNEL_TYPE_SHOW_ADD_OPTION: ChannelAccordionShowAdd = { favoriteChannels: false, lectureChannels: true, hiddenChannels: false, + savedPosts: false, }; const CHANNEL_TYPE_ICON: ChannelTypeIcons = { @@ -55,6 +72,7 @@ const CHANNEL_TYPE_ICON: ChannelTypeIcons = { favoriteChannels: faHeart, lectureChannels: faFile, hiddenChannels: faBan, + savedPosts: faBookmark, }; const DEFAULT_COLLAPSE_STATE: CollapseState = { @@ -66,6 +84,7 @@ const DEFAULT_COLLAPSE_STATE: CollapseState = { favoriteChannels: false, lectureChannels: true, hiddenChannels: true, + savedPosts: true, }; const DEFAULT_SHOW_ALWAYS: SidebarItemShowAlways = { @@ -77,6 +96,7 @@ const DEFAULT_SHOW_ALWAYS: SidebarItemShowAlways = { favoriteChannels: true, lectureChannels: false, hiddenChannels: false, + savedPosts: true, }; @Component({ @@ -110,6 +130,9 @@ export class CourseConversationsComponent implements OnInit, OnDestroy { isProduction = true; isTestServer = false; isMobile = false; + focusPostId: number | undefined = undefined; + openThreadOnFocus = false; + selectedSavedPostStatus: null | SavedPostStatus = null; readonly CHANNEL_TYPE_SHOW_ADD_OPTION = CHANNEL_TYPE_SHOW_ADD_OPTION; readonly CHANNEL_TYPE_ICON = CHANNEL_TYPE_ICON; @@ -140,6 +163,7 @@ export class CourseConversationsComponent implements OnInit, OnDestroy { private courseSidebarService: CourseSidebarService = inject(CourseSidebarService); private layoutService: LayoutService = inject(LayoutService); + private changeDetector: ChangeDetectorRef = inject(ChangeDetectorRef); constructor( private router: Router, @@ -251,9 +275,23 @@ export class CourseConversationsComponent implements OnInit, OnDestroy { subscribeToQueryParameter() { this.activatedRoute.queryParams.pipe(take(1), takeUntil(this.ngUnsubscribe)).subscribe((queryParams) => { if (queryParams.conversationId) { - this.metisConversationService.setActiveConversation(Number(queryParams.conversationId)); - - this.closeSidebarOnMobile(); + if ( + isNaN(Number(queryParams.conversationId)) && + Object.values(SavedPostStatusMap) + .map((s) => s.toString()) + .includes(queryParams.conversationId) + ) { + this.selectedSavedPostStatus = Posting.mapToStatus(queryParams.conversationId as SavedPostStatusMap); + } else { + this.metisConversationService.setActiveConversation(Number(queryParams.conversationId)); + this.closeSidebarOnMobile(); + } + } + if (queryParams.focusPostId) { + this.focusPostId = Number(queryParams.focusPostId); + } + if (queryParams.openThreadOnFocus) { + this.openThreadOnFocus = queryParams.openThreadOnFocus; } if (queryParams.messageId) { this.postInThread = { id: Number(queryParams.messageId) } as Post; @@ -265,11 +303,22 @@ export class CourseConversationsComponent implements OnInit, OnDestroy { }); } + onNavigateToPost(post: Posting) { + if (post.referencePostId === undefined || post.conversation?.id === undefined) { + return; + } + + this.focusPostId = post.referencePostId; + this.openThreadOnFocus = (post.postingType as PostingType) === PostingType.ANSWER; + this.metisConversationService.setActiveConversation(post.conversation!.id!); + this.changeDetector.detectChanges(); + } + updateQueryParameters() { this.router.navigate([], { relativeTo: this.activatedRoute, queryParams: { - conversationId: this.activeConversation?.id, + conversationId: this.activeConversation?.id ?? (this.selectedSavedPostStatus !== null ? Posting.statusToMap(this.selectedSavedPostStatus) : undefined), }, replaceUrl: true, }); @@ -348,6 +397,7 @@ export class CourseConversationsComponent implements OnInit, OnDestroy { this.courseSidebarService.openSidebar(); } } + this.selectedSavedPostStatus = null; this.metisConversationService.setActiveConversation(undefined); this.activeConversation = undefined; this.updateQueryParameters(); @@ -377,9 +427,29 @@ export class CourseConversationsComponent implements OnInit, OnDestroy { }; } - onConversationSelected(conversationId: number) { + onConversationSelected(conversationId: number | string) { this.closeSidebarOnMobile(); - this.metisConversationService.setActiveConversation(conversationId); + this.focusPostId = undefined; + this.openThreadOnFocus = false; + if (typeof conversationId === 'string') { + if ( + Object.values(SavedPostStatusMap) + .map((s) => s.toString()) + .includes(conversationId) + ) { + this.selectedSavedPostStatus = Posting.mapToStatus(conversationId as SavedPostStatusMap); + this.postInThread = undefined; + this.metisConversationService.setActiveConversation(undefined); + this.activeConversation = undefined; + this.updateQueryParameters(); + this.metisService.resetCachedPosts(); + this.changeDetector.detectChanges(); + } + } else { + conversationId = +conversationId; + this.selectedSavedPostStatus = null; + this.metisConversationService.setActiveConversation(conversationId); + } } toggleSidebar() { diff --git a/src/main/webapp/app/overview/course-conversations/course-conversations.module.ts b/src/main/webapp/app/overview/course-conversations/course-conversations.module.ts index 0646118f577f..10d2cea22583 100644 --- a/src/main/webapp/app/overview/course-conversations/course-conversations.module.ts +++ b/src/main/webapp/app/overview/course-conversations/course-conversations.module.ts @@ -31,6 +31,8 @@ import { CourseConversationsCodeOfConductComponent } from 'app/overview/course-c import { CourseWideSearchComponent } from 'app/overview/course-conversations/course-wide-search/course-wide-search.component'; import { ArtemisSidebarModule } from 'app/shared/sidebar/sidebar.module'; import { ProfilePictureComponent } from 'app/shared/profile-picture/profile-picture.component'; +import { SavedPostsComponent } from 'app/overview/course-conversations/saved-posts/saved-posts.component'; +import { PostingSummaryComponent } from 'app/overview/course-conversations/posting-summary/posting-summary.component'; const routes: Routes = [ { @@ -79,6 +81,8 @@ const routes: Routes = [ OneToOneChatCreateDialogComponent, GroupChatCreateDialogComponent, CourseWideSearchComponent, + SavedPostsComponent, + PostingSummaryComponent, ], }) export class CourseConversationsModule {} diff --git a/src/main/webapp/app/overview/course-conversations/course-wide-search/course-wide-search.component.html b/src/main/webapp/app/overview/course-conversations/course-wide-search/course-wide-search.component.html index 1295be3edf63..c9641f8aa287 100644 --- a/src/main/webapp/app/overview/course-conversations/course-wide-search/course-wide-search.component.html +++ b/src/main/webapp/app/overview/course-conversations/course-wide-search/course-wide-search.component.html @@ -72,7 +72,7 @@

}
-
+
diff --git a/src/main/webapp/app/overview/course-conversations/layout/conversation-messages/conversation-messages.component.html b/src/main/webapp/app/overview/course-conversations/layout/conversation-messages/conversation-messages.component.html index f7f35b3b2a3e..3cc7ff2a571d 100644 --- a/src/main/webapp/app/overview/course-conversations/layout/conversation-messages/conversation-messages.component.html +++ b/src/main/webapp/app/overview/course-conversations/layout/conversation-messages/conversation-messages.component.html @@ -1,5 +1,5 @@ @if (course) { -
+
@@ -103,7 +103,7 @@ } @if (_activeConversation && newPost && canCreateNewMessageInConversation(_activeConversation) && isMobile) { -
+
@if (getAsChannel(_activeConversation)?.isAnnouncementChannel) {
@@ -116,7 +116,7 @@ }
@if (_activeConversation && newPost && canCreateNewMessageInConversation(_activeConversation) && !isMobile) { -
+
@if (getAsChannel(_activeConversation)?.isAnnouncementChannel) {
diff --git a/src/main/webapp/app/overview/course-conversations/layout/conversation-messages/conversation-messages.component.ts b/src/main/webapp/app/overview/course-conversations/layout/conversation-messages/conversation-messages.component.ts index 7fdbe98508c2..17342052df52 100644 --- a/src/main/webapp/app/overview/course-conversations/layout/conversation-messages/conversation-messages.component.ts +++ b/src/main/webapp/app/overview/course-conversations/layout/conversation-messages/conversation-messages.component.ts @@ -13,7 +13,9 @@ import { ViewChild, ViewChildren, ViewEncapsulation, + effect, inject, + input, } from '@angular/core'; import { faCircleNotch, faEnvelope, faSearch, faTimes } from '@fortawesome/free-solid-svg-icons'; import { Conversation, ConversationDTO } from 'app/entities/metis/conversation/conversation.model'; @@ -73,6 +75,8 @@ export class ConversationMessagesComponent implements OnInit, AfterViewInit, OnD searchbarCollapsed = false; @Input() contentHeightDev: boolean = false; + readonly focusPostId = input(undefined); + readonly openThreadOnFocus = input(false); getAsChannel = getAsChannelDTO; @@ -101,6 +105,8 @@ export class ConversationMessagesComponent implements OnInit, AfterViewInit, OnD isMobile = false; isHiddenInputWithCallToAction = false; isHiddenInputFull = false; + focusOnPostId: number | undefined = undefined; + isOpenThreadOnFocus: boolean = false; private layoutService: LayoutService = inject(LayoutService); private renderer = inject(Renderer2); @@ -109,7 +115,12 @@ export class ConversationMessagesComponent implements OnInit, AfterViewInit, OnD public metisService: MetisService, // instance from course-conversations.component public metisConversationService: MetisConversationService, // instance from course-conversations.component public cdr: ChangeDetectorRef, - ) {} + ) { + effect(() => { + this.focusOnPostId = this.focusPostId(); + this.isOpenThreadOnFocus = this.openThreadOnFocus(); + }); + } ngOnInit(): void { this.subscribeToSearch(); @@ -130,7 +141,7 @@ export class ConversationMessagesComponent implements OnInit, AfterViewInit, OnD private subscribeToActiveConversation() { this.metisConversationService.activeConversation$.pipe(takeUntil(this.ngUnsubscribe)).subscribe((conversation: ConversationDTO) => { // This statement avoids a bug that reloads the messages when the conversation is already displayed - if (this._activeConversation?.id === conversation.id) { + if (conversation && this._activeConversation?.id === conversation.id) { return; } this._activeConversation = conversation; @@ -179,8 +190,13 @@ export class ConversationMessagesComponent implements OnInit, AfterViewInit, OnD } private scrollToStoredId() { - const savedScrollId = sessionStorage.getItem(this.sessionStorageKey + this._activeConversation?.id) ?? ''; - requestAnimationFrame(() => this.goToLastSelectedElement(parseInt(savedScrollId, 10))); + let savedScrollId; + if (this.focusOnPostId) { + savedScrollId = this.focusOnPostId + ''; + } else { + savedScrollId = sessionStorage.getItem(this.sessionStorageKey + this._activeConversation?.id) ?? ''; + } + requestAnimationFrame(() => this.goToLastSelectedElement(parseInt(savedScrollId, 10), this.isOpenThreadOnFocus)); } private onActiveConversationChange() { @@ -389,7 +405,7 @@ export class ConversationMessagesComponent implements OnInit, AfterViewInit, OnD this.scrollToBottomOfMessages(); } - async goToLastSelectedElement(lastScrollPosition: number) { + async goToLastSelectedElement(lastScrollPosition: number, isOpenThread: boolean) { if (!lastScrollPosition) { this.scrollToBottomOfMessages(); this.canStartSaving = true; @@ -404,6 +420,11 @@ export class ConversationMessagesComponent implements OnInit, AfterViewInit, OnD // We scroll to the element with a slight buffer to ensure its fully visible (-10) this.content.nativeElement.scrollTop = Math.max(0, element.elementRef.nativeElement.offsetTop - 10); this.canStartSaving = true; + if (isOpenThread) { + this.openThread.emit(element.post); + } + this.focusOnPostId = undefined; + this.isOpenThreadOnFocus = false; } } diff --git a/src/main/webapp/app/overview/course-conversations/layout/conversation-thread-sidebar/conversation-thread-sidebar.component.html b/src/main/webapp/app/overview/course-conversations/layout/conversation-thread-sidebar/conversation-thread-sidebar.component.html index 64ae4ee9d908..db9e1ebcdb24 100644 --- a/src/main/webapp/app/overview/course-conversations/layout/conversation-thread-sidebar/conversation-thread-sidebar.component.html +++ b/src/main/webapp/app/overview/course-conversations/layout/conversation-thread-sidebar/conversation-thread-sidebar.component.html @@ -25,7 +25,7 @@
@if (post !== undefined) {
-
+
-
+
@if (!readOnlyMode) { + @if (post() !== undefined) { + @if (isShowSummary) { +
+ + + + + {{ post()!.conversation!.title! }} + @if (isAnswerPost) { + > + } + +
+ } + @if (isShowContent) { +
+ @if (isAnswerPost) { +
+ +
+ } +
+ + +
+
+ {{ post()!.author!.name! }} + @if (post()!.creationDate !== undefined) { + + {{ postingIsOfToday ? (post()!.creationDate! | artemisDate: 'time') : (post()!.creationDate! | artemisDate: 'short-date') }} + + } +
+
+ +
+
+
+
+ } + + @if (isShowSavedPostOptions()) { +
+
+ + + +
+
+ } + } +
diff --git a/src/main/webapp/app/overview/course-conversations/posting-summary/posting-summary.component.scss b/src/main/webapp/app/overview/course-conversations/posting-summary/posting-summary.component.scss new file mode 100644 index 000000000000..36fbe43fa303 --- /dev/null +++ b/src/main/webapp/app/overview/course-conversations/posting-summary/posting-summary.component.scss @@ -0,0 +1,44 @@ +@import 'bootstrap/scss/functions'; +@import 'bootstrap/scss/variables'; +@import 'bootstrap/scss/mixins'; + +.posting-summary { + background-color: transparent; + cursor: pointer; + position: relative; + + transition: background-color 0.2s ease-in-out; +} + +.posting-summary:hover { + background-color: rgba($primary, 0.1); + + & .posting-summary-saved-post-options { + opacity: 1; + } +} + +.posting-summary-author-content { + margin-top: -0.15em; +} + +.posting-summary-saved-post-options { + position: absolute; + top: 0.3rem; + right: 0.3rem; + opacity: 0; + + transition: opacity 0.2s ease-in-out; +} + +.posting-summary-content.is-answer-post { + padding-left: 0.7rem; + margin-left: 0.35rem; + border-left: 1px solid $secondary; +} + +@include media-breakpoint-down(sm) { + .posting-summary-saved-post-options { + opacity: 1; + } +} diff --git a/src/main/webapp/app/overview/course-conversations/posting-summary/posting-summary.component.ts b/src/main/webapp/app/overview/course-conversations/posting-summary/posting-summary.component.ts new file mode 100644 index 000000000000..6e5b23539180 --- /dev/null +++ b/src/main/webapp/app/overview/course-conversations/posting-summary/posting-summary.component.ts @@ -0,0 +1,59 @@ +import { Component, effect, input, output } from '@angular/core'; +import { Posting, PostingType, SavedPostStatus } from 'app/entities/metis/posting.model'; +import { faBookmark, faBoxArchive, faCheckSquare, faEllipsis, faHashtag, faLock } from '@fortawesome/free-solid-svg-icons'; +import { ConversationType } from 'app/entities/metis/conversation/conversation.model'; +import dayjs from 'dayjs/esm'; + +@Component({ + selector: 'jhi-posting-summary', + templateUrl: './posting-summary.component.html', + styleUrls: ['./posting-summary.component.scss'], +}) +export class PostingSummaryComponent { + readonly post = input(); + readonly isShowSavedPostOptions = input(false); + + readonly onChangeSavedPostStatus = output(); + readonly onNavigateToPost = output(); + + protected readonly ConversationType = ConversationType; + protected readonly SavedPostStatus = SavedPostStatus; + + protected isAnswerPost = false; + protected postingIsOfToday = false; + protected isShowPosting = false; + protected isShowSummary = false; + protected isShowContent = false; + + // Icons + readonly faLock = faLock; + readonly faHashtag = faHashtag; + readonly faCheckSquare = faCheckSquare; + readonly faBookmark = faBookmark; + readonly faBoxArchive = faBoxArchive; + readonly faEllipsis = faEllipsis; + + constructor() { + effect(() => { + this.isShowPosting = this.post() !== undefined; + this.isShowSummary = + this.isShowPosting && this.post()!.conversation !== undefined && this.post()!.conversation!.type !== undefined && this.post()!.conversation!.title !== undefined; + this.isShowContent = this.isShowPosting && this.post()!.author !== undefined && this.post()!.content !== undefined && this.post()!.postingType !== undefined; + this.isAnswerPost = this.post()?.postingType === PostingType.ANSWER.valueOf(); + if (this.post()) { + this.postingIsOfToday = dayjs().isSame(this.post()!.creationDate, 'day'); + } + }); + } + + protected onStatusChangeClick(status: SavedPostStatus) { + this.onChangeSavedPostStatus.emit(status); + } + + protected onTriggerNavigateToPost() { + if (this.post() === undefined) { + return; + } + this.onNavigateToPost.emit(this.post()!); + } +} diff --git a/src/main/webapp/app/overview/course-conversations/saved-posts/saved-posts.component.html b/src/main/webapp/app/overview/course-conversations/saved-posts/saved-posts.component.html new file mode 100644 index 000000000000..159e9a163d8d --- /dev/null +++ b/src/main/webapp/app/overview/course-conversations/saved-posts/saved-posts.component.html @@ -0,0 +1,33 @@ +
+
+

+ () +

+
+
+ @if (isShowDeleteNotice) { +
+ + +
+ } +
+ @if (posts && posts.length > 0) { + @for (post of posts; track trackPostFunction($index, post)) { + @if (!hiddenPosts.includes(post.id!)) { + + } + } + } @else { +
+ + +
+ } +
+
diff --git a/src/main/webapp/app/overview/course-conversations/saved-posts/saved-posts.component.scss b/src/main/webapp/app/overview/course-conversations/saved-posts/saved-posts.component.scss new file mode 100644 index 000000000000..f8ff21b56846 --- /dev/null +++ b/src/main/webapp/app/overview/course-conversations/saved-posts/saved-posts.component.scss @@ -0,0 +1,14 @@ +.saved-posts-post-container { + overflow-y: auto; + overflow-x: hidden; + height: 100%; + max-height: 100%; +} + +.saved-posts-empty-notice { + height: 100%; + display: flex; + flex-direction: column; + align-items: center; + justify-content: center; +} diff --git a/src/main/webapp/app/overview/course-conversations/saved-posts/saved-posts.component.ts b/src/main/webapp/app/overview/course-conversations/saved-posts/saved-posts.component.ts new file mode 100644 index 000000000000..f3606114b830 --- /dev/null +++ b/src/main/webapp/app/overview/course-conversations/saved-posts/saved-posts.component.ts @@ -0,0 +1,64 @@ +import { Component, effect, inject, input, output } from '@angular/core'; +import { Posting, SavedPostStatus, SavedPostStatusMap } from 'app/entities/metis/posting.model'; +import { SavedPostService } from 'app/shared/metis/saved-post.service'; +import { faBookmark, faInfoCircle } from '@fortawesome/free-solid-svg-icons'; + +@Component({ + selector: 'jhi-saved-posts', + templateUrl: './saved-posts.component.html', + styleUrls: ['./saved-posts.component.scss'], +}) +export class SavedPostsComponent { + readonly savedPostStatus = input(); + readonly courseId = input(); + + readonly onNavigateToPost = output(); + + private readonly savedPostService = inject(SavedPostService); + + protected posts: Posting[]; + protected hiddenPosts: number[] = []; + protected savedPostStatusMap: SavedPostStatusMap = SavedPostStatusMap.PROGRESS; + protected isShowDeleteNotice: boolean = false; + + // Icons + readonly faBookmark = faBookmark; + readonly faInfoCircle = faInfoCircle; + + constructor() { + effect(() => { + this.savedPostStatusMap = Posting.statusToMap(this.savedPostStatus()!); + + this.isShowDeleteNotice = this.savedPostStatusMap !== SavedPostStatusMap.PROGRESS; + + this.savedPostService.fetchSavedPosts(this.courseId()!, this.savedPostStatus()!).subscribe({ + next: (response) => { + if (!response.body) { + this.posts = []; + } else { + this.posts = response.body.map(this.savedPostService.convertPostingToCorrespondingType); + } + }, + error: () => { + this.posts = []; + }, + complete: () => { + this.hiddenPosts = []; + }, + }); + }); + } + + protected trackPostFunction = (index: number, post: Posting): string => index + '' + post.id!; + + protected changeSavedPostStatus(post: Posting, status: SavedPostStatus) { + this.savedPostService.changeSavedPostStatus(post, status).subscribe({ + next: () => {}, + }); + this.hiddenPosts.push(post.id!); + } + + protected onTriggerNavigateToPost(post: Posting) { + this.onNavigateToPost.emit(post); + } +} diff --git a/src/main/webapp/app/overview/course-overview.service.ts b/src/main/webapp/app/overview/course-overview.service.ts index 0432dc2e361b..1aeb84cf5045 100644 --- a/src/main/webapp/app/overview/course-overview.service.ts +++ b/src/main/webapp/app/overview/course-overview.service.ts @@ -11,14 +11,15 @@ import { AccordionGroups, ChannelGroupCategory, SidebarCardElement, TimeGroupCat import dayjs from 'dayjs/esm'; import { cloneDeep } from 'lodash-es'; import { faGraduationCap } from '@fortawesome/free-solid-svg-icons'; -import { ConversationDTO } from 'app/entities/metis/conversation/conversation.model'; +import { ConversationDTO, ConversationType } from 'app/entities/metis/conversation/conversation.model'; import { ChannelSubType, getAsChannelDTO } from 'app/entities/metis/conversation/channel.model'; import { IconDefinition } from '@fortawesome/fontawesome-svg-core'; -import { faBullhorn, faHashtag, faLock } from '@fortawesome/free-solid-svg-icons'; +import { faBookmark, faBoxArchive, faBullhorn, faHashtag, faLock, faSquareCheck } from '@fortawesome/free-solid-svg-icons'; import { isOneToOneChatDTO } from 'app/entities/metis/conversation/one-to-one-chat.model'; import { isGroupChatDTO } from 'app/entities/metis/conversation/group-chat.model'; import { ConversationService } from 'app/shared/metis/conversations/conversation.service'; import { StudentExam } from 'app/entities/student-exam.model'; +import { SavedPostStatusMap } from 'app/entities/metis/posting.model'; const DEFAULT_UNIT_GROUPS: AccordionGroups = { future: { entityData: [] }, @@ -222,6 +223,33 @@ export class CourseOverviewService { const channelGroups = messagingEnabled ? { ...DEFAULT_CHANNEL_GROUPS, groupChats: { entityData: [] }, directMessages: { entityData: [] } } : DEFAULT_CHANNEL_GROUPS; const groupedConversationGroups = cloneDeep(channelGroups) as AccordionGroups; + groupedConversationGroups.savedPosts = { + isHideCount: true, + entityData: [ + { + title: this.translate.instant('artemisApp.courseOverview.sidebar.progress'), + id: SavedPostStatusMap.PROGRESS.toString(), + type: ConversationType.CHANNEL, + icon: faBookmark, + size: 'S', + }, + { + title: this.translate.instant('artemisApp.courseOverview.sidebar.completed'), + id: SavedPostStatusMap.COMPLETED.toString(), + type: ConversationType.CHANNEL, + icon: faSquareCheck, + size: 'S', + }, + { + title: this.translate.instant('artemisApp.courseOverview.sidebar.archived'), + id: SavedPostStatusMap.ARCHIVED.toString(), + type: ConversationType.CHANNEL, + icon: faBoxArchive, + size: 'S', + }, + ], + }; + for (const conversation of conversations) { const conversationGroup = this.getConversationGroup(conversation); const conversationCardItem = this.mapConversationToSidebarCardElement(conversation); diff --git a/src/main/webapp/app/shared/metis/answer-post/answer-post.component.html b/src/main/webapp/app/shared/metis/answer-post/answer-post.component.html index 1579e97f9a0f..8a703757ecfc 100644 --- a/src/main/webapp/app/shared/metis/answer-post/answer-post.component.html +++ b/src/main/webapp/app/shared/metis/answer-post/answer-post.component.html @@ -1,15 +1,25 @@ -
+
+ @if (posting.isSaved) { +
+
+ + +
+
+ } @if (!isConsecutive()) { - +
+ +
} @if (!createAnswerPostModal.isInputOpen) { -
+
@@ -43,7 +54,7 @@
@if (!isDeleted) { -
+
} @@ -76,6 +88,10 @@ } +
diff --git a/src/main/webapp/app/shared/metis/answer-post/answer-post.component.scss b/src/main/webapp/app/shared/metis/answer-post/answer-post.component.scss index f744b2dafdd3..72c1034f12a7 100644 --- a/src/main/webapp/app/shared/metis/answer-post/answer-post.component.scss +++ b/src/main/webapp/app/shared/metis/answer-post/answer-post.component.scss @@ -5,12 +5,11 @@ @import 'src/main/webapp/app/shared/metis/metis.component'; .answer-post { - background-color: var(--metis-answer-post-background-color); border-radius: 7px; } .answer-post-content-margin { - padding-left: 3.2rem; + padding-left: 3.42rem; } @include media-breakpoint-down(sm) { @@ -37,13 +36,27 @@ .message-container { position: relative; - border-radius: 5px; - transition: background-color 0.3s ease; } -.message-content { - padding-left: 0.3rem; +.post-is-saved-message, +.message-container, +.post-reactions-bar, +.answer-post { + background-color: transparent; + + transition: background-color 0.2s ease-in-out; + + &.is-saved { + background-color: rgba($primary, 0.1); + } +} +.message-content, +.post-is-saved-message-content { + padding-left: 0.25rem; +} + +.message-content { &.force-hover { background: var(--metis-selection-option-hover-background); diff --git a/src/main/webapp/app/shared/metis/answer-post/answer-post.component.ts b/src/main/webapp/app/shared/metis/answer-post/answer-post.component.ts index ea4d54ba7267..0c16f1be06ce 100644 --- a/src/main/webapp/app/shared/metis/answer-post/answer-post.component.ts +++ b/src/main/webapp/app/shared/metis/answer-post/answer-post.component.ts @@ -6,6 +6,8 @@ import { HostListener, Inject, Input, + OnChanges, + OnInit, Output, Renderer2, ViewChild, @@ -18,7 +20,7 @@ import dayjs from 'dayjs/esm'; import { animate, style, transition, trigger } from '@angular/animations'; import { Posting } from 'app/entities/metis/posting.model'; import { Reaction } from 'app/entities/metis/reaction.model'; -import { faPencilAlt, faSmile, faThumbtack, faTrash } from '@fortawesome/free-solid-svg-icons'; +import { faBookmark, faPencilAlt, faSmile, faTrash } from '@fortawesome/free-solid-svg-icons'; import { DOCUMENT } from '@angular/common'; import { AnswerPostReactionsBarComponent } from 'app/shared/metis/posting-reactions-bar/answer-post-reactions-bar/answer-post-reactions-bar.component'; @@ -34,7 +36,7 @@ import { AnswerPostReactionsBarComponent } from 'app/shared/metis/posting-reacti ]), ], }) -export class AnswerPostComponent extends PostingDirective { +export class AnswerPostComponent extends PostingDirective implements OnInit, OnChanges { @Input() lastReadDate?: dayjs.Dayjs; @Input() isLastAnswer: boolean; @Output() openPostingCreateEditModal = new EventEmitter(); @@ -45,12 +47,15 @@ export class AnswerPostComponent extends PostingDirective { @Input() isReadOnlyMode = false; // ng-container to render answerPostCreateEditModalComponent + + // Icons + faBookmark = faBookmark; + @ViewChild('createEditAnswerPostContainer', { read: ViewContainerRef }) containerRef: ViewContainerRef; isConsecutive = input(false); readonly faPencilAlt = faPencilAlt; readonly faSmile = faSmile; readonly faTrash = faTrash; - readonly faThumbtack = faThumbtack; static activeDropdownPost: AnswerPostComponent | null = null; mayEdit: boolean = false; mayDelete: boolean = false; @@ -64,6 +69,15 @@ export class AnswerPostComponent extends PostingDirective { super(); } + ngOnInit() { + super.ngOnInit(); + this.assignPostingToAnswerPost(); + } + + ngOnChanges(): void { + this.assignPostingToAnswerPost(); + } + get reactionsBar() { return this.reactionsBarComponent; } @@ -133,4 +147,11 @@ export class AnswerPostComponent extends PostingDirective { this.dropdownPosition.x = screenWidth - dropdownWidth - 10; } } + + private assignPostingToAnswerPost() { + // This is needed because otherwise instanceof returns 'object'. + if (this.posting && !(this.posting instanceof AnswerPost)) { + this.posting = Object.assign(new AnswerPost(), this.posting); + } + } } diff --git a/src/main/webapp/app/shared/metis/metis.component.scss b/src/main/webapp/app/shared/metis/metis.component.scss index 0db317b31ea8..a89058855c11 100644 --- a/src/main/webapp/app/shared/metis/metis.component.scss +++ b/src/main/webapp/app/shared/metis/metis.component.scss @@ -31,8 +31,8 @@ $delete-delay-duration: 6s; line-height: 1.1; } -.post-content-margin { - margin-left: 2.65rem; +.post-content-padding { + padding-left: 3.42rem; } .post-authority-icon-student { @@ -87,7 +87,7 @@ $delete-delay-duration: 6s; gap: 0 !important; } - .post-content-margin { + .post-content-padding { margin-left: 0; } diff --git a/src/main/webapp/app/shared/metis/metis.service.ts b/src/main/webapp/app/shared/metis/metis.service.ts index a2badd9dba73..d5c40e6dcd27 100644 --- a/src/main/webapp/app/shared/metis/metis.service.ts +++ b/src/main/webapp/app/shared/metis/metis.service.ts @@ -5,8 +5,8 @@ import { HttpResponse } from '@angular/common/http'; import { User } from 'app/core/user/user.model'; import { AccountService } from 'app/core/auth/account.service'; import { Course } from 'app/entities/course.model'; -import { Posting } from 'app/entities/metis/posting.model'; -import { Injectable, OnDestroy } from '@angular/core'; +import { Posting, SavedPostStatus } from 'app/entities/metis/posting.model'; +import { Injectable, OnDestroy, inject } from '@angular/core'; import { AnswerPostService } from 'app/shared/metis/answer-post.service'; import { AnswerPost } from 'app/entities/metis/answer-post.model'; import { Reaction } from 'app/entities/metis/reaction.model'; @@ -31,6 +31,8 @@ import { Conversation, ConversationDTO } from 'app/entities/metis/conversation/c import { ChannelDTO, ChannelSubType, getAsChannelDTO } from 'app/entities/metis/conversation/channel.model'; import { ConversationService } from 'app/shared/metis/conversations/conversation.service'; import { NotificationService } from 'app/shared/notification/notification.service'; +import { SavedPostService } from 'app/shared/metis/saved-post.service'; +import { cloneDeep } from 'lodash-es'; @Injectable() export class MetisService implements OnDestroy { @@ -49,6 +51,7 @@ export class MetisService implements OnDestroy { private subscriptionChannel?: string; private courseWideTopicSubscription: Subscription; + private savedPostService: SavedPostService = inject(SavedPostService); constructor( protected postService: PostService, @@ -547,6 +550,54 @@ export class MetisService implements OnDestroy { this.jhiWebsocketService.receive(this.subscriptionChannel).subscribe(this.handleNewOrUpdatedMessage); } + public savePost(post: Posting) { + this.setIsSavedAndStatusOfPost(post, true, post.savedPostStatus as SavedPostStatus); + this.savedPostService.savePost(post).subscribe({ + next: () => {}, + }); + this.posts$.next(this.cachedPosts); + } + + public removeSavedPost(post: Posting) { + this.setIsSavedAndStatusOfPost(post, false, post.savedPostStatus as SavedPostStatus); + this.savedPostService.removeSavedPost(post).subscribe({ + next: () => {}, + }); + this.posts$.next(this.cachedPosts); + } + + public changeSavedPostStatus(post: Posting, status: SavedPostStatus) { + this.setIsSavedAndStatusOfPost(post, post.isSaved, status); + this.savedPostService.changeSavedPostStatus(post, status).subscribe({ + next: () => {}, + }); + this.posts$.next(this.cachedPosts); + } + + public resetCachedPosts() { + this.cachedPosts = []; + this.posts$.next(this.cachedPosts); + this.cachedTotalNumberOfPosts = 0; + this.totalNumberOfPosts$.next(this.cachedTotalNumberOfPosts); + } + + private setIsSavedAndStatusOfPost(post: Posting, isSaved: undefined | boolean, status: undefined | SavedPostStatus) { + if (post instanceof AnswerPost) { + const indexToUpdate = this.cachedPosts.findIndex((cachedPost) => cachedPost.id === post.post!.id); + const indexOfAnswer = this.cachedPosts[indexToUpdate].answers?.findIndex((answer) => answer.id === post.id) ?? -1; + const postCopy = cloneDeep(this.cachedPosts[indexToUpdate].answers![indexOfAnswer]); + postCopy.isSaved = isSaved; + postCopy.savedPostStatus = status?.valueOf(); + this.cachedPosts[indexToUpdate].answers![indexOfAnswer] = postCopy; + } else { + const indexToUpdate = this.cachedPosts.findIndex((cachedPost) => cachedPost.id === post.id); + const postCopy = cloneDeep(this.cachedPosts[indexToUpdate]); + postCopy.isSaved = isSaved; + postCopy.savedPostStatus = status?.valueOf(); + this.cachedPosts[indexToUpdate] = postCopy; + } + } + private handleNewOrUpdatedMessage = (postDTO: MetisPostDTO): void => { const postConvId = postDTO.post.conversation?.id; const postIsNotFromCurrentConversation = this.currentPostContextFilter.conversationId && postConvId !== this.currentPostContextFilter.conversationId; diff --git a/src/main/webapp/app/shared/metis/post/post.component.html b/src/main/webapp/app/shared/metis/post/post.component.html index 0c014cda695c..053357c4e274 100644 --- a/src/main/webapp/app/shared/metis/post/post.component.html +++ b/src/main/webapp/app/shared/metis/post/post.component.html @@ -1,18 +1,28 @@ -
+
+ @if (posting.isSaved) { +
+
+ + +
+
+ } @if (!isConsecutive()) { - +
+ +
} -
+
-
+ @if (!displayInlineInput) { -
+
-
+
@if (!previewMode) { }
@@ -93,13 +109,13 @@
@if (!isDeleted && displayInlineInput && !readOnlyMode) { -
+
} @if (!isDeleted) { -
- +
+ @if (!previewMode) { }
@@ -166,6 +183,10 @@ +
diff --git a/src/main/webapp/app/shared/metis/post/post.component.scss b/src/main/webapp/app/shared/metis/post/post.component.scss index 10cb7ef83132..43ae9a2bbcd9 100644 --- a/src/main/webapp/app/shared/metis/post/post.component.scss +++ b/src/main/webapp/app/shared/metis/post/post.component.scss @@ -34,8 +34,6 @@ .message-container { position: relative; - border-radius: 5px; - transition: background-color 0.3s ease; &.force-hover { background: var(--metis-selection-option-hover-background); @@ -47,8 +45,22 @@ } } -.message-content { - padding-left: 0.3rem; +.post-is-saved-message, +.message-container, +.post-reactions-bar, +.post { + background-color: transparent; + + transition: background-color 0.2s ease-in-out; + + &.is-saved { + background-color: rgba($primary, 0.1); + } +} + +.message-content, +.post-is-saved-message-content { + padding-left: 0.25rem; } .message-content:hover { diff --git a/src/main/webapp/app/shared/metis/post/post.component.ts b/src/main/webapp/app/shared/metis/post/post.component.ts index 7bfe1d0c6f49..5deafdbd287b 100644 --- a/src/main/webapp/app/shared/metis/post/post.component.ts +++ b/src/main/webapp/app/shared/metis/post/post.component.ts @@ -20,7 +20,7 @@ import { PostingDirective } from 'app/shared/metis/posting.directive'; import { MetisService } from 'app/shared/metis/metis.service'; import { NgbModalRef } from '@ng-bootstrap/ng-bootstrap'; import { ContextInformation, DisplayPriority, PageType, RouteComponents } from '../metis.util'; -import { faBullhorn, faComments, faPencilAlt, faSmile, faThumbtack, faTrash } from '@fortawesome/free-solid-svg-icons'; +import { faBookmark, faBullhorn, faCheckSquare, faComments, faPencilAlt, faSmile, faThumbtack, faTrash } from '@fortawesome/free-solid-svg-icons'; import dayjs from 'dayjs/esm'; import { PostFooterComponent } from 'app/shared/metis/posting-footer/post-footer/post-footer.component'; import { OneToOneChatService } from 'app/shared/metis/conversations/one-to-one-chat.service'; @@ -88,6 +88,8 @@ export class PostComponent extends PostingDirective implements OnInit, OnC readonly faSmile = faSmile; readonly faTrash = faTrash; readonly faThumbtack = faThumbtack; + readonly faCheckSquare = faCheckSquare; + readonly faBookmark = faBookmark; isConsecutive = input(false); dropdownPosition = { x: 0, y: 0 }; @@ -184,6 +186,7 @@ export class PostComponent extends PostingDirective implements OnInit, OnC this.contextInformation = this.metisService.getContextInformation(this.posting); this.isAtLeastTutorInCourse = this.metisService.metisUserIsAtLeastTutorInCourse(); this.sortAnswerPosts(); + this.assignPostingToPost(); } /** @@ -195,6 +198,7 @@ export class PostComponent extends PostingDirective implements OnInit, OnC this.queryParams = this.metisService.getQueryParamsForPost(this.posting); this.showAnnouncementIcon = (getAsChannelDTO(this.posting.conversation)?.isAnnouncementChannel && this.showChannelReference) ?? false; this.sortAnswerPosts(); + this.assignPostingToPost(); } /** @@ -287,4 +291,11 @@ export class PostComponent extends PostingDirective implements OnInit, OnC } } } + + private assignPostingToPost() { + // This is needed because otherwise instanceof returns 'object'. + if (this.posting && !(this.posting instanceof Post)) { + this.posting = Object.assign(new Post(), this.posting); + } + } } diff --git a/src/main/webapp/app/shared/metis/posting-content/posting-content.component.html b/src/main/webapp/app/shared/metis/posting-content/posting-content.component.html index 86d8860b100d..ecf25fe3a3bb 100644 --- a/src/main/webapp/app/shared/metis/posting-content/posting-content.component.html +++ b/src/main/webapp/app/shared/metis/posting-content/posting-content.component.html @@ -6,7 +6,7 @@ -} @else if (currentlyLoadedPosts) { +} @else { @if (previewMode) {
diff --git a/src/main/webapp/app/shared/metis/posting-content/posting-content.components.ts b/src/main/webapp/app/shared/metis/posting-content/posting-content.components.ts index 45b92cb0bdde..59de56813a99 100644 --- a/src/main/webapp/app/shared/metis/posting-content/posting-content.components.ts +++ b/src/main/webapp/app/shared/metis/posting-content/posting-content.components.ts @@ -25,11 +25,12 @@ export class PostingContentComponent implements OnInit, OnChanges, OnDestroy { @Output() userReferenceClicked = new EventEmitter(); @Output() channelReferenceClicked = new EventEmitter(); isDeleted = input(false); + isSubscribeToMetis = input(true); deleteTimerInSeconds = input(0); onUndoDeleteEvent = output(); showContent = false; - currentlyLoadedPosts: Post[]; + currentlyLoadedPosts: Post[] = []; postingContentParts = signal([]); private postsSubscription: Subscription; @@ -47,14 +48,21 @@ export class PostingContentComponent implements OnInit, OnChanges, OnDestroy { * on initialization: calculate posting parts to be displayed */ ngOnInit(): void { - this.computeContentPartsOfPosts(); + if (!this.isSubscribeToMetis()) { + const patternMatches: PatternMatch[] = this.getPatternMatches(); + this.computePostingContentParts(patternMatches); + } else { + this.computeContentPartsOfPosts(); + } } /** * on changes: update posting parts to be displayed */ ngOnChanges(): void { - this.computeContentPartsOfPosts(); + if (!this.isSubscribeToMetis()) { + this.computeContentPartsOfPosts(); + } } /** diff --git a/src/main/webapp/app/shared/metis/posting-header/answer-post-header/answer-post-header.component.ts b/src/main/webapp/app/shared/metis/posting-header/answer-post-header/answer-post-header.component.ts index bb1ff3cbbbd2..45bd9775fd06 100644 --- a/src/main/webapp/app/shared/metis/posting-header/answer-post-header/answer-post-header.component.ts +++ b/src/main/webapp/app/shared/metis/posting-header/answer-post-header/answer-post-header.component.ts @@ -1,10 +1,8 @@ import { Component, EventEmitter, Input, OnChanges, OnInit, Output } from '@angular/core'; import { AnswerPost } from 'app/entities/metis/answer-post.model'; import { PostingHeaderDirective } from 'app/shared/metis/posting-header/posting-header.directive'; -import { MetisService } from 'app/shared/metis/metis.service'; import { faCheck, faPencilAlt } from '@fortawesome/free-solid-svg-icons'; import dayjs from 'dayjs/esm'; -import { AccountService } from 'app/core/auth/account.service'; @Component({ selector: 'jhi-answer-post-header', @@ -22,13 +20,6 @@ export class AnswerPostHeaderComponent extends PostingHeaderDirective implements readonly faPencilAlt = faPencilAlt; readonly faCheckSquare = faCheckSquare; - constructor( - protected metisService: MetisService, - protected accountService: AccountService, - ) { - super(metisService, accountService); - } - ngOnInit() { super.ngOnInit(); } diff --git a/src/main/webapp/app/shared/metis/posting-header/posting-header.directive.ts b/src/main/webapp/app/shared/metis/posting-header/posting-header.directive.ts index f07ef5e1ed04..8868f60124c1 100644 --- a/src/main/webapp/app/shared/metis/posting-header/posting-header.directive.ts +++ b/src/main/webapp/app/shared/metis/posting-header/posting-header.directive.ts @@ -1,5 +1,5 @@ import { Posting } from 'app/entities/metis/posting.model'; -import { Directive, EventEmitter, Input, OnInit, Output, input } from '@angular/core'; +import { Directive, EventEmitter, Input, OnInit, Output, inject, input } from '@angular/core'; import dayjs from 'dayjs/esm'; import { MetisService } from 'app/shared/metis/metis.service'; import { UserRole } from 'app/shared/metis/metis.util'; @@ -29,10 +29,8 @@ export abstract class PostingHeaderDirective implements OnIni userAuthorityTooltip: string; currentUser?: User; - protected constructor( - protected metisService: MetisService, - protected accountService: AccountService, - ) {} + protected metisService: MetisService = inject(MetisService); + protected accountService: AccountService = inject(AccountService); /** * on initialization: determines if user is at least tutor in the course and if user is author of posting by invoking the metis service, diff --git a/src/main/webapp/app/shared/metis/posting-reactions-bar/answer-post-reactions-bar/answer-post-reactions-bar.component.html b/src/main/webapp/app/shared/metis/posting-reactions-bar/answer-post-reactions-bar/answer-post-reactions-bar.component.html index 1d0c14bff56f..d19d55ec56df 100644 --- a/src/main/webapp/app/shared/metis/posting-reactions-bar/answer-post-reactions-bar/answer-post-reactions-bar.component.html +++ b/src/main/webapp/app/shared/metis/posting-reactions-bar/answer-post-reactions-bar/answer-post-reactions-bar.component.html @@ -88,6 +88,13 @@ /> } + }
diff --git a/src/main/webapp/app/shared/metis/posting-reactions-bar/answer-post-reactions-bar/answer-post-reactions-bar.component.ts b/src/main/webapp/app/shared/metis/posting-reactions-bar/answer-post-reactions-bar/answer-post-reactions-bar.component.ts index c287db1b1d7b..eed3ef65d59e 100644 --- a/src/main/webapp/app/shared/metis/posting-reactions-bar/answer-post-reactions-bar/answer-post-reactions-bar.component.ts +++ b/src/main/webapp/app/shared/metis/posting-reactions-bar/answer-post-reactions-bar/answer-post-reactions-bar.component.ts @@ -19,6 +19,7 @@ export class AnswerPostReactionsBarComponent extends PostingsReactionsBarDirecti // Icons readonly farSmile = faSmile; readonly faCheck = faCheck; + @Output() openPostingCreateEditModal = new EventEmitter(); isAuthorOfOriginalPost: boolean; isAnswerOfAnnouncement: boolean; diff --git a/src/main/webapp/app/shared/metis/posting-reactions-bar/post-reactions-bar/post-reactions-bar.component.html b/src/main/webapp/app/shared/metis/posting-reactions-bar/post-reactions-bar/post-reactions-bar.component.html index bf818ff12160..a1b39c6f61c2 100644 --- a/src/main/webapp/app/shared/metis/posting-reactions-bar/post-reactions-bar/post-reactions-bar.component.html +++ b/src/main/webapp/app/shared/metis/posting-reactions-bar/post-reactions-bar/post-reactions-bar.component.html @@ -131,6 +131,15 @@ } + @if (!isEmojiCount) { + + }
@if (isEmojiCount && getShowNewMessageIcon()) { diff --git a/src/main/webapp/app/shared/metis/posting-reactions-bar/posting-reactions-bar.directive.ts b/src/main/webapp/app/shared/metis/posting-reactions-bar/posting-reactions-bar.directive.ts index e3847cf48c34..c8877be83b9c 100644 --- a/src/main/webapp/app/shared/metis/posting-reactions-bar/posting-reactions-bar.directive.ts +++ b/src/main/webapp/app/shared/metis/posting-reactions-bar/posting-reactions-bar.directive.ts @@ -4,6 +4,8 @@ import { MetisService } from 'app/shared/metis/metis.service'; import { EmojiData } from '@ctrl/ngx-emoji-mart/ngx-emoji'; import { Reaction } from 'app/entities/metis/reaction.model'; import { PLACEHOLDER_USER_REACTED } from 'app/shared/pipes/reacting-users-on-posting.pipe'; +import { faBookmark } from '@fortawesome/free-solid-svg-icons'; +import { faBookmark as farBookmark } from '@fortawesome/free-regular-svg-icons'; const PIN_EMOJI_ID = 'pushpin'; const ARCHIVE_EMOJI_ID = 'open_file_folder'; @@ -58,6 +60,11 @@ export abstract class PostingsReactionsBarDirective implement isAuthorOfPosting: boolean; @Output() isModalOpen = new EventEmitter(); isDeleteEvent = output(); + readonly onBookmarkClicked = output(); + + // Icons + readonly farBookmark = farBookmark; + readonly faBookmark = faBookmark; /* * icons (as svg paths) to be used as category preview image in emoji mart selector @@ -209,4 +216,8 @@ export abstract class PostingsReactionsBarDirective implement return { ...metaDataMap, [reaction.emojiId!]: reactionMetaData }; }, {}); } + + protected bookmarkPosting() { + this.onBookmarkClicked.emit(); + } } diff --git a/src/main/webapp/app/shared/metis/posting.directive.ts b/src/main/webapp/app/shared/metis/posting.directive.ts index 7e601e30d3ca..f62af4907e18 100644 --- a/src/main/webapp/app/shared/metis/posting.directive.ts +++ b/src/main/webapp/app/shared/metis/posting.directive.ts @@ -2,6 +2,8 @@ import { Posting } from 'app/entities/metis/posting.model'; import { ChangeDetectorRef, Directive, Input, OnDestroy, OnInit, inject } from '@angular/core'; import { MetisService } from 'app/shared/metis/metis.service'; import { DisplayPriority } from 'app/shared/metis/metis.util'; +import { faBookmark } from '@fortawesome/free-solid-svg-icons'; +import { faBookmark as farBookmark } from '@fortawesome/free-regular-svg-icons'; @Directive() export abstract class PostingDirective implements OnInit, OnDestroy { @@ -29,6 +31,10 @@ export abstract class PostingDirective implements OnInit, OnD protected metisService = inject(MetisService); protected changeDetector = inject(ChangeDetectorRef); + // Icons + farBookmark = farBookmark; + faBookmark = faBookmark; + ngOnInit(): void { this.content = this.posting.content; } @@ -115,4 +121,14 @@ export abstract class PostingDirective implements OnInit, OnD toggleEmojiSelect() { this.showReactionSelector = !this.showReactionSelector; } + + protected toggleSavePost() { + if (this.posting.isSaved) { + this.metisService.removeSavedPost(this.posting); + this.posting.isSaved = false; + } else { + this.metisService.savePost(this.posting); + this.posting.isSaved = true; + } + } } diff --git a/src/main/webapp/app/shared/metis/saved-post.service.ts b/src/main/webapp/app/shared/metis/saved-post.service.ts new file mode 100644 index 000000000000..b0b871c2cd19 --- /dev/null +++ b/src/main/webapp/app/shared/metis/saved-post.service.ts @@ -0,0 +1,98 @@ +import { Injectable, inject } from '@angular/core'; +import { HttpClient, HttpResponse } from '@angular/common/http'; +import { Observable } from 'rxjs'; +import { Post } from 'app/entities/metis/post.model'; +import { Posting, PostingType, SavedPostStatus } from 'app/entities/metis/posting.model'; +import { map } from 'rxjs/operators'; +import { convertDateFromServer } from 'app/utils/date.utils'; +import { ConversationType } from 'app/entities/metis/conversation/conversation.model'; +import { AnswerPost } from 'app/entities/metis/answer-post.model'; + +@Injectable({ + providedIn: 'root', +}) +export class SavedPostService { + private resourceUrl = 'api/saved-posts/'; + + private readonly http: HttpClient = inject(HttpClient); + + /** + * saves a post + * @param {Posting} post + * @return {Observable} + */ + public savePost(post: Posting): Observable { + const type = this.getPostingType(post).toString(); + + return this.http.post(`${this.resourceUrl}${post.id}/${type}`, {}, { observe: 'response' }); + } + + /** + * un-saves a post + * @param {Posting} post + * @return {Observable} + */ + public removeSavedPost(post: Posting): Observable { + const type = this.getPostingType(post).toString(); + + return this.http.delete(`${this.resourceUrl}${post.id}/${type}`, { observe: 'response' }); + } + + /** + * updates a posts status + * @param {Posting} post + * @param {SavedPostStatus} status of a post (progress, archived, completed) + * @return {Observable} + */ + public changeSavedPostStatus(post: Posting, status: SavedPostStatus): Observable { + const type = this.getPostingType(post).toString(); + + return this.http.put(`${this.resourceUrl}${post.id}/${type}?status=${status.toString()}`, null, { observe: 'response' }); + } + + /** + * Fetches the saved postings for a given status + * @param {number} courseId + * @param {SavedPostStatus} status + * @return {Observable} + */ + public fetchSavedPosts(courseId: number, status: SavedPostStatus): Observable> { + return this.http.get(`${this.resourceUrl}${courseId}/${status.toString()}`, { observe: 'response' }).pipe(map(this.convertPostResponseFromServer)); + } + + /** + * Converts posting to the corresponding type + * @param {Posting} post to convert + * @return {Post|AnswerPost} + */ + public convertPostingToCorrespondingType(post: Posting) { + return Object.assign((post.postingType as PostingType) === PostingType.POST ? new Post() : new AnswerPost(), post); + } + + /** + * takes an array of postings and converts the date from the server + * @param {HttpResponse} res + * @return {HttpResponse} + */ + private convertPostResponseFromServer(res: HttpResponse): HttpResponse { + if (res.body) { + res.body.forEach((post) => { + post.creationDate = convertDateFromServer(post.creationDate); + post.updatedDate = convertDateFromServer(post.updatedDate); + if (post.conversation?.type !== undefined) { + post.conversation.type = post.conversation.type.toLowerCase() as ConversationType; + } + }); + } + return res; + } + + /** + * Retrieves the proper enum type for a posting + * @param {Posting} post + * @return {PostingType} + */ + private getPostingType(post: Posting): PostingType { + return post instanceof Post ? PostingType.POST : PostingType.ANSWER; + } +} diff --git a/src/main/webapp/app/shared/sidebar/sidebar-accordion/sidebar-accordion.component.html b/src/main/webapp/app/shared/sidebar/sidebar-accordion/sidebar-accordion.component.html index 92d7b034e785..895cc5ea858a 100644 --- a/src/main/webapp/app/shared/sidebar/sidebar-accordion/sidebar-accordion.component.html +++ b/src/main/webapp/app/shared/sidebar/sidebar-accordion/sidebar-accordion.component.html @@ -11,7 +11,9 @@ } {{ 'artemisApp.courseOverview.sidebar.' + groupKey | artemisTranslate | titlecase }} - ({{ (groupedData[groupKey].entityData | searchFilter: ['title', 'type'] : searchValue)?.length }}) + @if (!groupedData[groupKey].isHideCount) { + ({{ (groupedData[groupKey].entityData | searchFilter: ['title', 'type'] : searchValue)?.length }}) + }
@if (totalUnreadMessagesPerGroup[groupKey] > 0 && collapseState[groupKey]) { diff --git a/src/main/webapp/app/shared/sidebar/sidebar.component.ts b/src/main/webapp/app/shared/sidebar/sidebar.component.ts index 99903955e980..f3ea292820bb 100644 --- a/src/main/webapp/app/shared/sidebar/sidebar.component.ts +++ b/src/main/webapp/app/shared/sidebar/sidebar.component.ts @@ -22,7 +22,7 @@ import { ExerciseFilterModalComponent } from 'app/shared/exercise-filter/exercis styleUrls: ['./sidebar.component.scss'], }) export class SidebarComponent implements OnDestroy, OnChanges, OnInit { - @Output() onSelectConversation = new EventEmitter(); + @Output() onSelectConversation = new EventEmitter(); @Output() onUpdateSidebar = new EventEmitter(); onDirectChatPressed = output(); onGroupChatPressed = output(); @@ -117,7 +117,7 @@ export class SidebarComponent implements OnDestroy, OnChanges, OnInit { if (itemId) { this.storeLastSelectedItem(itemId); if (this.sidebarData.sidebarType == 'conversation') { - this.onSelectConversation.emit(+itemId); + this.onSelectConversation.emit(itemId); this.onUpdateSidebar.emit(); } } diff --git a/src/main/webapp/app/types/sidebar.ts b/src/main/webapp/app/types/sidebar.ts index 6eed6d06cb40..685bd3069cda 100644 --- a/src/main/webapp/app/types/sidebar.ts +++ b/src/main/webapp/app/types/sidebar.ts @@ -10,7 +10,10 @@ export type TimeGroupCategory = 'past' | 'current' | 'dueSoon' | 'future' | 'noD export type ExamGroupCategory = 'real' | 'test'; export type TutorialGroupCategory = 'all' | 'registered' | 'further'; export type SidebarTypes = 'exercise' | 'exam' | 'inExam' | 'conversation' | 'default'; -export type AccordionGroups = Record; +export type AccordionGroups = Record< + TimeGroupCategory | TutorialGroupCategory | ExamGroupCategory | ChannelGroupCategory | string, + { entityData: SidebarCardElement[]; isHideCount?: boolean } +>; export type ChannelGroupCategory = | 'favoriteChannels' | 'generalChannels' @@ -19,6 +22,7 @@ export type ChannelGroupCategory = | 'groupChats' | 'directMessages' | 'examChannels' + | 'savedPosts' | 'hiddenChannels'; export type CollapseState = { [key: string]: boolean; diff --git a/src/main/webapp/content/icons/icons.ts b/src/main/webapp/content/icons/icons.ts index f5588768724b..cabc6c1d4613 100644 --- a/src/main/webapp/content/icons/icons.ts +++ b/src/main/webapp/content/icons/icons.ts @@ -42,8 +42,23 @@ export const facSaveWarning: IconDefinition = { ], } as IconDefinition; +export const facDetails: IconDefinition = { + prefix: 'fac' as IconPrefix, + iconName: 'details' as IconName, + icon: [ + 24, // SVG view box width + 24, // SVG view box height + [], + '', + [ + 'M2.25 21C2.25 21.4125 2.5875 21.75 3 21.75H12.1424C13.196 22.3848 14.4303 22.75 15.75 22.75C16.3886 22.75 17.0073 22.6645 17.5951 22.5043C17.0752 23.3981 16.1068 24 15 24H3C1.34531 24 0 22.6547 0 21V3C0 1.34531 1.34531 0 3 0H10.7578C11.5547 0 12.3141 0.314063 12.8766 0.876563L17.1234 5.11875C17.6859 5.68125 18 6.44531 18 7.24219V9.11945C17.2939 8.87991 16.5371 8.75 15.75 8.75V7.5H12C11.1703 7.5 10.5 6.82969 10.5 6V2.25H3C2.5875 2.25 2.25 2.5875 2.25 3V21Z M9.83815 12H5.625C5.00156 12 4.5 12.5016 4.5 13.125C4.5 13.7484 5.00156 14.25 5.625 14.25H8.91109C9.08828 13.4384 9.40626 12.6795 9.83815 12Z M8.78971 16.5H5.625C5.00156 16.5 4.5 17.0016 4.5 17.625C4.5 18.2484 5.00156 18.75 5.625 18.75H9.42363C9.09363 18.0553 8.87467 17.2977 8.78971 16.5Z M21.3756 15.6867C21.3756 16.9416 20.9681 18.1008 20.2818 19.0413L23.7436 22.5052C24.0855 22.8469 24.0855 23.4019 23.7436 23.7437C23.4018 24.0854 22.8467 24.0854 22.5049 23.7437L19.043 20.2797C18.1023 20.9687 16.9429 21.3733 15.6878 21.3733C12.5458 21.3733 10 18.828 10 15.6867C10 12.5453 12.5458 10 15.6878 10C18.8297 10 21.3756 12.5453 21.3756 15.6867ZM15.6878 19.6236C16.2049 19.6236 16.7169 19.5218 17.1947 19.3239C17.6724 19.1261 18.1065 18.8361 18.4721 18.4705C18.8378 18.1049 19.1278 17.6709 19.3257 17.1933C19.5236 16.7156 19.6255 16.2037 19.6255 15.6867C19.6255 15.1697 19.5236 14.6577 19.3257 14.1801C19.1278 13.7024 18.8378 13.2684 18.4721 12.9028C18.1065 12.5373 17.6724 12.2473 17.1947 12.0494C16.7169 11.8516 16.2049 11.7497 15.6878 11.7497C15.1707 11.7497 14.6586 11.8516 14.1809 12.0494C13.7031 12.2473 13.2691 12.5373 12.9034 12.9028C12.5378 13.2684 12.2477 13.7024 12.0498 14.1801C11.8519 14.6577 11.7501 15.1697 11.7501 15.6867C11.7501 16.2037 11.8519 16.7156 12.0498 17.1933C12.2477 17.6709 12.5378 18.1049 12.9034 18.4705C13.2691 18.8361 13.7031 19.1261 14.1809 19.3239C14.6586 19.5218 15.1707 19.6236 15.6878 19.6236Z', + ], + ], +} as IconDefinition; + export const artemisIconPack: IconPack = { facSidebar, facSaveSuccess, facSaveWarning, + facDetails, }; diff --git a/src/main/webapp/i18n/de/metis.json b/src/main/webapp/i18n/de/metis.json index f88d74bce4f9..e6ab066ec220 100644 --- a/src/main/webapp/i18n/de/metis.json +++ b/src/main/webapp/i18n/de/metis.json @@ -27,6 +27,7 @@ "createModalTitleAnswer": "Antwort erstellen", "editPosting": "Inhalt bearbeiten", "edited": "(bearbeitet)", + "saveForLater": "Für später speichern", "markAsResolvingAnswerTooltip": "Bestätige, dass die ursprüngliche Nachricht durch diese Antwort geklärt wird", "resolvingAnswerTooltip": "Die ursprüngliche Nachricht wird durch diese Antwort geklärt", "unmarkAsResolvingAnswerTooltip": "Widerrufe, dass die ursprüngliche Nachricht durch diese Antwort geklärt wird", @@ -94,7 +95,13 @@ "allPublicMessages": "Alle öffentlichen Nachrichten", "searchResults": "Suchergebnisse für {{ search }}", "mobileDisclaimer": "Bitte erst eine Konversation auswählen.", - "mobileDisclaimerCallToAction": "Konversation wählen" + "mobileDisclaimerCallToAction": "Konversation wählen", + "savedPosts": "Gespeicherte Nachrichten", + "progress": "In Bearbeitung", + "completed": "Erledigt", + "archived": "Archiviert", + "emptySavedPosts": "Hier ist noch nichts. Speichere Nachrichten, damit sie hier auftauchen.", + "deleteNoticeSavedPosts": "Erledigte und archivierte Lesezeichen werden nach 100 Tagen gelöscht." }, "post": { "context": "Kontext", @@ -133,7 +140,14 @@ "deleteMessage": "Nachricht löschen", "replyMessage": "Antworten im Thread", "deletedContent": "Beitrag wird in {{ progress }} Sekunde(n) gelöscht.", - "undoDelete": "Löschen umkehren" + "undoDelete": "Löschen umkehren", + "bookmarkPost": "Beitrag speichern", + "removeBookmarkPost": "Beitrag nicht mehr speichern", + "bookmarkPostProgress": "Beitrag als in Bearbeitung speichern", + "bookmarkPostArchived": "Gespeicherten Beitrag archivieren", + "bookmarkPostComplete": "Gespeicherten Beitrag als Abgeschlossen markieren", + "thread": "Thread", + "saved": "Für später gespeichert" }, "answerPost": { "created": "Antwort erfolgreich erstellt", diff --git a/src/main/webapp/i18n/de/programmingExercise.json b/src/main/webapp/i18n/de/programmingExercise.json index 41533417cf1e..9a84f1b04a8e 100644 --- a/src/main/webapp/i18n/de/programmingExercise.json +++ b/src/main/webapp/i18n/de/programmingExercise.json @@ -357,6 +357,7 @@ "filter": "Filter", "noData": "Es konnten keine Feedback Einträge für die Programmieraufgabe gefunden werden.", "noDataFilter": "Für den spezifizierten Filter oder Suchbegriff konnten keine Feedback Einträge gefunden werden.", + "channelSuccess": "Kanal {{channelName}} erfolgreich erstellt.", "feedbackModal": { "header": "Fehlerdetails", "feedbackTitle": "Feedback zu Testfällen", @@ -379,6 +380,36 @@ "repository": "Repository", "totalItems": "Insgesamt {{count}} Element(e)", "error": "Beim Laden der betroffenen Studierenden ist ein Fehler aufgetreten." + }, + "feedbackDetailChannel": { + "title": "Erstelle einen Feedback-Diskussionskanal", + "studentNumber": "Anzahl der Studierende die dem Kanal hinzugefügt werden: {{count}}", + "description": "Dieser Kanal soll Diskussionen über spezifisches Feedback zur bereitgestellten Übung erleichtern. Es ermöglicht allen betroffenen Studierenden und Lehrenden, zusammenzuarbeiten und das Feedback effektiv anzugehen.", + "label": "Kanalname", + "channelVisibility": "Kanal Sichtbarkeit", + "visibilityPublic": "Öffentlich", + "visibilityPrivate": "Privat", + "announcementChannel": "Ankündigungskanal", + "announcementChannelYes": "Ja", + "announcementChannelNo": "Nein", + "createAndNavigateLabel": "Erstellen und Navigieren", + "createAndNavigateDescription": "Erstellt den Kanal und navigiert automatisch zum Kanal.", + "createChannelLabel": "Kanal erstellen:", + "createChannelDescription": "Erstellt den Kanal, ohne die Seite zu verlassen.", + "createChannelButton": "Kanal erstellen", + "placeholder": "Dieses Feld bitte nicht leer lassen", + "descriptionLabel": "Kanalbeschreibung", + "requiredValidationErrorName": "Der Kanalname ist ein Pflichtfeld.", + "maxLengthValidationErrorName": "Kanalname kann max {{ max }} Zeichen lang sein!", + "regexValidationErrorName": "Namen können nur Kleinbuchstaben, Zahlen und Striche enthalten. Nur Artemis kann Kanäle erstellen, die mit $ beginnen.", + "requiredValidationErrorDescription": "Die Kanalbeschreibung ist ein Pflichtfeld.", + "maxLengthValidationErrorDescription": "Kanalbeschreibung kann max {{ max }} Zeichen lang sein!", + "confirmationModal": { + "header": "Kanal Erstellen bestätigen", + "confirmationMessage": "Bist du sicher, dass du diesen Kanal erstellen möchten? Dies wird einen Kanal mit {{count}} Student(en) erstellen.", + "cancel": "Abbrechen", + "confirm": "Erstellen" + } } }, "help": { diff --git a/src/main/webapp/i18n/de/student-dashboard.json b/src/main/webapp/i18n/de/student-dashboard.json index 6c72a925727c..642af5f892fc 100644 --- a/src/main/webapp/i18n/de/student-dashboard.json +++ b/src/main/webapp/i18n/de/student-dashboard.json @@ -67,6 +67,10 @@ "notFound": "Keine Konversation gefunden", "favoriteChannels": "Favoriten", "hiddenChannels": "Ausgeblendet", + "savedPosts": "Gespeicherte Beiträge", + "progress": "In Bearbeitung", + "completed": "Erledigt", + "archived": "Archiviert", "channels": "Kanäle", "generalChannels": "Allgemein", "exerciseChannels": "Aufgaben", diff --git a/src/main/webapp/i18n/en/metis.json b/src/main/webapp/i18n/en/metis.json index 034f9f3b624a..d983860db3c0 100644 --- a/src/main/webapp/i18n/en/metis.json +++ b/src/main/webapp/i18n/en/metis.json @@ -27,6 +27,7 @@ "createModalTitleAnswer": "Create reply", "editPosting": "Edit content", "edited": "(edited)", + "saveForLater": "Save for later", "markAsResolvingAnswerTooltip": "Confirm that this reply resolves the original message", "unmarkAsResolvingAnswerTooltip": "Revoke that this reply resolves the original message", "resolvingAnswerTooltip": "This reply resolves the original message", @@ -94,7 +95,13 @@ "allPublicMessages": "All Public Messages", "searchResults": "Search Results for '{{ search }}'", "mobileDisclaimer": "Please select a conversation first.", - "mobileDisclaimerCallToAction": "Select conversation" + "mobileDisclaimerCallToAction": "Select conversation", + "savedPosts": "Saved Messages", + "progress": "In Progress", + "completed": "Completed", + "archived": "Archived", + "emptySavedPosts": "There is nothing here yet. Bookmark messages and they will appear here.", + "deleteNoticeSavedPosts": "Archived and completed bookmarks will be removed after 100 days." }, "post": { "context": "Context", @@ -133,7 +140,14 @@ "deleteMessage": "Delete message", "replyMessage": "Reply in thread", "deletedContent": "Post is being deleted in {{ progress }} second(s).", - "undoDelete": "Undo delete" + "undoDelete": "Undo delete", + "bookmarkPost": "Save post for later", + "removeBookmarkPost": "Remove bookmark", + "bookmarkPostProgress": "Save post as in progress", + "bookmarkPostArchived": "Archive saved post", + "bookmarkPostComplete": "Mark saved post as done", + "thread": "Thread", + "saved": "Saved for later" }, "answerPost": { "created": "New reply successfully created", diff --git a/src/main/webapp/i18n/en/programmingExercise.json b/src/main/webapp/i18n/en/programmingExercise.json index d3a53f20f180..feff9adb303d 100644 --- a/src/main/webapp/i18n/en/programmingExercise.json +++ b/src/main/webapp/i18n/en/programmingExercise.json @@ -357,6 +357,7 @@ "filter": "Filters", "noData": "No Feedback Entries could be found for the Programming Exercise.", "noDataFilter": "No Feedback Entries could be found for the specified filter or search Term.", + "channelSuccess": "Channel {{channelName}} successfully created.", "feedbackModal": { "header": "Error Details", "feedbackTitle": "Test Case Feedback", @@ -379,6 +380,36 @@ "repository": "Repository", "totalItems": "In total {{count}} item(s)", "error": "There was an error while loading the affected Students for this feedback." + }, + "feedbackDetailChannel": { + "title": "Create Feedback Discussion Channel", + "studentNumber": "Number of students which will be added to the channel: {{count}}", + "description": "This channel is intended to facilitate discussions around specific feedback for the provided exercise feedback. It will allow all affected students and instructors to collaborate and address the feedback effectively.", + "label": "Channel Name", + "channelVisibility": "Channel Visibility", + "visibilityPublic": "Public", + "visibilityPrivate": "Private", + "announcementChannel": "Announcement Channel", + "announcementChannelYes": "Yes", + "announcementChannelNo": "No", + "createAndNavigateLabel": "Create and Navigate", + "createAndNavigateDescription": "Creates the channel and automatically navigates to the channel.", + "createChannelLabel": "Create Channel:", + "createChannelDescription": "Creates the channel without navigating away from this page.", + "createChannelButton": "Create Channel", + "placeholder": "This field should not be empty", + "descriptionLabel": "Description", + "requiredValidationErrorName": "The channel name is required.", + "maxLengthValidationErrorName": "Channel name can be max {{ max }} characters long!", + "regexValidationErrorName": "Names can only contain lowercase letters, numbers, and dashes. Only Artemis can create channels that start with a $.", + "requiredValidationErrorDescription": "The channel description is required.", + "maxLengthValidationErrorDescription": "Channel description can be max {{ max }} characters long!", + "confirmationModal": { + "header": "Confirm Channel Creation", + "confirmationMessage": "Are you sure you want to create this channel? This will create a channel with {{count}} student(s).", + "cancel": "Cancel", + "confirm": "Create" + } } }, "help": { diff --git a/src/main/webapp/i18n/en/student-dashboard.json b/src/main/webapp/i18n/en/student-dashboard.json index 8506e7e5ed8b..eb79ff327373 100644 --- a/src/main/webapp/i18n/en/student-dashboard.json +++ b/src/main/webapp/i18n/en/student-dashboard.json @@ -67,6 +67,10 @@ "notFound": "No conversation found", "favoriteChannels": "Favorites", "hiddenChannels": "Hidden", + "savedPosts": "Saved Messages", + "progress": "In Progress", + "completed": "Completed", + "archived": "Archived", "channels": "Channels", "generalChannels": "General", "exerciseChannels": "Exercises", diff --git a/src/test/java/de/tum/cit/aet/artemis/assessment/ResultServiceIntegrationTest.java b/src/test/java/de/tum/cit/aet/artemis/assessment/ResultServiceIntegrationTest.java index 6b02b3e4d247..b5834d6a66bf 100644 --- a/src/test/java/de/tum/cit/aet/artemis/assessment/ResultServiceIntegrationTest.java +++ b/src/test/java/de/tum/cit/aet/artemis/assessment/ResultServiceIntegrationTest.java @@ -903,4 +903,43 @@ void testGetParticipationForFeedbackId() throws Exception { assertThat(jsonNode.has("empty")).isTrue(); } + @Test + @WithMockUser(username = TEST_PREFIX + "instructor1", roles = "INSTRUCTOR") + void testCountAffectedStudentsByFeedbackDetailText() throws Exception { + StudentParticipation participation1 = participationUtilService.createAndSaveParticipationForExercise(programmingExercise, TEST_PREFIX + "student1"); + StudentParticipation participation2 = participationUtilService.createAndSaveParticipationForExercise(programmingExercise, TEST_PREFIX + "student2"); + Result result1 = participationUtilService.addResultToParticipation(AssessmentType.AUTOMATIC, null, participation1); + Result result2 = participationUtilService.addResultToParticipation(AssessmentType.AUTOMATIC, null, participation2); + participationUtilService.addVariousFeedbackTypeFeedbacksToResult(result1); + ProgrammingExerciseTestCase testCase = programmingExerciseUtilService.addTestCaseToProgrammingExercise(programmingExercise, "test1"); + testCase.setId(1L); + + Feedback feedback1 = new Feedback(); + feedback1.setPositive(false); + feedback1.setDetailText("SampleFeedback"); + feedback1.setTestCase(testCase); + participationUtilService.addFeedbackToResult(feedback1, result1); + + Feedback feedback2 = new Feedback(); + feedback2.setPositive(false); + feedback2.setDetailText("SampleFeedback"); + feedback2.setTestCase(testCase); + participationUtilService.addFeedbackToResult(feedback2, result2); + + String url = "/api/exercises/" + programmingExercise.getId() + "/feedback-detail/affected-students?detailText=SampleFeedback"; + long affectedStudentsCount = request.get(url, HttpStatus.OK, Long.class); + + assertThat(affectedStudentsCount).isInstanceOf(Long.class); + } + + @Test + @WithMockUser(username = TEST_PREFIX + "instructor1", roles = "INSTRUCTOR") + void testCountAffectedStudentsByFeedbackDetailText_NoMatch() throws Exception { + ProgrammingExercise programmingExercise = programmingExerciseUtilService.addProgrammingExerciseToCourse(course); + + String url = "/api/exercises/" + programmingExercise.getId() + "/feedback-detail/affected-students?detailText=NonexistentFeedback"; + long affectedStudentsCount = request.get(url, HttpStatus.OK, Long.class); + + assertThat(affectedStudentsCount).isEqualTo(0); + } } diff --git a/src/test/java/de/tum/cit/aet/artemis/communication/ChannelIntegrationTest.java b/src/test/java/de/tum/cit/aet/artemis/communication/ChannelIntegrationTest.java index c0aa140ae963..3bb88f191080 100644 --- a/src/test/java/de/tum/cit/aet/artemis/communication/ChannelIntegrationTest.java +++ b/src/test/java/de/tum/cit/aet/artemis/communication/ChannelIntegrationTest.java @@ -1,6 +1,7 @@ package de.tum.cit.aet.artemis.communication; import static org.assertj.core.api.Assertions.assertThat; +import static org.assertj.core.api.Fail.fail; import java.time.ZonedDateTime; import java.util.Arrays; @@ -22,6 +23,7 @@ import de.tum.cit.aet.artemis.communication.domain.conversation.Channel; import de.tum.cit.aet.artemis.communication.dto.ChannelDTO; import de.tum.cit.aet.artemis.communication.dto.ChannelIdAndNameDTO; +import de.tum.cit.aet.artemis.communication.dto.FeedbackChannelRequestDTO; import de.tum.cit.aet.artemis.communication.dto.MetisCrudAction; import de.tum.cit.aet.artemis.communication.util.ConversationUtilService; import de.tum.cit.aet.artemis.core.domain.Course; @@ -32,6 +34,8 @@ import de.tum.cit.aet.artemis.lecture.domain.Lecture; import de.tum.cit.aet.artemis.lecture.repository.LectureRepository; import de.tum.cit.aet.artemis.lecture.util.LectureUtilService; +import de.tum.cit.aet.artemis.programming.domain.ProgrammingExercise; +import de.tum.cit.aet.artemis.programming.util.ProgrammingExerciseUtilService; import de.tum.cit.aet.artemis.text.domain.TextExercise; import de.tum.cit.aet.artemis.text.util.TextExerciseUtilService; import de.tum.cit.aet.artemis.tutorialgroup.service.TutorialGroupChannelManagementService; @@ -63,6 +67,9 @@ class ChannelIntegrationTest extends AbstractConversationTest { @Autowired private ConversationUtilService conversationUtilService; + @Autowired + private ProgrammingExerciseUtilService programmingExerciseUtilService; + @BeforeEach @Override void setupTestScenario() throws Exception { @@ -901,6 +908,60 @@ void getLectureChannel_asCourseStudent_shouldGetLectureChannel() throws Exceptio lectureRepository.deleteById(lecture.getId()); } + @Test + @WithMockUser(username = TEST_PREFIX + "student1", roles = "STUDENT") + void createFeedbackChannel_asStudent_shouldReturnForbidden() { + Course course = programmingExerciseUtilService.addCourseWithOneProgrammingExercise(); + ProgrammingExercise programmingExercise = programmingExerciseUtilService.addProgrammingExerciseToCourse(course); + + ChannelDTO channelDTO = new ChannelDTO(); + channelDTO.setName("feedback-channel"); + channelDTO.setDescription("Discussion channel for feedback"); + channelDTO.setIsPublic(true); + channelDTO.setIsAnnouncementChannel(false); + + FeedbackChannelRequestDTO feedbackChannelRequest = new FeedbackChannelRequestDTO(channelDTO, "Sample feedback text"); + + String BASE_ENDPOINT = "api/courses/{courseId}/{exerciseId}/feedback-channel"; + + try { + request.postWithoutResponseBody(BASE_ENDPOINT.replace("{courseId}", course.getId().toString()).replace("{exerciseId}", programmingExercise.getId().toString()), + feedbackChannelRequest, HttpStatus.FORBIDDEN); + } + catch (Exception e) { + fail("There was an error executing the post request.", e); + } + } + + @Test + @WithMockUser(username = TEST_PREFIX + "instructor1", roles = "INSTRUCTOR") + void createFeedbackChannel_asInstructor_shouldCreateChannel() { + Long courseId = 1L; + Long exerciseId = 1L; + ChannelDTO channelDTO = new ChannelDTO(); + channelDTO.setName("feedback-channel"); + channelDTO.setDescription("Discussion channel for feedback"); + channelDTO.setIsPublic(true); + channelDTO.setIsAnnouncementChannel(false); + + FeedbackChannelRequestDTO feedbackChannelRequest = new FeedbackChannelRequestDTO(channelDTO, "Sample feedback text"); + + String BASE_ENDPOINT = "/api/courses/{courseId}/{exerciseId}/feedback-channel"; + + ChannelDTO response = null; + try { + response = request.postWithResponseBody(BASE_ENDPOINT.replace("{courseId}", courseId.toString()).replace("{exerciseId}", exerciseId.toString()), feedbackChannelRequest, + ChannelDTO.class, HttpStatus.CREATED); + } + catch (Exception e) { + fail("Failed to create feedback channel", e); + } + + assertThat(response).isNotNull(); + assertThat(response.getName()).isEqualTo("feedback-channel"); + assertThat(response.getDescription()).isEqualTo("Discussion channel for feedback"); + } + private void testArchivalChangeWorks(ChannelDTO channel, boolean isPublicChannel, boolean shouldArchive) throws Exception { // prepare channel in db if (shouldArchive) { diff --git a/src/test/java/de/tum/cit/aet/artemis/communication/GroupChatIntegrationTest.java b/src/test/java/de/tum/cit/aet/artemis/communication/GroupChatIntegrationTest.java index e349eda63b65..8f9e023fabf7 100644 --- a/src/test/java/de/tum/cit/aet/artemis/communication/GroupChatIntegrationTest.java +++ b/src/test/java/de/tum/cit/aet/artemis/communication/GroupChatIntegrationTest.java @@ -111,6 +111,7 @@ void postInGroupChat_firstPostReceivedByAllMembers() throws Exception { GroupChatDTO chat = createGroupChatWithStudent1To3(); // when var post = this.postInConversation(chat.getId(), "student1"); + post.setIsSaved(false); // then verify(websocketMessagingService, timeout(2000).times(3)).sendMessage(anyString(), (Object) argThat(argument -> argument instanceof PostDTO postDTO && postDTO.post().equals(post))); diff --git a/src/test/java/de/tum/cit/aet/artemis/communication/PostingServiceUnitTest.java b/src/test/java/de/tum/cit/aet/artemis/communication/PostingServiceUnitTest.java index c3673c8a3dfd..554da34e0c7f 100644 --- a/src/test/java/de/tum/cit/aet/artemis/communication/PostingServiceUnitTest.java +++ b/src/test/java/de/tum/cit/aet/artemis/communication/PostingServiceUnitTest.java @@ -11,6 +11,8 @@ import java.lang.reflect.InvocationTargetException; import java.lang.reflect.Method; +import java.util.HashSet; +import java.util.List; import java.util.Set; import org.junit.jupiter.api.AfterEach; @@ -20,8 +22,13 @@ import org.mockito.Mock; import org.mockito.MockitoAnnotations; +import de.tum.cit.aet.artemis.communication.domain.AnswerPost; +import de.tum.cit.aet.artemis.communication.domain.Post; +import de.tum.cit.aet.artemis.communication.domain.PostingType; +import de.tum.cit.aet.artemis.communication.domain.SavedPost; import de.tum.cit.aet.artemis.communication.service.ConversationMessagingService; import de.tum.cit.aet.artemis.communication.service.PostingService; +import de.tum.cit.aet.artemis.communication.test_repository.SavedPostTestRepository; import de.tum.cit.aet.artemis.core.domain.Course; import de.tum.cit.aet.artemis.core.domain.User; import de.tum.cit.aet.artemis.core.exception.BadRequestAlertException; @@ -43,12 +50,51 @@ class PostingServiceUnitTest { private AutoCloseable closeable; + @Mock + private SavedPostTestRepository savedPostRepository; + + private User testUser; + + private Post testPost; + + private SavedPost savedPost; + + private SavedPost savedAnswer; + + private SavedPost savedAnswer2; + @BeforeEach void initTestCase() throws NoSuchMethodException { closeable = MockitoAnnotations.openMocks(this); parseUserMentions = PostingService.class.getDeclaredMethod("parseUserMentions", Course.class, String.class); parseUserMentions.setAccessible(true); + + testUser = new User(); + testUser.setId(1L); + + testPost = new Post(); + testPost.setId(2L); + + AnswerPost testAnswer1 = new AnswerPost(); + testAnswer1.setId(3L); + + AnswerPost testAnswer2 = new AnswerPost(); + testAnswer2.setId(4L); + + Set answers = new HashSet<>(); + answers.add(testAnswer1); + answers.add(testAnswer2); + testPost.setAnswers(answers); + + savedPost = new SavedPost(); + savedPost.setPostId(testPost.getId()); + savedAnswer = new SavedPost(); + savedAnswer.setPostId(testAnswer1.getId()); + savedAnswer2 = new SavedPost(); + savedAnswer2.setPostId(testAnswer2.getId()); + + when(userRepository.getUser()).thenReturn(testUser); } @AfterEach @@ -172,6 +218,46 @@ void testParseUserMentionsMissingClosingTag() throws InvocationTargetException, parseUserMentions.invoke(postingService, course, content); } + @Test + void shouldSetCorrectFlagsWhenPostsAreSaved() { + when(savedPostRepository.findSavedPostIdsByUserIdAndPostType( + testUser.getId(), + PostingType.POST + )).thenReturn(List.of(savedPost.getPostId())); + + when(savedPostRepository.findSavedPostIdsByUserIdAndPostType( + testUser.getId(), + PostingType.ANSWER + )).thenReturn(List.of(savedAnswer.getPostId(), savedAnswer2.getPostId())); + + postingService.preparePostForBroadcast(testPost); + + assertThat(testPost.getIsSaved()).isTrue(); + testPost.getAnswers().forEach(answer -> + assertThat(answer.getIsSaved()).isTrue() + ); + } + + @Test + void shouldSetCorrectFlagsWhenPostsAreNotSaved() { + when(savedPostRepository.findSavedPostIdsByUserIdAndPostType( + testUser.getId(), + PostingType.POST + )).thenReturn(List.of()); + + when(savedPostRepository.findSavedPostIdsByUserIdAndPostType( + testUser.getId(), + PostingType.ANSWER + )).thenReturn(List.of()); + + postingService.preparePostForBroadcast(testPost); + + assertThat(testPost.getIsSaved()).isFalse(); + testPost.getAnswers().forEach(answer -> + assertThat(answer.getIsSaved()).isFalse() + ); + } + /** * Creates a user with the provided name and login * diff --git a/src/test/java/de/tum/cit/aet/artemis/communication/SavedPostResourceIntegrationTest.java b/src/test/java/de/tum/cit/aet/artemis/communication/SavedPostResourceIntegrationTest.java new file mode 100644 index 000000000000..f5870ba3b79d --- /dev/null +++ b/src/test/java/de/tum/cit/aet/artemis/communication/SavedPostResourceIntegrationTest.java @@ -0,0 +1,129 @@ +package de.tum.cit.aet.artemis.communication; + +import static org.hamcrest.Matchers.hasSize; +import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.jsonPath; + +import java.util.ArrayList; +import java.util.List; + +import org.junit.jupiter.api.BeforeEach; +import org.junit.jupiter.api.Test; +import org.springframework.beans.factory.annotation.Autowired; +import org.springframework.security.test.context.support.WithMockUser; +import org.springframework.test.web.servlet.request.MockMvcRequestBuilders; +import org.springframework.test.web.servlet.result.MockMvcResultMatchers; + +import de.tum.cit.aet.artemis.communication.domain.Post; +import de.tum.cit.aet.artemis.communication.domain.PostingType; +import de.tum.cit.aet.artemis.communication.domain.SavedPost; +import de.tum.cit.aet.artemis.communication.domain.SavedPostStatus; +import de.tum.cit.aet.artemis.communication.domain.conversation.Conversation; +import de.tum.cit.aet.artemis.communication.test_repository.SavedPostTestRepository; +import de.tum.cit.aet.artemis.communication.util.ConversationFactory; +import de.tum.cit.aet.artemis.core.domain.User; + +class SavedPostResourceIntegrationTest extends AbstractConversationTest { + + private static final String TEST_PREFIX = "sptest"; + + @Autowired + private SavedPostTestRepository savedPostRepository; + + private User testUser; + + private Post testPost; + + private Conversation conversation; + + @BeforeEach + void setUp() { + testUser = userUtilService.createAndSaveUser(TEST_PREFIX + "student1"); + testPost = ConversationFactory.createBasicPost(1, testUser); + conversation = ConversationFactory.generatePublicChannel(exampleCourse, "Test Channel", true); + conversationRepository.save(conversation); + testPost.setConversation(conversation); + testPost = conversationMessageRepository.save(testPost); + + SavedPost savedPost = ConversationFactory.generateSavedPost(testUser, testPost, PostingType.POST, SavedPostStatus.IN_PROGRESS); + savedPostRepository.save(savedPost); + } + + @Test + @WithMockUser(username = TEST_PREFIX + "student1", roles = "USER") + void shouldReturnPostsWhenGetSavedPostIsCalled() throws Exception { + request.performMvcRequest(MockMvcRequestBuilders.get("/api/saved-posts/" + exampleCourseId + "/" + SavedPostStatus.IN_PROGRESS.getDatabaseKey())) + .andExpect(MockMvcResultMatchers.status().isOk()).andExpect(jsonPath("$", hasSize(1))).andExpect(jsonPath("$[0].id").value(testPost.getId())); + } + + @Test + @WithMockUser(username = TEST_PREFIX + "student1", roles = "USER") + void shouldReturnBadRequestWhenWrongStatusIsSupplied() throws Exception { + request.performMvcRequest(MockMvcRequestBuilders.get("/api/saved-posts/" + exampleCourseId + "/" + 999)).andExpect(MockMvcResultMatchers.status().isBadRequest()) + .andExpect(jsonPath("$.message").value("error.savedPostStatusDoesNotExist")); + } + + @Test + @WithMockUser(username = TEST_PREFIX + "student1", roles = "USER") + void shouldReturnCreatedWhenPostIsBookmarkedAndIsNotBookmarkedYet() throws Exception { + var newTestPost = ConversationFactory.createBasicPost(2, testUser); + newTestPost.setConversation(conversation); + conversationMessageRepository.save(newTestPost); + + request.performMvcRequest(MockMvcRequestBuilders.post("/api/saved-posts/{postId}/{type}", newTestPost.getId(), PostingType.POST.getDatabaseKey())) + .andExpect(MockMvcResultMatchers.status().isCreated()); + + conversationMessageRepository.delete(newTestPost); + } + + @Test + @WithMockUser(username = TEST_PREFIX + "student1", roles = "USER") + void shouldReturnBadRequestWhenWrongTypeIsSupplied() throws Exception { + request.performMvcRequest(MockMvcRequestBuilders.post("/api/saved-posts/{postId}/{type}", testPost.getId(), 999)).andExpect(MockMvcResultMatchers.status().isBadRequest()) + .andExpect(jsonPath("$.message").value("error.savedPostTypeDoesNotExist")); + } + + @Test + @WithMockUser(username = TEST_PREFIX + "student1", roles = "USER") + void shouldReturnMaxPostReachedWhenSavingAndLimitIsReached() throws Exception { + int createEntries = 100; + List savedPosts = new ArrayList<>(); + + for (int i = 0; i < createEntries; i++) { + SavedPost savedPost = ConversationFactory.generateSavedPost(testUser, testPost, PostingType.POST, SavedPostStatus.IN_PROGRESS); + savedPostRepository.save(savedPost); + savedPosts.add(savedPost); + } + + request.performMvcRequest(MockMvcRequestBuilders.post("/api/saved-posts/{postId}/{type}", testPost.getId(), PostingType.POST.getDatabaseKey())) + .andExpect(MockMvcResultMatchers.status().isBadRequest()).andExpect(jsonPath("$.message").value("error.savedPostMaxReached")); + + // Cleanup + savedPostRepository.deleteAll(savedPosts); + } + + @Test + @WithMockUser(username = TEST_PREFIX + "student1", roles = "USER") + void shouldReturnOkWhenUpdatingProperStatus() throws Exception { + request.performMvcRequest(MockMvcRequestBuilders.put("/api/saved-posts/{postId}/{type}?status={status}", testPost.getId(), PostingType.POST.getDatabaseKey(), + SavedPostStatus.COMPLETED.getDatabaseKey())).andExpect(MockMvcResultMatchers.status().isOk()); + } + + @Test + @WithMockUser(username = TEST_PREFIX + "student1", roles = "USER") + void shouldReturnBadRequestWhenUpdatingAndWrongStatusIsSupplied() throws Exception { + request.performMvcRequest(MockMvcRequestBuilders.put("/api/saved-posts/{postId}/{type}?status={status}", testPost.getId(), PostingType.POST.getDatabaseKey(), 999)) + .andExpect(MockMvcResultMatchers.status().isBadRequest()).andExpect(jsonPath("$.message").value("error.savedPostStatusDoesNotExist")); + } + + @Test + @WithMockUser(username = TEST_PREFIX + "student1", roles = "USER") + void shouldReturnNoContentWhenDeletingSavedPost() throws Exception { + request.performMvcRequest(MockMvcRequestBuilders.delete("/api/saved-posts/{postId}/{type}", testPost.getId(), PostingType.POST.getDatabaseKey())) + .andExpect(MockMvcResultMatchers.status().isNoContent()); + } + + @Override + String getTestPrefix() { + return TEST_PREFIX; + } +} diff --git a/src/test/java/de/tum/cit/aet/artemis/communication/notifications/service/MailServiceTest.java b/src/test/java/de/tum/cit/aet/artemis/communication/notifications/service/MailServiceTest.java index b29c998d6ee7..3e2a4f102fb5 100644 --- a/src/test/java/de/tum/cit/aet/artemis/communication/notifications/service/MailServiceTest.java +++ b/src/test/java/de/tum/cit/aet/artemis/communication/notifications/service/MailServiceTest.java @@ -31,6 +31,8 @@ import de.tum.cit.aet.artemis.communication.domain.notification.NotificationConstants; import de.tum.cit.aet.artemis.communication.service.notifications.MailSendingService; import de.tum.cit.aet.artemis.communication.service.notifications.MailService; +import de.tum.cit.aet.artemis.communication.service.notifications.MarkdownCustomLinkRendererService; +import de.tum.cit.aet.artemis.communication.service.notifications.MarkdownCustomReferenceRendererService; import de.tum.cit.aet.artemis.core.domain.Course; import de.tum.cit.aet.artemis.core.domain.User; import de.tum.cit.aet.artemis.core.service.TimeService; @@ -115,7 +117,8 @@ void setUp() throws MalformedURLException, URISyntaxException { mailSendingService = new MailSendingService(jHipsterProperties, javaMailSender); - mailService = new MailService(messageSource, templateEngine, timeService, mailSendingService); + mailService = new MailService(messageSource, templateEngine, timeService, mailSendingService, new MarkdownCustomLinkRendererService(), + new MarkdownCustomReferenceRendererService()); ReflectionTestUtils.setField(mailService, "artemisServerUrl", new URI("http://localhost:8080").toURL()); } diff --git a/src/test/java/de/tum/cit/aet/artemis/communication/notifications/service/MarkdownCustomLinkRendererServiceTest.java b/src/test/java/de/tum/cit/aet/artemis/communication/notifications/service/MarkdownCustomLinkRendererServiceTest.java new file mode 100644 index 000000000000..5fc0cfc27f37 --- /dev/null +++ b/src/test/java/de/tum/cit/aet/artemis/communication/notifications/service/MarkdownCustomLinkRendererServiceTest.java @@ -0,0 +1,71 @@ +package de.tum.cit.aet.artemis.communication.notifications.service; + +import static org.assertj.core.api.Assertions.assertThat; + +import java.net.MalformedURLException; +import java.net.URI; +import java.net.URISyntaxException; + +import org.junit.jupiter.api.BeforeEach; +import org.junit.jupiter.api.Test; +import org.springframework.test.util.ReflectionTestUtils; + +import de.tum.cit.aet.artemis.communication.service.notifications.MarkdownCustomLinkRendererService; + +class MarkdownCustomLinkRendererServiceTest { + + private MarkdownCustomLinkRendererService markdownCustomLinkRendererService; + + @BeforeEach + void setUp() throws MalformedURLException, URISyntaxException { + markdownCustomLinkRendererService = new MarkdownCustomLinkRendererService(); + + ReflectionTestUtils.setField(markdownCustomLinkRendererService, "artemisServerUrl", new URI("http://localhost:8080").toURL()); + } + + @Test + void shouldRenderProperlyWhenProgrammingTagIsSupplied() { + String input = "[programming]Example (/example)[/programming]"; + String expected = "Example"; + + String result = markdownCustomLinkRendererService.render(input); + + assertThat(result).isEqualTo(expected); + } + + @Test + void shouldRenderMultipleTagsWhenMultipleTagsAreSupplied() { + String input = "[programming]Code (/code)[/programming] and [quiz]Quiz (/quiz)[/quiz]"; + String expected = "Code and Quiz"; + + String result = markdownCustomLinkRendererService.render(input); + + assertThat(result).isEqualTo(expected); + } + + @Test + void shouldNotRenderWhenUnsupportedTagsAreSupplied() { + String input = "[unsupported]Text (/unsupported)[/unsupported]"; + String result = markdownCustomLinkRendererService.render(input); + + // Unsupported tags should not be rendered, so the input remains unchanged. + assertThat(result).isEqualTo(input); + } + + @Test + void shouldNotRenderWhenLinkIsOmitted() { + String input = "[programming]Example[/programming]"; + String result = markdownCustomLinkRendererService.render(input); + + // Invalid format should not be rendered, so the input remains unchanged. + assertThat(result).isEqualTo(input); + } + + @Test + void shouldReturnEmptyOutputWhenSuppliedWithEmptyInput() { + String input = ""; + String result = markdownCustomLinkRendererService.render(input); + + assertThat(result).isEmpty(); + } +} diff --git a/src/test/java/de/tum/cit/aet/artemis/communication/notifications/service/MarkdownCustomReferenceRendererServiceTest.java b/src/test/java/de/tum/cit/aet/artemis/communication/notifications/service/MarkdownCustomReferenceRendererServiceTest.java new file mode 100644 index 000000000000..9c7aef13b531 --- /dev/null +++ b/src/test/java/de/tum/cit/aet/artemis/communication/notifications/service/MarkdownCustomReferenceRendererServiceTest.java @@ -0,0 +1,60 @@ +package de.tum.cit.aet.artemis.communication.notifications.service; + +import static org.assertj.core.api.Assertions.assertThat; + +import org.junit.jupiter.api.BeforeEach; +import org.junit.jupiter.api.Test; + +import de.tum.cit.aet.artemis.communication.service.notifications.MarkdownCustomReferenceRendererService; + +class MarkdownCustomReferenceRendererServiceTest { + + private MarkdownCustomReferenceRendererService service; + + @BeforeEach + void setUp() { + service = new MarkdownCustomReferenceRendererService(); + } + + @Test + void shouldRenderUserReferenceWhenValidUserTagProvided() { + String input = "[user]Max Muster(ga1234as)[/user]"; + assertThat(service.render(input)).isEqualTo("@Max Muster"); + } + + @Test + void shouldRenderChannelReferenceWhenValidChannelTagProvided() { + String input = "[channel]General Channel(general)[/channel]"; + assertThat(service.render(input)).isEqualTo("#General Channel"); + } + + @Test + void shouldRenderMultipleReferencesInSingleContent() { + String input = "[user]Max Muster(ga1234as)[/user] and [channel]General Channel(general)[/channel]"; + assertThat(service.render(input)).isEqualTo("@Max Muster and #General Channel"); + } + + @Test + void shouldHandleEmptyContentWithoutError() { + String input = ""; + assertThat(service.render(input)).isEmpty(); + } + + @Test + void shouldReturnOriginalContentWhenNoValidTagsFound() { + String input = "Normal text without tags"; + assertThat(service.render(input)).isEqualTo(input); + } + + @Test + void shouldRenderReferenceWithAdditionalTextBeforeAndAfter() { + String input = "Before [user]Max Muster(ga1234as)[/user] After"; + assertThat(service.render(input)).isEqualTo("Before @Max Muster After"); + } + + @Test + void shouldHandleInvalidTagsGracefully() { + String input = "[invalid]Some Text(reference)[/invalid]"; + assertThat(service.render(input)).isEqualTo(input); + } +} diff --git a/src/test/java/de/tum/cit/aet/artemis/communication/service/SavedPostScheduleServiceTest.java b/src/test/java/de/tum/cit/aet/artemis/communication/service/SavedPostScheduleServiceTest.java new file mode 100644 index 000000000000..f7d6b1c5a132 --- /dev/null +++ b/src/test/java/de/tum/cit/aet/artemis/communication/service/SavedPostScheduleServiceTest.java @@ -0,0 +1,124 @@ +package de.tum.cit.aet.artemis.communication.service; + +import static org.assertj.core.api.Assertions.assertThat; +import static org.mockito.ArgumentMatchers.any; +import static org.mockito.Mockito.never; +import static org.mockito.Mockito.verify; +import static org.mockito.Mockito.when; + +import java.time.ZonedDateTime; +import java.util.ArrayList; +import java.util.List; + +import org.junit.jupiter.api.BeforeEach; +import org.junit.jupiter.api.Test; +import org.junit.jupiter.api.extension.ExtendWith; +import org.mockito.ArgumentCaptor; +import org.mockito.Captor; +import org.mockito.Mock; +import org.mockito.junit.jupiter.MockitoExtension; + +import de.tum.cit.aet.artemis.communication.domain.PostingType; +import de.tum.cit.aet.artemis.communication.domain.SavedPost; +import de.tum.cit.aet.artemis.communication.test_repository.SavedPostTestRepository; + +@ExtendWith(MockitoExtension.class) +class SavedPostScheduleServiceTest { + + @Mock + private SavedPostTestRepository savedPostRepository; + + private SavedPostScheduleService savedPostScheduleService; + + @Captor + private ArgumentCaptor> savedPostCaptor; + + @BeforeEach + void setUp() { + savedPostScheduleService = new SavedPostScheduleService(savedPostRepository); + } + + @Test + void shouldDeleteArchivedSavedPostsWhenDateExceedsCutoff() { + List oldPosts = List.of(createSavedPost(1L, ZonedDateTime.now().minusDays(101)), createSavedPost(2L, ZonedDateTime.now().minusDays(102))); + when(savedPostRepository.findByCompletedAtBefore(any())).thenReturn(oldPosts); + + savedPostScheduleService.cleanupArchivedSavedPosts(); + + verify(savedPostRepository).deleteAll(savedPostCaptor.capture()); + List deletedPosts = savedPostCaptor.getValue(); + assertThat(deletedPosts).hasSize(2); + assertThat(deletedPosts).containsExactlyElementsOf(oldPosts); + } + + @Test + void shouldNotDeleteAnythingWhenNoSavedPostsAreFound() { + when(savedPostRepository.findByCompletedAtBefore(any())).thenReturn(new ArrayList<>()); + + savedPostScheduleService.cleanupArchivedSavedPosts(); + + verify(savedPostRepository, never()).deleteAll(any()); + } + + @Test + void shouldDeleteSavedPostsWhenTheyAreOrphaned() { + // Arrange + List orphanedPosts = List.of(createSavedPost(1L, PostingType.POST), createSavedPost(2L, PostingType.POST)); + when(savedPostRepository.findOrphanedPostReferences()).thenReturn(orphanedPosts); + + // Act + savedPostScheduleService.cleanupOrphanedSavedPosts(); + + // Assert + verify(savedPostRepository).deleteAll(savedPostCaptor.capture()); + List deletedPosts = savedPostCaptor.getValue(); + assertThat(deletedPosts).hasSize(2); + assertThat(deletedPosts).containsExactlyElementsOf(orphanedPosts); + } + + @Test + void shouldNotDeleteAnythingWhenNoOrphanedPostsAreFound() { + when(savedPostRepository.findOrphanedPostReferences()).thenReturn(new ArrayList<>()); + + savedPostScheduleService.cleanupOrphanedSavedPosts(); + + verify(savedPostRepository, never()).deleteAll(any()); + } + + @Test + void shouldDeleteSavedAnswerPostsWhenTheyAreOrphaned() { + List orphanedAnswers = List.of(createSavedPost(1L, PostingType.ANSWER), createSavedPost(2L, PostingType.ANSWER)); + when(savedPostRepository.findOrphanedAnswerReferences()).thenReturn(orphanedAnswers); + + savedPostScheduleService.cleanupOrphanedSavedAnswerPosts(); + + verify(savedPostRepository).deleteAll(savedPostCaptor.capture()); + List deletedPosts = savedPostCaptor.getValue(); + assertThat(deletedPosts).hasSize(2); + assertThat(deletedPosts).containsExactlyElementsOf(orphanedAnswers); + } + + @Test + void shouldNotDeleteAnythingWhenNoOrphanedAnswerPostsAreFound() { + when(savedPostRepository.findOrphanedAnswerReferences()).thenReturn(new ArrayList<>()); + + savedPostScheduleService.cleanupOrphanedSavedAnswerPosts(); + + verify(savedPostRepository, never()).deleteAll(any()); + } + + private SavedPost createSavedPost(Long id, ZonedDateTime completedAt) { + SavedPost savedPost = new SavedPost(); + savedPost.setId(id); + savedPost.setCompletedAt(completedAt); + return savedPost; + } + + private SavedPost createSavedPost(Long id, PostingType postType) { + SavedPost savedPost = new SavedPost(); + savedPost.setId(id); + savedPost.setPostType(postType); + savedPost.setCompletedAt(ZonedDateTime.now()); + return savedPost; + } +} diff --git a/src/test/java/de/tum/cit/aet/artemis/communication/service/SavedPostServiceTest.java b/src/test/java/de/tum/cit/aet/artemis/communication/service/SavedPostServiceTest.java new file mode 100644 index 000000000000..19db6d11d46b --- /dev/null +++ b/src/test/java/de/tum/cit/aet/artemis/communication/service/SavedPostServiceTest.java @@ -0,0 +1,164 @@ +package de.tum.cit.aet.artemis.communication.service; + +import static org.assertj.core.api.Assertions.assertThat; +import static org.mockito.ArgumentMatchers.any; +import static org.mockito.Mockito.never; +import static org.mockito.Mockito.verify; +import static org.mockito.Mockito.when; + +import java.time.ZonedDateTime; +import java.util.List; + +import org.junit.jupiter.api.BeforeEach; +import org.junit.jupiter.api.Test; +import org.junit.jupiter.api.extension.ExtendWith; +import org.mockito.Mock; +import org.mockito.junit.jupiter.MockitoExtension; + +import de.tum.cit.aet.artemis.communication.domain.Post; +import de.tum.cit.aet.artemis.communication.domain.PostingType; +import de.tum.cit.aet.artemis.communication.domain.SavedPost; +import de.tum.cit.aet.artemis.communication.domain.SavedPostStatus; +import de.tum.cit.aet.artemis.communication.test_repository.SavedPostTestRepository; +import de.tum.cit.aet.artemis.core.domain.User; +import de.tum.cit.aet.artemis.core.test_repository.UserTestRepository; + +@ExtendWith(MockitoExtension.class) +class SavedPostServiceTest { + + private SavedPostService savedPostService; + + @Mock + private SavedPostTestRepository savedPostRepository; + + @Mock + private UserTestRepository userRepository; + + private User testUser; + + private Post testPost; + + private SavedPost testSavedPost; + + @BeforeEach + void setUp() { + savedPostService = new SavedPostService(savedPostRepository, userRepository); + + testUser = new User(); + testUser.setId(1L); + + testPost = new Post(); + testPost.setId(1L); + + testSavedPost = new SavedPost(testUser, testPost.getId(), PostingType.POST, SavedPostStatus.IN_PROGRESS, null); + + when(userRepository.getUser()).thenReturn(testUser); + } + + @Test + void shouldSavePostSuccessfullyWhenPostIsNotSavedYet() { + when(savedPostRepository.findSavedPostByUserIdAndPostIdAndPostType( + testUser.getId(), + testPost.getId(), + PostingType.POST + )).thenReturn(null); + + savedPostService.savePostForCurrentUser(testPost); + + verify(savedPostRepository).save(any(SavedPost.class)); + } + + @Test + void shouldNotSavePostWhenPostIsSavedAlready() { + when(savedPostRepository.findSavedPostByUserIdAndPostIdAndPostType( + testUser.getId(), + testPost.getId(), + PostingType.POST + )).thenReturn(testSavedPost); + + savedPostService.savePostForCurrentUser(testPost); + + verify(savedPostRepository, never()).save(any()); + } + + @Test + void shouldRemoveSavedPostWhenPostIsBookmarked() { + when(savedPostRepository.findSavedPostByUserIdAndPostIdAndPostType( + testUser.getId(), + testPost.getId(), + PostingType.POST + )).thenReturn(testSavedPost); + + savedPostService.removeSavedPostForCurrentUser(testPost); + + verify(savedPostRepository).delete(testSavedPost); + } + + @Test + void shouldNotRemoveSavedPostWhenPostIsNotBookmarked() { + when(savedPostRepository.findSavedPostByUserIdAndPostIdAndPostType( + testUser.getId(), + testPost.getId(), + PostingType.POST + )).thenReturn(null); + + savedPostService.removeSavedPostForCurrentUser(testPost); + + verify(savedPostRepository, never()).delete(any()); + } + + @Test + void shouldUpdateStatusAndCompletedAtOfSavedPostWhenPostIsInProgress() { + when(savedPostRepository.findSavedPostByUserIdAndPostIdAndPostType( + testUser.getId(), + testPost.getId(), + PostingType.POST + )).thenReturn(testSavedPost); + + savedPostService.updateStatusOfSavedPostForCurrentUser(testPost, SavedPostStatus.COMPLETED); + + assertThat(testSavedPost.getStatus()).isEqualTo(SavedPostStatus.COMPLETED); + assertThat(testSavedPost.getCompletedAt()).isNotNull(); + verify(savedPostRepository).save(testSavedPost); + } + + @Test + void shouldUpdateStatusAndResetCompletedAtOfSavedPostWhenPostIsSetToInProgress() { + testSavedPost.setCompletedAt(ZonedDateTime.now()); + when(savedPostRepository.findSavedPostByUserIdAndPostIdAndPostType(testUser.getId(), testPost.getId(), PostingType.POST)).thenReturn(testSavedPost); + + savedPostService.updateStatusOfSavedPostForCurrentUser(testPost, SavedPostStatus.IN_PROGRESS); + + assertThat(testSavedPost.getStatus()).isEqualTo(SavedPostStatus.IN_PROGRESS); + assertThat(testSavedPost.getCompletedAt()).isNull(); + verify(savedPostRepository).save(testSavedPost); + } + + @Test + void shouldReturnListFromRepositoryWhenQueriedByCurrentUser() { + SavedPostStatus status = SavedPostStatus.IN_PROGRESS; + when(savedPostRepository.findSavedPostsByUserIdAndStatusOrderByCompletedAtDescIdDesc(testUser.getId(), status)).thenReturn(List.of(testSavedPost)); + + List result = savedPostService.getSavedPostsForCurrentUserByStatus(status); + + assertThat(result).containsExactly(testSavedPost); + } + + @Test + void shouldReturnLimitExceededWhenUserHasToManySavedPosts() { + when(savedPostRepository.countByUserId(testUser.getId())).thenReturn(100L); + + boolean result = savedPostService.isMaximumSavedPostsReached(); + + assertThat(result).isTrue(); + } + + @Test + void shouldReturnLimitNotExceededWhenUserIsBelowThreshold() { + when(savedPostRepository.countByUserId(testUser.getId())).thenReturn(99L); + + boolean result = savedPostService.isMaximumSavedPostsReached(); + + assertThat(result).isFalse(); + } +} diff --git a/src/test/java/de/tum/cit/aet/artemis/communication/test_repository/SavedPostTestRepository.java b/src/test/java/de/tum/cit/aet/artemis/communication/test_repository/SavedPostTestRepository.java new file mode 100644 index 000000000000..8bad5d020cf1 --- /dev/null +++ b/src/test/java/de/tum/cit/aet/artemis/communication/test_repository/SavedPostTestRepository.java @@ -0,0 +1,11 @@ +package de.tum.cit.aet.artemis.communication.test_repository; + +import org.springframework.context.annotation.Primary; +import org.springframework.stereotype.Repository; + +import de.tum.cit.aet.artemis.communication.repository.SavedPostRepository; + +@Repository +@Primary +public interface SavedPostTestRepository extends SavedPostRepository { +} diff --git a/src/test/java/de/tum/cit/aet/artemis/communication/util/ConversationFactory.java b/src/test/java/de/tum/cit/aet/artemis/communication/util/ConversationFactory.java index 4409086389c2..5b4357c7e328 100644 --- a/src/test/java/de/tum/cit/aet/artemis/communication/util/ConversationFactory.java +++ b/src/test/java/de/tum/cit/aet/artemis/communication/util/ConversationFactory.java @@ -7,7 +7,11 @@ import de.tum.cit.aet.artemis.communication.domain.DisplayPriority; import de.tum.cit.aet.artemis.communication.domain.Post; +import de.tum.cit.aet.artemis.communication.domain.Posting; +import de.tum.cit.aet.artemis.communication.domain.PostingType; import de.tum.cit.aet.artemis.communication.domain.Reaction; +import de.tum.cit.aet.artemis.communication.domain.SavedPost; +import de.tum.cit.aet.artemis.communication.domain.SavedPostStatus; import de.tum.cit.aet.artemis.communication.domain.conversation.Channel; import de.tum.cit.aet.artemis.core.domain.Course; import de.tum.cit.aet.artemis.core.domain.User; @@ -110,4 +114,17 @@ public static Channel generatePublicChannel(Course course, String channelName, b channel.setDescription("Test channel"); return channel; } + + /** + * Generates a SavedPost for a given user, posting, posting type and saved post status. + * + * @param user User that bookmarked post + * @param posting Posting to bookmark + * @param postingType Type of posting + * @param savedPostStatus status of posting + * @return The generated SavedPost + */ + public static SavedPost generateSavedPost(User user, Posting posting, PostingType postingType, SavedPostStatus savedPostStatus) { + return new SavedPost(user, posting.getId(), postingType, savedPostStatus, ZonedDateTime.now()); + } } diff --git a/src/test/javascript/spec/component/overview/course-conversations/course-conversations.component.spec.ts b/src/test/javascript/spec/component/overview/course-conversations/course-conversations.component.spec.ts index 40b91216fea7..825d153b7af7 100644 --- a/src/test/javascript/spec/component/overview/course-conversations/course-conversations.component.spec.ts +++ b/src/test/javascript/spec/component/overview/course-conversations/course-conversations.component.spec.ts @@ -10,7 +10,7 @@ import { CourseWideSearchComponent } from 'app/overview/course-conversations/cou import { ConversationMessagesComponent } from 'app/overview/course-conversations/layout/conversation-messages/conversation-messages.component'; import { ConversationThreadSidebarComponent } from 'app/overview/course-conversations/layout/conversation-thread-sidebar/conversation-thread-sidebar.component'; import { Course } from 'app/entities/course.model'; -import { BehaviorSubject, EMPTY } from 'rxjs'; +import { BehaviorSubject, EMPTY, of } from 'rxjs'; import { NgbModal, NgbModalRef } from '@ng-bootstrap/ng-bootstrap'; import { ActivatedRoute, Params, Router, convertToParamMap } from '@angular/router'; import { MockRouter } from '../../../helpers/mocks/mock-router'; @@ -42,6 +42,7 @@ import { ChannelsCreateDialogComponent } from 'app/overview/course-conversations import { ChannelDTO } from 'app/entities/metis/conversation/channel.model'; import { LayoutService } from 'app/shared/breakpoints/layout.service'; import { CustomBreakpointNames } from 'app/shared/breakpoints/breakpoints.service'; +import { Posting, PostingType, SavedPostStatus, SavedPostStatusMap } from 'app/entities/metis/posting.model'; const examples: (ConversationDTO | undefined)[] = [undefined, generateOneToOneChatDTO({}), generateExampleGroupChatDTO({}), generateExampleChannelDTO({})]; @@ -59,6 +60,7 @@ examples.forEach((activeConversation) => { let modalService: NgbModal; let courseSidebarService: CourseSidebarService; let layoutService: LayoutService; + let activatedRoute: ActivatedRoute; const MockLayoutService = { activeBreakpoints: [], @@ -130,6 +132,7 @@ examples.forEach((activeConversation) => { metisConversationService = TestBed.inject(MetisConversationService); courseSidebarService = TestBed.inject(CourseSidebarService); layoutService = TestBed.inject(LayoutService); + activatedRoute = TestBed.inject(ActivatedRoute); Object.defineProperty(metisConversationService, 'isServiceSetup$', { get: () => new BehaviorSubject(true).asObservable() }); Object.defineProperty(metisConversationService, 'conversationsOfUser$', { get: () => new BehaviorSubject([new GroupChatDTO()]).asObservable() }); @@ -431,5 +434,174 @@ examples.forEach((activeConversation) => { expect(prepareSidebarDataSpy).not.toHaveBeenCalled(); }); }); + + describe('query parameter handling', () => { + it('should handle SavedPostStatus in conversationId', () => { + const queryParams = { + conversationId: SavedPostStatusMap.ARCHIVED.toString(), + }; + activatedRoute.queryParams = of(queryParams); + + component.subscribeToQueryParameter(); + + expect(component['selectedSavedPostStatus']).toBe(SavedPostStatus.ARCHIVED); + expect(setActiveConversationSpy).not.toHaveBeenCalled(); + }); + + it('should handle numeric conversationId', () => { + const queryParams = { + conversationId: '123', + }; + activatedRoute.queryParams = of(queryParams); + const spy = jest.spyOn(component, 'closeSidebarOnMobile'); + + component.subscribeToQueryParameter(); + + expect(setActiveConversationSpy).toHaveBeenCalledWith(123); + expect(spy).toHaveBeenCalled(); + }); + + it('should handle focusPostId parameter', () => { + const queryParams = { + focusPostId: '456', + }; + activatedRoute.queryParams = of(queryParams); + + component.subscribeToQueryParameter(); + + expect(component['focusPostId']).toBe(456); + }); + + it('should handle openThreadOnFocus parameter', () => { + const queryParams = { + openThreadOnFocus: 'true', + }; + activatedRoute.queryParams = of(queryParams); + + component.subscribeToQueryParameter(); + + expect(component['openThreadOnFocus']).toBe('true'); + }); + + it('should handle messageId parameter', () => { + const queryParams = { + messageId: '789', + }; + activatedRoute.queryParams = of(queryParams); + + component.subscribeToQueryParameter(); + + expect(component['postInThread']).toEqual({ id: 789 }); + }); + + it('should clear postInThread when no messageId is present', () => { + const queryParams = {}; + activatedRoute.queryParams = of(queryParams); + + component.subscribeToQueryParameter(); + + expect(component['postInThread']).toBeUndefined(); + }); + + it('should handle multiple query parameters together', () => { + const queryParams = { + conversationId: SavedPostStatusMap.ARCHIVED.toString(), + focusPostId: '456', + openThreadOnFocus: 'true', + messageId: '789', + }; + activatedRoute.queryParams = of(queryParams); + + component.subscribeToQueryParameter(); + + expect(component['selectedSavedPostStatus']).toBe(SavedPostStatus.ARCHIVED); + expect(component['focusPostId']).toBe(456); + expect(component['openThreadOnFocus']).toBe('true'); + expect(component['postInThread']).toEqual({ id: 789 }); + }); + }); + + describe('navigate to post functionality', () => { + it('should handle answer post navigation correctly', () => { + const answerPost: Posting = { + referencePostId: 123, + postingType: PostingType.ANSWER, + conversation: { + id: 456, + }, + }; + + component.onNavigateToPost(answerPost); + + expect(component['focusPostId']).toBe(123); + expect(component['openThreadOnFocus']).toBeTrue(); + expect(setActiveConversationSpy).toHaveBeenCalledWith(456); + }); + + it('should handle question post navigation correctly', () => { + const questionPost: Posting = { + referencePostId: 123, + postingType: PostingType.POST, + conversation: { + id: 456, + }, + }; + + component.onNavigateToPost(questionPost); + + expect(component['focusPostId']).toBe(123); + expect(component['openThreadOnFocus']).toBeFalse(); + expect(setActiveConversationSpy).toHaveBeenCalledWith(456); + }); + + it('should not process navigation when referencePostId is undefined', () => { + const invalidPost: Posting = { + postingType: PostingType.POST, + conversation: { + id: 456, + }, + }; + + component.onNavigateToPost(invalidPost); + + expect(setActiveConversationSpy).not.toHaveBeenCalled(); + }); + + it('should not process navigation when conversation id is undefined', () => { + const invalidPost: Posting = { + referencePostId: 123, + postingType: PostingType.POST, + conversation: {}, + }; + + component.onNavigateToPost(invalidPost); + + expect(setActiveConversationSpy).not.toHaveBeenCalled(); + }); + }); + + describe('conversation selection', () => { + it('should handle numeric conversationId', () => { + component.onConversationSelected(123); + expect(component.selectedSavedPostStatus).toBeNull(); + expect(setActiveConversationSpy).toHaveBeenCalledWith(123); + }); + + it('should handle valid string conversationId as SavedPostStatus', () => { + const validStatus = SavedPostStatusMap.ARCHIVED.toString(); + component.onConversationSelected(validStatus); + expect(component.selectedSavedPostStatus).toBe(SavedPostStatus.ARCHIVED); + expect(component.postInThread).toBeUndefined(); + expect(setActiveConversationSpy).toHaveBeenCalledWith(undefined); + expect(component.activeConversation).toBeUndefined(); + }); + + it('should ignore invalid string conversationId', () => { + const invalidStatus = 'invalidStatus'; + component.onConversationSelected(invalidStatus); + expect(component.selectedSavedPostStatus).toBeNull(); + expect(metisConversationService.setActiveConversation).not.toHaveBeenCalled(); + }); + }); }); }); diff --git a/src/test/javascript/spec/component/overview/course-conversations/layout/conversation-messages/conversation-messages.component.spec.ts b/src/test/javascript/spec/component/overview/course-conversations/layout/conversation-messages/conversation-messages.component.spec.ts index 407333ead201..9884da1a010a 100644 --- a/src/test/javascript/spec/component/overview/course-conversations/layout/conversation-messages/conversation-messages.component.spec.ts +++ b/src/test/javascript/spec/component/overview/course-conversations/layout/conversation-messages/conversation-messages.component.spec.ts @@ -162,12 +162,12 @@ examples.forEach((activeConversation) => { const fetchNextPageSpy = jest.spyOn(component, 'fetchNextPage').mockImplementation(() => {}); const existingScrollPosition = 1; - component.goToLastSelectedElement(existingScrollPosition); + component.goToLastSelectedElement(existingScrollPosition, false); tick(); expect(fetchNextPageSpy).not.toHaveBeenCalled(); const nonExistingScrollPosition = 999; - component.goToLastSelectedElement(nonExistingScrollPosition); + component.goToLastSelectedElement(nonExistingScrollPosition, false); tick(); expect(fetchNextPageSpy).toHaveBeenCalled(); diff --git a/src/test/javascript/spec/component/overview/course-conversations/posting-summary.component.spec.ts b/src/test/javascript/spec/component/overview/course-conversations/posting-summary.component.spec.ts new file mode 100644 index 000000000000..450135f6923c --- /dev/null +++ b/src/test/javascript/spec/component/overview/course-conversations/posting-summary.component.spec.ts @@ -0,0 +1,171 @@ +import { ComponentFixture, TestBed, fakeAsync, tick } from '@angular/core/testing'; +import { PostingSummaryComponent } from 'app/overview/course-conversations/posting-summary/posting-summary.component'; +import { Posting, PostingType, SavedPostStatus } from 'app/entities/metis/posting.model'; +import { ConversationType } from 'app/entities/metis/conversation/conversation.model'; +import dayjs from 'dayjs/esm'; +import { ArtemisDatePipe } from 'app/shared/pipes/artemis-date.pipe'; +import { MockComponent, MockPipe } from 'ng-mocks'; +import { FaIconComponent } from '@fortawesome/angular-fontawesome'; +import { ProfilePictureComponent } from 'app/shared/profile-picture/profile-picture.component'; +import { PostingContentComponent } from 'app/shared/metis/posting-content/posting-content.components'; + +describe('PostingSummaryComponent', () => { + let component: PostingSummaryComponent; + let fixture: ComponentFixture; + + const mockPost: Posting = { + id: 1, + author: { + id: 1, + name: 'Test Author', + internal: false, + }, + content: 'Test Content', + postingType: PostingType.POST, + creationDate: dayjs(), + conversation: { + id: 1, + title: 'Test Conversation', + type: ConversationType.CHANNEL, + }, + }; + + beforeEach(async () => { + await TestBed.configureTestingModule({ + declarations: [ + PostingSummaryComponent, + MockPipe(ArtemisDatePipe), + MockComponent(FaIconComponent), + MockComponent(ProfilePictureComponent), + MockComponent(PostingContentComponent), + ], // Changed from imports to declarations + }).compileComponents(); + + fixture = TestBed.createComponent(PostingSummaryComponent); + component = fixture.componentInstance; + }); + + it('should create', () => { + expect(component).toBeTruthy(); + }); + + describe('Input handling', () => { + it('should handle post input', () => { + fixture.componentRef.setInput('post', mockPost); + fixture.detectChanges(); + + // Assert + expect(component['isAnswerPost']).toBeFalsy(); + expect(component['postingIsOfToday']).toBeTruthy(); + }); + + it('should handle undefined post', () => { + fixture.componentRef.setInput('post', undefined); + fixture.detectChanges(); + + expect(component['isAnswerPost']).toBeFalsy(); + }); + }); + + describe('PostingType detection', () => { + it('should detect answer post', () => { + const answerPost = { ...mockPost, postingType: PostingType.ANSWER.valueOf() }; + + fixture.componentRef.setInput('post', answerPost); + fixture.detectChanges(); + + expect(component['isAnswerPost']).toBeTruthy(); + }); + + it('should detect non-answer post', () => { + fixture.componentRef.setInput('post', mockPost); + fixture.detectChanges(); + + expect(component['isAnswerPost']).toBeFalsy(); + }); + }); + + describe('Date handling', () => { + it('should detect post from today', () => { + const todayPost = { ...mockPost, creationDate: dayjs() }; + + fixture.componentRef.setInput('post', todayPost); + fixture.detectChanges(); + + expect(component['postingIsOfToday']).toBeTruthy(); + }); + + it('should detect post not from today', () => { + const yesterdayPost = { ...mockPost, creationDate: dayjs().subtract(1, 'day') }; + + fixture.componentRef.setInput('post', yesterdayPost); + fixture.detectChanges(); + + expect(component['postingIsOfToday']).toBeFalsy(); + }); + }); + + describe('Event emissions', () => { + it('should emit status change', () => { + const emitSpy = jest.spyOn(component.onChangeSavedPostStatus, 'emit'); + const newStatus = SavedPostStatus.ARCHIVED; + + component['onStatusChangeClick'](newStatus); + + expect(emitSpy).toHaveBeenCalledWith(newStatus); + }); + + it('should emit navigation event with post', () => { + const emitSpy = jest.spyOn(component.onNavigateToPost, 'emit'); + fixture.componentRef.setInput('post', mockPost); + + component['onTriggerNavigateToPost'](); + + expect(emitSpy).toHaveBeenCalledWith(mockPost); + }); + + it('should not emit navigation event when post is undefined', () => { + const emitSpy = jest.spyOn(component.onNavigateToPost, 'emit'); + fixture.componentRef.setInput('post', undefined); + + component['onTriggerNavigateToPost'](); + + expect(emitSpy).not.toHaveBeenCalled(); + }); + }); + + describe('Template rendering', () => { + beforeEach(fakeAsync(() => { + fixture.componentRef.setInput('post', mockPost); + fixture.detectChanges(); + tick(); + fixture.detectChanges(); + })); + + it('should render author name', () => { + const authorElement = fixture.nativeElement.querySelector('.posting-summary-author-content'); + expect(authorElement.textContent).toContain(mockPost.author!.name); + }); + + it('should render conversation title', () => { + const conversationElement = fixture.nativeElement.querySelector('.posting-summary-conversation'); + expect(conversationElement.textContent).toContain(mockPost.conversation!.title); + }); + + it('should show saved post options when enabled', () => { + fixture.componentRef.setInput('isShowSavedPostOptions', true); + fixture.detectChanges(); + + const optionsElement = fixture.nativeElement.querySelector('.posting-summary-saved-post-options'); + expect(optionsElement).toBeTruthy(); + }); + + it('should not show saved post options when disabled', () => { + fixture.componentRef.setInput('isShowSavedPostOptions', false); + fixture.detectChanges(); + + const optionsElement = fixture.nativeElement.querySelector('.posting-summary-saved-post-options'); + expect(optionsElement).toBeFalsy(); + }); + }); +}); diff --git a/src/test/javascript/spec/component/overview/course-conversations/saved-posts.component.spec.ts b/src/test/javascript/spec/component/overview/course-conversations/saved-posts.component.spec.ts new file mode 100644 index 000000000000..1d3bd88f6878 --- /dev/null +++ b/src/test/javascript/spec/component/overview/course-conversations/saved-posts.component.spec.ts @@ -0,0 +1,145 @@ +import { ComponentFixture, TestBed, fakeAsync, tick } from '@angular/core/testing'; +import { SavedPostsComponent } from 'app/overview/course-conversations/saved-posts/saved-posts.component'; +import { SavedPostService } from 'app/shared/metis/saved-post.service'; +import { Posting, SavedPostStatus } from 'app/entities/metis/posting.model'; +import { EMPTY, of, throwError } from 'rxjs'; +import { MockComponent, MockDirective } from 'ng-mocks'; +import { HttpResponse } from '@angular/common/http'; +import { TranslateDirective } from 'app/shared/language/translate.directive'; +import { FaIconComponent } from '@fortawesome/angular-fontawesome'; +import { PostingSummaryComponent } from 'app/overview/course-conversations/posting-summary/posting-summary.component'; + +describe('SavedPostsComponent', () => { + let component: SavedPostsComponent; + let fixture: ComponentFixture; + let savedPostService: jest.Mocked; + + const mockPosting: Posting = { + id: 1, + content: 'Test Content', + }; + + const mockPostings: Posting[] = [mockPosting, { id: 2, content: 'Test Content 2' }]; + + beforeEach(async () => { + const mockSavedPostService = { + fetchSavedPosts: jest.fn(), + convertPostingToCorrespondingType: jest.fn((post) => post), + changeSavedPostStatus: jest.fn(), + }; + + await TestBed.configureTestingModule({ + declarations: [SavedPostsComponent, MockDirective(TranslateDirective), MockComponent(FaIconComponent), MockComponent(PostingSummaryComponent)], + providers: [{ provide: SavedPostService, useValue: mockSavedPostService }], + }).compileComponents(); + + savedPostService = TestBed.inject(SavedPostService) as jest.Mocked; + fixture = TestBed.createComponent(SavedPostsComponent); + component = fixture.componentInstance; + }); + + it('should create', () => { + expect(component).toBeTruthy(); + }); + + describe('Initialization', () => { + it('should fetch saved posts successfully', fakeAsync(() => { + const courseId = 123; + const status = SavedPostStatus.PROGRESS; + savedPostService.fetchSavedPosts.mockReturnValue(of(new HttpResponse({ body: mockPostings }))); + + fixture.componentRef.setInput('courseId', courseId); + fixture.componentRef.setInput('savedPostStatus', status); + fixture.detectChanges(); + + expect(savedPostService.fetchSavedPosts).toHaveBeenCalledWith(courseId, status); + expect(component['posts']).toEqual(mockPostings); + expect(component['hiddenPosts']).toEqual([]); + })); + + it('should handle empty response', fakeAsync(() => { + const courseId = 123; + const status = SavedPostStatus.PROGRESS; + savedPostService.fetchSavedPosts.mockReturnValue(of(new HttpResponse({ body: [] }))); + + fixture.componentRef.setInput('courseId', courseId); + fixture.componentRef.setInput('savedPostStatus', status); + fixture.detectChanges(); + + expect(component['posts']).toEqual([]); + })); + + it('should handle error response', fakeAsync(() => { + const courseId = 123; + const status = SavedPostStatus.PROGRESS; + savedPostService.fetchSavedPosts.mockReturnValue(throwError(() => new Error('Test error'))); + + fixture.componentRef.setInput('courseId', courseId); + fixture.componentRef.setInput('savedPostStatus', status); + fixture.detectChanges(); + + expect(component['posts']).toEqual([]); + })); + }); + + describe('Change post status', () => { + it('should update post status and add to hidden posts', fakeAsync(() => { + const newStatus = SavedPostStatus.ARCHIVED; + savedPostService.changeSavedPostStatus.mockReturnValue(of({})); + + component['changeSavedPostStatus'](mockPosting, newStatus); + + expect(savedPostService.changeSavedPostStatus).toHaveBeenCalledWith(mockPosting, SavedPostStatus.ARCHIVED); + expect(component['hiddenPosts']).toContain(mockPosting.id); + })); + }); + + describe('Navigation', () => { + it('should emit post when navigating', () => { + const emitSpy = jest.spyOn(component.onNavigateToPost, 'emit'); + + component['onTriggerNavigateToPost'](mockPosting); + + expect(emitSpy).toHaveBeenCalledWith(mockPosting); + }); + }); + + describe('Template interaction', () => { + beforeEach(async () => { + const status = SavedPostStatus.PROGRESS; + fixture.componentRef.setInput('savedPostStatus', status); + savedPostService.fetchSavedPosts.mockReturnValue(EMPTY); + }); + + it('should show empty notice when no posts are available', () => { + component['posts'] = []; + fixture.detectChanges(); + + const emptyNotice = fixture.nativeElement.querySelector('.saved-posts-empty-notice'); + expect(emptyNotice).toBeTruthy(); + }); + + it('should not show empty notice when posts are available', fakeAsync(() => { + const courseId = 123; + savedPostService.fetchSavedPosts.mockReturnValue(of(new HttpResponse({ body: mockPostings }))); + fixture.componentRef.setInput('courseId', courseId); + fixture.detectChanges(); + tick(); + fixture.detectChanges(); + + const emptyNotice = fixture.nativeElement.querySelector('.saved-posts-empty-notice'); + expect(emptyNotice).toBeFalsy(); + })); + + it('should show delete post notice when archived is selected', fakeAsync(() => { + fixture.componentRef.setInput('savedPostStatus', SavedPostStatus.ARCHIVED); + fixture.detectChanges(); + tick(); + fixture.detectChanges(); + + const optionsElement = fixture.nativeElement.querySelector('.saved-posts-delete-notice'); + expect(component['isShowDeleteNotice']).toBeTruthy(); + expect(optionsElement).toBeTruthy(); + })); + }); +}); diff --git a/src/test/javascript/spec/component/programming-exercise/feedback-analysis/feedback-analysis.component.spec.ts b/src/test/javascript/spec/component/programming-exercise/feedback-analysis/feedback-analysis.component.spec.ts index 09d22ab65dd6..efba3a7ba4de 100644 --- a/src/test/javascript/spec/component/programming-exercise/feedback-analysis/feedback-analysis.component.spec.ts +++ b/src/test/javascript/spec/component/programming-exercise/feedback-analysis/feedback-analysis.component.spec.ts @@ -9,6 +9,10 @@ import { LocalStorageService } from 'ngx-webstorage'; import '@angular/localize/init'; import { FeedbackFilterModalComponent } from 'app/exercises/programming/manage/grading/feedback-analysis/Modal/feedback-filter-modal.component'; import { AffectedStudentsModalComponent } from 'app/exercises/programming/manage/grading/feedback-analysis/Modal/feedback-affected-students-modal.component'; +import { FeedbackDetailChannelModalComponent } from 'app/exercises/programming/manage/grading/feedback-analysis/Modal/feedback-detail-channel-modal.component'; +import { Subject } from 'rxjs'; +import { ChannelDTO } from 'app/entities/metis/conversation/channel.model'; +import { AlertService } from 'app/core/util/alert.service'; describe('FeedbackAnalysisComponent', () => { let fixture: ComponentFixture; @@ -16,6 +20,10 @@ describe('FeedbackAnalysisComponent', () => { let feedbackAnalysisService: FeedbackAnalysisService; let searchSpy: jest.SpyInstance; let localStorageService: LocalStorageService; + let modalService: NgbModal; + let alertService: AlertService; + let modalSpy: jest.SpyInstance; + let createChannelSpy: jest.SpyInstance; const feedbackMock: FeedbackDetail[] = [ { @@ -63,11 +71,27 @@ describe('FeedbackAnalysisComponent', () => { component = fixture.componentInstance; feedbackAnalysisService = fixture.debugElement.injector.get(FeedbackAnalysisService); localStorageService = fixture.debugElement.injector.get(LocalStorageService); + modalService = fixture.debugElement.injector.get(NgbModal); + alertService = fixture.debugElement.injector.get(AlertService); jest.spyOn(localStorageService, 'retrieve').mockReturnValue([]); searchSpy = jest.spyOn(feedbackAnalysisService, 'search').mockResolvedValue(feedbackResponseMock); + const mockFormSubmitted = new Subject<{ channelDto: ChannelDTO; navigate: boolean }>(); + modalSpy = jest.spyOn(TestBed.inject(NgbModal), 'open').mockReturnValue({ + componentInstance: { + formSubmitted: mockFormSubmitted, + affectedStudentsCount: null, + feedbackDetail: null, + }, + result: Promise.resolve(), + } as any); + + jest.spyOn(feedbackAnalysisService, 'getAffectedStudentCount').mockResolvedValue(10); + createChannelSpy = jest.spyOn(feedbackAnalysisService, 'createChannel').mockResolvedValue({ id: 123 } as ChannelDTO); + + jest.spyOn(fixture.debugElement.injector.get(AlertService), 'success'); + jest.spyOn(fixture.debugElement.injector.get(AlertService), 'error'); - // Initial input setup fixture.componentRef.setInput('exerciseId', 1); fixture.componentRef.setInput('exerciseTitle', 'Sample Exercise Title'); @@ -254,4 +278,44 @@ describe('FeedbackAnalysisComponent', () => { expect(modalSpy).toHaveBeenCalledOnce(); }); }); + + it('should open the feedback detail channel modal', async () => { + const formSubmitted = new Subject<{ channelDto: ChannelDTO; navigate: boolean }>(); + const modalRef = { + result: Promise.resolve('mocked result'), + componentInstance: { + formSubmitted, + affectedStudentsCount: null, + feedbackDetail: null, + }, + } as any; + jest.spyOn(modalService, 'open').mockReturnValue(modalRef); + await component.openFeedbackDetailChannelModal(feedbackMock[0]); + expect(modalService.open).toHaveBeenCalledWith(FeedbackDetailChannelModalComponent, { centered: true, size: 'lg' }); + }); + + it('should handle errors during channel creation gracefully', async () => { + const formSubmitted = new Subject<{ channelDto: ChannelDTO; navigate: boolean }>(); + const modalRef = { + result: Promise.resolve('mocked result'), + componentInstance: { + formSubmitted, + affectedStudentsCount: null, + feedbackDetail: null, + }, + } as any; + jest.spyOn(modalService, 'open').mockReturnValue(modalRef); + createChannelSpy.mockRejectedValue(new Error('Error creating channel')); + await component.openFeedbackDetailChannelModal(feedbackMock[0]); + formSubmitted.next({ channelDto: { name: 'Test Channel' } as ChannelDTO, navigate: true }); + expect(alertService.error).toHaveBeenCalledOnce(); + }); + + it('should not proceed if modal is already open', async () => { + component['isFeedbackDetailChannelModalOpen'] = true; + const feedbackDetail = feedbackMock[0]; + await component.openFeedbackDetailChannelModal(feedbackDetail); + expect(component['isFeedbackDetailChannelModalOpen']).toBeTrue(); + expect(modalSpy).not.toHaveBeenCalled(); + }); }); diff --git a/src/test/javascript/spec/component/programming-exercise/feedback-analysis/feedback-analysis.service.spec.ts b/src/test/javascript/spec/component/programming-exercise/feedback-analysis/feedback-analysis.service.spec.ts index 23b9bfaf0f49..45bb903fe421 100644 --- a/src/test/javascript/spec/component/programming-exercise/feedback-analysis/feedback-analysis.service.spec.ts +++ b/src/test/javascript/spec/component/programming-exercise/feedback-analysis/feedback-analysis.service.spec.ts @@ -132,4 +132,61 @@ describe('FeedbackAnalysisService', () => { expect(result.content[1].firstName).toBe('Jane'); }); }); + + describe('getAffectedStudentCount', () => { + it('should retrieve the count of affected students for a feedback detail text', async () => { + const exerciseId = 1; + const feedbackDetailText = 'Test feedback detail'; + const affectedStudentCountMock = 42; + + const responsePromise = service.getAffectedStudentCount(exerciseId, feedbackDetailText); + + const req = httpMock.expectOne(`api/exercises/${exerciseId}/feedback-detail/affected-students?detailText=${encodeURIComponent(feedbackDetailText)}`); + expect(req.request.method).toBe('GET'); + req.flush(affectedStudentCountMock); + + const result = await responsePromise; + expect(result).toBe(affectedStudentCountMock); + }); + }); + + describe('createChannel', () => { + it('should send a POST request to create a feedback-specific channel and return the created channel DTO', async () => { + const courseId = 1; + const exerciseId = 2; + + const channelDtoMock = { + name: 'feedback-channel', + description: 'Discussion channel for feedback', + isPublic: true, + isAnnouncementChannel: false, + }; + + const feedbackChannelRequestMock = { + channel: channelDtoMock, + feedbackDetailText: 'Sample feedback detail text', + }; + + const createdChannelMock = { + id: 1001, + name: 'feedback-channel', + description: 'Discussion channel for feedback', + isPublic: true, + isAnnouncementChannel: false, + }; + + const responsePromise = service.createChannel(courseId, exerciseId, feedbackChannelRequestMock); + + const req = httpMock.expectOne(`api/courses/${courseId}/${exerciseId}/feedback-channel`); + expect(req.request.method).toBe('POST'); + expect(req.request.body).toEqual(feedbackChannelRequestMock); + + req.flush(createdChannelMock); + + const result = await responsePromise; + expect(result).toEqual(createdChannelMock); + expect(result.name).toBe('feedback-channel'); + expect(result.description).toBe('Discussion channel for feedback'); + }); + }); }); diff --git a/src/test/javascript/spec/component/programming-exercise/feedback-analysis/modals/confirm-feedback-channel-creation-modal.component.spec.ts b/src/test/javascript/spec/component/programming-exercise/feedback-analysis/modals/confirm-feedback-channel-creation-modal.component.spec.ts new file mode 100644 index 000000000000..5c59597134d6 --- /dev/null +++ b/src/test/javascript/spec/component/programming-exercise/feedback-analysis/modals/confirm-feedback-channel-creation-modal.component.spec.ts @@ -0,0 +1,39 @@ +import { ComponentFixture, TestBed } from '@angular/core/testing'; +import { ConfirmFeedbackChannelCreationModalComponent } from 'app/exercises/programming/manage/grading/feedback-analysis/Modal/confirm-feedback-channel-creation-modal.component'; +import { NgbActiveModal } from '@ng-bootstrap/ng-bootstrap'; +import { TranslateModule } from '@ngx-translate/core'; + +describe('ConfirmFeedbackChannelCreationModalComponent', () => { + let fixture: ComponentFixture; + let component: ConfirmFeedbackChannelCreationModalComponent; + let activeModal: NgbActiveModal; + + beforeEach(async () => { + await TestBed.configureTestingModule({ + imports: [TranslateModule.forRoot(), ConfirmFeedbackChannelCreationModalComponent], + providers: [NgbActiveModal], + }).compileComponents(); + + fixture = TestBed.createComponent(ConfirmFeedbackChannelCreationModalComponent); + component = fixture.componentInstance; + activeModal = TestBed.inject(NgbActiveModal); + fixture.componentRef.setInput('affectedStudentsCount', 42); + fixture.detectChanges(); + }); + + it('should initialize with the provided affectedStudentsCount', () => { + expect(component.affectedStudentsCount()).toBe(42); + }); + + it('should call close on activeModal with true when confirm is triggered', () => { + const closeSpy = jest.spyOn(activeModal, 'close'); + component.confirm(); + expect(closeSpy).toHaveBeenCalledExactlyOnceWith(true); + }); + + it('should call dismiss on activeModal when dismiss is triggered', () => { + const dismissSpy = jest.spyOn(activeModal, 'dismiss'); + component.dismiss(); + expect(dismissSpy).toHaveBeenCalledOnce(); + }); +}); diff --git a/src/test/javascript/spec/component/programming-exercise/feedback-analysis/modals/feedback-detail-channel-modal.component.spec.ts b/src/test/javascript/spec/component/programming-exercise/feedback-analysis/modals/feedback-detail-channel-modal.component.spec.ts new file mode 100644 index 000000000000..74928d400dd3 --- /dev/null +++ b/src/test/javascript/spec/component/programming-exercise/feedback-analysis/modals/feedback-detail-channel-modal.component.spec.ts @@ -0,0 +1,153 @@ +import { ComponentFixture, TestBed } from '@angular/core/testing'; +import { FeedbackDetailChannelModalComponent } from 'app/exercises/programming/manage/grading/feedback-analysis/Modal/feedback-detail-channel-modal.component'; +import { NgbActiveModal, NgbModal } from '@ng-bootstrap/ng-bootstrap'; +import { FormBuilder, ReactiveFormsModule } from '@angular/forms'; +import { TranslateModule } from '@ngx-translate/core'; + +describe('FeedbackDetailChannelModalComponent', () => { + let fixture: ComponentFixture; + let component: FeedbackDetailChannelModalComponent; + let activeModal: NgbActiveModal; + let modalService: NgbModal; + + beforeEach(async () => { + await TestBed.configureTestingModule({ + imports: [TranslateModule.forRoot(), ReactiveFormsModule, FeedbackDetailChannelModalComponent], + providers: [NgbActiveModal, NgbModal, FormBuilder], + }).compileComponents(); + + fixture = TestBed.createComponent(FeedbackDetailChannelModalComponent); + component = fixture.componentInstance; + activeModal = TestBed.inject(NgbActiveModal); + modalService = TestBed.inject(NgbModal); + + fixture.componentRef.setInput('affectedStudentsCount', 42); + fixture.componentRef.setInput('feedbackDetail', { + detailText: 'Sample feedback', + concatenatedFeedbackIds: [1], + count: 10, + relativeCount: 50, + testCaseName: 'testCase1', + taskName: 'Task 1', + errorCategory: 'StudentError', + } as any); + fixture.componentInstance.isConfirmModalOpen.set(false); + fixture.detectChanges(); + }); + + it('should initialize form and inputs', () => { + expect(component.affectedStudentsCount()).toBe(42); + expect(component.feedbackDetail().detailText).toBe('Sample feedback'); + expect(component.form).toBeDefined(); + expect(component.form.valid).toBeFalse(); + }); + + it('should call activeModal.close when closeModal is triggered', () => { + const closeSpy = jest.spyOn(activeModal, 'close'); + component.closeModal(); + expect(closeSpy).toHaveBeenCalledOnce(); + }); + + it('should call activeModal.dismiss when dismissModal is triggered', () => { + const dismissSpy = jest.spyOn(activeModal, 'dismiss'); + component.dismissModal(); + expect(dismissSpy).toHaveBeenCalledOnce(); + }); + + it('should open confirmation modal and emit formSubmitted on successful confirmation', async () => { + jest.spyOn(component, 'handleModal').mockResolvedValue(true); + + component.form.setValue({ + name: 'channel', + description: 'channelDescription', + isPublic: true, + isAnnouncementChannel: false, + }); + + const formSubmittedSpy = jest.spyOn(component.formSubmitted, 'emit'); + await component.submitForm(false); + + expect(component.isConfirmModalOpen()).toBeFalse(); + expect(formSubmittedSpy).toHaveBeenCalledExactlyOnceWith({ + channelDto: expect.objectContaining({ + creationDate: undefined, + creator: undefined, + description: 'channelDescription', + hasChannelModerationRights: undefined, + hasUnreadMessage: undefined, + id: undefined, + isAnnouncementChannel: false, + isArchived: undefined, + isChannelModerator: undefined, + isCourseWide: undefined, + isCreator: undefined, + isFavorite: undefined, + isHidden: undefined, + isMember: undefined, + isMuted: undefined, + isPublic: true, + lastMessageDate: undefined, + lastReadDate: undefined, + name: 'channel', + numberOfMembers: undefined, + subType: undefined, + subTypeReferenceId: undefined, + topic: undefined, + tutorialGroupId: undefined, + tutorialGroupTitle: undefined, + type: 'channel', + unreadMessagesCount: undefined, + }), + navigate: false, + }); + }); + + it('should call handleModal and proceed if confirmed', async () => { + jest.spyOn(component, 'handleModal').mockResolvedValue(true); + const formSubmittedSpy = jest.spyOn(component.formSubmitted, 'emit'); + + component.form.setValue({ + name: 'channel', + description: 'channelDescription', + isPublic: true, + isAnnouncementChannel: false, + }); + + await component.submitForm(false); + + expect(component.handleModal).toHaveBeenCalledOnce(); + expect(formSubmittedSpy).toHaveBeenCalledExactlyOnceWith({ + channelDto: expect.objectContaining({ + name: 'channel', + description: 'channelDescription', + isPublic: true, + isAnnouncementChannel: false, + }), + navigate: false, + }); + }); + + it('should not proceed if modal is dismissed', async () => { + jest.spyOn(component, 'handleModal').mockResolvedValue(false); + + const formSubmittedSpy = jest.spyOn(component.formSubmitted, 'emit'); + + component.form.setValue({ + name: 'channel', + description: 'channelDescription', + isPublic: true, + isAnnouncementChannel: false, + }); + + await component.submitForm(false); + + expect(component.handleModal).toHaveBeenCalledOnce(); + expect(formSubmittedSpy).not.toHaveBeenCalledOnce(); + }); + + it('should not open confirmation modal if form is invalid', async () => { + const modalSpy = jest.spyOn(modalService, 'open'); + await component.submitForm(true); + expect(modalSpy).not.toHaveBeenCalledOnce(); + }); +}); diff --git a/src/test/javascript/spec/component/shared/metis/answer-post/answer-post.component.spec.ts b/src/test/javascript/spec/component/shared/metis/answer-post/answer-post.component.spec.ts index 247786e4fc12..441b3e4ef382 100644 --- a/src/test/javascript/spec/component/shared/metis/answer-post/answer-post.component.spec.ts +++ b/src/test/javascript/spec/component/shared/metis/answer-post/answer-post.component.spec.ts @@ -15,6 +15,8 @@ import { Reaction } from '../../../../../../../main/webapp/app/entities/metis/re import { BrowserAnimationsModule } from '@angular/platform-browser/animations'; import { MetisService } from 'app/shared/metis/metis.service'; import { MockMetisService } from '../../../../helpers/mocks/service/mock-metis-service.service'; +import { Posting, PostingType } from 'app/entities/metis/posting.model'; +import { AnswerPost } from 'app/entities/metis/answer-post.model'; describe('AnswerPostComponent', () => { let component: AnswerPostComponent; @@ -175,4 +177,24 @@ describe('AnswerPostComponent', () => { expect(component.posting.reactions).toEqual(updatedReactions); }); + + it('should cast the post to answer post on change', () => { + const mockPost: Posting = { + id: 1, + author: { + id: 1, + name: 'Test Author', + internal: false, + }, + content: 'Test Content', + postingType: PostingType.ANSWER, + }; + // @ts-ignore method is private + const spy = jest.spyOn(component, 'assignPostingToAnswerPost'); + component.posting = mockPost; + fixture.detectChanges(); + + expect(component.posting).toBeInstanceOf(AnswerPost); + expect(spy).toHaveBeenCalled(); + }); }); diff --git a/src/test/javascript/spec/component/shared/metis/post/post.component.spec.ts b/src/test/javascript/spec/component/shared/metis/post/post.component.spec.ts index c7c9cf4f24db..6d0a1940a7d9 100644 --- a/src/test/javascript/spec/component/shared/metis/post/post.component.spec.ts +++ b/src/test/javascript/spec/component/shared/metis/post/post.component.spec.ts @@ -36,6 +36,8 @@ import { AnswerPostCreateEditModalComponent } from 'app/shared/metis/posting-cre import { PostReactionsBarComponent } from 'app/shared/metis/posting-reactions-bar/post-reactions-bar/post-reactions-bar.component'; import { BrowserAnimationsModule } from '@angular/platform-browser/animations'; import { DOCUMENT } from '@angular/common'; +import { Posting, PostingType } from 'app/entities/metis/posting.model'; +import { Post } from 'app/entities/metis/post.model'; describe('PostComponent', () => { let component: PostComponent; @@ -320,4 +322,24 @@ describe('PostComponent', () => { expect(component.showDropdown).toBeFalse(); expect(enableBodyScrollSpy).toHaveBeenCalled(); }); + + it('should cast the post to Post on change', () => { + const mockPost: Posting = { + id: 1, + author: { + id: 1, + name: 'Test Author', + internal: false, + }, + content: 'Test Content', + postingType: PostingType.POST, + }; + // @ts-ignore method is private + const spy = jest.spyOn(component, 'assignPostingToPost'); + component.posting = mockPost; + fixture.detectChanges(); + + expect(component.posting).toBeInstanceOf(Post); + expect(spy).toHaveBeenCalled(); + }); }); diff --git a/src/test/javascript/spec/helpers/mocks/service/mock-metis-service.service.ts b/src/test/javascript/spec/helpers/mocks/service/mock-metis-service.service.ts index b96cb2441e8c..5fa7943e5d7e 100644 --- a/src/test/javascript/spec/helpers/mocks/service/mock-metis-service.service.ts +++ b/src/test/javascript/spec/helpers/mocks/service/mock-metis-service.service.ts @@ -60,6 +60,8 @@ export class MockMetisService { deleteReaction(reaction: Reaction): void {} + resetCachedPosts(): void {} + metisUserIsAtLeastTutorInCourse(): boolean { return true; } diff --git a/src/test/javascript/spec/helpers/sample/metis-sample-data.ts b/src/test/javascript/spec/helpers/sample/metis-sample-data.ts index ce2136c46028..89a12b96ad25 100644 --- a/src/test/javascript/spec/helpers/sample/metis-sample-data.ts +++ b/src/test/javascript/spec/helpers/sample/metis-sample-data.ts @@ -162,6 +162,7 @@ export const metisPostExerciseUser1 = { title: 'title', content: 'metisPostExerciseUser1', creationDate: undefined, + isSaved: false, } as Post; export const metisPostExerciseUser2 = { diff --git a/src/test/javascript/spec/service/metis/metis.service.spec.ts b/src/test/javascript/spec/service/metis/metis.service.spec.ts index 7b61efbc958e..17f174695dee 100644 --- a/src/test/javascript/spec/service/metis/metis.service.spec.ts +++ b/src/test/javascript/spec/service/metis/metis.service.spec.ts @@ -46,6 +46,8 @@ import { HttpHeaders, HttpResponse, provideHttpClient } from '@angular/common/ht import { ConversationService } from 'app/shared/metis/conversations/conversation.service'; import { NotificationService } from 'app/shared/notification/notification.service'; import { MockNotificationService } from '../../helpers/mocks/service/mock-notification.service'; +import { SavedPostService } from 'app/shared/metis/saved-post.service'; +import { SavedPostStatus } from 'app/entities/metis/posting.model'; describe('Metis Service', () => { let metisService: MetisService; @@ -63,6 +65,8 @@ describe('Metis Service', () => { let answerPost: AnswerPost; let reaction: Reaction; let course: Course; + let savedPostService: SavedPostService; + let setIsSavedAndStatusOfPostSpy: jest.SpyInstance; beforeEach(() => { TestBed.configureTestingModule({ @@ -89,9 +93,12 @@ describe('Metis Service', () => { postService = TestBed.inject(PostService); answerPostService = TestBed.inject(AnswerPostService); conversationService = TestBed.inject(ConversationService); + savedPostService = TestBed.inject(SavedPostService); metisServiceGetFilteredPostsSpy = jest.spyOn(metisService, 'getFilteredPosts'); metisServiceCreateWebsocketSubscriptionSpy = jest.spyOn(metisService, 'createWebsocketSubscription'); metisServiceUserStub = jest.spyOn(metisService, 'getUser'); + // @ts-ignore method is private + setIsSavedAndStatusOfPostSpy = jest.spyOn(metisService, 'setIsSavedAndStatusOfPost'); post = metisPostExerciseUser1; post.displayPriority = DisplayPriority.PINNED; @@ -624,4 +631,48 @@ describe('Metis Service', () => { expect(metisService.getCurrentConversation()).toBe(metisLectureChannelDTO); }); }); + + describe('Save post methods', () => { + it('should save a post and update cached posts', () => { + const savedPostServiceSpy = jest.spyOn(savedPostService, 'savePost'); + + metisService.createPost(post).subscribe(); + metisService.savePost(post); + + expect(setIsSavedAndStatusOfPostSpy).toHaveBeenCalledWith(post, true, post.savedPostStatus); + expect(savedPostServiceSpy).toHaveBeenCalledWith(post); + }); + + it('should remove a saved post and update cached posts', () => { + const savedPostServiceSpy = jest.spyOn(savedPostService, 'removeSavedPost'); + + metisService.createPost(post).subscribe(); + metisService.removeSavedPost(post); + + expect(setIsSavedAndStatusOfPostSpy).toHaveBeenCalledWith(post, false, post.savedPostStatus); + expect(savedPostServiceSpy).toHaveBeenCalledWith(post); + }); + + it('should change the saved post status and update cached posts', () => { + const status = SavedPostStatus.ARCHIVED; + const savedPostServiceSpy = jest.spyOn(savedPostService, 'changeSavedPostStatus'); + + metisService.createPost(post).subscribe(); + metisService.changeSavedPostStatus(post, status); + + expect(setIsSavedAndStatusOfPostSpy).toHaveBeenCalledWith(post, post.isSaved, status); + expect(savedPostServiceSpy).toHaveBeenCalled(); + }); + + it('should reset cached posts and update total number of posts', () => { + const spyPostsNext = jest.spyOn(metisService['posts$'], 'next'); + const spyNumberOfPostsNext = jest.spyOn(metisService['totalNumberOfPosts$'], 'next'); + metisService.resetCachedPosts(); + + expect(metisService['cachedPosts']).toEqual([]); + expect(spyPostsNext).toHaveBeenCalledWith([]); + expect(metisService['cachedTotalNumberOfPosts']).toBe(0); + expect(spyNumberOfPostsNext).toHaveBeenCalledWith(0); + }); + }); }); diff --git a/src/test/javascript/spec/service/metis/saved-post.service.spec.ts b/src/test/javascript/spec/service/metis/saved-post.service.spec.ts new file mode 100644 index 000000000000..7be01c348743 --- /dev/null +++ b/src/test/javascript/spec/service/metis/saved-post.service.spec.ts @@ -0,0 +1,149 @@ +import { TestBed, fakeAsync, tick } from '@angular/core/testing'; +import { HttpTestingController } from '@angular/common/http/testing'; +import { provideHttpClient } from '@angular/common/http'; +import { SavedPostService } from 'app/shared/metis/saved-post.service'; +import { Post } from 'app/entities/metis/post.model'; +import { Posting, PostingType, SavedPostStatus } from 'app/entities/metis/posting.model'; +import { AnswerPost } from 'app/entities/metis/answer-post.model'; +import { provideHttpClientTesting } from '@angular/common/http/testing'; +import { ConversationType } from 'app/entities/metis/conversation/conversation.model'; +import Dayjs from 'dayjs/esm'; + +describe('SavedPostService', () => { + let service: SavedPostService; + let httpMock: HttpTestingController; + const resourceUrl = 'api/saved-posts/'; + + beforeEach(() => { + TestBed.configureTestingModule({ + imports: [], + providers: [SavedPostService, provideHttpClient(), provideHttpClientTesting()], + }); + + service = TestBed.inject(SavedPostService); + httpMock = TestBed.inject(HttpTestingController); + }); + + it('should create', () => { + expect(service).toBeTruthy(); + }); + + afterEach(() => { + httpMock.verify(); + }); + + describe('Save post', () => { + it('should save a post if given a Post model', () => { + const post = new Post(); + post.id = 1; + + service.savePost(post).subscribe(); + + const req = httpMock.expectOne(`${resourceUrl}1/${PostingType.POST}`); + expect(req.request.method).toBe('POST'); + }); + + it('should save an answer if given AnswerPost model', () => { + const answerPost = new AnswerPost(); + answerPost.id = 1; + + service.savePost(answerPost).subscribe(); + + const req = httpMock.expectOne(`${resourceUrl}1/${PostingType.ANSWER}`); + expect(req.request.method).toBe('POST'); + }); + }); + + describe('Remove saved post', () => { + it('should remove a post when provided with Post model', () => { + const post = new Post(); + post.id = 1; + + service.removeSavedPost(post).subscribe(); + + const req = httpMock.expectOne(`${resourceUrl}1/${PostingType.POST}`); + expect(req.request.method).toBe('DELETE'); + }); + + it('should remove a answer when provided with AnswerPost model', () => { + const answerPost = new AnswerPost(); + answerPost.id = 1; + + service.removeSavedPost(answerPost).subscribe(); + + const req = httpMock.expectOne(`${resourceUrl}1/${PostingType.ANSWER}`); + expect(req.request.method).toBe('DELETE'); + }); + }); + + describe('Update saved post', () => { + it('should update post status to PROGRESS if provided with Post model and PROGRESS', () => { + const post = new Post(); + post.id = 1; + + service.changeSavedPostStatus(post, SavedPostStatus.PROGRESS).subscribe(); + + const req = httpMock.expectOne(`${resourceUrl}1/${PostingType.POST}?status=${SavedPostStatus.PROGRESS}`); + expect(req.request.method).toBe('PUT'); + }); + + it('should update answer post status to COMPLETED if provided with AnswerPost model and COMPLETED', () => { + const answerPost = new AnswerPost(); + answerPost.id = 1; + + service.changeSavedPostStatus(answerPost, SavedPostStatus.COMPLETED).subscribe(); + + const req = httpMock.expectOne(`${resourceUrl}1/${PostingType.ANSWER}?status=${SavedPostStatus.COMPLETED}`); + expect(req.request.method).toBe('PUT'); + }); + }); + + describe('Fetch saved posts', () => { + it('should fetch saved posts and convert dates accordingly', fakeAsync(() => { + const courseId = 1; + const status = SavedPostStatus.PROGRESS; + const mockPosts = [ + { + id: 1, + creationDate: '2024-03-20T10:00:00Z', + updatedDate: '2024-03-20T11:00:00Z', + conversation: { id: 1, type: ConversationType.CHANNEL }, + }, + ]; + + const fetchPost = service.fetchSavedPosts(courseId, status).subscribe((response) => { + expect(response.body?.[0].conversation?.type).toBe(ConversationType.CHANNEL); + expect(response.body?.[0].creationDate).toBeInstanceOf(Dayjs); + expect(response.body?.[0].updatedDate).toBeInstanceOf(Dayjs); + }); + + const req = httpMock.expectOne(`${resourceUrl}1/${SavedPostStatus.PROGRESS}`); + expect(req.request.method).toBe('GET'); + req.flush(mockPosts, { status: 200, statusText: 'OK' }); + tick(); + fetchPost.unsubscribe(); + })); + }); + + describe('Conversions of posts', () => { + it('should convert posting to Post type', () => { + const posting: Posting = { + id: 1, + postingType: PostingType.POST, + } as Posting; + + const result = service.convertPostingToCorrespondingType(posting); + expect(result).toBeInstanceOf(Post); + }); + + it('should convert posting to AnswerPost type', () => { + const posting: Posting = { + id: 1, + postingType: PostingType.ANSWER, + } as Posting; + + const result = service.convertPostingToCorrespondingType(posting); + expect(result).toBeInstanceOf(AnswerPost); + }); + }); +}); diff --git a/src/test/playwright/e2e/exam/ExamParticipation.spec.ts b/src/test/playwright/e2e/exam/ExamParticipation.spec.ts index 0e137ed96528..f8a08642e70e 100644 --- a/src/test/playwright/e2e/exam/ExamParticipation.spec.ts +++ b/src/test/playwright/e2e/exam/ExamParticipation.spec.ts @@ -11,7 +11,9 @@ import { ExamStartEndPage } from '../../support/pageobjects/exam/ExamStartEndPag import { Commands } from '../../support/commands'; import { ExamAPIRequests } from '../../support/requests/ExamAPIRequests'; import { ModalDialogBox } from '../../support/pageobjects/exam/ModalDialogBox'; -import { ExamParticipationActions } from '../../support/pageobjects/exam/ExamParticipationActions'; +import { ExamParticipationActions, TextDifferenceType } from '../../support/pageobjects/exam/ExamParticipationActions'; +import { ExamNavigationBar } from '../../support/pageobjects/exam/ExamNavigationBar'; +import textExerciseTemplate from '../../fixtures/exercise/text/template.json'; // Common primitives const textFixture = 'loremIpsum.txt'; @@ -261,11 +263,12 @@ test.describe('Exam participation', () => { test.describe('Exam announcements', { tag: '@slow' }, () => { let exam: Exam; const students = [studentOne, studentTwo]; + let exercise: Exercise; test.beforeEach('Create exam', async ({ login, examAPIRequests, examExerciseGroupCreation }) => { await login(admin); exam = await createExam(course, examAPIRequests); - const exercise = await examExerciseGroupCreation.addGroupWithExercise(exam, ExerciseType.TEXT, { textFixture }); + exercise = await examExerciseGroupCreation.addGroupWithExercise(exam, ExerciseType.TEXT, { textFixture }); exerciseArray.push(exercise); for (const student of students) { await examAPIRequests.registerStudentForExam(exam, student); @@ -347,6 +350,61 @@ test.describe('Exam participation', () => { await examParticipationActions.checkExamTimeLeft('29'); } }); + + test( + 'Instructor changes problem statement and all participants are informed', + { tag: '@fast' }, + async ({ browser, login, navigationBar, courseManagement, examManagement, examExerciseGroups, editExam, textExerciseCreation }) => { + await login(instructor); + await navigationBar.openCourseManagement(); + await courseManagement.openExamsOfCourse(course.id!); + await examManagement.openExam(exam.id!); + + const studentPages = []; + + for (const student of students) { + const studentContext = await browser.newContext(); + const studentPage = await studentContext.newPage(); + studentPages.push(studentPage); + + await Commands.login(studentPage, student); + await studentPage.goto(`/courses/${course.id!}/exams/${exam.id!}`); + const examStartEnd = new ExamStartEndPage(studentPage); + await examStartEnd.startExam(false); + const examNavigation = new ExamNavigationBar(studentPage); + await examNavigation.openOrSaveExerciseByTitle(exercise.exerciseGroup!.title!); + } + + await editExam.openExerciseGroups(); + await examExerciseGroups.clickEditExercise(exercise.exerciseGroup!.id!, exercise.id!); + + const problemStatementText = textExerciseTemplate.problemStatement; + const startOfChangesIndex = problemStatementText.lastIndexOf(' ') + 1; + const removedText = problemStatementText.slice(startOfChangesIndex); + const unchangedText = problemStatementText.slice(0, startOfChangesIndex); + const addedText = 'Changed'; + await textExerciseCreation.clearProblemStatement(); + await textExerciseCreation.typeProblemStatement(unchangedText + addedText); + await textExerciseCreation.create(); + + for (const studentPage of studentPages) { + const modalDialog = new ModalDialogBox(studentPage); + const exerciseUpdateMessage = `The problem statement of the exercise '${exercise.exerciseGroup!.title!}' was updated. Please open the exercise to see the changes.`; + await modalDialog.checkDialogType('Problem Statement Update'); + await modalDialog.checkDialogMessage(exerciseUpdateMessage); + await modalDialog.checkDialogAuthor(instructor.username); + await modalDialog.pressModalButton('Navigate to exercise'); + const examParticipationActions = new ExamParticipationActions(studentPage); + await examParticipationActions.checkExerciseProblemStatementDifference([ + { text: unchangedText, differenceType: TextDifferenceType.NONE }, + { text: removedText, differenceType: TextDifferenceType.DELETE }, + { text: addedText, differenceType: TextDifferenceType.ADD }, + ]); + await studentPage.locator('#highlightDiffButton').click(); + await examParticipationActions.checkExerciseProblemStatementDifference([{ text: unchangedText + addedText, differenceType: TextDifferenceType.NONE }]); + } + }, + ); }); test.afterEach('Delete course', async ({ courseManagementAPIRequests }) => { diff --git a/src/test/playwright/support/fixtures.ts b/src/test/playwright/support/fixtures.ts index dbf28d32cc37..24d95e944326 100644 --- a/src/test/playwright/support/fixtures.ts +++ b/src/test/playwright/support/fixtures.ts @@ -67,6 +67,7 @@ import { QuizExerciseOverviewPage } from './pageobjects/exercises/quiz/QuizExerc import { QuizExerciseParticipationPage } from './pageobjects/exercises/quiz/QuizExerciseParticipationPage'; import { ModalDialogBox } from './pageobjects/exam/ModalDialogBox'; import { ExamParticipationActions } from './pageobjects/exam/ExamParticipationActions'; +import { EditExamPage } from './pageobjects/exam/EditExamPage'; /* * Define custom types for fixtures @@ -96,6 +97,7 @@ export type ArtemisPageObjects = { courseCommunication: CourseCommunicationPage; lectureManagement: LectureManagementPage; lectureCreation: LectureCreationPage; + editExam: EditExamPage; examCreation: ExamCreationPage; examDetails: ExamDetailsPage; examExerciseGroupCreation: ExamExerciseGroupCreationPage; @@ -219,6 +221,9 @@ export const test = base.extend { await use(new LectureCreationPage(page)); }, + editExam: async ({ page }, use) => { + await use(new EditExamPage(page)); + }, examCreation: async ({ page }, use) => { await use(new ExamCreationPage(page)); }, diff --git a/src/test/playwright/support/pageobjects/exam/EditExamPage.ts b/src/test/playwright/support/pageobjects/exam/EditExamPage.ts new file mode 100644 index 000000000000..69608a61522c --- /dev/null +++ b/src/test/playwright/support/pageobjects/exam/EditExamPage.ts @@ -0,0 +1,13 @@ +import { Page } from '@playwright/test'; + +export class EditExamPage { + private readonly page: Page; + + constructor(page: Page) { + this.page = page; + } + + async openExerciseGroups() { + await this.page.locator(`#exercises-button-groups-table`).click(); + } +} diff --git a/src/test/playwright/support/pageobjects/exam/ExamExerciseGroupsPage.ts b/src/test/playwright/support/pageobjects/exam/ExamExerciseGroupsPage.ts index 4e4379f12817..9eb57e9fbc83 100644 --- a/src/test/playwright/support/pageobjects/exam/ExamExerciseGroupsPage.ts +++ b/src/test/playwright/support/pageobjects/exam/ExamExerciseGroupsPage.ts @@ -60,6 +60,10 @@ export class ExamExerciseGroupsPage { await this.page.locator(`#group-${groupID} .add-programming-exercise`).click(); } + async clickEditExercise(groupID: number, exerciseID: number) { + await this.page.locator(`#group-${groupID} #exercise-${exerciseID}`).locator('.btn', { hasText: 'Edit' }).click(); + } + async visitPageViaUrl(courseId: number, examId: number) { await this.page.goto(`course-management/${courseId}/exams/${examId}/exercise-groups`); } diff --git a/src/test/playwright/support/pageobjects/exam/ExamParticipationActions.ts b/src/test/playwright/support/pageobjects/exam/ExamParticipationActions.ts index a7be0510b65a..0fee7970a6ea 100644 --- a/src/test/playwright/support/pageobjects/exam/ExamParticipationActions.ts +++ b/src/test/playwright/support/pageobjects/exam/ExamParticipationActions.ts @@ -24,6 +24,31 @@ export class ExamParticipationActions { await expect(exercise.locator('.exercise-title')).toContainText(title); } + async checkExerciseProblemStatementDifference(differenceSlices: TextDifferenceSlice[]) { + const problemStatementCard = this.page.locator('.card', { hasText: 'Problem Statement' }); + const problemStatementText = problemStatementCard.locator('.markdown-preview').locator('p'); + + if ((await problemStatementText.locator('.diffmod').count()) > 0) { + for (const slice of differenceSlices) { + switch (slice.differenceType) { + case TextDifferenceType.ADD: + await expect(problemStatementText.locator('ins').getByText(slice.text)).toBeVisible(); + break; + case TextDifferenceType.DELETE: + await expect(problemStatementText.locator('del').getByText(slice.text)).toBeVisible(); + break; + case TextDifferenceType.NONE: + await expect(problemStatementText).toContainText(slice.text); + break; + } + } + } else { + const firstSlice = differenceSlices[0]; + expect(firstSlice.differenceType).toBe(TextDifferenceType.NONE); + await expect(problemStatementText).toHaveText(firstSlice.text); + } + } + async checkExamTitle(title: string) { await expect(this.page.locator('#exam-title')).toContainText(title); } @@ -89,3 +114,16 @@ export class ExamParticipationActions { await expect(gradingKeyCard.locator('tr.highlighted').locator('td', { hasText: gradeName })).toBeVisible(); } } + +export class TextDifferenceSlice { + constructor( + public text: string, + public differenceType: TextDifferenceType, + ) {} +} + +export enum TextDifferenceType { + NONE, + ADD, + DELETE, +} diff --git a/src/test/playwright/support/pageobjects/exam/ModalDialogBox.ts b/src/test/playwright/support/pageobjects/exam/ModalDialogBox.ts index 77d7a06f2168..54de2cf3f068 100644 --- a/src/test/playwright/support/pageobjects/exam/ModalDialogBox.ts +++ b/src/test/playwright/support/pageobjects/exam/ModalDialogBox.ts @@ -24,6 +24,10 @@ export class ModalDialogBox { await expect(this.getModalDialogContent().locator('.content').getByText(message)).toBeVisible(); } + async checkDialogType(type: string) { + await expect(this.getModalDialogContent().locator('.type').getByText(type)).toBeVisible(); + } + async checkDialogAuthor(authorUsername: string) { await expect(this.getModalDialogContent().locator('.author').getByText(authorUsername)).toBeVisible(); } @@ -37,4 +41,12 @@ export class ModalDialogBox { async closeDialog() { await this.getModalDialogContent().locator('button').click({ force: true }); } + + async pressModalButton(buttonText: string) { + let buttonLocator = this.getModalDialogContent().locator('button'); + if (buttonText) { + buttonLocator = buttonLocator.filter({ hasText: buttonText }); + } + await buttonLocator.click(); + } } diff --git a/src/test/playwright/support/pageobjects/exercises/text/TextExerciseCreationPage.ts b/src/test/playwright/support/pageobjects/exercises/text/TextExerciseCreationPage.ts index 7d13e7ee1101..b2c934b7f3f6 100644 --- a/src/test/playwright/support/pageobjects/exercises/text/TextExerciseCreationPage.ts +++ b/src/test/playwright/support/pageobjects/exercises/text/TextExerciseCreationPage.ts @@ -1,4 +1,4 @@ -import { Page } from '@playwright/test'; +import { Locator, Page } from '@playwright/test'; import { Dayjs } from 'dayjs'; import { enterDate } from '../../../utils'; import { TEXT_EXERCISE_BASE } from '../../../constants'; @@ -6,6 +6,10 @@ import { TEXT_EXERCISE_BASE } from '../../../constants'; export class TextExerciseCreationPage { private readonly page: Page; + private readonly PROBLEM_STATEMENT_SELECTOR = '#problemStatement'; + private readonly EXAMPLE_SOLUTION_SELECTOR = '#exampleSolution'; + private readonly ASSESSMENT_INSTRUCTIONS_SELECTOR = '#gradingInstructions'; + constructor(page: Page) { this.page = page; } @@ -33,15 +37,33 @@ export class TextExerciseCreationPage { } async typeProblemStatement(statement: string) { - await this.typeText('#problemStatement', statement); + const textEditor = this.getTextEditorLocator(this.PROBLEM_STATEMENT_SELECTOR); + await this.typeText(textEditor, statement); + } + + async clearProblemStatement() { + const textEditor = this.getTextEditorLocator(this.PROBLEM_STATEMENT_SELECTOR); + await this.clearText(textEditor); } async typeExampleSolution(statement: string) { - await this.typeText('#exampleSolution', statement); + const textEditor = this.getTextEditorLocator(this.EXAMPLE_SOLUTION_SELECTOR); + await this.typeText(textEditor, statement); + } + + async clearExampleSolution() { + const textEditor = this.getTextEditorLocator(this.EXAMPLE_SOLUTION_SELECTOR); + await this.clearText(textEditor); } async typeAssessmentInstructions(statement: string) { - await this.typeText('#gradingInstructions', statement); + const textEditor = this.getTextEditorLocator(this.ASSESSMENT_INSTRUCTIONS_SELECTOR); + await this.typeText(textEditor, statement); + } + + async clearAssessmentInstructions() { + const textEditor = this.getTextEditorLocator(this.ASSESSMENT_INSTRUCTIONS_SELECTOR); + await this.clearText(textEditor); } async create() { @@ -56,9 +78,18 @@ export class TextExerciseCreationPage { return await responsePromise; } - private async typeText(selector: string, text: string) { - const textField = this.page.locator(selector).locator('.monaco-editor'); - await textField.click(); - await textField.pressSequentially(text); + private getTextEditorLocator(selector: string) { + return this.page.locator(selector).locator('.monaco-editor'); + } + + private async clearText(textEditor: Locator) { + await textEditor.click(); + await textEditor.press('Control+a'); + await textEditor.press('Backspace'); + } + + private async typeText(textEditor: Locator, text: string) { + await textEditor.click(); + await textEditor.pressSequentially(text); } }