Iris: Answer questions about lecture slides

[yassinsws]

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) database calls.
• I strictly followed the server coding and design guidelines.
• I added multiple integration tests (Spring) related to the features (with a high test coverage).
• I added pre-authorization annotations according to the guidelines and checked the course groups for all new REST Calls (security).
• I documented the Java code using JavaDoc style.

Motivation and Context

We want Iris to be able to respond to the students questions based on the lecture content. For that we need to send the lectures to Pyris, everytime new lecture slides or attachments get updated or deleted.

Description

Every lecture that gets updated or created is sent to the Pyris through a rest call. If a course, lecture or a lectureUnit gets erased the webhook is also executed and the files are erased from the Pyris side.

Steps for Testing

Prerequisites:

• 1 Instructor / Admin
• use Test Course Yassine Souissi on test server 3.
• Pyris and Artemis running.
• Log in to Grafana through this link( should take you directly to ts3 logs): https://grafana.gchq.ase.in.tum.de/d/uBBKO8qnk/nodes-detailed-view?orgId=1&refresh=1m&var-DS_PROMETHEUS=default&var-job=artemis_test&var-name=artemis-test3.artemis.cit.tum.de&var-node=artemis-test-vm3.artemis.cit.tum.de&var-port=9100

Test as an admin(only people with admin rights can test on ts3):

1. Log in to Artemis as an Admin
2. Go to the course page
3. Upload a lecture unit attachment with a pdf file in it-> Nothing should happen here on Pyris side
4. Now Enable in Iris global settings and course, lecture ingestion and enable Auto Lecture ingestion.

Test as an INSTRUCTOR/Admin:
5. Download a lecture unit attachment then Reupload it -> Check if the file is sent correctly to Pyris by checking Artemis logs on Grafana. After some time you should find this log: Slides ingestion:Lecture Ingestion Finished.
6. Delete a lecture unit, delete a Lecture -> Check if the file is sent correctly to Pyris by checking the Artemis logs on Grafana after some time you should find this log: Old slides removal:Old slides removed.
7. On the lectures page there is a button called send lectures to Pyris near create lectures, when you click on it, the upload should work as expected. After some time you should find this log: Slides ingestion:Lecture Ingestion Finished.

Testserver States

Note

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

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
• I (as a reviewer) confirm that the server changes (in particular related to database calls) are implemented with a very good performance

Code Review

• Code Review 1
• Code Review 2

Manual Tests

• Test 1
• Test 2

Test Coverage

Client

Class/File	Line Coverage	Confirmation (assert/expect)
iris-common-sub-settings-update.component.ts	93.18%	✅ ❌
iris-enabled.component.ts	94.28%	✅ ❌

Server

Class/File	Line Coverage	Confirmation (assert/expect)
IrisCourseSettings.java	97%	✅
IrisGlobalSettings.java	97%	✅
AttachmentUnitService.java	95%	✅
LectureService.java	95%	✅
PyrisJobService.java	95%	✅
PyrisStatusUpdateService.java	91%	✅
PyrisWebhookService.java	94%	✅
IrisCombinedLectureIngestionSubSettingsDTO.java	100%	✅
IrisCombinedSettingsDTO.java	100%	✅
IrisSubSettingsService.java	89%	✅
LectureResource.java	93%	✅

Summary by CodeRabbit

• New Features

  • Added functionality to handle lecture ingestion in Pyris, including automatic updates and deletions of attachments.
  • Integrated new settings to manage lecture ingestion in Iris interface.

• Enhancements

  • Improved lecture ingestion processes with Pyris integration.
  • Updated language files for multilingual support, including new labels and settings.

• Bug Fixes

  • Corrected handling of lecture ingestion settings in various components.

• Tests

  • Added comprehensive test cases for new lecture ingestion functionalities and settings management.

• Documentation

  • Updated language files to include new key-value pairs for lecture ingestion settings.

[Jan-Thurner]

reapprove

[egekurt123]

Reapprove

outdated

[coderabbitai]

Actionable comments posted: 1

[bassner]

a boolean is not a job token

[bassner]

We should probably do something here when we add a status update to the UI