Communication: Remove announcements from unresolved filter

[cremertim]

Checklist

General

• I tested all changes and their related features with all corresponding user types on a test server.
• This is a small issue that I tested locally and was confirmed by another developer on a test server.
• Language: I followed the guidelines for inclusive, diversity-sensitive, and appreciative language.
• I chose a title conforming to the naming conventions for pull requests.

Client

• Important: I implemented the changes with a very good performance, prevented too many (unnecessary) REST calls and made sure the UI is responsive, even with large data (e.g. using paging).
• I added multiple integration tests (Jest) related to the features (with a high test coverage), while following the test guidelines.

Motivation and Context

Description

I removed the announcement channel from the courseWidesearch, if the user looks for unresolved questions

Steps for Testing

Prerequisites:

• 1 Instructor
• 1 Course with Communication enabled

1. Log in to Artemis
2. Navigate to Course Management
3. Create an Announcement
4. Use the course wide search to search for that announcement
5. verify the announcement is present
6. click on the unresolved filter
7. verify the announcement is not present

Testserver States

Note

These badges show the state of the test servers.
Green = Currently available, Red = Currently locked
Click on the badges to get to the test servers.

Review Progress

Code Review

• Code Review 1
• Code Review 2

Manual Tests

• Test 1
• Test 2

Test Coverage

Class/File	Line Coverage	Confirmation (assert/expect)
course-wide-search.component.ts	97.53%	✅

Screenshots

Unticked unresolved --> you can see the announcement

Ticked unresolved --> you cannot see the announcement

Summary by CodeRabbit

• New Features

  • Introduced a new method to identify announcement channels in course conversations.
  • Enhanced filtering logic to exclude announcement channels when viewing unresolved conversations.

• Bug Fixes

  • Improved accuracy of channel ID filtering in the course-wide search functionality.

[coderabbitai]

Walkthrough

The changes in this pull request modify the CourseWideSearchComponent to enhance the filtering logic for conversations. A new method, conversationIsAnnouncement, is introduced to identify announcement channels. The component's subscription to conversationsOfUser$ is updated to filter out announcement channels when the filterToUnresolved flag is true. Additionally, the currentPostContextFilter is updated to include a new property, courseWideChannelIds, populated based on the filtered conversations.

Changes

File Path	Change Summary
src/main/webapp/app/overview/course-conversations/course-wide-search/course-wide-search.component.ts	- Added ChannelDTO import. - Introduced conversationIsAnnouncement method. - Updated logic for populating courseWideChannelIds in currentPostContextFilter to filter out announcement channels when filterToUnresolved is true.

Possibly related PRs

• Communication: Fix an issue where the client does not keep track of the posts on screen #8990: Modifies logic in course-wide-search.component.html, which is directly related to the changes made in the course-wide-search.component.ts of the main PR, enhancing the handling of posts in the context of search operations.
• Communication: Fix user interface reload on channel selection #9464: Involves changes to the course-wide-search.component, specifically addressing the loading behavior and UI updates when selecting communication channels, which aligns with the filtering logic introduced in the main PR.

Suggested labels

ready for review, small, bugfix, component:Communication

Suggested reviewers

• krusche
• PaRangger
• egekurt123

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai or @coderabbitai title anywhere in the PR title to generate the title automatically.

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[coderabbitai]

Actionable comments posted: 1

🧹 Outside diff range and nitpick comments (1)

src/main/webapp/app/overview/course-conversations/course-wide-search/course-wide-search.component.ts (1)

164-170: Specify the return type for conversationIsAnnouncement method

For better code clarity and type safety, consider adding an explicit return type to the conversationIsAnnouncement method.

Apply this diff to add the return type:

- conversationIsAnnouncement(conversation: ConversationDTO) {
+ conversationIsAnnouncement(conversation: ConversationDTO): boolean {

📜 Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between f3eaf6d and 8ad5228.

📒 Files selected for processing (1)

• src/main/webapp/app/overview/course-conversations/course-wide-search/course-wide-search.component.ts (2 hunks)

🧰 Additional context used

📓 Path-based instructions (1)

src/main/webapp/app/overview/course-conversations/course-wide-search/course-wide-search.component.ts (1)

Pattern src/main/webapp/**/*.ts: angular_style:https://angular.io/guide/styleguide;methods_in_html:false;lazy_loading:true;code_reuse:true;tests:meaningful;types:PascalCase;enums:PascalCase;funcs:camelCase;props:camelCase;no_priv_prefix:true;strings:single_quotes;localize:true;btns:functionality;links:navigation;icons_text:newline;labels:associate;code_style:arrow_funcs,curly_braces,open_braces_same_line,indent_4;memory_leak_prevention:true;routes:naming_schema;chart_framework:ngx-charts;responsive_layout:true

🔇 Additional comments (1)

src/main/webapp/app/overview/course-conversations/course-wide-search/course-wide-search.component.ts (1)

20-20: Necessary import of ChannelDTO

The addition of ChannelDTO to the import statement is required for type assertions in the conversationIsAnnouncement method.

[PaRangger]

Code LGTM and works just as described 👍🏼

[krusche]

Code looks good to me 👍

[florian-glombik]

I followed the testing steps and it worked as described.

One thing that surprised me, I was first searching for the title of the announcement, but the search does only seem to include the content. Can we extend this in the future?

[github-actions]

⚠️ Unable to deploy to test servers ⚠️

Testserver "artemis-test4.artemis.cit.tum.de" is already in use by PR #9553.

[Cathy0123456789]

Tested on TS5. Works as described.