fix(content-health-monitor): ensure we always try to get the current user's full name (#266)

* Ensure we try to get the current user's full name even when setup is required, and handle any exceptions gracefully without printing errors at the top of reports

* Make the user name bold

* Refactor import to import module

* Fix test

* Update manifest

* Update manifest

Author: cgraham-rs

extensions/content-health-monitor/content-health-monitor.qmd

@@ -15,72 +15,71 @@ import requests
 import datetime
 from posit import connect
 from IPython.display import HTML, display
-from content_health_utils import *
-from content_health_utils import MonitorState
+import content_health_utils as utils
 
 # Create state object to share between this file and utils
-state = MonitorState()
+state = utils.MonitorState()
 
 # Initialize state variables that are only used in this Quarto document
 show_error = False        # Used to display on-screen error messages if API errors occur
 error_message = None      # Error message to display if API errors occur
 error_guid = None         # GUID that caused the error
 content_result = None     # Variable to store content monitoring result
 
+# Initialize current user name with the default value from utils
+current_user_name = utils.DEFAULT_USER_NAME  # Will be updated if user info can be retrieved
+
 # Read environment variables
-connect_server = get_env_var("CONNECT_SERVER", state) # Automatically provided by Connect, must be set when previewing locally
-api_key = get_env_var("CONNECT_API_KEY", state) # Automatically provided by Connect, must be set when previewing locally
-monitored_content_guid = get_env_var("MONITORED_CONTENT_GUID", state)
+connect_server = utils.get_env_var("CONNECT_SERVER", state) # Automatically provided by Connect, must be set when previewing locally
+api_key = utils.get_env_var("CONNECT_API_KEY", state) # Automatically provided by Connect, must be set when previewing locally
+monitored_content_guid = utils.get_env_var("MONITORED_CONTENT_GUID", state)
 
 # Extract GUID if it's a string or URL containing a GUID
 if monitored_content_guid:
-    monitored_content_guid, guid_error_message = extract_guid(monitored_content_guid)
+    monitored_content_guid, guid_error_message = utils.extract_guid(monitored_content_guid)
     # Handle URL with no GUID error
     if guid_error_message:
         state.show_instructions = True
         state.instructions.append(guid_error_message)
 
-# Only instantiate the client if we have the required environment variables
+# Check if we have the required environment variables to instantiate the client
 client = None
-if not state.show_instructions:
+has_connect_env_vars = connect_server and api_key
+
+if has_connect_env_vars:
     try:
-        # Instantiate a Connect client using posit-sdk where api_key and url are automatically read from our environment vars
+        # Instantiate a Connect client using posit-sdk
         client = connect.Client()
+        
+        # Get current user's full name - function handles errors internally
+        user_name = utils.get_current_user_full_name(client)
+        if user_name != "Unknown":  # Only update if we got a valid name
+            current_user_name = user_name
     except ValueError as e:
-        state.show_instructions = True
-        state.instructions.append(f"<b>Error initializing Connect client:</b> {str(e)}")
+        if not state.show_instructions:
+            state.show_instructions = True
+            state.instructions.append(f"<b>Error initializing Connect client:</b> {str(e)}")
 
 
 # ------ DATA GATHERING SECTION ------ #
 # Always record the current time for reporting purposes
 check_time = datetime.datetime.now().strftime('%Y-%m-%d %H:%M:%S')
 
-# Initialize current user name with a default for display
-current_user_name = "the publisher"  # Default, used if no name is available
-
-# Get current user's full name if client is available
-if not state.show_instructions and client:
-    try:
-        user_name = get_current_user_full_name(client)
-        if user_name:  # Only update if we got a valid name
-            current_user_name = user_name
-    except Exception as e:
-        print(f"Warning: Could not get current user name: {str(e)}")
 
 # Only proceed with content validation if we have all requirements
 # (state.show_instructions=False already tells us env vars are set and client was initialized)
 if not state.show_instructions:
     try:
         # Check if server is reachable
-        check_server_reachable(connect_server, api_key)
+        utils.check_server_reachable(connect_server, api_key)
         
         # Validate the content
-        content_result = validate(client, monitored_content_guid, connect_server, api_key)
+        content_result = utils.validate(client, monitored_content_guid, connect_server, api_key)
         
         # Check for content-specific errors
-        if has_error(content_result):
+        if utils.has_error(content_result):
             show_error = True
-            error_details = extract_error_details(content_result)
+            error_details = utils.extract_error_details(content_result)
             error_message = error_details["message"]
             error_guid = error_details["guid"]
             
@@ -94,7 +93,7 @@ if not state.show_instructions:
 # ------ DISPLAY SECTION ------ #
 # Create the about content text
 about_content = f"""<div>
-This report uses {current_user_name}'s API key to monitor a single piece of content. It checks whether the content is 
+This report uses <b>{current_user_name}</b>'s API key to monitor a single piece of content. It checks whether the content is 
 reachable, but does not verify that it runs without errors.<br><br>
 When scheduled to run regularly, the report will send an email alert 
 if the content becomes unreachable.
@@ -111,15 +110,15 @@ else:
 
 # Create all HTML components up front based on state
 html_components = {
-    'instructions': create_instructions_box(instructions_html) if state.show_instructions else None,
-    'error': create_error_box(error_guid, error_message) if show_error else None,
-    'report': create_report_display(content_result, check_time, current_user_name) if content_result and not has_error(content_result) else None,
-    'no_results': create_no_results_box() if not (state.show_instructions or show_error or 
-                                              (content_result and not has_error(content_result))) else None
+    'instructions': utils.create_instructions_box(instructions_html) if state.show_instructions else None,
+    'error': utils.create_error_box(error_guid, error_message) if show_error else None,
+    'report': utils.create_report_display(content_result, check_time, current_user_name) if content_result and not utils.has_error(content_result) else None,
+    'no_results': utils.create_no_results_box() if not (state.show_instructions or show_error or 
+                                              (content_result and not utils.has_error(content_result))) else None
 }
 
 # Always display the About callout box
-display(HTML(create_about_box(about_content)))
+display(HTML(utils.create_about_box(about_content)))
 
 # Display the first piece of information available from the list of instructions, error, report, etc.
 for component in html_components.values():
@@ -128,7 +127,7 @@ for component in html_components.values():
         break
 
 # Set send_email variable for the quarto email mechanism
-send_email = should_send_email(show_error, content_result)
+send_email = utils.should_send_email(show_error, content_result)
 ```
 
 
@@ -147,7 +146,7 @@ send_email = should_send_email(show_error, content_result)
 #| echo: false
 
 # Always show the about section in the email
-display(HTML(create_about_box(about_content)))
+display(HTML(utils.create_about_box(about_content)))
 
 # Display the first piece of information available from the list of instructions, error, report, etc.
 for component in html_components.values():

extensions/content-health-monitor/content_health_utils.py

@@ -18,6 +18,7 @@ def __init__(self):
 STATUS_PASS = "PASS"
 STATUS_FAIL = "FAIL"
 ERROR_PREFIX = "ERROR:"
+DEFAULT_USER_NAME = "the publisher"  # Default name used if user info cannot be retrieved
 
 # Define CSS styling constants
 CSS_COLORS = {
@@ -213,9 +214,8 @@ def get_current_user_full_name(client):
 
         return full_name
     except Exception as e:
-        # Handle any errors gracefully
-        error_message = format_error_message(e)
-        print(f"Warning: Could not retrieve current user: {error_message}")
+        # Handle any errors gracefully without printing
+        # This prevents errors from appearing at the top of reports
         return "Unknown"
 
 # Function to validate content health (simple HTTP 200 check)
@@ -264,9 +264,10 @@ def validate(client, guid, connect_server, api_key):
             owner_full_name = f"{owner_first_name} {owner_last_name}".strip()
             if not owner_full_name:  # Handle case where both names are empty
                 owner_full_name = "Unknown"
-    except Exception as e:
-        # If there's an error getting the owner, keep the defaults
-        print(f"Warning: Could not retrieve owner for {guid}: {str(e)}")
+    except Exception:
+        # If there's an error getting the owner, silently keep the defaults
+        # No print statement to avoid errors at the top of reports
+        pass
 
     # Compose URL to logs if we have a dashboard URL, only owner/editor have access
     if dashboard_url and content.get("app_role") != "viewer":
@@ -444,7 +445,7 @@ def create_report_display(result_data, check_time_value, current_user_name):
     if logs_url:
         logs_display = f"<a href='{logs_url}' target='_blank' style='text-decoration:none;'>📋 View Logs</a>"
     else:
-        logs_display = f"Log access is restricted for {current_user_name}. Logs are only available to the content owner and collaborators."
+        logs_display = f"Log access is restricted for <b>{current_user_name}</b>. Logs are only available to the content owner and collaborators."
 
     # Format owner information
     owner_name = result_data.get('owner_name', 'Unknown')

extensions/content-health-monitor/manifest.json

@@ -32,7 +32,7 @@
     "version": "3.11.7",
     "package_manager": {
       "name": "pip",
-      "version": "25.1.1",
+      "version": "24.2",
       "package_file": "requirements.txt"
     }
   },
@@ -41,10 +41,10 @@
       "checksum": "5f89d52674b219c0b0ed85f1a5785641"
     },
     "content-health-monitor.qmd": {
-      "checksum": "db9599dc24337de8c0becbcefb203371"
+      "checksum": "f3cb8562a07f411da78748d107ffeb3e"
     },
     "content_health_utils.py": {
-      "checksum": "3fc5386653742d8bf625686e486466ea"
+      "checksum": "0ce8c4e2191fc4763492c5498626912f"
     },
     "images/refresh-report.png": {
       "checksum": "e5680e6188eb8d659e4313cb89d0be3b"

extensions/content-health-monitor/test_content_health_utils.py

@@ -1052,7 +1052,7 @@ def test_create_report_display_without_logs_url(self):
         # Assert
         assert html_output is not None
         # Check that the "log access restricted" message is shown with the current user's name
-        assert f"Log access is restricted for {current_user_name}" in html_output
+        assert f"Log access is restricted for <b>{current_user_name}</b>" in html_output
         assert "only available to the content owner and collaborators" in html_output
         # Ensure there's no logs link
         assert "View Logs</a>" not in html_output