refactor: replace narrow parameter types with context objects (#519)

* refactor: replace narrow parameter types with context objects across action/

pass broader context objects (ToolContext, PromptContext, PostCleanupContext) to
utility functions instead of cherry-picking fields into single-use interfaces.
deletes 8 narrow types, simplifies call sites, and makes buildCommentFooter
synchronous by reading ctx.runId/ctx.jobId directly instead of re-deriving
from env vars and making an extra API call.

Made-with: Cursor

* fix: replace non-null assertion with local guard in validatePushDestination

addresses review feedback — the function now validates pushUrl itself instead
of relying on the caller's check, eliminating the ! assertion.

Made-with: Cursor

* revert: remove GH_TOKEN injection from restricted shell

the original change exposed the git token in restricted-mode shell so
`gh` CLI would work. this is a security regression for public repos: MCP
tools are deliberately constrained (no merge, no release, no arbitrary
API calls), but `gh api` with the token gives full GitHub API access to
any prompt-injected agent.

Made-with: Cursor
This commit is contained in:
Colin McDonnell
2026-04-04 20:51:49 +00:00
committed by pullfrog[bot]
parent ab76a4ad04
commit 2ea447a780
9 changed files with 5652 additions and 5829 deletions
+40 -57
View File
@@ -8,65 +8,61 @@ import { getJobToken } from "./token.ts";
type JsonPromptInput = Extract<ResolvedPromptInput, object>; // not string
interface PostCleanupContext {
repoContext: ReturnType<typeof parseRepoContext>;
octokit: ReturnType<typeof createOctokit>;
runId: number | undefined;
promptInput: JsonPromptInput | null;
}
// controls whether the script should check the reason for the workflow termination.
// it can be either canceled or failed.
// YAML file cannot supply it (not in ENV), so an extra request is required to check it.
const SHOULD_CHECK_REASON = true;
type BuildErrorCommentBodyParams = {
owner: string;
repo: string;
runId: number | undefined;
isCancellation: boolean;
};
function buildErrorCommentBody(params: BuildErrorCommentBodyParams): string {
let errorMessage = params.isCancellation
function buildErrorCommentBody(ctx: PostCleanupContext, isCancellation: boolean): string {
let errorMessage = isCancellation
? `This run was cancelled 🛑\n\nThe workflow was cancelled before completion.`
: `This run croaked 😵\n\nThe workflow encountered an error before any progress could be reported.`;
if (params.runId) {
if (ctx.runId) {
errorMessage += " Please check the link below for details.";
}
const customParts: string[] = [];
if (!params.isCancellation && params.runId) {
if (!isCancellation && ctx.runId) {
const apiUrl = getApiUrl();
customParts.push(
`[Rerun failed job ➔](${apiUrl}/trigger/${params.owner}/${params.repo}/${params.runId}?action=rerun)`
`[Rerun failed job ➔](${apiUrl}/trigger/${ctx.repoContext.owner}/${ctx.repoContext.name}/${ctx.runId}?action=rerun)`
);
}
const footer = buildPullfrogFooter({
triggeredBy: true,
workflowRun: params.runId
? { owner: params.owner, repo: params.repo, runId: params.runId }
workflowRun: ctx.runId
? {
owner: ctx.repoContext.owner,
repo: ctx.repoContext.name,
runId: ctx.runId,
}
: undefined,
customParts,
});
return `${errorMessage}${footer}`;
}
type ValidateStuckCommentParams = {
promptInput: JsonPromptInput | null;
octokit: ReturnType<typeof createOctokit>;
owner: string;
repo: string;
};
async function validateStuckProgressComment(
params: ValidateStuckCommentParams
): Promise<number | null> {
if (!params.promptInput?.progressCommentId) {
async function validateStuckProgressComment(ctx: PostCleanupContext): Promise<number | null> {
if (!ctx.promptInput?.progressCommentId) {
log.info("[post] no progressCommentId in prompt input, skipping cleanup");
return null;
}
const commentId = parseInt(params.promptInput.progressCommentId, 10);
const commentId = parseInt(ctx.promptInput.progressCommentId, 10);
log.info(`[post] validating progressCommentId from prompt input: ${commentId}`);
try {
const commentResult = await params.octokit.rest.issues.getComment({
owner: params.owner,
repo: params.repo,
const commentResult = await ctx.octokit.rest.issues.getComment({
owner: ctx.repoContext.owner,
repo: ctx.repoContext.name,
comment_id: commentId,
});
@@ -93,19 +89,13 @@ async function validateStuckProgressComment(
}
}
type GetIsCancelledParams = {
repoContext: ReturnType<typeof parseRepoContext>;
octokit: ReturnType<typeof createOctokit>;
runId: number | undefined;
};
async function getIsCancelled(params: GetIsCancelledParams): Promise<boolean> {
if (!params.runId) return false; // can't check without a run ID — assume failure
async function getIsCancelled(ctx: PostCleanupContext): Promise<boolean> {
if (!ctx.runId) return false; // can't check without a run ID — assume failure
try {
const jobsResult = await params.octokit.rest.actions.listJobsForWorkflowRun({
owner: params.repoContext.owner,
repo: params.repoContext.name,
run_id: params.runId,
const jobsResult = await ctx.octokit.rest.actions.listJobsForWorkflowRun({
owner: ctx.repoContext.owner,
repo: ctx.repoContext.name,
run_id: ctx.runId,
});
// find current job by matching GITHUB_JOB env var.
@@ -166,30 +156,23 @@ export async function runPostCleanup(): Promise<void> {
const repoContext = parseRepoContext();
const octokit = createOctokit(token);
const commentId = await validateStuckProgressComment({
promptInput,
octokit,
owner: repoContext.owner,
repo: repoContext.name,
});
const ctx: PostCleanupContext = { repoContext, octokit, runId, promptInput };
const commentId = await validateStuckProgressComment(ctx);
if (!commentId) return log.info("» [post] no stuck progress comment to update, skipping cleanup");
log.info(`» [post] validated stuck comment: ${commentId}, updating with error message`);
try {
const body = buildErrorCommentBody({
owner: repoContext.owner,
repo: repoContext.name,
runId,
isCancellation: SHOULD_CHECK_REASON
? await getIsCancelled({ octokit, repoContext, runId })
: false,
});
const body = buildErrorCommentBody(
ctx,
SHOULD_CHECK_REASON ? await getIsCancelled(ctx) : false
);
await octokit.rest.issues.updateComment({
owner: repoContext.owner,
repo: repoContext.name,
await ctx.octokit.rest.issues.updateComment({
owner: ctx.repoContext.owner,
repo: ctx.repoContext.name,
comment_id: commentId,
body,
});