sapiopycommons 2024.8.15a304__py3-none-any.whl → 2024.8.19a305__py3-none-any.whl

sapiopycommons/recordmodel/record_handler.py

@@ -1,5 +1,8 @@
+from __future__ import annotations
+
 from collections.abc import Iterable
 from typing import Any
+from weakref import WeakValueDictionary
 
 from sapiopylib.rest.DataRecordManagerService import DataRecordManager
 from sapiopylib.rest.User import SapioUser
@@ -7,6 +10,7 @@ from sapiopylib.rest.pojo.CustomReport import CustomReportCriteria, RawReportTer
 from sapiopylib.rest.pojo.DataRecord import DataRecord
 from sapiopylib.rest.pojo.DataRecordPaging import DataRecordPojoPageCriteria
 from sapiopylib.rest.pojo.datatype.FieldDefinition import FieldType
+from sapiopylib.rest.pojo.eln.SapioELNEnums import ElnBaseDataType
 from sapiopylib.rest.pojo.webhook.WebhookContext import SapioWebhookContext
 from sapiopylib.rest.utils.autopaging import QueryDataRecordsAutoPager, QueryDataRecordByIdListAutoPager, \
     QueryAllRecordsOfTypeAutoPager
@@ -16,6 +20,7 @@ from sapiopylib.rest.utils.recordmodel.RecordModelManager import RecordModelMana
 from sapiopylib.rest.utils.recordmodel.RecordModelWrapper import WrappedType, WrappedRecordModel
 from sapiopylib.rest.utils.recordmodel.RelationshipPath import RelationshipPath, RelationshipNode, \
     RelationshipNodeType
+from sapiopylib.rest.utils.recordmodel.ancestry import RecordModelAncestorManager
 
 from sapiopycommons.general.aliases import RecordModel, SapioRecord, FieldMap
 from sapiopycommons.general.custom_report_util import CustomReportUtil
@@ -32,16 +37,37 @@ class RecordHandler:
     rec_man: RecordModelManager
     inst_man: RecordModelInstanceManager
     rel_man: RecordModelRelationshipManager
+    an_man: RecordModelAncestorManager
+
+    __instances: WeakValueDictionary[SapioUser, RecordHandler] = WeakValueDictionary()
+    __initialized: bool
+
+    def __new__(cls, context: SapioWebhookContext | SapioUser):
+        """
+        :param context: The current webhook context or a user object to send requests from.
+        """
+        user = context if isinstance(context, SapioUser) else context.user
+        obj = cls.__instances.get(user)
+        if not obj:
+            obj = object.__new__(cls)
+            obj.__initialized = False
+            cls.__instances[user] = obj
+        return obj
 
     def __init__(self, context: SapioWebhookContext | SapioUser):
         """
         :param context: The current webhook context or a user object to send requests from.
         """
+        if self.__initialized:
+            return
+        self.__initialized = True
+
         self.user = context if isinstance(context, SapioUser) else context.user
         self.dr_man = DataRecordManager(self.user)
         self.rec_man = RecordModelManager(self.user)
         self.inst_man = self.rec_man.instance_manager
         self.rel_man = self.rec_man.relationship_manager
+        self.an_man = RecordModelAncestorManager(self.rec_man)
 
     def wrap_model(self, record: DataRecord, wrapper_type: type[WrappedType]) -> WrappedType:
         """
@@ -51,6 +77,7 @@ class RecordHandler:
         :param wrapper_type: The record model wrapper to use.
         :return: The record model for the input.
         """
+        self.__verify_data_type([record], wrapper_type)
         return self.inst_man.add_existing_record_of_type(record, wrapper_type)
 
     def wrap_models(self, records: Iterable[DataRecord], wrapper_type: type[WrappedType]) -> list[WrappedType]:
@@ -61,6 +88,7 @@ class RecordHandler:
         :param wrapper_type: The record model wrapper to use.
         :return: The record models for the input.
         """
+        self.__verify_data_type(records, wrapper_type)
         return self.inst_man.add_existing_records_of_type(list(records), wrapper_type)
 
     def query_models(self, wrapper_type: type[WrappedType], field: str, value_list: Iterable[Any],
@@ -168,6 +196,19 @@ class RecordHandler:
         pager.max_page = page_limit
         return self.wrap_models(pager.get_all_at_once(), wrapper_type), pager.next_page_criteria
 
+    def query_models_by_id_and_map(self, wrapper_type: type[WrappedType], ids: Iterable[int],
+                                   page_limit: int | None = None) -> dict[int, WrappedType]:
+        """
+        Shorthand for using the data record manager to query for a list of data records by record ID
+        and then converting the results into a dictionary of record ID to the record model for that ID.
+
+        :param wrapper_type: The record model wrapper to use.
+        :param ids: The list of record IDs to query.
+        :param page_limit: The maximum number of pages to query. If None, exhausts all possible pages.
+        :return: The record models for the queried records mapped in a dictionary by their record ID.
+        """
+        return {x.record_id: x for x in self.query_models_by_id(wrapper_type, ids, page_limit)}
+
     def query_all_models(self, wrapper_type: type[WrappedType], page_limit: int | None = None) -> list[WrappedType]:
         """
         Shorthand for using the data record manager to query for all data records of a given type
@@ -497,7 +538,7 @@ class RecordHandler:
 
     @staticmethod
     def map_by_child(models: Iterable[RecordModel], child_type: type[WrappedType]) \
-            -> dict[WrappedType, list[RecordModel]]:
+            -> dict[WrappedType, RecordModel]:
         """
         Take a list of record models and map them by their children. Essentially an inversion of map_to_child.
         If two records share the same child, an exception will be thrown. The children must already be loaded.
@@ -831,8 +872,6 @@ class RecordHandler:
         path, if any. The hierarchy must be linear (1:1 relationship between data types at every step) and the
         relationship path must already be loaded.
 
-        Currently, the relationship path may only contain parent/child nodes.
-
         :param models: A list of record models.
         :param path: The relationship path to follow.
         :param wrapper_type: The record model wrapper to use.
@@ -843,15 +882,44 @@ class RecordHandler:
         # PR-46832: Update path traversal to account for changes to RelationshipPath in Sapiopylib.
         path: list[RelationshipNode] = path.path
         for model in models:
-            current: PyRecordModel = model if isinstance(model, PyRecordModel) else model.backing_model
+            current: PyRecordModel | None = model if isinstance(model, PyRecordModel) else model.backing_model
             for node in path:
-                direction = node.direction
+                data_type: str = node.data_type_name
+                direction: RelationshipNodeType = node.direction
                 if current is None:
                     break
                 if direction == RelationshipNodeType.CHILD:
-                    current = current.get_child_of_type(node.data_type_name)
+                    current = current.get_child_of_type(data_type)
                 elif direction == RelationshipNodeType.PARENT:
-                    current = current.get_parent_of_type(node.data_type_name)
+                    current = current.get_parent_of_type(data_type)
+                elif direction == RelationshipNodeType.ANCESTOR:
+                    ancestors: list[PyRecordModel] = list(self.an_man.get_ancestors_of_type(current, data_type))
+                    if not ancestors:
+                        current = None
+                    elif len(ancestors) > 1:
+                        raise SapioException(f"Hierarchy contains multiple ancestors of type {data_type}.")
+                    else:
+                        current = ancestors[0]
+                elif direction == RelationshipNodeType.DESCENDANT:
+                    descendants: list[PyRecordModel] = list(self.an_man.get_descendant_of_type(current, data_type))
+                    if not descendants:
+                        current = None
+                    elif len(descendants) > 1:
+                        raise SapioException(f"Hierarchy contains multiple descendants of type {data_type}.")
+                    else:
+                        current = descendants[0]
+                elif direction == RelationshipNodeType.FORWARD_SIDE_LINK:
+                    current = current.get_forward_side_link(node.data_field_name)
+                elif direction == RelationshipNodeType.REVERSE_SIDE_LINK:
+                    field_name: str = node.data_field_name
+                    reverse_links: list[PyRecordModel] = current.get_reverse_side_link(field_name, data_type)
+                    if not reverse_links:
+                        current = None
+                    elif len(reverse_links) > 1:
+                        raise SapioException(f"Hierarchy contains multiple reverse links of type {data_type} on field "
+                                             f"{field_name}.")
+                    else:
+                        current = reverse_links[0]
                 else:
                     raise SapioException("Unsupported path direction.")
             ret_dict.update({model: self.inst_man.wrap(current, wrapper_type) if current else None})
@@ -864,8 +932,6 @@ class RecordHandler:
         path, if any. The hierarchy may be non-linear (1:Many relationships between data types are allowed) and the
         relationship path must already be loaded.
 
-        Currently, the relationship path may only contain parent/child nodes.
-
         :param models: A list of record models.
         :param path: The relationship path to follow.
         :param wrapper_type: The record model wrapper to use.
@@ -880,14 +946,23 @@ class RecordHandler:
             next_search: set[PyRecordModel] = set()
             # Exhaust the records at each step in the path, then use those records for the next step.
             for node in path:
-                direction = node.direction
+                data_type: str = node.data_type_name
+                direction: RelationshipNodeType = node.direction
                 if len(current_search) == 0:
                     break
                 for search in current_search:
                     if direction == RelationshipNodeType.CHILD:
-                        next_search.update(search.get_children_of_type(node.data_type_name))
+                        next_search.update(search.get_children_of_type(data_type))
                     elif direction == RelationshipNodeType.PARENT:
-                        next_search.update(search.get_parents_of_type(node.data_type_name))
+                        next_search.update(search.get_parents_of_type(data_type))
+                    elif direction == RelationshipNodeType.ANCESTOR:
+                        next_search.update(self.an_man.get_ancestors_of_type(search, data_type))
+                    elif direction == RelationshipNodeType.DESCENDANT:
+                        next_search.update(self.an_man.get_descendant_of_type(search, data_type))
+                    elif direction == RelationshipNodeType.FORWARD_SIDE_LINK:
+                        next_search.add(search.get_forward_side_link(node.data_field_name))
+                    elif direction == RelationshipNodeType.REVERSE_SIDE_LINK:
+                        next_search.update(search.get_reverse_side_link(node.data_field_name, data_type))
                     else:
                         raise SapioException("Unsupported path direction.")
                 current_search = next_search
@@ -908,8 +983,6 @@ class RecordHandler:
         relationships (e.g. a sample which is aliquoted to a number of samples, then those aliquots are pooled back
         together into a single sample).
 
-        Currently, the relationship path may only contain parent/child nodes.
-
         :param models: A list of record models.
         :param path: The relationship path to follow.
         :param wrapper_type: The record model wrapper to use.
@@ -922,13 +995,22 @@ class RecordHandler:
         for model in models:
             current: list[PyRecordModel] = [model if isinstance(model, PyRecordModel) else model.backing_model]
             for node in path:
-                direction = node.direction
+                data_type: str = node.data_type_name
+                direction: RelationshipNodeType = node.direction
                 if len(current) == 0:
                     break
                 if direction == RelationshipNodeType.CHILD:
-                    current = current[0].get_children_of_type(node.data_type_name)
+                    current = current[0].get_children_of_type(data_type)
                 elif direction == RelationshipNodeType.PARENT:
-                    current = current[0].get_parents_of_type(node.data_type_name)
+                    current = current[0].get_parents_of_type(data_type)
+                elif direction == RelationshipNodeType.ANCESTOR:
+                    current = list(self.an_man.get_ancestors_of_type(current[0], data_type))
+                elif direction == RelationshipNodeType.DESCENDANT:
+                    current = list(self.an_man.get_descendant_of_type(current[0], data_type))
+                elif direction == RelationshipNodeType.FORWARD_SIDE_LINK:
+                    current = [current[0].get_forward_side_link(node.data_field_name)]
+                elif direction == RelationshipNodeType.REVERSE_SIDE_LINK:
+                    current = current[0].get_reverse_side_link(node.data_field_name, data_type)
                 else:
                     raise SapioException("Unsupported path direction.")
             ret_dict.update({model: self.inst_man.wrap(current[0], wrapper_type) if current else None})
@@ -959,3 +1041,18 @@ class RecordHandler:
                                          f"encountered in system that matches all provided identifiers.")
                 unique_record = result
         return unique_record
+
+    @staticmethod
+    def __verify_data_type(records: Iterable[DataRecord], wrapper_type: type[WrappedType]) -> None:
+        """
+        Throw an exception if the data type of the given records and wrapper don't match.
+        """
+        model_type: str = wrapper_type.get_wrapper_data_type_name()
+        for record in records:
+            record_type: str = record.data_type_name
+            # Account for ELN data type records.
+            if ElnBaseDataType.is_eln_type(record_type):
+                record_type = ElnBaseDataType.get_base_type(record_type).data_type_name
+            if record_type != model_type:
+                raise SapioException(f"Data record of type {record_type} cannot be wrapped by the record model wrapper "
+                                     f"of type {model_type}")

sapiopycommons/rules/eln_rule_handler.py

@@ -1,5 +1,10 @@
+from __future__ import annotations
+
+from weakref import WeakValueDictionary
+
+from sapiopylib.rest.User import SapioUser
 from sapiopylib.rest.pojo.DataRecord import DataRecord
-from sapiopylib.rest.pojo.webhook.VeloxRules import VeloxRuleType, VeloxRuleParser
+from sapiopylib.rest.pojo.eln.SapioELNEnums import ElnBaseDataType
 from sapiopylib.rest.pojo.webhook.WebhookContext import SapioWebhookContext
 from sapiopylib.rest.utils.recordmodel.RecordModelManager import RecordModelManager, RecordModelInstanceManager
 from sapiopylib.rest.utils.recordmodel.RecordModelWrapper import WrappedType
@@ -12,7 +17,6 @@ from sapiopycommons.general.exceptions import SapioException
 class ElnRuleHandler:
     """
     A class which helps with the parsing and navigation of the ELN rule result map of a webhook context.
-    TODO: Add functionality around the VeloxRuleType of the rule results.
     """
     __context: SapioWebhookContext
     """The context that this handler is working from."""
@@ -34,7 +38,25 @@ class ElnRuleHandler:
     """A mapping of entry name to the lists of field maps for that entry, each grouping of field maps being mapped by
     its data type."""
 
+    __instances: WeakValueDictionary[SapioUser, ElnRuleHandler] = WeakValueDictionary()
+    __initialized: bool
+
+    def __new__(cls, context: SapioWebhookContext):
+        if context.velox_eln_rule_result_map is None:
+            raise SapioException("No Velox ELN rule result map in context for ElnRuleHandler to parse.")
+        user = context if isinstance(context, SapioUser) else context.user
+        obj = cls.__instances.get(user)
+        if not obj:
+            obj = object.__new__(cls)
+            obj.__initialized = False
+            cls.__instances[user] = obj
+        return obj
+
     def __init__(self, context: SapioWebhookContext):
+        if self.__initialized:
+            return
+        self.__initialized = True
+
         if context.velox_eln_rule_result_map is None:
             raise SapioException("No Velox ELN rule result map in context for ElnRuleHandler to parse.")
         self.__context = context
@@ -64,13 +86,8 @@ class ElnRuleHandler:
                         # Get the data type of this record. If this is an ELN type, ignore the digits.
                         data_type: str = record.data_type_name
                         # PR-46331: Ensure that all ELN types are converted to their base data type name.
-                        # TODO: Use ElnBaseDataType.is_eln_type when it is no longer bugged in sapiopylib.
-                        if data_type.startswith("ELNExperiment_"):
-                            data_type = "ELNExperiment"
-                        elif data_type.startswith("ELNExperimentDetail_"):
-                            data_type = "ELNExperimentDetail"
-                        elif data_type.startswith("ELNSampleDetail_"):
-                            data_type = "ELNSampleDetail"
+                        if ElnBaseDataType.is_eln_type(data_type):
+                            data_type = ElnBaseDataType.get_base_type(data_type).data_type_name
                         # Update the list of records of this type that exist so far globally.
                         self.__records.setdefault(data_type, set()).add(record)
                         # Do the same for the list of records of this type for this specific entry.
@@ -85,19 +102,9 @@ class ElnRuleHandler:
             entry_dict: dict[str, dict[int, FieldMap]] = {}
             for record_result in entry_results:
                 for result in record_result.velox_type_rule_field_map_result_list:
-                    # TODO: sapiopylib currently has a bug where this velox_type_pojo variable is stored as a dict instead
-                    #  of as the intended VeloxRuleType object. Parse that dict as a VeloxRuleType before use.
-                    velox_type: VeloxRuleType | dict = result.velox_type_pojo
-                    if isinstance(velox_type, dict):
-                        velox_type: VeloxRuleType = VeloxRuleParser.parse_velox_rule_type(velox_type)
-                    data_type: str = velox_type.data_type_name
-                    # TODO: Use ElnBaseDataType.is_eln_type when it is no longer bugged in sapiopylib.
-                    if data_type.startswith("ELNExperiment_"):
-                        data_type = "ELNExperiment"
-                    elif data_type.startswith("ELNExperimentDetail_"):
-                        data_type = "ELNExperimentDetail"
-                    elif data_type.startswith("ELNSampleDetail_"):
-                        data_type = "ELNSampleDetail"
+                    data_type: str = result.velox_type_pojo.data_type_name
+                    if ElnBaseDataType.is_eln_type(data_type):
+                        data_type = ElnBaseDataType.get_base_type(data_type).data_type_name
                     for field_map in result.field_map_list:
                         rec_id: int = field_map.get("RecordId")
                         self.__field_maps.setdefault(data_type, {}).update({rec_id: field_map})

sapiopycommons/rules/on_save_rule_handler.py

@@ -1,5 +1,10 @@
+from __future__ import annotations
+
+from weakref import WeakValueDictionary
+
+from sapiopylib.rest.User import SapioUser
 from sapiopylib.rest.pojo.DataRecord import DataRecord
-from sapiopylib.rest.pojo.webhook.VeloxRules import VeloxRuleType, VeloxRuleParser
+from sapiopylib.rest.pojo.eln.SapioELNEnums import ElnBaseDataType
 from sapiopylib.rest.pojo.webhook.WebhookContext import SapioWebhookContext
 from sapiopylib.rest.utils.recordmodel.RecordModelManager import RecordModelManager, RecordModelInstanceManager
 from sapiopylib.rest.utils.recordmodel.RecordModelWrapper import WrappedType
@@ -12,7 +17,6 @@ from sapiopycommons.general.exceptions import SapioException
 class OnSaveRuleHandler:
     """
     A class which helps with the parsing and navigation of the on save rule result map of a webhook context.
-    TODO: Add functionality around the VeloxRuleType of the rule results.
     """
     __context: SapioWebhookContext
     """The context that this handler is working from."""
@@ -34,7 +38,25 @@ class OnSaveRuleHandler:
     """A mapping of record IDs of records in the context.data_record_list to the field maps related to that
     record, each grouping of field maps being mapped by its data type."""
 
+    __instances: WeakValueDictionary[SapioUser, OnSaveRuleHandler] = WeakValueDictionary()
+    __initialized: bool
+
+    def __new__(cls, context: SapioWebhookContext):
+        if context.velox_on_save_result_map is None:
+            raise SapioException("No Velox on save rule result map in context for OnSaveRuleHandler to parse.")
+        user = context if isinstance(context, SapioUser) else context.user
+        obj = cls.__instances.get(user)
+        if not obj:
+            obj = object.__new__(cls)
+            obj.__initialized = False
+            cls.__instances[user] = obj
+        return obj
+
     def __init__(self, context: SapioWebhookContext):
+        if self.__initialized:
+            return
+        self.__initialized = True
+
         if context.velox_on_save_result_map is None:
             raise SapioException("No Velox on save rule result map in context for OnSaveRuleHandler to parse.")
         self.__context = context
@@ -51,9 +73,6 @@ class OnSaveRuleHandler:
         self.__base_id_to_records = {}
         # Each record ID in the context has a list of results for that record.
         for record_id, rule_results in self.__context.velox_on_save_result_map.items():
-            # TODO: Record IDs are currently being stored in the map as strings instead of ints. This can be removed
-            #  once sapiopylib is fixed.
-            record_id = int(record_id)
             # Keep track of the records for this specific record ID.
             id_dict: dict[str, set[DataRecord]] = {}
             # The list of results for a record consist of a list of data records and a VeloxType that specifies
@@ -64,13 +83,8 @@ class OnSaveRuleHandler:
                     # Get the data type of this record. If this is an ELN type, ignore the digits.
                     data_type: str = record.data_type_name
                     # PR-46331: Ensure that all ELN types are converted to their base data type name.
-                    # TODO: Use ElnBaseDataType.is_eln_type when it is no longer bugged in sapiopylib.
-                    if data_type.startswith("ELNExperiment_"):
-                        data_type = "ELNExperiment"
-                    elif data_type.startswith("ELNExperimentDetail_"):
-                        data_type = "ELNExperimentDetail"
-                    elif data_type.startswith("ELNSampleDetail_"):
-                        data_type = "ELNSampleDetail"
+                    if ElnBaseDataType.is_eln_type(data_type):
+                        data_type = ElnBaseDataType.get_base_type(data_type).data_type_name
                     # Update the list of records of this type that exist so far globally.
                     self.__records.setdefault(data_type, set()).add(record)
                     # Do the same for the list of records of this type that relate to this record ID.
@@ -82,24 +96,11 @@ class OnSaveRuleHandler:
         self.__base_id_to_field_maps = {}
         # Repeat the same thing for the field map results.
         for record_id, rule_results in self.__context.velox_on_save_field_map_result_map.items():
-            # TODO: Record IDs are currently being stored in the map as strings instead of ints. This can be removed
-            #  once sapiopylib is fixed.
-            record_id = int(record_id)
             id_dict: dict[str, dict[int, FieldMap]] = {}
             for record_result in rule_results:
-                # TODO: sapiopylib currently has a bug where this velox_type_pojo variable is stored as a dict instead
-                #  of as the intended VeloxRuleType object. Parse that dict as a VeloxRuleType before use.
-                velox_type: VeloxRuleType | dict = record_result.velox_type_pojo
-                if isinstance(velox_type, dict):
-                    velox_type: VeloxRuleType = VeloxRuleParser.parse_velox_rule_type(velox_type)
-                data_type: str = velox_type.data_type_name
-                # TODO: Use ElnBaseDataType.is_eln_type when it is no longer bugged in sapiopylib.
-                if data_type.startswith("ELNExperiment_"):
-                    data_type = "ELNExperiment"
-                elif data_type.startswith("ELNExperimentDetail_"):
-                    data_type = "ELNExperimentDetail"
-                elif data_type.startswith("ELNSampleDetail_"):
-                    data_type = "ELNSampleDetail"
+                data_type: str = record_result.velox_type_pojo.data_type_name
+                if ElnBaseDataType.is_eln_type(data_type):
+                    data_type = ElnBaseDataType.get_base_type(data_type).data_type_name
                 for field_map in record_result.field_map_list:
                     rec_id: int = field_map.get("RecordId")
                     self.__field_maps.setdefault(data_type, {}).update({rec_id: field_map})

sapiopycommons/webhook/webhook_handlers.py

@@ -4,16 +4,25 @@ from logging import Logger
 
 from sapiopylib.rest.DataMgmtService import DataMgmtServer
 from sapiopylib.rest.DataRecordManagerService import DataRecordManager
+from sapiopylib.rest.User import SapioUser
 from sapiopylib.rest.WebhookService import AbstractWebhookHandler
+from sapiopylib.rest.pojo.Message import VeloxLogMessage, VeloxLogLevel
 from sapiopylib.rest.pojo.webhook.WebhookContext import SapioWebhookContext
 from sapiopylib.rest.pojo.webhook.WebhookEnums import WebhookEndpointType
 from sapiopylib.rest.pojo.webhook.WebhookResult import SapioWebhookResult
+from sapiopylib.rest.utils.DataTypeCacheManager import DataTypeCacheManager
 from sapiopylib.rest.utils.recordmodel.RecordModelManager import RecordModelManager, RecordModelInstanceManager, \
     RecordModelRelationshipManager
 from sapiopylib.rest.utils.recordmodel.ancestry import RecordModelAncestorManager
 
+from sapiopycommons.callbacks.callback_util import CallbackUtil
+from sapiopycommons.eln.experiment_handler import ExperimentHandler
 from sapiopycommons.general.exceptions import SapioUserErrorException, SapioCriticalErrorException, \
-    SapioUserCancelledException
+    SapioUserCancelledException, SapioException
+from sapiopycommons.general.sapio_links import SapioNavigationLinker
+from sapiopycommons.recordmodel.record_handler import RecordHandler
+from sapiopycommons.rules.eln_rule_handler import ElnRuleHandler
+from sapiopycommons.rules.on_save_rule_handler import OnSaveRuleHandler
 
 
 # FR-46064 - Initial port of PyWebhookUtils to sapiopycommons.
@@ -25,6 +34,7 @@ class CommonsWebhookHandler(AbstractWebhookHandler):
     """
     logger: Logger
 
+    user: SapioUser
     context: SapioWebhookContext
 
     dr_man: DataRecordManager
@@ -34,21 +44,46 @@ class CommonsWebhookHandler(AbstractWebhookHandler):
     # FR-46329: Add the ancestor manager to CommonsWebhookHandler.
     an_man: RecordModelAncestorManager
 
+    dt_cache: DataTypeCacheManager
+    rec_handler: RecordHandler
+    callback: CallbackUtil
+    exp_handler: ExperimentHandler | None
+    rule_handler: OnSaveRuleHandler | ElnRuleHandler | None
+
     def run(self, context: SapioWebhookContext) -> SapioWebhookResult:
+        self.user = context.user
         self.context = context
-        self.logger = context.user.logger
+
+        self.logger = self.user.logger
 
         self.dr_man = context.data_record_manager
-        self.rec_man = RecordModelManager(context.user)
+        self.rec_man = RecordModelManager(self.user)
         self.inst_man = self.rec_man.instance_manager
         self.rel_man = self.rec_man.relationship_manager
         self.an_man = RecordModelAncestorManager(self.rec_man)
 
+        self.dt_cache = DataTypeCacheManager(self.user)
+        self.rec_handler = RecordHandler(context)
+        self.callback = CallbackUtil(context)
+        if context.eln_experiment is not None:
+            self.exp_handler = ExperimentHandler(context)
+        else:
+            self.exp_handler = None
+        if self.is_on_save_rule():
+            self.rule_handler = OnSaveRuleHandler(context)
+        elif self.is_eln_rule():
+            self.rule_handler = ElnRuleHandler(context)
+        else:
+            self.rule_handler = None
+
         # Wrap the execution of each webhook in a try/catch. If an exception occurs, handle any special sapiopycommons
         # exceptions. Otherwise, return a generic message stating that an error occurred.
         try:
             self.initialize(context)
-            return self.execute(context)
+            result = self.execute(context)
+            if result is None:
+                raise SapioException("Your execute function returned a None result! Don't forget your return statement!")
+            return result
         except SapioUserErrorException as e:
             return self.handle_user_error_exception(e)
         except SapioCriticalErrorException as e:
@@ -100,7 +135,7 @@ class CommonsWebhookHandler(AbstractWebhookHandler):
             return result
         self.log_error(traceback.format_exc())
         if self.can_send_client_callback():
-            DataMgmtServer.get_client_callback(self.context.user).display_error(e.args[0])
+            DataMgmtServer.get_client_callback(self.user).display_error(e.args[0])
         return SapioWebhookResult(False)
 
     def handle_unexpected_exception(self, e: Exception) -> SapioWebhookResult:
@@ -114,7 +149,10 @@ class CommonsWebhookHandler(AbstractWebhookHandler):
         result: SapioWebhookResult | None = self.handle_any_exception(e)
         if result is not None:
             return result
-        self.log_error(traceback.format_exc())
+        msg: str = traceback.format_exc()
+        self.log_error(msg)
+        # FR-47079: Also log all unexpected exception messages to the webhook execution log within the platform.
+        self.log_error_to_webhook_execution_log(msg)
         return SapioWebhookResult(False, display_text="Unexpected error occurred during webhook execution. "
                                                       "Please contact Sapio support.")
 
@@ -129,7 +167,7 @@ class CommonsWebhookHandler(AbstractWebhookHandler):
         result: SapioWebhookResult | None = self.handle_any_exception(e)
         if result is not None:
             return result
-        return SapioWebhookResult(False, display_text="User cancelled.")
+        return SapioWebhookResult(False)
 
     # noinspection PyMethodMayBeStatic,PyUnusedLocal
     def handle_any_exception(self, e: Exception) -> SapioWebhookResult | None:
@@ -145,32 +183,58 @@ class CommonsWebhookHandler(AbstractWebhookHandler):
 
     def log_info(self, msg: str) -> None:
         """
-        Write an info message to the log. Log destination is stdout. This message will be prepended with the user's
-        username and the experiment ID of the experiment they are in, if any.
+        Write an info message to the webhook server log. Log destination is stdout. This message will be prepended with
+        the user's username and the experiment ID of the experiment they are in, if any.
         """
-        exp_id = None
-        if self.context.eln_experiment is not None:
-            exp_id = self.context.eln_experiment.notebook_experiment_id
-        # CR-46333: Add the user's group to the logging message.
-        user = self.context.user
-        username = user.username
-        group_name = user.session_additional_data.current_group_name
-        self.logger.info(f"(User: {username}, Group: {group_name}, Experiment: {exp_id}):\n{msg}")
+        self.logger.info(self._format_log(msg, "log_info call"))
 
     def log_error(self, msg: str) -> None:
         """
-        Write an error message to the log. Log destination is stderr. This message will be prepended with the user's
-        username and the experiment ID of the experiment they are in, if any.
+        Write an error message to the webhook server log. Log destination is stderr. This message will be prepended with
+        the user's username and the experiment ID of the experiment they are in, if any.
         """
-        exp_id = None
+        # PR-46209: Use logger.error instead of logger.info when logging errors.
+        self.logger.error(self._format_log(msg, "log_error call"))
+
+    def log_error_to_webhook_execution_log(self, msg: str) -> None:
+        """
+        Write an error message to the platform's webhook execution log. This can be reviewed by navigating to the
+        webhook configuration where the webhook that called this function is defined and clicking the "View Log"
+        button. From there, select one of the rows for the webhook executions and click "Download Log" from the right
+        side table.
+        """
+        messenger = DataMgmtServer.get_messenger(self.user)
+        messenger.log_message(VeloxLogMessage(message=self._format_log(msg, "Error occurred during webhook execution."),
+                                              log_level=VeloxLogLevel.ERROR,
+                                              originating_class=self.__class__.__name__))
+
+    def _format_log(self, msg: str, prefix: str | None = None) -> str:
+        """
+        Given a message to log, populate it with some metadata about this particular webhook execution, including
+        the group of the user and the invocation type of the webhook call.
+        """
+        # If we're able to, provide a link to the location that the error occurred at.
+        navigator = SapioNavigationLinker(self.context)
         if self.context.eln_experiment is not None:
-            exp_id = self.context.eln_experiment.notebook_experiment_id
+            link = navigator.experiment(self.context.eln_experiment)
+        elif self.context.data_record and not self.context.data_record_list:
+            link = navigator.data_record(self.context.data_record)
+        elif self.context.base_data_record:
+            link = navigator.data_record(self.context.base_data_record)
+        else:
+            link = None
+
+        message: str = ""
+        if prefix:
+            message += prefix + "\n"
+        message += f"Webhook invocation type: {self.context.end_point_type.display_name}\n"
+        message += f"Username: {self.user.username}\n"
         # CR-46333: Add the user's group to the logging message.
-        user = self.context.user
-        username = user.username
-        group_name = user.session_additional_data.current_group_name
-        # PR-46209: Use logger.error instead of logger.info when logging errors.
-        self.logger.error(f"(User: {username}, Group: {group_name}, Experiment: {exp_id}):\n{msg}")
+        message += f"User group: {self.user.session_additional_data.current_group_name}\n"
+        if link:
+            message += f"User location: {link}\n"
+        message += msg
+        return message
 
     def is_main_toolbar(self) -> bool:
         """