add webhook support

pr_agent/algo/utils.py

@@ -320,7 +320,7 @@ def _fix_key_value(key: str, value: str):
 
 
 def load_yaml(response_text: str, keys_fix_yaml: List[str] = []) -> dict:
-    response_text = response_text.removeprefix('```yaml').rstrip('`')
+    response_text = response_text.removeprefix('```yaml').rstrip('`').rstrip(':\n')
     try:
         data = yaml.safe_load(response_text)
     except Exception as e:

pr_agent/git_providers/azuredevops_provider.py

@@ -10,6 +10,7 @@ from .git_provider import GitProvider
 from pr_agent.algo.types import EDIT_TYPE, FilePatchInfo
 
 AZURE_DEVOPS_AVAILABLE = True
+MEX_PR_DESCRIPTION_LENGTH = 4000-1
 
 try:
     # noinspection PyUnresolvedReferences
@@ -324,6 +325,11 @@ class AzureDevopsProvider(GitProvider):
             )
 
     def publish_description(self, pr_title: str, pr_body: str):
+        if len(pr_body) > MEX_PR_DESCRIPTION_LENGTH:
+            pr_body = pr_body[:MEX_PR_DESCRIPTION_LENGTH]
+            get_logger().warning(
+                "PR description exceeds the maximum character limit of 4000. Truncating the description."
+            )
         try:
             updated_pr = GitPullRequest()
             updated_pr.title = pr_title

pr_agent/servers/azuredevops_server_webhook.py

@@ -0,0 +1,110 @@
+# This file contains the code for the Azure DevOps Server webhook server.
+# The server listens for incoming webhooks from Azure DevOps Server and forwards them to the PR Agent.
+# ADO webhook documentation: https://learn.microsoft.com/en-us/azure/devops/service-hooks/services/webhooks?view=azure-devops
+
+import json
+import os
+import re
+
+import uvicorn
+from fastapi import APIRouter, FastAPI
+from fastapi.encoders import jsonable_encoder
+from starlette import status
+from starlette.background import BackgroundTasks
+from starlette.middleware import Middleware
+from starlette.requests import Request
+from starlette.responses import JSONResponse
+from starlette_context.middleware import RawContextMiddleware
+
+from pr_agent.agent.pr_agent import PRAgent, command2class
+from pr_agent.config_loader import get_settings
+from pr_agent.log import get_logger
+import base64
+
+router = APIRouter()
+available_commands_rgx = re.compile(r"^\/(" + "|".join(command2class.keys()) + r")\s*")
+azuredevops_server = get_settings().get("azure_devops")
+WEBHOOK_USERNAME = azuredevops_server.get("webhook_username")
+WEBHOOK_PASSWORD = azuredevops_server.get("webhook_password")
+
+def handle_request(
+    background_tasks: BackgroundTasks, url: str, body: str, log_context: dict
+):
+    log_context["action"] = body
+    log_context["api_url"] = url
+    with get_logger().contextualize(**log_context):
+        background_tasks.add_task(PRAgent().handle_request, url, body)
+
+
+@router.post("/")
+async def handle_webhook(background_tasks: BackgroundTasks, request: Request):
+    log_context = {"server_type": "azuredevops_server"}
+    data = await request.json()
+    get_logger().info(json.dumps(data))
+
+    if not validate_basic_auth(request):
+        get_logger().error("Unauthorized webhook request")
+        return JSONResponse(
+            status_code=status.HTTP_401_UNAUTHORIZED,
+            content=json.dumps({"message": "unauthorized"}),
+        )
+
+    if data["eventType"] == "git.pullrequest.created": 
+        body = "review"
+        # API V1 (latest)
+        pr_url = data["resource"]["_links"]["web"]["href"].replace("_apis/git/repositories", "_git")
+    elif data["eventType"] == "ms.vss-code.git-pullrequest-comment-event":
+        if available_commands_rgx.match(data["resource"]["comment"]["content"]):
+            if(data["resourceVersion"] == "2.0"):
+                repo = data["resource"]["pullRequest"]["repository"]["webUrl"]
+                pr_url = f'{repo}/pullrequest/{data["resource"]["pullRequest"]["pullRequestId"]}'
+                body = data["resource"]["comment"]["content"]
+            else: 
+                # API V1 not supported as it does not contain the PR URL
+                return JSONResponse(
+                    status_code=status.HTTP_400_BAD_REQUEST,
+                    content=json.dumps({"message": "version 1.0 webhook for Azure Devops PR comment is not supported. please upgrade to version 2.0"})),
+        else:
+            return JSONResponse(
+                status_code=status.HTTP_400_BAD_REQUEST,
+                content=json.dumps({"message": "Unsupported command"}),
+            )
+    else:
+        return JSONResponse(
+            status_code=status.HTTP_400_BAD_REQUEST,
+            content=json.dumps({"message": "Unsupported event"}),
+        )
+
+    log_context["event"] = data["eventType"]
+    log_context["api_url"] = pr_url
+    
+    try:
+        handle_request(background_tasks, pr_url, body, log_context)
+        return JSONResponse(
+            status_code=status.HTTP_200_OK, content=jsonable_encoder({"message": "success"})
+        )
+    except Exception as e:
+        get_logger().error("Azure DevOps Trigger failed. Error:" + str(e))
+        return JSONResponse(
+            status_code=status.HTTP_500_INTERNAL_SERVER_ERROR,
+            content=json.dumps({"message": "Internal server error"}),
+        )
+
+# currently only basic auth is supported with azure webhooks
+def validate_basic_auth(request: Request):
+    auth = request.headers.get("Authorization")
+    if not auth:
+        return False
+    if not auth.startswith("Basic "):
+        return False
+    decoded_auth = base64.b64decode(auth.split(" ")[1]).decode()
+    username, password = decoded_auth.split(":")
+    return username == WEBHOOK_USERNAME and password == WEBHOOK_PASSWORD
+
+def start():
+    app = FastAPI(middleware=[Middleware(RawContextMiddleware)])
+    app.include_router(router)
+    uvicorn.run(app, host="0.0.0.0", port=int(os.environ.get("PORT", "3000")))
+
+if __name__ == "__main__":
+    start()

pr_agent/settings/.secrets_template.toml

@@ -76,3 +76,9 @@ base_url = ""
 
 [litellm]
 LITELLM_TOKEN = "" # see https://docs.litellm.ai/docs/debugging/hosted_debugging for details and instructions on how to get a token
+
+[azuredevops_server]
+# For Azure devops Server basic auth - configured in the webhook creation 
+# Optional, uncomment if you want to use Azure devops webhooks. Value assinged when you create the webhook
+# webhook_username = "<basic auth user>"
+# webhook_password = "<basic auth password>"