-
Notifications
You must be signed in to change notification settings - Fork 748
OCPBUGS-78293: Defer 404 catch-all until plugin feature flags settle #17099
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
TheRealJon
wants to merge
4
commits into
openshift:main
Choose a base branch
from
redhat-chai-bot:fix/ocpbugs-78293-flag-gated-404
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+66
−1
Open
Changes from all commits
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
8c10df5
Bug 78293: Defer 404 catch-all until plugin feature flags settle
redhat-chai-bot f7a5ec8
Bug 78293: Extract usePluginFlagsSettled hook and fix timeout reset
redhat-chai-bot 9c25cca
Bug 78293: Use setState-during-render for flag timeout reset
redhat-chai-bot 882fa97
Bug 78293: Remove implementation comment from usePluginFlagsSettled
redhat-chai-bot File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
61 changes: 61 additions & 0 deletions
61
frontend/packages/console-app/src/hooks/usePluginFlagsSettled.ts
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,61 @@ | ||
| import { useState, useEffect, useMemo } from 'react'; | ||
| import type { PluginInfoEntry } from '@openshift/dynamic-plugin-sdk'; | ||
| import { flagPending } from '@console/internal/reducers/features'; | ||
| import { useConsoleSelector } from '@console/shared/src/hooks/useConsoleSelector'; | ||
|
|
||
| const FLAG_SETTLING_TIMEOUT_MS = 3000; | ||
|
|
||
| /** | ||
| * Checks whether all loaded plugin feature flags have settled. | ||
| * | ||
| * When a dynamic plugin finishes loading, its `console.flag/hookProvider` | ||
| * extensions run asynchronously. Until a hookProvider calls `setFeatureFlag`, | ||
| * its flag value is `undefined` (pending) in Redux. Routes gated on those | ||
| * flags are invisible to the router during this window. | ||
| * | ||
| * This hook inspects each loaded plugin's `manifest.extensions` for required | ||
| * flags that are still pending, and includes a timeout fallback so that | ||
| * broken hookProviders do not permanently block the 404 catch-all. | ||
| * | ||
| * @param pluginInfoEntries - current plugin information from `usePluginInfo()` | ||
| * @returns `true` when all plugin flags have resolved or the timeout has elapsed | ||
| */ | ||
| export const usePluginFlagsSettled = (pluginInfoEntries: PluginInfoEntry[]): boolean => { | ||
| const reduxFlags = useConsoleSelector((state) => state.FLAGS); | ||
|
|
||
| const hasPendingPluginFlags = useMemo( | ||
| () => | ||
| pluginInfoEntries.some((entry) => { | ||
| if (entry.status === 'pending' || entry.status === 'failed') return false; | ||
| const extensions = entry.manifest?.extensions; | ||
| if (!Array.isArray(extensions)) return false; | ||
| return extensions.some((ext) => { | ||
| const required = ext.flags?.required; | ||
| if (!Array.isArray(required) || required.length === 0) return false; | ||
| return required.some((flagName: string) => flagPending(reduxFlags[flagName])); | ||
| }); | ||
| }), | ||
| [pluginInfoEntries, reduxFlags], | ||
| ); | ||
|
|
||
| const [flagSettlingTimedOut, setFlagSettlingTimedOut] = useState(false); | ||
|
|
||
| const [prevHasPending, setPrevHasPending] = useState(false); | ||
| if (prevHasPending && !hasPendingPluginFlags) { | ||
| setFlagSettlingTimedOut(false); | ||
| } | ||
| if (prevHasPending !== hasPendingPluginFlags) { | ||
| setPrevHasPending(hasPendingPluginFlags); | ||
| } | ||
|
|
||
| useEffect(() => { | ||
| if (!hasPendingPluginFlags || flagSettlingTimedOut) { | ||
| return; | ||
| } | ||
|
|
||
| const timer = setTimeout(() => setFlagSettlingTimedOut(true), FLAG_SETTLING_TIMEOUT_MS); | ||
| return () => clearTimeout(timer); | ||
| }, [hasPendingPluginFlags, flagSettlingTimedOut]); | ||
|
|
||
| return !hasPendingPluginFlags || flagSettlingTimedOut; | ||
| }; |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.