[ISSUE-291] Fix setup_model_metrics() as a library

[umago]

Description

Fix nested event loop error when setup_model_metrics() is called with llama-stack used as a library.

fixes: 291

Type of change

• Refactor
• New feature
• Bug fix
• CVE fix
• Optimization
• Documentation Update
• Configuration Update
• Bump-up service version
• Bump-up dependent library
• Bump-up library or tool used for development (does not change the final image)
• CI configuration change
• Konflux configuration change
• Unit tests improvement
• Integration tests improvement
• End to end tests improvement

Related Tickets & Documents

• Related Issue #
• Closes [BUG] LSC:dev-latest fails to start when used as library #291

Checklist before requesting a review

• I have performed a self-review of my code.
• PR has passed all pre-merge test jobs.
• If it is a core feature, I have added thorough tests.

Testing

• Please provide detailed steps to perform tests related to this code change.
• How were the fix/results from this change verified? Please provide relevant screenshots or results.

Summary by CodeRabbit

• Bug Fixes

  • Improved application startup by deferring model metrics setup until the startup phase, ensuring smoother initialization.
  • Enhanced logging with a new message indicating when model metrics are being set up.

• Refactor

  • Updated model metrics setup to use asynchronous operations for better performance and reliability.

• Tests

  • Updated related unit tests to support asynchronous execution.

[coderabbitai]

Walkthrough

The setup of model metrics was moved from module import time to the application startup phase by making setup_model_metrics asynchronous and awaiting it during the app's startup event. The function was refactored to support both synchronous and asynchronous client usage, and the corresponding unit test was updated to be async.

Changes

File(s)	Change Summary
src/app/main.py	Removed direct call to setup_model_metrics; added awaited call in async startup_event with a log statement.
src/metrics/utils.py	Refactored setup_model_metrics to be async; added async client support and conditional client logic.
tests/unit/metrics/test_utis.py	Updated test function to be async and to await setup_model_metrics.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~8 minutes

Poem

In the warren where metrics grow,
Async bunnies hop to and fro.
Startup time is now just right,
No loops within loops to give us a fright!
With paws on the code and ears on the logs,
We leap through the changes—no more runtime bogs!
🐇✨

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 c7b1cf0 and 8422346.

📒 Files selected for processing (3)

• src/app/main.py (1 hunks)
• src/metrics/utils.py (1 hunks)
• tests/unit/metrics/test_utis.py (2 hunks)

⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)

• GitHub Check: build-pr

🔇 Additional comments (7)

src/metrics/utils.py (4)

4-4: LGTM: Async client import added correctly.

The import of AsyncLlamaStackClientHolder alongside the existing synchronous client is appropriate for supporting both usage modes.

---

11-11: LGTM: Function signature correctly converted to async.

Converting setup_model_metrics() to async is the right approach to resolve the nested event loop issue when used as a library.

---

13-17: LGTM: Conditional client usage addresses the core issue.

The conditional logic correctly uses the async client when use_as_library_client is true and the sync client otherwise. This properly addresses the nested event loop error mentioned in the PR objectives.

---

21-21: LGTM: Efficient model list usage.

Using the model_list variable instead of calling .list() again on the client is a good optimization that avoids redundant API calls.

src/app/main.py (1)

84-85: LGTM: Properly moved to startup event with logging.

Moving setup_model_metrics() to the async startup event handler correctly addresses the nested event loop issue. The function is properly awaited and includes helpful logging for debugging.

tests/unit/metrics/test_utis.py (2)

6-6: LGTM: Test function correctly converted to async.

The test function signature is properly updated to be async to match the function under test.

---

54-54: LGTM: Function call properly awaited.

The call to setup_model_metrics() is correctly awaited in the test.

✨ Finishing Touches

• 📝 Generate Docstrings

🧪 Generate unit tests

• Create PR with unit tests
• Post copyable unit tests in a comment

---

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

[manstis]

LGTM 👍

[ldjebran]

LGTM