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

Refactor requests to be blazingly fast ✨ #1

Merged
merged 1 commit into from
Aug 29, 2024

Conversation

knorr3
Copy link
Contributor

@knorr3 knorr3 commented Aug 29, 2024

Proposed Changes

You're already using threads. Why execute and wait for them in serial when you can execute them simultaneously.

I didn't test the code, please merge on your own risk.

Summary by CodeRabbit

  • New Features
    • Enhanced asynchronous data fetching capabilities for improved performance and responsiveness.
    • Introduced concurrent execution for fetching and extracting recipe attributes, leading to faster data retrieval.
  • Bug Fixes
    • Resolved inefficiencies in the original data fetching process by eliminating blocking calls.

Copy link

coderabbitai bot commented Aug 29, 2024

Walkthrough

The changes enhance the asynchronous data fetching capabilities of the async_update_data function in the custom_components/chefkoch_ha/__init__.py file. The implementation now utilizes asyncio.gather for concurrent execution of multiple fetch tasks, including random, daily, and vegan recipes. Additionally, recipe attribute extraction and initial data fetching for coordinators have been updated to follow a similar concurrent pattern, improving overall efficiency and responsiveness.

Changes

Files Change Summary
custom_components/chefkoch_ha/init.py Enhanced async_update_data to use asyncio.gather for concurrent fetching and extraction of recipes and attributes. Updated initial data fetching for coordinators to run concurrently.

Sequence Diagram(s)

sequenceDiagram
    participant A as User
    participant B as AsyncUpdater
    participant C as RecipeFetcher
    participant D as AttributeExtractor

    A->>B: Request data update
    B->>C: Fetch random recipes
    B->>C: Fetch daily recipes
    B->>C: Fetch vegan recipes
    C-->>B: Return recipes
    B->>D: Extract attributes for each recipe concurrently
    D-->>B: Return extracted attributes
    B-->>A: Send updated data
Loading

🐰 "In the garden, hopping with glee,
Async updates, oh what a spree!
Recipes gathered, a feast to share,
With speedy fetches, we dance in the air!
Cheers to the code, so swift and bright,
A rabbit's delight in the moon's soft light!" 🥕


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

@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

Outside diff range, codebase verification and nitpick comments (1)
custom_components/chefkoch_ha/__init__.py (1)

44-45: Improve logging message.

The logging message "Fetching all recipes concurrently..." is clear, but it can be more descriptive by mentioning the types of recipes being fetched.

Consider updating the logging message to:

-_LOGGER.debug("Fetching all recipes concurrently...")
+_LOGGER.debug("Fetching random, daily, and vegan recipes concurrently...")
Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 45ff9b5 and 5e743eb.

Files selected for processing (1)
  • custom_components/chefkoch_ha/init.py (3 hunks)
Additional comments not posted (7)
custom_components/chefkoch_ha/__init__.py (7)

46-50: Ensure thread safety.

Using asyncio.to_thread is a good approach to run blocking code in a separate thread. However, ensure that the retrievers are thread-safe.

Verify that RandomRetriever, DailyRecipeRetriever, and SearchRetriever are thread-safe.


51-56: LGTM!

Using asyncio.gather to run tasks concurrently improves performance.

The code changes are approved.


58-64: LGTM!

Logging the results after all tasks are completed provides a clear overview of the fetched data.

The code changes are approved.


102-109: Ensure thread safety.

Using asyncio.to_thread for recipe attribute extraction is a good approach. However, ensure that the Recipe class and extract_recipe_attributes function are thread-safe.

Verify that the Recipe class and extract_recipe_attributes function are thread-safe.


113-118: LGTM!

Using asyncio.gather to run tasks concurrently improves performance.

The code changes are approved.


120-121: LGTM!

Logging the results after all tasks are completed provides a clear overview of the extracted attributes.

The code changes are approved.


167-170: LGTM!

Using asyncio.gather to run coordinator tasks concurrently improves performance.

The code changes are approved.

@FaserF
Copy link
Owner

FaserF commented Aug 29, 2024

Before:
Finished fetching Chefkoch vegan recipe data in 7.654 seconds (success: True)
Finished fetching Chefkoch random recipe data in 4.417 seconds (success: True)
Finished fetching Chefkoch daily recipe data in 3.804 seconds (success: True)

After your PR:
Finished fetching Chefkoch vegan recipe data in 5.969 seconds (success: True)
Finished fetching Chefkoch random recipe data in 4.006 seconds (success: True)
Finished fetching Chefkoch daily recipe data in 2.677 seconds (success: True)

Thanks for the improvement!

@FaserF FaserF merged commit bfb0fc3 into FaserF:main Aug 29, 2024
4 of 5 checks passed
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.

2 participants