[IMP] web: field service: add loadFieldInfo and loadPathDescription

We remove the two hooks useLoadFieldInfo and useLoadPathDescription and
add two corresponding functions loadFieldInfo and loadPathDescription
in the field service.

Part-of: odoo#216038
Related: odoo/enterprise#88759
Signed-off-by: Michaël Mattiello (mcm) <[email protected]>

Author: Polymorphe57

addons/web/static/src/core/field_service.js

@@ -19,7 +19,13 @@ function getRelation(fieldDef, followRelationalProperties = false) {
 
 export const fieldService = {
     dependencies: ["orm"],
-    async: ["loadFields", "loadPath", "loadPropertyDefinitions"],
+    async: [
+        "loadFieldInfo",
+        "loadFields",
+        "loadPath",
+        "loadPropertyDefinitions",
+        "loadPathDescription",
+    ],
     start(env, { orm }) {
         /**
          * @param {string} resModel
@@ -154,7 +160,63 @@ export const fieldService = {
             return _loadPath(resModel, fieldDefs, path.split("."), followRelationalProperties);
         }
 
-        return { loadFields, loadPath, loadPropertyDefinitions };
+        /**
+         * @param {string} resModel
+         * @param {string} path
+         * @returns {Promise<Object>}
+         */
+        async function loadFieldInfo(resModel, path) {
+            if (typeof path !== "string" || !path || path === "*") {
+                return { resModel, fieldDef: null };
+            }
+            const { isInvalid, names, modelsInfo } = await loadPath(resModel, path);
+            if (isInvalid) {
+                return { resModel, fieldDef: null };
+            }
+            const name = names.at(-1);
+            const modelInfo = modelsInfo.at(-1);
+            return { resModel: modelInfo.resModel, fieldDef: modelInfo.fieldDefs[name] };
+        }
+
+        function makeString(value) {
+            return String(value ?? "-");
+        }
+
+        async function loadPathDescription(resModel, path, allowEmpty) {
+            if ([0, 1].includes(path)) {
+                return { isInvalid: false, displayNames: [makeString(path)] };
+            }
+            if (allowEmpty && !path) {
+                return { isInvalid: false, displayNames: [] };
+            }
+            if (typeof path !== "string" || !path || path === "*") {
+                return { isInvalid: true, displayNames: [makeString()] };
+            }
+            const { isInvalid, modelsInfo, names } = await loadPath(resModel, path);
+            const result = { isInvalid: !!isInvalid, displayNames: [] };
+            if (!isInvalid) {
+                const lastName = names.at(-1);
+                const lastFieldDef = modelsInfo.at(-1).fieldDefs[lastName];
+                if (["properties", "properties_definition"].includes(lastFieldDef.type)) {
+                    // there is no known case where we want to select a 'properties' field directly
+                    result.isInvalid = true;
+                }
+            }
+            for (let index = 0; index < names.length; index++) {
+                const name = names[index];
+                const fieldDef = modelsInfo[index]?.fieldDefs[name];
+                result.displayNames.push(fieldDef?.string || makeString(name));
+            }
+            return result;
+        }
+
+        return {
+            loadFieldInfo,
+            loadFields,
+            loadPath,
+            loadPathDescription,
+            loadPropertyDefinitions,
+        };
     },
 };
 

addons/web/static/src/core/model_field_selector/model_field_selector.js

@@ -1,8 +1,8 @@
 import { Component, onWillStart, onWillUpdateProps, useState } from "@odoo/owl";
+import { usePopover } from "@web/core/popover/popover_hook";
 import { KeepLast } from "@web/core/utils/concurrency";
+import { useService } from "@web/core/utils/hooks";
 import { ModelFieldSelectorPopover } from "./model_field_selector_popover";
-import { useLoadFieldInfo, useLoadPathDescription } from "./utils";
-import { usePopover } from "@web/core/popover/popover_hook";
 
 export class ModelFieldSelector extends Component {
     static template = "web._ModelFieldSelector";
@@ -33,13 +33,15 @@ export class ModelFieldSelector extends Component {
     };
 
     setup() {
-        this.loadPathDescription = useLoadPathDescription();
-        const loadFieldInfo = useLoadFieldInfo();
+        this.fieldService = useService("field");
         this.popover = usePopover(this.constructor.components.Popover, {
             popoverClass: "o_popover_field_selector",
             onClose: async () => {
                 if (this.newPath !== null) {
-                    const fieldInfo = await loadFieldInfo(this.props.resModel, this.newPath);
+                    const fieldInfo = await this.fieldService.loadFieldInfo(
+                        this.props.resModel,
+                        this.newPath
+                    );
                     this.props.update(this.newPath, fieldInfo);
                 }
             },
@@ -76,7 +78,7 @@ export class ModelFieldSelector extends Component {
 
     async updateState(params, isConcurrent) {
         const { resModel, path, allowEmpty } = params;
-        let prom = this.loadPathDescription(resModel, path, allowEmpty);
+        let prom = this.fieldService.loadPathDescription(resModel, path, allowEmpty);
         if (isConcurrent) {
             prom = this.keepLast.add(prom);
         }

addons/web/static/src/core/model_field_selector/utils.js

@@ -1,7 +1,6 @@
 import { Component, onWillStart, onWillUpdateProps } from "@odoo/owl";
 import { Dropdown } from "@web/core/dropdown/dropdown";
 import { DropdownItem } from "@web/core/dropdown/dropdown_item";
-import { useLoadFieldInfo } from "@web/core/model_field_selector/utils";
 import { cloneTree, connector, isTree, TRUE_TREE } from "@web/core/tree_editor/condition_tree";
 import {
     getDefaultValue,
@@ -49,7 +48,6 @@ export class TreeEditor extends Component {
         this.isTree = isTree;
         this.fieldService = useService("field");
         this.nameService = useService("name");
-        this.loadFieldInfo = useLoadFieldInfo(this.fieldService);
         this.makeGetFieldDef = useMakeGetFieldDef(this.fieldService);
         this.makeGetConditionDescription = useMakeGetConditionDescription(
             this.fieldService,
@@ -197,7 +195,7 @@ export class TreeEditor extends Component {
     }
 
     async _updatePath(node, path) {
-        const { fieldDef } = await this.loadFieldInfo(this.props.resModel, path);
+        const { fieldDef } = await this.fieldService.loadFieldInfo(this.props.resModel, path);
         node.path = path;
         node.negate = false;
         node.operator = this.props.getDefaultOperator(fieldDef);

addons/web/static/src/core/tree_editor/tree_editor.js

@@ -5,7 +5,6 @@ import {
     formatDateTime,
 } from "@web/core/l10n/dates";
 import { _t } from "@web/core/l10n/translation";
-import { useLoadFieldInfo, useLoadPathDescription } from "@web/core/model_field_selector/utils";
 import {
     condition,
     Expression,
@@ -80,15 +79,14 @@ export function disambiguate(value, displayNames) {
 
 export function useMakeGetFieldDef(fieldService) {
     fieldService ||= useService("field");
-    const loadFieldInfo = useLoadFieldInfo(fieldService);
     return async (resModel, tree, additionalsPath = []) => {
         const pathsInTree = getPathsInTree(tree, true);
         const paths = new Set([...pathsInTree, ...additionalsPath]);
         const promises = [];
         const fieldDefs = {};
         for (const path of paths) {
             promises.push(
-                loadFieldInfo(resModel, path).then(({ fieldDef }) => {
+                fieldService.loadFieldInfo(resModel, path).then(({ fieldDef }) => {
                     fieldDefs[path] = fieldDef;
                 })
             );
@@ -105,14 +103,13 @@ export function useMakeGetFieldDef(fieldService) {
 
 function useGetTreePathDescription(fieldService) {
     fieldService ||= useService("field");
-    const loadPathDescription = useLoadPathDescription(fieldService);
     return async (resModel, tree) => {
         const paths = getPathsInTree(tree);
         const promises = [];
         const pathDescriptions = new Map();
         for (const path of paths) {
             promises.push(
-                loadPathDescription(resModel, path).then(({ displayNames }) => {
+                fieldService.loadPathDescription(resModel, path).then(({ displayNames }) => {
                     pathDescriptions.set(path, displayNames.join(" \u2794 "));
                 })
             );