feat: add tags filtering to Project.get_case_ids, Project.get_project_ids, and metadata (#1341)

* feat: add tag filtering support to Project class + metadata and class property, get_case_ids/get_project_ids methods

499f63b

* fix: remove unused imports + dangerous default value

* feat: add property tags to AssetBase

Author: dawoodhq

flow360/component/case.py

@@ -182,7 +182,6 @@ class CaseMetaV2(AssetMetaBaseModelV2):
     """
 
     id: str = pd.Field(alias="caseId")
-    case_mesh_id: str = pd.Field(alias="caseMeshId")
     status: Flow360Status = pd.Field()
 
     def to_case(self) -> Case:
@@ -546,6 +545,13 @@ def info(self) -> CaseMetaV2:
         """
         return super().info
 
+    @property
+    def info_v2(self) -> CaseMetaV2:
+        """
+        returns metadata v2 info for case
+        """
+        return self._web_api_v2.info
+
     @property
     def project_id(self) -> Optional[str]:
         """Returns the project id of the case if case was run with V2 interface."""
@@ -555,6 +561,13 @@ def project_id(self) -> Optional[str]:
             return self.info.project_id
         raise ValueError("Case info is not of type CaseMeta or CaseMetaV2")
 
+    @property
+    def tags(self) -> List[str]:
+        """
+        get case tags
+        """
+        return self._web_api_v2.info.tags
+
     @property
     def volume_mesh(self) -> "VolumeMeshV2":
         """

flow360/component/project.py

@@ -25,6 +25,7 @@
     VolumeMeshInterfaceV2,
 )
 from flow360.component.project_utils import (
+    get_project_records,
     set_up_params_for_uploading,
     show_projects_with_keyword_filter,
     validate_params_with_context,
@@ -86,6 +87,8 @@ class ProjectMeta(pd.BaseModel, extra="allow"):
         The project ID.
     name : str
         The name of the project.
+    tags : List[str]
+        List of tags associated with the project.
     root_item_id : str
         ID of the root item in the project.
     root_item_type : RootType
@@ -95,6 +98,7 @@ class ProjectMeta(pd.BaseModel, extra="allow"):
     user_id: str = pd.Field(alias="userId")
     id: str = pd.Field()
     name: str = pd.Field()
+    tags: List[str] = pd.Field(default_factory=list)
     root_item_id: str = pd.Field(alias="rootItemId")
     root_item_type: RootType = pd.Field(alias="rootItemType")
 
@@ -402,6 +406,18 @@ def id(self) -> str:
         """
         return self.metadata.id
 
+    @property
+    def tags(self) -> List[str]:
+        """
+        Returns the tags of the project.
+
+        Returns
+        -------
+        List[str]
+            List of the project's tags.
+        """
+        return self.metadata.tags
+
     @property
     def length_unit(self) -> LengthType.Positive:
         """
@@ -613,17 +629,54 @@ def get_volume_mesh_ids(self):
         # pylint: disable=protected-access
         return self.project_tree._get_asset_ids_by_type(asset_type="VolumeMesh")
 
-    def get_case_ids(self):
+    def get_case_ids(self, tags: Optional[List[str]] = None) -> List[str]:
         """
-        Returns the available IDs of cases in the project
+        Returns the available IDs of cases in the project, optionally filtered by tags.
+
+        Parameters
+        ----------
+        tags : List[str], optional
+            List of tags to filter cases by. If None or empty tags list, returns all case IDs.
 
         Returns
         -------
         Iterable[str]
-            An iterable of asset IDs.
+            An iterable of case IDs. If tags are provided, filters to return only
+            case IDs that have at least one matching tag.
         """
         # pylint: disable=protected-access
-        return self.project_tree._get_asset_ids_by_type(asset_type="Case")
+        all_case_ids = self.project_tree._get_asset_ids_by_type(asset_type="Case")
+
+        if not tags:
+            return all_case_ids
+
+        # Filter cases by tags
+        filtered_case_ids = []
+        for case_id in all_case_ids:
+            case = self.get_case(asset_id=case_id)
+            if set(tags) & set(case.info_v2.tags):
+                filtered_case_ids.append(case_id)
+
+        return filtered_case_ids
+
+    @classmethod
+    def get_project_ids(cls, tags: Optional[List[str]] = None) -> List[str]:
+        """
+        Returns the available IDs of projects, optionally filtered by tags.
+
+        Parameters
+        ----------
+        tags : List[str], optional
+            List of tags to filter projects by. If None, returns all project IDs.
+
+        Returns
+        -------
+        List[str]
+            A list of project IDs. If tags are provided, filters to return only
+            project IDs that have at least one matching tag.
+        """
+        project_records, _ = get_project_records("", tags=tags)
+        return [record.project_id for record in project_records.records]
 
     # pylint: disable=too-many-arguments
     @classmethod

flow360/component/project_utils.py

@@ -107,7 +107,9 @@ def __str__(self):
         return output_str
 
 
-def get_project_records(search_keyword: str) -> tuple[ProjectRecords, int]:
+def get_project_records(
+    search_keyword: str, tags: Optional[List[str]] = None
+) -> tuple[ProjectRecords, int]:
     """Get all projects with a keyword filter"""
     # pylint: disable=invalid-name
     MAX_SEARCHABLE_ITEM_COUNT = 1000
@@ -117,6 +119,7 @@ def get_project_records(search_keyword: str) -> tuple[ProjectRecords, int]:
             "page": "0",
             "size": MAX_SEARCHABLE_ITEM_COUNT,
             "filterKeywords": search_keyword,
+            "filterTags": tags,
             "sortFields": ["createdAt"],
             "sortDirections": ["asc"],
         }

flow360/component/simulation/web/asset_base.py

@@ -76,6 +76,13 @@ def project_id(self):
         """
         return self.info.project_id
 
+    @property
+    def tags(self) -> List[str]:
+        """
+        get asset tags
+        """
+        return self.info.tags
+
     @property
     def solver_version(self):
         """