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

Programming exercises: Fix overflowing content for exercises with UML diagrams #8350

Merged
merged 2 commits into from
Apr 9, 2024

Conversation

rabeatwork
Copy link
Contributor

@rabeatwork rabeatwork commented Apr 8, 2024

Checklist

General

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

Motivation and Context

Description

Steps for Testing

Prerequisites:

  • 1 Student
  • 1 Programming Exercise with UML Diagram
  1. Log in to Artemis
  2. Navigate to Course Overview --> Exercise
  3. Select a programming exercise
  4. reduze the size of your viewport
  5. verify that the uml diagram does not lead to overflowing content

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

Exam Mode Test

  • Test 1
  • Test 2

Screenshots

image

Copy link

coderabbitai bot commented Apr 8, 2024

Walkthrough

The recent update involves refining the user interface and style consistency of the web application. It focuses on improving the display behavior of UI components by introducing flexible wrapping and ensuring images within specific elements have a constrained maximum width. These changes aim to enhance the visual presentation and user experience of the application.

Changes

File Path Change Summary
.../course-exercise-details.component.html Added flex-wrap class to improve display behavior.
src/main/webapp/content/scss/global.scss Set images in elements with IDs starting with 'plantUml-' to have max-width: 100%; for better width management.
.../exercise-update-plagiarism.component.spec.ts Updated handling of fieldCPCEnabled access, valueChanges triggering, and validation logic in the Exercise Update Plagiarism Component test.

Possibly related issues

  • Exam mode: The diff for problem statement changes is broken if inside Markdown structures #7793: The changes in this PR indirectly align with the objectives of ensuring consistent rendering across different sections and browsers. By enhancing UI responsiveness and visual clarity, these changes may help address issues with diff views and HTML rendering within code blocks, contributing to a more stable layout.
  • UX(Excercises): Text too wide #7648: The modifications related to setting a max-width for better readability in the task description could be indirectly impacted by the UI improvements made in this PR, potentially enhancing the overall user experience in reading long tasks.

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 8, 2024
Copy link

github-actions bot commented Apr 8, 2024

⚠️ Unable to deploy to test servers ⚠️

The docker build needs to run through before deploying.

@github-actions github-actions bot added deployment-error Added by deployment workflows if an error occured tests labels Apr 8, 2024
@rabeatwork rabeatwork removed the deployment-error Added by deployment workflows if an error occured label Apr 8, 2024
@rabeatwork rabeatwork temporarily deployed to artemis-test6.artemis.cit.tum.de April 8, 2024 17:31 — with GitHub Actions Inactive
@rabeatwork rabeatwork temporarily deployed to artemis-test2.artemis.cit.tum.de April 8, 2024 17:34 — with GitHub Actions Inactive
@krusche krusche changed the title General: Fix overflowing content for exercises with uml diagrams Programming exercises: Fix overflowing content for exercises with UML diagrams Apr 8, 2024
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.

Thank you for this fix, tested on ts2, works as expected (code also looks good)!
Gone are the days of 5 scrollbars on the exercise view 🥰
image

Copy link
Contributor

@egekurt123 egekurt123 left a comment

Choose a reason for hiding this comment

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

Manually tested on ts2, works as expected

@krusche krusche added this to the 7.0.0 milestone Apr 9, 2024
@krusche krusche merged commit 9cd7edf into develop Apr 9, 2024
25 of 32 checks passed
@krusche krusche deleted the fix-width-of-uml-diagram branch April 9, 2024 19:32
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!) tests
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

Fix width of exercise detail container when problem statement includes an uml diagram
5 participants