Development: Implement multiple exercise selection in LTI deep linking service

[basak-akan]

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 followed the 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.

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.
• I followed the 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 authorities to all new routes and checked the course groups for displaying navigation elements (links, buttons).
• 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

This update introduces the capability to add multiple exercises in a single LTI deep-linking service response. Previously, instructors had to add exercises individually. By enabling batch addition of exercises, this change enhances usability, and reduces the administrative burden on instructors. Additionally, it includes an improved arrangement of the exercises list view, further optimizing the overall workflow and user interface.

Description

• Multiple exercises can be selected to Link to external LMS (Moodle).
• If the Artemis exercise is a graded or bonus exercise, it will be added to the grade book of the external LMS.
• If the Artemis exercise is not a graded exercise, it won't appear on the grade book of the external LMS.
• Exercise selection page rearranged:
  • Course title and semester information removed
  • Exercise start date added
  • Exercise graded information added

Steps for Testing

Prerequisites:

• Test on Test Server 11 where lti profile is enabled.
• 1 Instructor

1. Login to Moodle (https://moodle.ase.in.tum.de/) using instructor credentials (e.g. artemis_test_user_11)
2. Select "LTI Testing Course"
3. Enable edit mode (on top right corner of the page)
4. Select add an activity or resource
5. Select "External Tool"
6. You will be directed to editing external tool page
7. Under preconfigured tools select "Artemis - https://artemis-test11.artemis.in.tum.de/" and click "select content" button.
8. Verify you see login page of artemis and login using same instructor credentials.
9. Verify you see "LTI Single Configuration Test" course and select this course
10. Select multiple exercises where graded column is yes and no and click on "link" button
11. Verify you see selected exercises names and graded information on navigated Moodle page (Please note that if exercise is a graded exercise you will see maximum graded value as 100 - this is the intended behavior to match with current results service)
12. Click on add and verify the selected exercises are added to the Moodle course.

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)
lti13-deep-linking.component.ts	90.62%	✅

Server

Class/File	Line Coverage	Confirmation (assert/expect)
LtiDeepLinkingService.java	97%	✅
LtiResource.java	100%	✅

Screenshots

Summary by CodeRabbit

• New Features

  • Enhanced the LTI Deep Linking service to support multiple exercise IDs for deep linking, improving integration flexibility.
  • Updated the LTI deep linking UI to display exercise start dates and inclusion in overall scores, enhancing user information.

• Refactor

  • Refactored LTI deep linking components and services for improved handling of multiple exercises.
  • Updated test suites to align with the new multi-exercise deep linking functionality.

• Style

  • Adjusted UI elements in the LTI deep linking component for a clearer presentation of exercise details.

The base branch was changed.

[egekurt123]

Reapprove after base merge

[RY997]

Tested on ts11, worked as expected

[Gusti2010]

Manually tested on ts11_Legacy, works as expected! Thanks for the detailed testing steps + video :)

[reschandreas]

code lgtm, also demonstrated in testing session, works as expected, thanks!

[laurenzfb]

demonstrated on ts11, works. code also lgtm

[rstief]

Demonstrated in testing session, code also lgtm