[FIX] GaugeChart: Update config upon sheet renaming

How to reproduce:
- Start with a spreadsheet with two sheets
- In Sheet 1, create a gauge chart
- Add an inflection point as a formula which points towards Sheet 2
- Rename Sheet 2 to something else

The inflection point formula was not updated to match the new sheet
name.

Transforming the name of a range following a `RENAME_SHEET` command
cannot work currently as we rely solely on the getters to convert
an XC to a range, adapt it and then regenerate an XC based on the
updated range. During this process, the name of the sheet does not
change inside the plugins which means that if we try to generate an
xc, we end up with the previous sheetName.

The fix suggested here stops relying on the getters (and therefore
the plugin states) in favor of the sheetName change information
contained in the original `RENAME_SHEET` command.

closes #7030

Task: 4868971
X-original-commit: 5ab44cd
Signed-off-by: Lucas Lefèvre (lul) <lul@odoo.com>
Signed-off-by: Rémi Rahir (rar) <rar@odoo.com>

Author: rrahir

src/helpers/figures/charts/abstract_chart.ts

@@ -1,4 +1,11 @@
-import { ApplyRangeChange, CommandResult, CoreGetters, RangeAdapter, UID } from "../../../types";
+import {
+  AdaptSheetName,
+  ApplyRangeChange,
+  CommandResult,
+  CoreGetters,
+  RangeAdapter,
+  UID,
+} from "../../../types";
 import {
   ChartCreationContext,
   ChartDefinition,
@@ -69,7 +76,11 @@ export abstract class AbstractChart {
    * This function should be used to update all the ranges of the chart after
    * a grid change (add/remove col/row, rename sheet, ...)
    */
-  abstract updateRanges(applyChange: ApplyRangeChange): AbstractChart;
+  abstract updateRanges(
+    applyChange: ApplyRangeChange,
+    sheetId: UID,
+    adaptSheetName: AdaptSheetName
+  ): AbstractChart;
 
   /**
    * Duplicate the chart when a sheet is duplicated.

src/helpers/figures/charts/gauge_chart.ts

@@ -8,6 +8,7 @@ import { tryToNumber } from "../../../functions/helpers";
 import { BasePlugin } from "../../../plugins/base_plugin";
 import { _t } from "../../../translation";
 import {
+  AdaptSheetName,
   ApplyRangeChange,
   CellValueType,
   Color,
@@ -30,7 +31,7 @@ import {
 } from "../../../types/chart/gauge_chart";
 import { CellErrorType } from "../../../types/errors";
 import { Validator } from "../../../types/validator";
-import { adaptStringRange } from "../../formulas";
+import { adaptFormulaStringRanges, adaptStringRange } from "../../formulas";
 import { clip, formatValue } from "../../index";
 import { createValidRange } from "../../range";
 import { rangeReference } from "../../references";
@@ -261,11 +262,19 @@ export class GaugeChart extends AbstractChart {
     };
   }
 
-  updateRanges(applyChange: ApplyRangeChange): GaugeChart {
+  updateRanges(
+    applyChange: ApplyRangeChange,
+    sheetId: UID,
+    adaptSheetName: AdaptSheetName
+  ): GaugeChart {
     const dataRange = adaptChartRange(this.dataRange, applyChange);
 
     const adaptFormula = (formula: string) =>
-      this.getters.adaptFormulaStringDependencies(this.sheetId, formula, applyChange);
+      adaptFormulaStringRanges(this.sheetId, formula, {
+        applyChange,
+        sheetId,
+        sheetName: adaptSheetName,
+      });
     const sectionRule = adaptSectionRuleFormulas(this.sectionRule, adaptFormula);
     const definition = this.getDefinitionWithSpecificRanges(dataRange, sectionRule);
     return new GaugeChart(definition, this.sheetId, this.getters);

src/plugins/core/chart.ts

@@ -4,6 +4,7 @@ import { AbstractChart } from "../../helpers/figures/charts/abstract_chart";
 import { chartFactory, validateChartDefinition } from "../../helpers/figures/charts/chart_factory";
 import { ChartCreationContext, ChartDefinition, ChartType } from "../../types/chart/chart";
 import {
+  AdaptSheetName,
   ApplyRangeChange,
   Command,
   CommandResult,
@@ -45,9 +46,13 @@ export class ChartPlugin extends CorePlugin<ChartState> implements ChartState {
   private validateChartDefinition = (cmd: CreateChartCommand | UpdateChartCommand) =>
     validateChartDefinition(this, cmd.definition);
 
-  adaptRanges(applyChange: ApplyRangeChange) {
+  adaptRanges(applyChange: ApplyRangeChange, sheetId: UID, adaptSheetName: AdaptSheetName) {
     for (const [chartId, chart] of Object.entries(this.charts)) {
-      this.history.update("charts", chartId, chart?.updateRanges(applyChange));
+      this.history.update(
+        "charts",
+        chartId,
+        chart?.updateRanges(applyChange, sheetId, adaptSheetName)
+      );
     }
   }
 

tests/figures/chart/gauge/gauge_chart_plugin.test.ts

@@ -17,6 +17,7 @@ import {
   duplicateSheet,
   paste,
   redo,
+  renameSheet,
   setCellContent,
   setFormat,
   undo,
@@ -176,6 +177,24 @@ describe("datasource tests", function () {
         upperInflectionPoint: { type: "number", value: "=SUM('Copy of Sheet1'!B1:C4)" },
       });
     });
+
+    test("gauge range are adapted when renaming the sheet", () => {
+      renameSheet(model, "Sheet2", "Boom");
+      let chart = model.getters.getChartDefinition("chartId") as GaugeChartDefinition;
+      expect(chart.sectionRule).toMatchObject({
+        lowerInflectionPoint: { operator: "<", type: "percentage", value: "=Boom!A2" },
+      });
+
+      renameSheet(model, "Sheet1", "Magic");
+      chart = model.getters.getChartDefinition("chartId") as GaugeChartDefinition;
+      expect(chart.dataRange).toStrictEqual("Magic!B1:B4");
+      expect(chart.sectionRule).toMatchObject({
+        rangeMin: "=A1+5",
+        rangeMax: "=C8",
+        lowerInflectionPoint: { operator: "<", type: "percentage", value: "=Boom!A2" },
+        upperInflectionPoint: { operator: "<", type: "number", value: "=SUM(Magic!B1:C4)" },
+      });
+    });
   });
 
   test("can delete an imported gauge chart", () => {