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: Add import of standardized competency into course #8467

Conversation

rstief
Copy link
Contributor

@rstief rstief commented Apr 24, 2024

Only test on ts3, you will need admin permissions for this!

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

Implements FR 3 of #8001

Description

  • Adds the possibility to import standardized competencies as normal competencies into a course.
  • Extracts the standardized competency filter component
  • Extracts the standardized competency filter logic into its own component aswell

Steps for Testing

Required:

  • 1 Admin Account
  • 1 Course
  1. Log in -> Go to Server Administration -> Feature Toggles
  2. Enable StandardizedCompetencies
  3. Go to course management -> competencies
  4. Click on Import Competencies -> Import Standardized Competencies
  5. See that the detail view works (click on a competency name)
  6. See that the selection of standardized competencies works (checkbox)
  7. See that de-selection works (checkbox, trash in the table below)
  8. See that the import works when clicking on import

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)
standardized-competency-management.component.ts 84.74%
competency-form.component.ts 86.02%
competency-management.component.ts 92.96%
competency.service.ts 94.52%
course-import-standardized-competencies.component.ts 87.17%
competency.model.ts 100%
navbar.component.ts 89.72%
standardized-competency-detail.component.ts 100%
standardized-competency-filter-page.component.ts 95.23%
standardized-competency-filter.component.ts 100%

Server

Class/File Line Coverage Confirmation (assert/expect)
Competency.java 81%
CompetencyService.java 93%
CompetencyResource.java 98%

Screenshots

image

image

Summary by CodeRabbit

Summary by CodeRabbit

  • New Features

    • Implemented a standardized competency filtering component for improved search functionality.
    • Added a stub component for testing the standardized competency filter feature.
  • Enhancements

    • Enhanced competency filtering capabilities with debounce functionality for smoother user experience.
  • Bug Fixes

    • Addressed potential issues related to competency filtering through improved component testing.

@github-actions github-actions bot added the client Pull requests that update TypeScript code. (Added Automatically!) label Apr 24, 2024
@github-actions github-actions bot added tests server Pull requests that update Java code. (Added Automatically!) labels Apr 25, 2024
@rstief rstief marked this pull request as ready for review April 25, 2024 15:05
@rstief rstief requested a review from a team as a code owner April 25, 2024 15:05
Copy link

coderabbitai bot commented Apr 25, 2024

Walkthrough

The update enhances competency management in Artemis by introducing standardized competencies. It aims to streamline competency import processes and improve cross-course competency comparison. These changes include new UI components and backend services to facilitate the handling and integration of standardized competencies within the platform.

Changes

File Path Change Summary
.../domain/competency/Competency.java Added DEFAULT_MASTERY_THRESHOLD constant.
.../service/competency/CompetencyService.java Introduced StandardizedCompetency entity and repository; added methods for importing competencies.
.../web/rest/CompetencyResource.java Added a new endpoint for importing standardized competencies.
.../admin/admin.module.ts and related admin files Renamed components; added ArtemisStandardizedCompetencyModule.
.../admin/standardized-competencies/... Updated components and introduced a new filtering component.
.../course/competencies/... Updated forms, management components, and introduced an import UI for standardized competencies.
.../shared/standardized-competencies/... Added new components and module for managing standardized competencies.
.../test/... Updated and introduced new test cases for components and services related to standardized competencies.

Possibly related issues


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

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 a review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @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.

Jan-Thurner
Jan-Thurner previously approved these changes Apr 29, 2024
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.

Code reviewed with Raphael. LGTM

@rstief rstief changed the title Adaptive learning: Add of import standardized competency into course Adaptive learning: Add import of standardized competency into course Apr 29, 2024
JohannesWt
JohannesWt previously approved these changes Apr 29, 2024
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.

Additionally reviewed in on-site code review session - Code looks good 👍

pzdr7
pzdr7 previously approved these changes Apr 29, 2024
@rstief rstief dismissed stale reviews from pzdr7 and JohannesWt via f0a4a68 April 29, 2024 18:43
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.

Tested in testing session - works as promised

Copy link
Contributor

@laurenzfb laurenzfb left a comment

Choose a reason for hiding this comment

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

Demonstrated in testing session

Copy link
Member

@BBesrour BBesrour left a comment

Choose a reason for hiding this comment

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

Demonstrated in testing session, works as expected

Copy link
Contributor

@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

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.

Tested on ts3 during testing session, checking the boxes adds a competency and deleting untoggles the checkbox aswell. The import of the selected standard competencies worked (imported competencies from 2 different knowledge areas)

@krusche krusche merged commit 5734935 into develop May 2, 2024
49 of 52 checks passed
@krusche krusche deleted the feature/adaptive-learning/import-standardized-competency-into-course branch May 2, 2024 21:14
@krusche krusche added this to the 7.0.3 milestone May 2, 2024
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 server Pull requests that update Java code. (Added Automatically!) tests
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

None yet

9 participants