🎨 add project template type 🚨 (🗃️) (#7677)

Author: matusdrobuliak66

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

@@ -26,7 +26,14 @@
 from ..emails import LowerCaseEmailStr
 from ..folders import FolderID
 from ..groups import GroupID
-from ..projects import ClassifierID, DateTimeStr, NodesDict, ProjectID
+from ..projects import (
+    ClassifierID,
+    DateTimeStr,
+    NodesDict,
+    ProjectID,
+    ProjectTemplateType,
+    ProjectType,
+)
 from ..projects_access import AccessRights, GroupIDStr
 from ..projects_state import ProjectState
 from ..utils._original_fastapi_encoders import jsonable_encoder
@@ -106,6 +113,9 @@ class ProjectGet(OutputSchema):
     description: str
     thumbnail: HttpUrl | Literal[""]
 
+    type: ProjectType
+    template_type: ProjectTemplateType | None
+
     workbench: NodesDict
 
     prj_owner: LowerCaseEmailStr
@@ -153,6 +163,8 @@ def _update_json_schema_extra(schema: JsonDict) -> None:
                     "name": "My Project",
                     "description": "This is a sample project",
                     "thumbnail": "https://example.com/thumbnail.png",
+                    "type": "STANDARD",
+                    "template_type": None,
                     "workbench": {},
                     "prj_owner": "[email protected]",
                     "access_rights": {},

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

@@ -3,7 +3,7 @@
 """
 
 from datetime import datetime
-from enum import Enum
+from enum import Enum, auto
 from typing import Annotated, Any, Final, TypeAlias
 from uuid import UUID
 
@@ -25,6 +25,7 @@
     empty_str_to_none_pre_validator,
     none_to_empty_str_pre_validator,
 )
+from .utils.enums import StrAutoEnum
 
 ProjectID: TypeAlias = UUID
 CommitID: TypeAlias = int
@@ -52,6 +53,12 @@ class ProjectType(str, Enum):
     STANDARD = "STANDARD"
 
 
+class ProjectTemplateType(StrAutoEnum):
+    TEMPLATE = auto()
+    TUTORIAL = auto()
+    HYPERTOOL = auto()
+
+
 class BaseProjectModel(BaseModel):
     # Description of the project
     uuid: Annotated[
@@ -108,6 +115,12 @@ class ProjectAtDB(BaseProjectModel):
     project_type: Annotated[
         ProjectType, Field(alias="type", description="The project type")
     ]
+    template_type: Annotated[
+        ProjectTemplateType | None,
+        Field(
+            examples=["TEMPLATE", "TUTORIAL", "HYPERTOOL", None],
+        ),
+    ]
 
     prj_owner: Annotated[int | None, Field(description="The project owner id")]
 
@@ -165,6 +178,22 @@ class Project(BaseProjectModel):
     # Project state (SEE projects_state.py)
     state: ProjectState | None = None
 
+    # Type of project
+    type: Annotated[
+        ProjectType,
+        Field(
+            description="The project type",
+            examples=["TEMPLATE", "STANDARD"],
+        ),
+    ]
+    template_type: Annotated[
+        ProjectTemplateType | None,
+        Field(
+            alias="templateType",
+            examples=["TEMPLATE", "TUTORIAL", "HYPERTOOL", None],
+        ),
+    ]
+
     # UI front-end fields (SEE projects_ui.py)
     ui: dict[str, Any] | None = None
     dev: dict[str, Any] | None = None

packages/models-library/tests/test_projects.py

@@ -24,6 +24,8 @@ def minimal_project(faker: Faker) -> dict[str, Any]:
         "creationDate": "2019-05-24T10:36:57.813Z",
         "lastChangeDate": "2019-05-24T10:36:57.813Z",
         "workbench": {},
+        "type": "STANDARD",
+        "templateType": None,
     }
 
 

packages/postgres-database/src/simcore_postgres_database/migration/versions/b39f2dc87ccd_add_templatetype_to_projects.py

@@ -0,0 +1,44 @@
+"""add templateType to projects
+
+Revision ID: b39f2dc87ccd
+Revises: fc1701bb7e93
+Create Date: 2025-05-14 11:59:27.033449+00:00
+
+"""
+
+import sqlalchemy as sa
+from alembic import op
+
+# revision identifiers, used by Alembic.
+revision = "b39f2dc87ccd"
+down_revision = "fc1701bb7e93"
+branch_labels = None
+depends_on = None
+
+
+def upgrade():
+    # ### commands auto generated by Alembic - please adjust! ###
+    # Create enum type first
+    project_template_type = sa.Enum(
+        "TEMPLATE", "TUTORIAL", "HYPERTOOL", name="projecttemplatetype"
+    )
+    project_template_type.create(op.get_bind())
+
+    op.add_column(
+        "projects",
+        sa.Column(
+            "template_type",
+            project_template_type,
+            nullable=True,
+            default=None,
+        ),
+    )
+    # ### end Alembic commands ###
+    op.execute("UPDATE projects SET template_type='TEMPLATE' WHERE type='TEMPLATE'")
+
+
+def downgrade():
+    # ### commands auto generated by Alembic - please adjust! ###
+    op.drop_column("projects", "template_type")
+    # ### end Alembic commands ###
+    sa.Enum(name="projecttemplatetype").drop(op.get_bind())

packages/postgres-database/src/simcore_postgres_database/models/projects.py

@@ -16,6 +16,12 @@ class ProjectType(enum.Enum):
     STANDARD = "STANDARD"
 
 
+class ProjectTemplateType(str, enum.Enum):
+    TEMPLATE = "TEMPLATE"
+    TUTORIAL = "TUTORIAL"
+    HYPERTOOL = "HYPERTOOL"
+
+
 projects = sa.Table(
     "projects",
     metadata,
@@ -29,6 +35,13 @@ class ProjectType(enum.Enum):
         default=ProjectType.STANDARD,
         doc="Either standard or template types",
     ),
+    sa.Column(
+        "template_type",
+        sa.Enum(ProjectTemplateType),
+        nullable=True,
+        default=None,
+        doc="None if type is STANDARD, otherwise it is one of the ProjectTemplateType",
+    ),
     sa.Column(
         "uuid",
         sa.String,

packages/pytest-simcore/src/pytest_simcore/simcore_webserver_projects_rest_api.py

@@ -75,6 +75,8 @@ def request_desc(self) -> str:
             },
             "dev": None,
             "workspace_id": None,
+            "type": "STANDARD",
+            "templateType": None,
             "folder_id": None,
             "trashedAt": None,
             "trashedBy": None,
@@ -102,6 +104,8 @@ def request_desc(self) -> str:
             "lastChangeDate": "2021-12-06T10:13:03.100Z",
             "workbench": {},
             "workspaceId": 123,
+            "type": "STANDARD",
+            "templateType": None,
             "folderId": 2,
             "accessRights": {"2": {"read": True, "write": True, "delete": True}},
             "dev": {},
@@ -157,6 +161,8 @@ def request_desc(self) -> str:
                 "state": {"value": "NOT_STARTED"},
             },
             "workspace_id": None,
+            "type": "STANDARD",
+            "templateType": None,
             "folder_id": None,
             "trashedAt": None,
             "trashedBy": None,
@@ -232,6 +238,8 @@ def request_desc(self) -> str:
             "creationDate": "2021-12-06T10:13:03.100Z",
             "lastChangeDate": "2021-12-06T10:13:07.347Z",
             "workbench": {},
+            "type": "STANDARD",
+            "templateType": None,
             "accessRights": {"2": {"read": True, "write": True, "delete": True}},
             "dev": {},
             "classifiers": [],
@@ -482,6 +490,8 @@ def request_desc(self) -> str:
             "accessRights": {"2": {"read": True, "write": True, "delete": True}},
             "dev": {},
             "workspace_id": None,
+            "type": "STANDARD",
+            "templateType": None,
             "folder_id": None,
             "trashedAt": None,
             "trashedBy": None,
@@ -684,6 +694,8 @@ def request_desc(self) -> str:
                 "classifiers": [],
                 "dev": {},
                 "workspace_id": None,
+                "type": "STANDARD",
+                "templateType": None,
                 "folder_id": None,
                 "trashedAt": None,
                 "trashed_by": None,
@@ -935,6 +947,8 @@ def request_desc(self) -> str:
             "classifiers": [],
             "dev": {},
             "workspace_id": None,
+            "type": "STANDARD",
+            "templateType": None,
             "folder_id": None,
             "trashedAt": None,
             "trashedBy": None,