MGMT-20354: LSO Operator Visually Unchecked in UI After Toggling Virt Bundle Whil…

[ElayAharoni]

https://issues.redhat.com/browse/MGMT-20354

https://www.loom.com/share/59c2ac9546d84233aac6d808c6b2b839?sid=f49a7de5-a1b5-4e4c-a71d-f231f86e41e4

Summary by CodeRabbit

• Bug Fixes
  • Improved operator selection in the cluster wizard to ensure that chosen options correctly update associated form fields, providing a more consistent and accurate user experience.

[openshift-ci-robot]

@ElayAharoni: This pull request references MGMT-20354 which is a valid jira issue.

Warning: The referenced jira issue has an invalid target version for the target branch this PR targets: expected the bug to target the "4.19.0" version, but no target version was set.

Details

In response to this:

https://issues.redhat.com/browse/MGMT-20354

https://www.loom.com/share/59c2ac9546d84233aac6d808c6b2b839?sid=f49a7de5-a1b5-4e4c-a71d-f231f86e41e4

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]

Walkthrough

The updates in the OperatorsStep component modify the useEffect hook. The hook now processes the monitoredOperators prop by filtering to create a newSelection array, iterating over it to retrieve corresponding field IDs from a mapping object, and then updating the form state using setFieldValue. The dependency array is also updated to include setFieldValue, ensuring the effect is re-run when this function changes.

Changes

File(s)	Change Summary
libs/ui-lib/.../clusterWizard/OperatorsStep.tsx	Modified the useEffect hook to loop over filtered operators (newSelection), retrieve field IDs via mapOperatorsToFieldIds, and update form state by calling setFieldValue. Also updated the dependency array to include setFieldValue.

Sequence Diagram(s)

sequenceDiagram
    participant OS as OperatorsStep Component
    participant UE as useEffect Hook
    participant FS as Form State

    OS->>UE: Component mounts/updating monitoredOperators
    UE->>OS: Filter monitoredOperators -> newSelection
    loop For each operator in newSelection
        UE->>UE: Retrieve fieldId via mapOperatorsToFieldIds
        UE->>FS: Call setFieldValue(fieldId, true)
    end
    UE->>OS: Update selectedOperators state

Loading

Suggested labels

lgtm, approved

Suggested reviewers

• celdrake
• ammont82
• rawagner

Poem

In a field of code I hop with glee,
Fixing bugs as light as can be.
With setFieldValue I update with might,
And operators now shine bright.
Bouncing on lines, coding day and night! 🐰

Happy hops to better code!

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/OperatorsStep.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 b138100 and c40d7a8.

📒 Files selected for processing (1)

• libs/ui-lib/lib/ocm/components/clusterWizard/OperatorsStep.tsx (1 hunks)

🧰 Additional context used

🧬 Code Graph Analysis (1)

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

libs/ui-lib/lib/ocm/components/clusterConfiguration/operators/SupportedOperators.tsx (1)

• mapOperatorsToFieldIds (92-115)

⏰ Context from checks skipped due to timeout of 90000ms (6)

• GitHub Check: tests
• GitHub Check: translation-files
• GitHub Check: unit-tests
• GitHub Check: circular-deps
• GitHub Check: format
• GitHub Check: lint

🔇 Additional comments (1)

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

157-161: Correctly synchronizes UI state with monitored operators.

This change ensures that when operators are part of the monitoredOperators list, their corresponding form fields are properly set to true. This fixes the issue where the LSO operator would appear unchecked in the UI after toggling the Virt Bundle, even though it should remain selected.

The implementation correctly:

1. Iterates through each operator in the filtered selection
2. Maps the operator name to its form field ID
3. Sets the form field value to true using setFieldValue
4. Adds setFieldValue to the dependency array to ensure the effect runs when it changes

✨ 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

• X
• Mastodon
• Reddit
• LinkedIn

🪧 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 plan to trigger planning for file edits and PR creation.
• @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-robot]

@ElayAharoni: This pull request references MGMT-20354 which is a valid jira issue.

Warning: The referenced jira issue has an invalid target version for the target branch this PR targets: expected the bug to target the "4.19.0" version, but no target version was set.

Details

In response to this:

https://issues.redhat.com/browse/MGMT-20354

https://www.loom.com/share/59c2ac9546d84233aac6d808c6b2b839?sid=f49a7de5-a1b5-4e4c-a71d-f231f86e41e4

Summary by CodeRabbit

• Bug Fixes
  • Improved operator selection in the cluster wizard to ensure that chosen options correctly update associated form fields, providing a more consistent and accurate user experience.

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.

[openshift-ci]

[APPROVALNOTIFIER] This PR is APPROVED

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

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:

• OWNERS [ammont82]

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

[ammont82]

/lgtm

[ammont82]

/cherry-pick releases/v2.39

[openshift-cherrypick-robot]

@ammont82: new pull request created: #2917

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.