Skip to content

EDM-1997: Show alert title as received from the API by default#343

Merged
celdrake merged 1 commit into
flightctl:mainfrom
celdrake:EDM-1997-show-alert-api-message
Aug 21, 2025
Merged

EDM-1997: Show alert title as received from the API by default#343
celdrake merged 1 commit into
flightctl:mainfrom
celdrake:EDM-1997-show-alert-api-message

Conversation

@celdrake

@celdrake celdrake commented Aug 18, 2025

Copy link
Copy Markdown
Collaborator

By default, show the human-readable message for alerts provided by the API.

Summary by CodeRabbit

  • New Features
    • Alert cards now prioritize showing an alert’s provided summary as the title when available, improving clarity and context.
    • When no summary is present, titles seamlessly fall back to the usual default/translated title.
    • This update affects only how titles are displayed; performance, data loading, and other behaviors remain unchanged.

@coderabbitai

coderabbitai Bot commented Aug 18, 2025

Copy link
Copy Markdown

Walkthrough

Added a local helper to resolve alert titles using alert.annotations.summary when available, falling back to the existing translation-based title. Updated the AlertsCard title rendering to use this helper. No exports changed; no data flow, fetching, or error handling modified.

Changes

Cohort / File(s) Summary
Alerts title resolution
libs/ui-components/src/components/OverviewPage/Cards/Alerts/AlertsCard.tsx
Added getAlertTitle(alert, defaultTitle) to prefer alert.annotations.summary over the prior computed title; updated rendering to use this helper. No public API changes.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Tip

🔌 Remote MCP (Model Context Protocol) integration is now available!

Pro plan users can now connect to remote MCP servers from the Integrations page. Connect with popular remote MCPs such as Notion and Linear to add more context to your reviews and chats.

✨ 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
🪧 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.
    • 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.
  • 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 the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

CodeRabbit Commands (Invoked using PR/Issue comments)

Type @coderabbitai help to get the list of available commands.

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

Status, Documentation and Community

  • Visit our Status Page to check the current availability of CodeRabbit.
  • 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 coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

🧹 Nitpick comments (1)
libs/ui-components/src/components/OverviewPage/Cards/Alerts/AlertsCard.tsx (1)

119-124: Make helper more robust: trim and fall back to description; add explicit return type

Prevents rendering blank/whitespace summaries and covers integrations that populate description instead of summary. The explicit return type improves readability.

-const getAlertTitle = (alert: AlertManagerAlert, defaultTitle: string) => {
-  if (alert.annotations.summary) {
-    return alert.annotations.summary;
-  }
-  return defaultTitle;
-};
+const getAlertTitle = (alert: AlertManagerAlert, defaultTitle: string): string => {
+  const summary = alert.annotations?.summary?.trim();
+  if (summary) return summary;
+  // Some Alertmanager integrations populate `description` instead of `summary`
+  const description = alert.annotations?.description?.trim();
+  if (description) return description;
+  return defaultTitle;
+};

If you’d like, I can add a couple of unit tests to cover:

  • summary present
  • summary whitespace-only
  • description present, summary missing
  • both missing (falls back to defaultTitle)
📜 Review details

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

💡 Knowledge Base configuration:

  • MCP integration is disabled by default for public repositories
  • Jira integration is disabled by default for public repositories
  • Linear integration is disabled by default for public repositories

You can enable these sources in your CodeRabbit configuration.

📥 Commits

Reviewing files that changed from the base of the PR and between 19f220b and 6397f30.

📒 Files selected for processing (1)
  • libs/ui-components/src/components/OverviewPage/Cards/Alerts/AlertsCard.tsx (2 hunks)
🧰 Additional context used
🧬 Code Graph Analysis (1)
libs/ui-components/src/components/OverviewPage/Cards/Alerts/AlertsCard.tsx (1)
libs/ui-components/src/types/extraTypes.ts (1)
  • AlertManagerAlert (63-77)
🔇 Additional comments (1)
libs/ui-components/src/components/OverviewPage/Cards/Alerts/AlertsCard.tsx (1)

163-163: LGTM: Correctly prefers API-provided title with a safe fallback

Using the helper here aligns with the PR objective and preserves backward compatibility when annotations are absent.

@amalykhi amalykhi left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Verified on the branch

@celdrake celdrake merged commit dbda497 into flightctl:main Aug 21, 2025
6 checks passed
@celdrake celdrake deleted the EDM-1997-show-alert-api-message branch August 21, 2025 08:35
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