[IMP] spreadsheet: select granularity for date filter

This commit adds the possibility to disable the month or quarter
granularity (or both) for fixedPeriod date filters.

closes odoo#169922

Task: 3887844
Related: odoo/enterprise#64964
Signed-off-by: Lucas Lefèvre (lul) <[email protected]>

Author: hokolomopo

addons/spreadsheet/static/src/global_filters/components/filter_date_value/filter_date_value.js

@@ -2,16 +2,28 @@
 
 import { Component, onWillUpdateProps } from "@odoo/owl";
 import { DateTimeInput } from "@web/core/datetime/datetime_input";
-import { FILTER_DATE_OPTION, monthsOptions } from "@spreadsheet/assets_backend/constants";
-import { getPeriodOptions } from "@web/search/utils/dates";
+import { monthsOptions } from "@spreadsheet/assets_backend/constants";
+import { QUARTER_OPTIONS } from "@web/search/utils/dates";
 
 const { DateTime } = luxon;
 
 export class DateFilterValue extends Component {
+    static template = "spreadsheet_edition.DateFilterValue";
+    static components = { DateTimeInput };
+    static props = {
+        // See @spreadsheet_edition/bundle/global_filters/filters_plugin.RangeType
+        onTimeRangeChanged: Function,
+        yearOffset: { type: Number, optional: true },
+        period: { type: String, optional: true },
+        disabledPeriods: { type: Array, optional: true },
+    };
     setup() {
         this._setStateFromProps(this.props);
-        onWillUpdateProps(this._setStateFromProps);
-        this.dateOptions = this.getDateOptions();
+        this.dateOptions = this.getDateOptions(this.props);
+        onWillUpdateProps((nextProps) => {
+            this._setStateFromProps(nextProps);
+            this.dateOptions = this.getDateOptions(nextProps);
+        });
     }
     _setStateFromProps(props) {
         this.period = props.period;
@@ -32,12 +44,18 @@ export class DateFilterValue extends Component {
      *
      * @returns {Array<Object>}
      */
-    getDateOptions() {
-        const periodOptions = getPeriodOptions(DateTime.local());
-        const quarters = FILTER_DATE_OPTION["quarter"].map((quarterId) =>
-            periodOptions.find((option) => option.id === quarterId)
-        );
-        return quarters.concat(monthsOptions);
+    getDateOptions(props) {
+        const quarterOptions = Object.values(QUARTER_OPTIONS);
+        const disabledPeriods = props.disabledPeriods || [];
+
+        const dateOptions = [];
+        if (!disabledPeriods.includes("quarter")) {
+            dateOptions.push(...quarterOptions);
+        }
+        if (!disabledPeriods.includes("month")) {
+            dateOptions.push(...monthsOptions);
+        }
+        return dateOptions;
     }
 
     isSelected(periodId) {
@@ -65,12 +83,3 @@ export class DateFilterValue extends Component {
         });
     }
 }
-DateFilterValue.template = "spreadsheet_edition.DateFilterValue";
-DateFilterValue.components = { DateTimeInput };
-
-DateFilterValue.props = {
-    // See @spreadsheet_edition/bundle/global_filters/filters_plugin.RangeType
-    onTimeRangeChanged: Function,
-    yearOffset: { type: Number, optional: true },
-    period: { type: String, optional: true },
-};

addons/spreadsheet/static/src/global_filters/components/filter_date_value/filter_date_value.xml

@@ -1,7 +1,7 @@
 <?xml version="1.0" encoding="utf-8"?>
 <templates>
     <div t-name="spreadsheet_edition.DateFilterValue" class="date_filter_values">
-        <select class="o_input me-3" t-on-change="onPeriodChanged">
+        <select t-if="dateOptions.length" class="o_input me-3" t-on-change="onPeriodChanged">
             <option value="empty">Select period...</option>
             <t t-foreach="dateOptions" t-as="periodOption" t-key="periodOption.id">
                 <option t-if="isSelected(periodOption.id)" selected="1" t-att-value="periodOption.id">

addons/spreadsheet/static/src/global_filters/components/filter_value/filter_value.xml

@@ -41,6 +41,7 @@
                 <DateFilterValue t-else=""
                     period="filterValue?.period"
                     yearOffset="filterValue?.yearOffset"
+                    disabledPeriods="filter.disabledPeriods"
                     onTimeRangeChanged="(value) => this.onDateInput(filter.id, value)"/>
             </div>
             <i t-if="getters.isGlobalFilterActive(filter.id)"

addons/spreadsheet/static/src/global_filters/helpers.js

@@ -5,45 +5,80 @@ import { Domain } from "@web/core/domain";
 
 import { CommandResult } from "@spreadsheet/o_spreadsheet/cancelled_reason";
 import { RELATIVE_DATE_RANGE_TYPES } from "@spreadsheet/helpers/constants";
+import { monthsOptions } from "@spreadsheet/assets_backend/constants";
+import { QUARTER_OPTIONS } from "@web/search/utils/dates";
 
 /**
  * @typedef {import("@spreadsheet/global_filters/plugins/global_filters_core_plugin").FieldMatching} FieldMatching
  */
 
-export function checkFiltersTypeValueCombination(type, value) {
+const monthsOptionsIds = monthsOptions.map((option) => option.id);
+const quarterOptionsIds = Object.values(QUARTER_OPTIONS).map((option) => option.id);
+
+/**
+ * Check if the value is valid for given filter.
+ * @param {GlobalFilter | CmdGlobalFilter} filter
+ * @param {any} value
+ * @returns {boolean}
+ */
+export function checkFilterValueIsValid(filter, value) {
+    const { type } = filter;
     if (value !== undefined) {
         switch (type) {
             case "text":
                 if (typeof value !== "string") {
-                    return CommandResult.InvalidValueTypeCombination;
+                    return false;
                 }
                 break;
             case "date": {
-                if (value === "") {
-                    return CommandResult.Success;
-                } else if (typeof value === "string") {
-                    const expectedValues = RELATIVE_DATE_RANGE_TYPES.map((val) => val.type);
-                    expectedValues.push("this_month", "this_quarter", "this_year");
-                    if (expectedValues.includes(value)) {
-                        return CommandResult.Success;
-                    }
-                    return CommandResult.InvalidValueTypeCombination;
-                } else if (typeof value !== "object") {
-                    return CommandResult.InvalidValueTypeCombination;
-                }
-                break;
+                return checkDateFilterValueIsValid(filter, value);
             }
             case "relation":
                 if (value === "current_user") {
-                    return CommandResult.Success;
+                    return true;
                 }
                 if (!Array.isArray(value)) {
-                    return CommandResult.InvalidValueTypeCombination;
+                    return false;
                 }
                 break;
         }
     }
-    return CommandResult.Success;
+    return true;
+}
+
+/**
+ * Check if the value is valid for given filter.
+ * @param {DateGlobalFilter} filter
+ * @param {any} value
+ * @returns {boolean}
+ */
+function checkDateFilterValueIsValid(filter, value) {
+    if (!value) {
+        return true;
+    }
+    switch (filter.rangeType) {
+        case "fixedPeriod": {
+            const period = value.period;
+            if (!filter.disabledPeriods || !filter.disabledPeriods.length) {
+                return true;
+            }
+            if (filter.disabledPeriods.includes("month")) {
+                return value !== "this_month" && !monthsOptionsIds.includes(period);
+            }
+            if (filter.disabledPeriods.includes("quarter")) {
+                return value !== "this_quarter" && !quarterOptionsIds.includes(period);
+            }
+            return true;
+        }
+        case "relative": {
+            const expectedValues = RELATIVE_DATE_RANGE_TYPES.map((val) => val.type);
+            expectedValues.push("this_month", "this_quarter", "this_year");
+            return expectedValues.includes(value);
+        }
+        case "from_to":
+            return typeof value === "object";
+    }
+    return true;
 }
 
 /**

addons/spreadsheet/static/src/global_filters/plugins/global_filters_core_plugin.js

@@ -4,6 +4,7 @@
  * @typedef {"fixedPeriod"|"relative"|"from_to"} RangeType
  *
  * @typedef {"last_month" | "last_week" | "last_year" | "last_three_years" | "this_month" | "this_quarter" | "this_year"} RelativePeriod
+ * @typedef {"quarter" | "month"} FixedPeriods
  *
  * @typedef {Object} FieldMatching
  * @property {string} chain name of the field
@@ -23,6 +24,8 @@
  * @property {string} label
  * @property {RangeType} rangeType
  * @property {RelativePeriod} [defaultValue]
+ * @property {FixedPeriods[]} [disabledPeriods]
+ *
  *
  * @typedef RelationalGlobalFilter
  * @property {"relation"} type
@@ -38,7 +41,7 @@ export const globalFiltersFieldMatchers = {};
 
 import * as spreadsheet from "@odoo/o-spreadsheet";
 import { CommandResult } from "@spreadsheet/o_spreadsheet/cancelled_reason";
-import { checkFiltersTypeValueCombination } from "@spreadsheet/global_filters/helpers";
+import { checkFilterValueIsValid } from "@spreadsheet/global_filters/helpers";
 import { _t } from "@web/core/l10n/translation";
 import { escapeRegExp } from "@web/core/utils/strings";
 
@@ -52,7 +55,7 @@ export class GlobalFiltersCorePlugin extends spreadsheet.CorePlugin {
     /**
      * Check if the given command can be dispatched
      *
-     * @param {Object} cmd Command
+     * @param {import("@spreadsheet").AllCoreCommand} cmd Command
      */
     allowDispatch(cmd) {
         switch (cmd.type) {
@@ -62,7 +65,10 @@ export class GlobalFiltersCorePlugin extends spreadsheet.CorePlugin {
                 } else if (this._isDuplicatedLabel(cmd.filter.id, cmd.filter.label)) {
                     return CommandResult.DuplicatedFilterLabel;
                 }
-                return checkFiltersTypeValueCombination(cmd.filter.type, cmd.filter.defaultValue);
+                if (!checkFilterValueIsValid(cmd.filter, cmd.filter.defaultValue)) {
+                    return CommandResult.InvalidValueTypeCombination;
+                }
+                break;
             case "REMOVE_GLOBAL_FILTER":
                 if (!this.getGlobalFilter(cmd.id)) {
                     return CommandResult.FilterNotFound;
@@ -72,7 +78,10 @@ export class GlobalFiltersCorePlugin extends spreadsheet.CorePlugin {
                 if (this._isDuplicatedLabel(cmd.filter.id, cmd.filter.label)) {
                     return CommandResult.DuplicatedFilterLabel;
                 }
-                return checkFiltersTypeValueCombination(cmd.filter.type, cmd.filter.defaultValue);
+                if (!checkFilterValueIsValid(cmd.filter, cmd.filter.defaultValue)) {
+                    return CommandResult.InvalidValueTypeCombination;
+                }
+                break;
             case "MOVE_GLOBAL_FILTER": {
                 const index = this.globalFilters.findIndex((filter) => filter.id === cmd.id);
                 if (index === -1) {

addons/spreadsheet/static/src/global_filters/plugins/global_filters_ui_plugin.js

@@ -18,7 +18,7 @@ import { CommandResult } from "@spreadsheet/o_spreadsheet/cancelled_reason";
 import { isEmpty } from "@spreadsheet/helpers/helpers";
 import { FILTER_DATE_OPTION } from "@spreadsheet/assets_backend/constants";
 import {
-    checkFiltersTypeValueCombination,
+    checkFilterValueIsValid,
     getRelativeDateDomain,
 } from "@spreadsheet/global_filters/helpers";
 import { RELATIVE_DATE_RANGE_TYPES } from "@spreadsheet/helpers/constants";
@@ -65,7 +65,7 @@ export class GlobalFiltersUIPlugin extends spreadsheet.UIPlugin {
     /**
      * Check if the given command can be dispatched
      *
-     * @param {Object} cmd Command
+     * @param {import("@spreadsheet").AllCommand} cmd Command
      */
     allowDispatch(cmd) {
         switch (cmd.type) {
@@ -74,7 +74,10 @@ export class GlobalFiltersUIPlugin extends spreadsheet.UIPlugin {
                 if (!filter) {
                     return CommandResult.FilterNotFound;
                 }
-                return checkFiltersTypeValueCombination(filter.type, cmd.value);
+                if (!checkFilterValueIsValid(filter, cmd.value)) {
+                    return CommandResult.InvalidValueTypeCombination;
+                }
+                break;
             }
         }
         return CommandResult.Success;
@@ -83,19 +86,30 @@ export class GlobalFiltersUIPlugin extends spreadsheet.UIPlugin {
     /**
      * Handle a spreadsheet command
      *
-     * @param {Object} cmd Command
+     * @param {import("@spreadsheet").AllCommand} cmd
      */
     handle(cmd) {
         switch (cmd.type) {
             case "ADD_GLOBAL_FILTER":
-                this.recordsDisplayName[cmd.filter.id] = cmd.filter.defaultValueDisplayNames;
+                this.recordsDisplayName[cmd.filter.id] =
+                    cmd.filter.type === "relation"
+                        ? cmd.filter.defaultValueDisplayNames
+                        : undefined;
                 break;
             case "EDIT_GLOBAL_FILTER": {
-                const id = cmd.filter.id;
-                if (this.values[id] && this.values[id].rangeType !== cmd.filter.rangeType) {
+                const filter = cmd.filter;
+                const id = filter.id;
+                if (
+                    filter.type === "date" &&
+                    this.values[id] &&
+                    this.values[id].rangeType !== filter.rangeType
+                ) {
+                    delete this.values[id];
+                } else if (!checkFilterValueIsValid(filter, this.values[id]?.value)) {
                     delete this.values[id];
                 }
-                this.recordsDisplayName[id] = cmd.filter.defaultValueDisplayNames;
+                this.recordsDisplayName[id] =
+                    filter.type === "relation" ? filter.defaultValueDisplayNames : undefined;
                 break;
             }
             case "SET_GLOBAL_FILTER_VALUE":