`Communication`: Add conversation and author selection to search bar #10661

FelberMartin · 2025-04-10T13:06:57Z

Checklist

General

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 strictly followed the principle of data economy for all client-server REST calls.
I strictly followed the client coding and design guidelines.
Following the theming guidelines, I specified colors only in the theming variable files and checked that the changes look consistent in both the light and the dark theme.
I added multiple integration tests (Jest) related to the features (with a high test coverage), while following the test guidelines.
I documented the TypeScript code using JSDoc style.
I added multiple screenshots/screencasts of my UI changes.
I translated all newly inserted strings into English and German.

Motivation and Context

With #10601 we adapted the messages endpoint to allow for searching messages with a specific author or in specific channels. This PR introduces the frontend changes to make this new functionality available in the web UI.

Description

In the search bar you can search for messages by an author with typing "by: ..." and selecting the author
We removed the filterToOwn checkbox. Instead you can search for "by:me" or "by:" with your username
Search within a conversation by typing "in: ..." or by clicking the search icon within a chat

Steps for Testing

Prerequisites:

1 Student

Log in to Artemis
Go to the communication section of a course
Play around with the new filter options by typing "by: ..." and "in: ..." and using the checkboxes in the search results
See that everything works and looks as expected
Go to any chat and click the search icon in the top right -> See that "in:" automatically gets filled into the global search and the search bar is focussed

Testserver States

You can manage test servers using Helios. Check environment statuses in the environment list. To deploy to a test server, go to the CI/CD page, find your PR or branch, and trigger the deployment.

Review Progress

Code Review

Code Review 1
Code Review 2

Manual Tests

Test 1
Test 2

Screenshots

Test Coverage

Client

Class/File	Line Coverage	Confirmation (assert/expect)
course-wide-search.component.ts	94.64%	✅
conversation-header.component.ts	95.91%	✅
conversation-messages.component.ts	94.07%	✅
metis.util.ts	100%	✅
metis.service.ts	90.33%	✅
post.service.ts	78.43%	✅
conversation-global-search.component.ts	82.18%	✅
course-conversations.component.ts	92.22%	✅
discussion-section.component.ts	93.98%	✅

Summary by CodeRabbit

New Features
- Introduced a global search component for conversations and users with advanced filtering by conversation and author.
- Added UI controls for course-wide filtering and multi-criteria selection in conversation search.
- Expanded localization with new search-related strings in English and German.
Refactor
- Removed the deprecated "filter to own" feature, replacing it with explicit author selection for post filtering.
- Updated filtering logic and configuration to support multiple selected conversations and authors.
- Simplified search bar UI by removing redundant controls and deprecated search input handling.
- Renamed event emitter in conversation header for clearer interaction handling.
- Replaced previous course-wide search input with the new global search component in conversation views.
- Updated post filtering to use author ID lists instead of a boolean own filter.
Bug Fixes
- Enhanced filtering accuracy by excluding announcement channels from unresolved post queries.
Style
- Added new styles for the global search component.
Tests
- Updated tests to remove deprecated filters and cover new search and filtering behaviors.
- Added tests for the global search component’s filtering, selection, and keyboard navigation.
Documentation
- Enhanced localization and tooltips for search features.

…and close button in search bar

PaRangger

Tested on TS5, works great! One thing i noticed was that when you search for yourself it does not show the indicator that the search result is part of the answer messages. I don't think that's a big issue though, since the user can likely remember they answered a certain question.

…arch-bar

github-actions · 2025-04-18T10:47:18Z

End-to-End (E2E) Test Results Summary

	Tests	Passed ☑️	Skipped ⚠️	Failed ❌️	Time ⏱
End-to-End (E2E) Test Report	201 ran	196 passed	3 skipped	2 failed	53m 3s 99ms

Test	Result	Time ⏱
End-to-End (E2E) Test Report
e2e/course/CourseMessages.spec.ts
ts.Course messages › Channel messages › Write/edit/delete message in channel › Student should be able to edit message in channel	❌ failure	28s 43ms
e2e/exercise/programming/ProgrammingExerciseStaticCodeAnalysis.spec.ts
ts.Static code analysis tests › Configures SCA grading and makes a successful submission with SCA errors	❌ failure	1m 46s 534ms

eylulnc

Tested in TS5, works as expected. ✅

HawKhiem

Tested on TS5. Works as expected

…arch-bar

github-actions · 2025-04-24T07:54:34Z

End-to-End (E2E) Test Results Summary

	Tests	Passed ☑️	Skipped ⚠️	Failed ❌️	Time ⏱
End-to-End (E2E) Test Report	201 ran	196 passed	3 skipped	2 failed	48m 46s 801ms

Test	Result	Time ⏱
End-to-End (E2E) Test Report
e2e/course/CourseMessages.spec.ts
ts.Course messages › Channel messages › Write/edit/delete message in channel › Student should be able to edit message in channel	❌ failure	2m 3s 56ms
e2e/exercise/programming/ProgrammingExerciseStaticCodeAnalysis.spec.ts
ts.Static code analysis tests › Configures SCA grading and makes a successful submission with SCA errors	❌ failure	1m 45s 676ms

FelberMartin · 2025-04-24T08:26:02Z

One thing i noticed was that when you search for yourself it does not show the indicator that the search result is part of the answer messages. I don't think that's a big issue though, since the user can likely remember they answered a certain question.

Hi Paul, thank you for your review and pointing out this inconsistency! I included a small fix for this now :D

github-actions · 2025-04-24T09:02:41Z

End-to-End (E2E) Test Results Summary

	Tests	Passed ☑️	Skipped ⚠️	Failed ❌️	Time ⏱
End-to-End (E2E) Test Report	201 ran	196 passed	3 skipped	2 failed	51m 39s 165ms

Test	Result	Time ⏱
End-to-End (E2E) Test Report
e2e/course/CourseMessages.spec.ts
ts.Course messages › Channel messages › Write/edit/delete message in channel › Student should be able to edit message in channel	❌ failure	2m 3s 41ms
e2e/exercise/programming/ProgrammingExerciseStaticCodeAnalysis.spec.ts
ts.Static code analysis tests › Configures SCA grading and makes a successful submission with SCA errors	❌ failure	1m 44s 833ms

PaRangger

Retested on TS5, works great! Thanks for implementing the feedback! ✅

eylulnc

Retested on TS5, works as described.

HawKhiem

Retested on TS1. Reapprove

…arch-bar # Conflicts: # src/main/webapp/app/communication/shared/course-conversations/course-conversations.component.html

github-actions · 2025-04-26T11:45:20Z

End-to-End (E2E) Test Results Summary

	Tests	Passed ☑️	Skipped ⚠️	Failed ❌️	Time ⏱
End-to-End (E2E) Test Report	201 ran	196 passed	3 skipped	2 failed	51m 28s 562ms

Test	Result	Time ⏱
End-to-End (E2E) Test Report
e2e/course/CourseMessages.spec.ts
ts.Course messages › Channel messages › Write/edit/delete message in channel › Student should be able to edit message in channel	❌ failure	2m 3s 302ms
e2e/exercise/programming/ProgrammingExerciseStaticCodeAnalysis.spec.ts
ts.Static code analysis tests › Configures SCA grading and makes a successful submission with SCA errors	❌ failure	1m 43s 984ms

FelberMartin added 24 commits April 9, 2025 15:37

First version of conversation as search label

3ccd74c

Move to own component

e0d3173

Remove now unused stuff

096fe16

Adjust styling

8a81dd4

Add support for multiselect + keyboard popup navigation

62fb515

Add user search to global search

e2876d9

Show hints for empty search states

782634c

Disallow double selection

40a0733

Use Prefix constants

34a6f8a

Improve UI: dropdown keyboard navigation scroll, texts, include tags …

6cd90e0

…and close button in search bar

Make clear button smaller

4199676

Replace conversation search with global search

66cd090

Cleanup and add todo

c807dbf

Fix rebase client compilation

35cc880

Use new API and add coursewide toggle

245eb7a

Don't show announcement posts as unresolved

a7b7fdd

Add translation for course wide checkbox label

8cc62a8

Disable coursewide when conversation is selected

f87bdd0

Change to show all messages (also non-public) by default

b86027b

Fix existing tests

9819d59

Add new course-wide-search.component.spec.ts tests

20d7a10

Add new global-search test specs

f63318f

Make close button clickable area bigger

117e795

Fix searchbar size

35bec10

FelberMartin self-assigned this Apr 10, 2025

github-project-automation bot added this to Artemis Development Apr 10, 2025

github-project-automation bot moved this to Work In Progress in Artemis Development Apr 10, 2025

github-actions bot added server Pull requests that update Java code. (Added Automatically!) client Pull requests that update TypeScript code. (Added Automatically!) communication Pull requests that affect the corresponding module labels Apr 10, 2025

helios-aet bot temporarily deployed to artemis-test5.artemis.cit.tum.de April 17, 2025 15:19 Inactive

PaRangger previously approved these changes Apr 17, 2025

View reviewed changes

helios-aet bot temporarily deployed to artemis-test2.artemis.cit.tum.de April 17, 2025 18:52 Inactive

helios-aet bot temporarily deployed to artemis-test3.artemis.cit.tum.de April 18, 2025 10:02 Inactive

Merge branch 'develop' into feature/communication/filter-labels-in-se…

2545321

…arch-bar

github-actions bot added the plagiarism Pull requests that affect the corresponding module label Apr 18, 2025

helios-aet bot temporarily deployed to artemis-test3.artemis.cit.tum.de April 18, 2025 10:23 Inactive

helios-aet bot temporarily deployed to artemis-test6.artemis.cit.tum.de April 18, 2025 12:20 Inactive

helios-aet bot temporarily deployed to artemis-test5.artemis.cit.tum.de April 19, 2025 07:12 Inactive

eylulnc previously approved these changes Apr 19, 2025

View reviewed changes

HawKhiem previously approved these changes Apr 19, 2025

View reviewed changes

Merge branch 'develop' into feature/communication/filter-labels-in-se…

e05a5ab

…arch-bar

Also show "Search result in answers" for author search

c04dda7

FelberMartin dismissed stale reviews from PaRangger, eylulnc, and HawKhiem via c04dda7 April 24, 2025 08:23

helios-aet bot temporarily deployed to artemis-test5.artemis.cit.tum.de April 24, 2025 09:11 Inactive

PaRangger previously approved these changes Apr 24, 2025

View reviewed changes

eylulnc previously approved these changes Apr 24, 2025

View reviewed changes

helios-aet bot temporarily deployed to artemis-test1.artemis.cit.tum.de April 25, 2025 09:32 Inactive

HawKhiem previously approved these changes Apr 25, 2025

View reviewed changes

Merge branch 'develop' into feature/communication/filter-labels-in-se…

a9362be

…arch-bar # Conflicts: # src/main/webapp/app/communication/shared/course-conversations/course-conversations.component.html

FelberMartin dismissed stale reviews from HawKhiem, eylulnc, and PaRangger via a9362be April 26, 2025 11:07

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

`Communication`: Add conversation and author selection to search bar #10661

`Communication`: Add conversation and author selection to search bar #10661

FelberMartin commented Apr 10, 2025 •

edited

Loading

PaRangger left a comment

github-actions bot commented Apr 18, 2025

eylulnc left a comment

HawKhiem left a comment

github-actions bot commented Apr 24, 2025

FelberMartin commented Apr 24, 2025 •

edited

Loading

github-actions bot commented Apr 24, 2025

PaRangger left a comment

eylulnc left a comment

HawKhiem left a comment

github-actions bot commented Apr 26, 2025

Communication: Add conversation and author selection to search bar #10661

Are you sure you want to change the base?

Communication: Add conversation and author selection to search bar #10661

Conversation

FelberMartin commented Apr 10, 2025 • edited Loading

Checklist

General

Client

Motivation and Context

Description

Steps for Testing

Testserver States

Review Progress

Code Review

Manual Tests

Screenshots

Test Coverage

Client

Summary by CodeRabbit

PaRangger left a comment

Choose a reason for hiding this comment

github-actions bot commented Apr 18, 2025

End-to-End (E2E) Test Results Summary

eylulnc left a comment

Choose a reason for hiding this comment

HawKhiem left a comment

Choose a reason for hiding this comment

github-actions bot commented Apr 24, 2025

End-to-End (E2E) Test Results Summary

FelberMartin commented Apr 24, 2025 • edited Loading

github-actions bot commented Apr 24, 2025

End-to-End (E2E) Test Results Summary

PaRangger left a comment

Choose a reason for hiding this comment

eylulnc left a comment

Choose a reason for hiding this comment

HawKhiem left a comment

Choose a reason for hiding this comment

github-actions bot commented Apr 26, 2025

End-to-End (E2E) Test Results Summary

`Communication`: Add conversation and author selection to search bar #10661

`Communication`: Add conversation and author selection to search bar #10661

FelberMartin commented Apr 10, 2025 •

edited

Loading

FelberMartin commented Apr 24, 2025 •

edited

Loading