[FIX] xlsx: do not export dynamic tables to excel

Excel does not support array formulas inside tables. With this commit,
if a table contains an array formula, it will not be exported to excel
but be exported as individual cell styles instead.

closes #8167

Task: 5214240
X-original-commit: f915568
Signed-off-by: Adrien Minne (adrm) <adrm@odoo.com>
Signed-off-by: Rémi Rahir (rar) <rar@odoo.com>

Author: hokolomopo

packages/o-spreadsheet-engine/src/plugins/ui_core_views/dynamic_tables.ts

@@ -1,21 +1,23 @@
 import { CellPosition, FilterId, TableId, UID, Zone } from "../..";
-import { deepEquals } from "../../helpers/misc";
+import { toXC } from "../../helpers/coordinates";
+import { getItemId } from "../../helpers/data_normalization";
+import { deepEquals, isObjectEmptyRecursive } from "../../helpers/misc";
 import { createFilter } from "../../helpers/table_helpers";
 import {
   areZonesContinuous,
   getZoneArea,
   isInside,
   overlap,
+  positions,
   positionToZone,
   toZone,
   union,
-  zoneToXc,
 } from "../../helpers/zones";
 import { Command, invalidateEvaluationCommands } from "../../types/commands";
 import { CellErrorType } from "../../types/errors";
 import { PivotStyle } from "../../types/pivot";
 import { CoreTable, DynamicTable, Filter, Table, TableConfig } from "../../types/table";
-import { ExcelWorkbookData } from "../../types/workbook_data";
+import { ExcelTableData, ExcelWorkbookData } from "../../types/workbook_data";
 
 import { CoreViewPlugin } from "../core_view_plugin";
 
@@ -293,19 +295,51 @@ export class DynamicTablesPlugin extends CoreViewPlugin {
     return tableId + "_" + tableCol;
   }
 
+  /** Check if a table contains array formula, as we cannot have them in a table in Excel */
+  private isTableExcelExportable(sheetId: UID, table: CoreTable): boolean {
+    if (table.type === "dynamic") {
+      return false;
+    }
+
+    return !positions(table.range.zone).some((position) =>
+      this.getters.getArrayFormulaSpreadingOn({ sheetId, ...position })
+    );
+  }
+
   exportForExcel(data: ExcelWorkbookData) {
     for (const sheet of data.sheets) {
+      const exportedTables: ExcelTableData[] = [];
       for (const tableData of sheet.tables) {
         const zone = toZone(tableData.range);
         const topLeft = { sheetId: sheet.id, col: zone.left, row: zone.top };
         const coreTable = this.getters.getCoreTable(topLeft);
         const table = this.getTable(topLeft);
 
-        if (coreTable?.type !== "dynamic" || !table) {
+        if (!coreTable || !table || this.isTableExcelExportable(sheet.id, coreTable)) {
+          exportedTables.push(tableData);
           continue;
         }
-        tableData.range = zoneToXc(table.range.zone);
+        sheet.styles = sheet.styles || {};
+        sheet.borders = sheet.borders || {};
+
+        // If the table is not exportable to excel, we apply the cell styles to individual cells instead
+        for (const position of positions(table.range.zone)) {
+          const cellPosition = { sheetId: sheet.id, ...position };
+          const style = this.getters.getCellComputedStyle(cellPosition);
+          const border = this.getters.getCellComputedBorder(cellPosition);
+          const xc = toXC(position.col, position.row);
+          if (!isObjectEmptyRecursive(style)) {
+            const styleId = getItemId(style, data.styles);
+            sheet.styles[xc] = styleId;
+          }
+
+          if (border) {
+            const borderId = getItemId(border, data.borders);
+            sheet.borders[xc] = borderId;
+          }
+        }
       }
+      sheet.tables = exportedTables;
     }
   }
 }

tests/table/dynamic_table_plugin.test.ts

@@ -1,6 +1,6 @@
 import { Model } from "../../src";
 import { toZone } from "../../src/helpers";
-import { UID } from "../../src/types";
+import { BorderDescr, UID } from "../../src/types";
 import {
   copy,
   createDynamicTable,
@@ -235,12 +235,37 @@ describe("Dynamic tables", () => {
       expect(getTables(model, sheetId)).toMatchObject([{ zone: "A1:B2" }]);
     });
 
-    test("Dynamic tables are transformed into static tables when exporting for excel", async () => {
-      setCellContent(model, "A1", "=MUNIT(3)");
-      createDynamicTable(model, "A1");
+    test("Dynamic table is exported as individual cell style to Excel", async () => {
+      setCellContent(model, "A1", "=MUNIT(2)");
+      createDynamicTable(model, "A1", { styleId: "TableStyleLight8" });
+
+      const exported = await getExportedExcelData(model);
+      const sheetData = exported.sheets[0];
+      expect(sheetData.tables).toHaveLength(0);
+      expect(exported.styles).toEqual({
+        "1": { fillColor: "#000000", textColor: "#FFFFFF", bold: true },
+      });
+      const border: BorderDescr = { color: "#000000", style: "thin" };
+      expect(exported.borders).toEqual({
+        "1": { top: border, left: border, bottom: border },
+        "2": { top: border, bottom: border, right: border },
+      });
+      expect(sheetData.borders).toEqual({ A1: 1, A2: 1, B1: 2, B2: 2 });
+      expect(sheetData.styles).toEqual({ A1: 1, B1: 1 });
+    });
+
+    test("Tables that contains an array formula are also exported as individual cell styles", async () => {
+      setCellContent(model, "A2", "=MUNIT(2)");
+      createTable(model, "A1:B3", { styleId: "TableStyleLight8" });
 
       const exported = await getExportedExcelData(model);
-      expect(exported.sheets[0].tables).toMatchObject([{ range: "A1:C3" }]);
+      const sheetData = exported.sheets[0];
+      expect(sheetData.tables).toHaveLength(0);
+      expect(exported.styles).toEqual({
+        "1": { fillColor: "#000000", textColor: "#FFFFFF", bold: true },
+      });
+
+      expect(sheetData.styles).toEqual({ A1: 1, B1: 1 });
     });
   });