sapiopycommons 2024.7.25a299__py3-none-any.whl → 2024.8.2a301__py3-none-any.whl

sapiopycommons/webhook/webhook_handlers.py

@@ -4,7 +4,9 @@ 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
@@ -14,6 +16,7 @@ from sapiopylib.rest.utils.recordmodel.ancestry import RecordModelAncestorManage
 
 from sapiopycommons.general.exceptions import SapioUserErrorException, SapioCriticalErrorException, \
     SapioUserCancelledException
+from sapiopycommons.general.sapio_links import SapioNavigationLinker
 
 
 # FR-46064 - Initial port of PyWebhookUtils to sapiopycommons.
@@ -25,6 +28,7 @@ class CommonsWebhookHandler(AbstractWebhookHandler):
     """
     logger: Logger
 
+    user: SapioUser
     context: SapioWebhookContext
 
     dr_man: DataRecordManager
@@ -35,11 +39,13 @@ class CommonsWebhookHandler(AbstractWebhookHandler):
     an_man: RecordModelAncestorManager
 
     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)
@@ -100,7 +106,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 +120,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.")
 
@@ -145,32 +154,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.
+        """
+        # 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.
         """
-        exp_id = None
+        # 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:
         """

{sapiopycommons-2024.7.25a299.dist-info → sapiopycommons-2024.8.2a301.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: sapiopycommons
-Version: 2024.7.25a299
+Version: 2024.8.2a301
 Summary: Official Sapio Python API Utilities Package
 Project-URL: Homepage, https://github.com/sapiosciences
 Author-email: Jonathan Steck <jsteck@sapiosciences.com>, Yechen Qiao <yqiao@sapiosciences.com>

{sapiopycommons-2024.7.25a299.dist-info → sapiopycommons-2024.8.2a301.dist-info}/RECORD

@@ -1,29 +1,31 @@
 sapiopycommons/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 sapiopycommons/callbacks/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-sapiopycommons/callbacks/callback_util.py,sha256=caeIWCHvK33jDs3TRskpJv0kDe7W8NPK4MyJPjgztwo,58012
+sapiopycommons/callbacks/callback_util.py,sha256=YdaN1iNnJ51EauvKfEOAUwahu1dt_YVvr4Zia29g9qc,61123
 sapiopycommons/chem/IndigoMolecules.py,sha256=QqFDi9CKERj6sn_ZwVcS2xZq4imlkaTeCrpq1iNcEJA,1992
 sapiopycommons/chem/Molecules.py,sha256=t80IsQBPJ9mwE8ZxnWomAGrZDhdsOuPvLaTPb_N6jGU,8639
 sapiopycommons/chem/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 sapiopycommons/datatype/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-sapiopycommons/datatype/attachment_util.py,sha256=YlnMprj5IGBbAZDLG2khS1P7JIYTw_NYfpJAfRZfP3M,3219
+sapiopycommons/datatype/attachment_util.py,sha256=23JQ4avSmBBJdCv95LVj31x8rUCclzB_DYFBijH0NII,3708
 sapiopycommons/eln/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-sapiopycommons/eln/experiment_handler.py,sha256=v1pG4qtZb8OSNWfKtFo6NjnEkReqnu5R9i_hqWh_xxg,57198
+sapiopycommons/eln/experiment_handler.py,sha256=RspUDmPmBQIG7l7q_luFP8yeRljdU3E64066NH5CtdI,59817
 sapiopycommons/eln/experiment_report_util.py,sha256=FTLw-6SLAMeoWTOO-qhGROE9g54pZdyoQJIhiIzlwGw,7848
 sapiopycommons/eln/plate_designer.py,sha256=FYJfhhNq8hdfuXgDYOYHy6g0m2zNwQXZWF_MTPzElDg,7184
 sapiopycommons/files/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-sapiopycommons/files/complex_data_loader.py,sha256=XSJOl676mIklJo78v07-70u1b015a5DI4sqZPI3C-Tw,1475
-sapiopycommons/files/file_bridge.py,sha256=GI3-gWFzcL0q0c8jKOxTevbzJqtUpiElmkXfTnMsaOo,6224
+sapiopycommons/files/complex_data_loader.py,sha256=8jgYF5iGDD6Abw8JRWLYxUWVwj4s4pH5HylyxEGFZSU,1471
+sapiopycommons/files/file_bridge.py,sha256=njx_5Z3tvQUNW4mPazQerL8lopLAFStIByHWHJ7m5ug,6220
 sapiopycommons/files/file_bridge_handler.py,sha256=MU2wZR4VY606yx6Bnv8-LzG3mGCeuXeRBn914WNRFCo,13601
 sapiopycommons/files/file_data_handler.py,sha256=3-guAdhJdeJWAFq1a27ijspkO7uMMZ6CapMCD_6o4jA,36746
-sapiopycommons/files/file_util.py,sha256=44mzhn3M_QltoncBB-ooX7_yO6u5k-XU_bzUXHGxUiw,26299
-sapiopycommons/files/file_validator.py,sha256=BhXB2XnoNEzdBXuwul1s2RNoj-3ZoiMmephUCU_0o3Y,28113
+sapiopycommons/files/file_util.py,sha256=ronTlJimQ6ttJN6Y9qfAzEWoeWnDoUbohkdObNK5mJQ,27042
+sapiopycommons/files/file_validator.py,sha256=EqPCXfVCiilgnOb2G-yZg8XWeDqYp9iVCg8AaWznvf4,28040
 sapiopycommons/files/file_writer.py,sha256=5u_iZXTQvuUU7ceHZr8Q001_tvgJhOqBwAnB_pxcAbQ,16027
 sapiopycommons/general/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 sapiopycommons/general/accession_service.py,sha256=HYgyOsH_UaoRnoury-c2yTW8SeG4OtjLemdpCzoV4R8,13484
-sapiopycommons/general/aliases.py,sha256=i6af5o2oVFGNcyk7GkvTWXQs0H9xTbFKc_GIah8NKVU,3594
+sapiopycommons/general/aliases.py,sha256=UddtYCGqM-wkLXT0LAUqMlFGHZSyOPjA6hzQHvjlDcQ,4324
+sapiopycommons/general/audit_log.py,sha256=LNpBCpZ5mz47-HzHel8PUz1TYGCnxTY6dnerZu-cwOo,9076
 sapiopycommons/general/custom_report_util.py,sha256=cLgIR5Fn3M9uyAtgfTYRv3JRk2SKNevnsb_R5zidSYs,15557
 sapiopycommons/general/exceptions.py,sha256=DOlLKnpCatxQF-lVCToa8ryJgusWLvip6N_1ALN00QE,1679
 sapiopycommons/general/popup_util.py,sha256=-mN5IgYPrLrOEHJ4CHPi2rec4_WAN6X0yMxHwD5h3Bs,30126
+sapiopycommons/general/sapio_links.py,sha256=UlqB09wmgDgbQiB8d3mEj7rxW_GMIXz3j3RlvADNt_A,2475
 sapiopycommons/general/storage_util.py,sha256=ovmK_jN7v09BoX07XxwShpBUC5WYQOM7dbKV_VeLXJU,8892
 sapiopycommons/general/time_util.py,sha256=jiJUh7jc1ZRCOem880S3HaLPZ4RboBtSl4_U9sqAQuM,7290
 sapiopycommons/multimodal/multimodal.py,sha256=A1QsC8QTPmgZyPr7KtMbPRedn2Ie4WIErodUvQ9otgU,6724
@@ -31,13 +33,13 @@ sapiopycommons/multimodal/multimodal_data.py,sha256=zqgYHO-ULaPKV0POFWZVY9N-Sfm1
 sapiopycommons/processtracking/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 sapiopycommons/processtracking/endpoints.py,sha256=g5h_uCVByqacYm9zWAz8TyAdRsGfaO2o0b5RSJdOaSA,10926
 sapiopycommons/recordmodel/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-sapiopycommons/recordmodel/record_handler.py,sha256=AyK1H3x-g1eu1Mt9XD1h57yRrZp_TJjZlEaQ2kPP4Dc,54432
+sapiopycommons/recordmodel/record_handler.py,sha256=qqsHeGNyqQeFKuZ4U2v2MD278AlH4n1HMvSTOY0hbyo,58636
 sapiopycommons/rules/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-sapiopycommons/rules/eln_rule_handler.py,sha256=qfkBZtck0KK1i9s9Xe2UZqkzQOgPCzDxRkhxE8Si1xk,10671
-sapiopycommons/rules/on_save_rule_handler.py,sha256=JY9F30IcHwFVdgPAMQtTYuRastV1jeezhVktyrzNASU,10763
+sapiopycommons/rules/eln_rule_handler.py,sha256=rz9E1PQLShCZM09JafMl_ylUqBbMs-et0FsOG41tQL0,9480
+sapiopycommons/rules/on_save_rule_handler.py,sha256=I06HwsNvulyU0avSXOU0itBDAmiOxsyW8KGk_gH0FHc,9238
 sapiopycommons/webhook/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-sapiopycommons/webhook/webhook_handlers.py,sha256=ibpBY3Sk3Eij919bIdW0awzlogYoQSWYDDOg--NwsQE,13431
-sapiopycommons-2024.7.25a299.dist-info/METADATA,sha256=i4UbrKpFDQoTmRgh5esjX8qysb4lmefghuPy-UtM1hA,3176
-sapiopycommons-2024.7.25a299.dist-info/WHEEL,sha256=1yFddiXMmvYK7QYTqtRNtX66WJ0Mz8PYEiEUoOUUxRY,87
-sapiopycommons-2024.7.25a299.dist-info/licenses/LICENSE,sha256=HyVuytGSiAUQ6ErWBHTqt1iSGHhLmlC8fO7jTCuR8dU,16725
-sapiopycommons-2024.7.25a299.dist-info/RECORD,,
+sapiopycommons/webhook/webhook_handlers.py,sha256=1uM_epEaEB8w14padEdASXqF3BNalNiShP51a_hU-Ac,15267
+sapiopycommons-2024.8.2a301.dist-info/METADATA,sha256=EVt23yIYhHMJPakRR5Q-RMUi7-1AnxZSKtMrN6hHwwM,3175
+sapiopycommons-2024.8.2a301.dist-info/WHEEL,sha256=1yFddiXMmvYK7QYTqtRNtX66WJ0Mz8PYEiEUoOUUxRY,87
+sapiopycommons-2024.8.2a301.dist-info/licenses/LICENSE,sha256=HyVuytGSiAUQ6ErWBHTqt1iSGHhLmlC8fO7jTCuR8dU,16725
+sapiopycommons-2024.8.2a301.dist-info/RECORD,,