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

Development: Fix an issue with clearing text fields in an e2e test #10281

Merged
merged 1 commit into from
Feb 7, 2025

Conversation

muradium
Copy link
Contributor

@muradium muradium commented Feb 6, 2025

Checklist

General

Client

Motivation and Context

The action for clearing the text fields during e2e tests is not working correctly anymore. As a result, "Instructor changes problem statement and all participants are informed" e2e test is failing.

Description

This PR changes the action for clearing the text field into "delete button press" to make it more reliable.

Steps for Testing

  • Code Review: Ensure that test passes for valid reasons and improvements make sense.
  • CI testing: Check that all tests pass on both single-node and multi-node Artemis Bamboo builds.

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

Summary by CodeRabbit

  • Bug Fixes
    • Improved text clearing behavior on the exercise creation page, ensuring a more consistent and reliable removal of text.

@muradium muradium changed the title Chore: Fix the issue with clearing text fields in e2e test Chore: Fix the issue with clearing text fields in an e2e test Feb 6, 2025
@muradium muradium marked this pull request as ready for review February 6, 2025 21:26
@muradium muradium requested a review from a team as a code owner February 6, 2025 21:26
Copy link

coderabbitai bot commented Feb 6, 2025

Walkthrough

The clearText method in the TextExerciseCreationPage class was modified to replace a backspace action with a delete action for clearing text in the editor. All other functionalities in the class remain unchanged, and there were no modifications to public or exported entities.

Changes

File Change Summary
src/.../TextExerciseCreationPage.ts Updated clearText method: replaced backspace action with delete action.

Suggested labels

ready for review, bugfix

Suggested reviewers

  • coolchock
  • SimonEntholzer
  • EneaGore
  • BBesrour
  • HawKhiem

Tip

🌐 Web search-backed reviews and chat
  • We have enabled web search-based reviews and chat for all users. This feature allows CodeRabbit to access the latest documentation and information on the web.
  • You can disable this feature by setting web_search: false in the knowledge_base settings.
  • Please share any feedback in the Discord discussion.
✨ Finishing Touches
  • 📝 Generate Docstrings (Beta)

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>, please review it.
    • 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 gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @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.
    • @coderabbitai help me debug CodeRabbit configuration file.

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 using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR. (Beta)
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai or @coderabbitai title anywhere in the PR title to generate the title automatically.

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.

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: 0

🧹 Nitpick comments (1)
src/test/playwright/support/pageobjects/exercises/text/TextExerciseCreationPage.ts (1)

88-88: Consider adding a comment explaining the Delete key choice.

To help future maintainers understand why Delete was chosen over Backspace, consider adding a comment explaining this decision.

+    // Using Delete key instead of Backspace as it's more reliable for clearing text in Monaco editor
     await textEditor.press('Delete');
📜 Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between cc1e3cb and 58302db.

📒 Files selected for processing (1)
  • src/test/playwright/support/pageobjects/exercises/text/TextExerciseCreationPage.ts (1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (1)
  • GitHub Check: Codacy Static Code Analysis
🔇 Additional comments (1)
src/test/playwright/support/pageobjects/exercises/text/TextExerciseCreationPage.ts (1)

85-89: LGTM! The change from Backspace to Delete key should fix the text clearing issue.

The implementation maintains a clean approach: focus the editor, select all text, and delete the selection. Using the Delete key instead of Backspace is a valid solution that could be more reliable for clearing text in the Monaco editor.

Copy link

@simonbohnen simonbohnen left a comment

Choose a reason for hiding this comment

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

Looks good 👌🏼

Copy link
Contributor

@DominikRemo DominikRemo left a comment

Choose a reason for hiding this comment

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

LGTM, test passes

Copy link
Contributor

@sebastianloose sebastianloose left a comment

Choose a reason for hiding this comment

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

Looks good

Copy link

@HanyangXu0508 HanyangXu0508 left a comment

Choose a reason for hiding this comment

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

worked locally.

@krusche krusche changed the title Chore: Fix the issue with clearing text fields in an e2e test Development: Fix the issue with clearing text fields in an e2e test Feb 7, 2025
@krusche krusche added this to the 7.10.0 milestone Feb 7, 2025
@krusche krusche merged commit 274d0c7 into develop Feb 7, 2025
24 of 36 checks passed
@krusche krusche deleted the chore/playwright/fix-problem-statement-modify branch February 7, 2025 14:36
@krusche krusche changed the title Development: Fix the issue with clearing text fields in an e2e test Development: Fix an issue with clearing text fields in an e2e test Feb 7, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Status: Merged
Development

Successfully merging this pull request may close these issues.

8 participants