-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathmain.py
More file actions
667 lines (601 loc) · 22.8 KB
/
main.py
File metadata and controls
667 lines (601 loc) · 22.8 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
#!/usr/bin/env python3
"""
github-webhook-mcp — GitHub webhook receiver + MCP server
Usage:
python main.py webhook [--port 8080] [--secret $WEBHOOK_SECRET] [--event-profile all|notifications]
python main.py mcp
"""
import argparse
import asyncio
import hashlib
import hmac
import json
import os
import shlex
import sys
import uuid
from collections import Counter
from contextlib import asynccontextmanager
try:
from dotenv import load_dotenv
except ModuleNotFoundError:
def load_dotenv() -> bool:
return False
load_dotenv()
from datetime import datetime, timezone
from pathlib import Path
from typing import Any, Awaitable, Callable
DATA_FILE = Path(__file__).parent / "events.json"
TRIGGER_EVENTS_DIR = Path(__file__).parent / "trigger-events"
PRIMARY_ENCODING = "utf-8"
LEGACY_ENCODINGS = ("utf-8-sig", "cp932", "shift_jis")
NOTIFY_ONLY_EXIT_CODE = 86
DEFAULT_PURGE_DAYS = 1
NOTIFICATION_EVENT_ACTIONS = {
"issues": {"assigned", "closed", "opened", "reopened", "unassigned"},
"issue_comment": {"created"},
"pull_request": {
"assigned",
"closed",
"converted_to_draft",
"opened",
"ready_for_review",
"reopened",
"review_requested",
"review_request_removed",
"synchronize",
"unassigned",
},
"pull_request_review": {"dismissed", "submitted"},
"pull_request_review_comment": {"created"},
"check_run": {"completed"},
"workflow_run": {"completed"},
"discussion": {"answered", "closed", "created", "reopened"},
"discussion_comment": {"created"},
}
# ── Event Store ───────────────────────────────────────────────────────────────
def _load() -> list[dict]:
if DATA_FILE.exists():
raw = DATA_FILE.read_bytes()
for encoding in (PRIMARY_ENCODING, *LEGACY_ENCODINGS):
try:
text = raw.decode(encoding)
events = json.loads(text)
if encoding != PRIMARY_ENCODING:
_save(events)
return events
except (UnicodeDecodeError, json.JSONDecodeError):
continue
raise ValueError(f"Unable to decode event store: {DATA_FILE}")
return []
def _save(events: list[dict]) -> None:
DATA_FILE.write_text(
json.dumps(events, ensure_ascii=False, indent=2),
encoding=PRIMARY_ENCODING,
)
def add_event(event_type: str, payload: dict) -> dict:
events = _load()
event = {
"id": str(uuid.uuid4()),
"type": event_type,
"payload": payload,
"received_at": datetime.now(timezone.utc).isoformat(),
"processed": False,
}
events.append(event)
_save(events)
return event
def get_pending() -> list[dict]:
return [e for e in _load() if not e["processed"]]
def update_event(event_id: str, **updates: Any) -> bool:
events = _load()
for event in events:
if event["id"] == event_id:
event.update(updates)
_save(events)
return True
return False
def _purge_days() -> int:
env = os.environ.get("PURGE_AFTER_DAYS")
if env is not None:
try:
n = int(env)
if n >= 0:
return n
except ValueError:
pass
return DEFAULT_PURGE_DAYS
def purge_processed(events: list[dict]) -> tuple[list[dict], int]:
days = _purge_days()
if days < 0:
return events, 0
cutoff = datetime.now(timezone.utc).timestamp() - days * 86400
before = len(events)
kept = []
for e in events:
if not e.get("processed"):
kept.append(e)
continue
try:
ts = datetime.fromisoformat(e["received_at"]).timestamp()
except (KeyError, ValueError):
kept.append(e)
continue
if ts > cutoff:
kept.append(e)
return kept, before - len(kept)
def _normalize_event_profile(profile: str) -> str:
normalized = (profile or "all").strip().lower()
if normalized not in {"all", "notifications"}:
raise ValueError(f"Unknown event profile: {profile}")
return normalized
def should_store_event(event_type: str, payload: dict, profile: str) -> bool:
normalized = _normalize_event_profile(profile)
if normalized == "all":
return True
allowed_actions = NOTIFICATION_EVENT_ACTIONS.get(event_type)
if not allowed_actions:
return False
action = payload.get("action")
return action in allowed_actions
def _event_number(payload: dict) -> int | str | None:
return (
payload.get("number")
or (payload.get("issue") or {}).get("number")
or (payload.get("pull_request") or {}).get("number")
)
def _event_title(payload: dict) -> str | None:
return (
(payload.get("issue") or {}).get("title")
or (payload.get("pull_request") or {}).get("title")
or (payload.get("discussion") or {}).get("title")
or (payload.get("check_run") or {}).get("name")
or (payload.get("workflow_run") or {}).get("name")
or (payload.get("workflow_job") or {}).get("name")
)
def _event_url(payload: dict) -> str | None:
return (
(payload.get("issue") or {}).get("html_url")
or (payload.get("pull_request") or {}).get("html_url")
or (payload.get("discussion") or {}).get("html_url")
or (payload.get("check_run") or {}).get("html_url")
or (payload.get("workflow_run") or {}).get("html_url")
)
def summarize_event(event: dict) -> dict:
payload = event.get("payload", {})
return {
"id": event["id"],
"type": event["type"],
"received_at": event["received_at"],
"processed": event["processed"],
"trigger_status": event.get("trigger_status"),
"last_triggered_at": event.get("last_triggered_at"),
"action": payload.get("action"),
"repo": (payload.get("repository") or {}).get("full_name"),
"sender": (payload.get("sender") or {}).get("login"),
"number": _event_number(payload),
"title": _event_title(payload),
"url": _event_url(payload),
}
def get_pending_status() -> dict:
pending = get_pending()
return {
"pending_count": len(pending),
"latest_received_at": pending[-1]["received_at"] if pending else None,
"types": dict(Counter(event["type"] for event in pending)),
}
def get_pending_summaries(limit: int = 20) -> list[dict]:
pending = get_pending()
if limit > 0:
pending = pending[-limit:]
return [summarize_event(event) for event in pending]
def get_event(event_id: str) -> dict | None:
for event in _load():
if event["id"] == event_id:
return event
return None
def mark_done(event_id: str) -> dict:
events = _load()
found = False
for event in events:
if event["id"] == event_id:
event["processed"] = True
found = True
break
if not found:
return {"success": False, "purged": 0}
kept, purged = purge_processed(events)
_save(kept)
return {"success": True, "purged": purged}
# ── Direct Trigger Execution ───────────────────────────────────────────────────
def parse_trigger_command(command: str) -> list[str]:
raw = (command or "").strip()
if not raw:
return []
windows_style = os.name == "nt" or ":\\" in raw or raw.startswith("\\\\")
return shlex.split(raw, posix=not windows_style)
def resolve_trigger_command(
env_command: str,
cli_tokens: list[str] | None,
) -> list[str]:
if not cli_tokens:
return parse_trigger_command(env_command)
if len(cli_tokens) == 1:
return parse_trigger_command(cli_tokens[0])
return cli_tokens
def persist_trigger_event(event: dict) -> Path:
TRIGGER_EVENTS_DIR.mkdir(parents=True, exist_ok=True)
event_path = TRIGGER_EVENTS_DIR / f"{event['id']}.json"
event_path.write_text(
json.dumps(event, ensure_ascii=False, indent=2),
encoding=PRIMARY_ENCODING,
)
return event_path
def _stringify_env(value: Any) -> str:
if value is None:
return ""
return str(value)
def build_trigger_env(event: dict, event_path: Path) -> dict[str, str]:
payload = event.get("payload", {})
env = os.environ.copy()
env.update(
{
"GITHUB_WEBHOOK_EVENT_ID": event["id"],
"GITHUB_WEBHOOK_EVENT_TYPE": event["type"],
"GITHUB_WEBHOOK_EVENT_ACTION": _stringify_env(payload.get("action")),
"GITHUB_WEBHOOK_EVENT_REPO": _stringify_env(
(payload.get("repository") or {}).get("full_name")
),
"GITHUB_WEBHOOK_EVENT_SENDER": _stringify_env(
(payload.get("sender") or {}).get("login")
),
"GITHUB_WEBHOOK_EVENT_NUMBER": _stringify_env(_event_number(payload)),
"GITHUB_WEBHOOK_EVENT_TITLE": _stringify_env(_event_title(payload)),
"GITHUB_WEBHOOK_EVENT_URL": _stringify_env(_event_url(payload)),
"GITHUB_WEBHOOK_EVENT_PATH": str(event_path),
"GITHUB_WEBHOOK_RECEIVED_AT": event["received_at"],
}
)
return env
def _summarize_process_output(stdout: bytes, stderr: bytes) -> str:
parts: list[str] = []
if stdout:
parts.append(f"stdout={stdout.decode(PRIMARY_ENCODING, errors='replace').strip()[:400]}")
if stderr:
parts.append(f"stderr={stderr.decode(PRIMARY_ENCODING, errors='replace').strip()[:400]}")
return " ".join(part for part in parts if part).strip()
async def run_trigger_command(
command: list[str],
event: dict,
cwd: Path | None = None,
) -> None:
if not command:
return
event_path = persist_trigger_event(event)
proc = await asyncio.create_subprocess_exec(
*command,
cwd=str(cwd) if cwd else None,
env=build_trigger_env(event, event_path),
stdin=asyncio.subprocess.PIPE,
stdout=asyncio.subprocess.PIPE,
stderr=asyncio.subprocess.PIPE,
)
payload_bytes = json.dumps(event, ensure_ascii=False, indent=2).encode(PRIMARY_ENCODING)
stdout, stderr = await proc.communicate(payload_bytes)
if proc.returncode != 0:
if proc.returncode == NOTIFY_ONLY_EXIT_CODE:
raise TriggerSkipped("trigger command requested notify-only fallback")
details = _summarize_process_output(stdout, stderr)
raise RuntimeError(
f"trigger command failed with exit code {proc.returncode}"
+ (f" ({details})" if details else "")
)
TriggerRunner = Callable[[list[str], dict, Path | None], Awaitable[None]]
class TriggerSkipped(Exception):
"""A trigger command chose not to handle the event directly."""
class TriggerDispatcher:
def __init__(
self,
command: list[str],
*,
cwd: Path | None = None,
mark_processed_on_success: bool = True,
runner: TriggerRunner = run_trigger_command,
) -> None:
self.command = command
self.cwd = cwd
self.mark_processed_on_success = mark_processed_on_success
self.runner = runner
self._queue: asyncio.Queue[dict | None] = asyncio.Queue()
self._worker_task: asyncio.Task[None] | None = None
@property
def enabled(self) -> bool:
return bool(self.command)
async def start(self) -> None:
if self.enabled and self._worker_task is None:
self._worker_task = asyncio.create_task(self._worker())
async def stop(self) -> None:
if self._worker_task is None:
return
await self._queue.put(None)
await self._worker_task
self._worker_task = None
async def enqueue(self, event: dict) -> None:
if not self.enabled:
return
await self._queue.put(event)
async def _worker(self) -> None:
while True:
event = await self._queue.get()
if event is None:
self._queue.task_done()
return
try:
await self.runner(self.command, event, self.cwd)
except TriggerSkipped as exc:
update_event(
event["id"],
trigger_status="skipped",
trigger_error=str(exc),
last_triggered_at=datetime.now(timezone.utc).isoformat(),
)
except Exception as exc:
update_event(
event["id"],
trigger_status="failed",
trigger_error=str(exc),
last_triggered_at=datetime.now(timezone.utc).isoformat(),
)
print(
f"[github-webhook-mcp] trigger failed for {event['id']}: {exc}",
file=sys.stderr,
)
else:
updates: dict[str, Any] = {
"trigger_status": "succeeded",
"trigger_error": "",
"last_triggered_at": datetime.now(timezone.utc).isoformat(),
}
if self.mark_processed_on_success:
updates["processed"] = True
update_event(event["id"], **updates)
finally:
self._queue.task_done()
# ── Webhook Server (FastAPI) ──────────────────────────────────────────────────
def run_webhook(
port: int,
secret: str,
event_profile: str,
*,
trigger_command: list[str] | None = None,
trigger_cwd: Path | None = None,
mark_processed_on_trigger_success: bool = True,
) -> None:
from fastapi import FastAPI, Header, HTTPException, Request
import uvicorn
normalized_profile = _normalize_event_profile(event_profile)
dispatcher = TriggerDispatcher(
trigger_command or [],
cwd=trigger_cwd,
mark_processed_on_success=mark_processed_on_trigger_success,
)
@asynccontextmanager
async def lifespan(_: Any):
await dispatcher.start()
try:
yield
finally:
await dispatcher.stop()
app = FastAPI(title="github-webhook-mcp", lifespan=lifespan)
def _verify(body: bytes, sig: str) -> bool:
if not secret:
return True
if not sig.startswith("sha256="):
return False
expected = hmac.new(secret.encode(), body, hashlib.sha256).hexdigest()
return hmac.compare_digest(f"sha256={expected}", sig)
@app.get("/health")
async def health():
return {"status": "ok"}
@app.post("/webhook")
async def webhook(
request: Request,
x_github_event: str = Header(default=""),
x_hub_signature_256: str = Header(default=""),
):
body = await request.body()
if not _verify(body, x_hub_signature_256):
raise HTTPException(status_code=401, detail="Invalid signature")
payload = json.loads(body)
if not should_store_event(x_github_event, payload, normalized_profile):
return {"ignored": True, "type": x_github_event, "profile": normalized_profile}
event = add_event(x_github_event, payload)
await dispatcher.enqueue(event)
return {"id": event["id"], "type": x_github_event}
uvicorn.run(app, host="0.0.0.0", port=port)
# ── MCP Server (stdio) ────────────────────────────────────────────────────────
async def run_mcp() -> None:
from mcp.server import Server
from mcp.server.stdio import stdio_server
import mcp.types as types
server = Server("github-webhook-mcp")
@server.list_tools()
async def list_tools() -> list[types.Tool]:
return [
types.Tool(
name="get_pending_status",
description=(
"Get a lightweight snapshot of pending GitHub webhook events. "
"Use this for periodic polling before requesting details."
),
inputSchema={"type": "object", "properties": {}, "required": []},
),
types.Tool(
name="list_pending_events",
description=(
"List lightweight summaries for pending GitHub webhook events. "
"Returns metadata only, without full payloads."
),
inputSchema={
"type": "object",
"properties": {
"limit": {
"type": "integer",
"description": "Maximum number of pending events to return",
"minimum": 1,
"maximum": 100,
"default": 20,
}
},
"required": [],
},
),
types.Tool(
name="get_event",
description="Get the full payload for a single webhook event by ID.",
inputSchema={
"type": "object",
"properties": {
"event_id": {
"type": "string",
"description": "The event ID to retrieve",
}
},
"required": ["event_id"],
},
),
types.Tool(
name="get_webhook_events",
description=(
"Get pending (unprocessed) GitHub webhook events with full payloads. "
"Prefer get_pending_status or list_pending_events for polling."
),
inputSchema={"type": "object", "properties": {}, "required": []},
),
types.Tool(
name="mark_processed",
description="Mark a webhook event as processed so it won't appear again.",
inputSchema={
"type": "object",
"properties": {
"event_id": {
"type": "string",
"description": "The event ID to mark as processed",
}
},
"required": ["event_id"],
},
),
]
@server.call_tool()
async def call_tool(
name: str, arguments: dict[str, Any]
) -> list[types.TextContent]:
if name == "get_pending_status":
status = get_pending_status()
return [
types.TextContent(
type="text",
text=json.dumps(status, ensure_ascii=False, indent=2),
)
]
if name == "list_pending_events":
limit = arguments.get("limit", 20)
if not isinstance(limit, int):
raise ValueError("limit must be an integer")
summaries = get_pending_summaries(limit=limit)
return [
types.TextContent(
type="text",
text=json.dumps(summaries, ensure_ascii=False, indent=2),
)
]
if name == "get_event":
event_id = arguments.get("event_id", "")
event = get_event(event_id)
if event is None:
return [
types.TextContent(
type="text",
text=json.dumps({"error": "not_found", "event_id": event_id}),
)
]
return [
types.TextContent(
type="text",
text=json.dumps(event, ensure_ascii=False, indent=2),
)
]
if name == "get_webhook_events":
events = get_pending()
return [
types.TextContent(
type="text",
text=json.dumps(events, ensure_ascii=False, indent=2),
)
]
if name == "mark_processed":
event_id = arguments.get("event_id", "")
result = mark_done(event_id)
return [
types.TextContent(
type="text",
text=json.dumps({"success": result["success"], "event_id": event_id, "purged": result["purged"]}),
)
]
raise ValueError(f"Unknown tool: {name}")
async with stdio_server() as (read_stream, write_stream):
await server.run(
read_stream,
write_stream,
server.create_initialization_options(),
)
# ── Entry Point ───────────────────────────────────────────────────────────────
if __name__ == "__main__":
parser = argparse.ArgumentParser(description="github-webhook-mcp")
sub = parser.add_subparsers(dest="mode", required=True)
wp = sub.add_parser("webhook", help="Start webhook receiver (HTTP server)")
wp.add_argument("--port", type=int, default=8080)
wp.add_argument("--secret", default=os.environ.get("WEBHOOK_SECRET", ""))
wp.add_argument(
"--event-profile",
default=os.environ.get("WEBHOOK_EVENT_PROFILE", "all"),
choices=["all", "notifications"],
)
wp.add_argument(
"--trigger-command",
nargs=argparse.REMAINDER,
help=(
"Optional command to run for each stored event. "
"When provided on the CLI, put it last and pass the command tokens "
"after --trigger-command. "
"The event JSON is sent to stdin and metadata is provided via "
"GITHUB_WEBHOOK_* environment variables."
),
)
wp.add_argument(
"--trigger-cwd",
default=os.environ.get("WEBHOOK_TRIGGER_CWD", ""),
help="Optional working directory for the trigger command.",
)
wp.add_argument(
"--keep-pending-on-trigger-success",
action="store_true",
help="Leave events pending even when the trigger command exits successfully.",
)
sub.add_parser("mcp", help="Start MCP server (stdio transport)")
args = parser.parse_args()
if args.mode == "webhook":
run_webhook(
port=args.port,
secret=args.secret,
event_profile=args.event_profile,
trigger_command=resolve_trigger_command(
os.environ.get("WEBHOOK_TRIGGER_COMMAND", ""),
args.trigger_command,
),
trigger_cwd=Path(args.trigger_cwd).expanduser() if args.trigger_cwd else None,
mark_processed_on_trigger_success=not args.keep_pending_on_trigger_success,
)
elif args.mode == "mcp":
asyncio.run(run_mcp())