Add related ID fields to resources

Author: rycwo

metafold/assets.py

@@ -19,13 +19,15 @@ class Asset:
         checksum: File checksum.
         created: Asset creation datetime.
         modified: Asset last modified datetime.
+        project_id: Project ID.
     """
     id: str
     filename: str
     size: int
     checksum: str
     created: datetime = field(converter=asdatetime)
     modified: datetime = field(converter=asdatetime)
+    project_id: str
 
 
 class AssetsEndpoint:

metafold/jobs.py

@@ -61,6 +61,9 @@ class Job:
         error: Error message for failed jobs.
         inputs: Input assets and parameters.
         outputs: Output assets and parameters.
+        needs: List of upstream job IDs in a workflow graph.
+        project_id: Project ID.
+        workflow_id: Workflow ID.
         assets: (Deprecated) List of generated asset resources.
         parameters: (Deprecated) Job parameters.
         meta: (Deprecated) Additional metadata generated by the job.
@@ -78,6 +81,8 @@ class Job:
     inputs: IO = field(converter=lambda v: v if isinstance(v, IO) else IO.from_dict(v))
     outputs: IO = field(converter=lambda v: v if isinstance(v, IO) else IO.from_dict(v))
     needs: list[str]
+    project_id: Optional[str] = None
+    workflow_id: Optional[str] = None
     # NOTE(ryan): Deprecated
     assets: Optional[list[Asset]] = field(
         converter=lambda v: optional(_assets)(v), default=None)

metafold/workflows.py

@@ -19,6 +19,7 @@ class Workflow:
         started: Workflow started datetime.
         finished: Workflow finished datetime.
         definition: Workflow definition string.
+        project_id: Project ID.
     """
     id: str
     jobs: list[str] = field(factory=list)
@@ -29,6 +30,7 @@ class Workflow:
     finished: Optional[datetime] = field(
         converter=lambda v: optional_datetime(v), default=None)
     definition: str
+    project_id: str
 
 
 class WorkflowsEndpoint:

pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "metafold"
-version = "0.8.dev1"
+version = "0.8.dev2"
 authors = [
     {name = "Metafold 3D", email = "[email protected]"},
 ]

tests/test_assets.py

@@ -24,6 +24,7 @@
         "checksum": "sha256:b5bb9d8014a0f9b1d61e21e796d78dccdf1352f23cd32812f4850b878ae4944c",
         "created": "Mon, 01 Jan 2024 00:00:00 GMT",
         "modified": "Mon, 01 Jan 2024 00:00:00 GMT",
+        "project_id": "1",
     },
     {
         "id": "2",
@@ -32,6 +33,7 @@
         "checksum": "sha256:6310a5951d58eb3e0fdd8c8767c606615552899e65019cb1582508a7c7bfec39",
         "created": "Mon, 01 Jan 2024 00:00:00 GMT",
         "modified": "Mon, 01 Jan 2024 00:00:00 GMT",
+        "project_id": "1",
     },
     {
         "id": "1",
@@ -40,6 +42,7 @@
         "checksum": "sha256:6310a5951d58eb3e0fdd8c8767c606615552899e65019cb1582508a7c7bfec39",
         "created": "Mon, 01 Jan 2024 00:00:00 GMT",
         "modified": "Mon, 01 Jan 2024 00:00:00 GMT",
+        "project_id": "1",
     },
 ]
 
@@ -50,6 +53,7 @@
     "checksum": "sha256:089ad5bf4831b6758e9907db43bc5ebba2e9248a9929dad6132c49932e538278",
     "created": "Mon, 01 Jan 2024 00:00:00 GMT",
     "modified": "Mon, 01 Jan 2024 00:00:00 GMT",
+    "project_id": "1",
 }
 
 
@@ -149,6 +153,7 @@ def test_get_asset(client):
         checksum="sha256:6310a5951d58eb3e0fdd8c8767c606615552899e65019cb1582508a7c7bfec39",
         created=default_dt,
         modified=default_dt,
+        project_id="1",
     )
 
 
@@ -168,6 +173,7 @@ def test_create_asset(client):
         checksum="sha256:089ad5bf4831b6758e9907db43bc5ebba2e9248a9929dad6132c49932e538278",
         created=default_dt,
         modified=default_dt,
+        project_id="1",
     )
 
 

tests/test_jobs.py

@@ -22,6 +22,7 @@
     "checksum": "sha256:6310a5951d58eb3e0fdd8c8767c606615552899e65019cb1582508a7c7bfec39",
     "created": "Mon, 01 Jan 2024 00:00:00 GMT",
     "modified": "Mon, 01 Jan 2024 00:00:00 GMT",
+    "project_id": "1",
 }
 
 asset_obj = Asset(
@@ -31,6 +32,7 @@
     checksum="sha256:6310a5951d58eb3e0fdd8c8767c606615552899e65019cb1582508a7c7bfec39",
     created=default_dt,
     modified=default_dt,
+    project_id="1",
 )
 
 # Default sort order is descending by id
@@ -51,6 +53,8 @@
             "params": None,
         },
         "needs": [],
+        "project_id": "1",
+        "workflow_id": None,
         "parameters": default_params,
         "meta": None,
     },
@@ -70,6 +74,8 @@
             "params": None,
         },
         "needs": [],
+        "project_id": "1",
+        "workflow_id": None,
         "parameters": default_params,
         "meta": None,
     },
@@ -89,6 +95,8 @@
             "params": None,
         },
         "needs": [],
+        "project_id": "1",
+        "workflow_id": None,
         "parameters": default_params,
         "meta": None,
     },
@@ -113,6 +121,8 @@
         "params": None,
     },
     "needs": [],
+    "project_id": "1",
+    "workflow_id": None,
     "assets": [],
     "parameters": {
         "foo": "1",
@@ -229,6 +239,8 @@ def test_get_job(client):
         inputs=IO(params=default_params),
         outputs=IO(),
         needs=[],
+        project_id="1",
+        workflow_id=None,
         assets=[asset_obj],
         parameters=default_params,
         meta=None,
@@ -253,6 +265,8 @@ def test_run_job(client):
         inputs=IO(params=params),
         outputs=IO(),
         needs=[],
+        project_id="1",
+        workflow_id=None,
         assets=[asset_obj],
         parameters=params,
         meta=None,
@@ -280,6 +294,8 @@ def test_poll_job(client):
         inputs=IO(params=params),
         outputs=IO(),
         needs=[],
+        project_id="1",
+        workflow_id=None,
         assets=[asset_obj],
         parameters=params,
         meta=None,

tests/test_workflows.py

@@ -19,6 +19,7 @@
         "started": "Mon, 01 Jan 2024 00:00:00 GMT",
         "finished": "Mon, 01 Jan 2024 00:00:00 GMT",
         "definition": "...",
+        "project_id": "1",
     },
     {
         "id": "2",
@@ -28,6 +29,7 @@
         "started": "Mon, 01 Jan 2024 00:00:00 GMT",
         "finished": "Mon, 01 Jan 2024 00:00:00 GMT",
         "definition": "...",
+        "project_id": "1",
     },
     {
         "id": "1",
@@ -37,6 +39,7 @@
         "started": "Mon, 01 Jan 2024 00:00:00 GMT",
         "finished": "Mon, 01 Jan 2024 00:00:00 GMT",
         "definition": "...",
+        "project_id": "1",
     },
 ]
 
@@ -47,6 +50,7 @@
     "started": "Mon, 01 Jan 2024 00:00:00 GMT",
     "finished": "Mon, 01 Jan 2024 00:00:00 GMT",
     "definition": "foo",
+    "project_id": "1",
 }
 
 poll_count: int = 0
@@ -134,6 +138,7 @@ def test_get_workflow(client):
         started=default_dt,
         finished=default_dt,
         definition="...",
+        project_id="1",
     )
 
 
@@ -148,4 +153,5 @@ def test_run_workflow(client):
         started=default_dt,
         finished=default_dt,
         definition=definition,
+        project_id="1",
     )