Skip to content

move Set TechPreviewNoUpgrade on the target cluster to networking step#2918

Merged
openshift-merge-bot[bot] merged 1 commit intoopenshift-assisted:masterfrom
ElayAharoni:move-Set-TechPreviewNoUpgrade-on-the-target-cluster-to-networking-page
Apr 16, 2025
Merged

move Set TechPreviewNoUpgrade on the target cluster to networking step#2918
openshift-merge-bot[bot] merged 1 commit intoopenshift-assisted:masterfrom
ElayAharoni:move-Set-TechPreviewNoUpgrade-on-the-target-cluster-to-networking-page

Conversation

@ElayAharoni
Copy link
Contributor

@ElayAharoni ElayAharoni commented Apr 15, 2025

move Set TechPreviewNoUpgrade on the target cluster to networking step

Summary by CodeRabbit

  • New Features

    • Added a conditional step in the network configuration wizard that updates the cluster's install configuration when a specific feature flag is enabled, with error handling and user alerts.
  • Refactor

    • Simplified the host discovery wizard step by removing the conditional configuration update and related error handling, streamlining the navigation process.

Signed-off-by: Elay Aharoni <elayaha@gmail.com>
@openshift-ci openshift-ci bot requested review from celdrake and rawagner April 15, 2025 14:28
@coderabbitai
Copy link

coderabbitai bot commented Apr 15, 2025

Walkthrough

This change moves the logic for conditionally updating the cluster's install configuration based on a feature flag from the HostDiscovery wizard step to the NetworkConfigurationForm step. An asynchronous onNext callback is introduced in NetworkConfigurationForm to perform the API update and handle errors before advancing the wizard. Corresponding logic is removed from HostDiscovery, which now simply advances the wizard without performing the API call or error handling.

Changes

File(s) Change Summary
libs/ui-lib/lib/ocm/components/clusterConfiguration/networkConfiguration/NetworkConfigurationForm.tsx Added an async onNext callback to update cluster install config if a feature flag is enabled, with error handling; updated footer to use this logic.
libs/ui-lib/lib/ocm/components/clusterWizard/HostDiscovery.tsx Removed feature flag-based async onNext logic and API call; reverted to direct wizard navigation on next.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant NetworkConfigurationForm
    participant ClustersAPI
    participant Redux
    participant Wizard

    User->>NetworkConfigurationForm: Clicks "Next"
    NetworkConfigurationForm->>NetworkConfigurationForm: onNext()
    alt Feature flag enabled
        NetworkConfigurationForm->>ClustersAPI: updateInstallConfig(clusterId, payload)
        alt API call succeeds
            NetworkConfigurationForm->>Wizard: moveNext()
        else API call fails
            NetworkConfigurationForm->>NetworkConfigurationForm: Show alert
            alt Unknown server error
                NetworkConfigurationForm->>Redux: setServerUpdateError()
            end
        end
    else Feature flag disabled
        NetworkConfigurationForm->>Wizard: moveNext()
    end
Loading

Possibly related PRs

Suggested labels

lgtm, approved, size/M

Suggested reviewers

  • ammont82
  • rawagner

Poem

A hop to the left, a hop to the right,
The wizard advances, its logic now light.
With flags and configs checked on the fly,
Errors are caught, and alerts flutter by.
As clusters are guided, step by step true—
This bunny approves the code, and so should you! 🐇✨

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/clusterConfiguration/networkConfiguration/NetworkConfigurationForm.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/HostDiscovery.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.

Tip

⚡💬 Agentic Chat (Pro Plan, General Availability)
  • We're introducing multi-step agentic chat in review comments and issue comments, within and outside of PR's. This feature enhances review and issue discussions with the CodeRabbit agentic chat by enabling advanced interactions, including the ability to create pull requests directly from comments and add commits to existing pull requests.

📜 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 fde98bb and b9e1b00.

📒 Files selected for processing (2)
  • libs/ui-lib/lib/ocm/components/clusterConfiguration/networkConfiguration/NetworkConfigurationForm.tsx (5 hunks)
  • libs/ui-lib/lib/ocm/components/clusterWizard/HostDiscovery.tsx (1 hunks)
🔇 Additional comments (6)
libs/ui-lib/lib/ocm/components/clusterWizard/HostDiscovery.tsx (1)

46-46: Simplified navigation callback aligns with PR objective

The onNext callback has been simplified to directly call moveNext() without any API calls or error handling. This change correctly implements the PR objective of moving the TechPreviewNoUpgrade flag setting to the networking step.

libs/ui-lib/lib/ocm/components/clusterConfiguration/networkConfiguration/NetworkConfigurationForm.tsx (5)

19-19: New import aligns with functionality move

Adding the ClustersAPI import is necessary for the moved TechPreviewNoUpgrade flag setting functionality.


49-49: Feature flag import added for conditional logic

The useFeature import is required for the conditional TechPreviewNoUpgrade flag setting.


70-72: Required hooks added for feature flag and error handling

These hooks are necessary for implementing the feature-flagged install config update that was moved from HostDiscovery.


122-122: Footer updated to use new asynchronous callback

The ClusterWizardFooter's onNext prop is correctly updated to call the new asynchronous callback and properly handles the Promise.


87-108:

Details

❓ Verification inconclusive

Successfully implemented TechPreviewNoUpgrade flag setting

The new onNext callback correctly implements the functionality that was previously in HostDiscovery:

  1. It checks the feature flag before attempting the update
  2. Makes the API call with the TechPreviewNoUpgrade flag
  3. Properly handles errors and prevents navigation on failure
  4. Only continues to the next step if successful or if the feature is disabled

Note: The double JSON.stringify on line 92 creates a nested string. Is this the expected format for the API?


🏁 Script executed:

#!/bin/bash
# Check if double JSON.stringify is used elsewhere in the codebase for updateInstallConfig
rg -A 2 -B 2 "updateInstallConfig|JSON\.stringify.*JSON\.stringify" --type ts

Length of output: 1543


Code Verified: Flag Setting Correct with Caution on Payload Formatting

The updated onNext callback correctly:

  • Checks the feature flag before attempting the update.
  • Calls ClustersAPI.updateInstallConfig with the TechPreviewNoUpgrade flag set.
  • Handles errors by displaying alerts and preventing navigation on failure.
  • Proceeds to the next step only when updates are successful or the feature is disabled.

Our repository search confirmed that the double JSON.stringify (creating a nested JSON string) is used only here. Please verify that this nested format is indeed what the API expects.

✨ 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 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 the size/M Denotes a PR that changes 30-99 lines, ignoring generated files. label Apr 15, 2025
@openshift-ci openshift-ci bot added the lgtm Indicates that a PR is ready to be merged. label Apr 16, 2025
@openshift-ci
Copy link

openshift-ci bot commented Apr 16, 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-ci openshift-ci bot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Apr 16, 2025
@openshift-merge-bot openshift-merge-bot bot merged commit 845a8eb into openshift-assisted:master Apr 16, 2025
11 checks passed
@coderabbitai coderabbitai bot mentioned this pull request Aug 14, 2025
ammont82 pushed a commit to ammont82/assisted-installer-ui that referenced this pull request Sep 12, 2025
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.

2 participants