Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
68 changes: 60 additions & 8 deletions static/app/views/dashboards/contexts/widgetSyncContext.tsx
Original file line number Diff line number Diff line change
@@ -1,11 +1,13 @@
import type {ReactNode} from 'react';
import {useCallback, useEffect, useMemo, useRef} from 'react';
import type {EChartsType} from 'echarts';
import * as echarts from 'echarts';

import {uniqueId} from 'sentry/utils/guid';
import {createDefinedContext} from 'sentry/utils/performance/contexts/utils';

type RegistrationFunction = (chart: EChartsType) => void;
type UnregisterFunction = () => void;
type RegistrationFunction = (chart: EChartsType) => UnregisterFunction;

interface WidgetSyncContext {
groupName: string;
Expand All @@ -25,18 +27,68 @@ interface WidgetSyncContextProviderProps {

export function WidgetSyncContextProvider({
children,
groupName = uniqueId(),
groupName,
}: WidgetSyncContextProviderProps) {
const register: RegistrationFunction = chart => {
Comment thread
cursor[bot] marked this conversation as resolved.
chart.group = groupName;
echarts?.connect(groupName);
};
// Stabilize the default groupName so it doesn't change on every render
const stableGroupName = useMemo(() => groupName ?? uniqueId(), [groupName]);
const observerRef = useRef<IntersectionObserver | null>(null);

const getOrCreateObserver = useCallback(() => {
if (!observerRef.current) {
observerRef.current = new IntersectionObserver(entries => {
for (const entry of entries) {
const chart = echarts.getInstanceByDom(entry.target as HTMLElement);
if (!chart) {
continue;
}

if (entry.isIntersecting) {
chart.group = stableGroupName;
} else {
chart.group = '';
}
}

echarts?.connect(stableGroupName);
});
}
return observerRef.current;
}, [stableGroupName]);

useEffect(() => {
return () => {
observerRef.current?.disconnect();
observerRef.current = null;
};
}, [stableGroupName]);

const register = useCallback(
(chart: EChartsType): UnregisterFunction => {
const dom = chart.getDom();
if (!dom) {
return () => {};
}

getOrCreateObserver().observe(dom);

// Set the group immediately for charts that may already be visible
chart.group = stableGroupName;
echarts?.connect(stableGroupName);

// Return a function to unregister the chart
return () => {
observerRef.current?.unobserve(dom);
chart.group = '';
};
},
[stableGroupName, getOrCreateObserver]
);
Comment thread
sentry[bot] marked this conversation as resolved.
Comment thread
cursor[bot] marked this conversation as resolved.

return (
<_WidgetSyncProvider
value={{
register,
groupName,
groupName: stableGroupName,
}}
>
{children}
Expand All @@ -50,7 +102,7 @@ export function useWidgetSyncContext(): WidgetSyncContext {
if (!context) {
// The provider was not registered, return a dummy function
return {
register: (_p: any) => null,
register: (_p: any) => () => {},
groupName: '',
};
}
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import {useCallback, useMemo, useRef, useState} from 'react';
import {useCallback, useEffect, useMemo, useRef, useState} from 'react';
import {useTheme} from '@emotion/react';
import {mergeRefs} from '@react-aria/utils';
import * as Sentry from '@sentry/react';
Expand Down Expand Up @@ -136,8 +136,15 @@ export function TimeSeriesWidgetVisualization(props: TimeSeriesWidgetVisualizati
// the backend zerofills the data

const chartRef = useRef<ReactEchartsRef | null>(null);
const unregisterRef = useRef<(() => void) | null>(null);
Comment thread
gggritso marked this conversation as resolved.
const {register: registerWithWidgetSyncContext, groupName} = useWidgetSyncContext();

useEffect(() => {
return () => {
unregisterRef.current?.();
};
}, []);

const pageFilters = usePageFilters();
const {start, end, period, utc} =
props.pageFilters?.datetime || pageFilters.selection.datetime;
Expand Down Expand Up @@ -445,7 +452,8 @@ export function TimeSeriesWidgetVisualization(props: TimeSeriesWidgetVisualizati
const handleChartReady = useCallback(
(instance: echarts.ECharts) => {
onChartReadyZoom(instance);
registerWithWidgetSyncContext(instance);
unregisterRef.current?.();
unregisterRef.current = registerWithWidgetSyncContext(instance);
},
[onChartReadyZoom, registerWithWidgetSyncContext]
);
Expand Down
Loading