`Communication`: Add FAQ consistency check to rewrite action #10814

cremertim · 2025-05-07T18:42:44Z

Note

This PR depends on the counterpart in IRIS. For testing, deploy EduTelligence#61 via Helios. You can only use TS3 for testing because you potentially need turn on the IRIS settings of the server with an admin account.

Checklist

General

I tested all changes and their related features with all corresponding user types 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.

Server

Important: I implemented the changes with a very good performance and prevented too many (unnecessary) and too complex database calls.(https://docs.artemis.cit.tum.de/dev/guidelines/server/#rest-endpoint-best-practices-for-authorization) and checked the course groups for all new REST Calls (security).
I documented the Java code using JavaDoc style.

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 added multiple screenshots/screencasts of my UI changes.
I translated all newly inserted strings into English and German.

Motivation and Context

If a user creates a FAQ, the system should ensure that the newly created FAQ is consistent with all existing FAQs.

Description

I extended the rewrite pipeline of iris to show , wheter the provided information are consistent or not

Steps for Testing

Prerequisites:

1 Instructor or Tutor
1 Course with FAQ enabled. Make sure, that this course has the FAQ ingestion settings enabled and you deployed the related IRIS PR.

Log in to Artemis
Navigate to the FAQ overview
Ensure, that you already have some FAQs and add them to IRIS (otherwise, create some or use the test course "Tim Cremers Test Course")
Create a new FAQ
Insert some FAQ content, which is conflicting with already existing FAQs
Click on rewrite FAQ
Wait until the response is there.
Check, whether the inconsistencies are described and shown
Check whether there is an alternative formulation of your faq

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

Performance Review

I (as a reviewer) confirm that the client changes (in particular related to REST calls and UI responsiveness) are implemented with a very good performance even for very large courses with more than 2000 students.
I (as a reviewer) confirm that the server changes (in particular related to database calls) are implemented with a very good performance even for very large courses with more than 2000 students.

Code Review

Code Review 1
Code Review 2

Manual Tests

Test 1
Test 2

Exam Mode Test

Test 1
Test 2

Performance Tests

Test 1
Test 2

Test Coverage

Screenshots

Summary by CodeRabbit

New Features
- Introduced a consistency check for FAQs, displaying detected inconsistencies, suggestions, and improvement tips in a new alert component within the FAQ update view.
- Added a dedicated FAQ Consistency Check component for enhanced user feedback on FAQ content quality.
Enhancements
- Consistency check results now provide structured feedback, including inconsistencies, suggestions, and improvement recommendations.
- Improved integration of rewriting and consistency check actions across relevant editors and components.
- Enhanced rewriting functionality to deliver richer results, including detailed consistency data and improvement suggestions.
- Updated rewriting service to include course context in processing and extend status updates with additional metadata.
Localization
- Added new English and German translations for consistency check alerts and improvement suggestions.
Bug Fixes
- Removed unnecessary debug logging from the FAQ rewriting process.
Tests
- Expanded test coverage for FAQ update logic and consistency check actions.
- Improved tests for the rewriting and consistency check service, including error handling and UI integration.
- Added tests for the new FAQ Consistency Check component.

github-actions · 2025-05-07T19:20:59Z

End-to-End (E2E) Test Results Summary

	Tests	Passed ✅	Skipped	Failed	Time ⏱
End-to-End (E2E) Test Report	1 ran	1 passed	0 skipped	0 failed	1s 823ms

Test	Result	Time ⏱
No test annotations available

github-actions · 2025-05-07T19:49:02Z

End-to-End (E2E) Test Results Summary

	Tests	Passed ✅	Skipped ⚠️	Failed	Time ⏱
End-to-End (E2E) Test Report	201 ran	198 passed	3 skipped	0 failed	47m 32s 578ms

Test	Result	Time ⏱
No test annotations available

github-actions · 2025-05-07T22:42:15Z

End-to-End (E2E) Test Results Summary

	Tests	Passed ✅	Skipped ⚠️	Failed	Time ⏱
End-to-End (E2E) Test Report	201 ran	198 passed	3 skipped	0 failed	46m 42s 689ms

Test	Result	Time ⏱
No test annotations available

github-actions · 2025-05-08T09:54:27Z

End-to-End (E2E) Test Results Summary

	Tests	Passed ✅	Skipped ⚠️	Failed	Time ⏱
End-to-End (E2E) Test Report	201 ran	198 passed	3 skipped	0 failed	49m 14s 118ms

Test	Result	Time ⏱
No test annotations available

github-actions · 2025-05-08T10:32:49Z

End-to-End (E2E) Test Results Summary

	Tests	Passed ✅	Skipped	Failed	Time ⏱
End-to-End (E2E) Test Report	1 ran	1 passed	0 skipped	0 failed	1s 799ms

Test	Result	Time ⏱
No test annotations available

github-actions · 2025-05-08T11:00:07Z

End-to-End (E2E) Test Results Summary

	Tests	Passed ✅	Skipped ⚠️	Failed	Time ⏱
End-to-End (E2E) Test Report	201 ran	198 passed	3 skipped	0 failed	47m 5s 640ms

Test	Result	Time ⏱
No test annotations available

github-actions · 2025-05-08T12:34:48Z

End-to-End (E2E) Test Results Summary

	Tests	Passed ✅	Skipped ⚠️	Failed	Time ⏱
End-to-End (E2E) Test Report	201 ran	198 passed	3 skipped	0 failed	47m 15s 532ms

Test	Result	Time ⏱
No test annotations available

github-actions · 2025-05-08T13:53:22Z

End-to-End (E2E) Test Results Summary

	Tests	Passed ☑️	Skipped ⚠️	Failed ❌️	Time ⏱
End-to-End (E2E) Test Report	201 ran	197 passed	3 skipped	1 failed	50m 995ms

Test	Result	Time ⏱
End-to-End (E2E) Test Report
e2e/exercise/quiz-exercise/QuizExerciseParticipation.spec.ts
ts.Quiz Exercise Participation › DnD Quiz participation › Student can participate in DnD Quiz	❌ failure	2m 3s 567ms

github-actions · 2025-06-13T12:57:26Z

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	58m 24s 302ms

Test	Result	Time ⏱
End-to-End (E2E) Test Report
e2e/exercise/quiz-exercise/QuizExerciseParticipation.spec.ts
ts.Quiz Exercise Participation › DnD Quiz participation › Student can participate in DnD Quiz	❌ failure	2m 3s 933ms
e2e/exercise/programming/ProgrammingExerciseStaticCodeAnalysis.spec.ts
ts.Static code analysis tests › Configures SCA grading and makes a successful submission with SCA errors	❌ failure	2m 14s 219ms

github-actions · 2025-06-13T13:38:21Z

End-to-End (E2E) Test Results Summary

	Tests	Passed ☑️	Skipped ⚠️	Failed ❌️	Time ⏱
End-to-End (E2E) Test Report	201 ran	197 passed	3 skipped	1 failed	1h 3m 9s 941ms

Test	Result	Time ⏱
End-to-End (E2E) Test Report
e2e/exercise/programming/ProgrammingExerciseStaticCodeAnalysis.spec.ts
ts.Static code analysis tests › Configures SCA grading and makes a successful submission with SCA errors	❌ failure	2m 17s 701ms

az108

retested TS3 and still works, reapprove

florian-glombik

Thanks for the adjustments, approve code

MoritzSpengler

Re-tested on TS3. Works as described.

eylulnc

code

# Conflicts: # src/test/java/de/tum/cit/aet/artemis/core/connector/IrisRequestMockProvider.java

github-actions · 2025-06-24T05:50:17Z

End-to-End (E2E) Test Results Summary

	Tests	Passed ☑️	Skipped ⚠️	Failed ❌️	Time ⏱
End-to-End (E2E) Test Report	201 ran	197 passed	3 skipped	1 failed	59m 14s 711ms

Test	Result	Time ⏱
End-to-End (E2E) Test Report
e2e/exercise/programming/ProgrammingExerciseStaticCodeAnalysis.spec.ts
ts.Static code analysis tests › Configures SCA grading and makes a successful submission with SCA errors	❌ failure	2m 19s 667ms

github-actions · 2025-06-24T11:31:34Z

End-to-End (E2E) Test Results Summary

	Tests	Passed ✅	Skipped	Failed	Time ⏱
End-to-End (E2E) Test Report	1 ran	1 passed	0 skipped	0 failed	2s 169ms

Test	Result	Time ⏱
No test annotations available

github-actions · 2025-06-24T12:03:55Z

End-to-End (E2E) Test Results Summary

	Tests	Passed ✅	Skipped ⚠️	Failed	Time ⏱
End-to-End (E2E) Test Report	201 ran	198 passed	3 skipped	0 failed	55m 16s 12ms

Test	Result	Time ⏱
No test annotations available

github-actions · 2025-06-27T13:42: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	58m 3s 369ms

Test	Result	Time ⏱
End-to-End (E2E) Test Report
e2e/exercise/quiz-exercise/QuizExerciseParticipation.spec.ts
ts.Quiz Exercise Participation › DnD Quiz participation › Student can participate in DnD Quiz	❌ failure	2m 4s 33ms
e2e/exercise/programming/ProgrammingExerciseStaticCodeAnalysis.spec.ts
ts.Static code analysis tests › Configures SCA grading and makes a successful submission with SCA errors	❌ failure	2m 14s 919ms

First implementation

22c1b6c

github-project-automation bot added this to Artemis Development May 7, 2025

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

github-actions bot assigned cremertim May 7, 2025

github-project-automation bot added this to Communication Webclient May 7, 2025

github-project-automation bot moved this to Todo in Communication Webclient May 7, 2025

Prettier

8d3347b

Prettier

97abc4c

Fix issues

2db08ee

cremertim changed the title ~~First implementation~~ Communication: Add FAQ consistency check to rewrite action May 8, 2025

cremertim added 2 commits May 8, 2025 12:02

Merge branch 'develop' into feature/iris/faq-consistency-check

0f8bf4d

Test addition of translate service

d78946e

test change of artemis intelligence service

89dddf1

test change of faq update component

88df956

test change of faq update component

2abd457

helios-aet bot temporarily deployed to artemis-test3.artemis.cit.tum.de June 13, 2025 13:04 Inactive

az108 previously approved these changes Jun 13, 2025

View reviewed changes

florian-glombik previously approved these changes Jun 13, 2025

View reviewed changes

helios-aet bot temporarily deployed to artemis-test3.artemis.cit.tum.de June 15, 2025 12:00 Inactive

MoritzSpengler previously approved these changes Jun 15, 2025

View reviewed changes

eylulnc previously approved these changes Jun 15, 2025

View reviewed changes

Test ignore prettier

3b2f889

cremertim dismissed stale reviews from eylulnc, MoritzSpengler, florian-glombik, az108, and coderabbitai[bot] via 3b2f889 June 23, 2025 15:35

coderabbitai bot previously approved these changes Jun 23, 2025

View reviewed changes

Merge branch 'develop' into feature/iris/faq-consistency-check

4097885

# Conflicts: # src/test/java/de/tum/cit/aet/artemis/core/connector/IrisRequestMockProvider.java

cremertim dismissed coderabbitai[bot]’s stale review via 4097885 June 24, 2025 05:05

github-actions bot removed tests core Pull requests that affect the corresponding module labels Jun 24, 2025

helios-aet bot had a problem deploying to artemis-test3.artemis.cit.tum.de June 24, 2025 08:37 Failure

helios-aet bot had a problem deploying to artemis-test3.artemis.cit.tum.de June 24, 2025 09:33 Failure

Fix test

b4fd6ca

github-actions bot added the tests label Jun 24, 2025

Merge branch 'develop' into feature/iris/faq-consistency-check

fa2e033

helios-aet bot had a problem deploying to artemis-test3.artemis.cit.tum.de June 24, 2025 13:09 Failure

Merge branch 'develop' into feature/iris/faq-consistency-check

a435245

Communication: Add FAQ consistency check to rewrite action #10814

Are you sure you want to change the base?

Communication: Add FAQ consistency check to rewrite action #10814

Conversation

cremertim commented May 7, 2025 • edited by coderabbitai bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Checklist

General

Server

Client

Motivation and Context

Description

Steps for Testing

Testserver States

Review Progress

Performance Review

Code Review

Manual Tests

Exam Mode Test

Performance Tests

Test Coverage

Screenshots

Summary by CodeRabbit

Uh oh!

github-actions bot commented May 7, 2025

End-to-End (E2E) Test Results Summary

Uh oh!

github-actions bot commented May 7, 2025

End-to-End (E2E) Test Results Summary

Uh oh!

github-actions bot commented May 7, 2025

End-to-End (E2E) Test Results Summary

Uh oh!

github-actions bot commented May 8, 2025

End-to-End (E2E) Test Results Summary

Uh oh!

github-actions bot commented May 8, 2025

End-to-End (E2E) Test Results Summary

Uh oh!

github-actions bot commented May 8, 2025

End-to-End (E2E) Test Results Summary

Uh oh!

github-actions bot commented May 8, 2025

End-to-End (E2E) Test Results Summary

Uh oh!

github-actions bot commented May 8, 2025

End-to-End (E2E) Test Results Summary

Uh oh!

github-actions bot commented Jun 13, 2025

End-to-End (E2E) Test Results Summary

Uh oh!

github-actions bot commented Jun 13, 2025

End-to-End (E2E) Test Results Summary

Uh oh!

az108 left a comment

Choose a reason for hiding this comment

Uh oh!

florian-glombik left a comment

Choose a reason for hiding this comment

Uh oh!

MoritzSpengler left a comment

Choose a reason for hiding this comment

Uh oh!

eylulnc left a comment

Choose a reason for hiding this comment

Uh oh!

github-actions bot commented Jun 24, 2025

End-to-End (E2E) Test Results Summary

Uh oh!

github-actions bot commented Jun 24, 2025

End-to-End (E2E) Test Results Summary

Uh oh!

github-actions bot commented Jun 24, 2025

End-to-End (E2E) Test Results Summary

Uh oh!

github-actions bot commented Jun 27, 2025

End-to-End (E2E) Test Results Summary

Uh oh!

Uh oh!

`Communication`: Add FAQ consistency check to rewrite action #10814

`Communication`: Add FAQ consistency check to rewrite action #10814

cremertim commented May 7, 2025 •

edited by coderabbitai bot

Loading