fix: replace domain-specific exit handler with generic signal handler registry (#299)
* fix: replace domain-specific exit handler with generic signal handler registry Rewrite exitHandler.ts as a generic, domain-agnostic exit signal module that exports onExitSignal(handler) returning a dispose function. - subprocess.ts now registers via onExitSignal instead of direct process.on(SIGINT/SIGTERM) calls - resolveTokens registers a signal handler that captures tokens by closure, fixing the race condition where the exit handler would read the wrong token after disposal - Remove setupExitHandler and runCleanup — domain cleanup is handled by post.ts + await using Co-authored-by: Cursor <cursoragent@cursor.com> * tweaks * simplify handler installation * extract to util * fix race in dispose * wrap dispose body in try/finally to ensure disposingRef always settles --------- Co-authored-by: Mateusz Burzyński <mateuszburzynski@gmail.com> Co-authored-by: Cursor <cursoragent@cursor.com> Co-authored-by: pullfrog[bot] <226033991+pullfrog[bot]@users.noreply.github.com>
This commit is contained in:
committed by
pullfrog[bot]
parent
70f1c47a28
commit
ee100354da
+22
-106
@@ -1,119 +1,35 @@
|
||||
import { LEAPING_INTO_ACTION_PREFIX } from "../mcp/comment.ts";
|
||||
import type { ToolState } from "../mcp/server.ts";
|
||||
import { buildPullfrogFooter } from "./buildPullfrogFooter.ts";
|
||||
import { log } from "./cli.ts";
|
||||
import { createOctokit, parseRepoContext } from "./github.ts";
|
||||
import { revokeGitHubInstallationToken } from "./token.ts";
|
||||
import os from "node:os";
|
||||
|
||||
type ExitSignalHandler = (signal: "SIGINT" | "SIGTERM") => void | Promise<void>;
|
||||
|
||||
const handlers = new Set<ExitSignalHandler>();
|
||||
let installed = false;
|
||||
|
||||
/**
|
||||
* Build error comment body with error message and footer
|
||||
* Register a handler to run when the process receives SIGINT or SIGTERM.
|
||||
* Returns a dispose function that removes the handler.
|
||||
*/
|
||||
export function buildErrorCommentBody(params: {
|
||||
owner: string;
|
||||
repo: string;
|
||||
runId: string | undefined;
|
||||
isCancellation: boolean;
|
||||
}): string {
|
||||
const workflowRunLink = params.runId
|
||||
? `[workflow run logs](https://github.com/${params.owner}/${params.repo}/actions/runs/${params.runId})`
|
||||
: "workflow run logs";
|
||||
const errorMessage = params.isCancellation
|
||||
? `This run was cancelled 🛑\n\nThe workflow was cancelled before completion. Please check the ${workflowRunLink} for details.`
|
||||
: `This run croaked 😵\n\nThe workflow encountered an error before any progress could be reported. Please check the ${workflowRunLink} for details.`;
|
||||
const footer = buildPullfrogFooter({
|
||||
triggeredBy: true,
|
||||
workflowRun: params.runId
|
||||
? { owner: params.owner, repo: params.repo, runId: params.runId }
|
||||
: undefined,
|
||||
});
|
||||
return `${errorMessage}${footer}`;
|
||||
export function onExitSignal(handler: ExitSignalHandler): () => void {
|
||||
installSignalHandlers();
|
||||
handlers.add(handler);
|
||||
return () => {
|
||||
handlers.delete(handler);
|
||||
};
|
||||
}
|
||||
|
||||
let cleanupFn: ((isCancellation: boolean) => Promise<void>) | undefined;
|
||||
function installSignalHandlers(): void {
|
||||
if (installed) return;
|
||||
installed = true;
|
||||
|
||||
export function setupExitHandler(toolState: ToolState): void {
|
||||
let hasCleanedUp = false;
|
||||
|
||||
async function cleanup(isCancellation: boolean): Promise<void> {
|
||||
if (hasCleanedUp) {
|
||||
return;
|
||||
}
|
||||
hasCleanedUp = true;
|
||||
|
||||
const token = process.env.GITHUB_TOKEN;
|
||||
const commentId = toolState.progressCommentId;
|
||||
const wasUpdated = toolState.wasUpdated === true;
|
||||
|
||||
// update progress comment if it was never updated (still shows "leaping into action")
|
||||
if (token && commentId && !wasUpdated) {
|
||||
try {
|
||||
const repoContext = parseRepoContext();
|
||||
const octokit = createOctokit(token);
|
||||
|
||||
const existingComment = await octokit.rest.issues.getComment({
|
||||
owner: repoContext.owner,
|
||||
repo: repoContext.name,
|
||||
comment_id: commentId,
|
||||
});
|
||||
|
||||
const commentBody = existingComment.data.body || "";
|
||||
|
||||
// only update if comment still shows the initial "leaping into action" message
|
||||
if (commentBody.startsWith(LEAPING_INTO_ACTION_PREFIX)) {
|
||||
const runId = process.env.GITHUB_RUN_ID;
|
||||
|
||||
const body = buildErrorCommentBody({
|
||||
owner: repoContext.owner,
|
||||
repo: repoContext.name,
|
||||
runId,
|
||||
isCancellation,
|
||||
});
|
||||
|
||||
await octokit.rest.issues.updateComment({
|
||||
owner: repoContext.owner,
|
||||
repo: repoContext.name,
|
||||
comment_id: commentId,
|
||||
body,
|
||||
});
|
||||
|
||||
log.info("» updated progress comment with error message");
|
||||
}
|
||||
} catch {
|
||||
// ignore errors during cleanup
|
||||
}
|
||||
}
|
||||
|
||||
// revoke token
|
||||
if (token) {
|
||||
try {
|
||||
await revokeGitHubInstallationToken(token);
|
||||
log.debug("» installation token revoked");
|
||||
} catch {
|
||||
// ignore errors during cleanup
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
// store cleanup function for runCleanup()
|
||||
cleanupFn = cleanup;
|
||||
|
||||
// handle cancellation signals
|
||||
function handleSignal(): void {
|
||||
log.info("» workflow cancelled, cleaning up...");
|
||||
cleanup(true).finally(() => process.exit(1));
|
||||
async function handleSignal(signal: "SIGINT" | "SIGTERM") {
|
||||
await Promise.allSettled([...handlers].map((h) => Promise.try(h, signal)));
|
||||
exitWithSignal(signal);
|
||||
}
|
||||
|
||||
process.on("SIGINT", handleSignal);
|
||||
process.on("SIGTERM", handleSignal);
|
||||
}
|
||||
|
||||
/**
|
||||
* Run cleanup explicitly. Called from entry.ts in finally block.
|
||||
*/
|
||||
export async function runCleanup(): Promise<void> {
|
||||
try {
|
||||
await cleanupFn?.(false);
|
||||
} catch {
|
||||
// ignore errors during cleanup
|
||||
}
|
||||
export function exitWithSignal(signal: "SIGINT" | "SIGTERM") {
|
||||
process.exit(128 + os.constants.signals[signal]);
|
||||
}
|
||||
|
||||
Reference in New Issue
Block a user