[MIG] spreadsheet_oca: Migration to 18.0

Author: chrisandrewmann

spreadsheet_oca/README.rst

@@ -7,7 +7,7 @@ Spreadsheet Oca
    !! This file is generated by oca-gen-addon-readme !!
    !! changes will be overwritten.                   !!
    !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
-   !! source digest: sha256:2e54effb5771467ddab39e872bcddddc5e7a900f7afb88dd3bb87ac26d195ca5
+   !! source digest: sha256:a7edc105b2730d126fc787ef8ef2c8c1d293b8e18e94402ff7db7d044ee863cd
    !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
 
 .. |badge1| image:: https://img.shields.io/badge/maturity-Beta-yellow.png

spreadsheet_oca/__manifest__.py

@@ -5,7 +5,7 @@
     "name": "Spreadsheet Oca",
     "summary": """
         Allow to edit spreadsheets""",
-    "version": "17.0.1.0.3",
+    "version": "18.0.1.0.0",
     "license": "AGPL-3",
     "author": "CreuBlanca,Odoo Community Association (OCA)",
     "website": "https://github.com/OCA/spreadsheet",
@@ -25,28 +25,19 @@
             "spreadsheet_oca/static/src/spreadsheet_tree/spreadsheet_tree_view.xml",
             "spreadsheet_oca/static/src/spreadsheet/spreadsheet.scss",
             "spreadsheet_oca/static/src/spreadsheet/spreadsheet_action.esm.js",
-            "spreadsheet_oca/static/src/spreadsheet/pivot_controller.esm.js",
-            "spreadsheet_oca/static/src/spreadsheet/graph_controller.esm.js",
             "spreadsheet_oca/static/src/spreadsheet/list_controller.esm.js",
             "spreadsheet_oca/static/src/spreadsheet/list_renderer.esm.js",
-            (
-                "after",
-                "web/static/src/views/graph/graph_controller.xml",
-                "spreadsheet_oca/static/src/spreadsheet/graph_controller.xml",
-            ),
-            (
-                "after",
-                "web/static/src/views/list/list_controller.xml",
-                "spreadsheet_oca/static/src/spreadsheet/list_controller.xml",
-            ),
-            (
-                "after",
-                "web/static/src/views/pivot/pivot_controller.xml",
-                "spreadsheet_oca/static/src/spreadsheet/pivot_controller.xml",
-            ),
+            "spreadsheet_oca/static/src/spreadsheet/list_controller.xml",
+        ],
+        "web.assets_backend_lazy": [
+            "spreadsheet_oca/static/src/spreadsheet/pivot_controller.esm.js",
+            "spreadsheet_oca/static/src/spreadsheet/graph_controller.esm.js",
+            "spreadsheet_oca/static/src/spreadsheet/pivot_controller.xml",
+            "spreadsheet_oca/static/src/spreadsheet/graph_controller.xml",
         ],
         "spreadsheet.o_spreadsheet": [
             "spreadsheet_oca/static/src/spreadsheet/bundle/spreadsheet.xml",
+            "spreadsheet_oca/static/src/spreadsheet/bundle/image_file_store.esm.js",
             "spreadsheet_oca/static/src/spreadsheet/bundle/filter.esm.js",
             "spreadsheet_oca/static/src/spreadsheet/bundle/filter_panel_datasources.esm.js",
             "spreadsheet_oca/static/src/spreadsheet/bundle/spreadsheet_renderer.esm.js",

spreadsheet_oca/migrations/17.0.1.0.0/pre-migrate.py

@@ -3,14 +3,18 @@
 
 import base64
 import json
+from typing import Any
 
 from odoo import _, api, fields, models
 from odoo.exceptions import AccessError
 
+CollaborationMessage = dict[str, Any]
+
 
 class SpreadsheetAbstract(models.AbstractModel):
     _name = "spreadsheet.abstract"
     _description = "Spreadsheet abstract for inheritance"
+    _inherit = ["bus.listener.mixin"]
 
     name = fields.Char(required=True)
     spreadsheet_binary_data = fields.Binary(
@@ -76,8 +80,7 @@ def get_spreadsheet_data(self):
         self.ensure_one()
         mode = "normal"
         try:
-            self.check_access_rights("write")
-            self.check_access_rule("write")
+            self.check_access("write")
         except AccessError:
             mode = "readonly"
         return {
@@ -106,11 +109,29 @@ def open_spreadsheet(self):
             "params": {"spreadsheet_id": self.id, "model": self._name},
         }
 
-    def send_spreadsheet_message(self, message):
+    def send_spreadsheet_message(
+        self, message: CollaborationMessage, access_token=None
+    ):
         self.ensure_one()
-        channel = (self.env.cr.dbname, "spreadsheet_oca", self._name, self.id)
-        message.update({"res_model": self._name, "res_id": self.id})
         if message["type"] in ["REVISION_UNDONE", "REMOTE_REVISION", "REVISION_REDONE"]:
+            self._check_access_spreadsheet("write")
+            self.env["spreadsheet.oca.revision"].create(
+                {
+                    "model": self._name,
+                    "res_id": self.id,
+                    "type": message["type"],
+                    "client_id": message.get("clientId"),
+                    "next_revision_id": message["nextRevisionId"],
+                    "server_revision_id": message["serverRevisionId"],
+                    "commands": json.dumps(
+                        self._build_spreadsheet_revision_commands_data(message)
+                    ),
+                }
+            )
+            self._bus_send("spreadsheet_oca", dict(message, id=self.id))
+            return True
+        elif message["type"] == "SNAPSHOT":
+            self._check_access_spreadsheet("write")
             self.env["spreadsheet.oca.revision"].create(
                 {
                     "model": self._name,
@@ -124,7 +145,18 @@ def send_spreadsheet_message(self, message):
                     ),
                 }
             )
-        self.env["bus.bus"]._sendone(channel, "spreadsheet_oca", message)
+            return True
+        elif message["type"] in ["CLIENT_JOINED", "CLIENT_LEFT", "CLIENT_MOVED"]:
+            self._check_access_spreadsheet("read")
+            self._bus_send("spreadsheet_oca", dict(message, id=self.id))
+            return True
+        return False
+
+    def _check_access_spreadsheet(self, operation: str):
+        try:
+            self.check_access(operation)
+        except AccessError as e:
+            raise e
         return True
 
     @api.model

spreadsheet_oca/models/spreadsheet_abstract.py

@@ -1,7 +1,6 @@
-/** @odoo-module */
 /* Copyright 2024 Tecnativa - Carlos Roca
  * License LGPL-3.0 or later (http://www.gnu.org/licenses/lgpl). */
-import {SpreadsheetPivotTable} from "@spreadsheet/pivot/pivot_table";
+import {SpreadsheetPivotTable} from "@odoo/o-spreadsheet";
 import {patch} from "@web/core/utils/patch";
 
 patch(SpreadsheetPivotTable.prototype, {

spreadsheet_oca/static/description/index.html

@@ -1,5 +1,3 @@
-/** @odoo-module */
-
 import * as spreadsheet from "@odoo/o-spreadsheet";
 import {patch} from "@web/core/utils/patch";
 

spreadsheet_oca/static/src/pivot/pivot_table.esm.js

@@ -1,15 +1,17 @@
-/** @odoo-module */
-
 import * as spreadsheet from "@odoo/o-spreadsheet";
 import {Domain} from "@web/core/domain";
-
 import {Many2XAutocomplete} from "@web/views/fields/relational_utils";
+import {_t} from "@web/core/l10n/translation";
 import {patch} from "@web/core/utils/patch";
 import {useService} from "@web/core/utils/hooks";
-import {_t} from "@web/core/l10n/translation";
 
-const {LineBarPieConfigPanel, ScorecardChartConfigPanel, GaugeChartConfigPanel} =
-    spreadsheet.components;
+const {
+    GenericChartConfigPanel,
+    LineConfigPanel,
+    BarConfigPanel,
+    ScorecardChartConfigPanel,
+    GaugeChartConfigPanel,
+} = spreadsheet.components;
 
 const menuChartProps = {
     setup() {
@@ -55,7 +57,6 @@ const menuChartProps = {
             return;
         }
         const menu = this.env.model.getters.getIrMenu(menuId[0].id);
-        console.log(menu);
         this.env.model.dispatch("LINK_ODOO_MENU_TO_CHART", {
             chartId: this.props.figureId,
             odooMenuId: menu.xmlid || menu.id,
@@ -77,9 +78,21 @@ const menuChartProps = {
     },
 };
 
-patch(LineBarPieConfigPanel.prototype, menuChartProps);
-LineBarPieConfigPanel.components = {
-    ...LineBarPieConfigPanel.components,
+patch(GenericChartConfigPanel.prototype, menuChartProps);
+GenericChartConfigPanel.components = {
+    ...GenericChartConfigPanel.components,
+    Many2XAutocomplete,
+};
+
+patch(LineConfigPanel.prototype, menuChartProps);
+LineConfigPanel.components = {
+    ...LineConfigPanel.components,
+    Many2XAutocomplete,
+};
+
+patch(BarConfigPanel.prototype, menuChartProps);
+BarConfigPanel.components = {
+    ...BarConfigPanel.components,
     Many2XAutocomplete,
 };
 

spreadsheet_oca/static/src/spreadsheet/bundle/chart_panel.esm.js

@@ -1,12 +1,12 @@
-/** @odoo-module **/
-
 import * as spreadsheet from "@odoo/o-spreadsheet";
 import {Component, onWillStart, useState} from "@odoo/owl";
-import {_lt, _t} from "@web/core/l10n/translation";
+
 import {FilterValue} from "@spreadsheet/global_filters/components/filter_value/filter_value";
 import {ModelFieldSelector} from "@web/core/model_field_selector/model_field_selector";
 import {ModelSelector} from "@web/core/model_selector/model_selector";
 import {RELATIVE_DATE_RANGE_TYPES} from "@spreadsheet/helpers/constants";
+
+import {_t} from "@web/core/l10n/translation";
 import {globalFiltersFieldMatchers} from "@spreadsheet/global_filters/plugins/global_filters_core_plugin";
 import {useService} from "@web/core/utils/hooks";
 
@@ -123,10 +123,10 @@ export class EditFilterPanel extends Component {
     get dateOffset() {
         return [
             {value: 0, name: ""},
-            {value: -1, name: _lt("Previous")},
-            {value: -2, name: _lt("Before Previous")},
-            {value: 1, name: _lt("Next")},
-            {value: 2, name: _lt("After next")},
+            {value: -1, name: _t("Previous")},
+            {value: -2, name: _t("Before Previous")},
+            {value: 1, name: _t("Next")},
+            {value: 2, name: _t("After next")},
         ];
     }
     onChangeFieldMatchOffset(object, ev) {
@@ -144,26 +144,25 @@ export class EditFilterPanel extends Component {
         const action = this.props.filter.id
             ? "EDIT_GLOBAL_FILTER"
             : "ADD_GLOBAL_FILTER";
-        this.env.openSidePanel("FilterPanel", {});
-        var filter = {
+
+        const filter = {
             id: this.props.filter.id || uuidGenerator.uuidv4(),
             type: this.state.type,
             label: this.state.label,
             defaultValue: this.state.defaultValue,
             rangeType: this.state.rangeType,
             modelName: this.state.modelName.technical,
         };
-        var filterMatching = {};
+        const filterMatching = {};
         Object.values(this.state.objects).forEach((object) => {
             filterMatching[object.type] = filterMatching[object.type] || {};
-            filterMatching[object.type][object.objectId] = {...object.fieldMatch};
+            const fieldMatch = object.fieldMatch ? {...object.fieldMatch} : {};
+            filterMatching[object.type][object.objectId] = fieldMatch;
         });
         this.env.model.dispatch(action, {
-            id: filter.id,
             filter,
             ...filterMatching,
         });
-
         this.env.openSidePanel("FilterPanel", {});
     }
     onCancel() {
@@ -177,13 +176,54 @@ export class EditFilterPanel extends Component {
         }
         this.env.openSidePanel("FilterPanel", {});
     }
-    onFieldMatchUpdate(object, name) {
-        this.state.objects[object.id].fieldMatch.chain = name;
-        this.state.objects[object.id].fieldMatch.type = object.fields[name]?.type;
+    onFieldMatchUpdate(object, path, fieldInfo) {
+        if (!path) {
+            // Clear the field match if no path selected
+            this.state.objects[object.id].fieldMatch = {};
+            return;
+        }
+        // Extract field definition from fieldInfo (V18> structure)
+        const fieldDef =
+            fieldInfo && fieldInfo.fieldDef ? fieldInfo.fieldDef : fieldInfo;
+        this.state.objects[object.id].fieldMatch = {
+            chain: path,
+            type: fieldDef?.type || "",
+        };
     }
     toggleDateDefaultValue(ev) {
         this.state.defaultValue = ev.target.checked ? "this_month" : undefined;
     }
+    getModelField(fieldMatch) {
+        if (!fieldMatch || !fieldMatch.chain) {
+            return "";
+        }
+        return fieldMatch.chain;
+    }
+    filterModelFieldSelectorField(field, path, coModel) {
+        if (!field.searchable) {
+            return false;
+        }
+
+        // TODO: Define allowed field types based on filter type
+        const ALLOWED_FIELD_TYPES = [
+            "char",
+            "text",
+            "selection",
+            "many2one",
+            "date",
+            "datetime",
+        ];
+
+        if (field.name === "id" && this.state.type === "relation") {
+            const paths = path.split(".");
+            const lastField = paths.at(-2);
+            if (!lastField || (lastField.relation && lastField.relation === coModel)) {
+                return true;
+            }
+            return false;
+        }
+        return ALLOWED_FIELD_TYPES.includes(field.type) || Boolean(field.relation);
+    }
 }
 
 EditFilterPanel.template = "spreadsheet_oca.EditFilterPanel";