Team exercises: Fix synchronization for empty submissions

[coolchock]

Checklist

General

• I tested all changes and their related features with all corresponding user types on a test server.
• I chose a title conforming to the naming conventions for pull requests.

Client

• I strictly followed the client coding and design guidelines.
• I added multiple integration tests (Jest) related to the features (with a high test coverage), while following the test guidelines.

Description

When testing #10087, an issue was discovered: text editors do not synchronize properly when one user deletes all text from the editor. This pull request addresses the issue, ensuring this edge case is handled correctly.

Steps for Testing

Prerequisites:

• 2 Students
• 1 Team Text Exercise

1. Start a team text exercise in two browsers (or in an incognito tab).
2. Type some text in one editor and verify that both users' editors are synchronized.
3. Delete some parts of the text in one editor and verify that both users' editors remain synchronized.
4. Delete all text in one editor and verify that both users' editors remain synchronized.

Testserver States

Note

These badges show the state of the test servers.
Green = Currently available, Red = Currently locked
Click on the badges to get to the test servers.

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 even for very large courses with more than 2000 students.
• I (as a reviewer) confirm that the server changes (in particular related to database calls) are implemented with a very good performance even for very large courses with more than 2000 students.

Code Review

• Code Review 1
• Code Review 2

Manual Tests

• Test 1
• Test 2

Summary by CodeRabbit

• New Features

  • Enhanced text editor component to utilize the ButtonComponent.
  • Improved test coverage for submission handling.

• Bug Fixes

  • Ensured answer property is correctly initialized when submission is empty.

[coderabbitai]

Walkthrough

The pull request introduces modifications to the text-editor.component.ts file and its corresponding test suite. The changes include updating the import statements to include ButtonComponent and adding a new test case to handle empty submissions from a team. The primary focus is on ensuring proper initialization of the answer property and enhancing test coverage for the component's submission handling logic.

Changes

File	Change Summary
src/main/webapp/app/exercises/text/participate/text-editor.component.ts	- Updated import statement to include ButtonComponent - Added initialization of answer to an empty string for empty submissions
src/test/javascript/spec/component/text-editor/text-editor.component.spec.ts	- Added new test case should receive empty submission from team - Verified handling of empty submissions

Possibly related PRs

• Programming exercises: Fix translation issue for participation modes in exam management #9293: The changes in the main PR involve modifications to the text-editor.component.ts file, specifically related to the handling of text submissions.
• Exam mode: Remove exercise title from solution containers  #9442: The changes in the main PR include updates to the text-editor.component.ts, which may relate to the handling of submissions in exam contexts.
• Development: Fix exam assessment e2e tests failing #9462: The main PR's focus on ensuring proper handling of submissions in the text-editor.component.ts could relate to the adjustments made in this PR regarding exam assessments.

Suggested labels

bugfix, ready for review, exercise, programming

Suggested reviewers

• krusche
• EneaGore
• SimonEntholzer
• Feras797
• vinceclifford
• HawKhiem

---

📜 Recent review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 840c4a0 and 0423480.

📒 Files selected for processing (1)

• src/main/webapp/app/exercises/text/participate/text-editor.component.ts (2 hunks)

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

• src/main/webapp/app/exercises/text/participate/text-editor.component.ts

⏰ Context from checks skipped due to timeout of 90000ms (5)

• GitHub Check: client-tests
• GitHub Check: server-tests
• GitHub Check: Build and Push Docker Image
• GitHub Check: Build .war artifact
• GitHub Check: Analyse

---

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

[HawKhiem]

Tested on TS5. Works as described

Screen.Recording.2025-01-21.185533.mp4

[SimonEntholzer]

Code

[zagemello]

Tested on TS1, all works as expected.

[github-actions]

⚠️ Unable to deploy to test servers ⚠️

Testserver "artemis-test5.artemis.cit.tum.de" is already in use by PR #10178.

[vinceclifford]

Tested on TS1, works as expected.

[Feras797]

Tested on TS1, the synchronization of team exercises works as described.