Skip to content

ABI updates:#2985

Merged
openshift-merge-bot[bot] merged 1 commit intoopenshift-assisted:masterfrom
rawagner:abi_alerts
Jun 19, 2025
Merged

ABI updates:#2985
openshift-merge-bot[bot] merged 1 commit intoopenshift-assisted:masterfrom
rawagner:abi_alerts

Conversation

@rawagner
Copy link
Member

@rawagner rawagner commented Jun 9, 2025

  • clear download alerts
  • add AI header + tech preview badge

Summary by CodeRabbit

  • New Features

    • Added a Developer Preview badge to the Assisted Installer header when a specific feature flag is enabled.
  • Bug Fixes

    • Improved alert handling during credential downloads by clearing previous alerts before starting a new download.
  • Refactor

    • Simplified and standardized the header and breadcrumb rendering on cluster-related pages by consolidating components and updating prop usage.

@openshift-ci openshift-ci bot requested review from ElayAharoni and batzionb June 9, 2025 12:39
@coderabbitai
Copy link

coderabbitai bot commented Jun 9, 2025

Walkthrough

This update refactors cluster page and header components to streamline header rendering and feature flag handling, modifies the credentials download flow to clear alerts before downloads, and updates component APIs to use children instead of custom props. Some components are removed or consolidated for clarity and maintainability.

Changes

Files/Groups Change Summary
libs/ui-lib/lib/ocm/components/clusterWizard/CredentialsDownload.tsx Added alert clearing before credentials download by invoking clearAlerts() at the start of download.
libs/ui-lib/lib/ocm/components/clusters/AssistedInstallerHeader.tsx Uses useFeature to conditionally render DeveloperPreview based on a feature flag.
libs/ui-lib/lib/ocm/components/clusters/ClusterPage.tsx Adds a PageSection with AssistedInstallerHeader above the main cluster page content.
libs/ui-lib/lib/ocm/components/clusters/NewClusterPage.tsx Refactors NewClusterPageGeneric to use children prop; removes NewClusterTitleSection.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant CredentialsDownload
    participant Alerts
    participant Downloader

    User->>CredentialsDownload: Click "Download Credentials"
    CredentialsDownload->>Alerts: clearAlerts()
    CredentialsDownload->>CredentialsDownload: setDownloading(true)
    CredentialsDownload->>Downloader: download files
    Downloader-->>CredentialsDownload: download complete
    CredentialsDownload->>CredentialsDownload: setDownloading(false)
Loading
sequenceDiagram
    participant ClusterPage
    participant AssistedInstallerHeader
    participant useFeature

    ClusterPage->>AssistedInstallerHeader: Render header
    AssistedInstallerHeader->>useFeature: Check feature flag
    useFeature-->>AssistedInstallerHeader: Return flag status
    AssistedInstallerHeader->>ClusterPage: Render header (with/without DeveloperPreview)
Loading

Possibly related PRs

Suggested labels

lgtm

Suggested reviewers

  • ElayAharoni
  • celdrake

Poem

A header here, a breadcrumb there,
Alerts now vanish, clear as air.
Credentials download, smooth and neat,
Feature flags make code complete.
Components pruned, the path is bright—
The cluster’s future’s looking 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/ocm/components/clusterWizard/CredentialsDownload.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/clusters/AssistedInstallerHeader.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/clusters/ClusterPage.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.

  • 1 others

📜 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 5d5ef54 and e49e4cf.

📒 Files selected for processing (4)
  • libs/ui-lib/lib/ocm/components/clusterWizard/CredentialsDownload.tsx (2 hunks)
  • libs/ui-lib/lib/ocm/components/clusters/AssistedInstallerHeader.tsx (1 hunks)
  • libs/ui-lib/lib/ocm/components/clusters/ClusterPage.tsx (1 hunks)
  • libs/ui-lib/lib/ocm/components/clusters/NewClusterPage.tsx (4 hunks)
🚧 Files skipped from review as they are similar to previous changes (4)
  • libs/ui-lib/lib/ocm/components/clusterWizard/CredentialsDownload.tsx
  • libs/ui-lib/lib/ocm/components/clusters/ClusterPage.tsx
  • libs/ui-lib/lib/ocm/components/clusters/AssistedInstallerHeader.tsx
  • libs/ui-lib/lib/ocm/components/clusters/NewClusterPage.tsx
⏰ Context from checks skipped due to timeout of 90000ms (6)
  • GitHub Check: format
  • GitHub Check: lint
  • GitHub Check: translation-files
  • GitHub Check: circular-deps
  • GitHub Check: unit-tests
  • GitHub Check: tests
✨ 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.
    • 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.

@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 Jun 9, 2025
Copy link

@coderabbitai coderabbitai bot left a comment

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-lib/lib/ocm/components/clusters/NewClusterPage.tsx (1)

16-16: Improve type definition instead of using empty object type.

The static analysis tool correctly identifies that {} as a type should be avoided. Consider using a more explicit type definition.

Apply this diff to improve the type definition:

-const NewClusterPageGeneric = ({ children }: React.PropsWithChildren<{}>) => {
+const NewClusterPageGeneric = ({ children }: React.PropsWithChildren) => {

Or if you need to be more explicit:

-const NewClusterPageGeneric = ({ children }: React.PropsWithChildren<{}>) => {
+const NewClusterPageGeneric = ({ children }: { children?: ReactNode }) => {
🧰 Tools
🪛 Biome (1.9.4)

[error] 16-16: Don't use '{}' as a type.

Prefer explicitly define the object shape. '{}' means "any non-nullable value".

(lint/complexity/noBannedTypes)

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between e74106f and ad964b1.

📒 Files selected for processing (4)
  • libs/ui-lib/lib/ocm/components/clusterWizard/CredentialsDownload.tsx (2 hunks)
  • libs/ui-lib/lib/ocm/components/clusters/AssistedInstallerHeader.tsx (1 hunks)
  • libs/ui-lib/lib/ocm/components/clusters/ClusterPage.tsx (1 hunks)
  • libs/ui-lib/lib/ocm/components/clusters/NewClusterPage.tsx (3 hunks)
🧰 Additional context used
🧬 Code Graph Analysis (2)
libs/ui-lib/lib/ocm/components/clusters/AssistedInstallerHeader.tsx (1)
libs/ui-lib/lib/common/components/ui/DeveloperPreview.tsx (1)
  • DeveloperPreview (8-20)
libs/ui-lib/lib/ocm/components/clusters/NewClusterPage.tsx (1)
libs/ui-lib/lib/ocm/components/clusters/AssistedInstallerHeader.tsx (1)
  • AssistedInstallerHeader (11-35)
🪛 Biome (1.9.4)
libs/ui-lib/lib/ocm/components/clusters/NewClusterPage.tsx

[error] 16-16: Don't use '{}' as a type.

Prefer explicitly define the object shape. '{}' means "any non-nullable value".

(lint/complexity/noBannedTypes)

⏰ Context from checks skipped due to timeout of 90000ms (6)
  • GitHub Check: translation-files
  • GitHub Check: tests
  • GitHub Check: unit-tests
  • GitHub Check: circular-deps
  • GitHub Check: lint
  • GitHub Check: format
🔇 Additional comments (8)
libs/ui-lib/lib/ocm/components/clusters/ClusterPage.tsx (1)

208-210: LGTM! Consistent header implementation.

The addition of AssistedInstallerHeader wrapped in a PageSection with light variant follows the same pattern established in other cluster pages and maintains UI consistency.

libs/ui-lib/lib/ocm/components/clusterWizard/CredentialsDownload.tsx (2)

25-25: Good addition of clearAlerts functionality.

Adding clearAlerts to the destructured useAlerts hook enables proper alert management during the download process.


45-45: Excellent UX improvement - clearing alerts before downloads.

Calling clearAlerts() at the start of the download process ensures users see only relevant alerts from the current download attempt, preventing confusion from previous error messages.

libs/ui-lib/lib/ocm/components/clusters/AssistedInstallerHeader.tsx (3)

3-9: Well-organized imports for feature flag functionality.

The import additions are clean and properly organized, bringing in the necessary DeveloperPreview component and useFeature hook for the new feature flag implementation.


12-12: Proper feature flag implementation.

The feature flag check using useFeature('ASSISTED_INSTALLER_SINGLE_CLUSTER_FEATURE') follows the established pattern and enables controlled rollout of the developer preview badge.


18-18: Clean conditional rendering of developer preview badge.

The conditional rendering of <DeveloperPreview /> is implemented correctly and will only show the technical preview badge when the feature flag is enabled, aligning with the PR objectives.

libs/ui-lib/lib/ocm/components/clusters/NewClusterPage.tsx (2)

27-30: Excellent consolidation of header rendering.

Moving the AssistedInstallerHeader rendering inside NewClusterPageGeneric with a consistent PageSection wrapper improves maintainability and ensures uniform header presentation across cluster pages.


47-49: Clean API improvement using children prop.

The refactor to use the standard React children prop instead of a custom pageTitleSection prop makes the component API more intuitive and follows React conventions.

 - clear download alerts
 - add AI header + tech preview badge
@openshift-ci openshift-ci bot added the lgtm Indicates that a PR is ready to be merged. label Jun 19, 2025
@openshift-ci
Copy link

openshift-ci bot commented Jun 19, 2025

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: ElayAharoni, 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

@openshift-merge-bot openshift-merge-bot bot merged commit 12ec61f into openshift-assisted:master Jun 19, 2025
11 checks passed
@rawagner
Copy link
Member Author

/cherry-pick release-4.19

@openshift-cherrypick-robot
Copy link
Contributor

@rawagner: new pull request created: #3003

Details

In response to this:

/cherry-pick release-4.19

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.

ammont82 pushed a commit to ammont82/assisted-installer-ui that referenced this pull request Sep 12, 2025
- clear download alerts
 - add AI header + tech preview badge
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