fix(connect): remove unraid-api folder before creating symlink

[elibosley]

During plugin installation, if /usr/local/bin/unraid-api exists as a directory, the installation fails because rm -f cannot remove a directory. This change replaces rm -f with rm -rf to ensure that the path is removed regardless of whether it is a file or a directory, allowing the symlink to be created successfully.

Summary by CodeRabbit

• Bug Fixes
  • Improved cleanup process to ensure both files and directories related to the API are properly removed during uninstallation.

[coderabbitai]

Caution

Review failed

The pull request is closed.

Walkthrough

The change updates the uninstall script for a plugin by modifying the command that removes usr/local/bin/unraid-api, switching from rm -f to rm -rf. This allows for recursive removal, handling both files and directories at that path. No other parts of the script or project are modified.

Changes

Cohort / File(s)	Change Summary
Uninstall Script Update plugin/source/dynamix.unraid.net/install/doinst.sh	Changed removal command for usr/local/bin/unraid-api from rm -f to rm -rf to allow recursive deletion.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Possibly related PRs

• feat: use plugin file for install and uninstall #995: Restructures install and uninstall logic, including file removals and script simplification, which relates to this PR's update to the uninstall process.

Suggested reviewers

• pujitm
• mdatelle

Poem

A script with a hop and a dash,
Now deletes with a recursive bash!
Whether file or a nest,
It cleans up the rest—
Unraid’s uninstall, quick as a flash!
🐇✨

Note

⚡️ Unit Test Generation is now available in beta!

Learn more here, or try it out under "Finishing Touches" below.

---

📜 Recent review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 8005b8c and 8df49d9.

📒 Files selected for processing (1)

• plugin/source/dynamix.unraid.net/install/doinst.sh (1 hunks)

✨ Finishing Touches

• 📝 Generate Docstrings

🧪 Generate unit tests

• Create PR with unit tests
• Post copyable unit tests in a comment
• Commit unit tests in branch fix/unraid-api-folder-check

---

🪧 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.
  • Explain this complex logic.
  • 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 explain this code block.
  • @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 explain its main purpose.
  • @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.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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.
• @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
• @coderabbitai generate unit tests to generate unit tests for this 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.

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.

[claude]

Claude finished @elibosley's task —— View job

---

PR Review: Fix unraid-api folder check

Reviewing the changes to fix the unraid-api symlink creation issue.

Todo List:

• Read and analyze the installation script
• Review the specific change from rm -f to rm -rf
• Assess security implications
• Check for potential issues and alternatives
• Provide comprehensive review feedback

Review Findings

✅ Code Quality & Best Practices

The change is appropriate and well-justified. The modification from rm -f to rm -rf on line 16 of doinst.sh correctly addresses the installation failure when /usr/local/bin/unraid-api exists as a directory.

✅ Bug Fix Validation

• Problem: rm -f cannot remove directories, causing symlink creation to fail
• Solution: rm -rf handles both files and directories correctly
• Context: This path should only contain either:
  • A symlink to the CLI (expected case)
  • A directory (edge case causing the bug)
  • A regular file (unlikely but possible)

✅ Security Assessment

The security risk is minimal and acceptable because:

• Controlled path: The script targets a specific, known path (usr/local/bin/unraid-api)
• Installation context: Runs during plugin installation with appropriate privileges
• Consistent pattern: The cleanup script (cleanup.sh:94) already uses rm -rf for the same path
• No user input: The path is hardcoded, not derived from user input

✅ Consistency Check

The change aligns with existing patterns:

• Cleanup script uses rm -rf /usr/local/bin/unraid-api (line 94)
• Installation script now consistently uses rm -rf usr/local/bin/unraid-api (line 16)

🔍 Minor Observations

1. Path consistency: Installation script uses relative path (usr/local/bin/unraid-api) while cleanup uses absolute path (/usr/local/bin/unraid-api) - this is likely intentional for the installation context
2. No error handling: Neither the old nor new version checks if the removal succeeded, but this is consistent with the script's general approach

✅ Test Coverage

While there are no automated tests for this shell script, the fix is:

• Low risk: Simple, targeted change
• Self-evident: Addresses a clear failure case
• Reversible: Can be easily reverted if issues arise

Recommendation

✅ APPROVE - This is a solid bug fix that:

• Correctly addresses the reported installation failure
• Maintains security best practices
• Follows existing code patterns
• Has minimal risk of regression

The change is minimal, targeted, and necessary for proper plugin installation when the target path exists as a directory.

---

[github-actions]

This plugin has been deployed to Cloudflare R2 and is available for testing.
Download it at this URL:

https://preview.dl.unraid.net/unraid-api/tag/PR1556/dynamix.unraid.net.plg