Try to fix issues caused from old Platformio leftovers in .platformio/packages

[Jason2866]

Description:

The PR deletes all folders found with @ in tool / toolchain folder name, before installing pioarduino tools / toolchains with tl-install.

Probably fix #208

Checklist:

• The pull request is done against the latest develop branch
• Only relevant files were touched
• Only one feature/fix was added per PR, more changes are allowed when changing boards.json
• I accept the CLA

Summary by CodeRabbit

• New Features
  • Improved cleanup of tool-related directories during installation and version updates, ensuring removal of outdated or versioned folders.
  • Enhanced error handling and logging for directory removal operations.

[coderabbitai]

Important

Review skipped

Auto reviews are disabled on base/target branches other than the default branch.

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 changes add a utility function to safely remove directories matching a pattern and enhance the tool installation logic to clean up stale or versioned tool directories before caching or reinstalling tools. Additional logging and error handling are introduced to improve robustness during directory cleanup operations related to tool version management.

Changes

File(s)	Change Summary
platform.py	Added safe_remove_directory_pattern for safe pattern-based directory removal; improved _get_tool_paths and _handle_existing_tool to clean up versioned/suffixed tool directories before caching or reinstalling; added logging and error handling; imported fnmatch for pattern matching.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant Espressif32Platform
    participant FileSystem

    User->>Espressif32Platform: Install or update tool
    Espressif32Platform->>FileSystem: Scan packages directory for tool subdirs
    Espressif32Platform->>FileSystem: Remove subdirs matching tool_name + '@*' or tool_name + '.*'
    FileSystem-->>Espressif32Platform: Confirmation of removal
    Espressif32Platform->>FileSystem: Remove main tool directory (if needed)
    FileSystem-->>Espressif32Platform: Confirmation of removal
    Espressif32Platform->>User: Proceed with tool installation or caching

Loading

Assessment against linked issues

Objective	Addressed	Explanation
Ensure tool installation does not fail due to stale or mismatched tool directories (#208)	✅
Remove versioned or suffixed tool directories before reinstalling or caching tool paths (#208)	✅
Add robust error handling and logging for directory cleanup during tool installation (#208)	✅

Poem

In the warren of code, a cleanup began,
Old tool burrows swept by a gentle hand.
Patterns matched, stale paths gone,
Now fresh installs can hop along!
With safe removals and logs in tow,
The platform’s ready—let’s watch it grow!
🐇✨

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 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 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.

[Jason2866]

@swoboda1337 can you try the PR branch? I think it could fix the issues you have seen with esphome

[Jason2866]

@coderabbitai full review

[coderabbitai]

✅ Actions performed

Full review triggered.

[coderabbitai]

Actionable comments posted: 1

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 6fdcd03 and c594d41.

📒 Files selected for processing (1)

• platform.py (4 hunks)

🔇 Additional comments (3)

platform.py (3)

15-15: LGTM!

The fnmatch import is correctly added and necessary for the pattern matching functionality in the new safe_remove_directory_pattern function.

---

171-181: LGTM!

The implementation correctly identifies and removes directories containing '@' that start with the tool name. This effectively cleans up old PlatformIO versioned packages as intended.

---

331-344: LGTM!

The enhanced cleanup logic correctly removes versioned tool directories (e.g., xtensa@src, xtensa.12232) before removing the main tool directory. The sequencing ensures all related directories are cleaned up during reinstallation.