Merge pull request #55 from hexa2k9/feature-return-runner-name-in-webhook-operations

Provide additional Details for Webhook Operations

Author: Cyclenerd

app/clients/gcloud_client.py

@@ -54,7 +54,14 @@ def _get_template_name(self, template_name):
         except Exception:
             return None
 
-    def create_runner_instance(self, registration_token, repo_url, template_name, instance_label=None):
+    def create_runner_instance(
+        self,
+        registration_token,
+        repo_url,
+        template_name,
+        instance_label=None,
+        delivery_id=None,
+    ):
         """
         Create a new GCE instance for a GitHub Actions runner.
 
@@ -63,16 +70,26 @@ def create_runner_instance(self, registration_token, repo_url, template_name, in
             repo_url (str): The URL of the repository or organization.
             template_name (str): The name of the instance template to use.
             instance_label (str): Label to add to the Instance for Cost Tracking.
+            delivery_id (str): The GitHub webhook delivery ID for log correlation.
 
         Returns:
             str: The name of the created instance.
         """
         instance_template_resource = self._get_template_name(template_name)
         if instance_template_resource:
-            logger.info(f"Found matching instance template: {instance_template_resource.name}")
+            logger.info(
+                "Found matching instance template: %s, delivery_id: %s",
+                instance_template_resource.name,
+                delivery_id,
+            )
         else:
-            logger.warning(f"No matching instance template found for label '{template_name}' in region {self.region}. "
-                           "Skipping instance creation.")
+            logger.warning(
+                "No matching instance template found for label '%s' in region %s. "
+                "Skipping instance creation. delivery_id: %s",
+                template_name,
+                self.region,
+                delivery_id,
+            )
             return None
 
         instance_uuid = uuid.uuid4().hex[:16]
@@ -81,7 +98,12 @@ def create_runner_instance(self, registration_token, repo_url, template_name, in
         else:
             instance_name = f"runner-{instance_uuid}"
 
-        logger.info(f"Creating GCE instance {instance_name} with template {instance_template_resource.self_link}")
+        logger.info(
+            "Creating GCE instance %s with template %s, delivery_id: %s",
+            instance_name,
+            instance_template_resource.self_link,
+            delivery_id,
+        )
 
         # Set instance name
         instance_resource = compute_v1.Instance()  # google.cloud.compute_v1.types.Instance
@@ -122,30 +144,46 @@ def create_runner_instance(self, registration_token, repo_url, template_name, in
 
         try:
             # https://docs.cloud.google.com/compute/docs/reference/rest/v1/instances/insert
-            operation = self.instance_client.insert(
-                request=request
+            operation = self.instance_client.insert(request=request)
+            logger.info(
+                "Instance creation operation started: %s, delivery_id: %s",
+                operation.name,
+                delivery_id,
             )
-            logger.info(f"Instance creation operation started: {operation.name}")
             return instance_name
         except Exception as e:
-            logger.error(f"Failed to create instance: {e}")
+            logger.error(
+                "Failed to create instance: %s, delivery_id: %s", e, delivery_id
+            )
             raise
 
-    def delete_runner_instance(self, instance_name):
+    def delete_runner_instance(self, instance_name, delivery_id=None):
         """
         Delete a GCE instance.
 
         Args:
             instance_name (str): The name of the instance to delete.
+            delivery_id (str): The GitHub webhook delivery ID for log correlation.
         """
-        logger.info(f"Deleting GCE instance {instance_name}")
+        logger.info(
+            "Deleting GCE instance %s, delivery_id: %s", instance_name, delivery_id
+        )
         try:
             operation = self.instance_client.delete(
                 project=self.project_id,
                 zone=self.zone,
                 instance=instance_name
             )
-            logger.info(f"Instance deletion operation started: {operation.name}")
+            logger.info(
+                "Instance deletion operation started: %s, delivery_id: %s",
+                operation.name,
+                delivery_id,
+            )
         except Exception as e:
-            logger.error(f"Failed to delete instance {instance_name}: {e}")
+            logger.error(
+                "Failed to delete instance %s: %s, delivery_id: %s",
+                instance_name,
+                e,
+                delivery_id,
+            )
             raise

app/clients/github_client.py

@@ -79,7 +79,7 @@ def get_installation_access_token(self):
         # The installation access token will expire after 1 hour.
         return response.json()['token']
 
-    def get_registration_token(self, org_name=None, repo_name=None):
+    def get_registration_token(self, org_name=None, repo_name=None, delivery_id=None):
         """Gets a runner registration token."""
         # https://docs.github.com/en/rest/actions/self-hosted-runners
         token = self.get_installation_access_token()
@@ -90,12 +90,20 @@ def get_registration_token(self, org_name=None, repo_name=None):
         }
         if org_name:
             # GitHub Docs: https://t.ly/dAyGK
-            url = f'https://api.github.com/orgs/{org_name}/actions/runners/registration-token'
-            logger.info(f"Create registration token for organization: {org_name}")
+            url = f"https://api.github.com/orgs/{org_name}/actions/runners/registration-token"
+            logger.info(
+                "Create registration token for organization: %s, delivery_id: %s",
+                org_name,
+                delivery_id,
+            )
         elif repo_name:
             # GitHub Docs: https://t.ly/n0w2a
-            url = f'https://api.github.com/repos/{repo_name}/actions/runners/registration-token'
-            logger.info(f"Create registration token for repository: {repo_name}")
+            url = f"https://api.github.com/repos/{repo_name}/actions/runners/registration-token"
+            logger.info(
+                "Create registration token for repository: %s, delivery_id: %s",
+                repo_name,
+                delivery_id,
+            )
         else:
             raise ValueError("Either org_name or repo_name must be provided")
 

app/routes/webhook.py

@@ -18,13 +18,15 @@ def webhook():
     """Handle incoming GitHub webhook events."""
     # https://docs.github.com/en/webhooks/webhook-events-and-payloads
     event_type = request.headers.get('X-GitHub-Event')
+    # https://docs.github.com/en/webhooks/webhook-events-and-payloads#delivery-headers
+    delivery_id = request.headers.get('X-GitHub-Delivery')
 
     # Validate event type
     if not event_type or not isinstance(event_type, str):
         logger.error("Missing or invalid X-GitHub-Event header")
         return jsonify({'status': 'error', 'message': 'Invalid event type'}), 400
 
-    logger.info("Received webhook event: %s", event_type)
+    logger.info("Received webhook event: %s, delivery_id: %s", event_type, delivery_id)
 
     # Handle ping event
     if event_type == 'ping':
@@ -34,36 +36,72 @@ def webhook():
     signature = request.headers.get('X-Hub-Signature-256')
 
     if not verify_github_signature(request.data, signature):
-        logger.error("GitHub webhook signature not successfully verified! Ignoring webhook event.")
+        logger.error(
+            "GitHub webhook signature not successfully verified! "
+            "Ignoring webhook event. delivery_id: %s",
+            delivery_id,
+        )
         return jsonify({'status': 'forbidden', 'message': 'Invalid signature'}), 403
 
     # Validate JSON payload
     try:
         payload = request.json
         if not payload:
-            logger.error("Empty or invalid JSON payload")
+            logger.error("Empty or invalid JSON payload, delivery_id: %s", delivery_id)
             return jsonify({'status': 'error', 'message': 'Invalid JSON payload'}), 400
     except Exception as e:
-        logger.error("Failed to parse JSON payload: %s", str(e))
+        logger.error(
+            "Failed to parse JSON payload: %s, delivery_id: %s",
+            str(e),
+            delivery_id,
+        )
         return jsonify({'status': 'error', 'message': 'Invalid JSON'}), 400
 
     # https://docs.github.com/en/webhooks/webhook-events-and-payloads#workflow_job
     if event_type == 'workflow_job':
-        return handle_workflow_job_event(payload)
+        return handle_workflow_job_event(payload, delivery_id)
     else:
-        logger.warning("Received unknown event type: %s", event_type)
+        logger.warning(
+            "Received unknown event type: %s, delivery_id: %s",
+            event_type,
+            delivery_id,
+        )
         return jsonify({'status': 'ignored'}), 200
 
 
-def handle_workflow_job_event(payload):
+def handle_workflow_job_event(payload, delivery_id=None):
     """Handle workflow_job event."""
     try:
         webhook_service = WebhookService()
-        webhook_service.handle_workflow_job(payload)
-        return jsonify({'status': 'success'}), 200
+        result = webhook_service.handle_workflow_job(payload, delivery_id=delivery_id)
+        logger.info(
+            "Webhook processed successfully, action: %s, runner_name: %s, "
+            "delivery_id: %s",
+            result.get("action"),
+            result.get("runner_name"),
+            delivery_id,
+        )
+        return (
+            jsonify(
+                {
+                    'status': 'success',
+                    'action': result.get('action'),
+                    'runner_name': result.get('runner_name'),
+                }
+            ),
+            200,
+        )
     except ValueError as e:
-        logger.error("[Webhook] Validation error: %s", str(e))
+        logger.error(
+            "[Webhook] Validation error: %s, delivery_id: %s",
+            str(e),
+            delivery_id,
+        )
         return jsonify({'status': 'error', 'message': 'Invalid payload'}), 400
     except Exception as e:
-        logger.error("[Webhook] Error handling webhook: %s", str(e))
+        logger.error(
+            "[Webhook] Error handling webhook: %s, delivery_id: %s",
+            str(e),
+            delivery_id,
+        )
         return jsonify({'status': 'error', 'message': 'Internal error'}), 500