Skip to content

fix(github-bot): run automation forwarding independently #1519

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
ColeMurray wants to merge 1 commit into
base: main
Choose a base branch
from
+130 −60
Open

fix(github-bot): run automation forwarding independently #1519

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
122 changes: 62 additions & 60 deletions packages/github-bot/src/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -168,71 +168,73 @@ async function handleWebhook(
};

const start = Date.now();
let result: HandlerResult | undefined;
let dispatchFailure: { error: unknown } | undefined;
const normalizationPayload = actionResult.success ? actionResult.data : {};
const [dispatchResult, forwardingResult] = await Promise.allSettled([

@open-inspect open-inspect Bot Aug 19, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[deep review] This couples dispatch observability to the independent forwarding path. Because Promise.allSettled waits for both operations, webhook.handled is now delayed by a slow forward (or suppressed by a non-settling one), and duration_ms measures max(dispatch, forwarding) rather than built-in dispatch as it did before. There is a simpler code-judo move: start forwardGitHubAutomationEvent(...) and retain its promise before entering the existing try/await dispatchHandler flow, log dispatch as soon as that settles, then await/log forwarding before rethrowing any captured dispatch error. Starting forwarding first also means dispatchHandler does not need to become artificially async; its synchronous schema errors remain caught by the existing try. That preserves the cleanup policy while deleting the two settled-result state machines and retaining accurate telemetry.

dispatchHandler(env, log, event, p, payload, traceId),
forwardGitHubAutomationEvent(env, event, normalizationPayload, traceId),
]);

try {
result = await dispatchHandler(env, log, event, p, payload, traceId);
} catch (err) {
dispatchFailure = { error: err };
log.info("webhook.handled", {
...wideEventBase,
outcome: "error",
duration_ms: Date.now() - start,
error: err instanceof Error ? err : new Error(String(err)),
});
}

if (result !== undefined) {
const wideEvent: Record<string, unknown> = {
...wideEventBase,
outcome: result.outcome,
duration_ms: Date.now() - start,
};
const wideEvent: Record<string, unknown> = {
...wideEventBase,
outcome: dispatchResult.status === "fulfilled" ? dispatchResult.value.outcome : "error",
duration_ms: Date.now() - start,
};
if (dispatchResult.status === "fulfilled") {
const result = dispatchResult.value;
if (result.outcome === "skipped") {
wideEvent.skip_reason = result.skip_reason;
} else {
wideEvent.session_id = result.session_id;
wideEvent.message_id = result.message_id;
wideEvent.handler_action = result.handler_action;
}
log.info("webhook.handled", wideEvent);
} else {
wideEvent.error =
dispatchResult.reason instanceof Error
? dispatchResult.reason
: new Error(String(dispatchResult.reason));
}
log.info("webhook.handled", wideEvent);

// Forwarding and built-in dispatch are independent; both must run before a
// failure reaches the waitUntil cleanup path. Use the passthrough parse so
// nested lifecycle fields are not stripped by the summary schema.
if (event) {
const normalizationPayload = actionResult.success ? actionResult.data : {};
const normalizedEvent = normalizeGitHubEvent(event, normalizationPayload);
if (normalizedEvent !== null) {
try {
const url = "https://internal/internal/github-event";
const body = JSON.stringify(normalizedEvent);
const response = await signedControlPlaneFetch(env, { method: "POST", url, body, traceId });
if (!response.ok) {
log.warn("webhook.github_event_forward_failed", {
trace_id: traceId,
delivery_id: deliveryId,
event_type: event,
status: response.status,
});
}
} catch (err) {
log.warn("webhook.github_event_forward_error", {
trace_id: traceId,
delivery_id: deliveryId,
event_type: event,
error: err instanceof Error ? err : new Error(String(err)),
});
}
}
if (forwardingResult.status === "rejected") {
const err = forwardingResult.reason;
log.warn("webhook.github_event_forward_error", {
trace_id: traceId,
delivery_id: deliveryId,
event_type: event,
error: err instanceof Error ? err : new Error(String(err)),
});
} else if (forwardingResult.value && !forwardingResult.value.ok) {
log.warn("webhook.github_event_forward_failed", {
trace_id: traceId,
delivery_id: deliveryId,
event_type: event,
status: forwardingResult.value.status,
});
}

if (dispatchFailure !== undefined) throw dispatchFailure.error;
if (dispatchResult.status === "rejected") throw dispatchResult.reason;
}

function dispatchHandler(
async function forwardGitHubAutomationEvent(
env: Env,
event: string | undefined,
normalizationPayload: Record<string, unknown>,
traceId: string
): Promise<Response | null> {
if (!event) return null;

// Use the passthrough parse so nested lifecycle fields are not stripped by
// the summary schema used for logging and bot dispatch.
const normalizedEvent = normalizeGitHubEvent(event, normalizationPayload);
if (normalizedEvent === null) return null;

const url = "https://internal/internal/github-event";
const body = JSON.stringify(normalizedEvent);
return signedControlPlaneFetch(env, { method: "POST", url, body, traceId });
}

async function dispatchHandler(
env: Env,
log: Logger,
event: string | undefined,
Expand All @@ -249,42 +251,42 @@ function dispatchHandler(
}
if (p.action === "review_requested") {
if (!isReviewRequestedForBot(payload, env.GITHUB_BOT_USERNAME)) {
return Promise.resolve({ outcome: "skipped", skip_reason: "review_not_for_bot" });
return { outcome: "skipped", skip_reason: "review_not_for_bot" };
}
const parsed = reviewRequestedPayloadSchema.safeParse(payload);
if (!parsed.success) throw new Error("Malformed pull_request review_requested payload");
return handleReviewRequested(env, log, parsed.data, traceId);
}
return Promise.resolve({
return {
outcome: "skipped",
skip_reason: "unsupported_action",
});
};
case "issue_comment":
if (p.action === "created") {
const parsed = issueCommentPayloadSchema.safeParse(payload);
if (!parsed.success) throw new Error("Malformed issue_comment created payload");
return handleIssueComment(env, log, parsed.data, traceId);
}
return Promise.resolve({
return {
outcome: "skipped",
skip_reason: "unsupported_action",
});
};
case "pull_request_review_comment":
if (p.action === "created") {
const parsed = reviewCommentPayloadSchema.safeParse(payload);
if (!parsed.success)
throw new Error("Malformed pull_request_review_comment created payload");
return handleReviewComment(env, log, parsed.data, traceId);
}
return Promise.resolve({
return {
outcome: "skipped",
skip_reason: "unsupported_action",
});
};
default:
return Promise.resolve({
return {
outcome: "skipped",
skip_reason: "unsupported_event",
});
};
}
}

Expand Down
68 changes: 68 additions & 0 deletions packages/github-bot/test/webhook.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -222,6 +222,74 @@ describe("POST /webhooks/github", () => {
expect(githubKv.delete).toHaveBeenCalledTimes(2);
});

it("starts automation forwarding before built-in dispatch settles", async () => {
let resolveConfigFetch!: (response: Response) => void;
const configFetch = new Promise<Response>((resolve) => {
resolveConfigFetch = resolve;
});
const env = makeEnv();
const controlPlaneFetch = vi.fn((input: string | URL | Request) => {
const url = typeof input === "string" ? input : input instanceof URL ? input.href : input.url;
if (url.includes("/integration-settings/github/resolved/")) return configFetch;
return Promise.resolve(new Response(null, { status: 204 }));
});
env.CONTROL_PLANE = { fetch: controlPlaneFetch };

const body = JSON.stringify({
action: "opened",
pull_request: {
number: 42,
title: "Independent automation forwarding",
body: null,
user: { login: "alice" },
head: { ref: "feature/test", sha: "abc123" },
base: { ref: "main" },
draft: false,
},
repository: { owner: { login: "test" }, name: "repo", private: false },
sender: { login: "alice", id: 7, avatar_url: "https://example.com/alice.png" },
});
const signature = await sign(SECRET, body);
const ctx = makeCtx();

const res = await app.fetch(
new Request("http://localhost/webhooks/github", {
method: "POST",
body,
headers: {
"X-Hub-Signature-256": signature,
"X-GitHub-Event": "pull_request",
"X-GitHub-Delivery": "delivery-pending-dispatch",
},
}),
env,
ctx
);

expect(res.status).toBe(200);
try {
await vi.waitFor(() =>
expect(
controlPlaneFetch.mock.calls.some(
([url]) =>
typeof url === "string" &&
url.includes("/integration-settings/github/resolved/test/repo")
)
).toBe(true)
);
await vi.waitFor(() =>
expect(
controlPlaneFetch.mock.calls.some(
([url]) => url === "https://internal/internal/github-event"
)
).toBe(true)
);
} finally {
resolveConfigFetch(new Response(null, { status: 500 }));
await flushWaitUntil(ctx);
}
});

it("returns 200 for unhandled event type", async () => {
const body = '{"action":"opened"}';
const signature = await sign(SECRET, body);
Expand Down
Loading