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

Exam mode: Show result for programming exercises on the exam overview page #8354

Merged
merged 10 commits into from
Apr 15, 2024

Conversation

undernagruzez
Copy link
Contributor

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

Motivation and Context

This PR introduces an updating result component to the exam overview page. Previously, students submitting code for automated programming exercises would only see a checkmark to indicate submission status, leading to potential misinterpretation under exam conditions. This enhancement aims to provide clearer, real-time feedback on submission outcomes, reducing misunderstanding and stress during exams.
image

Description

The jhi-exam-exercise-overview-page component now has a jhi-updating-result component.

Steps for Testing

Exam Mode Testing

Prerequisites:

  • 1 Instructor
  • 1 Student
  • 1 Exam with a Programming Exercise
  1. Log in as an instructor.
  2. Create an exam with a programming exercise in it and set the programming exercise to automatic assessment.
  3. Log in as a student.
  4. Participate in the exam & submit code.
  5. Go to the overview page and ensure that the result updates without reloading the page.

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

@github-actions github-actions bot added tests client Pull requests that update TypeScript code. (Added Automatically!) labels Apr 8, 2024
@undernagruzez undernagruzez changed the title show updating result on the exam overview page Exam mode show updating result on the exam overview page Apr 8, 2024
@undernagruzez undernagruzez changed the title Exam mode show updating result on the exam overview page Exam mode Show updating result for programming exercises on the exam overview page 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 the deployment-error Added by deployment workflows if an error occured label Apr 8, 2024
@undernagruzez undernagruzez marked this pull request as ready for review April 8, 2024 21:55
@undernagruzez undernagruzez requested a review from a team as a code owner April 8, 2024 21:55
Copy link

coderabbitai bot commented Apr 8, 2024

Walkthrough

The update involves enhancing the HTML layout for exercise overviews in exams with conditional rendering for improved exercise information display. Additionally, the test suite is expanded to include new components, ensuring seamless integration of feedback components within the Angular framework.

Changes

File Path Change Summary
.../app/exam/participate/exercises/exercise-overview-page/...component.html Restructured HTML layout with conditional rendering for exercise information display.
.../spec/component/exam/participate/exam-exercise-overview-page.component.spec.ts Added tests for jhi-updating-result component presence; updated imports and TestBed declarations.

Possibly related issues

  • Highlight differences in Exam Timeline #7197: The enhancement to highlight differences in the Exam Timeline could benefit from the HTML restructuring for better display of information, including differences between submissions.
  • Exam: Divide the Testing Process into Steps #6621: The changes in handling and displaying exercise information could indirectly support the objectives related to improving the exam programming exercise creation process by providing clearer feedback and information display mechanisms.

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 removed the deployment-error Added by deployment workflows if an error occured label Apr 8, 2024
@undernagruzez undernagruzez temporarily deployed to artemis-test3.artemis.cit.tum.de April 8, 2024 21:58 — with GitHub Actions Inactive
@pzdr7 pzdr7 temporarily deployed to artemis-test3.artemis.cit.tum.de April 9, 2024 11:34 — with GitHub Actions Inactive
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.

Tested on TS3. Looks good - the code as well. I left one suggestion you could try 👍

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

Good improvement - code looks good

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.

Tested in testing session - LGTM

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.

tested in testing session, works as expected.

Copy link
Contributor

@coolchock coolchock left a comment

Choose a reason for hiding this comment

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

tested during testing session, works as described

Copy link
Contributor

@muradium muradium 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 test server, works as expected

@krusche krusche modified the milestones: 7.0.0, 7.0.1 Apr 11, 2024
@maximiliansoelch maximiliansoelch changed the title Exam mode Show updating result for programming exercises on the exam overview page Exam mode: Show result for programming exercises on the exam overview page Apr 15, 2024
Copy link
Member

@maximiliansoelch maximiliansoelch left a comment

Choose a reason for hiding this comment

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

Tested locally, programming results are shown as expected 👍

@maximiliansoelch maximiliansoelch added the maintainer-approved The feature maintainer has approved the PR label Apr 15, 2024
@krusche krusche merged commit 4d7b40e into develop Apr 15, 2024
42 of 52 checks passed
@krusche krusche deleted the programming-result-exam-overview branch April 15, 2024 22:21
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!) maintainer-approved The feature maintainer has approved the PR ready to merge small tests
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

None yet

8 participants