Skip to content

Conversation

@rhamilto
Copy link
Member

@rhamilto rhamilto commented Jan 23, 2026

Summary

This PR completes the modal migration effort by migrating all instances of confirmModal to use the modern overlay pattern with useWarningModal and refactors moveNodeToGroup to use React Context for confirmation handling.

Note: This PR builds on:

Changes

Removed deprecated confirmModal

  • ✅ Deleted confirm-modal.tsx and its imperative launcher
  • ✅ Removed confirmModal from modals/index.ts exports
  • ✅ Removed translation key from public.json

Migrated to useWarningModal overlay pattern

  • ✅ Updated topology moveNodeToGroup to use useWarningModal with proper cancel handling
  • ✅ Updated StopNodeMaintenanceModal to remove imperative API, keeping only hook-based approach
  • ✅ Updated all metal3-plugin maintenance components to use hook-based approach
  • ✅ Fixed useWarningModal to properly call closeOverlay() and filter it from props spread

Refactored moveNodeToGroup to use React Context

  • ✅ Created MoveNodeHandlersProvider for confirmation modal handling only
  • ✅ Created SyncMoveNodeHandlers component to sync handlers for non-React contexts
  • ✅ Added useMoveNodeHandlers() hook for accessing confirmation handler
  • ✅ Wrapped Topology component with MoveNodeHandlersProvider
  • Uses shared launchErrorModal() from CONSOLE-5012: Create shared error modal launcher using React Context #15946 for error handling (not custom handler)
  • ✅ Deprecated old useSetupMoveNodeToGroupHandlers hooks with warnings
  • ✅ Added comprehensive unit tests (8 tests covering all scenarios)

Fixed accessibility violation

  • ✅ Blur active element before launching confirmation modal
  • ✅ Prevents focus from remaining on SVG elements in topology graph
  • ✅ Fixes browser warning: "Blocked aria-hidden on an element because its descendant retained focus"

Architecture Benefits

  • Eliminates global state race conditions - React Context ensures proper scoping
  • Follows React Context pattern established in CONSOLE-5012: Create shared error modal launcher using React Context #15946 (error modal handler)
  • Consistent error handling - Uses shared launchErrorModal() from CONSOLE-5012: Create shared error modal launcher using React Context #15946
  • Single responsibility - Provider only handles confirmations, errors use global handler
  • Improves testability - Context can be mocked in tests
  • Single provider initialization - Around Topology component only
  • Proper cleanup - Via React lifecycle instead of manual cleanup
  • Type-safe - With clear error messages when handlers not available
  • Maintains backward compatibility - Via deprecated hooks with console warnings
  • WCAG 2.1 Level A compliant - No aria-hidden focus violations

The hybrid approach (Context + module reference) supports both React components (via useMoveNodeHandlers hook) and non-React drag-drop callbacks (via moveNodeToGroup function), consistent with the error modal handler pattern.

Technical Details

Accessibility Fix - aria-hidden Focus Violation

Problem: When the confirmation modal opened during drag-drop operations, focus remained on an SVG <g> element in the topology graph. PatternFly's Modal sets aria-hidden="true" on the #app div, creating an accessibility violation where a focused element is hidden from assistive technology users.

Browser Warning (Fixed):

Blocked aria-hidden on an element because its descendant retained focus.
The focus must not be hidden from assistive technology users.
Element with focus: <g>
Ancestor with aria-hidden: <div#app>

Solution: Blur the active element before launching the modal:

// Blur active element to prevent aria-hidden focus violations when modal opens
if (document.activeElement instanceof HTMLElement || 
    document.activeElement instanceof SVGElement) {
  document.activeElement.blur();
}

React Context Pattern

Before (Global State):

// ❌ Module-level variables set by hooks
let globalConfirmHandler = null;
let globalErrorHandler = null;

export const setMoveNodeToGroupConfirmHandler = (handler) => {
  globalConfirmHandler = handler;
};

// Called in Topology component
useSetupMoveNodeToGroupHandlers();

After (React Context + Shared Error Handler):

// ✅ React Context provider for confirmation only
export const MoveNodeHandlersProvider = ({ children }) => {
  const confirmMove = useCallback((title, message, confirmText) => {
    return new Promise((resolve, reject) => {
      launchWarningModal({
        title: t(`topology~${title}`),
        children: message,
        confirmButtonLabel: t(`topology~${confirmText}`),
        onConfirm: resolve,
        onClose: () => reject(new Error('User cancelled')),
      });
    });
  }, [launchWarningModal, t]);
  
  return <Context.Provider value={{ confirmMove }}>{children}</Context.Provider>;
};

// Error handling uses shared global launcher from #15946
import { launchErrorModal } from '@console/shared/src/utils/error-modal-handler';

// In moveNodeToGroup:
catch (err) {
  if (err.message !== 'User cancelled') {
    launchErrorModal({ error: err.message });  // ← Shared handler
  }
  throw err;
}

// Wrap Topology component
<MoveNodeHandlersProvider>
  <SyncMoveNodeHandlers />  {/* Syncs confirmation handler for drag-drop */}
  <Topology />
</MoveNodeHandlersProvider>

Key Improvements:

Hybrid Approach:

useWarningModal Fix

Fixed prop spreading issue that caused React DOM warnings:

const ControlledWarningModal: FC<WarningModalProps & { closeOverlay?: () => void }> = ({
  closeOverlay,  // ← Destructured to prevent prop warning
  ...props
}) => {
  const onClose = (e) => {
    setIsOpen(false);
    props.onClose?.(e);
    closeOverlay?.();  // ← Properly calls cleanup
  };
  // ...
}

Test Plan

Automated Tests ✅

  • TypeScript compilation succeeds
  • ESLint passes
  • Unit tests pass (8/8 for moveNodeToGroup)
  • Frontend tests pass
  • Backend tests pass
  • E2E tests pass

Manual Testing

  • Verify topology node drag-and-drop with confirmation modal works
  • Verify clicking "Cancel" in confirmation modal restores node to original position
  • Verify clicking "Move"/"Remove" confirms the operation
  • Verify error modals use the shared launchErrorModal() handler
  • Verify metal3-plugin node maintenance modals work correctly
  • Verify no React DOM warnings about closeOverlay prop in console
  • Verify modals properly close and remove from DOM on both confirm and cancel
  • Test with multiple topology instances (different namespaces/tabs)
  • Verify no aria-hidden accessibility warnings in browser console
  • Verify modal receives focus when opened from drag-drop operation

Breaking Changes

None - deprecated hooks remain functional with console warnings for backward compatibility.

Related

🤖 Generated with Claude Code

@openshift-ci-robot openshift-ci-robot added the jira/valid-reference Indicates that this PR references a valid Jira ticket of any type. label Jan 23, 2026
@openshift-ci-robot
Copy link
Contributor

openshift-ci-robot commented Jan 23, 2026

@rhamilto: This pull request references CONSOLE-5012 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.22.0" version, but no target version was set.

Details

In response to this:

Summary

This PR migrates all instances of confirmModal to use the modern overlay pattern with useWarningModal, completing the modal migration effort.

Changes

  • ✅ Removed deprecated confirmModal launcher and confirm-modal.tsx file
  • ✅ Migrated topology moveNodeToGroup to use useWarningModal with proper cancel handling
  • ✅ Updated StopNodeMaintenanceModal to remove deprecated imperative API
  • ✅ Fixed useWarningModal to properly handle closeOverlay prop
  • ✅ Added try-catch in topology drag-drop to prevent optimistic update on cancel
  • ✅ Updated all metal3-plugin maintenance components to use hook-based approach

Technical Details

Topology Move Node Migration

The topology moveNodeToGroup function used confirmModal imperatively. Since it's not a React component, I implemented a global handler pattern similar to the existing error handler:

  • Added setMoveNodeToGroupConfirmHandler to set a global confirmation handler
  • Created useSetupMoveNodeToGroupHandlers hook that uses useWarningModal
  • Added cancel callback support to properly reject the promise when user cancels
  • Fixed drag-drop component to use try-catch and prevent optimistic update on rejection

StopNodeMaintenanceModal Migration

  • Removed the deprecated stopNodeMaintenanceModal function
  • Kept only the useStopNodeMaintenanceModal hook that already used useWarningModal
  • Updated all call sites to use the hook instead of the imperative function

useWarningModal Fix

  • Fixed closeOverlay prop warning by properly excluding it from the props spread
  • Added closeOverlay() calls in both onClose and onConfirm handlers to properly remove the modal from DOM

Dependencies

This PR builds upon and depends on:

Test Plan

  • Verify topology node drag-and-drop with confirmation works
  • Verify clicking "Cancel" restores node to original position
  • Verify clicking confirm button moves the node
  • Verify metal3-plugin node maintenance modals work
  • Verify no React DOM warnings about closeOverlay prop
  • Verify modal properly closes and removes from DOM on both confirm and cancel

🤖 Generated with Claude Code

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.

@rhamilto rhamilto changed the title CONSOLE-5012: Migrate confirmModal to overlay pattern [WIP] CONSOLE-5012: Migrate confirmModal to overlay pattern Jan 23, 2026
@openshift-ci openshift-ci bot added the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Jan 23, 2026
@openshift-ci openshift-ci bot requested review from jhadvig and sg00dwin January 23, 2026 20:59
@openshift-ci openshift-ci bot added component/core Related to console core functionality component/dev-console Related to dev-console approved Indicates a PR has been approved by an approver from all required OWNERS files. component/knative Related to knative-plugin component/metal3 Related to metal3-plugin component/sdk Related to console-plugin-sdk component/shared Related to console-shared component/topology Related to topology kind/i18n Indicates issue or PR relates to internationalization or has content that needs to be translated labels Jan 23, 2026
@openshift-ci-robot
Copy link
Contributor

openshift-ci-robot commented Jan 23, 2026

@rhamilto: This pull request references CONSOLE-5012 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.22.0" version, but no target version was set.

Details

In response to this:

Summary

This PR migrates all instances of confirmModal to use the modern overlay pattern with useWarningModal, completing the modal migration effort.

Changes

  • ✅ Removed deprecated confirmModal launcher and confirm-modal.tsx file
  • ✅ Migrated topology moveNodeToGroup to use useWarningModal with proper cancel handling
  • ✅ Updated StopNodeMaintenanceModal to remove deprecated imperative API
  • ✅ Fixed useWarningModal to properly handle closeOverlay prop
  • ✅ Added try-catch in topology drag-drop to prevent optimistic update on cancel
  • ✅ Updated all metal3-plugin maintenance components to use hook-based approach

Technical Details

Topology Move Node Migration

The topology moveNodeToGroup function used confirmModal imperatively. Since it's not a React component, I implemented a global handler pattern similar to the existing error handler:

  • Added setMoveNodeToGroupConfirmHandler to set a global confirmation handler
  • Created useSetupMoveNodeToGroupHandlers hook that uses useWarningModal
  • Added cancel callback support to properly reject the promise when user cancels
  • Fixed drag-drop component to use try-catch and prevent optimistic update on rejection

StopNodeMaintenanceModal Migration

  • Removed the deprecated stopNodeMaintenanceModal function
  • Kept only the useStopNodeMaintenanceModal hook that already used useWarningModal
  • Updated all call sites to use the hook instead of the imperative function

useWarningModal Fix

  • Fixed closeOverlay prop warning by properly excluding it from the props spread
  • Added closeOverlay() calls in both onClose and onConfirm handlers to properly remove the modal from DOM

Dependencies

This PR builds upon and depends on:

Test Plan

  • Verify topology node drag-and-drop with confirmation works
  • Verify clicking "Cancel" restores node to original position
  • Verify clicking confirm button moves the node
  • Verify metal3-plugin node maintenance modals work
  • Verify no React DOM warnings about closeOverlay prop
  • Verify modal properly closes and removes from DOM on both confirm and cancel

🤖 Generated with Claude Code

Summary by CodeRabbit

  • New Features

  • Introduced global error modal handler for consistent error notifications across the application.

  • Implemented lazy-loading for modals to improve initial page load performance.

  • Bug Fixes

  • Enhanced modal overlay management for improved accessibility and proper focus handling.

  • Refactor

  • Consolidated modal system to use provider-based architecture.

  • Optimized component memoization to reduce unnecessary re-renders.

  • Simplified modal invocation patterns across the application.

✏️ Tip: You can customize this high-level summary in your review settings.

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
Copy link
Contributor

coderabbitai bot commented Jan 23, 2026

📝 Walkthrough

Walkthrough

This pull request introduces a modal infrastructure refactor across the OpenShift Console codebase, shifting from a direct modal launcher pattern (via createModalLauncher) to an overlay-based provider pattern with React lazy loading. The changes include: introducing OverlayComponent-based modal providers wrapping existing modal components in ModalWrapper; implementing useOverlay() hooks to obtain launchModal functions for programmatic modal invocation; consolidating error handling through a new global error modal handler utility; creating lazy-loaded modal exports for code-splitting; removing launchModal from dependency arrays with ESLint suppressions to address potential max-depth errors; and updating action creators and modal invocation sites across frontend packages to use the new launchModal(ProviderComponent, props) pattern instead of direct function calls.

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Title check ✅ Passed The title accurately reflects the main objective: migrating confirmModal to an overlay-based pattern, which is the primary architectural shift across this substantial changeset.
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing touches
  • 📝 Generate docstrings
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment

Comment @coderabbitai help to get the list of available commands and usage tips.

Copy link
Contributor

@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: 8

Caution

Some comments are outside the diff and can’t be posted inline due to platform limitations.

⚠️ Outside diff range comments (4)
frontend/packages/console-shared/src/components/formik-fields/EnvironmentField.tsx (1)

64-80: Stabilize launchModal reference instead of suppressing hook deps

The dependency exhaustive-deps suppression masks a real issue: useOverlay() returns an unstable reference because OverlayContext.Provider creates a new value object on every render, even though the underlying callback is memoized. Adding launchModal to deps would trigger infinite re-runs (max depth exceeded), so the ref pattern below is the right approach at the consumer level.

♻️ Proposed refactor
-import { useMemo, useState, useCallback, useEffect } from 'react';
+import { useMemo, useState, useCallback, useEffect, useRef } from 'react';

 const { t } = useTranslation();
 const launchModal = useOverlay();
+const launchModalRef = useRef(launchModal);
+useEffect(() => {
+  launchModalRef.current = launchModal;
+}, [launchModal]);

 useEffect(() => {
   Promise.all([k8sGet(ConfigMapModel, null, namespace), k8sGet(SecretModel, null, namespace)])
     .then(([nsConfigMaps, nsSecrets]) => {
       setConfigMaps(nsConfigMaps);
       setSecrets(nsSecrets);
     })
     .catch(async (err) => {
       if (err?.response?.status !== 403) {
         try {
-          await launchModal(ErrorModal, { error: err?.message });
+          await launchModalRef.current(ErrorModal, { error: err?.message });
           // eslint-disable-next-line no-empty
         } catch (e) {}
       }
     });
-  // missing launchModal dependency, that causes max depth exceeded error
-  // eslint-disable-next-line react-hooks/exhaustive-deps
 }, [namespace]);
frontend/packages/topology/src/utils/moveNodeToGroup.tsx (1)

41-108: Fix the type contract: targetGroup should be optional and updateTopologyResourceApplication must accept string | null.

The function declares targetGroup: Node as required, but the implementation treats it as optional (see line 54's targetGroup?.getLabel() and line 58's conditional check). Line 82 passes null to updateTopologyResourceApplication, which expects application: string per the function signature in topology-utils.ts:137–140. Additionally, line 102 will crash if sourceGroup is falsy and targetGroup is somehow undefined, calling .getLabel() on a falsy value.

Update the type signature to match the implementation, and widen updateTopologyResourceApplication's application parameter to string | null to safely handle the "remove from application" case:

Proposed fix
export const moveNodeToGroup = (
  node: Node,
-  targetGroup: Node,
+  targetGroup: Node | null,
  onError?: (error: string) => void,
): Promise<void> => {

Then in topology-utils.ts:

export const updateTopologyResourceApplication = (
  item: Node,
-  application: string,
+  application: string | null,
): Promise<any> => {

and add an early guard:

  const itemData = item?.getData();
  const resource = getResource(item);
-  if (!item || !resource || !_.size(itemData.resources)) {
+  if (!item || !resource || application === null || !_.size(itemData.resources)) {
     return Promise.reject();
   }
frontend/packages/shipwright-plugin/src/actions/useBuildRunActions.ts (1)

4-4: Typo: Double slash in import path.

The import path contains actions//hooks with a double slash. While most bundlers normalize this, it's a minor inconsistency that should be cleaned up.

Suggested fix
-import { useCommonResourceActions } from '@console/app/src/actions//hooks/useCommonResourceActions';
+import { useCommonResourceActions } from '@console/app/src/actions/hooks/useCommonResourceActions';
frontend/packages/shipwright-plugin/src/actions/useBuildActions.ts (1)

75-89: Remove the duplicate Delete action at line 89.

The useCommonResourceActions hook returns all common actions including Delete via Object.values(commonActions) at line 75. Explicitly pushing commonActions.Delete again at line 89 creates a duplicate entry in the actions menu.

🤖 Fix all issues with AI agents
In
`@frontend/packages/console-app/src/components/modals/clone/clone-pvc-modal.tsx`:
- Around line 279-283: The spread props currently come after explicit close
props in ClonePVCModalProvider which allows props.closeOverlay to be overridden;
update the JSX so {...props} is spread first and then pass
cancel={props.closeOverlay} and close={props.closeOverlay} (affecting the
ClonePVCModal inside ModalWrapper) to ensure closeOverlay always wins and cannot
be overridden by incoming props.

In
`@frontend/packages/console-app/src/components/modals/restore-pvc/restore-pvc-modal.tsx`:
- Around line 282-287: The provider currently spreads props after passing
cancel/close to RestorePVCModal, allowing a caller to override those with their
own cancel/close; change RestorePVCModalProvider so you destructure closeOverlay
from props first (e.g., const { closeOverlay, ...rest } = props) then render
<RestorePVCModal cancel={closeOverlay} close={closeOverlay} {...rest} /> inside
ModalWrapper, ensuring props.closeOverlay cannot be overridden by
caller-supplied props.

In
`@frontend/packages/console-app/src/components/nodes/modals/ConfigureUnschedulableModal.tsx`:
- Around line 51-64: The provider currently spreads props after assigning cancel
and close which allows caller props to override them; update
ConfigureUnschedulableModalProvider to destructure props into { closeOverlay,
...rest } (or extract known keys) and then render ConfigureUnschedulableModal
with {...rest} followed by explicit cancel={closeOverlay} and
close={closeOverlay} so the overlay's close handlers cannot be overridden;
ensure ModalWrapper still uses closeOverlay for onClose and pass the same
closeOverlay to ConfigureUnschedulableModal.

In `@frontend/packages/console-shared/src/utils/error-modal-handler.ts`:
- Around line 35-50: The cleanup unconditionally clears the global launcher
causing newer launchers to be removed; fix useSetupGlobalErrorModalLauncher by
capturing the specific errorModalLauncher reference you set via
setGlobalErrorModalLauncher and, in the return cleanup, only call
setGlobalErrorModalLauncher(null) if the current global launcher equals that
captured reference (so use a stable local/ref for errorModalLauncher and guard
the cleanup), referencing the existing functions errorModalLauncher,
useSetupGlobalErrorModalLauncher, and setGlobalErrorModalLauncher to locate and
implement the guarded cleanup.

In `@frontend/packages/knative-plugin/src/actions/creators.ts`:
- Around line 4-5: The SDK currently forces imports from an internal path to
reach useOverlay; update the SDK public exports so useOverlay can be imported
from '@console/dynamic-plugin-sdk' by re-exporting the modal overlay API: add an
export for the modal-support module (e.g., export * from './modal-support') from
the SDK app index or alternatively export the dynamic-core-api module from the
SDK root so that the symbol useOverlay is publicly available; modify the module
that aggregates app exports to re-export useOverlay (and related modal types) so
consumers can import { useOverlay } from '@console/dynamic-plugin-sdk'.

In `@frontend/public/components/modals/configure-update-strategy-modal.tsx`:
- Around line 241-250: The provider currently spreads {...props} after setting
cancel/close so a caller can override cancel/close; update
ConfigureUpdateStrategyModalProvider to spread props first into
ConfigureUpdateStrategyModal (or omit cancel/close from the spread) and then
pass cancel={props.closeOverlay} and close={props.closeOverlay} to enforce using
props.closeOverlay; locate the ConfigureUpdateStrategyModalProvider and
ConfigureUpdateStrategyModal usages to apply this change so closeOverlay cannot
be overridden by caller props.

In `@frontend/public/components/modals/delete-modal.tsx`:
- Around line 183-188: The DeleteModalProvider currently spreads props after
passing cancel and close, allowing a caller to override cancel/close; in the
DeleteModalProvider component (and the ModalWrapper usage) spread {...props}
first and then pass cancel={props.closeOverlay} and close={props.closeOverlay}
so the enforced overlay handlers cannot be overridden by caller-provided props
(refer to DeleteModalProvider, ModalWrapper, DeleteModal, and
props.closeOverlay).

In `@frontend/public/components/modals/delete-pvc-modal.tsx`:
- Around line 87-91: The DeletePVCModalProvider currently spreads {...props}
after explicit cancel/close props which allows callers to override
props.closeOverlay; change the prop order in the JSX so you spread {...props}
first and then pass cancel={props.closeOverlay} close={props.closeOverlay} (on
ModalWrapper keep onClose={props.closeOverlay}) to ensure DeletePVCModal and
ModalWrapper always use props.closeOverlay for teardown and cannot be overridden
by incoming props.
♻️ Duplicate comments (2)
frontend/packages/console-app/src/actions/hooks/useJobActions.ts (1)

55-57: Same launcher-dep suppression pattern—please confirm stability.

If useConfigureCountModal() returns a new function over time, omitting it from deps can leave the action stale. This mirrors the earlier launcher-dep concern.

frontend/packages/console-app/src/actions/providers/build-config-provider.ts (1)

36-38: Launcher-dep suppression repeated here—confirm the hook’s launcher is stable.

Same dependency omission pattern as in other action hooks; please ensure the launcher identity is stable or the action can become stale.

Also applies to: 71-73

🧹 Nitpick comments (16)
frontend/public/components/utils/webhooks.tsx (1)

90-115: The isLoaded dependency may cause an unnecessary double-fetch.

The effect sets isLoaded = true at line 111, and isLoaded is also listed in the dependency array. On initial mount:

  1. isLoaded is false → effect runs → secrets fetched → setLoaded(true)
  2. isLoaded changes to true → effect re-runs → secrets fetched again

Consider adding a guard or removing isLoaded from deps if it's only meant to track completion:

  useEffect(() => {
-   if (!canGetSecret) {
+   if (!canGetSecret || isLoaded) {
      return;
    }

Alternatively, if the intent is to allow re-fetching when secretNames change, isLoaded should be removed from the dependency array entirely—it's not a meaningful trigger.


On the launchModal suppression: I see this pattern across the PR for avoiding the max-depth error. For long-term maintainability, the useOverlay hook should ideally return a stable (memoized) function reference. If that's not feasible right now, a useRef wrapper is a cleaner alternative to eslint-disable:

const launchModalRef = useRef(launchModal);
launchModalRef.current = launchModal;
// then use launchModalRef.current inside the effect

This keeps the linter happy and documents the intent more explicitly than a suppression comment.

frontend/packages/console-shared/src/hooks/useWarningModal.tsx (1)

37-52: Consider documenting memoization expectations.

The dependency array at line 50 includes props, which is an object reference. If callers pass inline objects (e.g., useWarningModal({ title: 'Title' })), the callback will be recreated on every render. This is fine for most use cases, but callers needing a stable callback reference should memoize their props.

Consider adding a note in the JSDoc (around line 30-36) mentioning this behavior, especially since other parts of the codebase may rely on stable callback references for effect dependencies.

📝 Suggested documentation addition
 /**
  * useWarningModal is a hook that provides a way to launch a WarningModal.
  * Supports two usage patterns:
  * - Pass props at hook initialization time: useWarningModal({ title: 'Title' })
  * - Pass props in the callback: const launch = useWarningModal(); launch({ title: 'Title' })
  * - Mix both (overrides have priority): const launch = useWarningModal({ title: 'Title' }); launch({ children: <Content /> })
+ *
+ * Note: If a stable callback reference is required, memoize the props object passed
+ * to this hook using useMemo to prevent the callback from being recreated on each render.
  */
frontend/packages/knative-plugin/src/components/add/SecretKeySelector.tsx (1)

51-63: Confirm useOverlay() provides a stable function or capture it safely.
Line 51–63 suppresses exhaustive-deps and drops launchModal. If useOverlay() ever returns a new function (e.g., provider change), this effect will keep a stale launcher and may miss error modals. Please confirm stability; if not guaranteed, capture it via a ref while keeping the namespace-only fetch behavior.

♻️ Optional safer pattern (ref keeps latest launcher)
-import { useState, useEffect } from 'react';
+import { useState, useEffect, useRef } from 'react';
...
-  const launchModal = useOverlay();
+  const launchModal = useOverlay();
+  const launchModalRef = useRef(launchModal);
+  useEffect(() => {
+    launchModalRef.current = launchModal;
+  }, [launchModal]);
...
-        if (err?.response?.status !== 403) {
-          launchModal(ErrorModal, { error: err?.message });
-        }
+        if (err?.response?.status !== 403) {
+          launchModalRef.current(ErrorModal, { error: err?.message });
+        }
frontend/packages/metal3-plugin/src/components/maintenance/actions.tsx (2)

42-42: Minor inconsistency in CTA assignment pattern

Line 34 assigns cta: startNodeMaintenanceModal directly as a function reference, whereas here you wrap with cta: () => stopNodeMaintenanceModalLauncher(). Both work, but the inconsistency is a bit puzzling.

If both launchers have the same signature (no-arg functions returning void/Promise), prefer consistency—either direct reference for both or arrow wrappers for both. This aids readability and avoids questions about subtle differences.

♻️ Suggested alignment (if signatures match)
-        cta: () => stopNodeMaintenanceModalLauncher(),
+        cta: stopNodeMaintenanceModalLauncher,

27-28: Guard the useStopNodeMaintenanceModal hook call or add undefined handling

findNodeMaintenance returns undefined when no matching maintenance is found, yet useStopNodeMaintenanceModal(nodeMaintenance) is invoked unconditionally at line 28. The hook immediately computes modal content by calling getNodeMaintenanceReason(nodeMaintenance) and getNodeMaintenanceNodeName(nodeMaintenance) with potentially undefined data. Additionally, getMaintenanceModel(nodeMaintenance) (invoked in the onConfirm callback) accesses nodeMaintenance.apiVersion without checking if it exists.

While the launcher is only invoked when nodeMaintenance is truthy (line 38), this pattern wastes renders and violates the hook's contract—the type signature doesn't reflect that undefined is acceptable. This can be fragile if the selector functions don't handle undefined gracefully.

Either guard the hook call with a conditional or update useStopNodeMaintenanceModal to explicitly handle and return a no-op launcher when nodeMaintenance is undefined.

frontend/packages/knative-plugin/src/actions/creators.ts (1)

130-130: Unnecessary template literal.

Use a plain string literal here since there's no interpolation.

✏️ Suggested fix
-      id: `delete-resource`,
+      id: 'delete-resource',
frontend/packages/console-app/src/actions/hooks/useRetryRolloutAction.ts (1)

98-100: Re-enable react-hooks/exhaustive-deps and include launchModal in the dependency array.

useOverlay returns a stable launcher—launchOverlay is memoized with useCallback(..., []) in OverlayProvider (line 40), so its identity never changes. The suppression is unnecessary; including it in the deps array will not cause infinite loops. Keeping the lint rule enabled ensures future maintainers catch unintended stale closures.

frontend/packages/console-app/src/actions/hooks/useCommonActions.ts (1)

47-85: Avoid suppressing exhaustive-deps; verify useOverlay stability.

launchModal is omitted from deps with an eslint-disable. If useOverlay ever returns a new function, this can capture a stale launcher. Prefer stabilizing the hook output (or memoizing) so the dependency can be included and the suppression removed.

Also applies to: 174-176

frontend/packages/console-app/src/actions/hooks/usePVCActions.ts (1)

7-11: Inconsistent lazy-loading for modal providers.

LazyExpandPVCModalProvider and LazyClonePVCModalProvider are lazy-loaded, but DeletePVCModalProvider is imported directly. For consistency and code-splitting benefits, consider using a lazy-loaded variant for DeletePVCModalProvider as well.

Does React lazy loading improve bundle size for modals?
frontend/public/components/modals/managed-resource-save-modal.tsx (1)

53-54: Consider excluding closeOverlay from prop spread.

The {...props} spread will pass closeOverlay to the inner ManagedResourceSaveModal, which doesn't use it (it uses close instead). While React ignores unknown props on function components, explicitly destructuring to exclude closeOverlay would be cleaner:

♻️ Suggested refinement
 export const ManagedResourceSaveModalProvider: OverlayComponent<ManagedResourceSaveModalProps> = (
   props,
 ) => {
+  const { closeOverlay, ...rest } = props;
   return (
-    <ModalWrapper blocking onClose={props.closeOverlay}>
-      <ManagedResourceSaveModal close={props.closeOverlay} {...props} />
+    <ModalWrapper blocking onClose={closeOverlay}>
+      <ManagedResourceSaveModal close={closeOverlay} {...rest} />
     </ModalWrapper>
   );
 };
frontend/public/components/namespace.jsx (1)

878-882: Simplify: pullSecret: undefined is redundant.

Passing pullSecret: undefined explicitly is unnecessary since the prop is already optional in ConfigureNamespacePullSecretProps. This adds noise without semantic value.

♻️ Suggested simplification
   const modal = () =>
     launchModal(LazyConfigureNamespacePullSecretModalProvider, {
       namespace,
-      pullSecret: undefined,
     });
frontend/packages/console-app/src/components/modals/resource-limits/index.ts (1)

4-9: The .then(m => ({ default: m.default })) is redundant.

Since ResourceLimitsModalLauncher already exports ResourceLimitsModalProvider as its default export, the transform is unnecessary. React.lazy expects a module with a default export, which is already satisfied.

♻️ Simplified lazy export
 export const LazyResourceLimitsModalProvider = lazy(() =>
-  import('./ResourceLimitsModalLauncher' /* webpackChunkName: "resource-limits-modal" */).then(
-    (m) => ({
-      default: m.default,
-    }),
-  ),
+  import('./ResourceLimitsModalLauncher' /* webpackChunkName: "resource-limits-modal" */),
 );

That said, if this pattern is intentional for consistency across the codebase or to handle potential named-export scenarios in the future, feel free to keep it.

frontend/packages/dev-console/src/actions/context-menu.ts (1)

14-40: Inconsistency: DeleteApplicationAction still uses i18next.t() directly.

This function uses i18next.t() for translations (line 23), while the new useDeleteResourceAction hook uses useTranslation(). Since DeleteApplicationAction is not a hook, it can't use useTranslation, but this creates an inconsistency in how translations are handled within the same file.

Consider migrating DeleteApplicationAction to a hook (useDeleteApplicationAction) in a future iteration to align with the hook-based pattern if the broader migration effort supports it.

frontend/packages/console-app/src/components/modals/resource-limits/ResourceLimitsModalLauncher.tsx (1)

64-70: Prop spread order could inadvertently override close.

The spread {...props} after close={props.closeOverlay} means if props somehow contains a close property, it would override the intended value. While OverlayComponent props shouldn't include close (they provide closeOverlay), defensive ordering is safer:

♻️ Defensive prop ordering
 export const ResourceLimitsModalProvider: OverlayComponent<ResourceLimitsModalLauncherProps> = (
   props,
 ) => (
   <ModalWrapper blocking onClose={props.closeOverlay}>
-    <ResourceLimitsModalLauncher close={props.closeOverlay} {...props} />
+    <ResourceLimitsModalLauncher {...props} close={props.closeOverlay} />
   </ModalWrapper>
 );

This ensures close is always bound to closeOverlay regardless of what's in props.

frontend/public/components/modals/configure-ns-pull-secret-modal.tsx (1)

317-329: Same prop spread order concern; also closeOverlay leaks into child props.

Two observations:

  1. Prop ordering: The spread {...props} after explicit cancel and close assignments could override them if props contains those keys.

  2. closeOverlay prop leakage: The OverlayComponent type injects closeOverlay into props. Spreading {...props} passes closeOverlay to ConfigureNamespacePullSecret, which doesn't expect it. This may cause a React warning about unknown DOM attributes if the prop propagates further.

♻️ Destructure to exclude closeOverlay and fix ordering
-export const ConfigureNamespacePullSecretModalProvider: OverlayComponent<ConfigureNamespacePullSecretProps> = (
-  props,
-) => {
+export const ConfigureNamespacePullSecretModalProvider: OverlayComponent<ConfigureNamespacePullSecretProps> = ({
+  closeOverlay,
+  ...restProps
+}) => {
   return (
-    <ModalWrapper blocking onClose={props.closeOverlay}>
+    <ModalWrapper blocking onClose={closeOverlay}>
       <ConfigureNamespacePullSecret
-        cancel={props.closeOverlay}
-        close={props.closeOverlay}
-        {...props}
+        {...restProps}
+        cancel={closeOverlay}
+        close={closeOverlay}
       />
     </ModalWrapper>
   );
 };

This prevents closeOverlay from leaking and ensures cancel/close are always correctly bound.

frontend/public/components/modals/index.ts (1)

87-92: Minor formatting inconsistency.

LazyClonePVCModalProvider and LazyRestorePVCModalProvider use single-line .then((m) => ({ default: m.default })) while the other six lazy providers use multi-line formatting. Consider aligning for consistency and easier diffing across providers.

📝 Suggested formatting alignment
 // Lazy-loaded OverlayComponent for Clone PVC Modal
 export const LazyClonePVCModalProvider = lazy(() =>
   import(
     '@console/app/src/components/modals/clone/clone-pvc-modal' /* webpackChunkName: "clone-pvc-modal" */
-  ).then((m) => ({ default: m.default })),
+  ).then((m) => ({
+    default: m.default,
+  })),
 );
 // Lazy-loaded OverlayComponent for Restore PVC Modal
 export const LazyRestorePVCModalProvider = lazy(() =>
   import(
     '@console/app/src/components/modals/restore-pvc/restore-pvc-modal' /* webpackChunkName: "restore-pvc-modal" */
-  ).then((m) => ({ default: m.default })),
+  ).then((m) => ({
+    default: m.default,
+  })),
 );

Also applies to: 113-118

@rhamilto
Copy link
Member Author

/retest

2 similar comments
@rhamilto
Copy link
Member Author

/retest

@rhamilto
Copy link
Member Author

/retest

@rhamilto rhamilto force-pushed the CONSOLE-5012-5 branch 3 times, most recently from d102d05 to 274b735 Compare January 27, 2026 20:39
@rhamilto
Copy link
Member Author

/retest

1 similar comment
@rhamilto
Copy link
Member Author

/retest

@rhamilto
Copy link
Member Author

/retest

@rhamilto
Copy link
Member Author

rhamilto commented Feb 2, 2026

/assign @yanpzhan
/assign @vojtechszocs

Tech debt, so assigning labels
/label px-approved
/label docs-approved

@openshift-ci openshift-ci bot added the docs-approved Signifies that Docs has signed off on this PR label Feb 2, 2026
@rhamilto rhamilto changed the title [WIP] CONSOLE-5012: Migrate confirmModal to overlay pattern CONSOLE-5012: Migrate confirmModal to overlay pattern Feb 2, 2026
@openshift-ci openshift-ci bot removed the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Feb 2, 2026
@rhamilto rhamilto changed the title CONSOLE-5012: Migrate confirmModal to overlay pattern [WIP] CONSOLE-5012: Migrate confirmModal to overlay pattern Feb 2, 2026
@openshift-ci openshift-ci bot added the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Feb 2, 2026
@openshift-ci
Copy link
Contributor

openshift-ci bot commented Feb 2, 2026

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: rhamilto

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

openshift-ci-robot commented Feb 2, 2026

@rhamilto: This pull request references CONSOLE-5012 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.22.0" version, but no target version was set.

Details

In response to this:

Summary

This PR completes the modal migration effort by migrating all instances of confirmModal to use the modern overlay pattern with useWarningModal and React Context.

Note: This PR builds on:

Changes

Core Modal System Updates

  • ✅ Removed deprecated confirmModal launcher and confirm-modal.tsx file
  • ✅ Fixed useWarningModal to properly handle closeOverlay prop and prevent React DOM warnings
  • ✅ Updated all modal invocations to use lazy-loaded overlay components

Topology Move Node - React Context Pattern

Migrated topology moveNodeToGroup from global state to React Context pattern:

  • Created MoveNodeHandlersProvider - React Context provider for confirmation/error handlers
  • Created SyncMoveNodeHandlers - Zero-render component that syncs handlers for non-React contexts (drag-drop callbacks)
  • Wrapped Topology component with MoveNodeHandlersProvider
  • Added unit tests - 8 tests covering all scenarios, all passing ✅
  • Deprecated old hooks with console warnings for backward compatibility

Architecture Benefits:

StopNodeMaintenanceModal Migration

  • Removed the deprecated stopNodeMaintenanceModal imperative function
  • Kept only the useStopNodeMaintenanceModal hook that already uses useWarningModal
  • Updated all metal3-plugin components to use the hook-based approach

Action Hooks Migration

Updated all action hooks to use lazy-loaded overlay components:

  • useCommonActions - Delete modal
  • useDeploymentActions - Update strategy, resource limits
  • usePVCActions - Expand, clone, delete PVC modals
  • usePDBActions - Delete PDB modal
  • useVolumeSnapshotActions - Restore PVC modal

Drag-Drop Error Handling

  • Added try-catch in topology drag-drop components
  • Prevents optimistic UI update when user cancels move operation
  • Properly handles promise rejection from user cancellation

Technical Details

useWarningModal Fix

Fixed prop spreading issue that caused React DOM warnings:

const ControlledWarningModal: FC<WarningModalProps & { closeOverlay?: () => void }> = ({
 closeOverlay,  // ← Destructured to prevent prop warning
 ...props
}) => {
 const onClose = (e) => {
   setIsOpen(false);
   props.onClose?.(e);
   closeOverlay?.();  // ← Properly calls cleanup
 };
 // ...
}

Topology Move Node - Context Pattern

Before (Global State):

// ❌ Module-level variables set by hooks
let globalConfirmHandler = null;
let globalErrorHandler = null;

export const setMoveNodeToGroupConfirmHandler = (handler) => {
 globalConfirmHandler = handler;
};

// Called in Topology component
useSetupMoveNodeToGroupHandlers();

After (React Context):

// ✅ React Context provider
export const MoveNodeHandlersProvider = ({ children }) => {
 const { showError, confirmMove } = useMemo(() => ({
   showError: (error) => launcher(ErrorModal, { error }),
   confirmMove: (title, message, confirmText) => new Promise((resolve, reject) => {
     launchWarningModal({ title, children: message, onConfirm: resolve, onClose: reject });
   }),
 }));
 
 return <Context.Provider value={{ showError, confirmMove }}>{children}</Context.Provider>;
};

// Wrap Topology component
<MoveNodeHandlersProvider>
 <SyncMoveNodeHandlers />  {/* Syncs to module for drag-drop callbacks */}
 <Topology />
</MoveNodeHandlersProvider>

Hybrid Approach:

Dependencies

This PR builds upon and depends on:

Test Plan

Automated Tests ✅

  • TypeScript compilation succeeds
  • ESLint passes
  • Unit tests pass (8/8 for moveNodeToGroup)
  • Frontend tests pass
  • Backend tests pass
  • E2E tests pass

Manual Testing

  • Verify topology node drag-and-drop with confirmation modal works
  • Verify clicking "Cancel" in confirmation modal restores node to original position
  • Verify clicking "Move"/"Remove" confirms the operation
  • Verify metal3-plugin node maintenance modals work correctly
  • Verify no React DOM warnings about closeOverlay prop in console
  • Verify modals properly close and remove from DOM on both confirm and cancel
  • Test with multiple topology instances (different namespaces/tabs)

Breaking Changes

None - deprecated hooks remain functional with console warnings for backward compatibility.

🤖 Generated with Claude Code

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.

@rhamilto
Copy link
Member Author

rhamilto commented Feb 3, 2026

/retest

@openshift-merge-robot openshift-merge-robot added the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Feb 3, 2026
@openshift-ci-robot
Copy link
Contributor

openshift-ci-robot commented Feb 3, 2026

@rhamilto: This pull request references CONSOLE-5012 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.22.0" version, but no target version was set.

Details

In response to this:

Summary

This PR completes the modal migration effort by migrating all instances of confirmModal to use the modern overlay pattern with useWarningModal and React Context.

Note: This PR builds on:

Changes

Core Modal System Updates

  • ✅ Removed deprecated confirmModal launcher and confirm-modal.tsx file
  • ✅ Fixed useWarningModal to properly handle closeOverlay prop and prevent React DOM warnings
  • ✅ Updated all modal invocations to use lazy-loaded overlay components

Topology Move Node - React Context Pattern

Migrated topology moveNodeToGroup from global state to React Context pattern:

  • Created MoveNodeHandlersProvider - React Context provider for confirmation/error handlers
  • Created SyncMoveNodeHandlers - Zero-render component that syncs handlers for non-React contexts (drag-drop callbacks)
  • Wrapped Topology component with MoveNodeHandlersProvider
  • Added unit tests - 8 tests covering all scenarios, all passing ✅
  • Deprecated old hooks with console warnings for backward compatibility
  • Fixed aria-hidden accessibility violation - Blur active element before modal opens to prevent focus violations

Architecture Benefits:

  • Eliminates global state race conditions
  • Follows React Context pattern from CONSOLE-5012: Create shared error modal launcher using React Context #15946
  • Improves testability (context can be mocked)
  • Single provider initialization in Topology component
  • Proper cleanup via React lifecycle
  • Type-safe with clear error messages
  • WCAG 2.1 Level A compliant - No aria-hidden focus violations

Accessibility Fix - aria-hidden Focus Violation

Problem: When the confirmation modal opened during drag-drop operations, focus remained on an SVG <g> element in the topology graph. PatternFly's Modal sets aria-hidden="true" on the #app div, creating an accessibility violation where a focused element is hidden from assistive technology users.

Browser Warning (Fixed):

Blocked aria-hidden on an element because its descendant retained focus.
The focus must not be hidden from assistive technology users.
Element with focus: <g>
Ancestor with aria-hidden: <div#app>

Solution: Blur the active element before launching the modal:

// Blur active element to prevent aria-hidden focus violations when modal opens
if (document.activeElement instanceof HTMLElement || 
   document.activeElement instanceof SVGElement) {
 document.activeElement.blur();
}

This ensures PatternFly's Modal can properly manage focus by moving it to the modal itself, eliminating the accessibility violation.

StopNodeMaintenanceModal Migration

  • Removed the deprecated stopNodeMaintenanceModal imperative function
  • Kept only the useStopNodeMaintenanceModal hook that already uses useWarningModal
  • Updated all metal3-plugin components to use the hook-based approach

Action Hooks Migration

Updated all action hooks to use lazy-loaded overlay components:

  • useCommonActions - Delete modal
  • useDeploymentActions - Update strategy, resource limits
  • usePVCActions - Expand, clone, delete PVC modals
  • usePDBActions - Delete PDB modal
  • useVolumeSnapshotActions - Restore PVC modal

Drag-Drop Error Handling

  • Added try-catch in topology drag-drop components
  • Prevents optimistic UI update when user cancels move operation
  • Properly handles promise rejection from user cancellation

Technical Details

useWarningModal Fix

Fixed prop spreading issue that caused React DOM warnings:

const ControlledWarningModal: FC<WarningModalProps & { closeOverlay?: () => void }> = ({
 closeOverlay,  // ← Destructured to prevent prop warning
 ...props
}) => {
 const onClose = (e) => {
   setIsOpen(false);
   props.onClose?.(e);
   closeOverlay?.();  // ← Properly calls cleanup
 };
 // ...
}

Topology Move Node - Context Pattern

Before (Global State):

// ❌ Module-level variables set by hooks
let globalConfirmHandler = null;
let globalErrorHandler = null;

export const setMoveNodeToGroupConfirmHandler = (handler) => {
 globalConfirmHandler = handler;
};

// Called in Topology component
useSetupMoveNodeToGroupHandlers();

After (React Context):

// ✅ React Context provider
export const MoveNodeHandlersProvider = ({ children }) => {
 const { showError, confirmMove } = useMemo(() => ({
   showError: (error) => launcher(ErrorModal, { error }),
   confirmMove: (title, message, confirmText) => new Promise((resolve, reject) => {
     launchWarningModal({ title, children: message, onConfirm: resolve, onClose: reject });
   }),
 }));
 
 return <Context.Provider value={{ showError, confirmMove }}>{children}</Context.Provider>;
};

// Wrap Topology component
<MoveNodeHandlersProvider>
 <SyncMoveNodeHandlers />  {/* Syncs to module for drag-drop callbacks */}
 <Topology />
</MoveNodeHandlersProvider>

Hybrid Approach:

Dependencies

This PR builds upon and depends on:

Test Plan

Automated Tests ✅

  • TypeScript compilation succeeds
  • ESLint passes
  • Unit tests pass (8/8 for moveNodeToGroup)
  • Frontend tests pass
  • Backend tests pass
  • E2E tests pass

Manual Testing

  • Verify topology node drag-and-drop with confirmation modal works
  • Verify clicking "Cancel" in confirmation modal restores node to original position
  • Verify clicking "Move"/"Remove" confirms the operation
  • Verify metal3-plugin node maintenance modals work correctly
  • Verify no React DOM warnings about closeOverlay prop in console
  • Verify modals properly close and remove from DOM on both confirm and cancel
  • Test with multiple topology instances (different namespaces/tabs)
  • Verify no aria-hidden accessibility warnings in browser console
  • Verify modal receives focus when opened from drag-drop operation

Breaking Changes

None - deprecated hooks remain functional with console warnings for backward compatibility.

🤖 Generated with Claude Code

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-merge-robot openshift-merge-robot removed the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Feb 3, 2026
@openshift-ci-robot
Copy link
Contributor

openshift-ci-robot commented Feb 3, 2026

@rhamilto: This pull request references CONSOLE-5012 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.22.0" version, but no target version was set.

Details

In response to this:

Summary

This PR completes the modal migration effort by migrating all instances of confirmModal to use the modern overlay pattern with useWarningModal and refactors moveNodeToGroup to use React Context, eliminating global state race conditions.

Note: This PR builds on:

Changes

Removed deprecated confirmModal

  • ✅ Deleted confirm-modal.tsx and its imperative launcher
  • ✅ Removed confirmModal from modals/index.ts exports
  • ✅ Removed translation key from public.json

Migrated to useWarningModal overlay pattern

  • ✅ Updated topology moveNodeToGroup to use useWarningModal with proper cancel handling
  • ✅ Updated StopNodeMaintenanceModal to remove imperative API, keeping only hook-based approach
  • ✅ Updated all metal3-plugin maintenance components to use hook-based approach
  • ✅ Fixed useWarningModal to properly call closeOverlay() and filter it from props spread

Refactored moveNodeToGroup to use React Context

  • ✅ Created MoveNodeHandlersProvider using React Context pattern
  • ✅ Created SyncMoveNodeHandlers component to sync handlers for non-React contexts
  • ✅ Added useMoveNodeHandlers() hook for accessing handlers
  • ✅ Wrapped Topology component with MoveNodeHandlersProvider
  • ✅ Deprecated old useSetupMoveNodeToGroupHandlers hooks with warnings
  • ✅ Added comprehensive unit tests (8 tests covering all scenarios) ✅

Fixed accessibility violation

  • ✅ Blur active element before launching confirmation modal
  • ✅ Prevents focus from remaining on SVG elements in topology graph
  • ✅ Fixes browser warning: "Blocked aria-hidden on an element because its descendant retained focus"

Architecture Benefits

  • Eliminates global state race conditions - React Context ensures proper scoping
  • Follows React Context pattern established in CONSOLE-5012: Create shared error modal launcher using React Context #15946 (error modal handler)
  • Improves testability - Context can be mocked in tests
  • Single provider initialization - Around Topology component only
  • Proper cleanup - Via React lifecycle instead of manual cleanup
  • Type-safe - With clear error messages when handlers not available
  • Maintains backward compatibility - Via deprecated hooks with console warnings
  • WCAG 2.1 Level A compliant - No aria-hidden focus violations

The hybrid approach (Context + module reference) supports both React components (via useMoveNodeHandlers hook) and non-React drag-drop callbacks (via moveNodeToGroup function), consistent with the error modal handler pattern.

Technical Details

Accessibility Fix - aria-hidden Focus Violation

Problem: When the confirmation modal opened during drag-drop operations, focus remained on an SVG <g> element in the topology graph. PatternFly's Modal sets aria-hidden="true" on the #app div, creating an accessibility violation where a focused element is hidden from assistive technology users.

Browser Warning (Fixed):

Blocked aria-hidden on an element because its descendant retained focus.
The focus must not be hidden from assistive technology users.
Element with focus: <g>
Ancestor with aria-hidden: <div#app>

Solution: Blur the active element before launching the modal:

// Blur active element to prevent aria-hidden focus violations when modal opens
if (document.activeElement instanceof HTMLElement || 
   document.activeElement instanceof SVGElement) {
 document.activeElement.blur();
}

React Context Pattern

Before (Global State):

// ❌ Module-level variables set by hooks
let globalConfirmHandler = null;
let globalErrorHandler = null;

export const setMoveNodeToGroupConfirmHandler = (handler) => {
 globalConfirmHandler = handler;
};

// Called in Topology component
useSetupMoveNodeToGroupHandlers();

After (React Context):

// ✅ React Context provider
export const MoveNodeHandlersProvider = ({ children }) => {
 const { showError, confirmMove } = useMemo(() => ({
   showError: (error) => launcher(ErrorModal, { error }),
   confirmMove: (title, message, confirmText) => new Promise((resolve, reject) => {
     launchWarningModal({ title, children: message, onConfirm: resolve, onClose: reject });
   }),
 }));
 
 return <Context.Provider value={{ showError, confirmMove }}>{children}</Context.Provider>;
};

// Wrap Topology component
<MoveNodeHandlersProvider>
 <SyncMoveNodeHandlers />  {/* Syncs to module for drag-drop callbacks */}
 <Topology />
</MoveNodeHandlersProvider>

Hybrid Approach:

useWarningModal Fix

Fixed prop spreading issue that caused React DOM warnings:

const ControlledWarningModal: FC<WarningModalProps & { closeOverlay?: () => void }> = ({
 closeOverlay,  // ← Destructured to prevent prop warning
 ...props
}) => {
 const onClose = (e) => {
   setIsOpen(false);
   props.onClose?.(e);
   closeOverlay?.();  // ← Properly calls cleanup
 };
 // ...
}

Test Plan

Automated Tests ✅

  • TypeScript compilation succeeds
  • ESLint passes
  • Unit tests pass (8/8 for moveNodeToGroup)
  • Frontend tests pass
  • Backend tests pass
  • E2E tests pass

Manual Testing

  • Verify topology node drag-and-drop with confirmation modal works
  • Verify clicking "Cancel" in confirmation modal restores node to original position
  • Verify clicking "Move"/"Remove" confirms the operation
  • Verify metal3-plugin node maintenance modals work correctly
  • Verify no React DOM warnings about closeOverlay prop in console
  • Verify modals properly close and remove from DOM on both confirm and cancel
  • Test with multiple topology instances (different namespaces/tabs)
  • Verify no aria-hidden accessibility warnings in browser console
  • Verify modal receives focus when opened from drag-drop operation

Breaking Changes

None - deprecated hooks remain functional with console warnings for backward compatibility.

🤖 Generated with Claude Code

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

openshift-ci-robot commented Feb 3, 2026

@rhamilto: This pull request references CONSOLE-5012 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.22.0" version, but no target version was set.

Details

In response to this:

Summary

This PR completes the modal migration effort by migrating all instances of confirmModal to use the modern overlay pattern with useWarningModal and refactors moveNodeToGroup to use React Context, eliminating global state race conditions.

Note: This PR builds on:

Changes

Removed deprecated confirmModal

  • ✅ Deleted confirm-modal.tsx and its imperative launcher
  • ✅ Removed confirmModal from modals/index.ts exports
  • ✅ Removed translation key from public.json

Migrated to useWarningModal overlay pattern

  • ✅ Updated topology moveNodeToGroup to use useWarningModal with proper cancel handling
  • ✅ Updated StopNodeMaintenanceModal to remove imperative API, keeping only hook-based approach
  • ✅ Updated all metal3-plugin maintenance components to use hook-based approach
  • ✅ Fixed useWarningModal to properly call closeOverlay() and filter it from props spread

Refactored moveNodeToGroup to use React Context

  • ✅ Created MoveNodeHandlersProvider using React Context pattern
  • ✅ Created SyncMoveNodeHandlers component to sync handlers for non-React contexts
  • ✅ Added useMoveNodeHandlers() hook for accessing handlers
  • ✅ Wrapped Topology component with MoveNodeHandlersProvider
  • ✅ Deprecated old useSetupMoveNodeToGroupHandlers hooks with warnings
  • ✅ Added comprehensive unit tests (8 tests covering all scenarios) ✅

Fixed accessibility violation

  • ✅ Blur active element before launching confirmation modal
  • ✅ Prevents focus from remaining on SVG elements in topology graph
  • ✅ Fixes browser warning: "Blocked aria-hidden on an element because its descendant retained focus"

Architecture Benefits

  • Eliminates global state race conditions - React Context ensures proper scoping
  • Follows React Context pattern established in CONSOLE-5012: Create shared error modal launcher using React Context #15946 (error modal handler)
  • Improves testability - Context can be mocked in tests
  • Single provider initialization - Around Topology component only
  • Proper cleanup - Via React lifecycle instead of manual cleanup
  • Type-safe - With clear error messages when handlers not available
  • Maintains backward compatibility - Via deprecated hooks with console warnings
  • WCAG 2.1 Level A compliant - No aria-hidden focus violations

The hybrid approach (Context + module reference) supports both React components (via useMoveNodeHandlers hook) and non-React drag-drop callbacks (via moveNodeToGroup function), consistent with the error modal handler pattern.

Technical Details

Accessibility Fix - aria-hidden Focus Violation

Problem: When the confirmation modal opened during drag-drop operations, focus remained on an SVG <g> element in the topology graph. PatternFly's Modal sets aria-hidden="true" on the #app div, creating an accessibility violation where a focused element is hidden from assistive technology users.

Browser Warning (Fixed):

Blocked aria-hidden on an element because its descendant retained focus.
The focus must not be hidden from assistive technology users.
Element with focus: <g>
Ancestor with aria-hidden: <div#app>

Solution: Blur the active element before launching the modal:

// Blur active element to prevent aria-hidden focus violations when modal opens
if (document.activeElement instanceof HTMLElement || 
   document.activeElement instanceof SVGElement) {
 document.activeElement.blur();
}

React Context Pattern

Before (Global State):

// ❌ Module-level variables set by hooks
let globalConfirmHandler = null;
let globalErrorHandler = null;

export const setMoveNodeToGroupConfirmHandler = (handler) => {
 globalConfirmHandler = handler;
};

// Called in Topology component
useSetupMoveNodeToGroupHandlers();

After (React Context):

// ✅ React Context provider
export const MoveNodeHandlersProvider = ({ children }) => {
 const { showError, confirmMove } = useMemo(() => ({
   showError: (error) => launcher(ErrorModal, { error }),
   confirmMove: (title, message, confirmText) => new Promise((resolve, reject) => {
     launchWarningModal({ title, children: message, onConfirm: resolve, onClose: reject });
   }),
 }));
 
 return <Context.Provider value={{ showError, confirmMove }}>{children}</Context.Provider>;
};

// Wrap Topology component
<MoveNodeHandlersProvider>
 <SyncMoveNodeHandlers />  {/* Syncs to module for drag-drop callbacks */}
 <Topology />
</MoveNodeHandlersProvider>

Hybrid Approach:

useWarningModal Fix

Fixed prop spreading issue that caused React DOM warnings:

const ControlledWarningModal: FC<WarningModalProps & { closeOverlay?: () => void }> = ({
 closeOverlay,  // ← Destructured to prevent prop warning
 ...props
}) => {
 const onClose = (e) => {
   setIsOpen(false);
   props.onClose?.(e);
   closeOverlay?.();  // ← Properly calls cleanup
 };
 // ...
}

Test Plan

Automated Tests ✅

  • TypeScript compilation succeeds
  • ESLint passes
  • Unit tests pass (8/8 for moveNodeToGroup)
  • Frontend tests pass
  • Backend tests pass
  • E2E tests pass

Manual Testing

  • Verify topology node drag-and-drop with confirmation modal works
  • Verify clicking "Cancel" in confirmation modal restores node to original position
  • Verify clicking "Move"/"Remove" confirms the operation
  • Verify metal3-plugin node maintenance modals work correctly
  • Verify no React DOM warnings about closeOverlay prop in console
  • Verify modals properly close and remove from DOM on both confirm and cancel
  • Test with multiple topology instances (different namespaces/tabs)
  • Verify no aria-hidden accessibility warnings in browser console
  • Verify modal receives focus when opened from drag-drop operation

Breaking Changes

None - deprecated hooks remain functional with console warnings for backward compatibility.

🤖 Generated with Claude Code

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.

@rhamilto rhamilto force-pushed the CONSOLE-5012-5 branch 2 times, most recently from fbd0f24 to 1970b4a Compare February 3, 2026 19:45
@openshift-ci-robot
Copy link
Contributor

openshift-ci-robot commented Feb 3, 2026

@rhamilto: This pull request references CONSOLE-5012 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.22.0" version, but no target version was set.

Details

In response to this:

Summary

This PR completes the modal migration effort by migrating all instances of confirmModal to use the modern overlay pattern with useWarningModal and refactors moveNodeToGroup to use React Context for confirmation handling.

Note: This PR builds on:

Changes

Removed deprecated confirmModal

  • ✅ Deleted confirm-modal.tsx and its imperative launcher
  • ✅ Removed confirmModal from modals/index.ts exports
  • ✅ Removed translation key from public.json

Migrated to useWarningModal overlay pattern

  • ✅ Updated topology moveNodeToGroup to use useWarningModal with proper cancel handling
  • ✅ Updated StopNodeMaintenanceModal to remove imperative API, keeping only hook-based approach
  • ✅ Updated all metal3-plugin maintenance components to use hook-based approach
  • ✅ Fixed useWarningModal to properly call closeOverlay() and filter it from props spread

Refactored moveNodeToGroup to use React Context

  • ✅ Created MoveNodeHandlersProvider for confirmation modal handling only
  • ✅ Created SyncMoveNodeHandlers component to sync handlers for non-React contexts
  • ✅ Added useMoveNodeHandlers() hook for accessing confirmation handler
  • ✅ Wrapped Topology component with MoveNodeHandlersProvider
  • Uses shared launchErrorModal() from CONSOLE-5012: Create shared error modal launcher using React Context #15946 for error handling (not custom handler)
  • ✅ Deprecated old useSetupMoveNodeToGroupHandlers hooks with warnings
  • ✅ Added comprehensive unit tests (8 tests covering all scenarios)

Fixed accessibility violation

  • ✅ Blur active element before launching confirmation modal
  • ✅ Prevents focus from remaining on SVG elements in topology graph
  • ✅ Fixes browser warning: "Blocked aria-hidden on an element because its descendant retained focus"

Architecture Benefits

  • Eliminates global state race conditions - React Context ensures proper scoping
  • Follows React Context pattern established in CONSOLE-5012: Create shared error modal launcher using React Context #15946 (error modal handler)
  • Consistent error handling - Uses shared launchErrorModal() from CONSOLE-5012: Create shared error modal launcher using React Context #15946
  • Single responsibility - Provider only handles confirmations, errors use global handler
  • Improves testability - Context can be mocked in tests
  • Single provider initialization - Around Topology component only
  • Proper cleanup - Via React lifecycle instead of manual cleanup
  • Type-safe - With clear error messages when handlers not available
  • Maintains backward compatibility - Via deprecated hooks with console warnings
  • WCAG 2.1 Level A compliant - No aria-hidden focus violations

The hybrid approach (Context + module reference) supports both React components (via useMoveNodeHandlers hook) and non-React drag-drop callbacks (via moveNodeToGroup function), consistent with the error modal handler pattern.

Technical Details

Accessibility Fix - aria-hidden Focus Violation

Problem: When the confirmation modal opened during drag-drop operations, focus remained on an SVG <g> element in the topology graph. PatternFly's Modal sets aria-hidden="true" on the #app div, creating an accessibility violation where a focused element is hidden from assistive technology users.

Browser Warning (Fixed):

Blocked aria-hidden on an element because its descendant retained focus.
The focus must not be hidden from assistive technology users.
Element with focus: <g>
Ancestor with aria-hidden: <div#app>

Solution: Blur the active element before launching the modal:

// Blur active element to prevent aria-hidden focus violations when modal opens
if (document.activeElement instanceof HTMLElement || 
   document.activeElement instanceof SVGElement) {
 document.activeElement.blur();
}

React Context Pattern

Before (Global State):

// ❌ Module-level variables set by hooks
let globalConfirmHandler = null;
let globalErrorHandler = null;

export const setMoveNodeToGroupConfirmHandler = (handler) => {
 globalConfirmHandler = handler;
};

// Called in Topology component
useSetupMoveNodeToGroupHandlers();

After (React Context + Shared Error Handler):

// ✅ React Context provider for confirmation only
export const MoveNodeHandlersProvider = ({ children }) => {
 const confirmMove = useCallback((title, message, confirmText) => {
   return new Promise((resolve, reject) => {
     launchWarningModal({
       title: t(`topology~${title}`),
       children: message,
       confirmButtonLabel: t(`topology~${confirmText}`),
       onConfirm: resolve,
       onClose: () => reject(new Error('User cancelled')),
     });
   });
 }, [launchWarningModal, t]);
 
 return <Context.Provider value={{ confirmMove }}>{children}</Context.Provider>;
};

// Error handling uses shared global launcher from #15946
import { launchErrorModal } from '@console/shared/src/utils/error-modal-handler';

// In moveNodeToGroup:
catch (err) {
 if (err.message !== 'User cancelled') {
   launchErrorModal({ error: err.message });  // ← Shared handler
 }
 throw err;
}

// Wrap Topology component
<MoveNodeHandlersProvider>
 <SyncMoveNodeHandlers />  {/* Syncs confirmation handler for drag-drop */}
 <Topology />
</MoveNodeHandlersProvider>

Key Improvements:

Hybrid Approach:

useWarningModal Fix

Fixed prop spreading issue that caused React DOM warnings:

const ControlledWarningModal: FC<WarningModalProps & { closeOverlay?: () => void }> = ({
 closeOverlay,  // ← Destructured to prevent prop warning
 ...props
}) => {
 const onClose = (e) => {
   setIsOpen(false);
   props.onClose?.(e);
   closeOverlay?.();  // ← Properly calls cleanup
 };
 // ...
}

Test Plan

Automated Tests ✅

  • TypeScript compilation succeeds
  • ESLint passes
  • Unit tests pass (8/8 for moveNodeToGroup)
  • Frontend tests pass
  • Backend tests pass
  • E2E tests pass

Manual Testing

  • Verify topology node drag-and-drop with confirmation modal works
  • Verify clicking "Cancel" in confirmation modal restores node to original position
  • Verify clicking "Move"/"Remove" confirms the operation
  • Verify error modals use the shared launchErrorModal() handler
  • Verify metal3-plugin node maintenance modals work correctly
  • Verify no React DOM warnings about closeOverlay prop in console
  • Verify modals properly close and remove from DOM on both confirm and cancel
  • Test with multiple topology instances (different namespaces/tabs)
  • Verify no aria-hidden accessibility warnings in browser console
  • Verify modal receives focus when opened from drag-drop operation

Breaking Changes

None - deprecated hooks remain functional with console warnings for backward compatibility.

Related

🤖 Generated with Claude Code

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.

rhamilto and others added 2 commits February 4, 2026 15:01
- Add error-modal-handler.tsx to console-shared package with:
  - SyncErrorModalLauncher - Zero-render component that syncs launcher for non-React contexts
  - useErrorModalLauncher() - Hook for launching error modals from React components
  - launchErrorModal() - Function for launching from non-React contexts (callbacks, promises)

- Add SyncErrorModalLauncher to app.tsx inside OverlayProvider
  - Single initialization point for the entire application
  - Reuses existing OverlayProvider instead of creating new context

- Migrate packages to use launchErrorModal:
  - topology: componentUtils.ts, edgeActions.ts
  - knative-plugin: knativeComponentUtils.ts, create-connector-utils.ts
  - shipwright-plugin: logs-utils.ts
  - dev-console: pipeline-template-utils.ts

- Update moveNodeToGroup.tsx to support error handling:
  - Add setMoveNodeToGroupErrorHandler() for managing error handler
  - Add useSetupMoveNodeToGroupErrorHandler() hook for Topology component
  - Update moveNodeToGroup() to accept optional onError callback
  - Deprecate useMoveNodeToGroup() hook

- Add comprehensive test coverage:
  - error-modal-handler.spec.tsx - 5 unit tests covering all scenarios
  - __mocks__/error-modal-handler.tsx - Mock utilities for testing

- Remove deprecated errorModal() function from public/components/modals

This establishes a React Context-based pattern for error modals that
eliminates global state race conditions, improves testability, and
provides a consistent API across all packages. The hybrid approach
supports both React hooks and imperative API calls via module-level
reference with proper cleanup via React lifecycle.

Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
…veNodeToGroup

This commit completes the migration of confirmModal to the modern overlay
pattern and refactors moveNodeToGroup to use React Context, eliminating
global state race conditions and improving testability.

- Deleted confirm-modal.tsx and its imperative launcher
- Removed confirmModal from modals/index.ts exports
- Removed translation key from public.json

- Updated topology moveNodeToGroup to use useWarningModal with proper cancel handling
- Updated StopNodeMaintenanceModal to remove imperative API, keeping only hook-based approach
- Updated all metal3-plugin maintenance components to use hook-based approach
- Fixed useWarningModal to properly call closeOverlay() and filter it from props spread

- Created MoveNodeHandlersProvider using React Context pattern
- Created SyncMoveNodeHandlers component to sync handlers for non-React contexts
- Added useMoveNodeHandlers() hook for accessing handlers
- Wrapped Topology component with MoveNodeHandlersProvider
- Deprecated old useSetupMoveNodeToGroupHandlers hooks with warnings
- Added comprehensive unit tests (8 tests covering all scenarios)

- Blur active element before launching confirmation modal
- Prevents focus from remaining on SVG elements in topology graph
- Fixes browser warning: "Blocked aria-hidden on an element because its descendant retained focus"

- Eliminates global state race conditions
- Follows React Context pattern established in openshift#15946
- Improves testability with mockable context
- Single provider initialization around Topology component
- Proper cleanup via React lifecycle
- Type-safe with clear error messages
- Maintains backward compatibility via deprecated hooks
- Resolves accessibility violations with aria-hidden elements

The hybrid approach (Context + module reference) supports both React components
(via useMoveNodeHandlers hook) and non-React drag-drop callbacks (via moveNodeToGroup
function), consistent with the error modal handler pattern.

Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
@rhamilto
Copy link
Member Author

rhamilto commented Feb 4, 2026

/retest

3 similar comments
@rhamilto
Copy link
Member Author

rhamilto commented Feb 5, 2026

/retest

@rhamilto
Copy link
Member Author

rhamilto commented Feb 5, 2026

/retest

@rhamilto
Copy link
Member Author

rhamilto commented Feb 5, 2026

/retest

@openshift-ci
Copy link
Contributor

openshift-ci bot commented Feb 5, 2026

@rhamilto: all tests passed!

Full PR test history. Your PR dashboard.

Details

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. I understand the commands that are listed here.

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. component/core Related to console core functionality component/dev-console Related to dev-console component/knative Related to knative-plugin component/metal3 Related to metal3-plugin component/sdk Related to console-plugin-sdk component/shared Related to console-shared component/topology Related to topology do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. docs-approved Signifies that Docs has signed off on this PR jira/valid-reference Indicates that this PR references a valid Jira ticket of any type. kind/i18n Indicates issue or PR relates to internationalization or has content that needs to be translated px-approved Signifies that Product Support has signed off on this PR

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants