fractal-server 2.14.12__tar.gz → 2.14.13__tar.gz

{fractal_server-2.14.12 → fractal_server-2.14.13}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: fractal-server
-Version: 2.14.12
+Version: 2.14.13
 Summary: Backend component of the Fractal analytics platform
 License: BSD-3-Clause
 Author: Tommaso Comparin

fractal_server-2.14.13/fractal_server/__init__.py

@@ -0,0 +1 @@
+__VERSION__ = "2.14.13"

fractal_server-2.14.13/fractal_server/app/routes/api/v2/_aux_task_group_disambiguation.py

@@ -0,0 +1,163 @@
+import itertools
+
+from sqlmodel import select
+
+from fractal_server.app.db import AsyncSession
+from fractal_server.app.models import LinkUserGroup
+from fractal_server.app.models.v2 import TaskGroupV2
+from fractal_server.exceptions import UnreachableBranchError
+from fractal_server.logger import set_logger
+
+
+logger = set_logger(__name__)
+
+
+async def _disambiguate_task_groups(
+    *,
+    matching_task_groups: list[TaskGroupV2],
+    user_id: int,
+    default_group_id: int,
+    db: AsyncSession,
+) -> TaskGroupV2 | None:
+    """
+    Find ownership-based top-priority task group, if any.
+
+    Args:
+        matching_task_groups:
+        user_id:
+        default_group_id:
+        db:
+
+    Returns:
+        The task group or `None`.
+    """
+
+    # Highest priority: task groups created by user
+    list_user_ids = [tg.user_id for tg in matching_task_groups]
+    try:
+        ind_user_id = list_user_ids.index(user_id)
+        task_group = matching_task_groups[ind_user_id]
+        logger.debug(
+            "[_disambiguate_task_groups] "
+            f"Found task group {task_group.id} with {user_id=}, return."
+        )
+        return task_group
+    except ValueError:
+        logger.debug(
+            "[_disambiguate_task_groups] "
+            f"No task group with {user_id=}, continue."
+        )
+
+    # Medium priority: task groups owned by default user group
+    list_user_group_ids = [tg.user_group_id for tg in matching_task_groups]
+    try:
+        ind_user_group_id = list_user_group_ids.index(default_group_id)
+        task_group = matching_task_groups[ind_user_group_id]
+        logger.debug(
+            "[_disambiguate_task_groups] "
+            f"Found task group {task_group.id} with {user_id=}, return."
+        )
+        return task_group
+    except ValueError:
+        logger.debug(
+            "[_disambiguate_task_groups] "
+            "No task group with user_group_id="
+            f"{default_group_id}, continue."
+        )
+
+    # Lowest priority: task groups owned by other groups, sorted
+    # according to age of the user/usergroup link
+    logger.debug(
+        "[_disambiguate_task_groups] "
+        "Sort remaining task groups by oldest-user-link."
+    )
+    stm = (
+        select(LinkUserGroup.group_id)
+        .where(LinkUserGroup.user_id == user_id)
+        .where(LinkUserGroup.group_id.in_(list_user_group_ids))
+        .order_by(LinkUserGroup.timestamp_created.asc())
+    )
+    res = await db.execute(stm)
+    oldest_user_group_id = res.scalars().first()
+    logger.debug(
+        "[_disambiguate_task_groups] " f"Result: {oldest_user_group_id=}."
+    )
+    task_group = next(
+        iter(
+            task_group
+            for task_group in matching_task_groups
+            if task_group.user_group_id == oldest_user_group_id
+        ),
+        None,
+    )
+    return task_group
+
+
+async def _disambiguate_task_groups_not_none(
+    *,
+    matching_task_groups: list[TaskGroupV2],
+    user_id: int,
+    default_group_id: int,
+    db: AsyncSession,
+) -> TaskGroupV2:
+    """
+    Find ownership-based top-priority task group, and fail otherwise.
+
+    Args:
+        matching_task_groups:
+        user_id:
+        default_group_id:
+        db:
+
+    Returns:
+        The top-priority task group.
+    """
+    task_group = await _disambiguate_task_groups(
+        matching_task_groups=matching_task_groups,
+        user_id=user_id,
+        default_group_id=default_group_id,
+        db=db,
+    )
+    if task_group is None:
+        error_msg = (
+            "[_disambiguate_task_groups_not_none] Could not find a task "
+            f"group ({user_id=}, {default_group_id=})."
+        )
+        logger.error(f"UnreachableBranchError {error_msg}")
+        raise UnreachableBranchError(error_msg)
+    else:
+        return task_group
+
+
+async def remove_duplicate_task_groups(
+    *,
+    task_groups: list[TaskGroupV2],
+    user_id: int,
+    default_group_id: int,
+    db: AsyncSession,
+) -> list[TaskGroupV2]:
+    """
+    Extract a single task group for each `version`.
+
+    Args:
+        task_groups: A list of task groups with identical `pkg_name`
+        user_id: User ID
+
+    Returns:
+        New list of task groups with no duplicate `(pkg_name,version)` entries
+    """
+
+    new_task_groups = [
+        (
+            await _disambiguate_task_groups_not_none(
+                matching_task_groups=list(groups),
+                user_id=user_id,
+                default_group_id=default_group_id,
+                db=db,
+            )
+        )
+        for version, groups in itertools.groupby(
+            task_groups, key=lambda tg: tg.version
+        )
+    ]
+    return new_task_groups

{fractal_server-2.14.12 → fractal_server-2.14.13}/fractal_server/app/routes/api/v2/task_group.py

@@ -1,8 +1,13 @@
+import itertools
+
 from fastapi import APIRouter
 from fastapi import Depends
 from fastapi import HTTPException
 from fastapi import Response
 from fastapi import status
+from packaging.version import InvalidVersion
+from packaging.version import parse
+from packaging.version import Version
 from pydantic.types import AwareDatetime
 from sqlmodel import or_
 from sqlmodel import select
@@ -10,6 +15,7 @@ from sqlmodel import select
 from ._aux_functions_tasks import _get_task_group_full_access
 from ._aux_functions_tasks import _get_task_group_read_access
 from ._aux_functions_tasks import _verify_non_duplication_group_constraint
+from ._aux_task_group_disambiguation import remove_duplicate_task_groups
 from fractal_server.app.db import AsyncSession
 from fractal_server.app.db import get_async_db
 from fractal_server.app.models import LinkUserGroup
@@ -18,6 +24,7 @@ from fractal_server.app.models.v2 import TaskGroupActivityV2
 from fractal_server.app.models.v2 import TaskGroupV2
 from fractal_server.app.models.v2 import WorkflowTaskV2
 from fractal_server.app.routes.auth import current_active_user
+from fractal_server.app.routes.auth._aux_auth import _get_default_usergroup_id
 from fractal_server.app.routes.auth._aux_auth import (
     _verify_user_belongs_to_group,
 )
@@ -33,6 +40,26 @@ router = APIRouter()
 logger = set_logger(__name__)
 
 
+def _version_sort_key(
+    task_group: TaskGroupV2,
+) -> tuple[int, Version | str | None]:
+    """
+    Returns a tuple used as (reverse) ordering key for TaskGroups in
+    `get_task_group_list`.
+    The TaskGroups with a parsable versions are the first in order,
+    sorted according to the sorting rules of packaging.version.Version.
+    Next in order we have the TaskGroups with non-null non-parsable versions,
+    sorted alphabetically.
+    Last we have the TaskGroups with null version.
+    """
+    if task_group.version is None:
+        return (0, task_group.version)
+    try:
+        return (2, parse(task_group.version))
+    except InvalidVersion:
+        return (1, task_group.version)
+
+
 @router.get("/activity/", response_model=list[TaskGroupActivityV2Read])
 async def get_task_group_activity_list(
     task_group_activity_id: int | None = None,
@@ -97,14 +124,14 @@ async def get_task_group_activity(
     return activity
 
 
-@router.get("/", response_model=list[TaskGroupReadV2])
+@router.get("/", response_model=list[tuple[str, list[TaskGroupReadV2]]])
 async def get_task_group_list(
     user: UserOAuth = Depends(current_active_user),
     db: AsyncSession = Depends(get_async_db),
     only_active: bool = False,
     only_owner: bool = False,
     args_schema: bool = True,
-) -> list[TaskGroupReadV2]:
+) -> list[tuple[str, list[TaskGroupReadV2]]]:
     """
     Get all accessible TaskGroups
     """
@@ -119,7 +146,7 @@ async def get_task_group_list(
                 )
             ),
         )
-    stm = select(TaskGroupV2).where(condition)
+    stm = select(TaskGroupV2).where(condition).order_by(TaskGroupV2.pkg_name)
     if only_active:
         stm = stm.where(TaskGroupV2.active)
 
@@ -132,7 +159,28 @@ async def get_task_group_list(
                 setattr(task, "args_schema_non_parallel", None)
                 setattr(task, "args_schema_parallel", None)
 
-    return task_groups
+    default_group_id = await _get_default_usergroup_id(db)
+    grouped_result = [
+        (
+            pkg_name,
+            sorted(
+                (
+                    await remove_duplicate_task_groups(
+                        task_groups=list(groups),
+                        user_id=user.id,
+                        default_group_id=default_group_id,
+                        db=db,
+                    )
+                ),
+                key=_version_sort_key,
+                reverse=True,
+            ),
+        )
+        for pkg_name, groups in itertools.groupby(
+            task_groups, key=lambda tg: tg.pkg_name
+        )
+    ]
+    return grouped_result
 
 
 @router.get("/{task_group_id}/", response_model=TaskGroupReadV2)

{fractal_server-2.14.12 → fractal_server-2.14.13}/fractal_server/app/routes/api/v2/workflow_import.py

@@ -21,6 +21,9 @@ from ._aux_functions_tasks import _check_type_filters_compatibility
 from fractal_server.app.models import LinkUserGroup
 from fractal_server.app.models import UserOAuth
 from fractal_server.app.models.v2 import TaskGroupV2
+from fractal_server.app.routes.api.v2._aux_task_group_disambiguation import (
+    _disambiguate_task_groups,
+)
 from fractal_server.app.routes.auth import current_active_user
 from fractal_server.app.routes.auth._aux_auth import _get_default_usergroup_id
 from fractal_server.app.schemas.v2 import TaskImportV2
@@ -85,76 +88,6 @@ async def _get_task_by_source(
     return task_id
 
 
-async def _disambiguate_task_groups(
-    *,
-    matching_task_groups: list[TaskGroupV2],
-    user_id: int,
-    db: AsyncSession,
-    default_group_id: int,
-) -> TaskV2 | None:
-    """
-    Disambiguate task groups based on ownership information.
-    """
-    # Highest priority: task groups created by user
-    for task_group in matching_task_groups:
-        if task_group.user_id == user_id:
-            logger.info(
-                "[_disambiguate_task_groups] "
-                f"Found task group {task_group.id} with {user_id=}, return."
-            )
-            return task_group
-    logger.info(
-        "[_disambiguate_task_groups] "
-        f"No task group found with {user_id=}, continue."
-    )
-
-    # Medium priority: task groups owned by default user group
-    for task_group in matching_task_groups:
-        if task_group.user_group_id == default_group_id:
-            logger.info(
-                "[_disambiguate_task_groups] "
-                f"Found task group {task_group.id} with user_group_id="
-                f"{default_group_id}, return."
-            )
-            return task_group
-    logger.info(
-        "[_disambiguate_task_groups] "
-        "No task group found with user_group_id="
-        f"{default_group_id}, continue."
-    )
-
-    # Lowest priority: task groups owned by other groups, sorted
-    # according to age of the user/usergroup link
-    logger.info(
-        "[_disambiguate_task_groups] "
-        "Now sorting remaining task groups by oldest-user-link."
-    )
-    user_group_ids = [
-        task_group.user_group_id for task_group in matching_task_groups
-    ]
-    stm = (
-        select(LinkUserGroup.group_id)
-        .where(LinkUserGroup.user_id == user_id)
-        .where(LinkUserGroup.group_id.in_(user_group_ids))
-        .order_by(LinkUserGroup.timestamp_created.asc())
-    )
-    res = await db.execute(stm)
-    oldest_user_group_id = res.scalars().first()
-    logger.info(
-        "[_disambiguate_task_groups] "
-        f"Result of sorting: {oldest_user_group_id=}."
-    )
-    task_group = next(
-        iter(
-            task_group
-            for task_group in matching_task_groups
-            if task_group.user_group_id == oldest_user_group_id
-        ),
-        None,
-    )
-    return task_group
-
-
 async def _get_task_by_taskimport(
     *,
     task_import: TaskImportV2,

fractal_server-2.14.13/fractal_server/exceptions.py

@@ -0,0 +1,2 @@
+class UnreachableBranchError(RuntimeError):
+    pass

{fractal_server-2.14.12 → fractal_server-2.14.13}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "fractal-server"
-version = "2.14.12"
+version = "2.14.13"
 description = "Backend component of the Fractal analytics platform"
 authors = [
     { name="Tommaso Comparin", email="tommaso.comparin@exact-lab.it" },
@@ -94,7 +94,7 @@ filterwarnings = [
 markers = ["container", "ssh"]
 
 [tool.bumpver]
-current_version = "2.14.12"
+current_version = "2.14.13"
 version_pattern = "MAJOR.MINOR.PATCH[PYTAGNUM]"
 commit_message = "bump version {old_version} -> {new_version}"
 commit = true

fractal_server-2.14.12/fractal_server/__init__.py

@@ -1 +0,0 @@
-__VERSION__ = "2.14.12"