Skip to content

feat(widget-form): solve widget form bugs #5652

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

Merged
piggggggggy merged 2 commits into from
Feb 20, 2025
Merged

feat(widget-form): solve widget form bugs #5652

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ab8dc5b
fix(widget): solve widget draw chart bug
piggggggggy Feb 20, 2025
4c18eba
refactor(widget-helper): refactor sanitize options helper
piggggggggy Feb 20, 2025
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
9 changes: 7 additions & 2 deletions apps/web/src/common/modules/widgets/_components/WidgetFormOverlayStep2WidgetForm.vue
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -142,10 +142,14 @@ const handleSelectDataTable = async (dataTableId: string) => {
await updateWidget({
widget_id: widgetGenerateState.widgetId,
data_table_id: dataTableId,
widget_type: widgetType,
state: 'INACTIVE',
options: sanitizedOptions,
});

const _config = getWidgetConfig(widgetType);
if (!_config) return;
props.fieldManager.updateWidgetConfig(_config);
props.fieldManager.updateDataTableAndOriginData(selectedDataTable, sanitizedOptions);
};

Expand Down Expand Up @@ -189,11 +193,12 @@ const checkDefaultValidation = () => {
const changeWidgetType = (widgetName: string) => {
const _config = getWidgetConfig(widgetName);
if (widgetName === widgetGenerateState.selectedWidgetName || !_config) return;
widgetGenerateStore.setSelectedWidgetName(widgetName);
widgetGenerateStore.setSize(_config.meta.sizes[0]);

const sanitizedOptions = sanitizeWidgetOptions(props.fieldManager.data, widgetName, state.selectedDataTable);
props.fieldManager.updateWidgetConfig(_config);
props.fieldManager.updateModifiedData(sanitizedOptions);
widgetGenerateStore.setSelectedWidgetName(widgetName);
widgetGenerateStore.setSize(_config.meta.sizes[0]);
checkDefaultValidation();
};

Expand Down
58 changes: 36 additions & 22 deletions apps/web/src/common/modules/widgets/_helpers/widget-helper.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
import bytes from 'bytes';
import { cloneDeep } from 'lodash';
import { cloneDeep, isArray } from 'lodash';

import { byteFormatter, customNumberFormatter, numberFormatter } from '@cloudforet/utils';

Expand All @@ -10,6 +10,8 @@ import { DATE_FIELD } from '@/common/modules/widgets/_constants/widget-constant'
import { NUMBER_FORMAT } from '@/common/modules/widgets/_constants/widget-field-constant';
import { getWidgetConfig } from '@/common/modules/widgets/_helpers/widget-config-helper';
import { integrateFieldsSchema } from '@/common/modules/widgets/_helpers/widget-field-helper';
// eslint-disable-next-line import/no-cycle
import { widgetFieldDefaultValueSetterRegistry } from '@/common/modules/widgets/_widget-field-value-manager/constant/default-value-registry';
import { WIDGET_OPTIONS_AFFECTED_BY_DATA_TABLE, widgetValidatorRegistry } from '@/common/modules/widgets/_widget-field-value-manager/constant/validator-registry';
import type { NumberFormatInfo } from '@/common/modules/widgets/_widget-fields/number-format/type';
import type { DataTableModel } from '@/common/modules/widgets/types/widget-data-table-type';
Expand Down Expand Up @@ -67,51 +69,54 @@ export const sanitizeWidgetOptions = (options: WidgetModel['options'] = {}, widg

// Remove keys that are not in the validOptionKeys list
currentOptionKeys.forEach((key) => {
const fieldValue = cloneDeep(options[key]).value;
if (!validOptionKeys.includes(key)) {
delete options[key];
}

const fieldValue = cloneDeep(options[key]).value;
const validator = widgetValidatorRegistry[key];
const isFieldAffectedByDataTable = WIDGET_OPTIONS_AFFECTED_BY_DATA_TABLE.includes(key);

if (!dataTable || !fieldValue || !validator || !isFieldAffectedByDataTable) return;
if (!validOptionKeys.includes(key) || !dataTable || !fieldValue || !validator || !isFieldAffectedByDataTable) return;

const fieldOptions = _fieldsSchema[key]?.options ?? {};
if (!validator(fieldValue, widgetConfig, dataTable, options)) {
const availableFieldKeys = Object.keys(dataTable?.[fieldOptions?.dataTarget || 'data_info'] ?? {});
console.debug('key', key, dataTable, fieldValue, availableFieldKeys, fieldOptions, validator(fieldValue, widgetConfig, dataTable, options));
console.debug('availableFieldKeys', key, fieldOptions, availableFieldKeys, fieldValue.data);
if (key === 'dataField') {
const isMultiSelectable = fieldOptions?.multiSelectable;
const originalData = fieldValue.data;
const filteredData = isArray(originalData) ? originalData.filter((val) => availableFieldKeys.includes(val)) : [];
const getSingleValue = (data) => (availableFieldKeys.includes(data) ? data : availableFieldKeys[0]);

const isPivotDataTable = dataTable?.operator === DATA_TABLE_OPERATOR.PIVOT;
if (isPivotDataTable) {
const pivotColumnsField = dataTable?.options.PIVOT?.fields?.column;
options[key] = { value: { ...fieldValue, data: isMultiSelectable ? [pivotColumnsField] : pivotColumnsField } };
} else if (isMultiSelectable) {
const pivotColumnsField = dataTable?.options.PIVOT?.fields?.column; // string;
options[key] = {
value: {
...fieldValue,
data: fieldValue.data?.filter((val) => availableFieldKeys.includes(val)) || [],
data: isMultiSelectable ? [pivotColumnsField] : pivotColumnsField,
},
};
} else if (!availableFieldKeys.includes(fieldValue.data)) {
options[key] = { value: { ...fieldValue, data: availableFieldKeys[0] } };
} else {
options[key] = {
...fieldValue,
value: { data: isMultiSelectable ? filteredData : getSingleValue(originalData) },
};
}
}
if (key === 'groupBy') {
const isMultiSelectable = fieldOptions?.multiSelectable;
if (isMultiSelectable) {
options[key] = {
value: {
...fieldValue,
data: fieldValue.data?.filter((val) => availableFieldKeys.includes(val)) || [],
},
};
} else if (!availableFieldKeys.includes(fieldValue.data)) {
options[key] = { value: { ...fieldValue, data: availableFieldKeys[0] } };
}
const originalData = fieldValue.data;
const filteredData = isArray(originalData) ? originalData.filter((val) => availableFieldKeys.includes(val)) : [];
const hideCount = fieldOptions?.hideCount;
const getSingleValue = (data) => (availableFieldKeys.includes(data) ? data : availableFieldKeys[0]);

options[key] = {
value: {
count: !hideCount ? (fieldValue.count ?? fieldOptions.defaultMaxCount ?? 5) : undefined,
data: isMultiSelectable ? filteredData : getSingleValue(originalData),
},
};
}
if (key === 'categoryBy' || key === 'stackBy' || key === 'xAxis' || key === 'yAxis') {
if (!availableFieldKeys.includes(fieldValue.data)) {
Expand Down Expand Up @@ -155,6 +160,15 @@ export const sanitizeWidgetOptions = (options: WidgetModel['options'] = {}, widg
}
});

console.debug('options', options);
validOptionKeys.forEach((key) => {
const fieldValue = cloneDeep(options[key])?.value;
if (!fieldValue) {
const defaultValueSetter = widgetFieldDefaultValueSetterRegistry[key];
if (defaultValueSetter) {
options[key] = { value: defaultValueSetter(widgetConfig, dataTable) };
}
}
});

return options;
};
2 changes: 1 addition & 1 deletion apps/web/src/common/modules/widgets/_widget-field-value-manager/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -106,7 +106,7 @@ export default class WidgetFieldValueManager {
this.validationErrors = {};
}

private updateWidgetConfig(widgetConfig: WidgetConfig): void {
updateWidgetConfig(widgetConfig: WidgetConfig): void {
this.widgetConfig = widgetConfig;
}

Expand Down
3 changes: 2 additions & 1 deletion apps/web/src/common/modules/widgets/_widgets/clustered-column-chart/ClusteredColumnChart.vue
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -307,7 +307,8 @@ watch([() => state.chartData, () => chartContext.value], ([, chartCtx]) => {
}
});

watch([() => state.data, () => props.widgetOptions], ([newData]) => {
watch([() => state.data, () => props.widgetOptions, () => state.dataTable], ([newData,, _dataTable]) => {
if (!_dataTable) return;
drawChart(newData);
}, { immediate: true });

Expand Down
3 changes: 2 additions & 1 deletion apps/web/src/common/modules/widgets/_widgets/gauge/Gauge.vue
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -205,7 +205,8 @@ watch([() => state.chartData, () => chartContext.value, () => props.widgetOption
state.chart.setOption(state.chartOptions, true);
}
});
watch([() => state.data, () => props.widgetOptions], ([newData]) => {
watch([() => state.data, () => props.widgetOptions, () => state.dataTable], ([newData,, _dataTable]) => {
if (!_dataTable) return;
drawChart(newData);
}, { immediate: true });
watch(() => props.dataTableId, async (newDataTableId) => {
Expand Down
3 changes: 2 additions & 1 deletion apps/web/src/common/modules/widgets/_widgets/geo-map/GeoMap.vue
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -206,7 +206,8 @@ watch([() => state.chartData, () => chartContext.value, () => state.mapLoaded],
state.chart.setOption(state.chartOptions, true);
}
});
watch([() => state.data, () => props.widgetOptions], async ([newData]) => {
watch([() => state.data, () => props.widgetOptions, () => state.dataTable], async ([newData,, _dataTable]) => {
if (!_dataTable) return;
await loadMap();
await drawChart(newData);
}, { immediate: true });
Expand Down
3 changes: 2 additions & 1 deletion apps/web/src/common/modules/widgets/_widgets/heatmap/Heatmap.vue
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -252,7 +252,8 @@ watch([() => state.chartData, () => chartContext.value], ([, chartCtx]) => {
}
});

watch([() => state.data, () => props.widgetOptions], ([newData]) => {
watch([() => state.data, () => props.widgetOptions, () => state.dataTable], ([newData,, _dataTable]) => {
if (!_dataTable) return;
drawChart(newData);
}, { immediate: true });

Expand Down
19 changes: 11 additions & 8 deletions apps/web/src/common/modules/widgets/_widgets/line-chart/LineChart.vue
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -93,7 +93,7 @@ const state = reactive({
}),
chartData: [],
isAreaChart: computed<boolean>(() => props.widgetName === 'stackedAreaChart'),
unitMap: computed<Record<string, string>>(() => widgetFrameProps.value.unitMap || {}),
unitMap: computed<Record<string, string>>(() => widgetFrameProps?.value?.unitMap || {}),
chartOptions: computed<LineSeriesOption>(() => ({
color: MASSIVE_CHART_COLORS,
grid: {
Expand Down Expand Up @@ -272,26 +272,29 @@ const drawChart = (rawData: WidgetLoadResponse|null) => {
},
});
});

state.chartData = _seriesData;
};

const { widgetFrameProps, widgetFrameEventHandlers } = useWidgetFrame(props, emit, {
dateRange,
errorMessage,
widgetLoading,
noData: computed(() => (state.data ? !state.data.results?.length : false)),
});

/* Watcher */
watch([() => state.chartData, () => chartContext.value], ([, chartCtx]) => {
if (chartCtx) {
state.chart = init(chartContext.value);
state.chart.setOption(state.chartOptions, true);
}
});
watch([() => state.data, () => props.widgetOptions], ([newData]) => {
watch([() => state.data, () => props.widgetOptions, () => state.dataTable], ([newData,, _dataTable]) => {
if (!_dataTable) return;
drawChart(newData);
}, { immediate: true });

const { widgetFrameProps, widgetFrameEventHandlers } = useWidgetFrame(props, emit, {
dateRange,
errorMessage,
widgetLoading,
noData: computed(() => (state.data ? !state.data.results?.length : false)),
});

useResizeObserver(chartContext, throttle(() => {
state.chart?.resize();
Expand Down
3 changes: 2 additions & 1 deletion apps/web/src/common/modules/widgets/_widgets/pie-chart/PieChart.vue
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -286,7 +286,8 @@ watch([() => state.chartData, () => chartContext.value], ([, chartCtx]) => {
state.chart.setOption(state.chartOptions, true);
}
});
watch([() => state.data, () => props.widgetOptions], ([newData]) => {
watch([() => state.data, () => props.widgetOptions, () => state.dataTable], ([newData,, _dataTable]) => {
if (!_dataTable) return;
drawChart(newData);
}, { immediate: true });
useResizeObserver(chartContext, throttle(() => {
Expand Down
3 changes: 2 additions & 1 deletion apps/web/src/common/modules/widgets/_widgets/sankey-chart/SankeyChart.vue
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -233,7 +233,8 @@ watch([() => state.chartData, () => chartContext.value], ([, chartCtx]) => {
state.chart.setOption(state.chartOptions, true);
}
});
watch([() => state.data, () => props.widgetOptions], ([newData]) => {
watch([() => state.data, () => props.widgetOptions, () => state.dataTable], ([newData,, _dataTable]) => {
if (!_dataTable) return;
drawChart(newData);
}, { immediate: true });

Expand Down
3 changes: 2 additions & 1 deletion apps/web/src/common/modules/widgets/_widgets/stacked-column-chart/StackedColumnChart.vue
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -281,7 +281,8 @@ watch([() => state.chartData, () => chartContext.value], ([, chartCtx]) => {
state.chart.setOption(state.chartOptions, true);
}
});
watch([() => state.data, () => props.widgetOptions], ([newData]) => {
watch([() => state.data, () => props.widgetOptions, () => state.dataTable], ([newData,, _dataTable]) => {
if (!_dataTable) return;
drawChart(newData);
}, { immediate: true });

Expand Down
3 changes: 2 additions & 1 deletion ...ommon/modules/widgets/_widgets/stacked-horizontal-bar-chart/StackedHorizontalBarChart.vue
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -274,7 +274,8 @@ watch([() => state.chartData, () => chartContext.value], ([, chartCtx]) => {
state.chart.setOption(state.chartOptions, true);
}
});
watch([() => state.data, () => props.widgetOptions], ([newData]) => {
watch([() => state.data, () => props.widgetOptions, () => state.dataTable], ([newData,, _dataTable]) => {
if (!_dataTable) return;
drawChart(newData);
}, { immediate: true });

Expand Down
3 changes: 2 additions & 1 deletion apps/web/src/common/modules/widgets/_widgets/treemap/Treemap.vue
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -235,7 +235,8 @@ watch([() => state.chartData, () => chartContext.value], ([, chartCtx]) => {
state.chart.setOption(state.chartOptions, true);
}
});
watch([() => state.data, () => props.widgetOptions], ([newData]) => {
watch([() => state.data, () => props.widgetOptions, () => state.dataTable], ([newData,, _dataTable]) => {
if (!_dataTable) return;
drawChart(newData);
}, { immediate: true });

Expand Down
Loading