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

Enable Smokescreen proxy for annotation worker, same as for export worker #8199

Merged
merged 2 commits into from
Jul 24, 2024

Conversation

azhavoro
Copy link
Contributor

@azhavoro azhavoro commented Jul 19, 2024

…rker

Motivation and context

How has this been tested?

Checklist

  • I submit my changes into the develop branch
  • I have created a changelog fragment
  • I have updated the documentation accordingly
  • I have added tests to cover my changes
  • I have linked related issues (see GitHub docs)
  • I have increased versions of npm packages if it is necessary
    (cvat-canvas,
    cvat-core,
    cvat-data and
    cvat-ui)

License

  • I submit my code changes under the same MIT License that covers the project.
    Feel free to contact the maintainers if that's a concern.

Summary by CodeRabbit

  • New Features
    • Introduced a new program configuration for "smokescreen," enhancing service management capabilities.
    • Allowed for customizable listening IP and options through environment variables.

Copy link
Contributor

coderabbitai bot commented Jul 19, 2024

Important

Review skipped

Auto incremental reviews are disabled on this repository.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Walkthrough

The recent changes introduce a new program configuration for "smokescreen" within the supervisord management system. This enhancement allows supervisord to manage the smokescreen process, specifying its command and parameters, which improves service management capabilities. The overall structure of the configuration file remains unchanged, ensuring seamless integration of the new feature.

Changes

Files Change Summary
supervisord/worker.annotation.conf Added new program configuration [program:smokescreen] to manage the smokescreen process with specified command and options.

Sequence Diagram(s)

(No sequence diagrams generated as the changes are straightforward and do not necessitate visual representation.)

Poem

🐰 In the land of code where the rabbit hops,
A new smokescreen program, we add to the crops.
With commands and options, it starts with a cheer,
Managing services, bringing us near!
Let's celebrate change, with a jump and a skip,
In the world of supervisord, let’s take a trip! 🥕✨


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.
    • @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 as 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 resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

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.

@azhavoro azhavoro changed the title Enable Smokescreen proxy for annotation worker, same as for export wo… Enable Smokescreen proxy for annotation worker, same as for export worker Jul 19, 2024
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

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 6fea78c and 589c1d4.

Files selected for processing (1)
  • supervisord/worker.annotation.conf (1 hunks)
Additional comments not posted (2)
supervisord/worker.annotation.conf (2)

27-27: New program configuration for smokescreen added.

The introduction of the [program:smokescreen] section aligns with the PR objective to enable the Smokescreen proxy for the annotation worker. This addition enhances the proxy capabilities and is well-structured.


29-29: Command for smokescreen program specified correctly.

The command smokescreen --listen-ip=127.0.0.1 %(ENV_SMOKESCREEN_OPTS)s is correctly defined, ensuring that the Smokescreen proxy will run with the appropriate settings.

@azhavoro azhavoro requested a review from nmanovic as a code owner July 19, 2024 07:28
Copy link

@codecov-commenter
Copy link

Codecov Report

All modified and coverable lines are covered by tests ✅

Please upload report for BASE (develop@6fea78c). Learn more about missing BASE report.

Additional details and impacted files
@@            Coverage Diff             @@
##             develop    #8199   +/-   ##
==========================================
  Coverage           ?   83.37%           
==========================================
  Files              ?      388           
  Lines              ?    41305           
  Branches           ?     3854           
==========================================
  Hits               ?    34437           
  Misses             ?     6868           
  Partials           ?        0           
Components Coverage Δ
cvat-ui 79.66% <ø> (?)
cvat-server 86.69% <ø> (?)

@bsekachev bsekachev merged commit 35a6f06 into develop Jul 24, 2024
33 checks passed
@cvat-bot cvat-bot bot mentioned this pull request Aug 6, 2024
@bsekachev bsekachev deleted the az/enable_smokescreen_for_annotation_worker branch August 13, 2024 09:28
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.

3 participants