fixing tests

Author: sanderegg

services/web/server/src/simcore_service_webserver/collaboration/settings.py

@@ -14,7 +14,7 @@ class RealTimeCollaborationSettings(BaseCustomSettings):
     RTC_MAX_NUMBER_OF_USERS: Annotated[
         PositiveInt | None,
         Field(
-            description="Maximum number of users allowed in a real-time collaboration session",
+            description="Maximum number of user sessions allowed on a single project at once. (null disables the limit)",
         ),
     ]
 

services/web/server/src/simcore_service_webserver/projects/_controller/projects_states_rest.py

@@ -102,10 +102,12 @@ async def open_project(request: web.Request) -> web.Response:
             client_session_id=client_session_id,
             app=request.app,
             max_number_of_opened_projects_per_user=product.max_open_studies_per_user,
+            allow_multiple_sessions=app_settings.WEBSERVER_REALTIME_COLLABORATION
+            is not None,
             max_number_of_user_sessions_per_project=(
-                1
-                if not app_settings.WEBSERVER_REALTIME_COLLABORATION
-                else app_settings.WEBSERVER_REALTIME_COLLABORATION.RTC_MAX_NUMBER_OF_USERS
+                app_settings.WEBSERVER_REALTIME_COLLABORATION.RTC_MAX_NUMBER_OF_USERS
+                if app_settings.WEBSERVER_REALTIME_COLLABORATION
+                else None
             ),
         ):
             raise HTTPLockedError(text="Project is locked, try later")

services/web/server/src/simcore_service_webserver/projects/_projects_service.py

@@ -1368,7 +1368,9 @@ async def try_open_project_for_user(
     project_uuid: ProjectID,
     client_session_id: str,
     app: web.Application,
+    *,
     max_number_of_opened_projects_per_user: int | None,
+    allow_multiple_sessions: bool,
     max_number_of_user_sessions_per_project: PositiveInt | None,
 ) -> bool:
     """
@@ -1426,18 +1428,22 @@ async def _open_project() -> bool:
                         project_uuid=project_uuid,
                         client_session_id=client_session_id,
                     )
-                if (
-                    max_number_of_user_sessions_per_project is None
-                    or not sessions_with_project
-                ) or (
-                    len(sessions_with_project) < max_number_of_user_sessions_per_project
+                if not sessions_with_project or (
+                    allow_multiple_sessions
+                    and (
+                        max_number_of_user_sessions_per_project is None
+                        or (
+                            len(sessions_with_project)
+                            < max_number_of_user_sessions_per_project
+                        )
+                    )
                 ):
                     # if there are no sessions with this project, or the number of sessions is less than the maximum allowed
                     await user_session.add(PROJECT_ID_KEY, f"{project_uuid}")
                     return True
 
                 # NOTE: Special case for backwards compatibility, allow to close a tab and open the project again in a new tab
-                if max_number_of_user_sessions_per_project == 1:
+                if not allow_multiple_sessions:
                     current_session = user_session.get_id()
                     user_ids: set[int] = {s.user_id for s in sessions_with_project}
                     if user_ids.issubset({user_id}):

services/web/server/tests/unit/with_dbs/02/test_projects_states_handlers.py

@@ -37,7 +37,6 @@
 )
 from models_library.api_schemas_webserver.projects_nodes import NodeGet, NodeGetIdle
 from models_library.projects import ProjectID
-from models_library.projects_access import Owner
 from models_library.projects_state import (
     ProjectRunningState,
     ProjectStatus,
@@ -51,6 +50,7 @@
 from models_library.utils.fastapi_encoders import jsonable_encoder
 from pytest_mock import MockerFixture
 from pytest_simcore.helpers.assert_checks import assert_status
+from pytest_simcore.helpers.monkeypatch_envs import setenvs_from_dict
 from pytest_simcore.helpers.typing_env import EnvVarsDict
 from pytest_simcore.helpers.webserver_login import log_client_in
 from pytest_simcore.helpers.webserver_parametrizations import (
@@ -80,12 +80,26 @@ def app_environment(
     app_environment: EnvVarsDict, monkeypatch: pytest.MonkeyPatch
 ) -> EnvVarsDict:
     # disable the garbage collector
-    monkeypatch.setenv("WEBSERVER_GARBAGE_COLLECTOR", "null")
-    monkeypatch.setenv("WEBSERVER_DEV_FEATURES_ENABLED", "1")
-    return app_environment | {
-        "WEBSERVER_GARBAGE_COLLECTOR": "null",
-        "WEBSERVER_DEV_FEATURES_ENABLED": "1",
-    }
+    return app_environment | setenvs_from_dict(
+        monkeypatch,
+        {
+            "WEBSERVER_GARBAGE_COLLECTOR": "null",
+            "WEBSERVER_DEV_FEATURES_ENABLED": "1",
+        },
+    )
+
+
+@pytest.fixture
+def with_disabled_rtx_collaboration(
+    app_environment: EnvVarsDict, monkeypatch: pytest.MonkeyPatch
+) -> EnvVarsDict:
+    # disable the real-time collaboration settings
+    return app_environment | setenvs_from_dict(
+        monkeypatch,
+        {
+            "WEBSERVER_REALTIME_COLLABORATION": "null",
+        },
+    )
 
 
 def assert_replaced(current_project, update_data):
@@ -723,7 +737,8 @@ async def test_open_project_with_small_amount_of_dynamic_services_starts_them_au
 
 
 @pytest.mark.parametrize(*standard_user_role_response())
-async def test_open_project_with_disable_service_auto_start_set_overrides_behavior(
+async def test_open_project_with_disable_service_auto_start_set_overrides_behavior_collaboration_disabled(
+    with_disabled_rtx_collaboration: EnvVarsDict,
     client: TestClient,
     logged_user: UserInfoDict,
     user_project_with_num_dynamic_services: Callable[[int], Awaitable[ProjectDict]],
@@ -1038,7 +1053,8 @@ async def test_close_project(
         (UserRole.TESTER, status.HTTP_200_OK),
     ],
 )
-async def test_get_active_project(
+async def test_get_active_project_disabled_collaboration(
+    with_disabled_rtx_collaboration: EnvVarsDict,
     client: TestClient,
     logged_user: UserInfoDict,
     user_project: ProjectDict,
@@ -1334,6 +1350,7 @@ def clean_redis_table(redis_client) -> None:
 
 @pytest.mark.parametrize(*standard_user_role_response())
 async def test_open_shared_project_2_users_locked(
+    with_disabled_rtx_collaboration: EnvVarsDict,
     client: TestClient,
     client_on_running_server_factory: Callable[[], TestClient],
     logged_user: dict,
@@ -1388,16 +1405,18 @@ async def test_open_shared_project_2_users_locked(
         expected.ok if user_role != UserRole.GUEST else status.HTTP_200_OK,
     )
     # now the expected result is that the project is locked and opened by client 1
-    owner1 = Owner(
-        user_id=logged_user["id"],
-        first_name=logged_user.get("first_name"),
-        last_name=logged_user.get("last_name"),
+    expected_project_state_client_1 = expected_project_state_client_1.model_copy(
+        update={
+            "share_state": ProjectShareStateOutputSchema(
+                locked=True,
+                status=ProjectStatus.OPENED,
+                current_user_groupids=[
+                    logged_user["primary_gid"]
+                ],  # this should be the group of that user
+            ),
+        }
     )
-    expected_project_state_client_1.share_state.locked = True
-    expected_project_state_client_1.share_state.status = ProjectStatus.OPENED
-    expected_project_state_client_1.share_state.current_user_groupids = logged_user[
-        "primary_gid"
-    ]
+
     # NOTE: there are 2 calls since we are part of the primary group and the all group
     await _assert_project_state_updated(
         mock_project_state_updated_handler,
@@ -1432,8 +1451,15 @@ async def test_open_shared_project_2_users_locked(
         shared_project,
         expected.locked if user_role != UserRole.GUEST else status.HTTP_423_LOCKED,
     )
-    expected_project_state_client_2 = deepcopy(expected_project_state_client_1)
-    expected_project_state_client_2.share_state.status = ProjectStatus.OPENED
+    expected_project_state_client_2 = expected_project_state_client_1.model_copy(
+        update={
+            "share_state": ProjectShareStateOutputSchema(
+                locked=expected_project_state_client_1.share_state.locked,
+                status=ProjectStatus.OPENED,
+                current_user_groupids=expected_project_state_client_1.share_state.current_user_groupids,
+            ),
+        }
+    )
 
     await _state_project(
         client_2,
@@ -1465,9 +1491,7 @@ async def test_open_shared_project_2_users_locked(
                     "share_state": ProjectShareStateOutputSchema(
                         locked=True,
                         status=ProjectStatus.CLOSING,
-                        current_user_groupids=[
-                            owner1.user_id
-                        ],  # this should be the group of that user
+                        current_user_groupids=[logged_user["primary_gid"]],
                     )
                 }
             )
@@ -1499,21 +1523,25 @@ async def test_open_shared_project_2_users_locked(
         expected.ok if user_role != UserRole.GUEST else status.HTTP_423_LOCKED,
     )
     if not any(user_role == role for role in [UserRole.ANONYMOUS, UserRole.GUEST]):
-        expected_project_state_client_2.share_state.locked = True
-        expected_project_state_client_2.share_state.status = ProjectStatus.OPENED
-        owner2 = Owner(
-            user_id=user_2["id"],
-            first_name=user_2.get("first_name", None),
-            last_name=user_2.get("last_name", None),
+        expected_project_state_client_2 = expected_project_state_client_1.model_copy(
+            update={
+                "share_state": ProjectShareStateOutputSchema(
+                    locked=True,
+                    status=ProjectStatus.OPENED,
+                    current_user_groupids=[int(user_2["primary_gid"])],
+                ),
+            }
         )
-        expected_project_state_client_2.share_state.current_user_groupids = [
-            owner2.user_id
-        ]  # this should be the group of that user
-        expected_project_state_client_1.share_state.locked = True
-        expected_project_state_client_1.share_state.status = ProjectStatus.OPENED
-        expected_project_state_client_1.share_state.current_user_groupids = [
-            owner2.user_id
-        ]  # this should be the group of that user
+        expected_project_state_client_1 = expected_project_state_client_1.model_copy(
+            update={
+                "share_state": ProjectShareStateOutputSchema(
+                    locked=True,
+                    status=ProjectStatus.OPENED,
+                    current_user_groupids=[int(user_2["primary_gid"])],
+                ),
+            }
+        )
+
     # NOTE: there are 3 calls since we are part of the primary group and the all group
     await _assert_project_state_updated(
         mock_project_state_updated_handler,
@@ -1535,6 +1563,7 @@ async def test_open_shared_project_2_users_locked(
 
 @pytest.mark.parametrize(*standard_user_role_response())
 async def test_open_shared_project_at_same_time(
+    with_disabled_rtx_collaboration: EnvVarsDict,
     client: TestClient,
     client_on_running_server_factory: Callable[[], TestClient],
     logged_user: dict,
@@ -1619,9 +1648,10 @@ async def test_open_shared_project_at_same_time(
                 assert data == {k: shared_project[k] for k in data}
                 assert project_status.share_state.locked
                 assert project_status.share_state.current_user_groupids
-                assert project_status.share_state.current_user_groupids in [
-                    c["user"]["first_name"] for c in clients
-                ]  # TODO: this will fail
+                assert len(project_status.share_state.current_user_groupids) == 1
+                assert project_status.share_state.current_user_groupids[0] in [
+                    c["user"]["primary_gid"] for c in clients
+                ]
 
         assert num_assertions == NUMBER_OF_ADDITIONAL_CLIENTS