INTEGRITY Dokumentace

Vytvořte bota pro revizi kódu

Vytvořte GitHub bota, který reaguje na pull requesty, naklonuje repozitář do sandboxu, pomocí Claude analyzuje změny v kódu a zveřejňuje komentáře k revizi.

Doba dokončení: 30 minut

Předpoklady

  1. Zaregistrujte si účet Cloudflare ↗.
  2. Nainstalujte Node.js ↗.

Správce verzí Node.js

Použijte správce verzí Node, jako je Volta ↗ nebo nvm ↗ abyste se vyhnuli problémům s oprávněními a mohli měnit verze Node.js. Wrangler, o kterém se dozvíte dále v této příručce, vyžaduje verzi Node 16.17.0 nebo novější.

Budete také potřebovat:

1. Vytvořte projekt

npm create cloudflare@latest -- code-review-bot --template=cloudflare/sandbox-sdk/examples/minimal
cd code-review-bot

2. Nainstalujte závislosti

npm i @anthropic-ai/sdk @octokit/rest

3. Sestavte handler pro webhook

Nahraďte src/index.ts:

import { getSandbox, proxyToSandbox, type Sandbox } from "@cloudflare/sandbox";
import { Octokit } from "@octokit/rest";
import Anthropic from "@anthropic-ai/sdk";

export { Sandbox } from "@cloudflare/sandbox";

interface Env {
	Sandbox: DurableObjectNamespace<Sandbox>;
	GITHUB_TOKEN: string;
	ANTHROPIC_API_KEY: string;
	WEBHOOK_SECRET: string;
}

export default {
	async fetch(
		request: Request,
		env: Env,
		ctx: ExecutionContext,
	): Promise<Response> {
		const proxyResponse = await proxyToSandbox(request, env);
		if (proxyResponse) return proxyResponse;

		const url = new URL(request.url);

		if (url.pathname === "/webhook" && request.method === "POST") {
			const signature = request.headers.get("x-hub-signature-256");
			const contentType = request.headers.get("content-type") || "";
			const body = await request.text();

			// Verify webhook signature
			if (
				!signature ||
				!(await verifySignature(body, signature, env.WEBHOOK_SECRET))
			) {
				return Response.json({ error: "Invalid signature" }, { status: 401 });
			}

			const event = request.headers.get("x-github-event");

			// Parse payload (GitHub can send as JSON or form-encoded)
			let payload;
			if (contentType.includes("application/json")) {
				payload = JSON.parse(body);
			} else {
				// Handle form-encoded payload
				const params = new URLSearchParams(body);
				payload = JSON.parse(params.get("payload") || "{}");
			}

			// Handle opened and reopened PRs
			if (
				event === "pull_request" &&
				(payload.action === "opened" || payload.action === "reopened")
			) {
				console.log(`Starting review for PR #${payload.pull_request.number}`);
				// Use waitUntil to ensure the review completes even after response is sent
				ctx.waitUntil(
					reviewPullRequest(payload, env).catch(console.error),
				);
				return Response.json({ message: "Review started" });
			}

			return Response.json({ message: "Event ignored" });
		}

		return new Response(
			"Code Review Bot\n\nConfigure GitHub webhook to POST /webhook",
		);
	},
};

async function verifySignature(
	payload: string,
	signature: string,
	secret: string,
): Promise<boolean> {
	const encoder = new TextEncoder();
	const key = await crypto.subtle.importKey(
		"raw",
		encoder.encode(secret),
		{ name: "HMAC", hash: "SHA-256" },
		false,
		["sign"],
	);

	const signatureBytes = await crypto.subtle.sign(
		"HMAC",
		key,
		encoder.encode(payload),
	);
	const expected =
		"sha256=" +
		Array.from(new Uint8Array(signatureBytes))
			.map((b) => b.toString(16).padStart(2, "0"))
			.join("");

	return signature === expected;
}

async function reviewPullRequest(payload: any, env: Env): Promise<void> {
	const pr = payload.pull_request;
	const repo = payload.repository;
	const octokit = new Octokit({ auth: env.GITHUB_TOKEN });
	const sandbox = getSandbox(env.Sandbox, `review-${pr.number}`);

	try {
		// Post initial comment
		console.log("Posting initial comment...");
		await octokit.issues.createComment({
			owner: repo.owner.login,
			repo: repo.name,
			issue_number: pr.number,
			body: "Code review in progress...",
		});
		// Clone repository
		console.log("Cloning repository...");
		const cloneUrl = `https://${env.GITHUB_TOKEN}@github.com/${repo.owner.login}/${repo.name}.git`;
		await sandbox.exec(
			`git clone --depth=1 --branch=${pr.head.ref} ${cloneUrl} /workspace/repo`,
		);

		// Get changed files
		console.log("Fetching changed files...");
		const comparison = await octokit.repos.compareCommits({
			owner: repo.owner.login,
			repo: repo.name,
			base: pr.base.sha,
			head: pr.head.sha,
		});

		const files = [];
		for (const file of (comparison.data.files || []).slice(0, 5)) {
			if (file.status !== "removed") {
				const content = await sandbox.readFile(
					`/workspace/repo/${file.filename}`,
				);
				files.push({
					path: file.filename,
					patch: file.patch || "",
					content: content.content,
				});
			}
		}

		// Generate review with Claude
		console.log(`Analyzing ${files.length} files with Claude...`);
		const anthropic = new Anthropic({ apiKey: env.ANTHROPIC_API_KEY });
		const response = await anthropic.messages.create({
			model: "claude-sonnet-4-5",
			max_tokens: 2048,
			messages: [
				{
					role: "user",
					content: `Review this PR:

Title: ${pr.title}

Changed files:
${files.map((f) => `File: ${f.path}\nDiff:\n${f.patch}\n\nContent:\n${f.content.substring(0, 1000)}`).join("\n\n")}

Provide a brief code review focusing on bugs, security, and best practices.`,
				},
			],
		});

		const review =
			response.content[0]?.type === "text"
				? response.content[0].text
				: "No review generated";

		// Post review comment
		console.log("Posting review...");
		await octokit.issues.createComment({
			owner: repo.owner.login,
			repo: repo.name,
			issue_number: pr.number,
			body: `## Code Review\n\n${review}\n\n---\n*Generated by Claude*`,
		});
		console.log("Review complete!");
	} catch (error: any) {
		console.error("Review failed:", error);
		await octokit.issues.createComment({
			owner: repo.owner.login,
			repo: repo.name,
			issue_number: pr.number,
			body: `Review failed: ${error.message}`,
		});
	} finally {
		await sandbox.destroy();
	}
}

4. Nastavte lokální proměnné prostředí

Vytvořte .dev.vars soubor v kořenovém adresáři projektu pro lokální vývoj:

cat > .dev.vars << EOF
GITHUB_TOKEN=your_github_token_here
ANTHROPIC_API_KEY=your_anthropic_key_here
WEBHOOK_SECRET=your_webhook_secret_here
EOF

Nahraďte zástupné hodnoty za:

5. Zpřístupněte lokální server pomocí Cloudflare Tunnel

Chcete-li lokálně testovat se skutečnými webhooky GitHubu, použijte Cloudflare Tunnel pro zpřístupnění vašeho lokálního vývojového serveru.

Spusťte vývojový server:

npm run dev

V samostatném terminálu vytvořte tunel ke svému místnímu serveru:

cloudflared tunnel --url http://localhost:8787

Tím se vypíše veřejná URL adresa (například https://example.trycloudflare.com). Tuto URL adresu zkopírujte pro další krok.

6. Nakonfigurujte GitHub webhook pro lokální testování

  1. Přejděte do svého testovacího repozitáře na GitHubu
  2. Přejděte na Nastavení > Webhooks > Přidat webhook
  3. Nastavte URL adresa payloadu: Vaše URL adresa Cloudflare Tunnel z kroku 5 s /webhook připojeno (například https://example.trycloudflare.com/webhook)
  4. Nastavte Typ obsahu: application/json
  5. Nastavte Secret: Stejná hodnota, jakou jste použili pro WEBHOOK_SECRET ve vašem .dev.vars soubor
  6. Vyberte Chci si vybrat jednotlivé události → Zkontrolujte Pull requesty
  7. Klikněte na Přidat webhook

7. Otestujte lokálně pomocí pull requestu

Vytvořte testovací PR:

git checkout -b test-review
echo "console.log('test');" > test.js
git add test.js
git commit -m "Add test file"
git push origin test-review

Otevřete PR na GitHubu. Bot by měl do několika sekund přidat komentář s revizí.

8. Nasaďte do produkce

Nasaďte svůj Worker:

npx wrangler deploy

Poté nastavte své produkční secrets:

# GitHub token (needs repo permissions)
npx wrangler secret put GITHUB_TOKEN

# Anthropic API key
npx wrangler secret put ANTHROPIC_API_KEY

# Webhook secret (use the same value from .dev.vars)
npx wrangler secret put WEBHOOK_SECRET

9. Aktualizujte webhook pro produkci

  1. Přejděte do svého repozitáře Nastavení > Webhooks
  2. Klikněte na svůj existující webhook
  3. Aktualizujte URL adresa payloadu na URL adresu nasazeného Workeru: https://code-review-bot.YOUR_SUBDOMAIN.workers.dev/webhook
  4. Klikněte na Aktualizace webhooku

Váš bot nyní běží v produkci a bude automaticky kontrolovat všechny nové pull requesty.

Co jste vytvořili

GitHub bot pro revizi kódu, který:

Další kroky