Skip to content

Conversation

@rhamilto
Copy link
Member

@rhamilto rhamilto commented Jan 22, 2026

Summary

Creates a shared error modal launcher utility in the console-shared package using React Context to eliminate code duplication and ensure error modals work correctly across all contexts (topology, standalone pages, import flows).

Note: This PR builds on:

Architecture

React Context Pattern

This implementation reuses the existing OverlayProvider instead of creating a new context provider:

<OverlayProvider>
  <SyncErrorModalLauncher />  {/* Zero-render sync component */}
  <App />
</OverlayProvider>

Dual API for Different Contexts

React Components - Use the hook:

const launchErrorModal = useErrorModalLauncher();
launchErrorModal({ title: 'Error', error: err.message });

Non-React Code (callbacks, promises, utilities) - Use the function:

createConnection(source, target).catch(err => {
  launchErrorModal({ title: 'Failed', error: err.message });
});

Changes

New Shared Utility

packages/console-shared/src/utils/error-modal-handler.tsx

  • SyncErrorModalLauncher - Component that syncs the launcher for non-React contexts
  • useErrorModalLauncher() - Hook for launching error modals from React components
  • launchErrorModal() - Function for launching from non-React contexts (callbacks, promises)

Test Coverage

packages/console-shared/src/utils/__tests__/error-modal-handler.spec.tsx

  • Unit tests covering all scenarios (5 tests, all passing)
  • Tests lifecycle (mount/unmount)
  • Tests error handling (uninitialized launcher)

packages/console-shared/src/utils/__mocks__/error-modal-handler.tsx

  • Mock utilities for testing components that use the error modal launcher

Single Initialization Point

public/components/app.tsx

  • Added <SyncErrorModalLauncher /> inside OverlayProvider
  • Single initialization point for the entire application

Topology Move Node Error Handling

packages/topology/src/utils/moveNodeToGroup.tsx

  • Added setMoveNodeToGroupErrorHandler() for managing error handler
  • Added useSetupMoveNodeToGroupErrorHandler() hook called in Topology component
  • Updated moveNodeToGroup() to accept optional onError callback
  • Deprecated useMoveNodeToGroup() hook

packages/topology/src/components/graph-view/Topology.tsx

  • Added useSetupMoveNodeToGroupErrorHandler() call to initialize error handling

Note: This uses a global handler pattern instead of React Context. A follow-up PR (#15948) will refactor this to use the same React Context pattern as the error modal handler.

Migrated to New API

Updated to use launchErrorModal in:

  • topology: componentUtils.ts, edgeActions.ts
  • knative-plugin: knativeComponentUtils.ts, create-connector-utils.ts
  • shipwright-plugin: logs-utils.ts
  • dev-console: pipeline-template-utils.ts

Cleanup

  • Removed deprecated errorModal function from public/components/modals
  • Updated exports in console-shared package

Benefits

  • Eliminates global state race conditions - Single initialization point in app root
  • Improves testability - OverlayProvider context can be mocked in tests
  • No code duplication - Shared utility used across all packages
  • Reuses existing infrastructure - No new providers, uses existing OverlayProvider
  • Simpler architecture - No unnecessary provider nesting
  • Type-safe - Full TypeScript support with proper generics
  • Proper lifecycle - Cleanup on unmount via useEffect
  • Backward compatible - Non-React code continues to work via module reference
  • Comprehensive test coverage - 5 unit tests covering all scenarios

Test Plan

Automated Tests

  • ✅ Unit tests pass (5/5 tests)
  • ✅ TypeScript compilation succeeds
  • ✅ ESLint passes
  • ✅ Pre-commit hooks pass

Manual Testing

  • Test topology drag/drop operations that trigger errors
  • Test BuildRun log viewing with error conditions
  • Test Git import flow with route exposure errors
  • Test deploy image flow with pipeline trigger errors
  • Verify no console errors when error modals are triggered
  • Test error modal from React component using useErrorModalLauncher() hook
  • Test error modal from promise chain using launchErrorModal() function
  • Test topology node move operations with error handling

Technical Details

Hybrid Approach

The implementation uses a hybrid pattern to support both React and non-React code:

  1. React Components: Call useErrorModalLauncher() hook which directly uses useOverlay()
  2. Non-React Code: Call launchErrorModal() function which accesses a module-level reference
  3. Sync Component: SyncErrorModalLauncher syncs the launcher to the module-level variable

This approach:

  • Eliminates the need for a custom Context provider
  • Reuses the existing OverlayProvider infrastructure
  • Supports both React hooks and imperative API calls
  • Has proper cleanup via React lifecycle

Migration Path

Before:

  • No shared utility
  • Each package implemented its own error modal handling
  • Inconsistent patterns across codebase
  • Direct imports of deprecated errorModal function

After:

  • Single initialization point (app.tsx)
  • React Context-based (via OverlayProvider)
  • Proper cleanup on unmount
  • Easy to test with mocks
  • Consistent API across all packages

Related

🤖 Generated with Claude Code

@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 22, 2026
@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 22, 2026
@openshift-ci-robot
Copy link
Contributor

openshift-ci-robot commented Jan 22, 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

Creates a shared global error modal launcher utility in the console-shared package to eliminate code duplication and ensure error modals work correctly across all contexts (topology, standalone pages, import flows).

Changes

New Shared Utility

  • packages/console-shared/src/utils/error-modal-handler.ts
  • launchGlobalErrorModal() - Launch error modals from non-React contexts
  • useSetupGlobalErrorModalLauncher() - Hook to initialize the launcher
  • setGlobalErrorModalLauncher() - Manage global state

Migrated Packages

  • topology: Updated Topology.tsx, componentUtils.ts, edgeActions.ts
  • knative-plugin: Updated knativeComponentUtils.ts, create-connector-utils.ts
  • shipwright-plugin: Updated logs-utils.ts, BuildRunDetailsPage.tsx
  • dev-console: Updated pipeline-template-utils.ts, ImportPage.tsx, DeployImagePage.tsx

Launcher Initialization

Added useSetupGlobalErrorModalLauncher() in root components:

  • packages/topology/src/components/graph-view/Topology.tsx - For topology drag/drop contexts
  • packages/shipwright-plugin/src/components/buildrun-details/BuildRunDetailsPage.tsx - For standalone log viewing
  • packages/dev-console/src/components/import/ImportPage.tsx - For Git import flow
  • packages/dev-console/src/components/import/DeployImagePage.tsx - For deploy image flow

Cleanup

  • Removed topology-specific errorModalHandler implementation
  • Removed deprecated errorModal function from public/components/modals

Benefits

  • ✅ Eliminates code duplication across packages
  • ✅ Ensures error modals work in all contexts (topology, standalone pages, import flows)
  • ✅ Single source of truth for error modal launching
  • ✅ Proper initialization and cleanup via React hooks

Test plan

  • Test topology drag/drop operations that trigger errors
  • Test BuildRun log viewing with error conditions
  • Test Git import flow with route exposure errors
  • Test deploy image flow with pipeline trigger errors
  • Verify no console errors when error modals are triggered

Related

Jira: CONSOLE-5012

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

openshift-ci bot commented Jan 22, 2026

Skipping CI for Draft Pull Request.
If you want CI signal for your change, please convert it to an actual PR.
You can still manually trigger a test run with /test all

@openshift-ci-robot
Copy link
Contributor

openshift-ci-robot commented Jan 22, 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

Creates a shared global error modal launcher utility in the console-shared package to eliminate code duplication and ensure error modals work correctly across all contexts (topology, standalone pages, import flows).

Changes

New Shared Utility

  • packages/console-shared/src/utils/error-modal-handler.ts
  • launchGlobalErrorModal() - Launch error modals from non-React contexts
  • useSetupGlobalErrorModalLauncher() - Hook to initialize the launcher
  • setGlobalErrorModalLauncher() - Manage global state

Migrated Packages

  • topology: Updated Topology.tsx, componentUtils.ts, edgeActions.ts
  • knative-plugin: Updated knativeComponentUtils.ts, create-connector-utils.ts
  • shipwright-plugin: Updated logs-utils.ts, BuildRunDetailsPage.tsx
  • dev-console: Updated pipeline-template-utils.ts, ImportPage.tsx, DeployImagePage.tsx

Launcher Initialization

Added useSetupGlobalErrorModalLauncher() in root components:

  • packages/topology/src/components/graph-view/Topology.tsx - For topology drag/drop contexts
  • packages/shipwright-plugin/src/components/buildrun-details/BuildRunDetailsPage.tsx - For standalone log viewing
  • packages/dev-console/src/components/import/ImportPage.tsx - For Git import flow
  • packages/dev-console/src/components/import/DeployImagePage.tsx - For deploy image flow

Cleanup

  • Removed topology-specific errorModalHandler implementation
  • Removed deprecated errorModal function from public/components/modals

Benefits

  • ✅ Eliminates code duplication across packages
  • ✅ Ensures error modals work in all contexts (topology, standalone pages, import flows)
  • ✅ Single source of truth for error modal launching
  • ✅ Proper initialization and cleanup via React hooks

Test plan

  • Test topology drag/drop operations that trigger errors
  • Test BuildRun log viewing with error conditions
  • Test Git import flow with route exposure errors
  • Test deploy image flow with pipeline trigger errors
  • Verify no console errors when error modals are triggered

Related

Jira: CONSOLE-5012

🤖 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 openshift-ci bot added the component/core Related to console core functionality label Jan 22, 2026
@openshift-ci
Copy link
Contributor

openshift-ci bot commented Jan 22, 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 openshift-ci bot added 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/sdk Related to console-plugin-sdk component/shared Related to console-shared component/topology Related to topology labels Jan 22, 2026
@rhamilto rhamilto marked this pull request as ready for review January 23, 2026 15:17
@rhamilto rhamilto changed the title WIP: CONSOLE-5012: Create shared global error modal launcher utility [WIP] CONSOLE-5012: Create shared global error modal launcher utility 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

Creates a shared global error modal launcher utility in the console-shared package to eliminate code duplication and ensure error modals work correctly across all contexts (topology, standalone pages, import flows).

Note: This PR is based on CONSOLE-5012 and includes changes from other PRs in that branch. The changes below are cumulative and may include work from multiple related PRs.

Changes

New Shared Utility

  • packages/console-shared/src/utils/error-modal-handler.ts
  • launchGlobalErrorModal() - Launch error modals from non-React contexts
  • useSetupGlobalErrorModalLauncher() - Hook to initialize the launcher
  • setGlobalErrorModalLauncher() - Manage global state

Migrated Packages

  • topology: Updated Topology.tsx, componentUtils.ts, edgeActions.ts
  • knative-plugin: Updated knativeComponentUtils.ts, create-connector-utils.ts
  • shipwright-plugin: Updated logs-utils.ts, BuildRunDetailsPage.tsx
  • dev-console: Updated pipeline-template-utils.ts, ImportPage.tsx, DeployImagePage.tsx

Launcher Initialization

Added useSetupGlobalErrorModalLauncher() in root components:

  • packages/topology/src/components/graph-view/Topology.tsx - For topology drag/drop contexts
  • packages/shipwright-plugin/src/components/buildrun-details/BuildRunDetailsPage.tsx - For standalone log viewing
  • packages/dev-console/src/components/import/ImportPage.tsx - For Git import flow
  • packages/dev-console/src/components/import/DeployImagePage.tsx - For deploy image flow

Cleanup

  • Removed topology-specific errorModalHandler implementation
  • Removed deprecated errorModal function from public/components/modals

Benefits

  • ✅ Eliminates code duplication across packages
  • ✅ Ensures error modals work in all contexts (topology, standalone pages, import flows)
  • ✅ Single source of truth for error modal launching
  • ✅ Proper initialization and cleanup via React hooks

Test plan

  • Test topology drag/drop operations that trigger errors
  • Test BuildRun log viewing with error conditions
  • Test Git import flow with route exposure errors
  • Test deploy image flow with pipeline trigger errors
  • Verify no console errors when error modals are triggered

Related

Jira: CONSOLE-5012

🤖 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.

1 similar comment
@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

Creates a shared global error modal launcher utility in the console-shared package to eliminate code duplication and ensure error modals work correctly across all contexts (topology, standalone pages, import flows).

Note: This PR is based on CONSOLE-5012 and includes changes from other PRs in that branch. The changes below are cumulative and may include work from multiple related PRs.

Changes

New Shared Utility

  • packages/console-shared/src/utils/error-modal-handler.ts
  • launchGlobalErrorModal() - Launch error modals from non-React contexts
  • useSetupGlobalErrorModalLauncher() - Hook to initialize the launcher
  • setGlobalErrorModalLauncher() - Manage global state

Migrated Packages

  • topology: Updated Topology.tsx, componentUtils.ts, edgeActions.ts
  • knative-plugin: Updated knativeComponentUtils.ts, create-connector-utils.ts
  • shipwright-plugin: Updated logs-utils.ts, BuildRunDetailsPage.tsx
  • dev-console: Updated pipeline-template-utils.ts, ImportPage.tsx, DeployImagePage.tsx

Launcher Initialization

Added useSetupGlobalErrorModalLauncher() in root components:

  • packages/topology/src/components/graph-view/Topology.tsx - For topology drag/drop contexts
  • packages/shipwright-plugin/src/components/buildrun-details/BuildRunDetailsPage.tsx - For standalone log viewing
  • packages/dev-console/src/components/import/ImportPage.tsx - For Git import flow
  • packages/dev-console/src/components/import/DeployImagePage.tsx - For deploy image flow

Cleanup

  • Removed topology-specific errorModalHandler implementation
  • Removed deprecated errorModal function from public/components/modals

Benefits

  • ✅ Eliminates code duplication across packages
  • ✅ Ensures error modals work in all contexts (topology, standalone pages, import flows)
  • ✅ Single source of truth for error modal launching
  • ✅ Proper initialization and cleanup via React hooks

Test plan

  • Test topology drag/drop operations that trigger errors
  • Test BuildRun log viewing with error conditions
  • Test Git import flow with route exposure errors
  • Test deploy image flow with pipeline trigger errors
  • Verify no console errors when error modals are triggered

Related

Jira: CONSOLE-5012

🤖 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 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

Creates a shared global error modal launcher utility in the console-shared package to eliminate code duplication and ensure error modals work correctly across all contexts (topology, standalone pages, import flows).

Note: This PR builds on:

Changes

New Shared Utility

  • packages/console-shared/src/utils/error-modal-handler.ts
  • launchGlobalErrorModal() - Launch error modals from non-React contexts
  • useSetupGlobalErrorModalLauncher() - Hook to initialize the launcher
  • setGlobalErrorModalLauncher() - Manage global state

Migrated Packages

  • topology: Updated Topology.tsx, componentUtils.ts, edgeActions.ts
  • knative-plugin: Updated knativeComponentUtils.ts, create-connector-utils.ts
  • shipwright-plugin: Updated logs-utils.ts, BuildRunDetailsPage.tsx
  • dev-console: Updated pipeline-template-utils.ts, ImportPage.tsx, DeployImagePage.tsx

Launcher Initialization

Added useSetupGlobalErrorModalLauncher() in root components:

  • packages/topology/src/components/graph-view/Topology.tsx - For topology drag/drop contexts
  • packages/shipwright-plugin/src/components/buildrun-details/BuildRunDetailsPage.tsx - For standalone log viewing
  • packages/dev-console/src/components/import/ImportPage.tsx - For Git import flow
  • packages/dev-console/src/components/import/DeployImagePage.tsx - For deploy image flow

Cleanup

  • Removed topology-specific errorModalHandler implementation
  • Removed deprecated errorModal function from public/components/modals

Benefits

  • ✅ Eliminates code duplication across packages
  • ✅ Ensures error modals work in all contexts (topology, standalone pages, import flows)
  • ✅ Single source of truth for error modal launching
  • ✅ Proper initialization and cleanup via React hooks

Test plan

  • Test topology drag/drop operations that trigger errors
  • Test BuildRun log viewing with error conditions
  • Test Git import flow with route exposure errors
  • Test deploy image flow with pipeline trigger errors
  • Verify no console errors when error modals are triggered

Related

Jira: CONSOLE-5012

🤖 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 openshift-ci bot added the kind/i18n Indicates issue or PR relates to internationalization or has content that needs to be translated label Jan 23, 2026
rhamilto added a commit to rhamilto/console that referenced this pull request Jan 23, 2026
This commit migrates all instances of confirmModal to use the modern
overlay pattern with useWarningModal, completing the modal migration
effort started in previous PRs.

Changes:
- Removed deprecated confirmModal launcher and confirm-modal.tsx file
- Migrated topology moveNodeToGroup to use useWarningModal with proper
  cancel handling via global handler pattern
- Updated StopNodeMaintenanceModal to remove deprecated imperative API
  and keep only the useStopNodeMaintenanceModal hook
- Fixed useWarningModal to properly call closeOverlay() and filter it
  from props spread to prevent React DOM warnings
- Added try-catch in topology drag-drop to prevent optimistic update
  when user cancels the move operation
- Updated all metal3-plugin maintenance components to use the hook-based
  approach

This PR builds upon and depends on:
- openshift#15932 (ResourceLimitsModal migration)
- openshift#15939 (DeletePDBModal migration)
- openshift#15940 (ConfigureUnschedulableModal migration)
- openshift#15946 (Global error modal utility)

Co-Authored-By: Claude Sonnet 4.5 <[email protected]>
@rhamilto
Copy link
Member Author

/retest

2 similar comments
@rhamilto
Copy link
Member Author

/retest

@rhamilto
Copy link
Member Author

/retest

rhamilto added a commit to rhamilto/console that referenced this pull request Jan 26, 2026
This commit migrates all instances of confirmModal to use the modern
overlay pattern with useWarningModal, completing the modal migration
effort started in previous PRs.

Changes:
- Removed deprecated confirmModal launcher and confirm-modal.tsx file
- Migrated topology moveNodeToGroup to use useWarningModal with proper
  cancel handling via global handler pattern
- Updated StopNodeMaintenanceModal to remove deprecated imperative API
  and keep only the useStopNodeMaintenanceModal hook
- Fixed useWarningModal to properly call closeOverlay() and filter it
  from props spread to prevent React DOM warnings
- Added try-catch in topology drag-drop to prevent optimistic update
  when user cancels the move operation
- Updated all metal3-plugin maintenance components to use the hook-based
  approach

This PR builds upon and depends on:
- openshift#15932 (ResourceLimitsModal migration)
- openshift#15939 (DeletePDBModal migration)
- openshift#15940 (ConfigureUnschedulableModal migration)
- openshift#15946 (Global error modal utility)

Co-Authored-By: Claude Sonnet 4.5 <[email protected]>
@rhamilto
Copy link
Member Author

/retest

rhamilto added a commit to rhamilto/console that referenced this pull request Jan 27, 2026
This commit migrates all instances of confirmModal to use the modern
overlay pattern with useWarningModal, completing the modal migration
effort started in previous PRs.

Changes:
- Removed deprecated confirmModal launcher and confirm-modal.tsx file
- Migrated topology moveNodeToGroup to use useWarningModal with proper
  cancel handling via global handler pattern
- Updated StopNodeMaintenanceModal to remove deprecated imperative API
  and keep only the useStopNodeMaintenanceModal hook
- Fixed useWarningModal to properly call closeOverlay() and filter it
  from props spread to prevent React DOM warnings
- Added try-catch in topology drag-drop to prevent optimistic update
  when user cancels the move operation
- Updated all metal3-plugin maintenance components to use the hook-based
  approach

This PR builds upon and depends on:
- openshift#15932 (ResourceLimitsModal migration)
- openshift#15939 (DeletePDBModal migration)
- openshift#15940 (ConfigureUnschedulableModal migration)
- openshift#15946 (Global error modal utility)

Co-Authored-By: Claude Sonnet 4.5 <[email protected]>
rhamilto added a commit to rhamilto/console that referenced this pull request Jan 28, 2026
This commit migrates all instances of confirmModal to use the modern
overlay pattern with useWarningModal, completing the modal migration
effort started in previous PRs.

Changes:
- Removed deprecated confirmModal launcher and confirm-modal.tsx file
- Migrated topology moveNodeToGroup to use useWarningModal with proper
  cancel handling via global handler pattern
- Updated StopNodeMaintenanceModal to remove deprecated imperative API
  and keep only the useStopNodeMaintenanceModal hook
- Fixed useWarningModal to properly call closeOverlay() and filter it
  from props spread to prevent React DOM warnings
- Added try-catch in topology drag-drop to prevent optimistic update
  when user cancels the move operation
- Updated all metal3-plugin maintenance components to use the hook-based
  approach

This PR builds upon and depends on:
- openshift#15932 (ResourceLimitsModal migration)
- openshift#15939 (DeletePDBModal migration)
- openshift#15940 (ConfigureUnschedulableModal migration)
- openshift#15946 (Global error modal utility)

Co-Authored-By: Claude Sonnet 4.5 <[email protected]>
@rhamilto
Copy link
Member Author

/retest

2 similar comments
@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 px-approved Signifies that Product Support has signed off on this PR docs-approved Signifies that Docs has signed off on this PR labels Feb 2, 2026
@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

Creates a shared error modal launcher utility in the console-shared package using React Context to eliminate code duplication and ensure error modals work correctly across all contexts (topology, standalone pages, import flows).

Note: This PR builds on:

Architecture

React Context Pattern

This implementation reuses the existing OverlayProvider instead of creating a new context provider:

<OverlayProvider>
 <SyncErrorModalLauncher />  {/* Zero-render sync component */}
 <App />
</OverlayProvider>

Dual API for Different Contexts

React Components - Use the hook:

const launchErrorModal = useErrorModalLauncher();
launchErrorModal({ title: 'Error', error: err.message });

Non-React Code (callbacks, promises, utilities) - Use the function:

createConnection(source, target).catch(err => {
 launchErrorModal({ title: 'Failed', error: err.message });
});

Changes

New Shared Utility

packages/console-shared/src/utils/error-modal-handler.tsx

  • SyncErrorModalLauncher - Component that syncs the launcher for non-React contexts
  • useErrorModalLauncher() - Hook for launching error modals from React components
  • launchErrorModal() - Function for launching from non-React contexts (callbacks, promises)

Test Coverage

packages/console-shared/src/utils/__tests__/error-modal-handler.spec.tsx

  • Unit tests covering all scenarios (5 tests, all passing)
  • Tests lifecycle (mount/unmount)
  • Tests error handling (uninitialized launcher)

packages/console-shared/src/utils/__mocks__/error-modal-handler.tsx

  • Mock utilities for testing components that use the error modal launcher

Single Initialization Point

public/components/app.tsx

  • Added <SyncErrorModalLauncher /> inside OverlayProvider
  • Single initialization point for the entire application

Removed Multiple Initialization Points

Removed useSetupGlobalErrorModalLauncher() calls from:

  • packages/topology/src/components/graph-view/Topology.tsx
  • packages/shipwright-plugin/src/components/buildrun-details/BuildRunDetailsPage.tsx
  • packages/dev-console/src/components/import/ImportPage.tsx
  • packages/dev-console/src/components/import/DeployImagePage.tsx

Migrated to New API

Updated launchGlobalErrorModallaunchErrorModal in:

  • topology: componentUtils.ts, edgeActions.ts
  • knative-plugin: knativeComponentUtils.ts, create-connector-utils.ts
  • shipwright-plugin: logs-utils.ts
  • dev-console: pipeline-template-utils.ts

Cleanup

  • Removed topology-specific errorModalHandler implementation
  • Removed deprecated errorModal function from public/components/modals

Benefits

  • Eliminates global state race conditions - Single initialization point in app root
  • Improves testability - OverlayProvider context can be mocked in tests
  • No code duplication - Shared utility used across all packages
  • Reuses existing infrastructure - No new providers, uses existing OverlayProvider
  • Simpler architecture - No unnecessary provider nesting
  • Type-safe - Full TypeScript support with proper generics
  • Proper lifecycle - Cleanup on unmount via useEffect
  • Backward compatible - Non-React code continues to work via module reference
  • Comprehensive test coverage - 5 unit tests covering all scenarios

Test Plan

Automated Tests

  • ✅ Unit tests pass (5/5 tests)
  • ✅ TypeScript compilation succeeds
  • ✅ ESLint passes
  • ✅ Pre-commit hooks pass

Manual Testing

  • Test topology drag/drop operations that trigger errors
  • Test BuildRun log viewing with error conditions
  • Test Git import flow with route exposure errors
  • Test deploy image flow with pipeline trigger errors
  • Verify no console errors when error modals are triggered
  • Test error modal from React component using useErrorModalLauncher() hook
  • Test error modal from promise chain using launchErrorModal() function

Technical Details

Hybrid Approach

The implementation uses a hybrid pattern to support both React and non-React code:

  1. React Components: Call useErrorModalLauncher() hook which directly uses useOverlay()
  2. Non-React Code: Call launchErrorModal() function which accesses a module-level reference
  3. Sync Component: SyncErrorModalLauncher syncs the launcher to the module-level variable

This approach:

  • Eliminates the need for a custom Context provider
  • Reuses the existing OverlayProvider infrastructure
  • Supports both React hooks and imperative API calls
  • Has proper cleanup via React lifecycle

Migration from Global State

Before:

  • Multiple initialization points (4 different files)
  • Global state directly managed outside React
  • No cleanup mechanism
  • Difficult to test

After:

  • Single initialization point (app.tsx)
  • React Context-based (via OverlayProvider)
  • Proper cleanup on unmount
  • Easy to test with mocks

Related

Jira: CONSOLE-5012

🤖 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 [WIP] CONSOLE-5012: Create shared global error modal launcher utility CONSOLE-5012: Create shared error modal launcher using React Context 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: Create shared error modal launcher using React Context [WIP] CONSOLE-5012: Create shared error modal launcher using React Context 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
rhamilto added a commit to rhamilto/console that referenced this pull request Feb 2, 2026
This commit migrates all instances of confirmModal to use the modern
overlay pattern with useWarningModal, completing the modal migration
effort started in previous PRs.

Changes:
- Removed deprecated confirmModal launcher and confirm-modal.tsx file
- Migrated topology moveNodeToGroup to use useWarningModal with proper
  cancel handling via global handler pattern
- Updated StopNodeMaintenanceModal to remove deprecated imperative API
  and keep only the useStopNodeMaintenanceModal hook
- Fixed useWarningModal to properly call closeOverlay() and filter it
  from props spread to prevent React DOM warnings
- Added try-catch in topology drag-drop to prevent optimistic update
  when user cancels the move operation
- Updated all metal3-plugin maintenance components to use the hook-based
  approach

This PR builds upon and depends on:
- openshift#15932 (ResourceLimitsModal migration)
- openshift#15939 (DeletePDBModal migration)
- openshift#15940 (ConfigureUnschedulableModal migration)
- openshift#15946 (Global error modal utility)

Co-Authored-By: Claude Sonnet 4.5 <[email protected]>
rhamilto added a commit to rhamilto/console that referenced this pull request Feb 2, 2026
This commit refactors the moveNodeToGroup global handler pattern to use
React Context instead of module-level variables, addressing architectural
concerns and following the same pattern established in openshift#15946.

Changes:
- Created MoveNodeHandlersProvider using React Context
- Created SyncMoveNodeHandlers component to sync handlers for non-React contexts
- Added useMoveNodeHandlers() hook for accessing handlers
- Refactored moveNodeToGroup to use context-based handlers
- Wrapped Topology component with MoveNodeHandlersProvider
- Deprecated old useSetupMoveNodeToGroupHandlers hooks with warnings
- Added comprehensive unit tests (8 tests, all passing)

Benefits:
- Eliminates global state race conditions
- Follows React Context pattern from error modal handler (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

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

Co-Authored-By: Claude Sonnet 4.5 <[email protected]>
rhamilto added a commit to rhamilto/console that referenced this pull request Feb 2, 2026
This commit refactors the moveNodeToGroup global handler pattern to use
React Context instead of module-level variables, addressing architectural
concerns and following the same pattern established in openshift#15946.

Changes:
- Created MoveNodeHandlersProvider using React Context
- Created SyncMoveNodeHandlers component to sync handlers for non-React contexts
- Added useMoveNodeHandlers() hook for accessing handlers
- Refactored moveNodeToGroup to use context-based handlers
- Wrapped Topology component with MoveNodeHandlersProvider
- Deprecated old useSetupMoveNodeToGroupHandlers hooks with warnings
- Added comprehensive unit tests (8 tests, all passing)

Benefits:
- Eliminates global state race conditions
- Follows React Context pattern from error modal handler (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

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

Co-Authored-By: Claude Sonnet 4.5 <[email protected]>
@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-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

Creates a shared error modal launcher utility in the console-shared package using React Context to eliminate code duplication and ensure error modals work correctly across all contexts (topology, standalone pages, import flows).

Note: This PR builds on:

Architecture

React Context Pattern

This implementation reuses the existing OverlayProvider instead of creating a new context provider:

<OverlayProvider>
 <SyncErrorModalLauncher />  {/* Zero-render sync component */}
 <App />
</OverlayProvider>

Dual API for Different Contexts

React Components - Use the hook:

const launchErrorModal = useErrorModalLauncher();
launchErrorModal({ title: 'Error', error: err.message });

Non-React Code (callbacks, promises, utilities) - Use the function:

createConnection(source, target).catch(err => {
 launchErrorModal({ title: 'Failed', error: err.message });
});

Changes

New Shared Utility

packages/console-shared/src/utils/error-modal-handler.tsx

  • SyncErrorModalLauncher - Component that syncs the launcher for non-React contexts
  • useErrorModalLauncher() - Hook for launching error modals from React components
  • launchErrorModal() - Function for launching from non-React contexts (callbacks, promises)

Test Coverage

packages/console-shared/src/utils/__tests__/error-modal-handler.spec.tsx

  • Unit tests covering all scenarios (5 tests, all passing)
  • Tests lifecycle (mount/unmount)
  • Tests error handling (uninitialized launcher)

packages/console-shared/src/utils/__mocks__/error-modal-handler.tsx

  • Mock utilities for testing components that use the error modal launcher

Single Initialization Point

public/components/app.tsx

  • Added <SyncErrorModalLauncher /> inside OverlayProvider
  • Single initialization point for the entire application

Migrated to New API

Updated to use launchErrorModal in:

  • topology: componentUtils.ts, edgeActions.ts, moveNodeToGroup.tsx
  • knative-plugin: knativeComponentUtils.ts, create-connector-utils.ts
  • shipwright-plugin: logs-utils.ts
  • dev-console: pipeline-template-utils.ts

Cleanup

  • Removed deprecated errorModal function from public/components/modals
  • Updated exports in console-shared package

Benefits

  • Eliminates global state race conditions - Single initialization point in app root
  • Improves testability - OverlayProvider context can be mocked in tests
  • No code duplication - Shared utility used across all packages
  • Reuses existing infrastructure - No new providers, uses existing OverlayProvider
  • Simpler architecture - No unnecessary provider nesting
  • Type-safe - Full TypeScript support with proper generics
  • Proper lifecycle - Cleanup on unmount via useEffect
  • Backward compatible - Non-React code continues to work via module reference
  • Comprehensive test coverage - 5 unit tests covering all scenarios

Test Plan

Automated Tests

  • ✅ Unit tests pass (5/5 tests)
  • ✅ TypeScript compilation succeeds
  • ✅ ESLint passes
  • ✅ Pre-commit hooks pass

Manual Testing

  • Test topology drag/drop operations that trigger errors
  • Test BuildRun log viewing with error conditions
  • Test Git import flow with route exposure errors
  • Test deploy image flow with pipeline trigger errors
  • Verify no console errors when error modals are triggered
  • Test error modal from React component using useErrorModalLauncher() hook
  • Test error modal from promise chain using launchErrorModal() function

Technical Details

Hybrid Approach

The implementation uses a hybrid pattern to support both React and non-React code:

  1. React Components: Call useErrorModalLauncher() hook which directly uses useOverlay()
  2. Non-React Code: Call launchErrorModal() function which accesses a module-level reference
  3. Sync Component: SyncErrorModalLauncher syncs the launcher to the module-level variable

This approach:

  • Eliminates the need for a custom Context provider
  • Reuses the existing OverlayProvider infrastructure
  • Supports both React hooks and imperative API calls
  • Has proper cleanup via React lifecycle

Migration from Global State

Before:

  • No shared utility
  • Each package implemented its own error modal handling
  • Inconsistent patterns across codebase

After:

  • Single initialization point (app.tsx)
  • React Context-based (via OverlayProvider)
  • Proper cleanup on unmount
  • Easy to test with mocks
  • Consistent API across all packages

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.

- 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 <[email protected]>
@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

Creates a shared error modal launcher utility in the console-shared package using React Context to eliminate code duplication and ensure error modals work correctly across all contexts (topology, standalone pages, import flows).

Note: This PR builds on:

Architecture

React Context Pattern

This implementation reuses the existing OverlayProvider instead of creating a new context provider:

<OverlayProvider>
 <SyncErrorModalLauncher />  {/* Zero-render sync component */}
 <App />
</OverlayProvider>

Dual API for Different Contexts

React Components - Use the hook:

const launchErrorModal = useErrorModalLauncher();
launchErrorModal({ title: 'Error', error: err.message });

Non-React Code (callbacks, promises, utilities) - Use the function:

createConnection(source, target).catch(err => {
 launchErrorModal({ title: 'Failed', error: err.message });
});

Changes

New Shared Utility

packages/console-shared/src/utils/error-modal-handler.tsx

  • SyncErrorModalLauncher - Component that syncs the launcher for non-React contexts
  • useErrorModalLauncher() - Hook for launching error modals from React components
  • launchErrorModal() - Function for launching from non-React contexts (callbacks, promises)

Test Coverage

packages/console-shared/src/utils/__tests__/error-modal-handler.spec.tsx

  • Unit tests covering all scenarios (5 tests, all passing)
  • Tests lifecycle (mount/unmount)
  • Tests error handling (uninitialized launcher)

packages/console-shared/src/utils/__mocks__/error-modal-handler.tsx

  • Mock utilities for testing components that use the error modal launcher

Single Initialization Point

public/components/app.tsx

  • Added <SyncErrorModalLauncher /> inside OverlayProvider
  • Single initialization point for the entire application

Topology Move Node Error Handling

packages/topology/src/utils/moveNodeToGroup.tsx

  • Added setMoveNodeToGroupErrorHandler() for managing error handler
  • Added useSetupMoveNodeToGroupErrorHandler() hook called in Topology component
  • Updated moveNodeToGroup() to accept optional onError callback
  • Deprecated useMoveNodeToGroup() hook

packages/topology/src/components/graph-view/Topology.tsx

  • Added useSetupMoveNodeToGroupErrorHandler() call to initialize error handling

Note: This uses a global handler pattern instead of React Context. A follow-up PR (#15948) will refactor this to use the same React Context pattern as the error modal handler.

Migrated to New API

Updated to use launchErrorModal in:

  • topology: componentUtils.ts, edgeActions.ts
  • knative-plugin: knativeComponentUtils.ts, create-connector-utils.ts
  • shipwright-plugin: logs-utils.ts
  • dev-console: pipeline-template-utils.ts

Cleanup

  • Removed deprecated errorModal function from public/components/modals
  • Updated exports in console-shared package

Benefits

  • Eliminates global state race conditions - Single initialization point in app root
  • Improves testability - OverlayProvider context can be mocked in tests
  • No code duplication - Shared utility used across all packages
  • Reuses existing infrastructure - No new providers, uses existing OverlayProvider
  • Simpler architecture - No unnecessary provider nesting
  • Type-safe - Full TypeScript support with proper generics
  • Proper lifecycle - Cleanup on unmount via useEffect
  • Backward compatible - Non-React code continues to work via module reference
  • Comprehensive test coverage - 5 unit tests covering all scenarios

Test Plan

Automated Tests

  • ✅ Unit tests pass (5/5 tests)
  • ✅ TypeScript compilation succeeds
  • ✅ ESLint passes
  • ✅ Pre-commit hooks pass

Manual Testing

  • Test topology drag/drop operations that trigger errors
  • Test BuildRun log viewing with error conditions
  • Test Git import flow with route exposure errors
  • Test deploy image flow with pipeline trigger errors
  • Verify no console errors when error modals are triggered
  • Test error modal from React component using useErrorModalLauncher() hook
  • Test error modal from promise chain using launchErrorModal() function
  • Test topology node move operations with error handling

Technical Details

Hybrid Approach

The implementation uses a hybrid pattern to support both React and non-React code:

  1. React Components: Call useErrorModalLauncher() hook which directly uses useOverlay()
  2. Non-React Code: Call launchErrorModal() function which accesses a module-level reference
  3. Sync Component: SyncErrorModalLauncher syncs the launcher to the module-level variable

This approach:

  • Eliminates the need for a custom Context provider
  • Reuses the existing OverlayProvider infrastructure
  • Supports both React hooks and imperative API calls
  • Has proper cleanup via React lifecycle

Migration Path

Before:

  • No shared utility
  • Each package implemented its own error modal handling
  • Inconsistent patterns across codebase
  • Direct imports of deprecated errorModal function

After:

  • Single initialization point (app.tsx)
  • React Context-based (via OverlayProvider)
  • Proper cleanup on unmount
  • Easy to test with mocks
  • Consistent API across all packages

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 added a commit to rhamilto/console that referenced this pull request Feb 3, 2026
…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.

## 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"

## Benefits
- 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 <[email protected]>
@openshift-ci
Copy link
Contributor

openshift-ci bot commented Feb 3, 2026

@rhamilto: The following tests failed, say /retest to rerun all failed tests or /retest-required to rerun all mandatory failed tests:

Test name Commit Details Required Rerun command
ci/prow/images ed87acf link true /test images
ci/prow/e2e-gcp-console ed87acf link true /test e2e-gcp-console

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/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