oarepo-workflows 2.0.0.dev6__tar.gz → 2.0.0.dev8__tar.gz

{oarepo_workflows-2.0.0.dev6 → oarepo_workflows-2.0.0.dev8}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: oarepo-workflows
-Version: 2.0.0.dev6
+Version: 2.0.0.dev8
 Summary: OARepo module allowing record workflow functionality
 Project-URL: Homepage, https://github.com/oarepo/oarepo-workflows
 Author-email: Ronald Krist <krist@cesnet.cz>

{oarepo_workflows-2.0.0.dev6 → oarepo_workflows-2.0.0.dev8}/oarepo_workflows/__init__.py

@@ -13,7 +13,7 @@ from oarepo_workflows.services.permissions import (
     FromRecordWorkflow,
     IfInState,
     WorkflowPermission,
-    WorkflowRecordPermissionPolicy,
+    WorkflowRecordPermissionPolicyMixin,
 )
 
 from .base import Workflow
@@ -27,7 +27,7 @@ from .requests import (
     WorkflowTransitions,
 )
 
-__version__ = "2.0.0dev6"
+__version__ = "2.0.0dev8"
 """Version of the library."""
 
 
@@ -38,7 +38,7 @@ __all__ = (
     "IfInState",
     "Workflow",
     "WorkflowPermission",
-    "WorkflowRecordPermissionPolicy",
+    "WorkflowRecordPermissionPolicyMixin",
     "WorkflowRequest",
     "WorkflowRequestEscalation",
     "WorkflowRequestPolicy",

{oarepo_workflows-2.0.0.dev6 → oarepo_workflows-2.0.0.dev8}/oarepo_workflows/base.py

@@ -12,7 +12,7 @@ from __future__ import annotations
 import dataclasses
 from typing import TYPE_CHECKING, Any, Protocol
 
-from . import WorkflowRecordPermissionPolicy
+from . import WorkflowRecordPermissionPolicyMixin
 from .requests import WorkflowRequestPolicy
 from .services.permissions import DefaultWorkflowPermissions
 
@@ -48,7 +48,7 @@ class Workflow:
 
     def requests(self) -> WorkflowRequestPolicy:
         """Return instance of request policy for this workflow."""
-        return self.request_policy_cls()
+        return self.request_policy_cls(self)
 
     @property
     def permission_policy_with_requests_cls(self) -> type[DefaultWorkflowPermissions]:
@@ -69,7 +69,7 @@ class Workflow:
 
         This is just a sanity check to raise an error as soon as possible.
         """
-        if issubclass(self.permission_policy_cls, WorkflowRecordPermissionPolicy):
+        if issubclass(self.permission_policy_cls, WorkflowRecordPermissionPolicyMixin):
             raise TypeError(
                 f"Workflow permission policy {self.permission_policy_cls} is not a "
                 f"subclass of WorkflowRecordPermissionPolicy."

{oarepo_workflows-2.0.0.dev6 → oarepo_workflows-2.0.0.dev8}/oarepo_workflows/errors.py

@@ -76,22 +76,20 @@ class InvalidConfigurationError(Exception):
     """Exception raised when a configuration is invalid."""
 
 
-class EventTypeNotInWorkflowError(Exception):
+class EventTypeNotInWorkflowError(KeyError):
     """Exception raised when user tries to create a request with a request type that is not defined in the workflow."""
 
-    def __init__(self, request_type: str, event_type: str, workflow_code: str) -> None:
+    def __init__(self, event_type: str) -> None:
         """Initialize the exception."""
-        self.request_type = request_type
-        self.workflow = workflow_code
         self.event_type = event_type
 
     @property
     def description(self) -> str:
         """Exception's description."""
-        return f"Event type {self.event_type} is not on request type {self.request_type} in workflow {self.workflow}."
+        return f"Event type {self.event_type} is not set in a workflow."
 
 
-class RequestTypeNotInWorkflowError(Exception):
+class RequestTypeNotInWorkflowError(KeyError):
     """Exception raised when user tries to create a request with a request type that is not defined in the workflow."""
 
     def __init__(self, request_type: str, workflow_code: str) -> None:

{oarepo_workflows-2.0.0.dev6 → oarepo_workflows-2.0.0.dev8}/oarepo_workflows/ext.py

@@ -15,6 +15,7 @@ from typing import TYPE_CHECKING, Any, cast
 
 from invenio_records_resources.services.uow import unit_of_work
 
+from oarepo_workflows import current_oarepo_workflows
 from oarepo_workflows.errors import (
     InvalidWorkflowError,
     MissingWorkflowError,
@@ -67,6 +68,7 @@ class OARepoWorkflows:
         from . import ext_config
 
         app.config.setdefault("WORKFLOWS", ext_config.WORKFLOWS)
+        app.config.setdefault("WORKFLOWS_DEFAULT_WORKFLOW", ext_config.WORKFLOWS_DEFAULT_WORKFLOW)
         app.config.setdefault("REQUESTS_ALLOWED_RECEIVERS", []).extend(ext_config.WORKFLOWS_ALLOWED_REQUEST_RECEIVERS)
 
     def init_app(self, app: Flask) -> None:
@@ -150,6 +152,18 @@ class OARepoWorkflows:
             self.app.config.get("DEFAULT_WORKFLOW_EVENTS", {}),
         )
 
+    @property
+    def default_workflow(self) -> Workflow:
+        """Return the default workflow."""
+        try:
+            return self.workflow_by_code[self.app.config["WORKFLOWS_DEFAULT_WORKFLOW"]]
+        except KeyError as exc:
+            raise MissingWorkflowError(
+                f"Default workflow is needed to run but there is no {self.app.config['WORKFLOWS_DEFAULT_WORKFLOW']} "
+                f"defined. Please define this workflow or change WORKFLOWS_DEFAULT_WORKFLOW to point "
+                f"to the default workflow."
+            ) from exc
+
     def get_workflow(self, record: Record | dict[str, Any]) -> Workflow:
         """Get the workflow for a record.
 
@@ -179,6 +193,7 @@ class OARepoWorkflows:
             except KeyError as e:
                 raise MissingWorkflowError("Parent record does not have a workflow attribute.", record=record) from e
         try:
+            workflow_id = workflow_id or current_oarepo_workflows.default_workflow.code
             return self.workflow_by_code[workflow_id]
         except KeyError as e:
             raise InvalidWorkflowError(

{oarepo_workflows-2.0.0.dev6 → oarepo_workflows-2.0.0.dev8}/oarepo_workflows/ext_config.py

@@ -20,3 +20,5 @@ WORKFLOWS: dict[str, Workflow] = {}
 """Configuration of workflows, must be provided by the user inside, for example, invenio.cfg."""
 
 WORKFLOWS_ALLOWED_REQUEST_RECEIVERS = ["multiple"]
+
+WORKFLOWS_DEFAULT_WORKFLOW = "individual"

{oarepo_workflows-2.0.0.dev6 → oarepo_workflows-2.0.0.dev8}/oarepo_workflows/model/presets/services/records/permission_policy.py

@@ -17,18 +17,16 @@ from __future__ import annotations
 
 from typing import TYPE_CHECKING, Any, override
 
-from invenio_records_permissions.policies.records import RecordPermissionPolicy
-from oarepo_model.customizations import Customization, ReplaceBaseClass
+from oarepo_model.customizations.prepend_mixin import PrependMixin
 from oarepo_model.presets import Preset
 
-from oarepo_workflows.services.permissions.record_permission_policy import (
-    WorkflowRecordPermissionPolicy,
-)
+from oarepo_workflows.services.permissions import WorkflowRecordPermissionPolicyMixin
 
 if TYPE_CHECKING:
     from collections.abc import Generator
 
     from oarepo_model.builder import InvenioModelBuilder
+    from oarepo_model.customizations import Customization
     from oarepo_model.model import InvenioModel
 
 
@@ -44,9 +42,4 @@ class WorkflowsPermissionPolicyPreset(Preset):
         model: InvenioModel,
         dependencies: dict[str, Any],
     ) -> Generator[Customization]:
-        yield ReplaceBaseClass(
-            "PermissionPolicy",
-            RecordPermissionPolicy,
-            WorkflowRecordPermissionPolicy,
-            subclass=True,
-        )
+        yield PrependMixin("PermissionPolicy", WorkflowRecordPermissionPolicyMixin)

{oarepo_workflows-2.0.0.dev6 → oarepo_workflows-2.0.0.dev8}/oarepo_workflows/requests/events.py

@@ -11,8 +11,9 @@ from __future__ import annotations
 
 import dataclasses
 from functools import cached_property
-from typing import TYPE_CHECKING
+from typing import TYPE_CHECKING, NoReturn
 
+from oarepo_workflows.errors import EventTypeNotInWorkflowError
 from oarepo_workflows.requests.generators.multiple_entities import (
     MultipleEntitiesGenerator,
 )
@@ -39,3 +40,11 @@ class WorkflowEvent:
     def submitter_generator(self) -> Generator:
         """Return the requesters as a single requester generator."""
         return MultipleEntitiesGenerator(self.submitters)
+
+
+class WorkflowEvents(dict[str, WorkflowEvent]):
+    """Class representing a collection of workflow events."""
+
+    def __missing__(self, key: str) -> NoReturn:
+        """Raise EventTypeNotInWorkflowError when a key is not found."""
+        raise EventTypeNotInWorkflowError(key)

{oarepo_workflows-2.0.0.dev6 → oarepo_workflows-2.0.0.dev8}/oarepo_workflows/requests/policy.py

@@ -12,6 +12,7 @@ from __future__ import annotations
 from functools import cached_property
 from typing import TYPE_CHECKING, Any
 
+from ..errors import RequestTypeNotInWorkflowError
 from .requests import (
     WorkflowRequest,
 )
@@ -20,6 +21,8 @@ if TYPE_CHECKING:
     from flask_principal import Identity
     from invenio_records_resources.records.api import Record
 
+    from .. import Workflow
+
 
 class WorkflowRequestPolicy:
     """Base class for workflow request policies.
@@ -48,6 +51,10 @@ class WorkflowRequestPolicy:
 
     """
 
+    def __init__(self, workflow: Workflow) -> None:
+        """Create the policy."""
+        self.workflow = workflow
+
     @cached_property
     def requests(self) -> list[WorkflowRequest]:
         """Return the list of request types and their instances.
@@ -71,7 +78,10 @@ class WorkflowRequestPolicy:
 
     def __getitem__(self, request_type_id: str) -> WorkflowRequest:
         """Get the workflow request type by its id."""
-        return self.requests_by_id[request_type_id]
+        try:
+            return self.requests_by_id[request_type_id]
+        except KeyError as exc:
+            raise RequestTypeNotInWorkflowError(request_type_id, self.workflow.code) from exc
 
     def applicable_workflow_requests(
         self, identity: Identity, *, record: Record, **context: Any

{oarepo_workflows-2.0.0.dev6 → oarepo_workflows-2.0.0.dev8}/oarepo_workflows/requests/requests.py

@@ -21,6 +21,7 @@ from invenio_requests.proxies import (
 
 from oarepo_workflows.errors import InvalidConfigurationError
 from oarepo_workflows.proxies import current_oarepo_workflows
+from oarepo_workflows.requests.events import WorkflowEvents
 from oarepo_workflows.requests.generators.multiple_entities import (
     MultipleEntitiesGenerator,
 )
@@ -37,6 +38,7 @@ if TYPE_CHECKING:
 
     from oarepo_workflows.requests.events import WorkflowEvent
 
+
 log = getLogger(__name__)
 
 
@@ -55,10 +57,10 @@ class WorkflowRequest:
     recipients: Sequence[InvenioGenerator]
     """Generators that define who can approve the request."""
 
-    events: dict[str, WorkflowEvent] = dataclasses.field(default_factory=dict)
+    events: dict[str, WorkflowEvent] = dataclasses.field(default_factory=WorkflowEvents)
     """Events that can be submitted with the request."""
 
-    transitions: WorkflowTransitions = dataclasses.field(default_factory=lambda: WorkflowTransitions())
+    transitions: WorkflowTransitions = dataclasses.field(default_factory=lambda: WorkflowTransitions())  # noqa PLW0108
     """Transitions applied to the state of the topic of the request."""
 
     escalations: list[WorkflowRequestEscalation] = dataclasses.field(default_factory=list)
@@ -113,12 +115,20 @@ class WorkflowRequest:
 
     def __set_name__(self, owner: type, name: str) -> None:
         """Set the name of the workflow request to the request type id."""
-        self._request_type = name
+        self._request_type = name.replace("_", "-")
+
+    def __post_init__(self):
+        """Post init to convert events dictionary to WorkflowEvents."""
+        if self.events:
+            self.events = WorkflowEvents(self.events)
 
     @property
     def request_type(self) -> RequestType:
         """Return the request type."""
-        return current_request_type_registry.lookup(self._request_type, quiet=False)
+        try:
+            return current_request_type_registry.lookup(self._request_type)
+        except KeyError:  # pragma: no cover
+            return current_request_type_registry.lookup(self._request_type.replace("-", "_"))  # pragma: no cover
 
 
 @dataclasses.dataclass

{oarepo_workflows-2.0.0.dev6 → oarepo_workflows-2.0.0.dev8}/oarepo_workflows/resolvers/multiple_entities/__init__.py

@@ -70,7 +70,7 @@ class MultipleEntitiesProxy(EntityProxy):
     def get_needs(self, ctx: dict | None = None) -> list[Need | ItemNeed]:
         """Get needs that the entity generate."""
         ret: list[Need | ItemNeed] = []
-        entity = self._entity if self._entity else self._resolve()
+        entity = self._entity or self._resolve()
         for subentity_proxy in entity.entities:
             ret.extend(subentity_proxy.get_needs(ctx) or [])
         return ret

{oarepo_workflows-2.0.0.dev6 → oarepo_workflows-2.0.0.dev8}/oarepo_workflows/services/components/workflow.py

@@ -14,7 +14,8 @@ from typing import TYPE_CHECKING, Any, override
 from invenio_records_resources.services.records.components.base import ServiceComponent
 from oarepo_runtime.typing import require_kwargs
 
-from oarepo_workflows.errors import MissingWorkflowError
+from oarepo_workflows import current_oarepo_workflows
+from oarepo_workflows.errors import InvalidWorkflowError
 
 if TYPE_CHECKING:
     from flask_principal import Identity
@@ -48,20 +49,13 @@ class WorkflowComponent(ServiceComponent):
         **kwargs: Any,
     ) -> None:
         """Implement record creation checks and set the workflow on the created record."""
-        if not data:
-            # sanity check, should be handled by policy before the component is called
-            raise MissingWorkflowError(
-                "Workflow not defined in input. As this should be handled by a policy, "
-                "make sure you are using workflow-enabled policy.",
-                record=data,
-            )  # pragma: no cover
         try:
             workflow_id = data["parent"]["workflow"]
-        except KeyError as e:  # pragma: no cover
-            # sanity check, should be handled by policy before the component is called
-            raise MissingWorkflowError(  # pragma: no cover
-                "Workflow not defined in input. As this should be handled by a policy, "
-                "make sure you are using workflow-enabled policy.",
-                record=data,
-            ) from e
+        except KeyError:
+            return
+        if workflow_id not in current_oarepo_workflows.workflow_by_code:
+            raise InvalidWorkflowError(
+                f"Workflow {workflow_id} does not exist in the configuration.",
+                record=data or record,
+            )
         record.parent.workflow = workflow_id  # type: ignore[reportAttributeAccessIssue, reportOptionalMemberAccess]

{oarepo_workflows-2.0.0.dev6 → oarepo_workflows-2.0.0.dev8}/oarepo_workflows/services/permissions/__init__.py

@@ -10,7 +10,7 @@
 from __future__ import annotations
 
 from .generators import FromRecordWorkflow, IfInState, WorkflowPermission
-from .record_permission_policy import WorkflowRecordPermissionPolicy
+from .record_permission_policy import WorkflowRecordPermissionPolicyMixin
 from .workflow_permissions import DefaultWorkflowPermissions
 
 __all__ = (
@@ -18,5 +18,5 @@ __all__ = (
     "FromRecordWorkflow",
     "IfInState",
     "WorkflowPermission",
-    "WorkflowRecordPermissionPolicy",
+    "WorkflowRecordPermissionPolicyMixin",
 )

{oarepo_workflows-2.0.0.dev6 → oarepo_workflows-2.0.0.dev8}/oarepo_workflows/services/permissions/generators.py

@@ -20,7 +20,7 @@ from oarepo_runtime.services.generators import (
     Generator,
 )
 
-from oarepo_workflows.errors import InvalidWorkflowError, MissingWorkflowError
+from oarepo_workflows.errors import InvalidWorkflowError
 from oarepo_workflows.proxies import current_oarepo_workflows
 from oarepo_workflows.requests import RecipientGeneratorMixin
 
@@ -37,6 +37,55 @@ if TYPE_CHECKING:
     from oarepo_workflows.services.permissions import DefaultWorkflowPermissions
 
 
+def query_filters_from_all_workflows(action: str, **context: Any) -> list[dsl.query.Query]:
+    """Get query filters to match records depending on the records' workflow."""
+    workflows = current_oarepo_workflows.record_workflows
+    queries = []
+    for workflow in workflows:
+        q_in_workflow = dsl.Q("term", **{"parent.workflow": workflow.code})
+        workflow_filters = workflow.permissions(action, **context).query_filters
+        if not workflow_filters:
+            workflow_filters = [dsl.Q("match_none")]
+        query = reduce(lambda f1, f2: f1 | f2, workflow_filters) & q_in_workflow
+        queries.append(query)
+    return [q for q in queries if q]
+
+
+class InAnyWorkflow(Generator):
+    """InAnyWorkflow generator.
+
+    Warning: if some workflow uses generators with excludes, they can clash with needs in different workflows leading
+    to the generator excluding users even though they are allowed in the workflow without the excludes generator.
+    This is due to how flask allows() is implemented.
+
+    Eg. If workflow 1 defines provides need for User 1 and Workflow 2 excludes User 1,
+    the generator will treat user 1 as excluded despite being allowed in the first workflow.
+    """
+
+    def __init__(self, action: str) -> None:
+        """Construct the generator."""
+        self._action = action
+
+    @override
+    def needs(self, **context: Any) -> Sequence[Need]:
+        ret = set()
+        for workflow in current_oarepo_workflows.record_workflows:
+            ret |= set(workflow.permissions(self._action, **context).needs)
+        return list(ret)
+
+    @override
+    def excludes(self, **context: Any) -> Sequence[Need]:
+        ret = set()
+        for workflow in current_oarepo_workflows.record_workflows:
+            ret |= set(workflow.permissions(self._action, **context).excludes)
+        return list(ret)
+
+    @override
+    def query_filter(self, **context: Any) -> dsl.query.Query:
+        queries = query_filters_from_all_workflows(self._action, **context)
+        return reduce(operator.or_, queries)
+
+
 class FromRecordWorkflow(Generator):
     """Permission delegating check to workflow.
 
@@ -84,7 +133,7 @@ class FromRecordWorkflow(Generator):
             data = context.get("data", {})
             workflow_code = data.get("parent", {}).get("workflow", {})
             if not workflow_code:
-                raise MissingWorkflowError("Workflow not defined in input.", record=data)
+                return current_oarepo_workflows.default_workflow
             if workflow_code not in current_oarepo_workflows.workflow_by_code:
                 raise InvalidWorkflowError(
                     f"Workflow {workflow_code} does not exist in the configuration.",

{oarepo_workflows-2.0.0.dev6 → oarepo_workflows-2.0.0.dev8}/oarepo_workflows/services/permissions/record_permission_policy.py

@@ -9,31 +9,30 @@
 
 from __future__ import annotations
 
-from functools import reduce
 from typing import TYPE_CHECKING
 
-from invenio_records_permissions import RecordPermissionPolicy
 from invenio_records_permissions.generators import (
     AnyUser,
     SystemProcess,
 )
-from invenio_search.engine import dsl
 
-from ...proxies import current_oarepo_workflows
-from .generators import FromRecordWorkflow
+from .generators import FromRecordWorkflow, InAnyWorkflow, SameAs, query_filters_from_all_workflows
 
 if TYPE_CHECKING:
+    from invenio_records_permissions import RecordPermissionPolicy as InvenioRecordPermissionPolicy
     from opensearch_dsl.query import Query
+else:
+    InvenioRecordPermissionPolicy = object
 
 
-class WorkflowRecordPermissionPolicy(RecordPermissionPolicy):
+class WorkflowRecordPermissionPolicyMixin(InvenioRecordPermissionPolicy):
     """Permission policy to be used in permission presets directly on RecordServiceConfig.permission_policy_cls.
 
     Do not use this class in Workflow constructor.
     """
 
     can_commit_files = (FromRecordWorkflow("commit_files"),)
-    can_create = (FromRecordWorkflow("create"),)
+    can_create = (InAnyWorkflow("create"),)
     can_create_files = (FromRecordWorkflow("create_files"),)
     can_delete = (FromRecordWorkflow("delete"),)
     can_delete_draft = (FromRecordWorkflow("delete_draft"),)
@@ -116,6 +115,7 @@ class WorkflowRecordPermissionPolicy(RecordPermissionPolicy):
     can_remove_record = (FromRecordWorkflow("remove_record"),)
     can_review = (FromRecordWorkflow("review"),)
     can_view = (FromRecordWorkflow("view"),)
+    can_view_deposit_page = (SameAs("can_create"),)
 
     @property
     def query_filters(self) -> list[Query]:
@@ -127,13 +127,4 @@ class WorkflowRecordPermissionPolicy(RecordPermissionPolicy):
             "read_all_records",
         ):
             return super().query_filters  # type: ignore[no-any-return]
-        workflows = current_oarepo_workflows.record_workflows
-        queries = []
-        for workflow in workflows:
-            q_in_workflow = dsl.Q("term", **{"parent.workflow": workflow.code})
-            workflow_filters = workflow.permissions(self.action, **self.over).query_filters
-            if not workflow_filters:
-                workflow_filters = [dsl.Q("match_none")]
-            query = reduce(lambda f1, f2: f1 | f2, workflow_filters) & q_in_workflow
-            queries.append(query)
-        return [q for q in queries if q]
+        return query_filters_from_all_workflows(self.action, **self.over)