refactored file_based_task_creation to use project id function

Author: andrewelamb

synapseclient/extensions/curator/file_based_metadata_task.py

@@ -430,27 +430,18 @@ def create_file_based_metadata_task(
     synapse_client.logger.info(
         "Attempting to get the Synapse ID of the provided folders project."
     )
-    try:
-        entity = Folder(folder_id).get(synapse_client=synapse_client)
-        parent = synapse_client.get(entity.parent_id)
-        project = None
-        while not project:
-            if parent.concreteType == "org.sagebionetworks.repo.model.Project":
-                project = parent
-                break
-            parent = synapse_client.get(parent.parentId)
-    except Exception as e:
-        synapse_client.logger.exception(
-            "Error getting the Synapse ID of the provided folders project"
-        )
-        raise e
+    from synapseclient.extensions.curator.record_based_metadata_task import (
+        project_id_from_entity_id,
+    )
+
+    project_id = project_id_from_entity_id(folder_id, synapse_client=synapse_client)
     synapse_client.logger.info("Got the Synapse ID of the provided folders project.")
 
     synapse_client.logger.info("Attempting to create the CurationTask.")
     try:
         task = CurationTask(
             data_type=task_datatype,
-            project_id=project.id,
+            project_id=project_id,
             instructions=instructions,
             assignee_principal_id=(
                 str(assignee_principal_id)

tests/unit/synapseclient/extensions/unit_test_curator.py

@@ -72,11 +72,15 @@ def setUp(self):
         self.mock_syn = Mock(spec=Synapse)
         self.mock_syn.logger = Mock()
         self.folder_id = "syn12345678"
+        self.project_id = "syn11111111"
         self.curation_task_name = "TestCurationTask"
         self.instructions = "Test instructions"
         self.entity_view_name = "Test Entity View"
         self.schema_uri = "sage.schemas.v2571-amp.Biospecimen.schema-0.0.1"
 
+    @patch(
+        "synapseclient.extensions.curator.record_based_metadata_task.project_id_from_entity_id"
+    )
     @patch(
         "synapseclient.extensions.curator.file_based_metadata_task.Synapse.get_client"
     )
@@ -97,11 +101,13 @@ def test_create_file_based_metadata_task_success_with_schema(
         mock_create_wiki,
         mock_create_entity_view,
         mock_get_client,
+        mock_get_project_id_from_entity_id,
     ):
         """Test successful creation with schema binding."""
         # GIVEN a file-based metadata task with schema binding
         mock_get_client.return_value = self.mock_syn
         mock_create_entity_view.return_value = "syn87654321"
+        mock_get_project_id_from_entity_id.return_value = self.project_id
 
         mock_folder = Mock()
         mock_folder_cls.return_value = mock_folder
@@ -148,6 +154,9 @@ def test_create_file_based_metadata_task_success_with_schema(
         )
         mock_get.assert_called_once_with(self.folder_id, synapse_client=self.mock_syn)
 
+    @patch(
+        "synapseclient.extensions.curator.record_based_metadata_task.project_id_from_entity_id"
+    )
     @patch(
         "synapseclient.extensions.curator.file_based_metadata_task.Synapse.get_client"
     )
@@ -162,11 +171,13 @@ def test_create_file_based_metadata_task_success_without_schema_no_wiki(
         mock_folder_cls,
         mock_create_entity_view,
         mock_get_client,
+        mock_get_project_id_from_entity_id,
     ):
         """Test successful creation without schema binding and without wiki."""
         # GIVEN a file-based metadata task without schema binding or wiki
         mock_get_client.return_value = self.mock_syn
         mock_create_entity_view.return_value = "syn87654321"
+        mock_get_project_id_from_entity_id.return_value = self.project_id
 
         mock_folder = Mock()
         mock_folder_cls.return_value = mock_folder
@@ -382,58 +393,8 @@ def test_create_file_based_metadata_task_schema_retrieval_error(
             )
 
     @patch(
-        "synapseclient.extensions.curator.file_based_metadata_task.Synapse.get_client"
+        "synapseclient.extensions.curator.record_based_metadata_task.project_id_from_entity_id"
     )
-    @patch(
-        "synapseclient.extensions.curator.file_based_metadata_task.create_json_schema_entity_view"
-    )
-    @patch("synapseclient.extensions.curator.file_based_metadata_task.Folder")
-    def test_create_file_based_metadata_task_project_traversal(
-        self, mock_folder_cls, mock_create_entity_view, mock_get_client
-    ):
-        """Test project traversal to find parent project."""
-        mock_get_client.return_value = self.mock_syn
-        mock_create_entity_view.return_value = "syn87654321"
-
-        mock_folder = Mock()
-        mock_folder_cls.return_value = mock_folder
-        mock_folder.get.return_value = mock_folder
-        mock_folder.parent_id = "syn11111111"
-
-        # Mock parent folder
-        mock_parent_folder = Mock()
-        mock_parent_folder.concreteType = "org.sagebionetworks.repo.model.Folder"
-        mock_parent_folder.parentId = "syn22222222"
-
-        # Mock project
-        mock_project = Mock()
-        mock_project.concreteType = "org.sagebionetworks.repo.model.Project"
-        mock_project.id = "syn22222222"
-
-        self.mock_syn.get.side_effect = [mock_parent_folder, mock_project]
-
-        mock_task = Mock()
-        mock_task.task_id = "task123"
-
-        with patch(
-            "synapseclient.extensions.curator.file_based_metadata_task.CurationTask"
-        ) as mock_curation_task_cls:
-            mock_curation_task = Mock()
-            mock_curation_task.store.return_value = mock_task
-            mock_curation_task_cls.return_value = mock_curation_task
-
-            result = create_file_based_metadata_task(
-                folder_id=self.folder_id,
-                curation_task_name=self.curation_task_name,
-                instructions=self.instructions,
-                attach_wiki=False,
-                synapse_client=self.mock_syn,
-            )
-
-        self.assertEqual(result, ("syn87654321", "task123"))
-        # Verify that syn.get was called twice (for parent folder and project)
-        self.assertEqual(self.mock_syn.get.call_count, 2)
-
     @patch(
         "synapseclient.extensions.curator.file_based_metadata_task.Synapse.get_client"
     )
@@ -448,6 +409,7 @@ def test_create_file_based_metadata_task_with_assignee(
         mock_folder_cls,
         mock_create_entity_view,
         mock_get_client,
+        mock_get_project_id_from_entity_id,
     ):
         """Test successful creation of file-based metadata task with assignee_principal_id."""
         # Test both string and int inputs - int should be converted to string
@@ -463,10 +425,12 @@ def test_create_file_based_metadata_task_with_assignee(
                 mock_folder_cls.reset_mock()
                 mock_create_entity_view.reset_mock()
                 mock_get_client.reset_mock()
+                mock_get_project_id_from_entity_id.reset_mock()
 
                 # GIVEN a file-based metadata task with assignee_principal_id
                 mock_get_client.return_value = self.mock_syn
                 mock_create_entity_view.return_value = "test_entity_view_id"
+                mock_get_project_id_from_entity_id.return_value = self.project_id
 
                 mock_folder = Mock()
                 mock_folder_cls.return_value = mock_folder
@@ -500,7 +464,7 @@ def test_create_file_based_metadata_task_with_assignee(
                 # THEN the CurationTask should be called with assignee_principal_id as string
                 mock_curation_task_cls.assert_called_once_with(
                     data_type=self.curation_task_name,
-                    project_id="syn22222222",
+                    project_id=self.project_id,
                     instructions=self.instructions,
                     assignee_principal_id=expected_assignee,
                     task_properties=FileBasedMetadataTaskProperties(