App Canary: always display app description (#199)

* Implement posit-sdk

* Provide better formatted instructions, and display the CANARY_GUIDS as text

* Always display app description

* When available use the content_url to monitor the app

* Update .gitignore

Author: cgraham-rs

extensions/app-canary/.gitignore

@@ -1,16 +1,14 @@
+# Quarto
 /.quarto/
 *.quarto_ipynb
-
 /_*.local
-
 app-canary.html
-
 /email-preview
-
 .output_metadata.json
-
 preview.html
+*.quarto_ipynb
 
+# Local dev
 /.posit/
-
 .envrc
+.python-version

extensions/app-canary/app-canary.qmd

@@ -27,19 +27,19 @@ gt_tbl = None
 connect_server = os.environ.get("CONNECT_SERVER", "")
 if not connect_server:
     show_instructions = True
-    instructions.append("Please set the CONNECT_SERVER environment variable.")
+    instructions.append("Please set the <b>CONNECT_SERVER</b> environment variable.")
 
 # Read CONNECT_API_KEY from environment, this is automatically configured on Connect, set manually for local dev
 api_key = os.environ.get("CONNECT_API_KEY", "")
 if not api_key:
     show_instructions = True
-    instructions.append("Please set the CONNECT_API_KEY environment variable.")
+    instructions.append("Please set the <b>CONNECT_API_KEY</b> environment variable.")
 
 # Read CANARY_GUIDS from environment, needs to be manually configured on Connect and for local dev
 canary_guids_str = os.environ.get("CANARY_GUIDS", "")
 if not canary_guids_str:
     show_instructions = True
-    instructions.append("Please set the CANARY_GUIDS environment variable. It should be a comma separated list of GUID you wish to monitor.")
+    instructions.append("Please set the <b>CANARY_GUIDS</b> environment variable. It should be a comma separated list of GUID you wish to monitor.")
     canary_guids = []
 else:
     # Clean up the GUIDs
@@ -120,13 +120,15 @@ if not show_instructions:
     def validate_app(guid):
         # Get app details
         content = get_content(guid)
+
         app_name = content.get("title", "")
         # Title is optional, if not set use name
         if not app_name:
             app_name = content.get("name", "")
         
         # Ensure we have a valid URL
         dashboard_url = content.get("dashboard_url", "")
+        content_url = content.get("content_url", "")
         content_guid = content.get("guid", guid)  # Use the passed guid if not in content
 
         # Initialize default owner information
@@ -158,7 +160,12 @@ if not show_instructions:
             logs_url = ""
 
         try:
-            app_url = f"{connect_server}/content/{guid}"
+            # Use the content_url if available, otherwise construct one so we get a proper status code
+            if content_url:
+                app_url = content_url
+            else:
+                # Likely hit error condition in get_content() thus no content_url available
+                app_url = f"{connect_server}/content/{guid}"
             app_response = requests.get(
                 app_url, 
                 headers=headers,
@@ -212,7 +219,12 @@ if not show_instructions:
 #| echo: false
 #| label: display
 
-# Create a table with basic styling
+about = """<div style="margin-bottom: 10px;">
+This report uses the publisher's API key to monitor a list of application GUIDs, verifies each of the monitored apps are 
+reachable at their content URL, and reports the results. If run on a schedule, reports will be emailed when any monitored 
+application reports a failure.
+</div>"""
+
 if not show_instructions and not df.empty:
     
     # Format the canary_guids as a string for display
@@ -221,11 +233,13 @@ if not show_instructions and not df.empty:
     # Use HTML to create a callout box
     display(HTML(f"""
     <div style="border: 1px solid #ccc; border-radius: 8px; padding: 10px; margin-bottom: 15px; background-color: #f8f9fa;">
-        <div style="margin-top: 0; padding-bottom: 8px; border-bottom: 1px solid #eaecef; font-weight: bold; font-size: 1.2em;">Monitored GUIDs</div>
+        <div style="margin-top: 0; padding-bottom: 8px; border-bottom: 1px solid #eaecef; font-weight: bold; font-size: 1.2em;">App Canary Monitor</div>
+        <div style="padding: 5px 0;">{about}</div>
+        <div style="margin-top: 10px; padding-top: 8px; border-top: 1px solid #eaecef; font-weight: bold;">Monitored GUIDs:</div>
         <div style="padding: 5px 0;">{canary_guids_str}</div>
     </div>
     """))
-
+    
     # First create links for name and guid columns
     df_display = df.copy()
     
@@ -315,7 +329,8 @@ if not show_instructions and not df.empty:
 
 elif show_instructions:
     # Create a callout box for instructions
-    instructions_html = ""
+    instructions_html = about  # Start with the about message
+
     for instruction in instructions:
         instructions_html += f"<div style='margin-bottom: 10px;'>{instruction}</div>"