[REF] ranges: remove sheetId argument of adaptRanges

The `adaptRanges` method of core plugins took a `sheetId` argument. But:

1) It wasn't easy to understand what it did and when to use it. It
was indicating the sheet with the ranges to adapt, but needed to
be ignored when adapting formulas.

2) In the future addition of named ranges, some adaptations (renaming
a named range) won't have a sheetId, and will need to be applied to
all sheets.

3) The argument was only there as an optimization. But it was useless
in the adaptation of cells formulas, as the `if` was repeated in the
`applyChange` implementation. And other core plugin adaptation costs
are negligible compared to the cells.

This commit removes the `sheetId` argument altogether.

Task: 5380498
Part-of: #7605
Signed-off-by: Lucas Lefèvre (lul) <lul@odoo.com>

Author: hokolomopo

packages/o-spreadsheet-engine/src/plugins/core/cell.ts

@@ -36,7 +36,7 @@ import {
 import { recomputeZones } from "../../helpers/recompute_zones";
 import { Format } from "../../types/format";
 import { DEFAULT_LOCALE } from "../../types/locale";
-import { AdaptSheetName, Style, UpdateCellData, Zone } from "../../types/misc";
+import { Style, UpdateCellData, Zone } from "../../types/misc";
 import { Range, RangePart } from "../../types/range";
 import { ExcelWorkbookData, WorkbookData } from "../../types/workbook_data";
 import { SquishedCell, Squisher } from "./squisher";
@@ -67,24 +67,22 @@ export class CellPlugin extends CorePlugin<CoreState> implements CoreState {
   readonly nextId = 1;
   public readonly cells: { [sheetId: string]: { [id: string]: Cell } } = {};
 
-  adaptRanges({ applyChange }: RangeAdapterFunctions, sheetId: UID, sheetName: AdaptSheetName) {
+  adaptRanges({ applyChange }: RangeAdapterFunctions) {
     for (const sheet of Object.keys(this.cells)) {
       for (const cell of Object.values(this.cells[sheet] || {})) {
         if (cell.isFormula) {
           for (const range of cell.compiledFormula.rangeDependencies) {
-            if (range.sheetId === sheetId || range.invalidSheetName === sheetName.old) {
-              const change = applyChange(range);
-              if (change.changeType !== "NONE") {
-                this.history.update(
-                  "cells",
-                  sheet,
-                  cell.id,
-                  "compiledFormula" as any,
-                  "rangeDependencies",
-                  cell.compiledFormula.rangeDependencies.indexOf(range),
-                  change.range
-                );
-              }
+            const change = applyChange(range);
+            if (change.changeType !== "NONE") {
+              this.history.update(
+                "cells",
+                sheet,
+                cell.id,
+                "compiledFormula" as any,
+                "rangeDependencies",
+                cell.compiledFormula.rangeDependencies.indexOf(range),
+                change.range
+              );
             }
           }
         }

packages/o-spreadsheet-engine/src/plugins/core/conditional_format.ts

@@ -175,9 +175,8 @@ export class ConditionalFormatPlugin
     }
   }
 
-  adaptRanges(rangeAdapters: RangeAdapterFunctions, sheetId: UID) {
-    const sheetIds = sheetId ? [sheetId] : Object.keys(this.cfRules);
-    for (const sheetId of sheetIds) {
+  adaptRanges(rangeAdapters: RangeAdapterFunctions) {
+    for (const sheetId of Object.keys(this.cfRules)) {
       this.adaptCFRanges(sheetId, rangeAdapters);
     }
     this.adaptCFFormulas(rangeAdapters);

packages/o-spreadsheet-engine/src/plugins/core/data_validation.ts

@@ -34,8 +34,10 @@ export class DataValidationPlugin
 
   readonly rules: { [sheet: string]: DataValidationRule[] } = {};
 
-  adaptRanges(rangeAdapters: RangeAdapterFunctions, sheetId: UID) {
-    this.adaptDVRanges(sheetId, rangeAdapters);
+  adaptRanges(rangeAdapters: RangeAdapterFunctions) {
+    for (const sheetId in this.rules) {
+      this.adaptDVRanges(sheetId, rangeAdapters);
+    }
     this.adaptDVFormulas(rangeAdapters);
   }
 

packages/o-spreadsheet-engine/src/plugins/core/figures.ts

@@ -27,7 +27,13 @@ export class FigurePlugin extends CorePlugin<FigureState> implements FigureState
   // Command Handling
   // ---------------------------------------------------------------------------
 
-  adaptRanges({ applyChange }: RangeAdapterFunctions, sheetId: UID) {
+  adaptRanges(rangeAdapterFunctions: RangeAdapterFunctions): void {
+    for (const sheetId in this.figures) {
+      this.adaptRangesOnSheet(rangeAdapterFunctions, sheetId);
+    }
+  }
+
+  adaptRangesOnSheet({ applyChange }: RangeAdapterFunctions, sheetId: UID) {
     for (const figure of this.getFigures(sheetId)) {
       const change = applyChange(
         this.getters.getRangeFromZone(sheetId, {

packages/o-spreadsheet-engine/src/plugins/core/merge.ts

@@ -117,8 +117,10 @@ export class MergePlugin extends CorePlugin<MergeState> implements MergeState {
     }
   }
 
-  adaptRanges(rangeAdapters: RangeAdapterFunctions, sheetId: UID) {
-    this.applyRangeChangeOnSheet(sheetId, rangeAdapters);
+  adaptRanges(rangeAdapters: RangeAdapterFunctions) {
+    for (const sheetId in this.merges) {
+      this.applyRangeChangeOnSheet(sheetId, rangeAdapters);
+    }
   }
 
   // ---------------------------------------------------------------------------

packages/o-spreadsheet-engine/src/plugins/core/range.ts

@@ -105,7 +105,7 @@ export class RangeAdapterPlugin implements CommandHandler<CoreCommand> {
         adaptFormulaStringRanges(defaultSheetId, formula, rangeAdapter),
     };
     for (const provider of this.providers) {
-      provider(adapterFunctions, rangeAdapter.sheetId, rangeAdapter.sheetName);
+      provider(adapterFunctions);
     }
     this.isAdaptingRanges = false;
   }

packages/o-spreadsheet-engine/src/plugins/core/tables.ts

@@ -52,9 +52,11 @@ export class TablePlugin extends CorePlugin<TableState> implements TableState {
   readonly tables: Record<UID, Record<TableId, CoreTable | undefined>> = {};
   readonly nextTableId: number = 1;
 
-  adaptRanges({ applyChange }: RangeAdapterFunctions, sheetId: UID) {
-    for (const table of this.getCoreTables(sheetId)) {
-      this.applyRangeChangeOnTable(sheetId, table, applyChange);
+  adaptRanges({ applyChange }: RangeAdapterFunctions) {
+    for (const sheetId in this.tables) {
+      for (const table of this.getCoreTables(sheetId)) {
+        this.applyRangeChangeOnTable(sheetId, table, applyChange);
+      }
     }
   }
 

packages/o-spreadsheet-engine/src/plugins/core_plugin.ts

@@ -1,7 +1,7 @@
 import { StateObserver } from "../state_observer";
 import { CoreCommand, CoreCommandDispatcher } from "../types/commands";
 import { CoreGetters } from "../types/core_getters";
-import { AdaptSheetName, RangeAdapterFunctions, RangeProvider, UID } from "../types/misc";
+import { RangeAdapterFunctions, RangeProvider } from "../types/misc";
 import { ModelConfig } from "../types/model";
 import { WorkbookData } from "../types/workbook_data";
 import { BasePlugin } from "./base_plugin";
@@ -62,9 +62,5 @@ export class CorePlugin<State = any>
    * @param sheetId an sheetId to adapt either range of that sheet specifically, or ranges pointing to that sheet
    * @param sheetName couple of old and new sheet names to adapt ranges pointing to that sheet
    */
-  adaptRanges(
-    rangeAdapterFunctions: RangeAdapterFunctions,
-    sheetId: UID,
-    sheetName: AdaptSheetName
-  ): void {}
+  adaptRanges(rangeAdapterFunctions: RangeAdapterFunctions): void {}
 }

packages/o-spreadsheet-engine/src/types/misc.ts

@@ -307,11 +307,7 @@ export type Dimension = "COL" | "ROW";
 export type ConsecutiveIndexes = HeaderIndex[];
 
 export interface RangeProvider {
-  adaptRanges: (
-    adapterFunctions: RangeAdapterFunctions,
-    sheetId: UID,
-    sheetName: AdaptSheetName
-  ) => void;
+  adaptRanges: (adapterFunctions: RangeAdapterFunctions) => void;
 }
 
 export type Validation<T> = (toValidate: T) => CommandResult | CommandResult[];