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

[utils/common] Check only for ovos_core and ovos_messagebus #243

Merged
merged 1 commit into from
Jan 15, 2025

Conversation

goldyfruit
Copy link
Member

@goldyfruit goldyfruit commented Jan 15, 2025

if other containers with ovos in the name exists then the installer will ask for uninstall even if OVOS has been uninstalled. This might be due to containers such as ovos_stt*, ovos_tts*, etc...

Summary by CodeRabbit

  • Bug Fixes
    • Improved container detection mechanism for Docker and Podman
    • Refined filtering of existing Open Voice OS instances

@goldyfruit goldyfruit added the bug Something isn't working label Jan 15, 2025
@goldyfruit goldyfruit added this to the Commander Keen milestone Jan 15, 2025
@goldyfruit goldyfruit self-assigned this Jan 15, 2025
Copy link
Contributor

coderabbitai bot commented Jan 15, 2025

Walkthrough

The pull request modifies the detect_existing_instance function in utils/common.sh, specifically refining the Docker and Podman container name filters for detecting existing Open Voice OS instances. The changes update the container name matching criteria from broad wildcard patterns to more precise container name specifications, ensuring more accurate identification of existing containers while maintaining the original function's core logic.

Changes

File Change Summary
utils/common.sh Updated container name filters for Docker and Podman detection:
- Docker filter changed from `name=ovos*

Poem

🐰 Containers dancing, names now precise,
Docker and Podman, filters so nice!
Ovos and Hivemind, caught in the net,
No more wild matches, a filtering duet!
Rabbit's code magic, filters refined ✨


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 (2)
utils/common.sh (2)

150-153: LGTM! Consider adding error handling for Docker/Podman commands.

The container name filter changes look good and align with the PR objectives. The new pattern correctly targets only the main OVOS components while maintaining support for hivemind containers.

Consider adding error handling for Docker/Podman command failures. Here's a suggested improvement:

-    if [ -n "$(docker ps -a --filter="name=ovos_core|ovos_messagebus|hivemind*" -q 2>>"$LOG_FILE")" ]; then
+    docker_containers=$(docker ps -a --filter="name=ovos_core|ovos_messagebus|hivemind*" -q 2>>"$LOG_FILE") || docker_containers=""
+    if [ -n "$docker_containers" ]; then
        export EXISTING_INSTANCE="true"
        export INSTANCE_TYPE="containers"
-    elif [ -n "$(podman ps -a --filter="name=ovos_core|ovos_messagebus|hivemind*" -q 2>>"$LOG_FILE")" ]; then
+    elif podman_containers=$(podman ps -a --filter="name=ovos_core|ovos_messagebus|hivemind*" -q 2>>"$LOG_FILE") && [ -n "$podman_containers" ]; then
        export EXISTING_INSTANCE="true"
        export INSTANCE_TYPE="containers"

Line range hint 146-149: Add function description and consider using constants.

The function would benefit from a clear description of its purpose, return values, and side effects (exported variables).

Consider these improvements:

+# Detect existing OVOS installations by checking for:
+# 1. Docker containers (ovos_core, ovos_messagebus, or hivemind*)
+# 2. Podman containers (same pattern as Docker)
+# 3. Python virtual environment at ~/.venvs/ovos
+#
+# Exports:
+#   EXISTING_INSTANCE: "true" if any installation is found, "false" otherwise
+#   INSTANCE_TYPE: "containers" for Docker/Podman, "virtualenv" for Python venv
+
+# Container name patterns
+OVOS_CONTAINER_PATTERN="ovos_core|ovos_messagebus|hivemind*"
+
 function detect_existing_instance() {
     echo -ne "➤ Checking for existing instance... "
-    if [ -n "$(docker ps -a --filter="name=ovos_core|ovos_messagebus|hivemind*" -q 2>>"$LOG_FILE")" ]; then
+    if [ -n "$(docker ps -a --filter="name=$OVOS_CONTAINER_PATTERN" -q 2>>"$LOG_FILE")" ]; then
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between b577f4d and 5d2b161.

📒 Files selected for processing (1)
  • utils/common.sh (1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (1)
  • GitHub Check: shell-testing

@goldyfruit goldyfruit merged commit 9d2c648 into main Jan 15, 2025
7 of 10 checks passed
@goldyfruit goldyfruit deleted the fix/container_exists branch January 15, 2025 15:51
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant