Update recommended content for search panel#250
Merged
CodyWMitchell merged 2 commits intoRedHatInsights:masterfrom Mar 5, 2026
Merged
Update recommended content for search panel#250CodyWMitchell merged 2 commits intoRedHatInsights:masterfrom
CodyWMitchell merged 2 commits intoRedHatInsights:masterfrom
Conversation
Summary by CodeRabbit
WalkthroughRefactors SearchPanel to compute recommended content from a new static/dynamic config and a one-time quickstarts load; derives bundle context synchronously from chrome bundle APIs; adds a recommendedContentConfig module and expands component tests with extensive API and chrome mocks. Changes
Sequence Diagram(s)sequenceDiagram
participant Test as Test Wrapper / Browser
participant Scalprum as Scalprum / App Init
participant Chrome as chrome API
participant Quickstarts as Quickstarts API
participant Search as SearchPanel
Test->>Scalprum: mount HelpPanel (with optional api)
Scalprum->>Chrome: chrome.getBundleData() / getAvailableBundles()
Chrome-->>Scalprum: bundle metadata
Scalprum->>Search: provide displayBundleName, bundleId
Search->>Quickstarts: fetch all quickstarts (on mount)
Quickstarts-->>Search: quickstarts payload (data / body)
Search->>Search: resolveRecommendedItems / buildFallbackRecommendedContent (uses recommendedContentConfig + allQuickStarts)
Search-->>Test: render UI (Recommended content, toggles, tabs)
Estimated code review effort🎯 3 (Moderate) | ⏱️ ~25 minutes 🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Tip Try Coding Plans. Let us write the prompt for your AI agent so you can ship faster (with fewer bugs). Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 2
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In
`@src/components/HelpPanel/HelpPanelTabs/SearchPanel/recommendedContentConfig.ts`:
- Line 45: Typo in several recommendation title strings: change "documenation"
to "documentation" in the title properties of the recommended content entries
defined in recommendedContentConfig (look for objects with title: 'Related
documenation for OpenShift Cluster Manager' and similar variants); update each
title string occurrence so it reads "Related documentation for OpenShift Cluster
Manager" (ensure you fix all instances in the recommendedContentConfig
definitions).
In `@src/components/HelpPanel/HelpPanelTabs/SearchPanel/SearchPanel.tsx`:
- Around line 401-403: computedRecommendedContent currently returns [] whenever
allQuickStarts is empty which hides static/curated recommendations; remove the
early return and instead initialize the recommendations from the static/curated
source (e.g., curatedRecommendations or staticRecommendedContent) and then
conditionally merge in quick-start items only if allQuickStarts.length > 0, or
filter/transform quickstarts when present; update the useMemo block around
computedRecommendedContent to build from the curated list first and append or
interleave allQuickStarts when available rather than short-circuiting to an
empty array.
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
Run ID: 529fddfc-c791-489f-b120-14e35e183994
📒 Files selected for processing (4)
cypress/component/HelpPanel.cy.tsxsrc/components/HelpPanel/HelpPanelTabs/SearchPanel/SearchPanel.tsxsrc/components/HelpPanel/HelpPanelTabs/SearchPanel/SearchResultItem.tsxsrc/components/HelpPanel/HelpPanelTabs/SearchPanel/recommendedContentConfig.ts
Comment on lines
+401
to
+403
| const computedRecommendedContent = useMemo(() => { | ||
| if (allQuickStarts.length === 0) return []; | ||
|
|
There was a problem hiding this comment.
Do not gate all recommendations on quickstart data availability.
Returning [] when allQuickStarts is empty suppresses static curated recommendations, so users can see an empty recommended section even when static config exists.
Suggested fix
- const computedRecommendedContent = useMemo(() => {
- if (allQuickStarts.length === 0) return [];
-
+ const computedRecommendedContent = useMemo(() => {
const showBundleContent =
activeToggle === 'bundle' && !isHomePage && bundleId;🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@src/components/HelpPanel/HelpPanelTabs/SearchPanel/SearchPanel.tsx` around
lines 401 - 403, computedRecommendedContent currently returns [] whenever
allQuickStarts is empty which hides static/curated recommendations; remove the
early return and instead initialize the recommendations from the static/curated
source (e.g., curatedRecommendations or staticRecommendedContent) and then
conditionally merge in quick-start items only if allQuickStarts.length > 0, or
filter/transform quickstarts when present; update the useMemo block around
computedRecommendedContent to build from the curated list first and append or
interleave allQuickStarts when available rather than short-circuiting to an
empty array.
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (3)
src/components/HelpPanel/HelpPanelTabs/SearchPanel/SearchPanel.tsx (2)
204-205: Avoid re-fetching quickstarts during search when already loaded.Quickstarts are loaded on mount (
allQuickStarts) and then fetched again per search query. ReusingallQuickStartswhen present will reduce request volume and improve perceived latency.Also applies to: 383-390
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@src/components/HelpPanel/HelpPanelTabs/SearchPanel/SearchPanel.tsx` around lines 204 - 205, The search handler is re-fetching quickstarts via fetchAllData even when allQuickStarts is already loaded; update the logic in SearchPanel (the spots using fetchAllData to get quickStarts) to first check the existing allQuickStarts state and reuse it if non-empty, only calling fetchAllData(chrome.auth.getUser, {}) to obtain quickStarts when allQuickStarts is empty or undefined; apply this change to the occurrence around the const [, quickStarts] = await fetchAllData(...) and the duplicate block referenced (the second occurrence around lines 383–390) so searches use cached allQuickStarts and avoid redundant network requests.
405-419: Backfill curated recommendations to the configured limit.Current logic returns curated results whenever
resolved.length > 0, so missing dynamic items can leave the list underfilled even when fallback items are available. Consider topping up from fallback (with de-duplication) to reachRECOMMENDED_CONTENT_LIMIT.Proposed fix
if (showBundleContent) { const curatedItems = bundleRecommendedContent[bundleId]; if (curatedItems?.length) { const resolved = resolveRecommendedItems(curatedItems, allQuickStarts); - if (resolved.length > 0) return resolved; + if (resolved.length >= RECOMMENDED_CONTENT_LIMIT) return resolved; + + const fallback = buildFallbackRecommendedContent(allQuickStarts, true); + const seen = new Set(resolved.map((item) => item.id)); + const topUp = fallback.filter((item) => !seen.has(item.id)); + return [...resolved, ...topUp].slice(0, RECOMMENDED_CONTENT_LIMIT); } return buildFallbackRecommendedContent(allQuickStarts, true); }🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@src/components/HelpPanel/HelpPanelTabs/SearchPanel/SearchPanel.tsx` around lines 405 - 419, When showBundleContent is true the code returns curated items as soon as resolveRecommendedItems(curatedItems, allQuickStarts) yields any results, which can leave the returned list shorter than RECOMMENDED_CONTENT_LIMIT; change the logic in the showBundleContent branch (using bundleRecommendedContent[bundleId], bundleId, resolveRecommendedItems and allQuickStarts) to, after resolving curated items, call buildFallbackRecommendedContent(allQuickStarts, true) and append fallback items (skipping duplicates by id or unique key) until the combined list reaches RECOMMENDED_CONTENT_LIMIT, then return that topped-up list; apply the same topping-up + de-duplication behavior when defaultResolved (from defaultRecommendedContent) is non-empty so both curated and default flows fill to the configured limit.src/components/HelpPanel/HelpPanelTabs/SearchPanel/recommendedContentConfig.ts (1)
61-137: Consider de-duplicating therhelandinsightsrecommendation blocks.Those two arrays are effectively the same content today, so keeping both copies will make future edits easy to miss in one path.
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@src/components/HelpPanel/HelpPanelTabs/SearchPanel/recommendedContentConfig.ts` around lines 61 - 137, The rhel and insights arrays in recommendedContentConfig.ts are duplicated; extract the common entries into a single shared constant (e.g., baseRecommendations or COMMON_RECOMMENDATIONS) and replace the rhel and insights properties to reference or clone that constant (e.g., rhel: baseRecommendations, insights: baseRecommendations or use [...baseRecommendations] if mutation safety is needed), keeping the existing dynamic entry names like 'insights-tasks-conversion' intact; update any export or object that currently defines rhel and insights to use this shared reference so future edits only change one place.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@src/components/HelpPanel/HelpPanelTabs/SearchPanel/SearchPanel.tsx`:
- Around line 117-119: The activeToggle state (initialized via useState in
SearchPanel) is only set from isHomePage once and can become stale when
navigation changes; add a useEffect that watches isHomePage (and, if relevant,
the current bundle/context prop) and calls setActiveToggle('all' if isHomePage
else 'bundle') to keep the toggle in sync with navigation changes so the UI
reflects the current page context.
---
Nitpick comments:
In
`@src/components/HelpPanel/HelpPanelTabs/SearchPanel/recommendedContentConfig.ts`:
- Around line 61-137: The rhel and insights arrays in
recommendedContentConfig.ts are duplicated; extract the common entries into a
single shared constant (e.g., baseRecommendations or COMMON_RECOMMENDATIONS) and
replace the rhel and insights properties to reference or clone that constant
(e.g., rhel: baseRecommendations, insights: baseRecommendations or use
[...baseRecommendations] if mutation safety is needed), keeping the existing
dynamic entry names like 'insights-tasks-conversion' intact; update any export
or object that currently defines rhel and insights to use this shared reference
so future edits only change one place.
In `@src/components/HelpPanel/HelpPanelTabs/SearchPanel/SearchPanel.tsx`:
- Around line 204-205: The search handler is re-fetching quickstarts via
fetchAllData even when allQuickStarts is already loaded; update the logic in
SearchPanel (the spots using fetchAllData to get quickStarts) to first check the
existing allQuickStarts state and reuse it if non-empty, only calling
fetchAllData(chrome.auth.getUser, {}) to obtain quickStarts when allQuickStarts
is empty or undefined; apply this change to the occurrence around the const [,
quickStarts] = await fetchAllData(...) and the duplicate block referenced (the
second occurrence around lines 383–390) so searches use cached allQuickStarts
and avoid redundant network requests.
- Around line 405-419: When showBundleContent is true the code returns curated
items as soon as resolveRecommendedItems(curatedItems, allQuickStarts) yields
any results, which can leave the returned list shorter than
RECOMMENDED_CONTENT_LIMIT; change the logic in the showBundleContent branch
(using bundleRecommendedContent[bundleId], bundleId, resolveRecommendedItems and
allQuickStarts) to, after resolving curated items, call
buildFallbackRecommendedContent(allQuickStarts, true) and append fallback items
(skipping duplicates by id or unique key) until the combined list reaches
RECOMMENDED_CONTENT_LIMIT, then return that topped-up list; apply the same
topping-up + de-duplication behavior when defaultResolved (from
defaultRecommendedContent) is non-empty so both curated and default flows fill
to the configured limit.
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
Run ID: d01dfd42-7593-46ae-88ae-b2a52ba50f4a
📒 Files selected for processing (2)
src/components/HelpPanel/HelpPanelTabs/SearchPanel/SearchPanel.tsxsrc/components/HelpPanel/HelpPanelTabs/SearchPanel/recommendedContentConfig.ts
Comment on lines
+117
to
119
| const [activeToggle, setActiveToggle] = useState<string>( | ||
| isHomePage ? 'all' : 'bundle' | ||
| ); |
There was a problem hiding this comment.
Sync recommended-scope toggle when bundle context changes.
Line [117] initializes activeToggle from isHomePage only once. If the panel stays mounted across navigation, the toggle can remain stale and show the wrong scope by default.
Proposed fix
const [activeToggle, setActiveToggle] = useState<string>(
isHomePage ? 'all' : 'bundle'
);
+
+ useEffect(() => {
+ setActiveToggle(isHomePage ? 'all' : 'bundle');
+ }, [isHomePage, bundleId]);📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
Suggested change
| const [activeToggle, setActiveToggle] = useState<string>( | |
| isHomePage ? 'all' : 'bundle' | |
| ); | |
| const [activeToggle, setActiveToggle] = useState<string>( | |
| isHomePage ? 'all' : 'bundle' | |
| ); | |
| useEffect(() => { | |
| setActiveToggle(isHomePage ? 'all' : 'bundle'); | |
| }, [isHomePage, bundleId]); |
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@src/components/HelpPanel/HelpPanelTabs/SearchPanel/SearchPanel.tsx` around
lines 117 - 119, The activeToggle state (initialized via useState in
SearchPanel) is only set from isHomePage once and can become stale when
navigation changes; add a useEffect that watches isHomePage (and, if relevant,
the current bundle/context prop) and calls setActiveToggle('all' if isHomePage
else 'bundle') to keep the toggle in sync with navigation changes so the UI
reflects the current page context.
apinkert
approved these changes
Mar 4, 2026
Collaborator
apinkert
left a comment
apinkert
left a comment
There was a problem hiding this comment.
this looks good to me 👍
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
RHCLOUD-45386
Updates the recommended content within the search panel tab (All and per bundle)