Fix 404 error on "dash-folder" dashboard type

[amotl]

About

Users reported about errors without this patch, see references.

References

• 404 error on dash-folder dashboard type #190
• Client Error 404: Dashboard not found #191

[coderabbitai]

Caution

Review failed

The pull request is closed.

Summary by CodeRabbit

• Bug Fixes

  • Resolved a 404 error when listing dashboards by skipping folder-type dashboards during enumeration.

• Documentation

  • Added a changelog entry describing the dashboard enumeration fix and acknowledging contributors.

• Tests

  • Updated test cases to reflect the corrected dashboard enumeration, adjusting expected output counts accordingly.

Walkthrough

A changelog entry was added to document a fix for a 404 error when enumerating "dash-folder" dashboards. The core logic now skips fetching dashboards of type "dash-folder" in the fetch_dashboards method. Corresponding test assertions were updated to expect fewer results, reflecting the exclusion of folder-type dashboards.

Changes

File(s)	Change Summary
CHANGES.rst	Added changelog entry for fix excluding "dash-folder" dashboards from enumeration; acknowledged contributors.
grafana_wtf/core.py	Modified fetch_dashboards to skip entries with "type": "dash-folder" during dashboard fetching.
tests/test_commands.py	Updated test assertions to expect two results instead of three, aligning with the new folder exclusion behavior.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant GrafanaEngine
    participant DashboardAPI

    User->>GrafanaEngine: fetch_dashboards()
    loop For each dashboard in dashboard_list
        alt dashboard.type == "dash-folder"
            GrafanaEngine-->>GrafanaEngine: Skip this dashboard
        else
            GrafanaEngine->>DashboardAPI: fetch_dashboard(dashboard)
            DashboardAPI-->>GrafanaEngine: return dashboard data
        end
    end
    GrafanaEngine-->>User: return dashboards (excluding folders)

Loading

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~7 minutes

Poem

In the warren of dashboards, a folder slipped by,
No more 404s to make rabbits sigh.
Tests now count just two, not three,
As folders hop past, wild and free.
Thanks to the team, the fix is neat—
Bugs are nibbled, code is sweet! 🐇✨

---

📜 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 8d7f9ed and 4c481ca.

📒 Files selected for processing (3)

• CHANGES.rst (1 hunks)
• grafana_wtf/core.py (1 hunks)
• tests/test_commands.py (2 hunks)

✨ Finishing Touches

• 📝 Generate Docstrings

🧪 Generate unit tests

• Create PR with unit tests
• Post copyable unit tests in a comment
• Commit unit tests in branch fix-dash

---

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

‼️ IMPORTANT
Auto-reply has been disabled for this repository in the CodeRabbit settings. The CodeRabbit bot will not respond to your replies unless it is explicitly tagged.

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

[codecov]

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 84.45%. Comparing base (8d7f9ed) to head (4c481ca).
⚠️ Report is 1 commits behind head on main.

Additional details and impacted files

@@            Coverage Diff             @@
##             main     #195      +/-   ##
==========================================
- Coverage   84.51%   84.45%   -0.07%     
==========================================
  Files           9        9              
  Lines        1124     1126       +2     
==========================================
+ Hits          950      951       +1     
- Misses        174      175       +1     

Flag	Coverage Δ
unittests	84.45% <100.00%> (-0.07%)	⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.