Adaptive learning: Remove relates relation type for competencies

[JohannesStoehr]

🚨 🚨 Contains Database migration. Do not deploy to test servers 🚨 🚨

Checklist

General

• This is a small issue that I tested locally and was confirmed by another developer on a test server.
• 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.

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 strictly followed the client coding and design guidelines.
• I added multiple screenshots/screencasts of my UI changes.
• I translated all newly inserted strings into English and German.

Motivation and Context

The "Relates" relation between competencies is quite weak in what it expresses. Instead the other relation types should be used, so the learning paths can better understand the course structure and adequately suggest competencies and within them lecture units and exercises to the student.

Description

Removed the "Relates" relation between competencies and replaced all existing with "Assumes".
Additionally added tooltips to the relation selector, so other instructors better understand the intention of each relation.
Extended the documentation to include more details and explanations about the competency relations.

Steps for Testing

Prerequisites:

• 1 Instructor

1. Log in to Artemis
2. Create a course using another branch, e.g. develop
3. Create competencies and relations between them. At least one relates and another
4. Switch to this branch and check that the relates relation is now an assumes relation
5. Check that the type of the other relation stayed the same
6. Look at the new tooltip for the drop down for the relation types
7. Read the documentation about competency relations: https://artemis-platform--8993.org.readthedocs.build/en/8993/user/adaptive-learning/adaptive-learning-instructor.html#manage-relations

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

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

Screenshots

New tooltip for relations:

Summary by CodeRabbit

• New Features

  • Enhanced the functionality for managing relations between competencies, allowing instructors to create and visualize different types of relationships like "Assumes", "Extends", and "Matches".

• Bug Fixes

  • Updated competency relation types to remove RELATES and added more descriptive types.

• Documentation

  • Updated instructor documentation to detail new relation types and their uses.

• Localization

  • Improved translations for competency terms in both English and German.

• User Interface

  • Added help icons and refined translations for relation types in competency management UI.

[coderabbitai]

Walkthrough

The update improves the management of competency relationships in course materials, enabling instructors to create and visualize relations such as "Assumes", "Extends", and "Matches". The "RELATES" type has been removed, and UI enhancements, including help icons and explanations for relation types, have been added. Additionally, translations were refined, and relevant test cases were adjusted to reflect these changes.

Changes

File(s)	Change Summary
docs/user/adaptive-learning/adaptive-learning-instructor.rst	Added details on creating and managing competency relations with new types "Assumes", "Extends", and "Matches".
src/main/java/de/tum/in/www1/artemis/domain/competency/RelationType.java	Removed RELATES from RelationType enum and added new relationship descriptions.
src/main/webapp/app/course/competencies/competency-management/competency-relation-graph...html	Enhanced UI with a help icon and improved translation for relation types.
src/main/webapp/app/entities/competency.model.ts	Removed RELATES from the CompetencyRelationType enum.
src/main/webapp/i18n/de/competency.json	Renamed keys and added detailed explanations for new competency relations.
src/main/webapp/i18n/en/competency.json	Enhanced competency type explanations by adding detailed descriptions for new relation types.
src/test/java/de/tum/in/www1/artemis/lecture/CompetencyIntegrationTest.java	Replaced RelationType.RELATES with RelationType.ASSUMES in creating competency relations.
src/test/java/de/tum/in/www1/artemis/service/LearningPathServiceTest.java	Removed testSingleRelates() method and updated relation types from RELATES to ASSUMES in testOrderOfCompetenciesByPriorUtility().
src/test/javascript/spec/component/competencies/competency.service.spec.ts	Updated CompetencyRelation type from RELATES to ASSUMES in get competency relations test within CompetencyService.
src/test/java/de/tum/in/www1/artemis/competency/CompetencyIntegrationTest.java	Changed relation type from RELATES to ASSUMES in shouldImportCompetencies test method, modifying the logic for competency imports.

---

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>.
  • 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 generate interesting stats about this repository and render them as a table.
  • @coderabbitai show all the console.log statements in this repository.
  • @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 as 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.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

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

[coderabbitai]

Actionable comments posted: 1

[N0W0RK]

Code 👍

[coderabbitai]

Actionable comments posted: 1

[JohannesWt]

Tested in Testing Session works as expected 🇹🇭

[pzdr7]

Tested locally in testing session. LGTM 🇹🇭

[florian-glombik]

Approve code

[dmytropolityka]

code

[MaximilianAnzinger]

Maintainer approved