Skip to content
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.

Sign up for GitHub

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

Jump to bottom

fix: vis is rendered with an invalid config #172

Merged
merged 7 commits into from
Feb 16, 2024
Merged

fix: vis is rendered with an invalid config #172

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
72c8b8b
fix: merge visConfig defaults before painting
oltionchampari Feb 7, 2024
1857073
fix: null category in heatmap
oltionchampari Feb 7, 2024
92ec4fb
fix: heatmap invalid settings
oltionchampari Feb 8, 2024
1d9b01d
fix: try a simpler solution
oltionchampari Feb 8, 2024
0950d3e
Merge branch 'develop' into och/vis-initialization
oltionchampari Feb 8, 2024
426854c
fix: use style instead of sx
oltionchampari Feb 8, 2024
7a6266e
refactor: use useUncontrolled hook in EagerVis
oltionchampari Feb 9, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
160 changes: 61 additions & 99 deletions src/vis/EagerVis.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -204,76 +204,40 @@ export function EagerVis({

const { getVisByType } = useVisProvider();

// Each time you switch between vis config types, there is one render where the config is inconsistent with the type before the merge functions in the useEffect below can be called.
// To ensure that we never render an incosistent config, keep a consistent and a current in the config. Always render the consistent.
// eslint-disable-next-line @typescript-eslint/naming-convention
const [{ consistent: visConfig, current: inconsistentVisConfig }, _setVisConfig] = React.useState<{
consistent: BaseVisConfig;
current: BaseVisConfig;
}>(
externalConfig
? { consistent: null, current: externalConfig }
const [_visConfig, _setVisConfig] = useUncontrolled({
value: externalConfig?.type ? getVisByType(externalConfig?.type)?.mergeConfig(columns, externalConfig) : null,
defaultValue: externalConfig
? null
: columns.filter((c) => c.type === EColumnTypes.NUMERICAL).length > 1
? {
consistent: null,
current: {
type: ESupportedPlotlyVis.SCATTER,
numColumnsSelected: [],
color: null,
numColorScaleType: ENumericalColorScaleType.SEQUENTIAL,
shape: null,
dragMode: EScatterSelectSettings.RECTANGLE,
alphaSliderVal: 0.5,
} as BaseVisConfig,
}
: {
consistent: null,
current: {
type: ESupportedPlotlyVis.BAR,
multiples: null,
group: null,
direction: EBarDirection.HORIZONTAL,
display: EBarDisplayType.ABSOLUTE,
groupType: EBarGroupingType.STACK,
numColumnsSelected: [],
catColumnSelected: null,
aggregateColumn: null,
aggregateType: EAggregateTypes.COUNT,
} as BaseVisConfig,
},
);

const setExternalConfigRef = useSyncedRef(setExternalConfig);
useEffect(() => {
setExternalConfigRef.current?.(visConfig);
// eslint-disable-next-line react-hooks/exhaustive-deps
}, [JSON.stringify(visConfig), setExternalConfigRef]);

const setVisConfig = React.useCallback((newConfig: BaseVisConfig) => {
_setVisConfig((oldConfig) => {
return {
current: newConfig,
consistent: oldConfig.current.type !== newConfig.type ? oldConfig.consistent : newConfig,
};
});
}, []);

React.useEffect(() => {
const vis = getVisByType(inconsistentVisConfig?.type);
if (vis) {
const newConfig = vis.mergeConfig(columns, inconsistentVisConfig);
_setVisConfig({ current: newConfig, consistent: newConfig });
}

// DANGER:: this useEffect should only occur when the visConfig.type changes. adding visconfig into the dep array will cause an infinite loop.
// eslint-disable-next-line react-hooks/exhaustive-deps
}, [inconsistentVisConfig?.type, getVisByType]);
? ({
type: ESupportedPlotlyVis.SCATTER,
numColumnsSelected: [],
color: null,
numColorScaleType: ENumericalColorScaleType.SEQUENTIAL,
shape: null,
dragMode: EScatterSelectSettings.RECTANGLE,
alphaSliderVal: 0.5,
} as BaseVisConfig)
: ({
type: ESupportedPlotlyVis.BAR,
multiples: null,
group: null,
direction: EBarDirection.HORIZONTAL,
display: EBarDisplayType.ABSOLUTE,
groupType: EBarGroupingType.STACK,
numColumnsSelected: [],
catColumnSelected: null,
aggregateColumn: null,
aggregateType: EAggregateTypes.COUNT,
} as BaseVisConfig),
onChange: setExternalConfig,
});

useEffect(() => {
if (externalConfig) {
setVisConfig(externalConfig);
}
}, [externalConfig, setVisConfig]);
const setVisConfig = (v: BaseVisConfig) => {
const withDefaults = getVisByType(v.type)?.mergeConfig(columns, v);
_setVisConfig(withDefaults);
};

// Converting the selected list into a map, since searching through the list to find an item is common in the vis components.
const selectedMap: { [key: string]: boolean } = useMemo(() => {
Expand Down Expand Up @@ -309,17 +273,17 @@ export function EagerVis({
};
}, [colors]);

if (!visConfig) {
return <div className="tdp-busy" />;
}

const commonProps = {
showSidebar,
setShowSidebar,
enableSidebar,
};

const Renderer = getVisByType(visConfig?.type)?.renderer;
const Renderer = getVisByType(_visConfig?.type)?.renderer;

if (!_visConfig || !Renderer) {
return null;
}

return (
<Group
Expand All @@ -341,35 +305,33 @@ export function EagerVis({
{enableSidebar && !showSidebar ? <VisSidebarOpenButton onClick={() => setShowSidebar(!showSidebar)} /> : null}

<Stack gap={0} style={{ width: '100%', height: '100%', overflow: 'hidden' }} align="stretch" ref={ref}>
{Renderer ? (
<Renderer
config={visConfig}
dimensions={dimensions}
optionsConfig={{
color: {
enable: true,
},
}}
showDragModeOptions={showDragModeOptions}
shapes={shapes}
setConfig={setVisConfig}
filterCallback={filterCallback}
selectionCallback={selectionCallback}
selectedMap={selectedMap}
selectedList={selected}
columns={columns}
scales={scales}
showSidebar={showSidebar}
showCloseButton={showCloseButton}
closeButtonCallback={closeCallback}
scrollZoom={scrollZoom}
{...commonProps}
/>
) : null}
<Renderer
config={_visConfig}
dimensions={dimensions}
optionsConfig={{
color: {
enable: true,
},
}}
showDragModeOptions={showDragModeOptions}
shapes={shapes}
setConfig={setVisConfig}
filterCallback={filterCallback}
selectionCallback={selectionCallback}
selectedMap={selectedMap}
selectedList={selected}
columns={columns}
scales={scales}
showSidebar={showSidebar}
showCloseButton={showCloseButton}
closeButtonCallback={closeCallback}
scrollZoom={scrollZoom}
{...commonProps}
/>
</Stack>
{showSidebar ? (
<VisSidebarWrapper config={visConfig} setConfig={setVisConfig} onClick={() => setShowSidebar(false)}>
<VisSidebar config={visConfig} columns={columns} filterCallback={filterCallback} setConfig={setVisConfig} />
<VisSidebarWrapper config={_visConfig} setConfig={setVisConfig} onClick={() => setShowSidebar(false)}>
<VisSidebar config={_visConfig} columns={columns} filterCallback={filterCallback} setConfig={setVisConfig} />
</VisSidebarWrapper>
) : null}
</Group>
Expand Down
10 changes: 5 additions & 5 deletions src/vis/heatmap/HeatmapGrid.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,11 +34,8 @@ export function HeatmapGrid({

return (
<Stack align="center" justify="center" style={{ width: '100%', height: '100%' }} p="sm">
{status === 'pending' ? (
<Loader />
) : !hasAtLeast2CatCols ? (
<InvalidCols headerMessage="Invalid settings" bodyMessage="To create a heatmap chart, select at least 2 categorical columns." />
) : (
{status === 'pending' && <Loader />}
Copy link
Contributor Author

@oltionchampari oltionchampari Feb 8, 2024 •
edited

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The Invalid settings message is shown shortly while the state is idle. This change fixes that. The other visualizations account for the idle state already.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for fixing this issue and the mention.

{status === 'success' && hasAtLeast2CatCols && (
<Heatmap
column1={allColumns.catColumn[0]}
column2={allColumns.catColumn[1]}
Expand All @@ -50,6 +47,9 @@ export function HeatmapGrid({
selectionCallback={selectionCallback}
/>
)}
{status === 'success' && !hasAtLeast2CatCols && (
<InvalidCols headerMessage="Invalid settings" bodyMessage="To create a heatmap chart, select at least 2 categorical columns." />
)}
</Stack>
);
}
2 changes: 1 addition & 1 deletion src/vis/heatmap/HeatmapText.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ export function HeatmapText({
isImmediate: boolean;
}) {
const labelSpacing = useMemo(() => {
const maxLabelLength = d3.max(yScale.domain().map((m) => m.length));
const maxLabelLength = d3.max(yScale.domain().map((m) => m?.length));
Copy link
Contributor Author

@oltionchampari oltionchampari Feb 8, 2024 •
edited

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Accounts for null categories. They are still shown in the visualization but at least the application does not crash.
I have created an issue to discuss possible better solutions


return maxLabelLength > 5 ? 35 : maxLabelLength * 7;
}, [yScale]);
Expand Down