Skip to content

Don't run after_create and after_update triggers if not specified #919

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
yuanzhou merged 2 commits into from
Sep 24, 2025
Merged

Don't run after_create and after_update triggers if not specified #919

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
39326a7
Don't run after_create and after_update triggers if not specified
yuanzhou Sep 24, 2025
89dfd35
Add trigger type comments
yuanzhou Sep 24, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
39 changes: 20 additions & 19 deletions src/app.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -1485,7 +1485,7 @@ def update_entity(id):

# 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']):
Expand All @@ -1500,13 +1500,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)
Expand Down Expand Up @@ -4580,7 +4580,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
----------
Expand Down Expand Up @@ -5000,7 +5000,7 @@ def create_multiple_component_details(request, normalized_entity_type, user_toke


"""
Execute 'after_create_triiger' methods
Execute 'after_create_trigger' methods

Parameters
----------
Expand All @@ -5013,8 +5013,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
Expand All @@ -5024,7 +5026,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"
Expand All @@ -5036,7 +5038,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
----------
Expand Down Expand Up @@ -5133,20 +5135,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"
Expand Down
6 changes: 2 additions & 4 deletions src/schema/schema_manager.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand All @@ -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
Expand Down
Loading