webhookイベントをgithub app(開発環境)で扱えるように実装 (#556)

* Update dependencies and enhance webhook event handling

* Add comments for future implementation of runner creation in webhook handling

* Refactor webhook event handling to correctly respond to queued actions and ignore others

* Update test description for non-workflow_job event response

Author: mafreud

openci-runner/package-lock.json

@@ -1,13 +1,14 @@
 {
 	"dependencies": {
-		"@octokit/webhooks-methods": "^6.0.0"
+		"@octokit/webhooks-methods": "^6.0.0",
+		"@octokit/webhooks-types": "^7.6.1"
 	},
 	"devDependencies": {
 		"@cloudflare/vitest-pool-workers": "^0.8.19",
 		"@vitest/coverage-istanbul": "^3.2.4",
 		"typescript": "^5.5.2",
 		"vitest": "3.2.4",
-		"wrangler": "^4.45.2"
+		"wrangler": "^4.45.3"
 	},
 	"name": "openci-runner",
 	"private": true,

openci-runner/package.json

@@ -1,4 +1,5 @@
 import { verify } from "@octokit/webhooks-methods";
+import type { WebhookEvent } from "@octokit/webhooks-types";
 
 export default {
 	async fetch(request, env, _): Promise<Response> {
@@ -18,6 +19,28 @@ export default {
 			return new Response("Unauthorized", { status: 401 });
 		}
 
-		return new Response("Successfully created OpenCI runner", { status: 201 });
+		const payload: WebhookEvent = JSON.parse(body);
+
+		if ("workflow_job" in payload) {
+			switch (payload.action) {
+				case WorkflowJobAction.Queued:
+					return new Response("Successfully created OpenCI runner", {
+						status: 201,
+					});
+				default:
+					return new Response(
+						"Workflow Job but status is not queued. Ignore this event",
+						{
+							status: 200,
+						},
+					);
+			}
+		}
+
+		return new Response("Event ignored", { status: 200 });
 	},
 } satisfies ExportedHandler<Env>;
+
+const WorkflowJobAction = {
+	Queued: "queued",
+} as const;

openci-runner/src/index.ts

@@ -20,7 +20,7 @@ describe("ensure secrets", () => {
 });
 
 describe("fetch", () => {
-	it("responds with 201 when signature is valid", async () => {
+	it("responds with 200 for non-workflow_job events", async () => {
 		const webhookSecret = env.GH_APP_WEBHOOK_SECRET;
 		const body = JSON.stringify({ action: "ping" });
 		const signature = createSignature(body, webhookSecret);
@@ -35,9 +35,9 @@ describe("fetch", () => {
 		const ctx = createExecutionContext();
 		const response = await worker.fetch(request, env, ctx);
 		await waitOnExecutionContext(ctx);
-		expect(response.status).toBe(201);
+		expect(response.status).toBe(200);
 		await expect(response.text()).resolves.toMatchInlineSnapshot(
-			`"Successfully created OpenCI runner"`,
+			`"Event ignored"`,
 		);
 	});
 
@@ -96,4 +96,46 @@ describe("fetch", () => {
 			"Webhook secret not configured",
 		);
 	});
+
+	it("return 201 when new runner is created", async () => {
+		const webhookSecret = env.GH_APP_WEBHOOK_SECRET;
+		const body = JSON.stringify({ action: "queued", workflow_job: {} });
+		const signature = createSignature(body, webhookSecret);
+		const request = new IncomingRequest("http://example.com", {
+			body,
+			headers: {
+				"content-type": "application/json",
+				"x-hub-signature-256": signature,
+			},
+			method: "POST",
+		});
+		const ctx = createExecutionContext();
+		const response = await worker.fetch(request, env, ctx);
+		await waitOnExecutionContext(ctx);
+		expect(response.status).toBe(201);
+		await expect(response.text()).resolves.toMatchInlineSnapshot(
+			`"Successfully created OpenCI runner"`,
+		);
+	});
+
+	it("nothing to be processed", async () => {
+		const webhookSecret = env.GH_APP_WEBHOOK_SECRET;
+		const body = JSON.stringify({ action: "ping", workflow_job: {} });
+		const signature = createSignature(body, webhookSecret);
+		const request = new IncomingRequest("http://example.com", {
+			body,
+			headers: {
+				"content-type": "application/json",
+				"x-hub-signature-256": signature,
+			},
+			method: "POST",
+		});
+		const ctx = createExecutionContext();
+		const response = await worker.fetch(request, env, ctx);
+		await waitOnExecutionContext(ctx);
+		expect(response.status).toBe(200);
+		await expect(response.text()).resolves.toMatchInlineSnapshot(
+			`"Workflow Job but status is not queued. Ignore this event"`,
+		);
+	});
 });

openci-runner/test/index.spec.ts

@@ -1,5 +1,6 @@
 {
 	"compilerOptions": {
+		"strictNullChecks": true,
 		"types": ["@cloudflare/vitest-pool-workers"]
 	},
 	"exclude": [],