Merge pull request #116 from MITLibraries/improve-display-run-details

Improve display of run details on the status page

Author: jonavellecuerdo

lambdas.py

@@ -3,7 +3,8 @@
 
 from apig_wsgi import make_lambda_handler
 
-from webapp import Config, create_app
+from webapp import create_app
+from webapp.config import Config, configure_logger, configure_sentry
 
 logger = logging.getLogger(__name__)
 CONFIG = Config()
@@ -21,8 +22,8 @@ def lambda_handler(event: dict, context: dict) -> dict:
     See https://github.com/adamchainz/apig-wsgi/tree/main.
     """
     CONFIG.check_required_env_vars()
-    CONFIG.configure_logger(verbose=True)
-    CONFIG.configure_sentry()
+    logger.info(configure_logger(verbose=True))
+    logger.info(configure_sentry())
 
     apig_wsgi_handler = make_lambda_handler(create_app())
 

tests/conftest.py

@@ -12,8 +12,9 @@
 from moto.core.utils import unix_time_millis, utcnow
 from moto.moto_api import state_manager
 
-from webapp import Config, create_app
+from webapp import create_app
 from webapp.app import User
+from webapp.config import Config
 from webapp.utils.aws import CloudWatchLogsClient, ECSClient
 
 AWS_DEFAULT_REGION = "us-east-1"

tests/test_aws/test_cloudwatch.py

@@ -16,21 +16,27 @@ def test_cloudwatchlogs_client_get_log_messages_review_run_success(
     cloudwatch_sapinvoices_review_run_logs,
     mock_cloudwatchlogs_log_stream_review_run_task,
 ):
-    assert (
-        cloudwatchlogs_client.get_log_messages(task_id="abc001")
-        == cloudwatch_sapinvoices_review_run_logs
-    )
+    assert cloudwatchlogs_client.get_log_messages(task_id="abc001") == [
+        "INFO sapinvoices.cli.process_invoices(): SAP invoice process completed for a review run",  # noqa: E501
+        "3 monograph invoices retrieved and processed:",
+        "2 SAP monograph invoices",
+        "1 other payment monograph invoices",
+        "2 serial invoices retrieved and processed",
+    ]
 
 
 def test_cloudwatchlogs_client_get_log_messages_final_run_success(
     cloudwatchlogs_client,
     cloudwatch_sapinvoices_final_run_logs,
     mock_cloudwatchlogs_log_stream_final_run_task,
 ):
-    assert (
-        cloudwatchlogs_client.get_log_messages(task_id="abc002")
-        == cloudwatch_sapinvoices_final_run_logs
-    )
+    assert cloudwatchlogs_client.get_log_messages(task_id="abc002") == [
+        "INFO sapinvoices.cli.process_invoices(): SAP invoice process completed for a final run",  # noqa: E501
+        "3 monograph invoices retrieved and processed:",
+        "2 SAP monograph invoices",
+        "1 other payment monograph invoices",
+        "2 serial invoices retrieved and processed",
+    ]
 
 
 def test_cloudwatchlogs_client_get_log_events_raise_error(

tests/test_config.py

@@ -2,6 +2,8 @@
 
 import pytest
 
+from webapp.config import configure_logger, configure_sentry
+
 
 def test_config_check_required_env_vars_success(config):
     config.check_required_env_vars()
@@ -15,30 +17,32 @@ def test_config_check_required_env_vars_error(monkeypatch, config):
 
 def test_configure_logger_not_verbose(config, caplog):
     logger = logging.getLogger(__name__)
-    result = config.configure_logger(verbose=False)
+    result = configure_logger(verbose=False)
     assert logger.getEffectiveLevel() == logging.INFO
     assert result == "Logger 'root' configured with level=INFO"
 
 
 def test_configure_logger_verbose(config, caplog):
     logger = logging.getLogger(__name__)
-    result = config.configure_logger(verbose=True)
+    result = configure_logger(verbose=True)
     assert logger.getEffectiveLevel() == logging.DEBUG
     assert result == "Logger 'root' configured with level=DEBUG"
 
 
 def test_configure_sentry_if_dsn_exists(config, caplog, monkeypatch):
     monkeypatch.setenv("SENTRY_DSN", "https://[email protected]/123456")
-    config.configure_sentry()
+
     assert (
-        "Sentry DSN found, exceptions will be sent to Sentry with env=test" in caplog.text
+        configure_sentry()
+        == "Sentry DSN found, exceptions will be sent to Sentry with env=test"
     )
 
 
 def test_configure_sentry_if_dsn_missing(config, caplog, monkeypatch):
     monkeypatch.delenv("SENTRY_DSN", raising=False)
-    config.configure_sentry()
-    assert "No Sentry DSN found, exceptions will not be sent to Sentry" in caplog.text
+    assert (
+        configure_sentry() == "No Sentry DSN found, exceptions will not be sent to Sentry"
+    )
 
 
 def test_config_env_access_success(config):

webapp/__init__.py

@@ -1,6 +1,5 @@
 """lambdas package."""
 
 from webapp.app import create_app
-from webapp.config import Config
 
-__all__ = ["Config", "create_app"]
+__all__ = ["create_app"]

webapp/config.py

@@ -5,7 +5,6 @@
 from typing import Any
 
 import sentry_sdk
-from sentry_sdk.integrations.aws_lambda import AwsLambdaIntegration
 
 logger = logging.getLogger("__name__")
 
@@ -62,41 +61,37 @@ def check_required_env_vars(self) -> None:
             message = f"Missing required environment variables: {', '.join(missing_vars)}"
             raise OSError(message)
 
-    def configure_logger(self, *, verbose: bool) -> str:
-        logger = logging.getLogger()
-        if verbose:
-            logging.basicConfig(
-                format=(
-                    "%(asctime)s %(levelname)s %(name)s.%(funcName)s() "
-                    "line %(lineno)d: "
-                    "%(message)s"
-                )
-            )
-            logger.setLevel(logging.DEBUG)
-        else:
-            logging.basicConfig(
-                format="%(asctime)s %(levelname)s %(name)s.%(funcName)s(): %(message)s"
-            )
-            logger.setLevel(logging.INFO)
 
-        return (
-            f"Logger '{logger.name}' configured with level="
-            f"{logging.getLevelName(logger.getEffectiveLevel())}"
+def configure_logger(*, verbose: bool) -> str:
+    logger = logging.getLogger()
+    if verbose:
+        logging.basicConfig(
+            format=(
+                "%(asctime)s %(levelname)s %(name)s.%(funcName)s() "
+                "line %(lineno)d: "
+                "%(message)s"
+            )
         )
+        logger.setLevel(logging.DEBUG)
+    else:
+        logging.basicConfig(
+            format="%(asctime)s %(levelname)s %(name)s.%(funcName)s(): %(message)s"
+        )
+        logger.setLevel(logging.INFO)
 
-    def configure_sentry(self) -> None:
-        if sentry_dsn := self.SENTRY_DSN:
-            sentry_sdk.init(
-                dsn=sentry_dsn,
-                environment=self.WORKSPACE,
-                integrations=[
-                    AwsLambdaIntegration(),
-                ],
-                traces_sample_rate=1.0,
-            )
-            logger.info(
-                "Sentry DSN found, exceptions will be sent to Sentry with env=%s",
-                self.WORKSPACE,
-            )
-        else:
-            logger.info("No Sentry DSN found, exceptions will not be sent to Sentry")
+    return (
+        f"Logger '{logger.name}' configured with level="
+        f"{logging.getLevelName(logger.getEffectiveLevel())}"
+    )
+
+
+def configure_sentry() -> str:
+    env = os.getenv("WORKSPACE")
+    sentry_dsn = os.getenv("SENTRY_DSN")
+    if sentry_dsn and sentry_dsn.lower() != "none":
+        sentry_sdk.init(
+            sentry_dsn,
+            environment=env,
+        )
+        return f"Sentry DSN found, exceptions will be sent to Sentry with env={env}"
+    return "No Sentry DSN found, exceptions will not be sent to Sentry"

webapp/static/libraries-additional.min.css

@@ -1,3 +1,7 @@
+.box-content {
+    display: inline-block;
+}
+
 .platform-name {
     color: #fff;
     font-size: clamp(1rem,5vw,2.8rem);

webapp/utils/aws/cloudwatch.py

@@ -39,9 +39,29 @@ def client(self) -> "CloudWatchLogsClientType":
     def get_log_messages(self, task_id: str) -> list:
         messages: list = []
         if logs := self.get_log_events(task_id):
-            messages.extend(event["message"] for event in logs)
+            return self.get_log_summary(logs)
         return messages
 
+    def get_log_summary(self, logs: list[dict]) -> list[str]:
+        """Get summary of SAP invoice processing logs.
+
+        This function will first determine the index of the log event
+        the marks the start of the "summary" log messages that
+        describe the output of the SAP invoice processing run.
+        The function will then retrieve all the messages starting from
+        that index, effectively retrieving a summary of the run.
+        """
+        summary_index: int | None = None
+        for index, event in enumerate(logs):
+            message = event["message"]
+            if (
+                "SAP invoice process completed" in message
+                or "No invoices waiting to be sent in Alma" in message
+            ):
+                summary_index = index
+                return [event["message"] for event in logs[summary_index:]]
+        return ["SAP invoice process did not complete."]
+
     def get_log_events(self, task_id: str) -> list:
         logger.info("Retrieving CloudWatch logs for task.")
         log_events = []