Merge branch 'feature/#5531/default-filter-for-chart-widgets' into 'd…

…evelop' [Issue #5531] Default filter for chart widgets See merge request canopsis/canopsis-pro!4017
capensis · Jul 31, 2024 · 1471cf3 · 1471cf3
2 parents 911705b + fa96afe
commit 1471cf3
Show file tree

Hide file tree

Showing 20 changed files with 46 additions and 36 deletions.
diff --git a/...es/webcore/src/canopsis-next/src/components/sidebars/chart/form/bar-chart-widget-form.vue b/...es/webcore/src/canopsis-next/src/components/sidebars/chart/form/bar-chart-widget-form.vue
@@ -34,11 +34,11 @@
       <field-sampling v-field="form.parameters.default_sampling" />
       <field-filters
         v-if="withFilters"
+        v-field="form.parameters.mainFilter"
         :filters="form.filters"
         addable
         editable
         with-entity
-        hide-selector
         @update:filters="updateFilters"
       />
       <field-switcher

diff --git a/...s/webcore/src/canopsis-next/src/components/sidebars/chart/form/line-chart-widget-form.vue b/...s/webcore/src/canopsis-next/src/components/sidebars/chart/form/line-chart-widget-form.vue
@@ -27,11 +27,11 @@
       <field-sampling v-field="form.parameters.default_sampling" />
       <field-filters
         v-if="withFilters"
+        v-field="form.parameters.mainFilter"
         :filters="form.filters"
         addable
         editable
         with-entity
-        hide-selector
         @update:filters="updateFilters"
       />
       <field-switcher

diff --git a/...rces/webcore/src/canopsis-next/src/components/sidebars/chart/form/numbers-widget-form.vue b/...rces/webcore/src/canopsis-next/src/components/sidebars/chart/form/numbers-widget-form.vue
@@ -34,11 +34,11 @@
       <field-sampling v-field="form.parameters.default_sampling" />
       <field-filters
         v-if="withFilters"
+        v-field="form.parameters.mainFilter"
         :filters="form.filters"
         addable
         editable
         with-entity
-        hide-selector
         @update:filters="updateFilters"
       />
       <field-switcher

diff --git a/...es/webcore/src/canopsis-next/src/components/sidebars/chart/form/pie-chart-widget-form.vue b/...es/webcore/src/canopsis-next/src/components/sidebars/chart/form/pie-chart-widget-form.vue
@@ -34,11 +34,11 @@
       <field-alarm-metric-aggregate-function v-field="form.parameters.aggregate_func" />
       <field-filters
         v-if="withFilters"
+        v-field="form.parameters.mainFilter"
         :filters="form.filters"
         addable
         editable
         with-entity
-        hide-selector
         @update:filters="updateFilters"
       />
     </widget-settings-group>

diff --git a/...unity/sources/webcore/src/canopsis-next/src/components/widgets/chart/bar-chart-widget.vue b/...unity/sources/webcore/src/canopsis-next/src/components/widgets/chart/bar-chart-widget.vue
@@ -7,7 +7,7 @@
       :widget-id="widget._id"
       :user-filters="userPreference.filters"
       :widget-filters="widget.filters"
-      :locked-value="query.lockedFilter"
+      :locked-filters="query.lockedFilter"
       :filters="query.filter"
       :interval="query.interval"
       :min-interval-date="minAvailableDate"
@@ -51,7 +51,7 @@ import { createNamespacedHelpers } from 'vuex';
 import { pick } from 'lodash';
 
 import { convertDateToStartOfDayTimestampByTimezone } from '@/helpers/date/date';
-import { convertFilterToQuery } from '@/helpers/entities/shared/query';
+import { convertFiltersToQuery } from '@/helpers/entities/shared/query';
 import { convertMetricsToTimezone } from '@/helpers/entities/metric/list';
 
 import { widgetFetchQueryMixin } from '@/mixins/widget/fetch-query';
@@ -157,7 +157,7 @@ export default {
       return {
         ...this.getIntervalQuery(),
         ...pick(this.query, ['parameters', 'sampling', 'with_history']),
-        widget_filters: convertFilterToQuery(this.query.filter),
+        widget_filters: convertFiltersToQuery(this.query.filter, this.query.lockedFilter),
       };
     },
 

diff --git a/...nity/sources/webcore/src/canopsis-next/src/components/widgets/chart/line-chart-widget.vue b/...nity/sources/webcore/src/canopsis-next/src/components/widgets/chart/line-chart-widget.vue
@@ -7,7 +7,7 @@
       :widget-id="widget._id"
       :user-filters="userPreference.filters"
       :widget-filters="widget.filters"
-      :locked-value="query.lockedFilter"
+      :locked-filters="query.lockedFilter"
       :filters="query.filter"
       :interval="query.interval"
       :min-interval-date="minAvailableDate"
@@ -50,7 +50,7 @@ import { createNamespacedHelpers } from 'vuex';
 import { pick } from 'lodash';
 
 import { convertDateToStartOfDayTimestampByTimezone } from '@/helpers/date/date';
-import { convertFilterToQuery } from '@/helpers/entities/shared/query';
+import { convertFiltersToQuery } from '@/helpers/entities/shared/query';
 import { convertMetricsToTimezone } from '@/helpers/entities/metric/list';
 
 import { widgetFetchQueryMixin } from '@/mixins/widget/fetch-query';
@@ -156,7 +156,7 @@ export default {
       return {
         ...this.getIntervalQuery(),
         ...pick(this.query, ['parameters', 'sampling', 'with_history']),
-        widget_filters: convertFilterToQuery(this.query.filter),
+        widget_filters: convertFiltersToQuery(this.query.filter, this.query.lockedFilter),
       };
     },
 

diff --git a/community/sources/webcore/src/canopsis-next/src/components/widgets/chart/numbers-widget.vue b/community/sources/webcore/src/canopsis-next/src/components/widgets/chart/numbers-widget.vue
@@ -7,7 +7,7 @@
       :widget-id="widget._id"
       :user-filters="userPreference.filters"
       :widget-filters="widget.filters"
-      :locked-filter="query.lockedFilter"
+      :locked-filters="query.lockedFilter"
       :filters="query.filter"
       :interval="query.interval"
       :sampling="query.sampling"
@@ -54,7 +54,7 @@ import {
   NUMBERS_CHART_MIN_AUTO_FONT_SIZE,
 } from '@/constants';
 
-import { convertFilterToQuery } from '@/helpers/entities/shared/query';
+import { convertFiltersToQuery } from '@/helpers/entities/shared/query';
 
 import { widgetFetchQueryMixin } from '@/mixins/widget/fetch-query';
 import { widgetFilterSelectMixin } from '@/mixins/widget/filter-select';
@@ -177,7 +177,7 @@ export default {
       return {
         ...this.getIntervalQuery(),
         ...pick(this.query, ['parameters', 'sampling', 'with_history']),
-        widget_filters: convertFilterToQuery(this.query.filter),
+        widget_filters: convertFiltersToQuery(this.query.filter, this.query.lockedFilter),
       };
     },
 

diff --git a/...unity/sources/webcore/src/canopsis-next/src/components/widgets/chart/pie-chart-widget.vue b/...unity/sources/webcore/src/canopsis-next/src/components/widgets/chart/pie-chart-widget.vue
@@ -7,7 +7,7 @@
       :widget-id="widget._id"
       :user-filters="userPreference.filters"
       :widget-filters="widget.filters"
-      :locked-value="query.lockedFilter"
+      :locked-filters="query.lockedFilter"
       :filters="query.filter"
       :interval="query.interval"
       :sampling="query.sampling"
@@ -48,7 +48,7 @@
 import { createNamespacedHelpers } from 'vuex';
 import { pick } from 'lodash';
 
-import { convertFilterToQuery } from '@/helpers/entities/shared/query';
+import { convertFiltersToQuery } from '@/helpers/entities/shared/query';
 
 import { widgetFetchQueryMixin } from '@/mixins/widget/fetch-query';
 import { widgetFilterSelectMixin } from '@/mixins/widget/filter-select';
@@ -138,7 +138,7 @@ export default {
       return {
         ...this.getIntervalQuery(),
         ...pick(this.query, ['parameters', 'sampling']),
-        widget_filters: convertFilterToQuery(this.query.filter),
+        widget_filters: convertFiltersToQuery(this.query.filter, this.query.lockedFilter),
       };
     },
 

diff --git a/.../sources/webcore/src/canopsis-next/src/components/widgets/partials/kpi-widget-filters.vue b/.../sources/webcore/src/canopsis-next/src/components/widgets/partials/kpi-widget-filters.vue
@@ -26,7 +26,7 @@
         :label="$t('settings.selectAFilter')"
         :filters="userFilters"
         :locked-filters="widgetFilters"
-        :locked-value="lockedFilter"
+        :locked-value="lockedFilters"
         :value="filters"
         :disabled="filterDisabled"
         class="kpi-widget-filters__filter-selector mr-4"
@@ -79,7 +79,7 @@ export default {
       type: Array,
       default: () => [],
     },
-    lockedFilter: {
+    lockedFilters: {
       type: [String, Array],
       required: false,
     },

diff --git a/...ebcore/src/canopsis-next/src/components/widgets/statistics/partials/statistics-widget.vue b/...ebcore/src/canopsis-next/src/components/widgets/statistics/partials/statistics-widget.vue
@@ -7,7 +7,7 @@
       :widget-id="widget._id"
       :user-filters="userPreference.filters"
       :widget-filters="widget.filters"
-      :locked-filter="query.lockedFilter"
+      :locked-filters="query.lockedFilter"
       :filters="query.filter"
       :interval="query.interval"
       :sampling="query.sampling"

diff --git a/community/sources/webcore/src/canopsis-next/src/helpers/entities/metric/query.js b/community/sources/webcore/src/canopsis-next/src/helpers/entities/metric/query.js
@@ -64,12 +64,17 @@ export const convertChartUserPreferenceToQuery = ({ content: { sampling, interva
  * This function converts chart widgets default parameters to query Object
  *
  * @param {Widget} widget
- * @returns {{ sampling: string, interval: Object }}
+ * @returns {{ lockedFilter: string | null, sampling: string, interval: Object }}
  */
 export function convertChartWidgetDefaultParametersToQuery(widget) {
-  const { parameters: { default_sampling: defaultSampling, default_time_range: defaultTimeRange } } = widget;
+  const {
+    mainFilter,
+    default_sampling: defaultSampling,
+    default_time_range: defaultTimeRange,
+  } = widget.parameters;
 
   return {
+    lockedFilter: mainFilter,
     sampling: defaultSampling,
     interval: {
       from: QUICK_RANGES[defaultTimeRange].start,
@@ -85,7 +90,7 @@ export function convertChartWidgetDefaultParametersToQuery(widget) {
  * @returns {Object}
  */
 export function convertChartWidgetToQuery(widget) {
-  const { parameters: { comparison = false, metrics = [] } } = widget;
+  const { comparison = false, metrics = [] } = widget.parameters;
 
   return {
     ...convertChartWidgetDefaultParametersToQuery(widget),
@@ -102,7 +107,10 @@ export function convertChartWidgetToQuery(widget) {
  * @returns {Object}
  */
 export function convertPieChartWidgetToQuery(widget) {
-  const { parameters: { metrics = [], aggregate_func: widgetAggregateFunc } } = widget;
+  const {
+    metrics = [],
+    aggregate_func: widgetAggregateFunc,
+  } = widget.parameters;
 
   return {
     ...convertChartWidgetDefaultParametersToQuery(widget),
@@ -121,7 +129,7 @@ export function convertPieChartWidgetToQuery(widget) {
  * @returns {Object}
  */
 export function convertNumbersWidgetToQuery(widget) {
-  const { parameters: { metrics = [], show_trend: showTrend = false } } = widget;
+  const { metrics = [], show_trend: showTrend = false } = widget.parameters;
 
   return {
     ...convertChartWidgetDefaultParametersToQuery(widget),
@@ -142,13 +150,11 @@ export function convertNumbersWidgetToQuery(widget) {
  */
 export function convertStatisticsWidgetParametersToQuery(widget) {
   const {
-    parameters: {
-      mainFilter,
-      mainParameter = {},
-      widgetColumns = [],
-      default_time_range: defaultTimeRange,
-    },
-  } = widget;
+    mainFilter,
+    mainParameter = {},
+    widgetColumns = [],
+    default_time_range: defaultTimeRange,
+  } = widget.parameters;
 
   const query = {
     interval: {

diff --git a/community/sources/webcore/src/canopsis-next/src/helpers/entities/widget/forms/bar-chart.js b/community/sources/webcore/src/canopsis-next/src/helpers/entities/widget/forms/bar-chart.js
@@ -12,6 +12,7 @@ import { metricPresetsToForm, formToMetricPresets } from '@/helpers/entities/met
  * @property {string} default_time_range
  * @property {Sampling} default_sampling
  * @property {boolean} comparison
+ * @property {string | null} mainFilter
  */
 
 /**
@@ -32,6 +33,7 @@ export const barChartWidgetParametersToForm = (parameters = {}) => ({
   default_time_range: parameters.default_time_range ?? QUICK_RANGES.last30Days.value,
   default_sampling: parameters.default_sampling ?? SAMPLINGS.day,
   comparison: parameters.comparison ?? false,
+  mainFilter: parameters.mainFilter ?? null,
 });
 
 /**

diff --git a/community/sources/webcore/src/canopsis-next/src/helpers/entities/widget/forms/line-chart.js b/community/sources/webcore/src/canopsis-next/src/helpers/entities/widget/forms/line-chart.js
@@ -11,6 +11,7 @@ import { metricPresetsToForm, formToMetricPresets } from '@/helpers/entities/met
  * @property {string} default_time_range
  * @property {Sampling} default_sampling
  * @property {boolean} comparison
+ * @property {string | null} mainFilter
  */
 
 /**
@@ -30,6 +31,7 @@ export const lineChartWidgetParametersToForm = (parameters = {}) => ({
   default_time_range: parameters.default_time_range ?? QUICK_RANGES.last30Days.value,
   default_sampling: parameters.default_sampling ?? SAMPLINGS.day,
   comparison: parameters.comparison ?? false,
+  mainFilter: parameters.mainFilter ?? null,
 });
 
 /**

diff --git a/...nity/sources/webcore/src/canopsis-next/src/helpers/entities/widget/forms/numbers-chart.js b/...nity/sources/webcore/src/canopsis-next/src/helpers/entities/widget/forms/numbers-chart.js
@@ -12,6 +12,7 @@ import { metricPresetsToForm, formToMetricPresets } from '@/helpers/entities/met
  * @property {Sampling} default_sampling
  * @property {string} show_trend
  * @property {number} [font_size]
+ * @property {string | null} mainFilter
  */
 
 /**
@@ -32,6 +33,7 @@ export const numbersWidgetParametersToForm = (parameters = {}) => ({
   default_sampling: parameters.default_sampling ?? SAMPLINGS.day,
   show_trend: parameters.show_trend ?? false,
   font_size: parameters.font_size,
+  mainFilter: parameters.mainFilter ?? null,
 });
 
 /**

diff --git a/community/sources/webcore/src/canopsis-next/src/helpers/entities/widget/forms/pie-chart.js b/community/sources/webcore/src/canopsis-next/src/helpers/entities/widget/forms/pie-chart.js
@@ -18,6 +18,7 @@ import { metricPresetsToForm, formToMetricPresets } from '@/helpers/entities/met
  * @property {Sampling} default_sampling
  * @property {string} aggregate_func
  * @property {string} show_mode
+ * @property {string | null} mainFilter
  */
 
 /**
@@ -38,6 +39,7 @@ export const pieChartWidgetParametersToForm = (parameters = {}) => ({
   aggregate_func: parameters.aggregate_func ?? AGGREGATE_FUNCTIONS.avg,
   default_time_range: parameters.default_time_range ?? QUICK_RANGES.last30Days.value,
   default_sampling: parameters.default_sampling ?? SAMPLINGS.day,
+  mainFilter: parameters.mainFilter ?? null,
 });
 
 /**

diff --git a/...ests/unit/components/sidebars/chart/form/__snapshots__/bar-chart-widget-form.spec.js.snap b/...ests/unit/components/sidebars/chart/form/__snapshots__/bar-chart-widget-form.spec.js.snap
@@ -50,7 +50,6 @@ exports[`bar-chart-widget-form Renders \`bar-chart-widget-form\` widget settings
       addable="true"
       editable="true"
       filters="[object Object]"
-      hideselector="true"
       withentity="true"
     />
     <field-switcher-stub

diff --git a/...sts/unit/components/sidebars/chart/form/__snapshots__/line-chart-widget-form.spec.js.snap b/...sts/unit/components/sidebars/chart/form/__snapshots__/line-chart-widget-form.spec.js.snap
@@ -40,7 +40,6 @@ exports[`line-chart-widget-form Renders \`line-chart-widget-form\` widget settin
       addable="true"
       editable="true"
       filters="[object Object]"
-      hideselector="true"
       withentity="true"
     />
     <field-switcher-stub

diff --git a/.../tests/unit/components/sidebars/chart/form/__snapshots__/numbers-widget-form.spec.js.snap b/.../tests/unit/components/sidebars/chart/form/__snapshots__/numbers-widget-form.spec.js.snap
@@ -49,7 +49,6 @@ exports[`numbers-widget-form Renders \`numbers-widget-form\` widget settings wit
       addable="true"
       editable="true"
       filters="[object Object]"
-      hideselector="true"
       withentity="true"
     />
     <field-switcher-stub

diff --git a/...ests/unit/components/sidebars/chart/form/__snapshots__/pie-chart-widget-form.spec.js.snap b/...ests/unit/components/sidebars/chart/form/__snapshots__/pie-chart-widget-form.spec.js.snap
@@ -53,7 +53,6 @@ exports[`pie-chart-widget-form Renders \`pie-chart-widget-form\` widget settings
       addable="true"
       editable="true"
       filters="[object Object]"
-      hideselector="true"
       withentity="true"
     />
   </widget-settings-group-stub>

diff --git a/...next/tests/unit/components/widgets/partials/__snapshots__/kpi-widget-filters.spec.js.snap b/...next/tests/unit/components/widgets/partials/__snapshots__/kpi-widget-filters.spec.js.snap
@@ -3,6 +3,7 @@
 exports[`kpi-widget-filters Renders 'kpi-widget-filters' with custom props 1`] = `
 <div
   class="layout kpi-widget-filters wrap"
+  lockedfilter="locked-filter-id"
 >
   <c-quick-date-interval-field-stub
     class="kpi-widget-filters__interval"
@@ -28,7 +29,6 @@ exports[`kpi-widget-filters Renders 'kpi-widget-filters' with custom props 1`] =
       itemvalue="_id"
       label="Select a filter"
       lockedfilters="[object Object],[object Object],[object Object],[object Object]"
-      lockedvalue="locked-filter-id"
       value="[object Object],[object Object]"
     />
     <filters-list-btn-stub