Add async wrapper for commonly used filesystem functions

[emontnemery]

Add async wrapper for commonly used filesystem functions os.path.exists and os.remove

This PR simply wraps file system accesses which currently happen from the event loop, separate follow-up PRs will handle optimizing the number of file system calls as needed.

[coderabbitai]

Walkthrough

Walkthrough

The update focuses on enhancing the Home Assistant Community Store (HACS) by converting various functions to asynchronous operations. This shift improves the efficiency and responsiveness of file system interactions and frontend setup processes. The changes span multiple files, introducing asynchronous methods for checking file existence, removing files, and setting up frontend endpoints, ensuring that HACS can perform these tasks without blocking the main execution flow.

Changes

File(s)	Change Summary
custom_components/hacs/__init__.py	Updated async_startup function to await async_register_frontend, converting it to an async operation.
custom_components/hacs/base.py	Introduced asynchronous file system checks and converted frontend endpoint setup methods to async.
custom_components/hacs/frontend.py	Converted async_register_frontend function to async, adding await for method calls within it.
custom_components/hacs/repositories/base.py	Replaced synchronous file system operations with asynchronous async_exists and async_remove.
custom_components/hacs/repositories/plugin.py	Updated async_post_installation method to use await for async_setup_frontend_endpoint_plugin.
custom_components/hacs/repositories/theme.py	Modified async_post_installation method to await async_setup_frontend_endpoint_themes.
custom_components/hacs/utils/file_system.py	Introduced async_exists and async_remove functions for asynchronous file system operations.
tests/utils/test_fs_util.py	Added test cases for async_exists and async_remove to validate their asynchronous behavior.

---

Recent Review Details

Configuration used: CodeRabbit UI
Review profile: ASSERTIVE

Commits

Files that changed from the base of the PR and between 6fe9fe6 and ed68737.

Files selected for processing (8)

• custom_components/hacs/init.py (1 hunks)
• custom_components/hacs/base.py (4 hunks)
• custom_components/hacs/frontend.py (2 hunks)
• custom_components/hacs/repositories/base.py (4 hunks)
• custom_components/hacs/repositories/plugin.py (1 hunks)
• custom_components/hacs/repositories/theme.py (1 hunks)
• custom_components/hacs/utils/file_system.py (1 hunks)
• tests/utils/test_fs_util.py (1 hunks)

Additional Context Used

Ruff (7)

custom_components/hacs/__init__.py (2)

9-9: os imported but unused; consider removing, adding to __all__, or using a redundant alias

---

132-132: custom_components.custom_updater imported but unused; consider using importlib.util.find_spec to test for availability

custom_components/hacs/base.py (1)

8-8: logging imported but unused

custom_components/hacs/frontend.py (1)

8-8: homeassistant.core.callback imported but unused

tests/utils/test_fs_util.py (3)

3-3: contextlib.nullcontext imported but unused

---

4-4: os imported but unused

---

10-10: tests.common.fixture imported but unused

Additional comments not posted (15)

custom_components/hacs/utils/file_system.py (2)

15-17: The implementation of async_exists correctly uses the executor to handle the file existence check asynchronously.

---

20-29: The async_remove function is well-implemented with proper exception handling and conditional behavior based on the missing_ok flag.

tests/utils/test_fs_util.py (2)

13-18: The tests for async_exists correctly validate both the non-existence and existence scenarios.

---

21-40: The tests for async_remove effectively cover the expected behavior under different conditions, including the handling of FileNotFoundError based on the missing_ok flag.

custom_components/hacs/frontend.py (1)

Line range hint 33-86: The changes to async_register_frontend correctly implement the asynchronous behavior for setting up themes and plugins. This ensures that all operations complete before proceeding.

custom_components/hacs/repositories/theme.py (1)

40-40: The change to await async_setup_frontend_endpoint_themes in async_post_installation is correct and ensures that the theme setup completes before proceeding.

custom_components/hacs/repositories/plugin.py (1)

58-58: The change to await async_setup_frontend_endpoint_plugin in async_post_installation is correct and ensures that the plugin setup completes before proceeding.

custom_components/hacs/__init__.py (1)

166-166: The change to await async_register_frontend in the startup sequence is correct and ensures that the frontend registration completes before proceeding.

custom_components/hacs/base.py (3)

68-68: The import of async_exists is correctly added to support asynchronous file operations.

---

1207-1212: Conversion of async_setup_frontend_endpoint_themes to asynchronous operation is correctly implemented.

---

68-68: Remove unused import of logging.

- import logging

Likely invalid or redundant comment.

custom_components/hacs/repositories/base.py (4)

34-34: Ensure the new imports are used appropriately throughout the file.

---

800-800: The use of async_remove with missing_ok=True correctly addresses previous concerns about handling non-existent files gracefully.

---

814-814: The replacement of synchronous file operations with async_exists and async_remove in remove_local_directory aligns with the PR's objectives and should enhance system responsiveness.

Also applies to: 821-821, 825-825

---

945-947: The use of async_exists in async_install_repository to check for the existence of a directory asynchronously is a good application of asynchronous programming principles.

---

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

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

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 a review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai help to get help.

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

CodeRabbit Configration 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.

[coderabbitai]

Actionable comments posted: 1

Outside diff range and nitpick comments (2)

custom_components/hacs/frontend.py (1)

Line range hint 8-8: Remove unused import: callback.

- from homeassistant.core import HomeAssistant, callback
+ from homeassistant.core import HomeAssistant

custom_components/hacs/__init__.py (1)

Line range hint 9-9: Remove unused import: os.

- import os