[FIX] pivot: deactivate support for exploded pivot

For now, the spreadsheet pivot does not fully support PIVOT.VALUE and
PIVOT.HEADER functions, so we prefer to disable it. It will be reactivate
later.

List of features that are not supported:
- Normalization of arguments, especially with the dates
- Positional arguments (with #)

closes #4025

Task: 3748717
Signed-off-by: Lucas Lefèvre (lul) <lul@odoo.com>

src/functions/module_lookup.ts

@@ -1,4 +1,5 @@
 import { getFullReference, range, toXC, toZone } from "../helpers/index";
+import { supportedPivotExplodedFormulaRegistry } from "../helpers/pivot/pivot_exploded_formula_registry";
 import { _t } from "../translation";
 import { AddFunctionDescription, CellPosition, FPayload, Matrix, Maybe } from "../types";
 import { CellErrorType, EvaluationError, InvalidReferenceError } from "../types/errors";
@@ -721,6 +722,12 @@ export const PIVOT_VALUE = {
     assertDomainLength(domainArgs);
     const pivot = this.getters.getPivot(pivotId);
     const coreDefinition = this.getters.getPivotCoreDefinition(pivotId);
+    if (!supportedPivotExplodedFormulaRegistry.get(coreDefinition.type)) {
+      return {
+        value: CellErrorType.GenericError,
+        message: _t("This pivot does not support PIVOT.VALUE formula"),
+      };
+    }
     addPivotDependencies(this, coreDefinition);
     const error = pivot.assertIsValid({ throwOnError: false });
     if (error) {
@@ -752,6 +759,12 @@ export const PIVOT_HEADER = {
     assertDomainLength(domainArgs);
     const pivot = this.getters.getPivot(_pivotId);
     const coreDefinition = this.getters.getPivotCoreDefinition(_pivotId);
+    if (!supportedPivotExplodedFormulaRegistry.get(coreDefinition.type)) {
+      return {
+        value: CellErrorType.GenericError,
+        message: _t("This pivot does not support PIVOT.VALUE formula"),
+      };
+    }
     addPivotDependencies(this, coreDefinition);
     const error = pivot.assertIsValid({ throwOnError: false });
     if (error) {

src/helpers/pivot/pivot_exploded_formula_registry.ts

@@ -0,0 +1,4 @@
+import { Registry } from "../../registries/registry";
+//TODO This registry is only used to disable the support of exploded pivot for spreadsheet
+export const supportedPivotExplodedFormulaRegistry = new Registry<boolean>();
+supportedPivotExplodedFormulaRegistry.add("SPREADSHEET", false);

src/index.ts

@@ -98,6 +98,7 @@ import {
   unquote,
 } from "./helpers/index";
 import { openLink, urlRegistry, urlRepresentation } from "./helpers/links";
+import { supportedPivotExplodedFormulaRegistry } from "./helpers/pivot/pivot_exploded_formula_registry";
 import {
   getFirstPivotFunction,
   getMaxObjectId,
@@ -256,6 +257,7 @@ export const registries = {
   pivotRegistry,
   pivotTimeAdapterRegistry,
   pivotSidePanelRegistry,
+  supportedPivotExplodedFormulaRegistry,
 };
 export const helpers = {
   arg,

src/registries/auto_completes/pivot_auto_complete.ts

@@ -1,6 +1,7 @@
 import { tokenColors } from "../../components/composer/composer/composer";
 import { EnrichedToken } from "../../formulas/composer_tokenizer";
 import { isDefined } from "../../helpers";
+import { supportedPivotExplodedFormulaRegistry } from "../../helpers/pivot/pivot_exploded_formula_registry";
 import {
   extractFormulaIdFromToken,
   insertTokenAfterArgSeparator,
@@ -27,17 +28,25 @@ autoCompleteProviders.add("pivot_ids", {
     if (pivotIds.includes(tokenAtCursor.value)) {
       return;
     }
-    return pivotIds.map((pivotId) => {
-      const definition = this.getters.getPivotCoreDefinition(pivotId);
-      const formulaId = this.getters.getPivotFormulaId(pivotId);
-      const str = `${formulaId}`;
-      return {
-        text: str,
-        description: definition.name,
-        htmlContent: [{ value: str, color: tokenColors.NUMBER }],
-        fuzzySearchKey: str + definition.name,
-      };
-    });
+    return pivotIds
+      .map((pivotId) => {
+        const definition = this.getters.getPivotCoreDefinition(pivotId);
+        if (
+          functionContext.parent.toUpperCase() !== "PIVOT" &&
+          !supportedPivotExplodedFormulaRegistry.get(definition.type)
+        ) {
+          return undefined;
+        }
+        const formulaId = this.getters.getPivotFormulaId(pivotId);
+        const str = `${formulaId}`;
+        return {
+          text: str,
+          description: definition.name,
+          htmlContent: [{ value: str, color: tokenColors.NUMBER }],
+          fuzzySearchKey: str + definition.name,
+        };
+      })
+      .filter(isDefined);
   },
   selectProposal: insertTokenAfterLeftParenthesis,
 });
@@ -64,6 +73,9 @@ autoCompleteProviders.add("pivot_measures", {
       return [];
     }
     const definition = this.getters.getPivotCoreDefinition(pivotId);
+    if (!supportedPivotExplodedFormulaRegistry.get(definition.type)) {
+      return [];
+    }
     return definition.measures
       .map((measure) => {
         if (measure.name === "__count") {
@@ -107,6 +119,10 @@ autoCompleteProviders.add("pivot_group_fields", {
     if (!fields) {
       return;
     }
+    const { columns, rows, type } = this.getters.getPivotCoreDefinition(pivotId);
+    if (!supportedPivotExplodedFormulaRegistry.get(type)) {
+      return [];
+    }
     let args = functionContext.args;
     if (functionContext?.parent.toUpperCase() === "PIVOT.VALUE") {
       args = args.filter((ast, index) => index % 2 === 0); // keep only the field names
@@ -115,7 +131,6 @@ autoCompleteProviders.add("pivot_group_fields", {
       args = args.filter((ast, index) => index % 2 === 1); // keep only the field names
     }
     const argGroupBys = args.map((ast) => ast?.value).filter(isDefined);
-    const { columns, rows } = this.getters.getPivotCoreDefinition(pivotId);
     const colFields = columns.map((groupBy) => groupBy.name);
     const rowFields = rows.map((groupBy) => groupBy.name);
 
@@ -200,6 +215,11 @@ autoCompleteProviders.add("pivot_group_values", {
     if (!pivotId || !this.getters.isExistingPivot(pivotId)) {
       return;
     }
+    const { type } = this.getters.getPivotCoreDefinition(pivotId);
+    if (!supportedPivotExplodedFormulaRegistry.get(type)) {
+      return [];
+    }
+
     const dataSource = this.getters.getPivot(pivotId);
     if (!dataSource.isValid()) {
       return;