fix(dashboard): refresh tabs as they load when dashboard is refreshed #35265
+138
−3
Conversation
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
dosubot
bot
added
dashboard
![korbit-ai[bot]](https://avatars.githubusercontent.com/in/322216?s=60&v=4){kind=small}
There was a problem hiding this comment.
Review by Korbit AI
Korbit automatically attempts to detect when you fix issues in new commits.
| Category | Issue | Status |
|---|---|---|
 |
High coupling with DashboardLayout implementation ▹ view | 🧠 Not in scope |
 |
Inefficient memoization key for layout ▹ view | 🧠 Incorrect |
|
Inefficient effect dependency on tabActivationTimes ▹ view | 🧠 Not in standard |
|
Component with Mixed Responsibilities ▹ view | 🧠 Incorrect |
Files scanned
| File Path | Reviewed |
|---|---|
| superset-frontend/src/dashboard/util/charts/useAllChartIds.ts | ✅ |
| superset-frontend/src/dashboard/util/getChartIdsFromComponent.ts | ✅ |
| superset-frontend/src/dashboard/reducers/dashboardState.js | ✅ |
| superset-frontend/src/dashboard/components/gridComponents/Tab/Tab.jsx | ✅ |
Explore our documentation to understand the languages and file types we support and the files we ignore.
Check out our docs on how you can make Korbit work best for you and your team.
Comment on lines
+22
to
+25
| export default function getChartIdsFromComponent( | ||
| componentId: string, | ||
| layout: DashboardLayout, | ||
| ): number[] { |
This comment was marked as resolved.
This comment was marked as resolved.
Sorry, something went wrong.
| const layout = useSelector( | ||
| (state: RootState) => state.dashboardLayout.present, | ||
| ); | ||
| return useMemo(() => getChartIdsFromLayout(layout), [layout]); |
This comment was marked as resolved.
This comment was marked as resolved.
Sorry, something went wrong.
Comment on lines
+127
to
+158
| useEffect(() => { | ||
| if (props.renderType === RENDER_TAB_CONTENT && props.isComponentVisible) { | ||
| const tabId = props.id; | ||
| const tabActivationTime = tabActivationTimes[tabId] || 0; | ||
|
|
||
| // If a refresh occurred while this tab was inactive, | ||
| // refresh the charts in this tab now that it's visible | ||
| if ( | ||
| lastRefreshTime && | ||
| tabActivationTime && | ||
| lastRefreshTime > tabActivationTime | ||
| ) { | ||
| const chartIds = getChartIdsFromComponent(tabId, dashboardLayout); | ||
| if (chartIds.length > 0) { | ||
| // Small delay to ensure charts are fully mounted | ||
| setTimeout(() => { | ||
| // Refresh charts in this tab | ||
| dispatch(onRefresh(chartIds, true, 0, dashboardInfo.id)); | ||
| }, 100); | ||
| } | ||
| } | ||
| } | ||
| }, [ | ||
| props.isComponentVisible, | ||
| props.renderType, | ||
| props.id, | ||
| lastRefreshTime, | ||
| tabActivationTimes, | ||
| dashboardLayout, | ||
| dashboardInfo.id, | ||
| dispatch, | ||
| ]); |
This comment was marked as resolved.
This comment was marked as resolved.
Sorry, something went wrong.
Comment on lines
114
to
+124
| const Tab = props => { | ||
| const dispatch = useDispatch(); | ||
| const canEdit = useSelector(state => state.dashboardInfo.dash_edit_perm); | ||
| const dashboardLayout = useSelector(state => state.dashboardLayout.present); | ||
| const lastRefreshTime = useSelector( | ||
| state => state.dashboardState.lastRefreshTime, | ||
| ); | ||
| const tabActivationTimes = useSelector( | ||
| state => state.dashboardState.tabActivationTimes || {}, | ||
| ); | ||
| const dashboardInfo = useSelector(state => state.dashboardInfo); |
This comment was marked as resolved.
This comment was marked as resolved.
Sorry, something went wrong.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
SUMMARY
This PR fixes an issue where refreshing a dashboard does not update charts in tabs that haven't been loaded yet. Previously, only charts in tabs that were already visited would refresh, leaving unvisited tabs with stale data.
The fix implements lazy refresh behavior for tabs - when a dashboard refresh is triggered, tabs that haven't been loaded yet will automatically refresh their charts when the user switches to them.
BEFORE/AFTER
Before
After
TESTING INSTRUCTIONS
ADDITIONAL INFORMATION
lastRefreshTimeto dashboard state to track when refreshes occurgetChartIdsFromComponentto get all chart IDs within a tabFixes the issue where dashboard refresh doesn't affect unloaded tabs.