oarepo-runtime 1.5.102__py3-none-any.whl → 1.5.103__py3-none-any.whl

oarepo_runtime/services/components.py

@@ -3,7 +3,7 @@ from __future__ import annotations
 import inspect
 from collections import defaultdict
 from dataclasses import dataclass, field
-from typing import Type
+from typing import Any, Type
 
 from flask import current_app
 from invenio_accounts.models import User
@@ -17,6 +17,7 @@ from invenio_records_resources.services import FileServiceConfig
 from invenio_records_resources.services.records.config import (
     RecordServiceConfig as RecordsRecordServiceConfig,
 )
+
 from oarepo_runtime.proxies import current_oarepo
 from oarepo_runtime.services.custom_fields import (
     CustomFields,
@@ -147,7 +148,7 @@ def process_service_configs(service_config, *additional_components):
     for excluded_component in current_oarepo.rdm_excluded_components:
         if excluded_component in processed_components:
             processed_components.remove(excluded_component)
-            
+
     processed_components = _sort_components(processed_components)
     return processed_components
 
@@ -165,44 +166,228 @@ class ComponentPlacement:
     depends_on: list[ComponentPlacement] = field(default_factory=list)
     """List of components this one depends on.
     
-    The components must be classes of ServiceComponent or '*' to denote
-    that this component depends on all other components and should be placed last.
+    The components must be classes of ServiceComponent.
     """
 
     affects: list[ComponentPlacement] = field(default_factory=list)
-    """List of components that depend on this one.
-    
-    This is a temporary list used for evaluation of '*' dependencies
-    but does not take part in the sorting algorithm."""
+    """List of components that depend on this one."""
+
+    star_depends: bool = False
+    """True if this component depends on all other components."""
+
+    star_affects: bool = False
+    """True if this component affects all other components."""
 
     def __hash__(self) -> int:
         return id(self.component)
 
-    def __eq__(self, other: ComponentPlacement) -> bool:
+    def __eq__(self, other: Any) -> bool:
         return self.component is other.component
 
-
-def _sort_components(components):
+    def __repr__(self) -> str:
+        depends_on = [d.component.__name__ for d in self.depends_on]
+        affects = [a.component.__name__ for a in self.affects]
+        if self.star_affects:
+            affects.append("*")
+        if self.star_depends:
+            depends_on.append("*")
+        r = [f"<{self.component.__name__}"]
+        if depends_on:
+            r.append(f" depends_on: {depends_on}")
+        if affects:
+            r.append(f" affects: {affects}")
+        r.append(">")
+        return "".join(r)
+
+    def __str__(self) -> str:
+        return repr(self)
+
+
+def _sort_components(components) -> list[Type[ServiceComponent]]:
     """Sort components based on their dependencies while trying to
-    keep the initial order as far as possible."""
+    keep the initial order as far as possible.
+
+    Sorting algorithm:
+
+    1. Select all "affects" components that has "*" in their "affects" list.
+    2. Merge these components preserving other other "affects" and "depends_on" settings
+       and output these
+
+    3. put "depends_on: *" components aside for the moment
+    4. Sort the remaining components by their dependencies
+
+    5. process depends_on: * in a similar way as in 2.
+    """
 
     placements: list[ComponentPlacement] = _prepare_component_placement(components)
-    placements = _propagate_dependencies(placements)
 
+    # placements that must be first as they affect all other components
+    affects_placements = [p for p in placements if p.star_affects]
+
+    # placements that must be last as they depend on all other components
+    depends_on_placements = [p for p in placements if p.star_depends]
+
+    # if a component affects another that affects all components,
+    # add it to affects_placements
+    #
+    # A[affects *] B[affects A] C => adds B to affects_placements
+    modified = True
+    while modified:
+        modified = False
+        for p in placements:
+            if (
+                any(q in affects_placements for q in p.affects)
+                and p not in affects_placements
+            ):
+                affects_placements.append(p)
+                modified = True
+
+    # if a component depends on another that depends on all components,
+    # add it to depends_on_placements
+    # A[depends_on *] B[depends_on A] C => adds B to depends_on_placements
+    modified = True
+    while modified:
+        modified = False
+        for p in placements:
+            if (
+                any(q in depends_on_placements for q in p.depends_on)
+                and p not in depends_on_placements
+            ):
+                depends_on_placements.append(p)
+                modified = True
+
+    # those that do not affect or depend on all components
+    middle_placements = [
+        p
+        for p in placements
+        if p not in depends_on_placements and p not in affects_placements
+    ]
+
+    # sort placements inside each group by their respective depends on and affects
+    # relationships, ignoring the star relationships
     ret = []
-    while placements:
-        without_dependencies = [p for p in placements if not p.depends_on]
-        if not without_dependencies:
-            raise ValueError("Circular dependency detected in components.")
-        for p in without_dependencies:
-            ret.append(p.component)
-            placements.remove(p)
-            for p2 in placements:
-                if p in p2.depends_on:
-                    p2.depends_on.remove(p)
+    ret.extend(_sort_placements(affects_placements))
+    ret.extend(_sort_placements(middle_placements))
+    ret.extend(_sort_placements(depends_on_placements))
     return ret
 
 
+def _sort_placements(placements):
+    """Sort placements based on their dependencies.
+
+    The algorithm tries to keep the initial order as far as possible,
+    while still respecting the dependencies.
+
+    At first, for each component that affects another component, the algorithm
+    moves the affecting component before the affected one one step at a time.
+
+    When no more such moves are possible, the algorithm moves to the next step
+    and does similar thing for components that depend on another component.
+
+    The algorithm is repeated until all components are sorted. If they can not
+    be after a set number of iterations, the algorithm raises an exception.
+    """
+
+    _filter_depends_on_and_affects(placements)
+
+    for _ in range(10):
+        for __ in range(10):
+            # move components that affect other components before them
+            modified = _move_affecting_components(placements)
+
+            # move components that depend on other components after them
+            if _move_depends_on_components(placements):
+                modified = True
+
+            # if the order was not modified, we are done
+            if not modified:
+                return (p.component for p in placements)
+        else:
+            # could not sort the components by simple move. This means that we are
+            # in a situation where A C B[affects A depends on C] - we will try to
+            # swap A with C and try again.
+            _swap_out_of_order_components(placements)
+
+    raise ValueError(f"Can not order components: {placements}")
+
+
+def _swap_out_of_order_components(placements):
+    for idx, placement in enumerate(placements):
+
+        # we are looking for a situation: A C placement[affects A depends on C]
+        # so if there are not depends on and affects, try the next one
+        if not placement.depends_on or not placement.affects:
+            continue
+
+        depends_on = [(p, placements.index(p)) for p in placement.depends_on]
+        affects = [(p, placements.index(p)) for p in placement.affects]
+
+        # if there are no indices to swap, continue
+        if not depends_on or not affects:
+            continue
+
+        # keep the indices in order
+        depends_on.sort(key=lambda x: x[1])
+        affects.sort(key=lambda x: x[1])
+
+        depends_on_indices = [d[1] for d in depends_on]
+        affects_indices = [a[1] for a in affects]
+
+        swapped_depends_on = [d[0] for d in depends_on]
+        swapped_affects = [a[0] for a in affects]
+
+        # if the index of the component the current placement depends on
+        # is lower that any of the components that depend on the current placement,
+        # we are ok as the placement can be moved to the space between them,
+        # so just continue
+        if max(depends_on_indices) < min(affects_indices):
+            continue
+
+        # add all to an array and sort them. This way depends on will be after
+        # affects, keeping the positions inside the group
+        indices = sorted([*affects_indices, *depends_on_indices])
+
+        for idx, dep in zip(
+            indices,
+            [*swapped_depends_on, *swapped_affects],
+        ):
+            placements[idx] = dep
+
+
+def _filter_depends_on_and_affects(placements):
+    """Filter out dependencies on components that are not in the placements list."""
+    for placement in placements:
+        placement.depends_on = [p for p in placement.depends_on if p in placements]
+        placement.affects = [p for p in placement.affects if p in placements]
+
+
+def _move_affecting_components(placements):
+    modified = False
+
+    for idx, placement in list(enumerate(placements)):
+        if not placement.affects:
+            continue
+        min_index = min(placements.index(a) for a in placement.affects)
+        if min_index < idx:
+            placements.remove(placement)
+            placements.insert(min_index, placement)
+            modified = True
+    return modified
+
+
+def _move_depends_on_components(placements):
+    modified = False
+    for idx, placement in reversed(list(enumerate(placements))):
+        if not placement.depends_on:
+            continue
+        max_index = max(placements.index(a) for a in placement.depends_on)
+        if max_index > idx:
+            placements.remove(placement)
+            placements.insert(max_index, placement)
+            modified = True
+    return modified
+
+
 def _matching_placements(placements, dep_class_or_factory):
     for pl in placements:
         pl_component = pl.component
@@ -222,6 +407,9 @@ def _prepare_component_placement(components) -> list[ComponentPlacement]:
     # direct dependencies
     for idx, placement in enumerate(placements):
         placements_without_this = placements[:idx] + placements[idx + 1 :]
+        placement.star_depends = "*" in getattr(placement.component, "depends_on", [])
+        placement.star_affects = "*" in getattr(placement.component, "affects", [])
+
         for dep in getattr(placement.component, "depends_on", []):
             if dep == "*":
                 continue
@@ -229,8 +417,6 @@ def _prepare_component_placement(components) -> list[ComponentPlacement]:
             for pl in _matching_placements(placements_without_this, dep):
                 if pl not in placement.depends_on:
                     placement.depends_on.append(pl)
-                if placement not in pl.affects:
-                    pl.affects.append(placement)
 
         for dep in getattr(placement.component, "affects", []):
             if dep == "*":
@@ -239,54 +425,5 @@ def _prepare_component_placement(components) -> list[ComponentPlacement]:
             for pl in _matching_placements(placements_without_this, dep):
                 if pl not in placement.affects:
                     placement.affects.append(pl)
-                if placement not in pl.depends_on:
-                    pl.depends_on.append(placement)
-
-    # star dependencies
-    for idx, placement in enumerate(placements):
-        placements_without_this = placements[:idx] + placements[idx + 1 :]
-        if "*" in getattr(placement.component, "depends_on", []):
-            for pl in placements_without_this:
-                # if this placement is not in placements that pl depends on
-                # (added via direct dependencies above), add it
-                if placement not in pl.depends_on:
-                    if pl not in placement.depends_on:
-                        placement.depends_on.append(pl)
-                    if placement not in pl.affects:
-                        pl.affects.append(placement)
-
-        if "*" in getattr(placement.component, "affects", []):
-            for pl in placements_without_this:
-                # if this placement is not in placements that pl affects
-                # (added via direct dependencies above), add it
-                if placement not in pl.affects:
-                    if pl not in placement.affects:
-                        placement.affects.append(pl)
-                    if placement not in pl.depends_on:
-                        pl.depends_on.append(placement)
-    return placements
-
-
-def _propagate_dependencies(
-    placements: list[ComponentPlacement],
-) -> list[ComponentPlacement]:
-    # now propagate dependencies
-    dependency_propagated = True
-    while dependency_propagated:
-        dependency_propagated = False
-        for placement in placements:
-            for dep in placement.depends_on:
-                for dep_of_dep in dep.depends_on:
-                    if dep_of_dep not in placement.depends_on:
-                        placement.depends_on.append(dep_of_dep)
-                        dep_of_dep.affects.append(placement)
-                        dependency_propagated = True
-
-            for dep in placement.affects:
-                for dep_of_dep in dep.affects:
-                    if dep_of_dep not in placement.affects:
-                        placement.affects.append(dep_of_dep)
-                        dep_of_dep.depends_on.append(placement)
-                        dependency_propagated = True
 
     return placements

{oarepo_runtime-1.5.102.dist-info → oarepo_runtime-1.5.103.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: oarepo-runtime
-Version: 1.5.102
+Version: 1.5.103
 Summary: A set of runtime extensions of Invenio repository
 Description-Content-Type: text/markdown
 License-File: LICENSE

{oarepo_runtime-1.5.102.dist-info → oarepo_runtime-1.5.103.dist-info}/RECORD

@@ -80,7 +80,7 @@ oarepo_runtime/resources/file_resource.py,sha256=Ta3bFce7l0xwqkkOMOEu9mxbB8BbKj5
 oarepo_runtime/resources/json_serializer.py,sha256=82_-xQEtxKaPakv8R1oBAFbGnxskF_Ve4tcfcy4PetI,963
 oarepo_runtime/resources/localized_ui_json_serializer.py,sha256=3V9cJaG_e1PMXKVX_wKfBp1LmbeForwHyBNYdyha4uQ,1878
 oarepo_runtime/services/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-oarepo_runtime/services/components.py,sha256=QKrdFmroE1hSrRjRkqinynCTb0KSqBhytTb9FoY0OEE,11023
+oarepo_runtime/services/components.py,sha256=0aqmuNbGCQhfOI22f6mM2DxuKSTqstGOGyisOiqw9KE,15481
 oarepo_runtime/services/generators.py,sha256=j87HitHA_w2awsz0C5IAAJ0qjg9JMtvdO3dvh6FQyfg,250
 oarepo_runtime/services/results.py,sha256=Ap2mUJHl3V4BSduTrBWPuco0inQVq0QsuCbVhez48uY,5705
 oarepo_runtime/services/search.py,sha256=t0WEe2VrbCzZ06-Jgz7C9-pc9y27BqAgTEXldEHskfk,9409
@@ -142,9 +142,9 @@ tests/marshmallow_to_json/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJW
 tests/marshmallow_to_json/test_datacite_ui_schema.py,sha256=82iLj8nW45lZOUewpWbLX3mpSkpa9lxo-vK-Qtv_1bU,48552
 tests/marshmallow_to_json/test_simple_schema.py,sha256=izZN9p0v6kovtSZ6AdxBYmK_c6ZOti2_z_wPT_zXIr0,1500
 tests/pkg_data/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-oarepo_runtime-1.5.102.dist-info/LICENSE,sha256=h2uWz0OaB3EN-J1ImdGJZzc7yvfQjvHVYdUhQ-H7ypY,1064
-oarepo_runtime-1.5.102.dist-info/METADATA,sha256=Gzch2ffpJDzH8HdjdKtaaQ5DX0xzAZTGYT0aOTwA5hI,4721
-oarepo_runtime-1.5.102.dist-info/WHEEL,sha256=In9FTNxeP60KnTkGw7wk6mJPYd_dQSjEZmXdBdMCI-8,91
-oarepo_runtime-1.5.102.dist-info/entry_points.txt,sha256=k7O5LZUOGsVeSpB7ulU0txBUNp1CVQG7Q7TJIVTPbzU,491
-oarepo_runtime-1.5.102.dist-info/top_level.txt,sha256=bHhlkT1_RQC4IkfTQCqA3iN4KCB6cSFQlsXpQMSP-bE,21
-oarepo_runtime-1.5.102.dist-info/RECORD,,
+oarepo_runtime-1.5.103.dist-info/LICENSE,sha256=h2uWz0OaB3EN-J1ImdGJZzc7yvfQjvHVYdUhQ-H7ypY,1064
+oarepo_runtime-1.5.103.dist-info/METADATA,sha256=bLIBuMCjXm85bclvhOvWFWBfpCglssd-Xt4AiPUB6rI,4721
+oarepo_runtime-1.5.103.dist-info/WHEEL,sha256=In9FTNxeP60KnTkGw7wk6mJPYd_dQSjEZmXdBdMCI-8,91
+oarepo_runtime-1.5.103.dist-info/entry_points.txt,sha256=k7O5LZUOGsVeSpB7ulU0txBUNp1CVQG7Q7TJIVTPbzU,491
+oarepo_runtime-1.5.103.dist-info/top_level.txt,sha256=bHhlkT1_RQC4IkfTQCqA3iN4KCB6cSFQlsXpQMSP-bE,21
+oarepo_runtime-1.5.103.dist-info/RECORD,,