✨ introduce /projects:search full search (ITISFoundation#6464)

Author: matusdrobuliak66

api/specs/web-server/_projects_crud.py

@@ -32,7 +32,10 @@
 from simcore_service_webserver._meta import API_VTAG
 from simcore_service_webserver.projects._common_models import ProjectPathParams
 from simcore_service_webserver.projects._crud_handlers import ProjectCreateParams
-from simcore_service_webserver.projects._crud_handlers_models import ProjectListParams
+from simcore_service_webserver.projects._crud_handlers_models import (
+    ProjectListFullSearchParams,
+    ProjectListParams,
+)
 
 router = APIRouter(
     prefix=f"/{API_VTAG}",
@@ -137,6 +140,16 @@ async def clone_project(
     ...
 
 
+@router.get(
+    "/projects:search",
+    response_model=Page[ProjectListItem],
+)
+async def list_projects_full_search(
+    _params: Annotated[ProjectListFullSearchParams, Depends()],
+):
+    ...
+
+
 @router.get(
     "/projects/{project_id}/inactivity",
     response_model=Envelope[GetProjectInactivityResponse],

services/web/server/src/simcore_service_webserver/api/v0/openapi.yaml

@@ -3291,6 +3291,45 @@ paths:
             application/json:
               schema:
                 $ref: '#/components/schemas/Envelope_TaskGet_'
+  /v0/projects:search:
+    get:
+      tags:
+      - projects
+      summary: List Projects Full Search
+      operationId: list_projects_full_search
+      parameters:
+      - required: false
+        schema:
+          title: Limit
+          exclusiveMaximum: true
+          minimum: 1
+          type: integer
+          default: 20
+          maximum: 50
+        name: limit
+        in: query
+      - required: false
+        schema:
+          title: Offset
+          minimum: 0
+          type: integer
+          default: 0
+        name: offset
+        in: query
+      - required: false
+        schema:
+          title: Text
+          maxLength: 100
+          type: string
+        name: text
+        in: query
+      responses:
+        '200':
+          description: Successful Response
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/Page_ProjectListItem_'
   /v0/projects/{project_id}/inactivity:
     get:
       tags:
@@ -9148,18 +9187,6 @@ components:
           title: Userid
           type: string
           description: the user that started the service
-      example:
-        published_port: 30000
-        entrypoint: /the/entry/point/is/here
-        service_uuid: 3fa85f64-5717-4562-b3fc-2c963f66afa6
-        service_key: simcore/services/comp/itis/sleeper
-        service_version: 1.2.3
-        service_host: jupyter_E1O2E-LAH
-        service_port: 8081
-        service_basepath: /x/E1O2E-LAH
-        service_state: pending
-        service_message: no suitable node (insufficient resources on 1 node)
-        user_id: 123
     NodeGetIdle:
       title: NodeGetIdle
       required:
@@ -11601,13 +11628,14 @@ components:
     ServiceState:
       title: ServiceState
       enum:
+      - failed
       - pending
       - pulling
       - starting
       - running
-      - complete
-      - failed
       - stopping
+      - complete
+      - idle
       description: An enumeration.
     ServiceType:
       title: ServiceType

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

@@ -5,7 +5,6 @@
 
 """
 
-
 from aiohttp import web
 from models_library.access_rights import AccessRights
 from models_library.api_schemas_webserver._base import OutputSchema
@@ -143,6 +142,28 @@ async def list_projects(  # pylint: disable=too-many-arguments
     return projects, total_number_projects
 
 
+async def list_projects_full_search(
+    app,
+    *,
+    user_id: UserID,
+    product_name: str,
+    offset: NonNegativeInt,
+    limit: int,
+    text: str | None,
+) -> tuple[list[ProjectDict], int]:
+    db = ProjectDBAPI.get_from_app_context(app)
+
+    total_number_projects, db_projects = await db.list_projects_full_search(
+        user_id=user_id,
+        product_name=product_name,
+        text=text,
+        offset=offset,
+        limit=limit,
+    )
+
+    return db_projects, total_number_projects
+
+
 async def get_project(
     request: web.Request,
     user_id: UserID,

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

@@ -58,6 +58,7 @@
     ProjectActiveParams,
     ProjectCreateHeaders,
     ProjectCreateParams,
+    ProjectListFullSearchParams,
     ProjectListWithJsonStrParams,
 )
 from ._permalink_api import update_or_pop_permalink_in_project
@@ -226,6 +227,40 @@ async def list_projects(request: web.Request):
     )
 
 
+@routes.get(f"/{VTAG}/projects:search", name="list_projects_full_search")
+@login_required
+@permission_required("project.read")
+@_handle_projects_exceptions
+async def list_projects_full_search(request: web.Request):
+    req_ctx = RequestContext.parse_obj(request)
+    query_params: ProjectListFullSearchParams = parse_request_query_parameters_as(
+        ProjectListFullSearchParams, request
+    )
+
+    projects, total_number_of_projects = await _crud_api_read.list_projects_full_search(
+        request.app,
+        user_id=req_ctx.user_id,
+        product_name=req_ctx.product_name,
+        limit=query_params.limit,
+        offset=query_params.offset,
+        text=query_params.text,
+    )
+
+    page = Page[ProjectDict].parse_obj(
+        paginate_data(
+            chunk=projects,
+            request_url=request.url,
+            total=total_number_of_projects,
+            limit=query_params.limit,
+            offset=query_params.offset,
+        )
+    )
+    return web.Response(
+        text=page.json(**RESPONSE_MODEL_POLICY),
+        content_type=MIMETYPE_APPLICATION_JSON,
+    )
+
+
 #
 # - Get https://google.aip.dev/131
 # - Get active project: Singleton per-session resources https://google.aip.dev/156

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

@@ -12,7 +12,10 @@
 from models_library.projects_nodes_io import NodeID
 from models_library.rest_ordering import OrderBy, OrderDirection
 from models_library.rest_pagination import PageQueryParameters
-from models_library.utils.common_validators import null_or_none_str_to_none_validator
+from models_library.utils.common_validators import (
+    empty_str_to_none_pre_validator,
+    null_or_none_str_to_none_validator,
+)
 from models_library.workspaces import WorkspaceID
 from pydantic import BaseModel, Extra, Field, Json, root_validator, validator
 from servicelib.common_headers import (
@@ -150,3 +153,16 @@ class Config:
 
 class ProjectActiveParams(BaseModel):
     client_session_id: str
+
+
+class ProjectListFullSearchParams(PageQueryParameters):
+    text: str | None = Field(
+        default=None,
+        description="Multi column full text search, across all folders and workspaces",
+        max_length=100,
+        example="My Project",
+    )
+
+    _empty_is_none = validator("text", allow_reuse=True, pre=True)(
+        empty_str_to_none_pre_validator
+    )