General: Fix programmatic scrolling to the top of the page

[pzdr7]

Checklist

General

• This is a small issue that I tested locally and was confirmed by another developer on a test server.
• I chose a title conforming to the naming conventions for pull requests.

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.

Motivation and Context

During the second testing session for 7.0.0, we noticed that the "Back to overview" button of the student exam summary did not work when no result was available.

It seems that the window is not scrollable because there is an element page-wrapper that handles the overflow-y of the Artemis page content.

Description

• Added an id to the page wrapper.
• Instead of the window, queried the page wrapper from the document and scrolled on it to get to the top of the page

Steps for Testing

Prerequisites:

• 1 Instructor
• 1 Exam with at least one submission (but no assessment). Ideally, you have a few exercises so the summary page is long enough to be scrollable.

1. Log in to Artemis
2. Navigate to Course Management > Your course > Exams
3. Open the Student exams of your exam and view one.
4. Open the Summary
5. Scroll to the bottom of the page and click the "Back to overview" button
6. You should now be at the top of the page again.

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

[coderabbitai]

Walkthrough

The recent modifications aim to enhance page navigation by adding an id attribute to a <div> element in the main layout for precise element targeting. Additionally, the update in the utility function improves scrolling behavior, specifically targeting the page-wrapper element for smoother content navigation and handling of overflowing content.

Changes

File Path	Change Summary
src/main/webapp/app/shared/layouts/main/main.component.html	Added id attribute to <div> for improved element targeting.
src/main/webapp/app/shared/util/utils.ts	Updated scrollToTopOfPage to scroll the page-wrapper element.

Possibly related issues

• Plagiarism Checks Scroll-down in the comparison of modelling exercises is working in some cases and other no.  #5402: The scroll enhancement could address inconsistent scroll-down behavior in certain interfaces, aligning with the objective of ensuring smooth scrolling functionality.
• Development: Course access authorization alert sometimes appears twice #6382: Improving scroll handling may indirectly impact issues related to unexpected behavior post-authorization alerts, potentially offering a smoother user experience after alerts.
• Programming exercises: Inline feedback sticks to top of online editor when saving #7731: The scroll adjustment might influence how inline comments behave, potentially contributing to a more stable user experience during navigation within the application.

---

Recent Review Details

Configuration used: CodeRabbit UI

Commits

Files that changed from the base of the PR and between 553f1f8 and 7508747.

Files selected for processing (1)

• src/main/webapp/app/shared/layouts/main/main.component.html (1 hunks)

Files skipped from review as they are similar to previous changes (1)

• src/main/webapp/app/shared/layouts/main/main.component.html

---

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.

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.

[undernagruzez]

lgtm and works as expected

[julian-christl]

code lgtm

[rabeatwork]

maintainer approve

[rstief]

demonstrated in testing session works as expected.

[muradium]

Presented in testing session, works as expected

[undernagruzez]

reapprove

[julian-christl]

reapprove code