Development: Use directive for programming repository button details in exercise detail overview

[florian-glombik]

Checklist

General

• I have tested the changes on a test server
• I chose a title conforming to the naming conventions for pull requests.

Client

• 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.
• I added multiple screenshots/screencasts of my UI changes.

Motivation and Context

Follow up on Development: Add directive to fix types in exercise detail overview list #8644

Description

• Added a component for ProgrammingRepositoryButtons
• Added a component for ProgrammingAuxiliaryRepositoryButtons
• Using ExerciseDetails directive for ProgrammingRepositoryButtons
• Using ExerciseDetails directive for ProgrammingAuxiliaryRepositoryButtons
• Added unit tests

Steps for Testing

Prerequisites:

• 1 Instructor

1. Navigate to the details page of a programming exercise with auxiliary repositories
2. Verify that the repository buttons are displayed and work properly
3. Verify that auxiliary repository buttons are displayed and work properly

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

Code Review

• Code Review 1
• Code Review 2

Manual Tests

• Test 1
• Test 2

Test Coverage

Screenshots

The UI should not have changed

Summary by CodeRabbit

• New Features

  • Introduced new components for buttons related to programming auxiliary repositories and programming repositories, enhancing user interaction for instructors.
  • Added conditional rendering in templates for managing the display of repository-related buttons based on data availability.

• Bug Fixes

  • Improved user notifications for missing repository directories with clear warnings.

• Documentation

  • Enhanced visibility of detail interfaces for broader importation across modules.

• Tests

  • Expanded test suite to include new detail types, ensuring robust validation of component functionality.

[github-actions]

⚠️ Unable to deploy to test servers ⚠️

The docker build needs to run through before deploying.

[coderabbitai]

Walkthrough

The recent changes significantly enhance the user interface for managing programming repository details within an educational platform. New components for displaying both auxiliary and primary repository buttons have been introduced, allowing for dynamic rendering based on input data. The directive has also been improved to accommodate new detail types, ensuring a more versatile interface. Testing has been updated to maintain comprehensive coverage of the new functionalities while refining existing implementations.

Changes

Files	Change Summary
src/main/webapp/app/detail-overview-list/components/*.html	New HTML templates for ProgrammingAuxiliaryRepositoryButtonsDetail and ProgrammingRepositoryButtonsDetail introduced, enhancing UI with dynamic rendering.
src/main/webapp/app/detail-overview-list/components/*.ts	New Angular components (ProgrammingAuxiliaryRepositoryButtonsDetailComponent, ProgrammingRepositoryButtonsDetailComponent) defined for managing repository details.
src/main/webapp/app/detail-overview-list/detail-overview-list.component.html	Removed sections for old button rendering, indicating a shift in UI handling for repository details.
src/main/webapp/app/detail-overview-list/detail-overview-list.component.ts	Reduced FontAwesome icon usage to simplify the UI, focusing on essential icons.
src/main/webapp/app/detail-overview-list/detail.model.ts	Exported ProgrammingRepositoryButtonsDetail and ProgrammingAuxiliaryRepositoryButtonsDetail interfaces to enhance accessibility across modules.
src/main/webapp/app/detail-overview-list/exercise-detail.directive.ts	Updated ExerciseDetailDirective to support new detail types by integrating the newly created components.
src/test/javascript/spec/component/exercise-detail.directive.spec.ts	Enhanced test suite to cover new detail types with additional test cases verifying component creation.

---

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

[JohannesStoehr]

Code

[sarpsahinalp]

Code lgtm

[JohannesStoehr]

Code

[pzdr7]

Reapprove after type fixes

[SimonEntholzer]

Tested on TS1 again -> reapprove

[rabeatwork]

maintainer approved

[ole-ve]

code looks reasonable since last review