Rename MONITORED_CONTENT_GUID to a more generic MONITORED_CONTENT (#269)

Author: cgraham-rs

extensions/content-health-monitor/README.md

@@ -12,7 +12,7 @@ The following environment variables are required when previewing the report loca
 # Required variables
 CONNECT_SERVER  # Set automatically when deployed to Connect
 CONNECT_API_KEY # Set automatically when deployed to Connect
-MONITORED_CONTENT_GUID # GUID for the content to monitor
+MONITORED_CONTENT # GUID for the content to monitor
 ```	
 
 # Usage

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

@@ -32,7 +32,7 @@ current_user_name = utils.DEFAULT_USER_NAME  # Will be updated if user info can
 # Read environment variables
 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)
+monitored_content_guid = utils.get_env_var("MONITORED_CONTENT", state)
 
 # Extract GUID if it's a string or URL containing a GUID
 if monitored_content_guid:

extensions/content-health-monitor/content_health_utils.py

@@ -63,9 +63,9 @@ def get_env_var(var_name, state, description=""):
         state.show_instructions = True
 
         # Generic instruction for most variables
-        if var_name != "MONITORED_CONTENT_GUID":
+        if var_name != "MONITORED_CONTENT":
             instruction = f"Please set the <code>{var_name}</code> environment variable."
-        # Detailed instructions for MONITORED_CONTENT_GUID
+        # Detailed instructions for MONITORED_CONTENT
         else:
             one_tab = "&nbsp;&nbsp;&nbsp;&nbsp;"  # For indentation in HTML
             two_tabs = f"{one_tab}{one_tab}"  # For deeper indentation
@@ -147,7 +147,7 @@ def extract_guid(input_string):
     url_pattern = re.compile(r'^https?://', re.IGNORECASE)
     if url_pattern.match(input_string):
         error_message = (
-            f"The URL provided in <code>MONITORED_CONTENT_GUID</code> does not contain a valid GUID. "
+            f"The URL provided in <code>MONITORED_CONTENT</code> does not contain a valid GUID. "
             f"The URL should contain a GUID like: <code>1d97c1ff-e56c-4074-906f-cb3557685b75</code><br><br>"
             f"The URL provided is: <a href=\"{input_string}\" target=\"_blank\" rel=\"noopener noreferrer\">{input_string}</a><br><br>"
             f"Please update your environment variable with a valid GUID or a URL containing a GUID."
@@ -156,7 +156,7 @@ def extract_guid(input_string):
 
     # Handle non-URL strings that don't match GUID format
     error_message = (
-        f"The value provided in <code>MONITORED_CONTENT_GUID</code> is not a valid GUID. "
+        f"The value provided in <code>MONITORED_CONTENT</code> is not a valid GUID. "
         f"A valid GUID looks like: <code>1d97c1ff-e56c-4074-906f-cb3557685b75</code><br><br>"
         f"The provided value was: <code>{input_string}</code><br><br>"
         f"Please update your environment variable with a valid GUID or a URL containing a GUID."
@@ -376,7 +376,7 @@ def create_error_box(guid, error_msg):
         </div>
         
         <div style="{CSS_FOOTER_STYLE}">
-            Please check that your <code>MONITORED_CONTENT_GUID</code> environment variable contains a valid content identifier.
+            Please check that your <code>MONITORED_CONTENT</code> environment variable contains a valid content identifier.
         </div>
     </div>
     """
@@ -395,7 +395,7 @@ def create_no_results_box():
                 <li>There was an issue connecting to the specified content</li>
                 <li>The environment is properly configured but there was an error that caused no data to be returned</li>
             </ul>
-            <p>Please check your MONITORED_CONTENT_GUID environment variable and ensure it contains a valid content identifier.</p>
+            <p>Please check your MONITORED_CONTENT environment variable and ensure it contains a valid content identifier.</p>
         </div>
     </div>
     """

extensions/content-health-monitor/test_content_health_utils.py

@@ -152,9 +152,9 @@ def test_get_env_var_missing_standard(self, state):
         assert f"Please set the <code>{var_name}</code> environment variable." in state.instructions[0]
 
     def test_get_env_var_missing_canary_guid(self, state):
-        """Test get_env_var when MONITORED_CONTENT_GUID is missing"""
+        """Test get_env_var when MONITORED_CONTENT is missing"""
         # Setup
-        var_name = "MONITORED_CONTENT_GUID"
+        var_name = "MONITORED_CONTENT"
         clear_env_var(var_name)  # Ensure it doesn't exist
 
         # Execute
@@ -164,7 +164,7 @@ def test_get_env_var_missing_canary_guid(self, state):
         assert result == ""
         assert state.show_instructions
         assert len(state.instructions) == 1
-        assert "you must configure the <code>MONITORED_CONTENT_GUID</code> environment variable" in state.instructions[0]
+        assert "you must configure the <code>MONITORED_CONTENT</code> environment variable" in state.instructions[0]
         assert f"<code>{var_name}</code>" in state.instructions[0]
 
     def test_get_env_var_with_description(self, state):
@@ -290,7 +290,7 @@ def test_extract_guid_with_url_no_guid(self):
         # Assert
         assert result == input_string
         assert error_message is not None
-        assert "The URL provided in <code>MONITORED_CONTENT_GUID</code> does not contain a valid GUID" in error_message
+        assert "The URL provided in <code>MONITORED_CONTENT</code> does not contain a valid GUID" in error_message
         assert "The URL should contain a GUID like: <code>1d97c1ff-e56c-4074-906f-cb3557685b75</code>" in error_message
         assert f"<a href=\"{input_string}\" target=\"_blank\" rel=\"noopener noreferrer\">" in error_message
         assert "Please update your environment variable with a valid GUID or a URL containing a GUID" in error_message
@@ -306,7 +306,7 @@ def test_extract_guid_with_plain_text(self):
         # Assert
         assert result == input_string
         assert error_message is not None
-        assert "The value provided in <code>MONITORED_CONTENT_GUID</code> is not a valid GUID" in error_message
+        assert "The value provided in <code>MONITORED_CONTENT</code> is not a valid GUID" in error_message
         assert "A valid GUID looks like: <code>1d97c1ff-e56c-4074-906f-cb3557685b75</code>" in error_message
         assert f"The provided value was: <code>{input_string}</code>" in error_message
         assert "Please update your environment variable with a valid GUID or a URL containing a GUID" in error_message
@@ -802,10 +802,10 @@ def test_scenario_no_canary_guid_env_var(self, mock_client, state):
         Expected: If scheduled, DOES NOT send an email
         """
         # Clear environment variable if it exists
-        clear_env_var("MONITORED_CONTENT_GUID")
+        clear_env_var("MONITORED_CONTENT")
 
         # Execute - Try to get the env var
-        result = get_env_var("MONITORED_CONTENT_GUID", state)
+        result = get_env_var("MONITORED_CONTENT", state)
 
         # Assert - It should be empty and show instructions
         assert result == ""

extensions/content-health-monitor/test_integration.py

@@ -23,7 +23,7 @@ def clean_environment():
         os.environ['PYTHONPATH'] = original_env['PYTHONPATH']
 
     # Explicitly ensure these variables are not set
-    for var in ['MONITORED_CONTENT_GUID', 'VAR1', 'VAR2', 'TEST_VAR']:
+    for var in ['MONITORED_CONTENT', 'VAR1', 'VAR2', 'TEST_VAR']:
         if var in os.environ:
             del os.environ[var]
 
@@ -55,18 +55,18 @@ def test_get_env_var_missing_variable(clean_environment, state):
     This simulates the case that was causing errors in Connect.
     """
     # Make sure the variable is not in environment
-    if 'MONITORED_CONTENT_GUID' in os.environ:
-        del os.environ['MONITORED_CONTENT_GUID']
+    if 'MONITORED_CONTENT' in os.environ:
+        del os.environ['MONITORED_CONTENT']
 
     # Call the function that was failing
-    value = content_health_utils.get_env_var('MONITORED_CONTENT_GUID', state)
+    value = content_health_utils.get_env_var('MONITORED_CONTENT', state)
 
     # Verify function behavior
     assert value == ""
     assert state.show_instructions is True
     assert len(state.instructions) == 1
     assert "Content Settings" in state.instructions[0]
-    assert "<code>MONITORED_CONTENT_GUID</code>" in state.instructions[0]
+    assert "<code>MONITORED_CONTENT</code>" in state.instructions[0]
 
 def test_multiple_env_var_checks(clean_environment, state):
     """
@@ -76,7 +76,7 @@ def test_multiple_env_var_checks(clean_environment, state):
     # Check several variables
     var1 = content_health_utils.get_env_var('VAR1', state)
     var2 = content_health_utils.get_env_var('VAR2', state)
-    var3 = content_health_utils.get_env_var('MONITORED_CONTENT_GUID', state)
+    var3 = content_health_utils.get_env_var('MONITORED_CONTENT', state)
 
     # Verify function behavior
     assert var1 == ""