feat: sort health collection by state

[schneider-felix]

Summary by CodeRabbit

• New Features
  • Health and performance check results are now automatically sorted by status, making it easier to identify critical issues at a glance.

[coderabbitai]

Walkthrough

A new sorting mechanism based on state priority was introduced for health and performance collections. The HealthCollection class now includes a sortByState() method, and the controller ensures collections are sorted by state before returning JSON responses. No other logic or interface changes were made.

Changes

File(s)	Change Summary
src/Components/Health/HealthCollection.php	Added STATE_PRIORITY constant and sortByState() method for sorting items by state priority.
src/Controller/HealthController.php	Updated to call sortByState() on health and performance collections before returning results.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant HealthController
    participant HealthCollection

    User->>HealthController: Request status()
    HealthController->>HealthCollection: Collect results
    HealthController->>HealthCollection: sortByState()
    HealthCollection-->>HealthController: Sorted results
    HealthController-->>User: Return JSON response

Loading

Poem

In fields of health, where states align,
Now sorted neat, from red to green in line.
With code so crisp, the rabbits cheer,
For order reigns, and checks are clear.
🐇✨

✨ Finishing Touches

• 📝 Generate Docstrings

---

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.

[coderabbitai]

Actionable comments posted: 0

🧹 Nitpick comments (1)

src/Components/Health/HealthCollection.php (1)

21-26: Consider adjusting the fallback priority for unknown states.

The implementation is clean and uses the spaceship operator correctly. However, the fallback value of -1 for unknown states means they will be sorted before ERROR states, which might not be the intended behavior.

Consider using a higher priority value (e.g., 99) to place unknown states at the end of the list:

-return (self::STATE_PRIORITY[$a->state] ?? -1) <=> (self::STATE_PRIORITY[$b->state] ?? -1);
+return (self::STATE_PRIORITY[$a->state] ?? 99) <=> (self::STATE_PRIORITY[$b->state] ?? 99);

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between aad1adc and 9b3215e.

📒 Files selected for processing (2)

• src/Components/Health/HealthCollection.php (1 hunks)
• src/Controller/HealthController.php (2 hunks)

🧰 Additional context used

🧬 Code Graph Analysis (2)

src/Controller/HealthController.php (1)

src/Components/Health/HealthCollection.php (1)

• sortByState (21-26)

src/Components/Health/HealthCollection.php (1)

src/Components/Health/SettingsResult.php (1)

• SettingsResult (9-79)

🔇 Additional comments (3)

src/Components/Health/HealthCollection.php (1)

14-19: LGTM! Well-structured priority mapping.

The state priority mapping is logical and follows the expected severity order with ERROR having the highest priority (0) and GREEN having the lowest (3).

src/Controller/HealthController.php (2)

41-41: LGTM! Correct placement of sorting call.

The sortByState() call is properly placed after collecting all health checks and before returning the JSON response.

---

54-54:

Details

✅ Verification successful

Verify that PerformanceCollection implements sortByState() method.

The code assumes that PerformanceCollection has a sortByState() method, but we only see the implementation in HealthCollection. This could cause a fatal error if the method doesn't exist.

---

🏁 Script executed:

#!/bin/bash
# Description: Verify that PerformanceCollection has the sortByState() method
# Expected: PerformanceCollection should either extend HealthCollection or implement its own sortByState() method

# Search for PerformanceCollection class definition
ast-grep --pattern 'class PerformanceCollection {
  $$$
}'

# Search for sortByState method in PerformanceCollection
rg -A 10 "class PerformanceCollection" | rg -A 20 "sortByState"

# Check if PerformanceCollection extends HealthCollection
rg "class PerformanceCollection extends"

Length of output: 268

---

No action needed: PerformanceCollection inherits sortByState() from HealthCollection.

Verified via the class definition in src/Components/Health/PerformanceCollection.php:

class PerformanceCollection extends HealthCollection

Since HealthCollection implements sortByState(), the call in HealthController is safe.