Introducing Registered functions/function jobs/collections

Author: wvangeit

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

@@ -77,40 +77,26 @@ class FunctionClass(str, Enum):
 
 class FunctionBase(BaseModel):
     function_class: FunctionClass
-    uid: FunctionID | None
     title: str = ""
     description: str = ""
     input_schema: FunctionInputSchema
     output_schema: FunctionOutputSchema
     default_inputs: FunctionInputs
 
 
-class FunctionDB(BaseModel):
-    function_class: FunctionClass
-    uuid: FunctionJobID | None
-    title: str = ""
-    description: str = ""
-    input_schema: FunctionInputSchema
-    output_schema: FunctionOutputSchema
-    default_inputs: FunctionInputs
-    class_specific_data: FunctionClassSpecificData
-
-
-class FunctionJobDB(BaseModel):
-    uuid: FunctionJobID | None
-    function_uuid: FunctionID
-    title: str = ""
-    inputs: FunctionInputs
-    outputs: FunctionOutputs
-    class_specific_data: FunctionJobClassSpecificData
-    function_class: FunctionClass
+class RegisteredFunctionBase(FunctionBase):
+    uid: FunctionID
 
 
 class ProjectFunction(FunctionBase):
     function_class: Literal[FunctionClass.project] = FunctionClass.project
     project_id: ProjectID
 
 
+class RegisteredProjectFunction(ProjectFunction, RegisteredFunctionBase):
+    pass
+
+
 SolverJobID: TypeAlias = UUID
 
 
@@ -120,21 +106,32 @@ class SolverFunction(FunctionBase):
     solver_version: ServiceVersion
 
 
+class RegisteredSolverFunction(SolverFunction, RegisteredFunctionBase):
+    pass
+
+
 class PythonCodeFunction(FunctionBase):
     function_class: Literal[FunctionClass.python_code] = FunctionClass.python_code
     code_url: str
 
 
+class RegisteredPythonCodeFunction(PythonCodeFunction, RegisteredFunctionBase):
+    pass
+
+
 Function: TypeAlias = Annotated[
     ProjectFunction | PythonCodeFunction | SolverFunction,
     Field(discriminator="function_class"),
 ]
+RegisteredFunction: TypeAlias = Annotated[
+    RegisteredProjectFunction | RegisteredPythonCodeFunction | RegisteredSolverFunction,
+    Field(discriminator="function_class"),
+]
 
 FunctionJobCollectionID: TypeAlias = projects.ProjectID
 
 
 class FunctionJobBase(BaseModel):
-    uid: FunctionJobID | None
     title: str = ""
     description: str = ""
     function_uid: FunctionID
@@ -143,25 +140,48 @@ class FunctionJobBase(BaseModel):
     function_class: FunctionClass
 
 
+class RegisteredFunctionJobBase(FunctionJobBase):
+    uid: FunctionJobID
+
+
 class ProjectFunctionJob(FunctionJobBase):
     function_class: Literal[FunctionClass.project] = FunctionClass.project
     project_job_id: ProjectID
 
 
+class RegisteredProjectFunctionJob(ProjectFunctionJob, RegisteredFunctionJobBase):
+    pass
+
+
 class SolverFunctionJob(FunctionJobBase):
     function_class: Literal[FunctionClass.solver] = FunctionClass.solver
     solver_job_id: ProjectID
 
 
+class RegisteredSolverFunctionJob(SolverFunctionJob, RegisteredFunctionJobBase):
+    pass
+
+
 class PythonCodeFunctionJob(FunctionJobBase):
     function_class: Literal[FunctionClass.python_code] = FunctionClass.python_code
 
 
+class RegisteredPythonCodeFunctionJob(PythonCodeFunctionJob, RegisteredFunctionJobBase):
+    pass
+
+
 FunctionJob: TypeAlias = Annotated[
     ProjectFunctionJob | PythonCodeFunctionJob | SolverFunctionJob,
     Field(discriminator="function_class"),
 ]
 
+RegisteredFunctionJob: TypeAlias = Annotated[
+    RegisteredProjectFunctionJob
+    | RegisteredPythonCodeFunctionJob
+    | RegisteredSolverFunctionJob,
+    Field(discriminator="function_class"),
+]
+
 
 class FunctionJobStatus(BaseModel):
     status: str
@@ -170,18 +190,13 @@ class FunctionJobStatus(BaseModel):
 class FunctionJobCollection(BaseModel):
     """Model for a collection of function jobs"""
 
-    uid: FunctionJobCollectionID | None
     title: str = ""
     description: str = ""
-    job_ids: list[FunctionJobID]
+    job_ids: list[FunctionJobID] = []
 
 
-class FunctionJobCollectionDB(BaseModel):
-    """Model for a collection of function jobs"""
-
-    uuid: FunctionJobCollectionID
-    title: str = ""
-    description: str = ""
+class RegisteredFunctionJobCollection(FunctionJobCollection):
+    uid: FunctionJobCollectionID
 
 
 class FunctionJobCollectionStatus(BaseModel):

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

@@ -6,10 +6,27 @@
 import uuid
 
 import sqlalchemy as sa
+from models_library.api_schemas_webserver.functions_wb_schema import (
+    FunctionJobCollectionID,
+)
+from pydantic import BaseModel
 from sqlalchemy.dialects.postgresql import UUID
+from sqlalchemy.sql import func
 
 from .base import metadata
 
+
+class FunctionJobCollectionDB(BaseModel):
+    """Model for a collection of function jobs"""
+
+    title: str = ""
+    description: str = ""
+
+
+class RegisteredFunctionJobCollectionDB(FunctionJobCollectionDB):
+    uuid: FunctionJobCollectionID
+
+
 function_job_collections_table = sa.Table(
     "funcapi_function_job_collections",
     metadata,
@@ -31,5 +48,20 @@
         sa.String,
         doc="Description of the function job collection",
     ),
+    sa.Column(
+        "created",
+        sa.DateTime(),
+        nullable=False,
+        server_default=func.now(),
+        doc="Timestamp auto-generated upon creation",
+    ),
+    sa.Column(
+        "modified",
+        sa.DateTime(),
+        nullable=False,
+        server_default=func.now(),
+        onupdate=func.now(),
+        doc="Automaticaly updates on modification of the row",
+    ),
     sa.PrimaryKeyConstraint("uuid", name="funcapi_function_job_collections_pk"),
 )

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

@@ -4,6 +4,7 @@
 """
 
 import sqlalchemy as sa
+from sqlalchemy.sql import func
 
 from ._common import RefActions
 from .base import metadata
@@ -33,4 +34,19 @@
         ),
         doc="Unique identifier of the function job",
     ),
+    sa.Column(
+        "created",
+        sa.DateTime(),
+        nullable=False,
+        server_default=func.now(),
+        doc="Timestamp auto-generated upon creation",
+    ),
+    sa.Column(
+        "modified",
+        sa.DateTime(),
+        nullable=False,
+        server_default=func.now(),
+        onupdate=func.now(),
+        doc="Automaticaly updates on modification of the row",
+    ),
 )

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

@@ -6,12 +6,37 @@
 import uuid
 
 import sqlalchemy as sa
+from models_library.api_schemas_webserver.functions_wb_schema import (
+    FunctionClass,
+    FunctionID,
+    FunctionInputs,
+    FunctionJobClassSpecificData,
+    FunctionJobID,
+    FunctionOutputs,
+)
+from pydantic import BaseModel
 from sqlalchemy.dialects.postgresql import UUID
+from sqlalchemy.sql import func
 
 from ._common import RefActions
 from .base import metadata
 from .funcapi_functions_table import functions_table
 
+
+class FunctionJobDB(BaseModel):
+    function_uuid: FunctionID
+    title: str = ""
+    description: str = ""
+    inputs: FunctionInputs
+    outputs: FunctionOutputs
+    class_specific_data: FunctionJobClassSpecificData
+    function_class: FunctionClass
+
+
+class RegisteredFunctionJobDB(FunctionJobDB):
+    uuid: FunctionJobID
+
+
 function_jobs_table = sa.Table(
     "funcapi_function_jobs",
     metadata,
@@ -28,6 +53,11 @@
         sa.String,
         doc="Name of the function job",
     ),
+    sa.Column(
+        "description",
+        sa.String,
+        doc="Description of the function job",
+    ),
     sa.Column(
         "function_uuid",
         sa.ForeignKey(
@@ -66,5 +96,20 @@
         nullable=True,
         doc="Fields specific for a function class",
     ),
+    sa.Column(
+        "created",
+        sa.DateTime(),
+        nullable=False,
+        server_default=func.now(),
+        doc="Timestamp auto-generated upon creation",
+    ),
+    sa.Column(
+        "modified",
+        sa.DateTime(),
+        nullable=False,
+        server_default=func.now(),
+        onupdate=func.now(),
+        doc="Automaticaly updates on modification of the row",
+    ),
     sa.PrimaryKeyConstraint("uuid", name="funcapi_function_jobs_pk"),
 )

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

@@ -6,10 +6,34 @@
 import uuid
 
 import sqlalchemy as sa
+from models_library.api_schemas_webserver.functions_wb_schema import (
+    FunctionClass,
+    FunctionClassSpecificData,
+    FunctionID,
+    FunctionInputs,
+    FunctionInputSchema,
+    FunctionOutputSchema,
+)
+from pydantic import BaseModel
 from sqlalchemy.dialects.postgresql import UUID
 
 from .base import metadata
 
+
+class FunctionDB(BaseModel):
+    function_class: FunctionClass
+    title: str = ""
+    description: str = ""
+    input_schema: FunctionInputSchema
+    output_schema: FunctionOutputSchema
+    default_inputs: FunctionInputs
+    class_specific_data: FunctionClassSpecificData
+
+
+class RegisteredFunctionDB(FunctionDB):
+    uuid: FunctionID
+
+
 functions_table = sa.Table(
     "funcapi_functions",
     metadata,