Skip to content

Fix badge for bundles with no feature ID#2931

Merged
openshift-merge-bot[bot] merged 1 commit intoopenshift-assisted:masterfrom
rawagner:fix_bundle_badges
Apr 23, 2025
Merged

Fix badge for bundles with no feature ID#2931
openshift-merge-bot[bot] merged 1 commit intoopenshift-assisted:masterfrom
rawagner:fix_bundle_badges

Conversation

@rawagner
Copy link
Member

@rawagner rawagner commented Apr 23, 2025

Summary by CodeRabbit

  • Refactor
    • Updated how support level badges are displayed for operator bundles, ensuring they are always shown and now use the bundle ID.
    • Simplified internal types by removing specific feature ID properties and using more general types.

No visible changes to app behavior are expected, but the display of support level badges is now more consistent.

@coderabbitai
Copy link

coderabbitai bot commented Apr 23, 2025

Walkthrough

This change updates how the featureId property is handled across several UI component files. The featureId prop type in NewFeatureSupportLevelBadge is changed from a specific FeatureId type to a generic string. The featureId property is removed from the BundleSpec type and from all bundle specification objects. The rendering logic for the support level badge in the operators bundle wizard is modified to always display the badge, passing a different value for featureId. No other logic or control flow is changed.

Changes

File(s) Change Summary
libs/ui-lib/lib/common/components/newFeatureSupportLevels/NewFeatureSupportLevelBadge.tsx Changed featureId prop type from FeatureId to string; removed unused import of FeatureId.
libs/ui-lib/lib/ocm/components/clusterConfiguration/operators/bundleSpecs.tsx Removed featureId property from BundleSpec type and all bundle spec objects; removed FeatureId import.
libs/ui-lib/lib/ocm/components/clusterWizard/OperatorsBundle.tsx Changed logic to always render NewFeatureSupportLevelBadge, passing `bundle.id

Sequence Diagram(s)

sequenceDiagram
    participant UI as OperatorsBundle Component
    participant Badge as NewFeatureSupportLevelBadge

    UI->>Badge: Render with featureId = bundle.id or ''
    Badge-->>UI: Render badge based on featureId (string)
Loading

Possibly related PRs

Suggested labels

lgtm, approved, size/M

Suggested reviewers

  • ammont82

Poem

A badge for every bundle, clear and bright,
No more guessing which feature’s in sight.
With types now strings, and specs made lean,
The UI’s logic is crisp and clean.
Hopping along, the rabbit’s delight—
Code refactored, everything’s right!
🐇✨

Warning

There were issues while running some tools. Please review the errors and either fix the tool's configuration or disable the tool if it's a critical failure.

🔧 ESLint

If the error stems from missing dependencies, add them to the package.json file. For unrecoverable errors (e.g., due to private dependencies), disable the tool in the CodeRabbit configuration.

libs/ui-lib/lib/common/components/newFeatureSupportLevels/NewFeatureSupportLevelBadge.tsx

Oops! Something went wrong! :(

ESLint: 8.57.1

ESLint couldn't find the config "@openshift-assisted/eslint-config" to extend from. Please check that the name of the config is correct.

The config "@openshift-assisted/eslint-config" was referenced from the config file in "/libs/ui-lib/.eslintrc.cjs".

If you still have problems, please stop by https://eslint.org/chat/help to chat with the team.

libs/ui-lib/lib/ocm/components/clusterConfiguration/operators/bundleSpecs.tsx

Oops! Something went wrong! :(

ESLint: 8.57.1

ESLint couldn't find the config "@openshift-assisted/eslint-config" to extend from. Please check that the name of the config is correct.

The config "@openshift-assisted/eslint-config" was referenced from the config file in "/libs/ui-lib/.eslintrc.cjs".

If you still have problems, please stop by https://eslint.org/chat/help to chat with the team.

libs/ui-lib/lib/ocm/components/clusterWizard/OperatorsBundle.tsx

Oops! Something went wrong! :(

ESLint: 8.57.1

ESLint couldn't find the config "@openshift-assisted/eslint-config" to extend from. Please check that the name of the config is correct.

The config "@openshift-assisted/eslint-config" was referenced from the config file in "/libs/ui-lib/.eslintrc.cjs".

If you still have problems, please stop by https://eslint.org/chat/help to chat with the team.


📜 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 117cb6f and 7d6f7d6.

📒 Files selected for processing (3)
  • libs/ui-lib/lib/common/components/newFeatureSupportLevels/NewFeatureSupportLevelBadge.tsx (1 hunks)
  • libs/ui-lib/lib/ocm/components/clusterConfiguration/operators/bundleSpecs.tsx (1 hunks)
  • libs/ui-lib/lib/ocm/components/clusterWizard/OperatorsBundle.tsx (1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (6)
  • GitHub Check: tests
  • GitHub Check: unit-tests
  • GitHub Check: circular-deps
  • GitHub Check: translation-files
  • GitHub Check: format
  • GitHub Check: lint
🔇 Additional comments (6)
libs/ui-lib/lib/ocm/components/clusterConfiguration/operators/bundleSpecs.tsx (3)

3-3: Import statement updated correctly

The import statement has been correctly updated to only include OPENSHIFT_AI_REQUIREMENTS_LINK after removing the FeatureId import.


5-10: BundleSpec type updated correctly

The featureId property has been removed from the BundleSpec type definition, which aligns with the PR objective to fix badge handling for bundles with no feature ID.


12-61: Bundle specifications updated consistently

All bundle specifications have been updated to remove the featureId property while maintaining all other properties. This change is consistent across all bundle definitions and aligns with the type definition change.

libs/ui-lib/lib/common/components/newFeatureSupportLevels/NewFeatureSupportLevelBadge.tsx (2)

3-3: Import statement updated correctly

The import statement has been correctly updated to only include isPreviewSupportLevel after removing the FeatureId import.


8-8: Prop type generalized appropriately

The featureId prop type has been changed from a specific FeatureId type to a more general string type. This change allows more flexibility in providing feature identifiers, specifically enabling the use of bundle IDs as feature identifiers.

libs/ui-lib/lib/ocm/components/clusterWizard/OperatorsBundle.tsx (1)

189-199: Badge rendering logic updated correctly

The support level badge rendering logic has been updated to always render the badge component with the bundle ID as the feature identifier. This approach ensures that bundles without a specific feature ID will still display the appropriate badge based on their support level.

This change works well with the updated prop type in NewFeatureSupportLevelBadge which now accepts a string rather than a specific FeatureId type.

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

@openshift-ci openshift-ci bot requested review from ElayAharoni and jgyselov April 23, 2025 08:05
@openshift-ci openshift-ci bot added approved Indicates a PR has been approved by an approver from all required OWNERS files. size/M Denotes a PR that changes 30-99 lines, ignoring generated files. labels Apr 23, 2025
@ammont82
Copy link
Member

/lgtm

@openshift-ci openshift-ci bot added the lgtm Indicates that a PR is ready to be merged. label Apr 23, 2025
@openshift-ci
Copy link

openshift-ci bot commented Apr 23, 2025

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: ammont82, rawagner

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

The pull request process is described here

Details Needs approval from an approver in each of these files:

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

@ammont82
Copy link
Member

/cherry-pick releases/v2.39

@openshift-cherrypick-robot
Copy link
Contributor

@ammont82: once the present PR merges, I will cherry-pick it on top of releases/v2.39 in a new PR and assign it to you.

Details

In response to this:

/cherry-pick releases/v2.39

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.

@openshift-merge-bot openshift-merge-bot bot merged commit 46ea82d into openshift-assisted:master Apr 23, 2025
11 checks passed
@openshift-cherrypick-robot
Copy link
Contributor

@ammont82: new pull request created: #2932

Details

In response to this:

/cherry-pick releases/v2.39

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

approved Indicates a PR has been approved by an approver from all required OWNERS files. lgtm Indicates that a PR is ready to be merged. size/M Denotes a PR that changes 30-99 lines, ignoring generated files.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants