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

Ensure that exited docker containers do not pollute self-hosted insta… #1702

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

smashah
Copy link

@smashah smashah commented Feb 12, 2025

…nces #1567

Closes #1567

✅ Checklist

  • I have followed every step in the contributing guide
  • The PR title follows the convention.
  • I ran and tested the code works

Testing

[Describe the steps you took to test this change]


Changelog

[Short description of what has changed]


Screenshots

[Screenshots]

💯

Copy link
Contributor

coderabbitai bot commented Feb 12, 2025

Walkthrough

The changes update the create method within the DockerTaskOperations class in the docker-provider module. The update adds a --rm flag to the command arguments, which ensures that the Docker container is automatically removed after it exits. No changes were made to public entity declarations or error handling.

Changes

File(s) Change Summary
apps/docker-provider/src/index.ts Modified the create method in DockerTaskOperations by adding the --rm flag to the Docker run arguments.

Sequence Diagram(s)

sequenceDiagram
    participant U as User
    participant D as DockerTaskOperations
    participant E as Docker Engine
    participant C as Container

    U->>D: Call create()
    D->>E: Build command (includes "--rm")
    E->>C: Start container
    C-->>E: Container exits
    E->>E: Automatically remove container (--rm)
Loading

Suggested Reviewers

  • nicktrn

Poem

In the code garden, I hop with cheer,
A new flag blooms, so crystal clear.
The container runs and then fades away,
Leaving no clutter at the end of day.
I'm just a rabbit, celebrating this code sway!
🐇🥕

Warning

There were issues while running some tools. Please review the errors and either fix the tool’s configuration or disable the tool if it’s a critical failure.

🔧 ESLint

If the error stems from missing dependencies, add them to the package.json file. For unrecoverable errors (e.g., due to private dependencies), disable the tool in the CodeRabbit configuration.

apps/docker-provider/src/index.ts

Oops! Something went wrong! :(

ESLint: 8.45.0

ESLint couldn't find the config "custom" to extend from. Please check that the name of the config is correct.

The config "custom" was referenced from the config file in "/.eslintrc.js".

If you still have problems, please stop by https://eslint.org/chat/help to chat with the team.

✨ 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 anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration 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
Contributor

@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)
apps/docker-provider/src/index.ts (1)

226-226: Address the FIXME comment about skipping port extraction in production.

The comment indicates that port extraction from logs should be skipped in production. This should be implemented to improve reliability and performance in production environments.

Would you like me to help implement the production environment check and skip the port extraction logic?

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between a38f713 and 1aa6b25.

📒 Files selected for processing (1)
  • apps/docker-provider/src/index.ts (1 hunks)
🔇 Additional comments (2)
apps/docker-provider/src/index.ts (2)

135-149: LGTM! Robust error handling for container creation.

The error handling is comprehensive, including proper type checking, detailed error logging, and appropriate error propagation.


118-118: LGTM! The "--rm" flag addition effectively prevents container pollution.

The addition of the "--rm" flag ensures that Docker automatically removes the container when it exits, which directly addresses the issue of exited containers polluting self-hosted instances.

Let's verify that this change doesn't interfere with container restoration functionality:

✅ Verification successful

🏁 Script executed:

#!/bin/bash
# Description: Check if there are any references to container restoration that might be affected by auto-removal

# Search for container restoration related code
rg -A 5 'restore|checkpoint|start' apps/docker-provider/src/

Length of output: 2592


Container restoration functionality remains unaffected by the "--rm" flag addition.

After reviewing the restoration code in apps/docker-provider/src/index.ts, we confirmed the following:

  • The restoration logic (e.g., the restore method) operates on containers that are not yet fully exited. For instance, it exercises a simulation path with docker unpause and a checkpoint restore path with docker start --checkpoint=..., both of which require the container to still exist.
  • The --rm flag only triggers post container exit. In scenarios where container restoration is necessary, the container is expected to be paused or stopped (but not exited), so the auto-removal does not occur.
  • There are no indications in the file that this change interferes with the checkpoints or restore operations.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

bug: Excessive task-run containers (9000+ exited) accumulating overnight in Trigger.dev self-hosted setup
1 participant