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

Quiz exercises: Improve apollon diagram import #8466

Merged
merged 2 commits into from
Apr 25, 2024

Conversation

milljoniaer
Copy link
Contributor

@milljoniaer milljoniaer commented Apr 24, 2024

Checklist

General

Client

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

slightly improves the UX of apollon diagram import for quiz exercises:

  • make title required
  • disable save/generate button when form not valid
  • slightly improve UI

Steps for Testing

Prerequisites:

  • 1 Instructor
  1. Log in to Artemis
  2. Create a new quiz exercise
  3. Add an Apollon Diagram drag-and-drop question
  4. verify that everything works

Testserver States

Note

These badges show the state of the test servers.
Green = Currently available, Red = Currently locked






Review Progress

Code Review

  • Code Review 1
  • Code Review 2

Manual Tests

  • Test 1
  • Test 2

Screenshots

image

Summary by CodeRabbit

  • New Features

    • Introduced input validation and mandatory title field for creating diagrams to enhance data integrity.
    • Improved interactive elements' responsiveness in diagram details.
  • Enhancements

    • Updated button text translations for clarity.
    • Enhanced styling for buttons and layout adjustments in diagram listings.
  • Bug Fixes

    • Adjusted diagram creation handling to improve reliability of diagram save operations.

@milljoniaer milljoniaer requested a review from a team as a code owner April 24, 2024 09:18
Copy link

coderabbitai bot commented Apr 24, 2024

Warning

Rate Limit Exceeded

@milljoniaer has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 29 minutes and 16 seconds before requesting another review.

How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.
Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.
Please see our FAQ for further information.

Commits Files that changed from the base of the PR and between b9e8ef4 and 9f175b4.

Walkthrough

The recent updates focus on enhancing user input validation, modifying the UI's interactive elements, and refining response handling for the creation of Apollon diagrams in a quiz management application. These changes aim to improve user experience and system robustness.

Changes

File Path Change Summary
.../apollon-diagram-create-form.component.html Added required attribute to diagram title input; updated save button text translation key.
.../apollon-diagram-create-form.component.ts Removed faBan icon import; updated save() method for response handling.
.../apollon-diagram-detail.component.html Updated button styling; added input validation; conditional UI rendering.
.../apollon-diagram-detail.component.ts Added NgModel import and @ViewChild for titleField.
.../apollon-diagram-list.component.html Updated button class to text-secondary; added mb-2 to a div element.
.../apollon-diagram-list.component.ts Modified handleOpenDialogClick to use diagram parameter in callback.

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.

@github-actions github-actions bot added the client Pull requests that update TypeScript code. (Added Automatically!) label Apr 24, 2024
Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 2

Out of diff range and nitpick comments (1)
src/main/webapp/app/exercises/quiz/manage/apollon-diagrams/apollon-diagram-list.component.html (1)

3-3: Check consistency of button styling across the application.

The class text-secondary has been added to the close button. While this change is minor, it's important to ensure that it aligns with the overall styling and theming guidelines of the application. Verify that this change is consistent with other similar buttons throughout the application.

coderabbitai[bot]
coderabbitai bot previously approved these changes Apr 24, 2024
laurenzfb
laurenzfb previously approved these changes Apr 24, 2024
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.

code lgtm

@milljoniaer milljoniaer dismissed stale reviews from laurenzfb and coderabbitai via 9f175b4 April 24, 2024 09:49
@github-actions github-actions bot added tests cypress Pull requests that update cypress tests. (Added Automatically!) labels Apr 24, 2024
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.

reapprove after fixing tests

Copy link
Contributor

@rstief rstief left a comment

Choose a reason for hiding this comment

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

Code LGTM, also tested on ts2 and works as expected.

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.

Works as expected

Copy link
Contributor

@pzdr7 pzdr7 left a comment

Choose a reason for hiding this comment

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

Code looks good 👍

@krusche krusche merged commit 3cc5c86 into develop Apr 25, 2024
20 of 27 checks passed
@krusche krusche deleted the feature/quiz-exercise/improve-apollon-import branch April 25, 2024 15:46
@krusche krusche added this to the 7.0.2 milestone Apr 25, 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!) cypress Pull requests that update cypress tests. (Added Automatically!) tests
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

None yet

6 participants