OCPBUGS-60969: Console headers are empty when used from a dynamic plugin #15439

Leo6Leo · 2025-08-27T20:59:28Z

Description

The function getConsoleRequestHeaders provided by the dynamic plugin SDK returns empty headers

Step to reproduce

Start the dynamic demo plugin and the console from this PR: https://github.com/jgbernalp/console/tree/console-headers-test
Navigate to http://localhost:9000/test-utility-consumer

Root cause

   // This fails in dynamic plugin context
   const store = storeHandler.getStore(); // undefined
   if (!store) return undefined; // ❌ here it returns undefined instead of headers

Fix

By adding the condition check, if store DNE, we will still return the header, instead of undefined.

Note

This bug is reproduced on 4.20, 4.19. The rest of the release versions haven't been tested yet, as there are some issues with the dynamic-plugin build process that I am trying to figure out.

/cc @TheRealJon @logonoff @krishagarwal278

…fore accessing state

openshift-ci-robot · 2025-08-27T20:59:31Z

@Leo6Leo: No Jira issue with key CONSOLE-60779 exists in the tracker at https://issues.redhat.com/.
Once a valid jira issue is referenced in the title of this pull request, request a refresh with /jira refresh.

In response to this:

Description

The function getConsoleRequestHeaders provided by the dynamic plugin SDK returns empty headers

Step to reproduce

Start the dynamic demo plugin and the console from this PR: https://github.com/jgbernalp/console/tree/console-headers-test

Navigate to http://localhost:9000/test-utility-consumer

Root cause
  // This fails in dynamic plugin context
  const store = storeHandler.getStore(); // undefined
  if (!store) return undefined; // ❌ here it returns undefined instead of headers
Fix

By adding the condition check, if store DNE, we will still return the header, instead of undefined.

Note

This bug is reproduced on 4.20, 4.19. The rest of the release versions haven't been tested yet, as there are some issues with the dynamic-plugin build process that I am trying to figure out.

/cc @TheRealJon @logonoff @krishagarwal278

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 · 2025-08-27T21:01:05Z

@Leo6Leo: This pull request references Jira Issue OCPBUGS-60779, which is invalid:

expected the bug to target the "4.20.0" version, but no target version was set

Comment /jira refresh to re-evaluate validity if changes to the Jira bug are made, or edit the title of this pull request to link to a different bug.

The bug has been updated to refer to the pull request using the external bug tracker.

In response to this:

Description

The function getConsoleRequestHeaders provided by the dynamic plugin SDK returns empty headers

Step to reproduce

Start the dynamic demo plugin and the console from this PR: https://github.com/jgbernalp/console/tree/console-headers-test

Navigate to http://localhost:9000/test-utility-consumer

Root cause
  // This fails in dynamic plugin context
  const store = storeHandler.getStore(); // undefined
  if (!store) return undefined; // ❌ here it returns undefined instead of headers
Fix

By adding the condition check, if store DNE, we will still return the header, instead of undefined.

Note

This bug is reproduced on 4.20, 4.19. The rest of the release versions haven't been tested yet, as there are some issues with the dynamic-plugin build process that I am trying to figure out.

/cc @TheRealJon @logonoff @krishagarwal278

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 · 2025-08-27T21:03:06Z

@Leo6Leo: This pull request references Jira Issue OCPBUGS-60969, which is valid. The bug has been moved to the POST state.

3 validation(s) were run on this bug

bug is open, matching expected state (open)
bug target version (4.20.0) matches configured target version for branch (4.20.0)
bug is in the state ASSIGNED, which is one of the valid states (NEW, ASSIGNED, POST)

Requesting review from QA contact:
/cc @yapei

The bug has been updated to refer to the pull request using the external bug tracker.

In response to this:

Description

The function getConsoleRequestHeaders provided by the dynamic plugin SDK returns empty headers

Step to reproduce

Start the dynamic demo plugin and the console from this PR: https://github.com/jgbernalp/console/tree/console-headers-test

Navigate to http://localhost:9000/test-utility-consumer

Root cause
  // This fails in dynamic plugin context
  const store = storeHandler.getStore(); // undefined
  if (!store) return undefined; // ❌ here it returns undefined instead of headers
Fix

By adding the condition check, if store DNE, we will still return the header, instead of undefined.

Note

This bug is reproduced on 4.20, 4.19. The rest of the release versions haven't been tested yet, as there are some issues with the dynamic-plugin build process that I am trying to figure out.

/cc @TheRealJon @logonoff @krishagarwal278

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.

Leo6Leo · 2025-08-27T21:04:07Z

/cherry-pick release-4.19

openshift-cherrypick-robot · 2025-08-27T21:04:10Z

@Leo6Leo: once the present PR merges, I will cherry-pick it on top of release-4.19 in a new PR and assign it to you.

In response to this:

/cherry-pick release-4.19

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.

frontend/packages/console-dynamic-plugin-sdk/src/utils/fetch/console-fetch-utils.ts

…-header/main

Leo6Leo · 2025-09-05T14:07:07Z

/retest-required

Leo6Leo · 2025-09-06T21:11:32Z

/retest-required

jgbernalp · 2025-09-15T11:15:20Z

@Leo6Leo I think this PR is ready, right?

jgbernalp · 2025-09-15T11:15:25Z

/lgtm

Leo6Leo · 2025-09-15T13:49:17Z

/cc @jhadvig @TheRealJon @spadgett

Leo6Leo · 2025-09-15T13:53:50Z

/jira refresh

openshift-ci-robot · 2025-09-15T13:53:57Z

@Leo6Leo: This pull request references Jira Issue OCPBUGS-60969, which is invalid:

expected the bug to target either version "4.21." or "openshift-4.21.", but it targets "4.20.0" instead

Comment /jira refresh to re-evaluate validity if changes to the Jira bug are made, or edit the title of this pull request to link to a different bug.

In response to this:

/jira refresh

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.

Leo6Leo · 2025-09-15T13:54:30Z

/jira refresh

openshift-ci-robot · 2025-09-15T13:54:37Z

@Leo6Leo: This pull request references Jira Issue OCPBUGS-60969, which is valid.

3 validation(s) were run on this bug

bug is open, matching expected state (open)
bug target version (4.21.0) matches configured target version for branch (4.21.0)
bug is in the state POST, which is one of the valid states (NEW, ASSIGNED, POST)

Requesting review from QA contact:
/cc @yapei

In response to this:

/jira refresh

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.

Leo6Leo · 2025-09-15T13:54:53Z

/retest-required

TheRealJon · 2025-09-15T15:53:29Z

frontend/public/redux.ts

  composeEnhancers(applyMiddleware(thunk)),
 );

+// Make store globally available for dynamic plugins


Isn't this what storeHandler.getStore() is for?

Based on my research and learning, I found the different storeHandler is used:
Main console: console/dynamic-plugin-sdk/src/app/storeHandler (source)
Plugin: @openshift-console/dynamic-plugin-sdk/lib/app/storeHandler (compiled)

And this leads to the different store to be used. By setting the store to the shared global space, we can make sure that same store get used. This is my understanding, what do you think? @TheRealJon

@Leo6Leo, we've always had a singleton Redux store instance. It's already declared globally in the storeHandler you referenced. @vojtechszocs could you clarify how this should work?

@Leo6Leo @TheRealJon

The root cause of the problem seems to be that storeHandler.setStore function is not called right after the Redux store instance is created and initialized in public/redux.ts module.

So I think the only change we need for this bugfix is to modify public/redux.ts like so:

// ... import storeHandler from '@console/dynamic-plugin-sdk/src/app/storeHandler'; // ... storeHandler.setStore(store); export default store;

Bugfix PRs should contain minimal changes to address the immediate issue. We can further improve the Redux handling code in follow-up non-bugfix PRs.

After applying @vojtechszocs 's fix

I have performed the fix @vojtechszocs suggested locally, I can see that the store is successfully initialized, but that doesn't solve the problem with the storeHandler.getStore() returning undefined in the getConsoleRequestHeaders() function, calling it from the file dynamic-demo-plugin/src/components/UtilityConsumer.tsx. But I think this change makes sense to me and it is necessary, since the store should be set when the store is being created.

Further investigation

One key observation I found is that: whether storeHandler.getStore() returning undefined or the real store value in the getConsoleRequestHeaders() function, it depends on where it get called.

When getConsoleRequestHeaders() is called from the file dynamic-demo-plugin/src/components/UtilityConsumer.tsx, we can see that it shows the store is undefined.

When getConsoleRequestHeaders() is called from somewhere else, the function proceed as expected:

Therefore, I think the root cause I found here is still valid.

different storeHandler is used:
Main console: console/dynamic-plugin-sdk/src/app/storeHandler (source)
Plugin: @openshift-console/dynamic-plugin-sdk/lib/app/storeHandler (compiled)

And here is a quote from the LLM that I think is a reasonable explanation to me:

The console uses Webpack Module Federation to load dynamic plugins. Which means:
Main Application Context: our main app (console/frontend) has its own module context with its own instance of storeHandler.
Plugin Context: the dynamic plugin (console/dynamic-demo-plugin) runs in a separate webpack container/module context and gets its own separate instance of storeHandler

So I think the approach of making the store become global makes sense. As suggested, we should only have 1 redux store, should we consider making that store become global?

I think if we do fix it this way, it should be commented with a FIXME and a CONSOLE project issue to look further into this. We probably shouldn't leak the internal application state into the window scope as a long-term solution.

openshift-ci · 2025-10-01T14:23:40Z

New changes are detected. LGTM label has been removed.

openshift-ci · 2025-10-01T14:24:09Z

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by: jgbernalp, Leo6Leo
Once this PR has been reviewed and has the lgtm label, please assign spadgett for approval. For more information see the Code Review Process.

The full list of commands accepted by this bot can be found here.

Needs approval from an approver in each of these files:

OWNERS

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

openshift-ci · 2025-10-01T20:19:48Z

@Leo6Leo: 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/frontend	`04696de`	link	true	`/test frontend`
ci/prow/okd-scos-e2e-aws-ovn	`04696de`	link	false	`/test okd-scos-e2e-aws-ovn`

Full PR test history. Your PR dashboard.

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.

Leo6Leo · 2025-10-01T20:48:07Z

This PR will be closed soon as another better approach is found here: #15556.

Leo6Leo · 2025-10-03T14:56:53Z

The issue has been resolved in #15556, now closing this PR.

openshift-ci-robot · 2025-10-03T14:56:56Z

@Leo6Leo: This pull request references Jira Issue OCPBUGS-60969. The bug has been updated to no longer refer to the pull request using the external bug tracker.

In response to this:

Description

The function getConsoleRequestHeaders provided by the dynamic plugin SDK returns empty headers

Step to reproduce

Start the dynamic demo plugin and the console from this PR: https://github.com/jgbernalp/console/tree/console-headers-test

Navigate to http://localhost:9000/test-utility-consumer

Root cause
  // This fails in dynamic plugin context
  const store = storeHandler.getStore(); // undefined
  if (!store) return undefined; // ❌ here it returns undefined instead of headers
Fix

By adding the condition check, if store DNE, we will still return the header, instead of undefined.

Note

This bug is reproduced on 4.20, 4.19. The rest of the release versions haven't been tested yet, as there are some issues with the dynamic-plugin build process that I am trying to figure out.

/cc @TheRealJon @logonoff @krishagarwal278

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.

fix: Refactor getConsoleRequestHeaders to check store availability be…

1e9aced

…fore accessing state

openshift-ci bot requested review from krishagarwal278, logonoff and TheRealJon August 27, 2025 20:59

openshift-ci bot added the component/sdk Related to console-plugin-sdk label Aug 27, 2025

Leo6Leo changed the title ~~CONSOLE-60779: Console headers are empty when used from a dynamic plugin~~ OCPBUGS-60779: Console headers are empty when used from a dynamic plugin Aug 27, 2025

openshift-ci-robot added jira/valid-reference Indicates that this PR references a valid Jira ticket of any type. jira/invalid-bug Indicates that a referenced Jira bug is invalid for the branch this PR is targeting. labels Aug 27, 2025

Leo6Leo changed the title ~~OCPBUGS-60779: Console headers are empty when used from a dynamic plugin~~ OCPBUGS-60969: Console headers are empty when used from a dynamic plugin Aug 27, 2025

openshift-ci-robot added jira/valid-bug Indicates that a referenced Jira bug is valid for the branch this PR is targeting. and removed jira/invalid-bug Indicates that a referenced Jira bug is invalid for the branch this PR is targeting. labels Aug 27, 2025

openshift-ci bot requested a review from yapei August 27, 2025 21:03

jgbernalp reviewed Aug 28, 2025

View reviewed changes

frontend/packages/console-dynamic-plugin-sdk/src/utils/fetch/console-fetch-utils.ts Show resolved Hide resolved

Leo6Leo added 2 commits September 3, 2025 23:23

Merge remote-tracking branch 'upstream' into lepo/ocpbugs/60779/empty…

cc32506

…-header/main

fix: use the global store to avoid the race condition

9a32ca7

openshift-ci bot added the component/core Related to console core functionality label Sep 4, 2025

openshift-ci bot assigned jgbernalp Sep 15, 2025

openshift-ci bot added the lgtm Indicates that a PR is ready to be merged. label Sep 15, 2025

openshift-ci bot requested review from jhadvig and spadgett September 15, 2025 13:49

openshift-ci-robot added jira/invalid-bug Indicates that a referenced Jira bug is invalid for the branch this PR is targeting. and removed jira/valid-bug Indicates that a referenced Jira bug is valid for the branch this PR is targeting. labels Sep 15, 2025

openshift-ci-robot added jira/valid-bug Indicates that a referenced Jira bug is valid for the branch this PR is targeting. and removed jira/invalid-bug Indicates that a referenced Jira bug is invalid for the branch this PR is targeting. labels Sep 15, 2025

TheRealJon reviewed Sep 15, 2025

View reviewed changes

cherry-pick: apply gabriel's commit

04696de

openshift-ci bot removed the lgtm Indicates that a PR is ready to be merged. label Oct 1, 2025

Leo6Leo closed this Oct 3, 2025

OCPBUGS-60969: Console headers are empty when used from a dynamic plugin #15439

OCPBUGS-60969: Console headers are empty when used from a dynamic plugin #15439

Uh oh!

Conversation

Leo6Leo commented Aug 27, 2025

Description

Step to reproduce

Root cause

Fix

Note

Uh oh!

openshift-ci-robot commented Aug 27, 2025

Description

Step to reproduce

Root cause

Fix

Note

Uh oh!

openshift-ci-robot commented Aug 27, 2025

Description

Step to reproduce

Root cause

Fix

Note

Uh oh!

openshift-ci-robot commented Aug 27, 2025

Description

Step to reproduce

Root cause

Fix

Note

Uh oh!

Leo6Leo commented Aug 27, 2025

Uh oh!

openshift-cherrypick-robot commented Aug 27, 2025

Uh oh!

Uh oh!

Leo6Leo commented Sep 5, 2025

Uh oh!

Leo6Leo commented Sep 6, 2025

Uh oh!

jgbernalp commented Sep 15, 2025

Uh oh!

jgbernalp commented Sep 15, 2025

Uh oh!

Leo6Leo commented Sep 15, 2025

Uh oh!

Leo6Leo commented Sep 15, 2025

Uh oh!

openshift-ci-robot commented Sep 15, 2025

Uh oh!

Leo6Leo commented Sep 15, 2025

Uh oh!

openshift-ci-robot commented Sep 15, 2025

Uh oh!

Leo6Leo commented Sep 15, 2025

Uh oh!

TheRealJon Sep 15, 2025

Choose a reason for hiding this comment

Uh oh!

Leo6Leo Sep 15, 2025

Choose a reason for hiding this comment

Uh oh!

TheRealJon Sep 22, 2025

Choose a reason for hiding this comment

Uh oh!

vojtechszocs Sep 24, 2025

Choose a reason for hiding this comment

Uh oh!

Leo6Leo Sep 24, 2025

Choose a reason for hiding this comment

After applying @vojtechszocs 's fix

Further investigation

Uh oh!

TheRealJon Sep 25, 2025

Choose a reason for hiding this comment

Uh oh!

openshift-ci bot commented Oct 1, 2025

Uh oh!

openshift-ci bot commented Oct 1, 2025