Development: Fix client layout for e2e tests

[julian-christl]

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

Motivation and Context

#8083 introduced changes to the layout that made inner divs scrollable instead of the main elements. Additionally, the footer was changed resulting in multiple E2E tests failing.

Description

I fixed the footer height and reused it several times to prevent overlapping. Additionally, I used a manual scrolling command to make sure Cypress finds the elements tested. Finally, I fixed the calling order of the course creation as the elements would otherwise be covered.

Keep in mind that cypress will probably be soon get deprecated/removed and it works well with playwright so

Steps for Testing

Just make sure the layout with the footer doesn't look odd.

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

Summary by CodeRabbit

• Style
  • Updated the footer's positioning and sizing to be dynamically controlled through CSS variables, enhancing consistency and flexibility across the application.
• Tests
  • Improved test reliability for course management and exam participation by ensuring elements are scrolled into view before visibility checks, enhancing test accuracy and user experience during test execution.
• Documentation
  • Enhanced the clarity and maintainability of the codebase by documenting the changes made to the styling and testing procedures.

[coderabbitai]

Walkthrough

The changes aim to enhance user experience by improving visibility and adaptability across various components. Updates include dynamic adjustments to footer height using CSS variables, ensuring elements are scrolled into view for better visibility during tests, and maintaining layout consistency. The goal is to make the application more user-friendly and adaptable, with a focus on layout adjustments and test interaction enhancements.

Changes

Files	Change Summary
.../app/exercises/quiz/participate/quiz-participation.component.scss, .../shared/layouts/footer/footer.scss, .../content/scss/global.scss	Adjusted footer height dynamically using CSS variables.
.../content/scss/themes/_default-variables.scss	Introduced a variable for customizable footer height.
.../cypress/e2e/course/CourseManagement.cy.ts, .../cypress/support/pageobjects/exam/ExamParticipation.ts, .../cypress/support/pageobjects/exercises/quiz/MultipleChoiceQuiz.ts, .../cypress/support/pageobjects/exercises/quiz/ShortAnswerQuiz.ts	Improved test interactions by incorporating scroll actions for better element visibility.

Related issues

• Plagiarism Checks Scroll-down in the comparison of modelling exercises is working in some cases and other no.  #5402: While this PR does not directly address the scroll-down behavior issue in plagiarism checks, the focus on enhancing visibility through scroll actions in tests aligns with the objective of ensuring consistent and smooth scrolling behavior, suggesting a similar approach could be beneficial for addressing this issue.

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-tests 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 tests 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 tests.
  • @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.
• The JSON schema for the configuration file is available here.
• 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/coderabbit-overrides.v2.json

CodeRabbit Discord Community

Join our Discord Community to get help, request features, and share feedback.

resolved

[coolchock]

tested on ts2, layout looks good, code also lgtm

[pzdr7]

Tested on TS2. LGTM