Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Adaptive learning: Allow creating and updating prerequisite competencies #8765

Conversation

rstief
Copy link
Contributor

@rstief rstief commented Jun 7, 2024

Checklist

General

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.

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

We want to refactor the prerequisite management with the goal of linking exercise units to prerequisites as pre-tests for a course. To support this, prerequisites were changed to be actual entities. Thus, we should also be able to create and update new prerequisites.

Description

  • Adds buttons to create and edit (update) prerequisites to the competency management
  • Expands the prerequisite table in the competency management to include all new information.

Steps for Testing

Required:

  • 1 instructor
  1. Go to course management -> competencies
  2. Create new prerequisites
  3. Edit existing prerequisites
  4. Change a prerequisite title to equal one of the existing ones. After a short delay an error message should be displayed!
  5. Always verify that the data is updated correctly!

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)
competency-form.component.ts 87.77%
competency-management.component.ts 93.49%
competency.service.ts 90.66%
create-competency.component.ts 97.61%
competency-recommendation-detail.component.ts 94.73%
competency-search.component.ts 100%
import-competencies.component.ts 90.9%
import-course-competencies.component.ts 98.59%
import-prerequisites.component.ts 91.66%
create-prerequisite.component.ts 100%
edit-prerequisite.component.ts 96.42%
prerequisite-form.component.ts 100%
prerequisite.service.ts 93.1%
competency.model.ts 88.33%
standardized-competency.model.ts 100%
course.model.ts 100%
lecture-wizard-competencies.component.ts 97.24%
course-competencies.component.ts 95.31%
course-prerequisites-modal.component.ts 94.73%

Server

Class/File Line Coverage Confirmation (assert/expect)
PrerequisiteRepository.java 100%
CourseCompetencyRepository.java 84%
PrerequisiteService.java 100%
PrerequisiteRequestDTO.java 100%
PrerequisiteResource.java 100%
CompetencyResource.java 94%

Screenshots

Create/Edit View
image
Prerequisite List in the Competency Management View
image

Summary by CodeRabbit

  • New Features

    • Added methods to create and update prerequisites for courses.
    • Introduced new routes and components for managing prerequisites.
    • Added logic to display loading spinners and forms conditionally in the UI.
    • Implemented functionality to retrieve course competency titles.
  • Bug Fixes

    • Improved form validation for competency titles and descriptions.
  • Refactor

    • Renamed CompetencyValidators to CourseCompetencyValidators.
    • Updated default mastery threshold from 80 to 100.
    • Adjusted method signatures for better clarity and functionality.
  • Tests

    • Added comprehensive unit tests for new prerequisites components and services.
    • Enhanced existing tests to include new validation scenarios and utilities.

rstief and others added 30 commits May 24, 2024 10:21
Copy link
Contributor

@Jan-Thurner Jan-Thurner left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

reapprove

Copy link
Contributor

@JohannesStoehr JohannesStoehr left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Reapprove

Copy link
Contributor

@JohannesWt JohannesWt left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Reapprove 👍

Copy link
Contributor

@florian-glombik florian-glombik left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Re-approve

Copy link
Contributor

@SimonEntholzer SimonEntholzer left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Re-approve

@JohannesStoehr JohannesStoehr added ready to merge maintainer-approved The feature maintainer has approved the PR and removed ready for review labels Jun 24, 2024
Copy link
Collaborator

@MaximilianAnzinger MaximilianAnzinger left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maintainer approved

@krusche krusche added this to the 7.3.0 milestone Jun 24, 2024
@krusche krusche merged commit 62f4132 into develop Jun 24, 2024
39 of 42 checks passed
@krusche krusche deleted the feature/adaptive-learning/allow-creating-and-updating-prerequisites branch June 24, 2024 19:40
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
client Pull requests that update TypeScript code. (Added Automatically!) component:AdaptiveLearning feature maintainer-approved The feature maintainer has approved the PR ready to merge server Pull requests that update Java code. (Added Automatically!) tests
Projects
Archived in project
Status: Done
Development

Successfully merging this pull request may close these issues.

9 participants