Development: Add competency information to metrics DTO

[MaximilianAnzinger]

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 documented the Java code using JavaDoc style.

Motivation and Context

Adds necessary information to the metrics dto to fetch all required data for the new dashboard with only one REST-call.

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

[FelixTJDietrich]

For reference, this is how it currently looks like:

{
  "exerciseMetrics" : {
    "exerciseInformation" : {
      "1" : {
        "id" : 1,
        "shortName" : "W1E1",
        "title" : "Exercise 1",
        "start" : "2024-05-07T12:57:00Z",
        "due" : "2024-05-08T12:57:00Z",
        "maxPoints" : 10.0,
        "type" : "de.tum.in.www1.artemis.domain.ProgrammingExercise"
      },
      "2" : {
        "id" : 2,
        "title" : "W1E2",
        "start" : "2024-05-07T12:58:00Z",
        "due" : "2024-05-07T14:58:00Z",
        "maxPoints" : 10.0,
        "type" : "de.tum.in.www1.artemis.domain.TextExercise"
      },
      "3" : {
        "id" : 3,
        "title" : "Text Exercise 2",
        "start" : "2024-05-13T08:14:00Z",
        "due" : "2024-05-13T08:16:00Z",
        "maxPoints" : 100.0,
        "type" : "de.tum.in.www1.artemis.domain.TextExercise"
      },
      "4" : {
        "id" : 4,
        "title" : "W2 asdasdf",
        "start" : "2024-05-13T13:34:00Z",
        "due" : "2024-05-13T13:35:00Z",
        "maxPoints" : 50.0,
        "type" : "de.tum.in.www1.artemis.domain.TextExercise"
      }
    },
    "averageScore" : {
      "1" : 0.0,
      "2" : 60.0,
      "3" : 65.1,
      "4" : 50.0
    },
    "averageLatestSubmission" : {
      "1" : 3.295138888888889,
      "2" : 36.986111111111114,
      "3" : 49.166666666666664,
      "4" : 91.66666666666667
    }
  },
  "lectureUnitStudentMetricsDTO" : {
    "lectureUnitInformation" : {
      "1" : {
        "id" : 1,
        "name" : "Amazing Text",
        "releaseDate" : "2024-05-15T16:14:00Z",
        "type" : "de.tum.in.www1.artemis.domain.lecture.TextUnit"
      },
      "2" : {
        "id" : 2,
        "name" : "Visit Google",
        "releaseDate" : "2024-05-15T16:14:00Z",
        "type" : "de.tum.in.www1.artemis.domain.lecture.OnlineUnit"
      }
    }
  },
  "competencyMetrics" : {
    "competencyInformation" : {
      "1" : {
        "id" : 1,
        "title" : "Test Competency 1",
        "softDueDate" : "2024-05-14T08:43:00Z",
        "optional" : false
      },
      "2" : {
        "id" : 2,
        "title" : "Test Competency 2",
        "optional" : false
      }
    },
    "exercises" : {
      "1" : [ 1, 2 ],
      "2" : [ 2 ]
    },
    "lectureUnits" : {
      "1" : [ 1 ],
      "2" : [ 2 ]
    }
  }
}

Looks good as far as I can see, I think this contains everything except completed and progress.
@MaximilianAnzinger with progress you mean the mastery of the competency?

[kaancayli]

I have left some comments, but in general, we need to address the following points that are currently missing:

• Include details of the exercises that belong to a competency (required for the exercise row component in the client).
• Include details of the lecture units that belong to a competency.
• Mark each exercise as completed or not (this is crucial for suggesting the next objective).
• Mark each lecture unit as completed or not (this is also crucial for suggesting the next objective).
• Include user progress information for a competency (important for displaying mastery and progress information).

Additionally, returning only the IDs of lecture units and exercises may result in unnecessary REST calls.

Aside from these points, the changes look good.

[MaximilianAnzinger]

@kaancayli Thank you for your review.

Some remarks / questions:

• Include details of the exercises that belong to a competency (required for the exercise row component in the client).

The DTO contains those already or are there any specific details you're missing?

Additionally, returning only the IDs of lecture units and exercises may result in unnecessary REST calls.

We do not only return the IDs. (see LectureUnitInformationDTO)

[kaancayli]

Changes look good.

[kaancayli]

@MaximilianAnzinger Approved, since @FelixTJDietrich will work later on "Next objective" part of the competencies

[FelixTJDietrich]

I also don't see any issues. I think we are potentially getting more exercise information now since there might be some linked to competencies. But I anyways have to do a fix later for the exercise statistics to filter out exercises where the due date has not passed.

Code looks good :) Thanks 🙏