Learning paths: Allow instructors to include prerequisites at the start

[JohannesStoehr]

🚨 🚨 Delete the prerequisites created with this PR after testing 🚨 🚨

Checklist

General

• I tested all changes and their related features with all corresponding user types 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.
• I added multiple integration tests (Spring) related to the features (with a high test coverage).
• 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 strictly followed the client coding and design guidelines.
• 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.

Motivation and Context

#8765 added the creation and edit options for prerequisites. They should now get more integrated into the rest of Artemis like linking to learning objects and scheduling those in the learning path.

Description

This PR adds the following things:

• You can now link prerequisites when editing exercises/lecture units
• You can now add relations between prerequisites themselves as well as to competencies
• Learning Paths now include prerequisites and their learning objects
• Started some refactoring from Competencies to CourseCompetencies (common super class of Competencies and Prerequisites)

What this PR does NOT cover:

• Linking lecture units when editing prerequisites
• UI changes apart from also showing prerequisites in relevant places (any visual differentiation to competencies will follow in FollowUps)
• Fixing the guided mode of lectures where it is currently not possible to link competencies
• Refactor all code from Competencies to CourseCompetencies

Steps for Testing

Prerequisites:

• 1 Instructor
• 1 Student
• 1 Course with activated learning paths

1. Log in to Artemis
2. Navigate to Course Administration
3. Create one or more prerequisites and one or more competencies
4. Create relations between prerequisites and competencies
5. Create lecture units and exercises and link them to the prerequisites
6. Participate as a student in the learning path
   • If you want to check your mastery progress, this is currently only visible in the competency relation graph in the drop down for the learning path navigation ui
7. Delete a prerequisite as instructor
8. 🚨 🚨 Delete all other prerequisites that you created during the test of this PR 🚨 🚨

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

Test Coverage

Client

Class/File	Line Coverage	Confirmation (assert/expect)
competency.service.ts	90.78%	✅
course-competency.service.ts	100%	✅
create-competency.component.ts	97.67%	✅
competency-selection.component.ts	100%	✅

Server

Class/File	Line Coverage	Confirmation (assert/expect)
LearningObjectService.java	89%	✅
CompetencyProgressService.java	94%	✅
CompetencyRelationService.java	100%	✅
CompetencyService.java	92%	✅
CourseCompetencyService.java	86%	✅
PrerequisiteService.java	77%	✅
LearningPathNavigationService.java	92%	✅
LearningPathNgxService.java	97%	✅
LearningPathRecommendationService.java	98%	✅
LearningPathService.java	97%	✅
CourseResource.java	89%	✅
LearningPathResource.java	100%	✅
CourseCompetencyResource.java	100%	✅
PrerequisiteResource.java	96%	✅

Summary by CodeRabbit

• New Features

  • Enhanced course information retrieval by including prerequisites in various services and models.

• Refactor

  • Renamed Competency to CourseCompetency across multiple classes and services for improved clarity and consistency.

• Bug Fixes

  • Adjusted method signatures and repository references to accommodate the new CourseCompetency entity.

• Tests

  • Updated test cases to align with the new CourseCompetency entity and added prerequisite handling in course retrieval tests.

[coderabbitai]

Walkthrough

The recent changes primarily focus on refactoring competency-related entities across various files to use CourseCompetency instead of Competency. This involves updating imports, field types, method signatures, and repository references. Additionally, functionality enhancements were made to include prerequisites in competency retrievals and learning paths. These changes aim to improve the handling and retrieval of competencies and prerequisites across different components of the application.

Changes

File(s)	Change Summary
.../domain/Exercise.java, .../domain/LearningObject.java, .../domain/LectureUnit.java	Refactored Competency to CourseCompetency for fields, getters, and setters.
src/main/java/de/tum/in/www1/artemis/service/CourseService.java	Modified registerUsersForCourseGroup to include eager loading of competencies and prerequisites.
src/main/java/de/tum/in/www1/artemis/service/learningpath/LearningPathRecommendationService.java	Refactored to use CourseCompetency and added utility constants and methods for prerequisites.
src/main/webapp/app/entities/competency/learning-path.model.ts	Replaced Competency array with CourseCompetency array in the LearningPath model.
src/test/java/de/tum/in/www1/artemis/competency/CompetencyIntegrationTest.java	Updated package names, imports, and method signatures to use CourseCompetency instead of Competency.
src/test/java/de/tum/in/www1/artemis/competency/LearningPathIntegrationTest.java	Enhanced course retrieval in tests to include prerequisites along with learning paths and competencies.

---

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 Configration 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: 13

Outside diff range comments (1)

src/main/java/de/tum/in/www1/artemis/web/rest/competency/PrerequisiteResource.java (1)

Line range hint 135-138: LGTM! Method correctly imports course competencies as prerequisites for a course.

The importPrerequisites method correctly imports a list of course competencies as prerequisites for a given course.

Reminder: Implement the TODO.

The TODO comment indicates that the import of relations between prerequisites is not yet implemented.

Do you want me to generate the code for importing relations between prerequisites or open a GitHub issue to track this task?

[coderabbitai]

Actionable comments posted: 5

[pzdr7]

Code looks good. One optional comment

[coderabbitai]

Actionable comments posted: 2

[az108]

reapprove after merge conflict

[iyannsch]

reapprove after merge conflict

[sarpsahinalp]

Reapprove after merge conflicts

[SimonEntholzer]

Re-approve after resolved merge conflicts