✨ Workspaces / Folders v2 🗃️🚨 (#6248)

Author: matusdrobuliak66

api/specs/web-server/_folders.py

@@ -10,21 +10,18 @@
 from typing import Annotated
 
 from fastapi import APIRouter, Depends, Query, status
-from models_library.api_schemas_webserver.folders import (
+from models_library.api_schemas_webserver.folders_v2 import (
     CreateFolderBodyParams,
     FolderGet,
     PutFolderBodyParams,
 )
+from models_library.folders import FolderID
 from models_library.generics import Envelope
 from models_library.rest_pagination import PageQueryParameters
+from models_library.workspaces import WorkspaceID
 from pydantic import Json
 from simcore_service_webserver._meta import API_VTAG
 from simcore_service_webserver.folders._folders_handlers import FoldersPathParams
-from simcore_service_webserver.folders._groups_api import FolderGroupGet
-from simcore_service_webserver.folders._groups_handlers import (
-    _FoldersGroupsBodyParams,
-    _FoldersGroupsPathParams,
-)
 
 router = APIRouter(
     prefix=f"/{API_VTAG}",
@@ -51,6 +48,8 @@ async def create_folder(_body: CreateFolderBodyParams):
 )
 async def list_folders(
     params: Annotated[PageQueryParameters, Depends()],
+    folder_id: FolderID | None = None,
+    workspace_id: WorkspaceID | None = None,
     order_by: Annotated[
         Json,
         Query(
@@ -86,45 +85,3 @@ async def replace_folder(
 )
 async def delete_folder(_path: Annotated[FoldersPathParams, Depends()]):
     ...
-
-
-### Folders groups
-
-
-@router.post(
-    "/folders/{folder_id}/groups/{group_id}",
-    response_model=Envelope[FolderGroupGet],
-    status_code=status.HTTP_201_CREATED,
-)
-async def create_folder_group(
-    _path: Annotated[_FoldersGroupsPathParams, Depends()],
-    _body: _FoldersGroupsBodyParams,
-):
-    ...
-
-
-@router.get(
-    "/folders/{folder_id}/groups",
-    response_model=Envelope[list[FolderGroupGet]],
-)
-async def list_folder_groups(_path: Annotated[FoldersPathParams, Depends()]):
-    ...
-
-
-@router.put(
-    "/folders/{folder_id}/groups/{group_id}",
-    response_model=Envelope[FolderGroupGet],
-)
-async def replace_folder_group(
-    _path: Annotated[_FoldersGroupsPathParams, Depends()],
-    _body: _FoldersGroupsBodyParams,
-):
-    ...
-
-
-@router.delete(
-    "/folders/{folder_id}/groups/{group_id}",
-    status_code=status.HTTP_204_NO_CONTENT,
-)
-async def delete_folder_group(_path: Annotated[_FoldersGroupsPathParams, Depends()]):
-    ...

api/specs/web-server/_workspaces.py

@@ -0,0 +1,113 @@
+""" Helper script to generate OAS automatically
+"""
+
+# pylint: disable=redefined-outer-name
+# pylint: disable=unused-argument
+# pylint: disable=unused-variable
+# pylint: disable=too-many-arguments
+
+
+from fastapi import APIRouter, status
+from models_library.api_schemas_webserver.workspaces import (
+    CreateWorkspaceBodyParams,
+    PutWorkspaceBodyParams,
+    WorkspaceGet,
+)
+from models_library.generics import Envelope
+from models_library.users import GroupID
+from models_library.workspaces import WorkspaceID
+from simcore_service_webserver._meta import API_VTAG
+from simcore_service_webserver.workspaces._groups_api import WorkspaceGroupGet
+from simcore_service_webserver.workspaces._groups_handlers import (
+    _WorkspacesGroupsBodyParams,
+)
+
+router = APIRouter(
+    prefix=f"/{API_VTAG}",
+    tags=[
+        "workspaces",
+    ],
+)
+
+### Workspaces
+
+
+@router.post(
+    "/workspaces",
+    response_model=Envelope[WorkspaceGet],
+    status_code=status.HTTP_201_CREATED,
+)
+async def create_workspace(body: CreateWorkspaceBodyParams):
+    ...
+
+
+@router.get(
+    "/workspaces",
+    response_model=Envelope[list[WorkspaceGet]],
+)
+async def list_workspaces():
+    ...
+
+
+@router.get(
+    "/workspaces/{workspace_id}",
+    response_model=Envelope[WorkspaceGet],
+)
+async def get_workspace(workspace_id: WorkspaceID):
+    ...
+
+
+@router.put(
+    "/workspaces/{workspace_id}",
+    response_model=Envelope[WorkspaceGet],
+)
+async def replace_workspace(workspace_id: WorkspaceID, body: PutWorkspaceBodyParams):
+    ...
+
+
+@router.delete(
+    "/workspaces/{workspace_id}",
+    status_code=status.HTTP_204_NO_CONTENT,
+)
+async def delete_workspace(workspace_id: WorkspaceID):
+    ...
+
+
+### Workspaces groups
+
+
+@router.post(
+    "/workspaces/{workspace_id}/groups/{group_id}",
+    response_model=Envelope[WorkspaceGroupGet],
+    status_code=status.HTTP_201_CREATED,
+)
+async def create_workspace_group(
+    workspace_id: WorkspaceID, group_id: GroupID, body: _WorkspacesGroupsBodyParams
+):
+    ...
+
+
+@router.get(
+    "/workspaces/{workspace_id}/groups",
+    response_model=Envelope[list[WorkspaceGroupGet]],
+)
+async def list_workspace_groups(workspace_id: WorkspaceID):
+    ...
+
+
+@router.put(
+    "/workspaces/{workspace_id}/groups/{group_id}",
+    response_model=Envelope[WorkspaceGroupGet],
+)
+async def replace_workspace_group(
+    workspace_id: WorkspaceID, group_id: GroupID, body: _WorkspacesGroupsBodyParams
+):
+    ...
+
+
+@router.delete(
+    "/workspaces/{workspace_id}/groups/{group_id}",
+    status_code=status.HTTP_204_NO_CONTENT,
+)
+async def delete_workspace_group(workspace_id: WorkspaceID, group_id: GroupID):
+    ...

api/specs/web-server/openapi.py

@@ -50,6 +50,7 @@
         "_users",
         "_version_control",
         "_wallets",
+        "_workspaces",
     )
 ]
 

packages/models-library/src/models_library/access_rights.py

@@ -0,0 +1,10 @@
+from pydantic import BaseModel, Extra, Field
+
+
+class AccessRights(BaseModel):
+    read: bool = Field(..., description="has read access")
+    write: bool = Field(..., description="has write access")
+    delete: bool = Field(..., description="has deletion rights")
+
+    class Config:
+        extra = Extra.forbid

packages/models-library/src/models_library/api_schemas_webserver/folders_v2.py

@@ -0,0 +1,54 @@
+from datetime import datetime
+from typing import NamedTuple
+
+from models_library.basic_types import IDStr
+from models_library.folders import FolderID
+from models_library.users import GroupID
+from models_library.utils.common_validators import null_or_none_str_to_none_validator
+from models_library.workspaces import WorkspaceID
+from pydantic import Extra, PositiveInt, validator
+
+from ._base import InputSchema, OutputSchema
+
+
+class FolderGet(OutputSchema):
+    folder_id: FolderID
+    parent_folder_id: FolderID | None = None
+    name: str
+    created_at: datetime
+    modified_at: datetime
+    owner: GroupID
+
+
+class FolderGetPage(NamedTuple):
+    items: list[FolderGet]
+    total: PositiveInt
+
+
+class CreateFolderBodyParams(InputSchema):
+    name: IDStr
+    parent_folder_id: FolderID | None = None
+    workspace_id: WorkspaceID | None = None
+
+    class Config:
+        extra = Extra.forbid
+
+    _null_or_none_str_to_none_validator = validator(
+        "parent_folder_id", allow_reuse=True, pre=True
+    )(null_or_none_str_to_none_validator)
+
+    _null_or_none_str_to_none_validator2 = validator(
+        "workspace_id", allow_reuse=True, pre=True
+    )(null_or_none_str_to_none_validator)
+
+
+class PutFolderBodyParams(InputSchema):
+    name: IDStr
+    parent_folder_id: FolderID | None
+
+    class Config:
+        extra = Extra.forbid
+
+    _null_or_none_str_to_none_validator = validator(
+        "parent_folder_id", allow_reuse=True, pre=True
+    )(null_or_none_str_to_none_validator)

packages/models-library/src/models_library/api_schemas_webserver/projects.py

@@ -7,6 +7,7 @@
 
 from typing import Any, Literal, TypeAlias
 
+from models_library.workspaces import WorkspaceID
 from pydantic import Field, validator
 
 from ..api_schemas_long_running_tasks.tasks import TaskGet
@@ -39,9 +40,10 @@ class ProjectCreateNew(InputSchema):
     tags: list[int] = Field(default_factory=list)
     classifiers: list[ClassifierID] = Field(default_factory=list)
     ui: StudyUI | None = None
+    workspace_id: WorkspaceID | None = None
 
     _empty_is_none = validator(
-        "uuid", "thumbnail", "description", allow_reuse=True, pre=True
+        "uuid", "thumbnail", "description", "workspace_id", allow_reuse=True, pre=True
     )(empty_str_to_none_pre_validator)
 
 
@@ -74,6 +76,7 @@ class ProjectGet(OutputSchema):
     quality: dict[str, Any] = {}
     dev: dict | None
     permalink: ProjectPermalink = FieldNotRequired()
+    workspace_id: WorkspaceID | None
 
     _empty_description = validator("description", allow_reuse=True, pre=True)(
         none_to_empty_str_pre_validator

packages/models-library/src/models_library/api_schemas_webserver/workspaces.py

@@ -0,0 +1,44 @@
+from datetime import datetime
+from typing import NamedTuple
+
+from models_library.basic_types import IDStr
+from models_library.users import GroupID
+from models_library.workspaces import WorkspaceID
+from pydantic import Extra, PositiveInt
+
+from ..access_rights import AccessRights
+from ._base import InputSchema, OutputSchema
+
+
+class WorkspaceGet(OutputSchema):
+    workspace_id: WorkspaceID
+    name: str
+    description: str | None
+    thumbnail: str | None
+    created_at: datetime
+    modified_at: datetime
+    my_access_rights: AccessRights
+    access_rights: dict[GroupID, AccessRights]
+
+
+class WorkspaceGetPage(NamedTuple):
+    items: list[WorkspaceGet]
+    total: PositiveInt
+
+
+class CreateWorkspaceBodyParams(InputSchema):
+    name: str
+    description: str | None = None
+    thumbnail: str | None = None
+
+    class Config:
+        extra = Extra.forbid
+
+
+class PutWorkspaceBodyParams(InputSchema):
+    name: IDStr
+    description: str | None = None
+    thumbnail: str | None = None
+
+    class Config:
+        extra = Extra.forbid

packages/models-library/src/models_library/folders.py

@@ -1,5 +1,36 @@
+from datetime import datetime
 from typing import TypeAlias
 
-from pydantic import PositiveInt
+from models_library.users import GroupID, UserID
+from models_library.workspaces import WorkspaceID
+from pydantic import BaseModel, Field, PositiveInt
 
 FolderID: TypeAlias = PositiveInt
+
+
+#
+# DB
+#
+
+
+class FolderDB(BaseModel):
+    folder_id: FolderID
+    name: str
+    parent_folder_id: FolderID | None
+    created_by_gid: GroupID = Field(
+        ...,
+        description="GID of the group that owns this wallet",
+    )
+    created: datetime = Field(
+        ...,
+        description="Timestamp on creation",
+    )
+    modified: datetime = Field(
+        ...,
+        description="Timestamp of last modification",
+    )
+    user_id: UserID | None
+    workspace_id: WorkspaceID | None
+
+    class Config:
+        orm_mode = True

packages/models-library/src/models_library/projects.py

@@ -8,6 +8,7 @@
 from typing import Any, Final, TypeAlias
 from uuid import UUID
 
+from models_library.workspaces import WorkspaceID
 from pydantic import BaseModel, ConstrainedStr, Extra, Field, validator
 
 from .basic_regex import DATE_RE, UUID_RE_BASE
@@ -173,6 +174,12 @@ class Project(BaseProjectModel):
         default=None, description="object used for development purposes only"
     )
 
+    workspace_id: WorkspaceID | None = Field(
+        default=None,
+        description="To which workspace project belongs. If None, belongs to private user workspace.",
+        alias="workspaceId",
+    )
+
     class Config:
         description = "Document that stores metadata, pipeline and UI setup of a study"
         title = "osparc-simcore project"