Skip to content

MGMT-20893: Remove Remediation operators#3014

Merged
openshift-merge-bot[bot] merged 1 commit intoopenshift-assisted:masterfrom
danmanor:remove-remediation-operators
Jun 25, 2025
Merged

MGMT-20893: Remove Remediation operators#3014
openshift-merge-bot[bot] merged 1 commit intoopenshift-assisted:masterfrom
danmanor:remove-remediation-operators

Conversation

@danmanor
Copy link
Contributor

@danmanor danmanor commented Jun 24, 2025

We keep their code as we might add them back soon. We just don't want them to be displayed

Summary by CodeRabbit

  • Bug Fixes
    • Removed the "Remediation" category and its associated operators from the operator selection and display.
    • Updated operator filtering to ensure only recognized operators are shown to users.

@openshift-ci-robot openshift-ci-robot added the jira/valid-reference Indicates that this PR references a valid Jira ticket of any type. label Jun 24, 2025
@openshift-ci-robot
Copy link

openshift-ci-robot commented Jun 24, 2025

@danmanor: This pull request references MGMT-20893 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 story to target the "4.20.0" version, but no target version was set.

Details

In response to this:

We keep their code as we might add them back soon. We just don't want them to be displayed

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.

@danmanor danmanor requested review from ammont82 and rawagner and removed request for ammont82 June 24, 2025 05:30
@openshift-ci openshift-ci bot requested review from ammont82 and jgyselov June 24, 2025 05:30
@openshift-ci openshift-ci bot added the size/M Denotes a PR that changes 30-99 lines, ignoring generated files. label Jun 24, 2025
@coderabbitai
Copy link

coderabbitai bot commented Jun 24, 2025

Walkthrough

This update removes the "Remediation" category and its related operators from the operator specifications, including all references, constants, and descriptions. Additionally, the operator service now filters supported operators to return only those recognized in the current operator specifications, ensuring consistency between API results and defined operators.

Changes

File(s) Change Summary
libs/ui-lib/lib/common/components/operators/operatorSpecs.tsx Removed "Remediation" category, its operators, related enums, constants, and descriptions.
libs/ui-lib/lib/ocm/services/OperatorsService.tsx Updated to filter API-fetched operators, returning only those present in the current operator specs.

Sequence Diagram(s)

sequenceDiagram
    participant UI
    participant OperatorsService
    participant API

    UI->>OperatorsService: getSupportedOperators()
    OperatorsService->>API: fetchOperators()
    API-->>OperatorsService: operatorsList
    OperatorsService->>OperatorsService: filter operators by getOperatorSpecs()
    OperatorsService-->>UI: filteredOperatorsList
Loading

Possibly related PRs

Suggested labels

lgtm, approved, size/S

Suggested reviewers

  • celdrake
  • rawagner

Poem

The Remediation bunnies hop away,
No more fences, health checks, or self-heal today.
Operators now filtered, neat and clean,
Only the known ones on the UI screen.
With specs in sync, the code feels light—
A garden trimmed just 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/services/OperatorsService.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.

✨ 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-robot
Copy link

openshift-ci-robot commented Jun 24, 2025

@danmanor: This pull request references MGMT-20893 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 story to target the "4.20.0" version, but no target version was set.

Details

In response to this:

We keep their code as we might add them back soon. We just don't want them to be displayed

Summary by CodeRabbit

  • Refactor
  • Removed the "Remediation" category and its associated operators from the operator specifications. These operators will no longer appear in the operator list or related displays. No other categories or operators are affected.

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.

@danmanor danmanor force-pushed the remove-remediation-operators branch from d43765d to 6310ce3 Compare June 24, 2025 05:51
@openshift-ci-robot
Copy link

openshift-ci-robot commented Jun 24, 2025

@danmanor: This pull request references MGMT-20893 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 story to target the "4.20.0" version, but no target version was set.

Details

In response to this:

We keep their code as we might add them back soon. We just don't want them to be displayed

Summary by CodeRabbit

  • Refactor
  • Removed the "Remediation" category and its associated operators from the operator specifications, so they will no longer appear in the operator list or related displays.
  • Improved the operator selection interface by accurately displaying the count of visible operators based on current filters.

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.

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/clusterWizard/OperatorsSelect.tsx (1)

66-69: LGTM! Consider memoizing for performance optimization.

The logic correctly counts only the operators that are actually displayed, which fixes the count accuracy after removing the Remediation category from operator specs. The filtering logic is consistent with the rendering logic on line 88.

Consider memoizing this computation to avoid recalculating on every render:

-  const totalDisplayedOperators = Object.values(byCategory).reduce((total, specs) => {
-    const displayedCount = specs.filter(spec => operators.includes(spec.operatorKey)).length;
-    return total + displayedCount;
-  }, 0);
+  const totalDisplayedOperators = React.useMemo(() => {
+    return Object.values(byCategory).reduce((total, specs) => {
+      const displayedCount = specs.filter(spec => operators.includes(spec.operatorKey)).length;
+      return total + displayedCount;
+    }, 0);
+  }, [byCategory, operators]);
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between d43765d and 6310ce3.

📒 Files selected for processing (2)
  • libs/ui-lib/lib/common/components/operators/operatorSpecs.tsx (0 hunks)
  • libs/ui-lib/lib/ocm/components/clusterWizard/OperatorsSelect.tsx (2 hunks)
💤 Files with no reviewable changes (1)
  • libs/ui-lib/lib/common/components/operators/operatorSpecs.tsx
⏰ Context from checks skipped due to timeout of 90000ms (6)
  • GitHub Check: circular-deps
  • GitHub Check: format
  • GitHub Check: translation-files
  • GitHub Check: tests
  • GitHub Check: lint
  • GitHub Check: unit-tests
🔇 Additional comments (1)
libs/ui-lib/lib/ocm/components/clusterWizard/OperatorsSelect.tsx (1)

81-81: Count accuracy improvement aligns with PR objectives.

The use of totalDisplayedOperators instead of operators.length ensures the toggle text shows the correct count of displayed operators, which is essential after removing the Remediation operators from the specs.

@openshift-ci-robot
Copy link

openshift-ci-robot commented Jun 24, 2025

@danmanor: This pull request references MGMT-20893 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 story to target the "4.20.0" version, but no target version was set.

Details

In response to this:

We keep their code as we might add them back soon. We just don't want them to be displayed

Summary by CodeRabbit

  • Refactor
  • Removed the "Remediation" category and its associated operators from the operator list and related displays.
  • Enhanced the operator selection interface to show the correct count of visible operators based on applied filters.

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.

@danmanor danmanor force-pushed the remove-remediation-operators branch from 51b7a5e to c80ced4 Compare June 24, 2025 12:17
@danmanor danmanor requested a review from celdrake June 24, 2025 12:18
@openshift-ci-robot
Copy link

openshift-ci-robot commented Jun 24, 2025

@danmanor: This pull request references MGMT-20893 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 story to target the "4.20.0" version, but no target version was set.

Details

In response to this:

We keep their code as we might add them back soon. We just don't want them to be displayed

Summary by CodeRabbit

  • Bug Fixes
    • Removed the "Remediation" category and its associated operators from the operator selection and display.
    • Updated operator filtering to ensure only recognized operators are shown to users.

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.

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/services/OperatorsService.tsx (1)

16-22: Filtering logic successfully implements the PR requirement.

The modification to getSupportedOperators effectively filters the API response to only include operators that are defined in the current specifications. This ensures consistency between the API results and the defined operators, which aligns perfectly with the goal of hiding Remediation operators without deleting their code.

Consider caching the result of getAllKnownOperatorKeys() if this method is called frequently, as the operator specifications are unlikely to change during runtime.

+const knownOperatorKeysCache = new Set<string>();
+let cacheInitialized = false;

 const getAllKnownOperatorKeys = (): Set<string> => {
+  if (cacheInitialized) {
+    return knownOperatorKeysCache;
+  }
+
   const allSpecsByCategory = getOperatorSpecs(() => undefined);
   const allKeys = Object.values(allSpecsByCategory)
     .flat()
     .map((spec) => spec.operatorKey);

-  return new Set(allKeys);
+  knownOperatorKeysCache.clear();
+  allKeys.forEach(key => knownOperatorKeysCache.add(key));
+  cacheInitialized = true;
+
+  return knownOperatorKeysCache;
 };
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 51b7a5e and c80ced4.

📒 Files selected for processing (2)
  • libs/ui-lib/lib/common/components/operators/operatorSpecs.tsx (0 hunks)
  • libs/ui-lib/lib/ocm/services/OperatorsService.tsx (1 hunks)
💤 Files with no reviewable changes (1)
  • libs/ui-lib/lib/common/components/operators/operatorSpecs.tsx
⏰ Context from checks skipped due to timeout of 90000ms (6)
  • GitHub Check: tests
  • GitHub Check: translation-files
  • GitHub Check: format
  • GitHub Check: unit-tests
  • GitHub Check: lint
  • GitHub Check: circular-deps
🔇 Additional comments (2)
libs/ui-lib/lib/ocm/services/OperatorsService.tsx (2)

2-2: Import addition looks good.

The import of getOperatorSpecs is correctly added to support the new filtering functionality.


4-12: Helper function implementation is solid.

The getAllKnownOperatorKeys function correctly extracts all operator keys from the specifications and returns them as a Set for efficient lookup. The implementation properly handles the flattening of nested operator categories.

…ight add them back soon. We just don't want them to be displayed
Copy link
Contributor

@celdrake celdrake left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, though I can't merge.
Pleaes @ammont82 check this PR :)

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

openshift-ci bot commented Jun 25, 2025

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: celdrake, danmanor

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 Jun 25, 2025
@danmanor
Copy link
Contributor Author

@celdrake I can merge, is it OK with you ?

@openshift-merge-bot openshift-merge-bot bot merged commit 0fecffc into openshift-assisted:master Jun 25, 2025
11 checks passed
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. jira/valid-reference Indicates that this PR references a valid Jira ticket of any type. 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