Development: Add endpoint for learning path competency graph

[JohannesStoehr]

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.
• 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

@JohannesWt wants a new endpoint with the following structure given the learning Path id:

"nodes": [
	 	{
	 		"id": 1,
	 		"label": "Competency 1",
	 		"softDueDate": "21.02.2022, 10:42"
	 		"progress": 50,
	 		"mastery": 50,
	 		"confidence": 80
	 	},
	 	{
	 		"id": 2,
	 		"label": "Competency 2",
	 		"progress": 50,
	 		"mastery": 50,
	 		"confidence": 80
	 	},
	 ],
	 "edges": [
	 	{
	 		"id": 42
	 		"source": 1,
	 		"target": 2,
	 		"type": "extends"
	 	}	
	 ]

Description

Added the endpoint as requested

Steps for Testing

No manual testing possible, since the end point is not yet used

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 server changes (in particular related to database calls) are implemented with a very good performance

Code Review

• Code Review 1
• Code Review 2

Test Coverage

Server

Class/File	Line Coverage	Confirmation (assert/expect)
LearningPathService.java	99%	✅
LearningPathResource.java	98%	✅
CompetencyProgressDTO.java	100%	✅
LearningPathCompetencyGraphDTO.java	100%	✅

[coderabbitai]

Walkthrough

The recent changes introduce new DTO classes for managing competency progress and learning path graphs, along with corresponding updates to the service and resource layers to support these features. Additionally, new tests have been added to ensure the integrity and functionality of the learning path competency graph feature.

Changes

Files/Paths	Change Summary
src/main/java/de/tum/in/www1/artemis/web/rest/dto/competency/CompetencyProgressDTO.java	Introduced CompetencyProgressDTO record class with a static method of to create instances from CompetencyProgress objects.
src/main/java/de/tum/in/www1/artemis/web/rest/dto/competency/LearningPathCompetencyGraphDTO.java	Added LearningPathCompetencyGraphDTO record class containing sets of CompetencyProgressDTO and CompetencyRelationDTO.
src/test/java/de/tum/in/www1/artemis/competency/LearningPathIntegrationTest.java	Added imports and new methods to test learning path competency graphs, progress, and relations.
src/main/java/de/tum/in/www1/artemis/service/learningpath/LearningPathService.java	Updated to include new imports and a method generateLearningPathCompetencyGraph for generating competency graphs.
src/main/java/de/tum/in/www1/artemis/web/rest/LearningPathResource.java	Added LearningPathCompetencyGraphDTO, new methods for access control, and modified existing methods for learning path access.

Sequence Diagram(s) (Beta)

sequenceDiagram
    participant User
    participant LearningPathResource
    participant LearningPathService
    participant CompetencyProgressRepository
    participant CompetencyRelationRepository

    User->>+LearningPathResource: getLearningPathCompetencyGraph()
    LearningPathResource->>+LearningPathService: generateLearningPathCompetencyGraph()
    LearningPathService->>+CompetencyProgressRepository: findCompetencyProgressByUser()
    CompetencyProgressRepository-->>-LearningPathService: CompetencyProgress data
    LearningPathService->>+CompetencyRelationRepository: findCompetencyRelations()
    CompetencyRelationRepository-->>-LearningPathService: CompetencyRelation data
    LearningPathService-->>-LearningPathResource: LearningPathCompetencyGraphDTO
    LearningPathResource-->>-User: LearningPathCompetencyGraphDTO

Loading

This sequence diagram illustrates the interaction flow for generating and retrieving a learning path competency graph for a user.

---

Recent Review Details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 42d4be3 and 6d7654f.

Files selected for processing (2)

• src/main/java/de/tum/in/www1/artemis/web/rest/LearningPathResource.java (5 hunks)
• src/main/java/de/tum/in/www1/artemis/web/rest/dto/competency/CompetencyProgressDTO.java (1 hunks)

Files skipped from review as they are similar to previous changes (2)

• src/main/java/de/tum/in/www1/artemis/web/rest/LearningPathResource.java
• src/main/java/de/tum/in/www1/artemis/web/rest/dto/competency/CompetencyProgressDTO.java

---

Tip

Early Access Features

• gpt-4o model for chat

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 full the 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: 4

[JohannesWt]

Code LGTM 👍

[JohannesWt]

Reapprove after adding softDueDate

[pzdr7]

Code looks good. One small comment

[JohannesWt]

Reapprove 👍

[pzdr7]

Code

[MaximilianAnzinger]

Maintainer approved

[bassner]

Suggested change

	public static CompetencyProgressDTO of(CompetencyProgress competencyProgress) {
	public static CompetencyProgressDTO of(@NotNull CompetencyProgress competencyProgress) {

?

[bassner]

Suggested change

	if (authorizationCheckService.isOnlyStudentInCourse(course, user) && !user.getId().equals(learningPath.getUser().getId())
	&& !authorizationCheckService.isAtLeastInstructorInCourse(course, user)) {
	if (authorizationCheckService.isOnlyStudentInCourse(course, user) && !user.equals(learningPath.getUser())) {

• Users implement equals()
• The third check appears unnecessary, as we already check that the user is only a student

[JohannesWt]

Reapprove

[pzdr7]

Reapprove