josh - add commment for wrapper DashboardViewportWithQuery

RyanL1997 · RyanL1997 · commit e0fd3efbf8d0 · 2025-05-07T13:32:29.000-07:00
Signed-off-by: Jialiang Liang &lt;jiallian@amazon.com&gt;
diff --git a/src/plugins/dashboard/public/application/embeddable/viewport/dashboard_viewport.tsx b/src/plugins/dashboard/public/application/embeddable/viewport/dashboard_viewport.tsx
@@ -202,6 +202,12 @@ export class DashboardViewport extends React.Component<DashboardViewportProps, S
   }
 }
 
+/**
+ * A wrapper component for DashboardViewport that integrates direct query sync functionality.
+ * Manages the state for direct query sync (startLoading, loadStatus, pollingResult) using the useDirectQuery hook,
+ * and provides mdsId state management for datasource synchronization.
+ * This separation keeps DashboardViewport as a pure presentational component while handling stateful logic here.
+ */
 export const DashboardViewportWithQuery = (
   props: Omit<DashboardViewportProps, 'startLoading' | 'loadStatus' | 'pollingResult'>
 ) => {

Original file line number	Diff line number	Diff line change
`@@ -202,6 +202,12 @@ export class DashboardViewport extends React.Component<DashboardViewportProps, S`
`202`	`202`	`}`
`203`	`203`	`}`
`204`	`204`
	`205`	`+/**`
	`206`	`+ * A wrapper component for DashboardViewport that integrates direct query sync functionality.`
	`207`	`+ * Manages the state for direct query sync (startLoading, loadStatus, pollingResult) using the useDirectQuery hook,`
	`208`	`+ * and provides mdsId state management for datasource synchronization.`
	`209`	`+ * This separation keeps DashboardViewport as a pure presentational component while handling stateful logic here.`
	`210`	`+ */`
`205`	`211`	`export const DashboardViewportWithQuery = (`
`206`	`212`	`props: Omit<DashboardViewportProps, 'startLoading' \| 'loadStatus' \| 'pollingResult'>`
`207`	`213`	`) => {`