[IMP] model: avoid useless SET_FORMATTING

This commits adds a check for the command `SET_FORMATTING` to avoid
useless revisions when the command doesn't change the format/style of
any cell.

Task: 3149088
Part-of: #7241
Signed-off-by: Pierre Rousseau (pro) <pro@odoo.com>

Author: hokolomopo

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

@@ -3,7 +3,12 @@ import { PositionMap } from "../../helpers/cells/position_map";
 import { getItemId } from "../../helpers/data_normalization";
 import { recomputeZones } from "../../helpers/recompute_zones";
 import { intersection, isInside, positionToZone, toZone, zoneToXc } from "../../helpers/zones";
-import { AddColumnsRowsCommand, CoreCommand } from "../../types/commands";
+import {
+  AddColumnsRowsCommand,
+  CommandResult,
+  CoreCommand,
+  SetFormattingCommand,
+} from "../../types/commands";
 import {
   ApplyRangeChange,
   CellPosition,
@@ -47,6 +52,14 @@ export class StylePlugin extends CorePlugin<StylePluginState> implements StylePl
 
   readonly styles: Record<UID, ZoneStyle[] | undefined> = {};
 
+  allowDispatch(cmd: CoreCommand): CommandResult | CommandResult[] {
+    switch (cmd.type) {
+      case "SET_FORMATTING":
+        return this.checkUselessSetFormatting(cmd);
+    }
+    return CommandResult.Success;
+  }
+
   handle(cmd: CoreCommand) {
     switch (cmd.type) {
       case "ADD_MERGE":
@@ -329,4 +342,29 @@ export class StylePlugin extends CorePlugin<StylePluginState> implements StylePl
   exportForExcel(data: ExcelWorkbookData) {
     this.export(data);
   }
+
+  private checkUselessSetFormatting(cmd: SetFormattingCommand) {
+    const { sheetId, target } = cmd;
+    const hasStyle = "style" in cmd;
+    const hasFormat = "format" in cmd;
+    if (!hasStyle && !hasFormat) {
+      return CommandResult.NoChanges;
+    }
+    for (const zone of recomputeZones(target)) {
+      for (let col = zone.left; col <= zone.right; col++) {
+        for (let row = zone.top; row <= zone.bottom; row++) {
+          const position = { sheetId, col, row };
+          const cell = this.getters.getCell(position);
+          const style = this.getCellStyle(position);
+          if (
+            (hasStyle && !deepEquals(style, cmd.style)) ||
+            (hasFormat && cell?.format !== cmd.format)
+          ) {
+            return CommandResult.Success;
+          }
+        }
+      }
+    }
+    return CommandResult.NoChanges;
+  }
 }

tests/cells/style_plugin.test.ts

@@ -5,6 +5,7 @@ import {
 } from "@odoo/o-spreadsheet-engine/constants";
 import { Model } from "@odoo/o-spreadsheet-engine/model";
 import { DEFAULT_STYLE_NO_ALIGN } from "@odoo/o-spreadsheet-engine/plugins/core/style";
+import { CommandResult } from "../../src";
 import { fontSizeInPixels, toCartesian } from "../../src/helpers";
 import {
   addDataValidation,
@@ -19,6 +20,22 @@ import { getCell, getCellContent, getCellStyle } from "../test_helpers/getters_h
 import { createEqualCF, target, toRangesData } from "../test_helpers/helpers";
 
 describe("styles", () => {
+  test("update formatting with the same format as before", () => {
+    const model = new Model();
+    expect(setFormat(model, "A1", "#,##0.0")).toBeSuccessfullyDispatched();
+    expect(setFormat(model, "A1", "#,##0.0")).toBeCancelledBecause(CommandResult.NoChanges);
+    expect(setFormat(model, "A1:A2", "#,##0.0")).toBeSuccessfullyDispatched();
+    expect(setFormat(model, "A1:A2", "#,##0.0")).toBeCancelledBecause(CommandResult.NoChanges);
+  });
+
+  test("update style with the same style as before", () => {
+    const model = new Model();
+    expect(setStyle(model, "A1", { bold: true })).toBeSuccessfullyDispatched();
+    expect(setStyle(model, "A1", { bold: true })).toBeCancelledBecause(CommandResult.NoChanges);
+    expect(setStyle(model, "A1:A2", { bold: true })).toBeSuccessfullyDispatched();
+    expect(setStyle(model, "A1:A2", { bold: true })).toBeCancelledBecause(CommandResult.NoChanges);
+  });
+
   test("can undo and redo a setStyle operation on an empty cell", () => {
     const model = new Model();
     setStyle(model, "B1", { fillColor: "red" });