OCPBUGS-65831: Fix catalog service swapping description and markdownDescription fields #15750

TheRealJon · 2025-11-20T16:12:36Z

The catalog service was incorrectly parsing FBC from catalogd:

Short plain-text descriptions were stored in markdownDescription
Long markdown-formatted descriptions were stored in description

This fix corrects the field mapping:

csvMetadata.Annotations["description"] → item.Description (short, plain-text)
csvMetadata.Description → item.MarkdownDescription (long, markdown)

Also removed fallback logic for markdownDescription to keep it empty when not available, and removed unused pkg parameter.

🤖 Generated with Claude Code

The catalog service was incorrectly parsing FBC from catalogd: - Short plain-text descriptions were stored in markdownDescription - Long markdown-formatted descriptions were stored in description This fix corrects the field mapping: - csvMetadata.Annotations["description"] → item.Description (short, plain-text) - csvMetadata.Description → item.MarkdownDescription (long, markdown) Also removed fallback logic for markdownDescription to keep it empty when not available, and removed unused pkg parameter. 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <[email protected]>

openshift-ci-robot · 2025-11-20T16:12:42Z

@TheRealJon: This pull request references Jira Issue OCPBUGS-65831, which is invalid:

expected the bug to target the "4.21.0" version, but no target version was set

Comment /jira refresh to re-evaluate validity if changes to the Jira bug are made, or edit the title of this pull request to link to a different bug.

The bug has been updated to refer to the pull request using the external bug tracker.

In response to this:

The catalog service was incorrectly parsing FBC from catalogd:

Short plain-text descriptions were stored in markdownDescription

Long markdown-formatted descriptions were stored in description

This fix corrects the field mapping:

csvMetadata.Annotations["description"] → item.Description (short, plain-text)

csvMetadata.Description → item.MarkdownDescription (long, markdown)

Also removed fallback logic for markdownDescription to keep it empty when not available, and removed unused pkg parameter.

🤖 Generated with Claude Code

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the openshift-eng/jira-lifecycle-plugin repository.

coderabbitai · 2025-11-20T16:12:54Z

Walkthrough

Refactored description derivation logic in the OLM catalog module. Removed helper functions for plain text and markdown description extraction. Updated the withDescription function to prioritize CSV annotation metadata and fall back to package description. Simplified withMarkdownDescription to use CSV metadata directly instead of deriving from multiple sources.

Changes

Cohort / File(s)	Summary
OLM Catalog Description Refactoring `pkg/olm/catalog.go`	Removed `getPlainTextDescription` and `getMarkdownDescription` helper functions. Updated `withDescription` to initialize with package description, check CSV annotations, and use `DescriptionOLMAnnotationKey` when available. Changed `withMarkdownDescription` signature to accept only CSV metadata and set description from `csvMetadata.Description`. Updated `CreateCatalogItem` call site to reflect new function signature.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~12 minutes

Single file modification with contained logic changes
Function signature updates are internal only; no exported API changes
Clear intent: prioritize CSV annotations over derived descriptions
Consider reviewing the order of precedence in description fallback logic to ensure correctness

✨ Finishing touches

📝 Generate docstrings

🧪 Generate unit tests (beta)

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

Tip

📝 Customizable high-level summaries are now available in beta!

You can now customize how CodeRabbit generates the high-level summary in your pull requests — including its content, structure, tone, and formatting.

Provide your own instructions using the high_level_summary_instructions setting.
Format the summary however you like (bullet lists, tables, multi-section layouts, contributor stats, etc.).
Use high_level_summary_in_walkthrough to move the summary from the description to the walkthrough section.

Example instruction:

"Divide the high-level summary into five sections:

📝 Description — Summarize the main change in 50–60 words, explaining what was done.

📓 References — List relevant issues, discussions, documentation, or related PRs.

📦 Dependencies & Requirements — Mention any new/updated dependencies, environment variable changes, or configuration updates.

📊 Contributor Summary — Include a Markdown table showing contributions:
| Contributor | Lines Added | Lines Removed | Files Changed |

✔️ Additional Notes — Add any extra reviewer context.
Keep each section concise (under 200 words) and use bullet or numbered lists for clarity."

Note: This feature is currently in beta for Pro-tier users, and pricing will be announced later.

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

openshift-ci · 2025-11-20T16:13:46Z

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: TheRealJon

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

~~pkg/OWNERS~~ [TheRealJon]

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

coderabbitai

Actionable comments posted: 1

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

Cache: Disabled due to data retention organization setting

Knowledge base: Disabled due to Reviews -> Disable Knowledge Base setting

📥 Commits

Reviewing files that changed from the base of the PR and between 86c7b34 and 113825e.

📒 Files selected for processing (1)

pkg/olm/catalog.go (3 hunks)

🧰 Additional context used

📓 Path-based instructions (1)

**

⚙️ CodeRabbit configuration file

-Focus on major issues impacting performance, readability, maintainability and security. Avoid nitpicks and avoid verbosity.

Files:

pkg/olm/catalog.go

🔇 Additional comments (2)

pkg/olm/catalog.go (2)

245-253: LGTM! Correct field mapping.

The function now correctly maps csvMetadata.Description (long markdown) to item.MarkdownDescription, and intentionally removes the fallback logic as stated in the PR objectives. Explicitly setting to empty string when csvMetadata is nil is good defensive programming.

84-84: LGTM! Call site correctly updated.

The function call correctly reflects the updated signature of withMarkdownDescription with the pkg parameter removed.

coderabbitai · 2025-11-20T16:15:13Z

pkg/olm/catalog.go

 // Plain text description takes precedence, fall back to markdown description if empty
 func withDescription(item *ConsoleCatalogItem, csvMetadata *property.CSVMetadata, pkg *declcfg.Package) {
+	item.Description = pkg.Description
+	if csvMetadata == nil {
+		return
+	}

-	item.Description = getPlainTextDescription(csvMetadata, pkg)
+	if csvMetadata.Annotations == nil {
+		return
+	}

+	item.Description = csvMetadata.Annotations[DescriptionOLMAnnotationKey]
 	if item.Description == "" {
-		item.Description = getMarkdownDescription(csvMetadata)
+		item.Description = pkg.Description
 	}
 }


⚠️ Potential issue | 🟡 Minor

Update outdated comment.

The comment on line 186 states "fall back to markdown description if empty", but the implementation falls back to pkg.Description (line 199), not markdown description. This appears to be a remnant from the previous implementation that used helper functions.

The logic itself correctly implements the intended mapping: csvMetadata.Annotations[DescriptionOLMAnnotationKey] → item.Description with pkg.Description as fallback.

-// Plain text description takes precedence, fall back to markdown description if empty +// Plain text description from CSV annotations, falls back to package description func withDescription(item *ConsoleCatalogItem, csvMetadata *property.CSVMetadata, pkg *declcfg.Package) {

🤖 Prompt for AI Agents

In pkg/olm/catalog.go around lines 186 to 201, the comment saying "fall back to markdown description if empty" is outdated because the code actually falls back to pkg.Description; update the comment to accurately describe behavior (e.g., "plain text description takes precedence, fall back to package description if empty") so it matches the implemented logic and remove any reference to markdown helper behavior.

TheRealJon · 2025-11-24T14:20:20Z

/retest

TheRealJon · 2025-11-24T15:41:52Z

/jira refresh

openshift-ci-robot · 2025-11-24T15:41:59Z

@TheRealJon: This pull request references Jira Issue OCPBUGS-65831, which is valid. The bug has been moved to the POST state.

3 validation(s) were run on this bug

bug is open, matching expected state (open)
bug target version (4.21.0) matches configured target version for branch (4.21.0)
bug is in the state ASSIGNED, which is one of the valid states (NEW, ASSIGNED, POST)

Requesting review from QA contact:
/cc @yapei

In response to this:

/jira refresh

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the openshift-eng/jira-lifecycle-plugin repository.

Leo6Leo · 2025-11-24T19:21:13Z

  1) Admission Webhook warning notification
       Create a pod and display Admission Webhook warning notification:
     CypressError: Timed out retrying after 30050ms: `cy.click()` failed because this element:

`<button id="save-changes" data-test="save-changes" class="pf-v6-c-button pf-m-primary" type="submit" data-ouia-component-type="PF6/Button" data-ouia-safe="true" data-ouia-component-id="OUIA-Generated-Button-primary-3">...</button>`

Seems cypress flaky
/retest

openshift-ci · 2025-11-25T00:43:59Z

@TheRealJon: all tests passed!

Full PR test history. Your PR dashboard.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository. I understand the commands that are listed here.

openshift-ci-robot added jira/valid-reference Indicates that this PR references a valid Jira ticket of any type. jira/invalid-bug Indicates that a referenced Jira bug is invalid for the branch this PR is targeting. labels Nov 20, 2025

openshift-ci bot requested review from Leo6Leo and jhadvig November 20, 2025 16:13

openshift-ci bot added the component/backend Related to backend label Nov 20, 2025

openshift-ci bot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Nov 20, 2025

coderabbitai bot reviewed Nov 20, 2025

View reviewed changes

openshift-ci-robot added the jira/valid-bug Indicates that a referenced Jira bug is valid for the branch this PR is targeting. label Nov 24, 2025

openshift-ci-robot removed the jira/invalid-bug Indicates that a referenced Jira bug is invalid for the branch this PR is targeting. label Nov 24, 2025

openshift-ci bot requested a review from yapei November 24, 2025 15:42

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

OCPBUGS-65831: Fix catalog service swapping description and markdownDescription fields #15750

OCPBUGS-65831: Fix catalog service swapping description and markdownDescription fields #15750

TheRealJon commented Nov 20, 2025

Uh oh!

openshift-ci-robot commented Nov 20, 2025

Uh oh!

coderabbitai bot commented Nov 20, 2025 •

edited

Loading

Uh oh!

openshift-ci bot commented Nov 20, 2025

Uh oh!

coderabbitai bot left a comment

Uh oh!

coderabbitai bot Nov 20, 2025

Uh oh!

TheRealJon commented Nov 24, 2025

Uh oh!

TheRealJon commented Nov 24, 2025

Uh oh!

openshift-ci-robot commented Nov 24, 2025

Uh oh!

Leo6Leo commented Nov 24, 2025

Uh oh!

openshift-ci bot commented Nov 25, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

OCPBUGS-65831: Fix catalog service swapping description and markdownDescription fields #15750

Are you sure you want to change the base?

OCPBUGS-65831: Fix catalog service swapping description and markdownDescription fields #15750

Conversation

TheRealJon commented Nov 20, 2025

Uh oh!

openshift-ci-robot commented Nov 20, 2025

Uh oh!

coderabbitai bot commented Nov 20, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Walkthrough

Changes

Estimated code review effort

Uh oh!

openshift-ci bot commented Nov 20, 2025

Uh oh!

coderabbitai bot left a comment

Choose a reason for hiding this comment

Uh oh!

coderabbitai bot Nov 20, 2025

Choose a reason for hiding this comment

Uh oh!

TheRealJon commented Nov 24, 2025

Uh oh!

TheRealJon commented Nov 24, 2025

Uh oh!

openshift-ci-robot commented Nov 24, 2025

Uh oh!

Leo6Leo commented Nov 24, 2025

Uh oh!

openshift-ci bot commented Nov 25, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

coderabbitai bot commented Nov 20, 2025 •

edited

Loading