Merge pull request #241 from oarepo/miroslavsimek/be-494-refactor-cus…

…tom-fields-to-uiresource-component

Refactored custom fields handling to a component

oarepo_ui/resources/__init__.py

@@ -8,4 +8,6 @@
     "RecordsUIResource",
     "UIResourceConfig",
     "RecordsUIResourceConfig",
+    "PermissionsComponent",
+    "BabelComponent"
 )

oarepo_ui/resources/components/__init__.py

@@ -1,15 +1,15 @@
-from .base import UIResourceComponent
 from .babel import BabelComponent
+from .base import UIResourceComponent
 from .bleach import AllowedHtmlTagsComponent
+from .communities import AllowedCommunitiesComponent
 from .files import FilesComponent
 from .permissions import PermissionsComponent
-from .communities import AllowedCommunitiesComponent
 
 __all__ = (
     "UIResourceComponent",
     "PermissionsComponent",
     "AllowedHtmlTagsComponent",
     "BabelComponent",
     "FilesComponent",
-    "AllowedCommunitiesComponent"
-)
+    "AllowedCommunitiesComponent",
+)

oarepo_ui/resources/components/base.py

@@ -1,4 +1,4 @@
-from typing import Dict, TYPE_CHECKING
+from typing import TYPE_CHECKING, Dict
 
 from flask_principal import Identity
 from invenio_records_resources.services.records.results import RecordItem

oarepo_ui/resources/components/bleach.py

@@ -1,5 +1,5 @@
 from flask import current_app
-from invenio_config.default import ALLOWED_HTML_TAGS, ALLOWED_HTML_ATTRS
+from invenio_config.default import ALLOWED_HTML_ATTRS, ALLOWED_HTML_TAGS
 
 from .base import UIResourceComponent
 

oarepo_ui/resources/components/communities.py

@@ -2,13 +2,10 @@
 
 from flask_principal import Identity
 from invenio_communities.communities.records.api import Community
+from invenio_records_resources.services.errors import PermissionDeniedError
 from oarepo_runtime.i18n import lazy_gettext as _
 
-
 from .base import UIResourceComponent
-from invenio_records_resources.services.errors import (
-    PermissionDeniedError,
-)
 
 
 class AllowedCommunitiesComponent(UIResourceComponent):
@@ -105,8 +102,8 @@ def user_has_permission(self, identity, community, action):
         )
 
     def check_user_permissions(self, community_id, workflow, identity, action):
-        from oarepo_workflows.proxies import current_oarepo_workflows
         from oarepo_workflows.errors import InvalidWorkflowError
+        from oarepo_workflows.proxies import current_oarepo_workflows
 
         if workflow not in current_oarepo_workflows.record_workflows:
             raise InvalidWorkflowError(

oarepo_ui/resources/components/custom_fields.py

@@ -0,0 +1,35 @@
+from typing import Dict
+
+from flask_principal import Identity
+from invenio_records_resources.services.records.results import RecordItem
+
+from oarepo_ui.resources.components import UIResourceComponent
+
+
+class CustomFieldsComponent(UIResourceComponent):
+    def form_config(
+        self,
+        *,
+        api_record: RecordItem = None,
+        record: Dict = None,
+        data: Dict = None,
+        identity: Identity,
+        form_config: Dict,
+        args: Dict,
+        view_args: Dict,
+        ui_links: Dict = None,
+        extra_context: Dict = None,
+        **kwargs,
+    ):
+        if hasattr(self.resource.config, "custom_fields"):
+            form_config["custom_fields"] = self.resource.config.custom_fields(
+                identity=identity,
+                api_record=api_record,
+                record=record,
+                data=data,
+                form_config=form_config,
+                args=args,
+                view_args=view_args,
+                ui_links=ui_links,
+                extra_context=extra_context,
+            )

oarepo_ui/resources/components/permissions.py

@@ -1,5 +1,5 @@
-from .base import UIResourceComponent
 from ...proxies import current_oarepo_ui
+from .base import UIResourceComponent
 
 
 class PermissionsComponent(UIResourceComponent):

oarepo_ui/resources/resource.py

@@ -4,7 +4,7 @@
 from typing import TYPE_CHECKING, Iterator
 
 import deepmerge
-from flask import abort, g, redirect, request, Response
+from flask import Response, abort, g, redirect, request
 from flask_principal import PermissionDenied
 from flask_resources import (
     Resource,
@@ -30,14 +30,17 @@
 from werkzeug.exceptions import Forbidden
 
 from oarepo_ui.utils import dump_empty
-from .signposting import response_header_signposting
 
+from .components.custom_fields import CustomFieldsComponent
+from .signposting import response_header_signposting
 from .templating.data import FieldData
 
 if TYPE_CHECKING:
     from .components import UIResourceComponent
 
 #
+import logging
+
 # Resource
 #
 from ..proxies import current_oarepo_ui
@@ -48,6 +51,8 @@
     UIResourceConfig,
 )
 
+log = logging.getLogger(__name__)
+
 request_export_args = request_parser(
     from_conf("request_export_args"), location="view_args"
 )
@@ -64,10 +69,26 @@ class UIComponentsMixin:
     #
     # Pluggable components
     #
+    config: UIResourceConfig
 
     @property
     def components(self) -> Iterator["UIResourceComponent"]:
         """Return initialized service components."""
+
+        # TODO: just for deprecation, will be removed later
+        for c in self.config.components or []:
+            if isinstance(c, CustomFieldsComponent):
+                break
+        else:
+            log.warning(
+                "CustomFieldsComponent not found in components, adding it to be backwards compatible."
+            )
+            if not self.config.components:
+                self.config.components = []
+            if isinstance(self.config.components, tuple):
+                self.config.components = list(self.config.components)
+            self.config.components.append(CustomFieldsComponent)
+
         return (c(self) for c in self.config.components or [])
 
     def run_components(self, action, *args, **kwargs):
@@ -240,9 +261,6 @@ def _detail(self, *, is_preview=False):
             args=resource_requestctx.args,
             view_args=resource_requestctx.view_args,
             ui_links=ui_links,
-            custom_fields=self._get_custom_fields(
-                api_record=api_record, resource_requestctx=resource_requestctx
-            ),
             is_preview=is_preview,
         )
 
@@ -260,10 +278,14 @@ def _detail(self, *, is_preview=False):
             "is_preview": is_preview,
         }
 
-        response = Response(current_oarepo_ui.catalog.render(
-            render_method,
-            **render_kwargs,
-        ), mimetype="text/html", status=200)
+        response = Response(
+            current_oarepo_ui.catalog.render(
+                render_method,
+                **render_kwargs,
+            ),
+            mimetype="text/html",
+            status=200,
+        )
         response._api_record = api_record
         return response
 
@@ -464,10 +486,6 @@ def edit(self):
             g.identity, updateUrl=api_record.links.get("self", None)
         )
 
-        form_config["custom_fields"] = self._get_custom_fields(
-            api_record=api_record, resource_requestctx=resource_requestctx
-        )
-
         form_config["ui_model"] = self.ui_model
 
         ui_links = self.expand_detail_links(identity=g.identity, record=api_record)
@@ -521,9 +539,6 @@ def edit(self):
             d=FieldData(record, self.ui_model),
         )
 
-    def _get_custom_fields(self, **kwargs):
-        return self.config.custom_fields(identity=g.identity, **kwargs)
-
     def _get_form_config(self, identity, **kwargs):
         return self.config.form_config(identity=identity, **kwargs)
 
@@ -541,9 +556,6 @@ def create(self):
         form_config = self._get_form_config(
             g.identity, createUrl=f"/api{self.api_service.config.url_prefix}"
         )
-        form_config["custom_fields"] = self._get_custom_fields(
-            resource_requestctx=resource_requestctx
-        )
 
         form_config["ui_model"] = self.ui_model
 

oarepo_ui/resources/signposting.py

@@ -18,7 +18,7 @@ def inner(*args, **kwargs):
         if not hasattr(response, "_api_record"):
             return response
 
-        signposting_link = response._api_record.links['self']
+        signposting_link = response._api_record.links["self"]
         response.headers.update(
             {
                 "Link": f'<{signposting_link}> ; rel="linkset" ; type="application/linkset+json"',  # noqa

setup.cfg

@@ -1,6 +1,6 @@
 [metadata]
 name = oarepo-ui
-version = 5.2.14
+version = 5.2.15
 description = UI module for invenio 3.5+
 long_description = file: README.md
 long_description_content_type = text/markdown

tests/conftest.py

@@ -34,12 +34,12 @@ def extra_entry_points():
 def app_config(app_config):
     app_config["I18N_LANGUAGES"] = [("cs", "Czech")]
     app_config["BABEL_DEFAULT_LOCALE"] = "en"
-    app_config[
-        "RECORDS_REFRESOLVER_CLS"
-    ] = "invenio_records.resolver.InvenioRefResolver"
-    app_config[
-        "RECORDS_REFRESOLVER_STORE"
-    ] = "invenio_jsonschemas.proxies.current_refresolver_store"
+    app_config["RECORDS_REFRESOLVER_CLS"] = (
+        "invenio_records.resolver.InvenioRefResolver"
+    )
+    app_config["RECORDS_REFRESOLVER_STORE"] = (
+        "invenio_jsonschemas.proxies.current_refresolver_store"
+    )
 
     # for ui tests
     app_config["APP_THEME"] = ["semantic-ui"]

tests/model.py

@@ -21,8 +21,9 @@
 
 from oarepo_ui.resources import (
     BabelComponent,
+    PermissionsComponent,
     RecordsUIResource,
-    RecordsUIResourceConfig, PermissionsComponent,
+    RecordsUIResourceConfig,
 )
 from oarepo_ui.resources.components.bleach import AllowedHtmlTagsComponent
 from oarepo_ui.resources.config import TemplatePageUIResourceConfig

tests/test_create.py

@@ -1,5 +1,6 @@
 import json
-from invenio_config.default import ALLOWED_HTML_TAGS, ALLOWED_HTML_ATTRS
+
+from invenio_config.default import ALLOWED_HTML_ATTRS, ALLOWED_HTML_TAGS
 
 
 def test_create(

tests/test_edit.py

@@ -1,5 +1,6 @@
 import json
-from invenio_config.default import ALLOWED_HTML_TAGS, ALLOWED_HTML_ATTRS
+
+from invenio_config.default import ALLOWED_HTML_ATTRS, ALLOWED_HTML_TAGS
 
 
 def test_edit(

tests/test_ui_resource_config.py

@@ -1,5 +1,5 @@
 from invenio_access.permissions import system_identity
-from invenio_config.default import ALLOWED_HTML_TAGS, ALLOWED_HTML_ATTRS
+from invenio_config.default import ALLOWED_HTML_ATTRS, ALLOWED_HTML_TAGS
 
 
 def test_ui_resource_form_config(app, test_record_ui_resource):
@@ -52,4 +52,13 @@ def test_ui_resource_form_config(app, test_record_ui_resource):
             "can_update_files": False,
             "can_view": False,
         },
+        custom_fields={
+            "ui": [
+                {"fields": [{"field": "bbb", "ui_widget": "Input"}], "section": "B"},
+                {
+                    "fields": [{"field": "nested_cf.aaa", "ui_widget": "Input"}],
+                    "section": "A",
+                },
+            ]
+        },
     )