Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

✨ Adds folders_get to folders db layer #6153

Merged
merged 5 commits into from
Aug 13, 2024
+200 −47
Merged

✨ Adds folders_get to folders db layer #6153

Show file tree
Hide file tree
Changes from 4 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
b3ca764
added folder_get sharing part of fodler_list
Aug 8, 2024
12cc597
added tests
Aug 8, 2024
65d5419
extend tests
Aug 8, 2024
a9766a7
Merge branch 'master' into pr-osparc-add-folder-get
GitHK Aug 8, 2024
b96df56
Merge branch 'master' into pr-osparc-add-folder-get
matusdrobuliak66 Aug 13, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
161 changes: 114 additions & 47 deletions packages/postgres-database/src/simcore_postgres_database/utils_folders.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
from datetime import datetime
from enum import Enum
from functools import reduce
from typing import Any, ClassVar, TypeAlias
from typing import Any, ClassVar, Final, TypeAlias

import sqlalchemy as sa
from aiopg.sa.connection import SAConnection
Expand All @@ -22,6 +22,7 @@
from pydantic.errors import PydanticErrorMixin
from sqlalchemy.dialects import postgresql
from sqlalchemy.sql.elements import ColumnElement
from sqlalchemy.sql.selectable import ScalarSelect

from .models.folders import folders, folders_access_rights, folders_to_projects
from .models.groups import GroupType, groups
Expand Down Expand Up @@ -69,9 +70,7 @@ class FolderAccessError(FoldersError):


class FolderNotFoundError(FolderAccessError):
msg_template = (
"no entry found for folder_id={folder_id} and product_name={product_name}"
)
msg_template = "no entry found for folder_id={folder_id}, gid={gid} and product_name={product_name}"


class FolderNotSharedWithGidError(FolderAccessError):
Expand Down Expand Up @@ -179,6 +178,7 @@ def _or_dicts_list(dicts: Iterable[_FolderPermissions]) -> _FolderPermissions:


class _BasePermissions:
GET_FOLDER: ClassVar[_FolderPermissions] = _make_permissions(r=True)
LIST_FOLDERS: ClassVar[_FolderPermissions] = _make_permissions(r=True)

CREATE_FOLDER: ClassVar[_FolderPermissions] = _make_permissions(w=True)
Expand Down Expand Up @@ -433,7 +433,9 @@ async def _check_folder_and_access(
.where(folders.c.product_name == product_name)
)
if not folder_entry:
raise FolderNotFoundError(folder_id=folder_id, product_name=product_name)
raise FolderNotFoundError(
folder_id=folder_id, gid=gid, product_name=product_name
)

# check if folder was shared
resolved_access_rights_without_permissions = await _get_resolved_access_rights(
Expand Down Expand Up @@ -931,6 +933,51 @@ async def folder_remove_project(
)


def _get_subquery_my_access_rights(
access_via_gid: _GroupID, access_via_folder_id: _FolderID | None
) -> ScalarSelect:
return (
sa.select(
sa.func.jsonb_build_object(
"read",
folders_access_rights.c.read,
"write",
folders_access_rights.c.write,
"delete",
folders_access_rights.c.delete,
).label("my_access_rights"),
)
.where(
folders_access_rights.c.folder_id == access_via_folder_id
if access_via_gid and access_via_folder_id
else folders_access_rights.c.folder_id == folders.c.id
)
.where(folders_access_rights.c.gid == access_via_gid)
.correlate(folders)
.scalar_subquery()
)


_SUBQUERY_ACCESS_RIGHTS: Final[ScalarSelect] = (
sa.select(
sa.func.jsonb_object_agg(
matusdrobuliak66 marked this conversation as resolved.
Show resolved Hide resolved
folders_access_rights.c.gid,
sa.func.jsonb_build_object(
"read",
folders_access_rights.c.read,
"write",
folders_access_rights.c.write,
"delete",
folders_access_rights.c.delete,
),
).label("access_rights"),
)
.where(folders_access_rights.c.folder_id == folders.c.id)
.correlate(folders)
.scalar_subquery()
)


async def folder_list(
connection: SAConnection,
product_name: _ProductName,
Expand Down Expand Up @@ -968,55 +1015,17 @@ async def folder_list(
access_via_gid = resolved_access_rights.gid
access_via_folder_id = resolved_access_rights.folder_id

subquery_my_access_rights = (
sa.select(
sa.func.jsonb_build_object(
"read",
folders_access_rights.c.read,
"write",
folders_access_rights.c.write,
"delete",
folders_access_rights.c.delete,
).label("my_access_rights"),
)
.where(
folders_access_rights.c.folder_id == access_via_folder_id
if access_via_gid and access_via_folder_id
else folders_access_rights.c.folder_id == folders.c.id
)
.where(folders_access_rights.c.gid == access_via_gid)
.correlate(folders)
.scalar_subquery()
)

subquery_access_rights = (
sa.select(
sa.func.jsonb_object_agg(
folders_access_rights.c.gid,
sa.func.jsonb_build_object(
"read",
folders_access_rights.c.read,
"write",
folders_access_rights.c.write,
"delete",
folders_access_rights.c.delete,
),
).label("access_rights"),
)
.where(folders_access_rights.c.folder_id == folders.c.id)
.correlate(folders)
.scalar_subquery()
)

query = (
sa.select(
folders,
folders_access_rights,
folders_access_rights.c.created.label("access_created"),
folders_access_rights.c.modified.label("access_modified"),
sa.literal_column(f"{access_via_gid}").label("access_via_gid"),
subquery_my_access_rights.label("my_access_rights"),
subquery_access_rights.label("access_rights"),
_get_subquery_my_access_rights(
access_via_gid, access_via_folder_id
).label("my_access_rights"),
_SUBQUERY_ACCESS_RIGHTS.label("access_rights"),
)
.join(
folders_access_rights, folders.c.id == folders_access_rights.c.folder_id
Expand Down Expand Up @@ -1046,3 +1055,61 @@ async def folder_list(
results.append(FolderEntry.from_orm(entry)) # noqa: PERF401s

return results


async def folder_get(
connection: SAConnection,
product_name: _ProductName,
folder_id: _FolderID,
gid: _GroupID,
*,
required_permissions=_requires(_BasePermissions.GET_FOLDER), # noqa: B008
) -> FolderEntry:
async with connection.begin():
resolved_access_rights: _ResolvedAccessRights = await _check_folder_and_access(
connection,
product_name,
folder_id=folder_id,
gid=gid,
permissions=required_permissions,
enforece_all_permissions=False,
)
access_via_gid = resolved_access_rights.gid
access_via_folder_id = resolved_access_rights.folder_id

query = (
sa.select(
folders,
folders_access_rights,
folders_access_rights.c.created.label("access_created"),
folders_access_rights.c.modified.label("access_modified"),
sa.literal_column(f"{access_via_gid}").label("access_via_gid"),
_get_subquery_my_access_rights(
access_via_gid, access_via_folder_id
).label("my_access_rights"),
_SUBQUERY_ACCESS_RIGHTS.label("access_rights"),
)
.join(
folders_access_rights, folders.c.id == folders_access_rights.c.folder_id
)
.where(folders_access_rights.c.folder_id == folder_id)
.where(folders_access_rights.c.gid.in_([access_via_gid]))
.where(
_get_and_calsue_with_only_true_entries(
required_permissions, folders_access_rights
)
if folder_id is None
else True
)
)

query_result: RowProxy | None = await (
await connection.execute(query.params(start_folder_id=folder_id))
).fetchone()

if query_result is None:
raise FolderNotFoundError(
folder_id=folder_id, gid=gid, product_name=product_name
)

return FolderEntry.from_orm(query_result)
86 changes: 86 additions & 0 deletions packages/postgres-database/tests/test_utils_folders.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,7 @@
folder_add_project,
folder_create,
folder_delete,
folder_get,
folder_list,
folder_move,
folder_remove_project,
Expand Down Expand Up @@ -2015,3 +2016,88 @@ async def test_folder_list_shared_with_different_permissions(
),
},
)


async def test_folder_get(
connection: SAConnection,
default_product_name: _ProductName,
get_unique_gids: Callable[[int], tuple[_GroupID, ...]],
make_folders: Callable[[set[MkFolder]], Awaitable[dict[str, _FolderID]]],
):
#######
# SETUP
#######
(
gid_owner,
gid_other_owner,
gid_not_shared,
) = get_unique_gids(3)

folder_ids = await make_folders(
{
MkFolder(
name="owner_folder",
gid=gid_owner,
shared_with={
gid_other_owner: FolderAccessRole.OWNER,
},
children={
*{MkFolder(name=f"f{i}", gid=gid_owner) for i in range(1, 3)},
MkFolder(
name="f10",
gid=gid_owner,
children={
MkFolder(name=f"sub_f{i}", gid=gid_owner)
for i in range(1, 3)
},
),
},
)
}
)

folder_id_owner_folder = folder_ids["owner_folder"]
folder_id_f1 = folder_ids["f1"]
folder_id_f2 = folder_ids["f2"]
folder_id_sub_f1 = folder_ids["sub_f1"]
folder_id_sub_f2 = folder_ids["sub_f2"]

#######
# TESTS
#######

# 1. query exsisting directories
for folder_id_to_list in (
None,
folder_id_owner_folder,
folder_id_f1,
folder_id_f2,
folder_id_sub_f1,
folder_id_sub_f2,
):
folder_entries = await _list_folder_as(
connection, default_product_name, folder_id_to_list, gid_owner
)
for entry in folder_entries:
queried_folder = await folder_get(
connection, default_product_name, entry.id, entry.access_via_gid
)
assert entry == queried_folder

# 2. query via gid_not_shared
with pytest.raises(FolderNotSharedWithGidError):
await folder_get(
connection, default_product_name, folder_id_owner_folder, gid_not_shared
)

# 3. query with missing folder_id
missing_folder_id = 12312313123
for gid_to_test in (
gid_owner,
gid_other_owner,
gid_not_shared,
):
with pytest.raises(FolderNotFoundError):
await folder_get(
connection, default_product_name, missing_folder_id, gid_to_test
)
Loading