Add "lines" and "verbose" query parameters for advanced logs

[sairon]

Proposed change

Since headers are clumsy considering the Core proxy between the frontend and Supervisor, add a way to adjust number of lines and verbose log format using query parameters as well. If both query parameters and headers are supplied, prefer the former, as it's more prominent when reading through the request logs.

Type of change

• Dependency upgrade
• Bugfix (non-breaking change which fixes an issue)
• New feature (which adds functionality to the supervisor)
• Breaking change (fix/feature causing existing functionality to break)
• Code quality improvements to existing code or addition of tests

Additional information

• This PR fixes or closes issue: fixes #
• This PR is related to issue:
• Link to documentation pull request:
• Link to cli pull request:
• Link to client library pull request:

Checklist

• The code change is tested and works locally.
• Local tests pass. Your PR cannot be merged unless tests pass
• There is no commented out code in this PR.
• I have followed the development checklist
• The code has been formatted using Ruff (ruff format supervisor tests)
• Tests have been added to verify that the new code works.

If API endpoints or add-on configuration are added/changed:

• Documentation added/updated for developers.home-assistant.io TBD
• CLI updated (if necessary)
• Client library updated (if necessary)

Summary by CodeRabbit

• New Features

  • Enhanced logging functionality with support for "verbose" and "lines" query parameters, allowing users to customize log retrieval.

• Tests

  • Introduced a new test to validate the advanced logging API's behavior with query parameters, ensuring reliable functionality.

[coderabbitai]

Walkthrough

Walkthrough

The changes involve modifications to the advanced_logs_handler function in the logging API, specifically in how log entries are formatted and retrieved based on query parameters. A new test function has been added to validate these changes, ensuring the correct handling of the lines and verbose parameters.

Changes

Files	Change Summary
supervisor/api/host.py	Modified advanced_logs_handler to check for "verbose" and "lines" query parameters for log formatting and entry range.
tests/api/test_host.py	Added test_advaced_logs_query_parameters to validate the behavior of the logging API with the new query parameters.

Sequence Diagram(s)

sequenceDiagram
    participant Client
    participant API
    participant LogFormatter
    participant Logger

    Client->>API: Request logs with "verbose" and "lines" parameters
    API->>LogFormatter: Check for "verbose" parameter
    LogFormatter-->>API: Set formatter to VERBOSE
    API->>Logger: Retrieve logs based on "lines" parameter
    Logger-->>API: Return specified number of log entries
    API-->>Client: Send log entries

Loading

Tip

We have updated our review workflow to use the Anthropic's Claude family of models. Please share any feedback in the discussion post on our Discord.

---

Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 5fbcaa8 and 4e300df.

Files selected for processing (2)

• supervisor/api/host.py (1 hunks)
• tests/api/test_host.py (1 hunks)

Additional comments not posted (3)

supervisor/api/host.py (2)

225-225: LGTM!

The code changes are approved.

---

228-232: LGTM!

The code changes are approved.

tests/api/test_host.py (1)

241-284: LGTM!

The new test function test_advaced_logs_query_parameters is well-structured and covers the essential scenarios for validating the query parameter functionality in the advanced logging API. It uses appropriate mocking and assertions to verify the expected behavior.

---

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.
  • @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 or @coderabbitai title 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.