fractal-server 2.17.1a1__py3-none-any.whl → 2.18.0__py3-none-any.whl

fractal_server/app/schemas/v2/workflowtask.py

@@ -5,17 +5,18 @@ from pydantic import ConfigDict
 from pydantic import Field
 from pydantic import model_validator
 
-from .task import TaskExportV2
-from .task import TaskImportV2
-from .task import TaskImportV2Legacy
-from .task import TaskReadV2
-from .task import TaskType
 from fractal_server.types import DictStrAny
 from fractal_server.types import TypeFilters
 from fractal_server.types import WorkflowTaskArgument
 
+from .task import TaskExport
+from .task import TaskImport
+from .task import TaskImportLegacy
+from .task import TaskRead
+from .task import TaskType
+
 
-class WorkflowTaskCreateV2(BaseModel):
+class WorkflowTaskCreate(BaseModel):
     model_config = ConfigDict(extra="forbid")
 
     meta_non_parallel: DictStrAny | None = None
@@ -25,14 +26,14 @@ class WorkflowTaskCreateV2(BaseModel):
     type_filters: TypeFilters = Field(default_factory=dict)
 
 
-class WorkflowTaskReplaceV2(BaseModel):
+class WorkflowTaskReplace(BaseModel):
     """Used by 'replace-task' endpoint"""
 
     args_non_parallel: dict[str, Any] | None = None
     args_parallel: dict[str, Any] | None = None
 
 
-class WorkflowTaskReadV2(BaseModel):
+class WorkflowTaskRead(BaseModel):
     id: int
 
     workflow_id: int
@@ -47,14 +48,14 @@ class WorkflowTaskReadV2(BaseModel):
 
     task_type: TaskType
     task_id: int
-    task: TaskReadV2
+    task: TaskRead
 
 
-class WorkflowTaskReadV2WithWarning(WorkflowTaskReadV2):
+class WorkflowTaskReadWithWarning(WorkflowTaskRead):
     warning: str | None = None
 
 
-class WorkflowTaskUpdateV2(BaseModel):
+class WorkflowTaskUpdate(BaseModel):
     model_config = ConfigDict(extra="forbid")
 
     meta_non_parallel: DictStrAny | None = None
@@ -64,7 +65,7 @@ class WorkflowTaskUpdateV2(BaseModel):
     type_filters: TypeFilters = None
 
 
-class WorkflowTaskImportV2(BaseModel):
+class WorkflowTaskImport(BaseModel):
     model_config = ConfigDict(extra="forbid")
 
     meta_non_parallel: DictStrAny | None = None
@@ -74,7 +75,7 @@ class WorkflowTaskImportV2(BaseModel):
     type_filters: TypeFilters | None = None
     input_filters: dict[str, Any] | None = None
 
-    task: TaskImportV2 | TaskImportV2Legacy
+    task: TaskImport | TaskImportLegacy
 
     @model_validator(mode="before")
     @classmethod
@@ -105,11 +106,11 @@ class WorkflowTaskImportV2(BaseModel):
         return values
 
 
-class WorkflowTaskExportV2(BaseModel):
+class WorkflowTaskExport(BaseModel):
     meta_non_parallel: dict[str, Any] | None = None
     meta_parallel: dict[str, Any] | None = None
     args_non_parallel: dict[str, Any] | None = None
     args_parallel: dict[str, Any] | None = None
     type_filters: dict[str, bool] = Field(default_factory=dict)
 
-    task: TaskExportV2
+    task: TaskExport

fractal_server/app/security/__init__.py

@@ -15,6 +15,7 @@ registers the client and the relative routes.
 
 All routes are registered under the `auth/` prefix.
 """
+
 import contextlib
 from collections.abc import AsyncGenerator
 from typing import Any
@@ -39,7 +40,7 @@ from sqlalchemy.orm import selectinload
 from sqlmodel import func
 from sqlmodel import select
 
-from ..db import get_async_db
+from fractal_server.app.db import get_async_db
 from fractal_server.app.db import get_sync_db
 from fractal_server.app.models import LinkUserGroup
 from fractal_server.app.models import OAuthAccount
@@ -275,9 +276,7 @@ class UserManager(IntegerIDMixin, BaseUserManager[UserOAuth, int]):
                 )
             except exceptions.UserNotExists:
                 # (0) Log
-                logger.warning(
-                    f"Self-registration attempt by {account_email}."
-                )
+                logger.warning(f"Self-registration attempt by {account_email}.")
 
                 # (1) Prepare user-facing error message
                 error_msg = (
@@ -426,7 +425,7 @@ async def _create_first_user(
                     kwargs = dict(
                         email=email,
                         password=password,
-                        project_dir=project_dir,
+                        project_dirs=[project_dir],
                         profile_id=profile_id,
                         is_superuser=is_superuser,
                         is_verified=is_verified,
@@ -459,9 +458,7 @@ def _create_first_group():
         )
         return
 
-    function_logger.info(
-        f"START, name '{settings.FRACTAL_DEFAULT_GROUP_NAME}'"
-    )
+    function_logger.info(f"START, name '{settings.FRACTAL_DEFAULT_GROUP_NAME}'")
     with next(get_sync_db()) as db:
         group_all = db.execute(
             select(UserGroup).where(

fractal_server/app/security/signup_email.py

@@ -36,9 +36,9 @@ def send_fractal_email_or_log_failure(
                 for recipient in email_settings.recipients
             ]
         )
-        mail_msg[
-            "Subject"
-        ] = f"[Fractal, {email_settings.instance_name}] {subject}"
+        mail_msg["Subject"] = (
+            f"[Fractal, {email_settings.instance_name}] {subject}"
+        )
         with smtplib.SMTP(
             email_settings.smtp_server,
             email_settings.port,
@@ -61,6 +61,5 @@ def send_fractal_email_or_log_failure(
 
     except Exception as e:
         logger.error(
-            "Could not send self-registration email, "
-            f"original error: {str(e)}."
+            f"Could not send self-registration email, original error: {str(e)}."
         )

fractal_server/app/shutdown.py

@@ -4,26 +4,26 @@ from sqlmodel import select
 
 from fractal_server.app.db import get_async_db
 from fractal_server.app.models.v2 import JobV2
-from fractal_server.app.models.v2.job import JobStatusTypeV2
+from fractal_server.app.models.v2.job import JobStatusType
 from fractal_server.app.routes.aux._job import _write_shutdown_file
 from fractal_server.config import get_settings
 from fractal_server.logger import get_logger
 from fractal_server.syringe import Inject
 
 
-async def cleanup_after_shutdown(*, jobsV2: list[int], logger_name: str):
+async def cleanup_after_shutdown(*, jobs: list[int], logger_name: str):
     settings = Inject(get_settings)
     logger = get_logger(logger_name)
     logger.info("Cleanup function after shutdown")
     stm_objects = (
         select(JobV2)
-        .where(JobV2.id.in_(jobsV2))
-        .where(JobV2.status == JobStatusTypeV2.SUBMITTED)
+        .where(JobV2.id.in_(jobs))
+        .where(JobV2.status == JobStatusType.SUBMITTED)
     )
     stm_ids = (
         select(JobV2.id)
-        .where(JobV2.id.in_(jobsV2))
-        .where(JobV2.status == JobStatusTypeV2.SUBMITTED)
+        .where(JobV2.id.in_(jobs))
+        .where(JobV2.status == JobStatusType.SUBMITTED)
     )
 
     async for session in get_async_db():

fractal_server/config/__init__.py

@@ -1,5 +1,3 @@
-from ._data import DataAuthScheme  # noqa F401
-from ._data import DataSettings
 from ._database import DatabaseSettings
 from ._email import EmailSettings
 from ._email import PublicEmailSettings  # noqa F401
@@ -21,7 +19,3 @@ def get_email_settings(email_settings=EmailSettings()) -> EmailSettings:
 
 def get_oauth_settings(oauth_settings=OAuthSettings()) -> OAuthSettings:
     return oauth_settings
-
-
-def get_data_settings(data_settings=DataSettings()) -> DataSettings:
-    return data_settings

fractal_server/config/_data.py

@@ -1,68 +0,0 @@
-from enum import StrEnum
-from typing import Self
-
-from pydantic import model_validator
-from pydantic_settings import BaseSettings
-from pydantic_settings import SettingsConfigDict
-
-from ._settings_config import SETTINGS_CONFIG_DICT
-from fractal_server.types import AbsolutePathStr
-
-
-class DataAuthScheme(StrEnum):
-    VIEWER_PATHS = "viewer-paths"
-    USERS_FOLDERS = "users-folders"
-    NONE = "none"
-
-
-class DataSettings(BaseSettings):
-    """
-    Settings for the `fractal-data` integration.
-    """
-
-    model_config = SettingsConfigDict(**SETTINGS_CONFIG_DICT)
-
-    FRACTAL_DATA_AUTH_SCHEME: DataAuthScheme = "none"
-    """
-    Defines how the list of allowed viewer paths is built.
-
-    This variable affects the `GET /auth/current-user/allowed-viewer-paths/`
-    response, which is then consumed by
-    [fractal-data](https://github.com/fractal-analytics-platform/fractal-data).
-
-    Options:
-
-    - "viewer-paths": The list of allowed viewer paths will include the user's
-      `project_dir` along with any path defined in user groups' `viewer_paths`
-      attributes.
-    - "users-folders": The list will consist of the user's `project_dir` and a
-       user-specific folder. The user folder is constructed by concatenating
-       the base folder `FRACTAL_DATA_BASE_FOLDER` with the user's profile
-       `username`.
-    - "none": An empty list will be returned, indicating no access to
-       viewer paths. Useful when vizarr viewer is not used.
-    """
-
-    FRACTAL_DATA_BASE_FOLDER: AbsolutePathStr | None = None
-    """
-    Base path to Zarr files that will be served by fractal-vizarr-viewer;
-    This variable is required and used only when
-    FRACTAL_DATA_AUTHORIZATION_SCHEME is set to "users-folders".
-    """
-
-    @model_validator(mode="after")
-    def check(self: Self) -> Self:
-        """
-        `FRACTAL_DATA_BASE_FOLDER` is required when
-        `FRACTAL_DATA_AUTHORIZATION_SCHEME` is set to `"users-folders"`.
-        """
-        if (
-            self.FRACTAL_DATA_AUTH_SCHEME == DataAuthScheme.USERS_FOLDERS
-            and self.FRACTAL_DATA_BASE_FOLDER is None
-        ):
-            raise ValueError(
-                "FRACTAL_DATA_BASE_FOLDER is required when "
-                "FRACTAL_DATA_AUTH_SCHEME is set to "
-                "users-folders"
-            )
-        return self

fractal_server/config/_database.py

@@ -1,45 +1,44 @@
+from typing import Literal
+
 from pydantic import SecretStr
 from pydantic.types import NonNegativeInt
 from pydantic_settings import BaseSettings
 from pydantic_settings import SettingsConfigDict
 from sqlalchemy.engine import URL
 
-from ._settings_config import SETTINGS_CONFIG_DICT
 from fractal_server.types import NonEmptyStr
 
+from ._settings_config import SETTINGS_CONFIG_DICT
+
 
 class DatabaseSettings(BaseSettings):
     """
     Minimal set of configurations needed for operating on the database (e.g
     for schema migrations).
+
+    Attributes:
+        DB_ECHO:
+            If `"true"`, make database operations verbose.
+        POSTGRES_USER:
+            User to use when connecting to the PostgreSQL database.
+        POSTGRES_PASSWORD:
+            Password to use when connecting to the PostgreSQL database.
+        POSTGRES_HOST:
+            URL to the PostgreSQL server or path to a UNIX domain socket.
+        POSTGRES_PORT:
+            Port number to use when connecting to the PostgreSQL server.
+        POSTGRES_DB:
+            Name of the PostgreSQL database to connect to.
     """
 
     model_config = SettingsConfigDict(**SETTINGS_CONFIG_DICT)
 
-    DB_ECHO: bool = False
-    """
-    If `True`, make database operations verbose.
-    """
+    DB_ECHO: Literal["true", "false"] = "false"
     POSTGRES_USER: NonEmptyStr | None = None
-    """
-    User to use when connecting to the PostgreSQL database.
-    """
     POSTGRES_PASSWORD: SecretStr | None = None
-    """
-    Password to use when connecting to the PostgreSQL database.
-    """
     POSTGRES_HOST: NonEmptyStr = "localhost"
-    """
-    URL to the PostgreSQL server or path to a UNIX domain socket.
-    """
     POSTGRES_PORT: NonNegativeInt = 5432
-    """
-    Port number to use when connecting to the PostgreSQL server.
-    """
     POSTGRES_DB: NonEmptyStr
-    """
-    Name of the PostgreSQL database to connect to.
-    """
 
     @property
     def DATABASE_URL(self) -> URL:

fractal_server/config/_email.py

@@ -4,8 +4,8 @@ from typing import Self
 from pydantic import BaseModel
 from pydantic import EmailStr
 from pydantic import Field
-from pydantic import model_validator
 from pydantic import SecretStr
+from pydantic import model_validator
 from pydantic_settings import BaseSettings
 from pydantic_settings import SettingsConfigDict
 
@@ -17,14 +17,14 @@ class PublicEmailSettings(BaseModel):
     Schema for `EmailSettings.public`, namely the ready-to-use settings.
 
     Attributes:
-        sender: Sender email address
-        recipients: List of recipients email address
-        smtp_server: SMTP server address
-        port: SMTP server port
-        password: Sender password
-        instance_name: Name of SMTP server instance
-        use_starttls: Whether to use the security protocol
-        use_login: Whether to use login
+        sender: Sender email address.
+        recipients: List of recipients email address.
+        smtp_server: SMTP server address.
+        port: SMTP server port.
+        password: Sender password.
+        instance_name: Name of SMTP server instance.
+        use_starttls: Whether to use the security protocol.
+        use_login: Whether to use login.
     """
 
     sender: EmailStr
@@ -40,50 +40,42 @@ class PublicEmailSettings(BaseModel):
 class EmailSettings(BaseSettings):
     """
     Class with settings for email-sending feature.
+
+    Attributes:
+        FRACTAL_EMAIL_SENDER:
+            Address of the OAuth-signup email sender.
+        FRACTAL_EMAIL_PASSWORD:
+            Password for the OAuth-signup email sender.
+        FRACTAL_EMAIL_SMTP_SERVER:
+            SMTP server for the OAuth-signup emails.
+        FRACTAL_EMAIL_SMTP_PORT:
+            SMTP server port for the OAuth-signup emails.
+        FRACTAL_EMAIL_INSTANCE_NAME:
+            Fractal instance name, to be included in the OAuth-signup emails.
+        FRACTAL_EMAIL_RECIPIENTS:
+            Comma-separated list of recipients of the OAuth-signup emails.
+        FRACTAL_EMAIL_USE_STARTTLS:
+            Whether to use StartTLS when using the SMTP server.
+        FRACTAL_EMAIL_USE_LOGIN:
+            Whether to use login when using the SMTP server.
+            If 'true', FRACTAL_EMAIL_PASSWORD  must be provided.
     """
 
     model_config = SettingsConfigDict(**SETTINGS_CONFIG_DICT)
 
     FRACTAL_EMAIL_SENDER: EmailStr | None = None
-    """
-    Address of the OAuth-signup email sender.
-    """
     FRACTAL_EMAIL_PASSWORD: SecretStr | None = None
-    """
-    Password for the OAuth-signup email sender.
-    """
     FRACTAL_EMAIL_SMTP_SERVER: str | None = None
-    """
-    SMTP server for the OAuth-signup emails.
-    """
     FRACTAL_EMAIL_SMTP_PORT: int | None = None
-    """
-    SMTP server port for the OAuth-signup emails.
-    """
     FRACTAL_EMAIL_INSTANCE_NAME: str | None = None
-    """
-    Fractal instance name, to be included in the OAuth-signup emails.
-    """
     FRACTAL_EMAIL_RECIPIENTS: str | None = None
-    """
-    Comma-separated list of recipients of the OAuth-signup emails.
-    """
     FRACTAL_EMAIL_USE_STARTTLS: Literal["true", "false"] = "true"
-    """
-    Whether to use StartTLS when using the SMTP server.
-    Accepted values: 'true', 'false'.
-    """
     FRACTAL_EMAIL_USE_LOGIN: Literal["true", "false"] = "true"
-    """
-    Whether to use login when using the SMTP server.
-    If 'true', FRACTAL_EMAIL_PASSWORD  must be provided.
-    Accepted values: 'true', 'false'.
-    """
 
     public: PublicEmailSettings | None = None
     """
-    The validated field which is actually used in `fractal-server
-    (automatically populated upon creation).
+    The validated field which is actually used in `fractal-server`,
+    automatically populated upon creation.
     """
 
     @model_validator(mode="after")

fractal_server/config/_main.py

@@ -11,68 +11,54 @@ from ._settings_config import SETTINGS_CONFIG_DICT
 
 class Settings(BaseSettings):
     """
-    Contains all the configuration variables for Fractal Server
-
-    The attributes of this class are set from the environment.
+    Contains the general configuration variables for Fractal Server.
+
+    Attributes:
+        JWT_EXPIRE_SECONDS:
+            JWT token lifetime, in seconds.
+        JWT_SECRET_KEY:
+            JWT secret.<br>
+            ⚠️ Set this variable to a secure string, and do not disclose it.
+        COOKIE_EXPIRE_SECONDS:
+            Cookie token lifetime, in seconds.
+        FRACTAL_RUNNER_BACKEND:
+            Select which runner backend to use.
+        FRACTAL_LOGGING_LEVEL:
+            Logging-level threshold for logging
+            Only logs of with this level (or higher) will appear in the console
+            logs.
+        FRACTAL_API_MAX_JOB_LIST_LENGTH:
+            Number of ids that can be stored in the `jobs` attribute of
+            `app.state`.
+        FRACTAL_GRACEFUL_SHUTDOWN_TIME:
+            Waiting time for the shutdown phase of executors, in seconds.
+        FRACTAL_HELP_URL:
+            The URL of an instance-specific Fractal help page.
+        FRACTAL_DEFAULT_GROUP_NAME:
+            Name of the default user group.
+
+            If set to `"All"`, then the user group with that name is a special
+            user group (e.g. it cannot be deleted, and new users are
+            automatically added to it). If set to `None` (the default value),
+            then user groups are all equivalent, independently on their name.
+        FRACTAL_LONG_REQUEST_TIME:
+            Time limit beyond which the execution of an API request is
+            considered *slow* and an appropriate warning is logged by the
+            middleware.
     """
 
     model_config = SettingsConfigDict(**SETTINGS_CONFIG_DICT)
 
     JWT_EXPIRE_SECONDS: int = 180
-    """
-    JWT token lifetime, in seconds.
-    """
-
     JWT_SECRET_KEY: SecretStr
-    """
-    JWT secret
-
-    ⚠️ **IMPORTANT**: set this variable to a secure string, and do not disclose
-    it.
-    """
-
     COOKIE_EXPIRE_SECONDS: int = 86400
-    """
-    Cookie token lifetime, in seconds.
-    """
-
     # Note: we do not use ResourceType here to avoid circular imports
-    FRACTAL_RUNNER_BACKEND: Literal[
-        "local", "slurm_ssh", "slurm_sudo"
-    ] = "local"
-    """
-    Select which runner backend to use.
-    """
-
+    FRACTAL_RUNNER_BACKEND: Literal["local", "slurm_ssh", "slurm_sudo"] = (
+        "local"
+    )
     FRACTAL_LOGGING_LEVEL: int = logging.INFO
-    """
-    Logging-level threshold for logging
-
-    Only logs of with this level (or higher) will appear in the console logs.
-    """
-
     FRACTAL_API_MAX_JOB_LIST_LENGTH: int = 25
-    """
-    Number of ids that can be stored in the `jobsV2` attribute of
-    `app.state`.
-    """
-
     FRACTAL_GRACEFUL_SHUTDOWN_TIME: float = 30.0
-    """
-    Waiting time for the shutdown phase of executors
-    """
-
     FRACTAL_HELP_URL: HttpUrl | None = None
-    """
-    The URL of an instance-specific Fractal help page.
-    """
-
     FRACTAL_DEFAULT_GROUP_NAME: Literal["All"] | None = None
-    """
-    Name of the default user group.
-
-    If set to `"All"`, then the user group with that name is a special user
-    group (e.g. it cannot be deleted, and new users are automatically added
-    to it). If set to `None` (the default value), then user groups are all
-    equivalent, independently on their name.
-    """
+    FRACTAL_LONG_REQUEST_TIME: float = 30.0

fractal_server/config/_oauth.py

@@ -1,20 +1,33 @@
 from typing import Annotated
 from typing import Self
 
-from pydantic import model_validator
 from pydantic import SecretStr
 from pydantic import StringConstraints
+from pydantic import model_validator
 from pydantic_settings import BaseSettings
 from pydantic_settings import SettingsConfigDict
 
-from ._settings_config import SETTINGS_CONFIG_DICT
 from fractal_server.types import NonEmptyStr
 
+from ._settings_config import SETTINGS_CONFIG_DICT
+
 
 class OAuthSettings(BaseSettings):
     """
-    Minimal set of configurations needed for operating on the database (e.g
-    for schema migrations).
+    Settings for integration with an OAuth identity provider.
+
+    Attributes:
+        OAUTH_CLIENT_NAME: Name of the client.
+        OAUTH_CLIENT_ID: ID of client.
+        OAUTH_CLIENT_SECRET:
+            Secret to authorise against the identity provider.
+        OAUTH_OIDC_CONFIG_ENDPOINT:
+            OpenID Connect configuration endpoint, for autodiscovery of
+            relevant endpoints.
+        OAUTH_REDIRECT_URL:
+            String to be used as `redirect_url` argument in
+            `fastapi_users.get_oauth_router`, and then in
+            `httpx_oauth.integrations.fastapi.OAuth2AuthorizeCallback`.
     """
 
     model_config = SettingsConfigDict(**SETTINGS_CONFIG_DICT)
@@ -26,27 +39,10 @@ class OAuthSettings(BaseSettings):
         ]
         | None
     ) = None
-    """
-    The name of the client.
-    """
     OAUTH_CLIENT_ID: SecretStr | None = None
-    """
-    ID of client.
-    """
     OAUTH_CLIENT_SECRET: SecretStr | None = None
-    """
-    Secret to authorise against the identity provider.
-    """
     OAUTH_OIDC_CONFIG_ENDPOINT: SecretStr | None = None
-    """
-    OpenID configuration endpoint, for autodiscovery of relevant endpoints.
-    """
     OAUTH_REDIRECT_URL: str | None = None
-    """
-    String to be used as `redirect_url` argument in
-    `fastapi_users.get_oauth_router`, and then in
-    `httpx_oauth.integrations.fastapi.OAuth2AuthorizeCallback`
-    """
 
     @model_validator(mode="after")
     def check_configuration(self: Self) -> Self:

fractal_server/data_migrations/2_18_0.py

@@ -0,0 +1,30 @@
+import logging
+import sys
+from os.path import normpath
+
+from sqlalchemy.orm.attributes import flag_modified
+from sqlmodel import select
+
+from fractal_server.app.db import get_sync_db
+from fractal_server.app.models import UserOAuth
+
+logging.basicConfig(level=logging.INFO)
+
+
+def fix_db():
+    logging.info("START - fix db")
+
+    with next(get_sync_db()) as db:
+        res = db.execute(select(UserOAuth).order_by(UserOAuth.email))
+        user_list = res.scalars().unique().all()
+
+        for user in user_list:
+            logging.info(f"Now handling user {user.email}.")
+            if user.project_dirs != []:
+                sys.exit(f"Non empty `project_dirs` for User[{user.id}]")
+            user.project_dirs.append(normpath(user.project_dir))
+            flag_modified(user, "project_dirs")
+
+        db.commit()
+
+    logging.info("END - fix db")

fractal_server/exceptions.py

@@ -1,2 +1,6 @@
 class UnreachableBranchError(RuntimeError):
+    """
+    Exception marking a code branch that should have not been reached.
+    """
+
     pass