feat: Enhance GitHub App functionality with improved error logging and API versioning

Author: ColinDaglish

infra/terraform/main.tf

@@ -82,11 +82,12 @@ resource "google_artifact_registry_repository" "app" {
 }
 
 # Cloud Run service for the GitHub App (deployed only if image is provided)
+# https://registry.terraform.io/providers/hashicorp/google/latest/docs/resources/cloud_run_v2_service#attributes-reference
 resource "google_cloud_run_v2_service" "app" {
-  count    = local.deploy_app ? 1 : 0
-  name     = var.service_name
-  location = var.region
-
+  count               = local.deploy_app ? 1 : 0
+  name                = var.service_name
+  location            = var.region
+  deletion_protection = false
   template {
     service_account = google_service_account.app.email
 
@@ -177,7 +178,7 @@ resource "google_api_gateway_api_config" "webhook" {
     document {
       path = "${path.module}/api-config.yaml"
       contents = base64encode(templatefile("${path.module}/api-config.yaml", {
-        service_url = google_cloud_run_v2_service.app[0].uri
+        service_url = "https://${var.service_name}-${data.google_project.project.number}.${var.region}.run.app"
       }))
     }
   }

src/github_app.py

@@ -3,11 +3,14 @@
 
 import jwt
 import requests
+import logging
 
 from src.config import get_env, normalize_private_key
 from src.config import get_secret
 
 GITHUB_API = "https://api.github.com"
+logger = logging.getLogger("github-app")
+GITHUB_API_VERSION = "2022-11-28"
 
 
 def create_app_jwt() -> str:
@@ -29,8 +32,16 @@ def get_installation_token(installation_id: int) -> Dict[str, str]:
     headers = {
         "Authorization": f"Bearer {token}",
         "Accept": "application/vnd.github+json",
+        "User-Agent": "ons-github-app",
+        "X-GitHub-Api-Version": GITHUB_API_VERSION,
     }
     response = requests.post(url, headers=headers, timeout=10)
+    if not response.ok:
+        logger.error(
+            "GitHub installation token request failed status=%s body=%s",
+            response.status_code,
+            response.text,
+        )
     response.raise_for_status()
     data = response.json()
     return {"token": data["token"], "expires_at": data["expires_at"]}
@@ -42,8 +53,18 @@ def post_pr_comment(*, installation_id: int, repo_full_name: str, pr_number: int
     token = get_installation_token(installation_id)["token"]
     url = f"{GITHUB_API}/repos/{repo_full_name}/issues/{pr_number}/comments"
     headers = {
-        "Authorization": f"token {token}",
+        "Authorization": f"Bearer {token}",
         "Accept": "application/vnd.github+json",
+        "User-Agent": "ons-github-app",
+        "X-GitHub-Api-Version": GITHUB_API_VERSION,
     }
     response = requests.post(url, headers=headers, json={"body": body}, timeout=10)
+    if not response.ok:
+        logger.error(
+            "GitHub post comment failed repo=%s pr=%s status=%s body=%s",
+            repo_full_name,
+            pr_number,
+            response.status_code,
+            response.text,
+        )
     response.raise_for_status()