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

Integrated code lifecycle: Add timeout when stopping hanging containers in edge cases #8587

Merged
merged 3 commits into from
May 18, 2024

Conversation

laurenzfb
Copy link
Contributor

@laurenzfb laurenzfb commented May 13, 2024

Checklist

General

Server

  • Important: I implemented the changes with a very good performance and prevented too many (unnecessary) database calls.
  • I strictly followed the server coding and design guidelines.
  • I documented the Java code using JavaDoc style.

Changes affecting Programming Exercises

  • High priority: I tested all changes and their related features with all corresponding user types on a test server configured with the integrated lifecycle setup (LocalVC and LocalCI).

Motivation and Context

There is an unresolved issue in LocalCI that prevents unresponsive Docker containers from being stopped / killed. Calling the stopContainerCmd or killContainerCmd may lead to endless execution / hanging of the commands, preventing the succeeding code from being executed. This leads to the build job not being processed properly.

Description

I added timeouts for the stop and kill commands. This does not fix the issue of the unresponsive container not being killed but it allows for the build job to finish processing and thus properly be displayed in the client.

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

@github-actions github-actions bot added the server Pull requests that update Java code. (Added Automatically!) label May 13, 2024
@laurenzfb laurenzfb changed the title add timeout for stopping container Integrated code lifecycle: Add timeout for stopping container May 13, 2024
@laurenzfb laurenzfb marked this pull request as ready for review May 14, 2024 09:47
@laurenzfb laurenzfb requested a review from a team as a code owner May 14, 2024 09:47
Copy link

coderabbitai bot commented May 14, 2024

Walkthrough

The recent updates enhance the BuildJobContainerService by introducing asynchronous handling for stopping and killing unresponsive containers using an ExecutorService. This change improves the robustness and responsiveness of the service by incorporating logging and timeout handling. Additionally, the BuildJobManagementService now includes logging statements to track the IDs of running and stopping containers, aiding in better monitoring and debugging.

Changes

File Change Summary
src/main/java/de/tum/in/www1/artemis/service/connectors/localci/buildagent/BuildJobContainerService.java Introduced ExecutorService for asynchronous container operations, added logging and timeout handling.
src/main/java/de/tum/in/www1/artemis/service/connectors/localci/buildagent/BuildJobManagementService.java Added logging statements to track container IDs and log messages when stopping unresponsive containers.

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.

Copy link
Member

@BBesrour BBesrour left a comment

Choose a reason for hiding this comment

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

Code lgtm!

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.

Code looks good 👍

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.

Code LGTM

@krusche krusche added this to the 7.1.0 milestone May 18, 2024
@krusche krusche changed the title Integrated code lifecycle: Add timeout for stopping container Integrated code lifecycle: Add timeout when stopping containers in edge cases May 18, 2024
@krusche krusche changed the title Integrated code lifecycle: Add timeout when stopping containers in edge cases Integrated code lifecycle: Add timeout when stopping hanging containers in edge cases May 18, 2024
@krusche krusche merged commit c4e0c9b into develop May 18, 2024
25 of 30 checks passed
@krusche krusche deleted the bugfix/icl/add-timeout-to-stop-container branch May 18, 2024 10:21
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
component:integrated code lifecycle ready for review server Pull requests that update Java code. (Added Automatically!) small
Projects
Status: Merged
Development

Successfully merging this pull request may close these issues.

None yet

5 participants