Don't run after_create and after_update triggers if not specified

Author: yuanzhou

src/app.py

@@ -1204,7 +1204,7 @@ def create_entity(entity_type):
     # For Dataset: link to direct ancestors
     # For Collection: link to member Datasets
     # For Upload: link to parent Lab node
-    after_create(normalized_entity_type, request, user_token, merged_dict)
+    after_create(normalized_entity_type, request, user_token, merged_dict, json_data_dict)
 
     # By default we'll return all the properties but skip these time-consuming ones
     # Donor doesn't need to skip any
@@ -1451,12 +1451,12 @@ def update_entity(id):
             if direct_ancestor_dict['entity_type'] not in ['Donor', 'Sample']:
                 bad_request_error(f"The uuid: {direct_ancestor_uuid} is not a Donor neither a Sample, cannot be used as the direct ancestor of this Sample")
 
-        # Generate 'before_update_triiger' data and update the entity details in Neo4j
+        # Generate 'before_update_trigger' data and update the entity details in Neo4j
         merged_updated_dict = update_entity_details(request, normalized_entity_type, user_token, json_data_dict, entity_dict)
 
         # Handle linkages update via `after_update_trigger` methods
         if has_direct_ancestor_uuid:
-            after_update(normalized_entity_type, request, user_token, merged_updated_dict)
+            after_update(normalized_entity_type, request, user_token, merged_updated_dict, json_data_dict)
     # 2/17/23 - Adding direct ancestor checks to publication as well as dataset.
     elif normalized_entity_type in ['Dataset', 'Publication']:
         # A bit more validation if `direct_ancestor_uuids` provided
@@ -1482,10 +1482,15 @@ def update_entity(id):
 
         # Generate 'before_update_trigger' data and update the entity details in Neo4j
         merged_updated_dict = update_entity_details(request, normalized_entity_type, user_token, json_data_dict, entity_dict)
+        
+        print("==========DEBUG Begin")
+        print(merged_updated_dict)
+        print("==========DEBUG End")
+
 
         # Handle linkages update via `after_update_trigger` methods
         if has_direct_ancestor_uuids or has_associated_collection_uuid or has_updated_status:
-            after_update(normalized_entity_type, request, user_token, merged_updated_dict)
+            after_update(normalized_entity_type, request, user_token, merged_updated_dict, json_data_dict)
     elif normalized_entity_type == 'Upload':
         has_dataset_uuids_to_link = False
         if ('dataset_uuids_to_link' in json_data_dict) and (json_data_dict['dataset_uuids_to_link']):
@@ -1500,13 +1505,13 @@ def update_entity(id):
 
         # Handle linkages update via `after_update_trigger` methods
         if has_dataset_uuids_to_link or has_dataset_uuids_to_unlink or has_updated_status:
-            after_update(normalized_entity_type, request, user_token, merged_updated_dict)
+            after_update(normalized_entity_type, request, user_token, merged_updated_dict, json_data_dict)
     elif schema_manager.entity_type_instanceof(normalized_entity_type, 'Collection'):
         # Generate 'before_update_trigger' data and update the entity details in Neo4j
         merged_updated_dict = update_entity_details(request, normalized_entity_type, user_token, json_data_dict, entity_dict)
 
         # Handle linkages update via `after_update_trigger` methods
-        after_update(normalized_entity_type, request, user_token, merged_updated_dict)
+        after_update(normalized_entity_type, request, user_token, merged_updated_dict, json_data_dict)
     else:
         # Generate 'before_update_trigger' data and update the entity details in Neo4j
         merged_updated_dict = update_entity_details(request, normalized_entity_type, user_token, json_data_dict, entity_dict)
@@ -4580,7 +4585,7 @@ def _get_dataset_associated_metadata(dataset_dict, dataset_visibility, valid_use
 
 
 """
-Generate 'before_create_triiger' data and create the entity details in Neo4j
+Generate 'before_create_trigger' data and create the entity details in Neo4j
 
 Parameters
 ----------
@@ -5000,7 +5005,7 @@ def create_multiple_component_details(request, normalized_entity_type, user_toke
 
 
 """
-Execute 'after_create_triiger' methods
+Execute 'after_create_trigger' methods
 
 Parameters
 ----------
@@ -5013,8 +5018,10 @@ def create_multiple_component_details(request, normalized_entity_type, user_toke
 merged_data_dict: dict
     The merged dict that contains the entity dict newly created and 
     information from user request json that are not stored in Neo4j
+json_data_dict: dict
+    The json request dict
 """
-def after_create(normalized_entity_type, request, user_token, merged_data_dict):
+def after_create(normalized_entity_type, request, user_token, merged_data_dict, json_data_dict):
     try:
         # 'after_create_trigger' and 'after_update_trigger' don't generate property values
         # It just returns the empty dict, no need to assign value
@@ -5024,7 +5031,7 @@ def after_create(normalized_entity_type, request, user_token, merged_data_dict):
                                                 , request=request
                                                 , user_token=user_token
                                                 , existing_data_dict=merged_data_dict
-                                                , new_data_dict={})
+                                                , new_data_dict=json_data_dict)
     except schema_errors.AfterCreateTriggerException:
         # Log the full stack trace, prepend a line with our message
         msg = "The entity has been created, but failed to execute one of the 'after_create_trigger' methods"
@@ -5036,7 +5043,7 @@ def after_create(normalized_entity_type, request, user_token, merged_data_dict):
 
 
 """
-Generate 'before_create_triiger' data and create the entity details in Neo4j
+Generate 'before_create_trigger' data and create the entity details in Neo4j
 
 Parameters
 ----------
@@ -5133,20 +5140,19 @@ def update_entity_details(request, normalized_entity_type, user_token, json_data
     The instance of Flask request passed in from application request
 user_token: str
     The user's globus groups token
-entity_dict: dict
-    The entity dict newly updated
+merged_updated_dict: dict
+    The merged entity dict containing newly updated values and existing values
+json_data_dict: dict
+    The data dict containing new values 
 """
-def after_update(normalized_entity_type, request, user_token, entity_dict):
+def after_update(normalized_entity_type, request, user_token, merged_updated_dict, json_data_dict):
     try:
-        # 'after_create_trigger' and 'after_update_trigger' don't generate property values
-        # It just returns the empty dict, no need to assign value
-        # Use {} sicne no new dict
         schema_manager.generate_triggered_data( trigger_type=TriggerTypeEnum.AFTER_UPDATE
                                                 , normalized_class=normalized_entity_type
                                                 , request=request
                                                 , user_token=user_token
-                                                , existing_data_dict=entity_dict
-                                                , new_data_dict={})
+                                                , existing_data_dict=merged_updated_dict
+                                                , new_data_dict=json_data_dict)
     except schema_errors.AfterUpdateTriggerException:
         # Log the full stack trace, prepend a line with our message
         msg = "The entity information has been updated, but failed to execute one of the 'after_update_trigger' methods"

src/schema/schema_manager.py

@@ -410,8 +410,7 @@ def generate_triggered_data(trigger_type: TriggerTypeEnum, normalized_class, req
             if trigger_type in [TriggerTypeEnum.AFTER_CREATE, TriggerTypeEnum.AFTER_UPDATE]:
                 # Only call the triggers if the propery key presents from the incoming data
                 # E.g., 'direct_ancestor_uuid' for Sample, 'dataset_uuids' for Collection
-                # This `existing_data_dict` is the newly created or updated entity dict
-                if key in existing_data_dict:
+                if key in new_data_dict:
                     trigger_method_name = properties[key][trigger_type.value]
 
                     try:
@@ -423,8 +422,7 @@ def generate_triggered_data(trigger_type: TriggerTypeEnum, normalized_class, req
                         # No return values for 'after_create_trigger' and 'after_update_trigger'
                         # because the property value is already set and stored in neo4j
                         # Normally it's building linkages between entity nodes
-                        # Use {} since no incoming new_data_dict 
-                        trigger_method_to_call(key, normalized_class, request, user_token, existing_data_dict, {})
+                        trigger_method_to_call(key, normalized_class, request, user_token, existing_data_dict, new_data_dict)
                     except Exception:
                         msg = f"Failed to call the {trigger_type.value} method: {trigger_method_name}"
                         # Log the full stack trace, prepend a line with our message

src/schema/schema_triggers.py

@@ -848,11 +848,11 @@ def link_dataset_to_direct_ancestors(property_key, normalized_type, request, use
     if 'uuid' not in existing_data_dict:
         raise KeyError("Missing 'uuid' key in 'existing_data_dict' during calling 'link_dataset_to_direct_ancestors()' trigger method.")
 
-    if 'direct_ancestor_uuids' not in existing_data_dict:
-        raise KeyError("Missing 'direct_ancestor_uuids' key in 'existing_data_dict' during calling 'link_dataset_to_direct_ancestors()' trigger method.")
+    if 'direct_ancestor_uuids' not in new_data_dict:
+        raise KeyError("Missing 'direct_ancestor_uuids' key in 'new_data_dict' during calling 'link_dataset_to_direct_ancestors()' trigger method.")
 
     dataset_uuid = existing_data_dict['uuid']
-    direct_ancestor_uuids = existing_data_dict['direct_ancestor_uuids']
+    direct_ancestor_uuids = new_data_dict['direct_ancestor_uuids']
 
     # Generate property values for Activity node
     activity_data_dict = schema_manager.generate_activity_data(normalized_type, request, user_token, existing_data_dict)
@@ -891,11 +891,11 @@ def link_collection_to_datasets(property_key, normalized_type, request, user_tok
     if 'uuid' not in existing_data_dict:
         raise KeyError("Missing 'uuid' key in 'existing_data_dict' during calling 'link_collection_to_datasets()' trigger method.")
 
-    if 'dataset_uuids' not in existing_data_dict:
-        raise KeyError("Missing 'dataset_uuids' key in 'existing_data_dict' during calling 'link_collection_to_datasets()' trigger method.")
+    if 'dataset_uuids' not in new_data_dict:
+        raise KeyError("Missing 'dataset_uuids' key in 'new_data_dict' during calling 'link_collection_to_datasets()' trigger method.")
 
     collection_uuid = existing_data_dict['uuid']
-    dataset_uuids = existing_data_dict['dataset_uuids']
+    dataset_uuids = new_data_dict['dataset_uuids']
 
     try:
         # Create a linkage (without an Activity node) between the Collection node and each Dataset it contains.
@@ -1022,14 +1022,14 @@ def link_to_previous_revision(property_key, normalized_type, request, user_token
         if 'uuid' not in existing_data_dict:
             raise KeyError("Missing 'uuid' key in 'existing_data_dict' during calling 'link_to_previous_revision()' trigger method.")
 
-        if 'previous_revision_uuid' not in existing_data_dict:
-            raise KeyError("Missing 'previous_revision_uuid' key in 'existing_data_dict' during calling 'link_to_previous_revision()' trigger method.")
+        if 'previous_revision_uuid' not in new_data_dict:
+            raise KeyError("Missing 'previous_revision_uuid' key in 'new_data_dict' during calling 'link_to_previous_revision()' trigger method.")
 
         entity_uuid = existing_data_dict['uuid']
-        if isinstance(existing_data_dict['previous_revision_uuid'], list):
-            previous_uuid = existing_data_dict['previous_revision_uuid']
+        if isinstance(new_data_dict['previous_revision_uuid'], list):
+            previous_uuid = new_data_dict['previous_revision_uuid']
         else:
-            previous_uuid = [existing_data_dict['previous_revision_uuid']]
+            previous_uuid = [new_data_dict['previous_revision_uuid']]
 
         # Create a revision reltionship from this new Dataset node and its previous revision of dataset node in neo4j
         try:
@@ -1743,8 +1743,6 @@ def delete_thumbnail_file(property_key, normalized_type, request, user_token, ex
     A merged dictionary that contains all possible input data to be used
 """
 def update_status(property_key, normalized_type, request, user_token, existing_data_dict, new_data_dict):
-    set_status_history(property_key, normalized_type, request, user_token, existing_data_dict, new_data_dict)
-    
     if 'uuid' not in existing_data_dict:
         raise KeyError("Missing 'uuid' key in 'existing_data_dict' during calling 'update_status()' trigger method.")
     uuid = existing_data_dict['uuid']
@@ -1753,6 +1751,8 @@ def update_status(property_key, normalized_type, request, user_token, existing_d
         raise KeyError("Missing 'status' key in 'existing_data_dict' during calling 'update_status()' trigger method.")
     status = existing_data_dict['status']
 
+    set_status_history(property_key, normalized_type, request, user_token, existing_data_dict, new_data_dict)
+
     # Only apply to non-published parent datasets
     if status.lower() != 'published':
         # Only sync the child component datasets status for Multi-Assay Split
@@ -1946,14 +1946,14 @@ def link_sample_to_direct_ancestor(property_key, normalized_type, request, user_
     if 'uuid' not in existing_data_dict:
         raise KeyError("Missing 'uuid' key in 'existing_data_dict' during calling 'link_sample_to_direct_ancestor()' trigger method.")
 
-    if 'direct_ancestor_uuid' not in existing_data_dict:
-        raise KeyError("Missing 'direct_ancestor_uuid' key in 'existing_data_dict' during calling 'link_sample_to_direct_ancestor()' trigger method.")
+    if 'direct_ancestor_uuid' not in new_data_dict:
+        raise KeyError("Missing 'direct_ancestor_uuid' key in 'new_data_dict' during calling 'link_sample_to_direct_ancestor()' trigger method.")
 
     sample_uuid = existing_data_dict['uuid']
 
     # Build a list of direct ancestor uuids
     # Only one uuid in the list in this case
-    direct_ancestor_uuids = [existing_data_dict['direct_ancestor_uuid']]
+    direct_ancestor_uuids = [new_data_dict['direct_ancestor_uuid']]
 
     # Generate property values for Activity node
     activity_data_dict = schema_manager.generate_activity_data(normalized_type, request, user_token, existing_data_dict)
@@ -1992,10 +1992,10 @@ def link_publication_to_associated_collection(property_key, normalized_type, req
     if 'uuid' not in existing_data_dict:
         raise KeyError("Missing 'uuid' key in 'existing_data_dict' during calling 'link_publication_to_associated_collection()' trigger method.")
 
-    if 'associated_collection_uuid' not in existing_data_dict:
-        raise KeyError("Missing 'associated_collection_uuid' key in 'existing_data_dict' during calling 'link_publication_to_associated_collection()' trigger method.")
+    if 'associated_collection_uuid' not in new_data_dict:
+        raise KeyError("Missing 'associated_collection_uuid' key in 'new_data_dict' during calling 'link_publication_to_associated_collection()' trigger method.")
 
-    associated_collection_uuid = existing_data_dict['associated_collection_uuid']
+    associated_collection_uuid = new_data_dict['associated_collection_uuid']
 
     # No activity node. We are creating a direct link to the associated collection
 
@@ -2203,11 +2203,11 @@ def link_datasets_to_upload(property_key, normalized_type, request, user_token,
     if 'uuid' not in existing_data_dict:
         raise KeyError("Missing 'uuid' key in 'existing_data_dict' during calling 'link_datasets_to_upload()' trigger method.")
 
-    if 'dataset_uuids_to_link' not in existing_data_dict:
-        raise KeyError("Missing 'dataset_uuids_to_link' key in 'existing_data_dict' during calling 'link_datasets_to_upload()' trigger method.")
+    if 'dataset_uuids_to_link' not in new_data_dict:
+        raise KeyError("Missing 'dataset_uuids_to_link' key in 'new_data_dict' during calling 'link_datasets_to_upload()' trigger method.")
 
     upload_uuid = existing_data_dict['uuid']
-    dataset_uuids = existing_data_dict['dataset_uuids_to_link']
+    dataset_uuids = new_data_dict['dataset_uuids_to_link']
 
     try:
         # Create a direct linkage (Dataset) - [:IN_UPLOAD] -> (Submission) for each dataset
@@ -2244,11 +2244,11 @@ def unlink_datasets_from_upload(property_key, normalized_type, request, user_tok
     if 'uuid' not in existing_data_dict:
         raise KeyError("Missing 'uuid' key in 'existing_data_dict' during calling 'unlink_datasets_from_upload()' trigger method.")
 
-    if 'dataset_uuids_to_unlink' not in existing_data_dict:
-        raise KeyError("Missing 'dataset_uuids_to_unlink' key in 'existing_data_dict' during calling 'unlink_datasets_from_upload()' trigger method.")
+    if 'dataset_uuids_to_unlink' not in new_data_dict:
+        raise KeyError("Missing 'dataset_uuids_to_unlink' key in 'new_data_dict' during calling 'unlink_datasets_from_upload()' trigger method.")
 
     upload_uuid = existing_data_dict['uuid']
-    dataset_uuids = existing_data_dict['dataset_uuids_to_unlink']
+    dataset_uuids = new_data_dict['dataset_uuids_to_unlink']
 
     try:
         # Delete the linkage (Dataset) - [:IN_UPLOAD] -> (Upload) for each dataset