Skip to content

Commit 9223e8a

Browse files
fix(prs): validate every stack layer before remote updates
1 parent 9281a6a commit 9223e8a

10 files changed

Lines changed: 204 additions & 29 deletions

File tree

‎apps/server/src/pullRequest/GitHubPullRequestCli.ts‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@ import * as Schema from "effect/Schema";
77
import {
88
resolvePullRequestAuthorFilter,
99
type PullRequestAction,
10+
type PullRequestStackHead,
1011
type PullRequestActor,
1112
type PullRequestInvolvement,
1213
type PullRequestListFilters,
@@ -631,7 +632,7 @@ export class GitHubPullRequestCli extends Context.Service<
631632
readonly number: number;
632633
readonly action: PullRequestAction;
633634
readonly stackNumber?: number;
634-
readonly expectedHeadSha?: string;
635+
readonly expectedStackHeads?: ReadonlyArray<PullRequestStackHead>;
635636
readonly mergeMethod?: PullRequestMergeMethod;
636637
readonly updateMethod?: PullRequestUpdateMethod;
637638
}) => Effect.Effect<void, GitHubPullRequestCliError>;

‎apps/server/src/pullRequest/GitHubPullRequestProvider.ts‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -561,9 +561,9 @@ export const make = Effect.gen(function* () {
561561
number: input.number,
562562
action: input.action,
563563
...(input.stackNumber === undefined ? {} : { stackNumber: input.stackNumber }),
564-
...(input.expectedHeadSha === undefined
564+
...(input.expectedStackHeads === undefined
565565
? {}
566-
: { expectedHeadSha: input.expectedHeadSha }),
566+
: { expectedStackHeads: input.expectedStackHeads }),
567567
...(input.mergeMethod === undefined ? {} : { mergeMethod: input.mergeMethod }),
568568
...(input.updateMethod === undefined ? {} : { updateMethod: input.updateMethod }),
569569
})

‎apps/server/src/pullRequest/PullRequestProvider.ts‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@ import * as Schema from "effect/Schema";
33
import type {
44
PullRequestStackMembership,
55
PullRequestAction,
6+
PullRequestStackHead,
67
PullRequestActor,
78
PullRequestBaseComparison,
89
PullRequestCapabilities,
@@ -432,7 +433,7 @@ export interface PullRequestProviderApi {
432433
readonly number: number;
433434
readonly action: PullRequestAction;
434435
readonly stackNumber?: number;
435-
readonly expectedHeadSha?: string;
436+
readonly expectedStackHeads?: ReadonlyArray<PullRequestStackHead>;
436437
/** Meaningful for `merge` and `enable-auto-merge`; absent takes the host's own default. */
437438
readonly mergeMethod?: PullRequestMergeMethod;
438439
/** Only meaningful for `update-branch`; absent takes the host's own default. */

‎apps/server/src/pullRequest/PullRequestService.test.ts‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3975,7 +3975,7 @@ it.effect("authorizes stack rebases independently of whether the selected layer
39753975
action: "update-branch" as const,
39763976
updateMethod: "rebase" as const,
39773977
stackNumber: 50,
3978-
expectedHeadSha: "ccc",
3978+
expectedStackHeads: [{ number: 3, headSha: "ccc" }],
39793979
};
39803980
yield* service.runAction(input);
39813981
assert.strictEqual(taken, 1);

‎apps/server/src/pullRequest/PullRequestService.ts‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1521,7 +1521,7 @@ export const make = Effect.gen(function* () {
15211521
input.stackNumber !== undefined &&
15221522
(project.api.capabilities.stackActions !== true ||
15231523
!["merge", "update-branch"].includes(input.action) ||
1524-
input.expectedHeadSha === undefined ||
1524+
input.expectedStackHeads === undefined ||
15251525
(input.action === "update-branch" && input.updateMethod !== "rebase"))
15261526
) {
15271527
return Effect.fail(
@@ -1604,9 +1604,9 @@ export const make = Effect.gen(function* () {
16041604
number: input.number,
16051605
action: input.action,
16061606
...(input.stackNumber === undefined ? {} : { stackNumber: input.stackNumber }),
1607-
...(input.expectedHeadSha === undefined
1607+
...(input.expectedStackHeads === undefined
16081608
? {}
1609-
: { expectedHeadSha: input.expectedHeadSha }),
1609+
: { expectedStackHeads: input.expectedStackHeads }),
16101610
...(input.mergeMethod === undefined ? {} : { mergeMethod: input.mergeMethod }),
16111611
...(input.updateMethod === undefined ? {} : { updateMethod: input.updateMethod }),
16121612
})

‎apps/server/src/pullRequest/githubStackActions.test.ts‎

Lines changed: 82 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -36,9 +36,21 @@ const input = {
3636
host: "github.com",
3737
number: 3,
3838
stackNumber: 50,
39-
expectedHeadSha: "ccc",
39+
expectedStackHeads: [
40+
{ number: 2, headSha: "bbb" },
41+
{ number: 3, headSha: "ccc" },
42+
],
4043
action: "merge" as const,
4144
};
45+
const access = {
46+
data: {
47+
repository: {
48+
pr2: { headRepository: { viewerPermission: "WRITE" }, maintainerCanModify: false },
49+
pr3: { headRepository: { viewerPermission: "WRITE" }, maintainerCanModify: false },
50+
},
51+
},
52+
};
53+
4254
function fake(responses: readonly unknown[]) {
4355
const calls: ReadonlyArray<string>[] = [];
4456
const execute: GitHubCli.GitHubCli["Service"]["execute"] = (request) =>
@@ -94,7 +106,10 @@ it.effect("refuses a changed stack before performing any mutation", () =>
94106
const api = fake([stack]);
95107
const result = yield* runGitHubStackAction(api.execute, {
96108
...input,
97-
expectedHeadSha: "old",
109+
expectedStackHeads: [
110+
{ number: 2, headSha: "old" },
111+
{ number: 3, headSha: "ccc" },
112+
],
98113
}).pipe(Effect.result);
99114
expect(result).toMatchObject({ _tag: "Failure", failure: { reason: "changed" } });
100115
expect(api.calls).toHaveLength(1);
@@ -103,9 +118,9 @@ it.effect("refuses a changed stack before performing any mutation", () =>
103118

104119
it.effect("rebases unmerged layers bottom to top without local git commands", () =>
105120
Effect.gen(function* () {
106-
const api = fake([stack, {}, {}]);
121+
const api = fake([stack, access, {}, {}]);
107122
yield* runGitHubStackAction(api.execute, { ...input, action: "update-branch" });
108-
expect(api.calls.slice(1)).toEqual([
123+
expect(api.calls.slice(2)).toEqual([
109124
["pr", "update-branch", "2", "--repo", "github.com/acme/web", "--rebase"],
110125
["pr", "update-branch", "3", "--repo", "github.com/acme/web", "--rebase"],
111126
]);
@@ -114,7 +129,7 @@ it.effect("rebases unmerged layers bottom to top without local git commands", ()
114129

115130
it.effect("does not update later layers after a rebase failure", () =>
116131
Effect.gen(function* () {
117-
const api = fake([stack]);
132+
const api = fake([stack, access]);
118133
const execute: typeof api.execute = (request) =>
119134
request.args[0] === "api"
120135
? api.execute(request)
@@ -134,3 +149,65 @@ it.effect("does not update later layers after a rebase failure", () =>
134149
});
135150
}),
136151
);
152+
153+
it.effect("refuses the entire rebase before mutation when a later fork denies write access", () =>
154+
Effect.gen(function* () {
155+
const api = fake([
156+
stack,
157+
{
158+
data: {
159+
repository: {
160+
...access.data.repository,
161+
pr3: { headRepository: { viewerPermission: "READ" }, maintainerCanModify: false },
162+
},
163+
},
164+
},
165+
]);
166+
const result = yield* runGitHubStackAction(api.execute, {
167+
...input,
168+
action: "update-branch",
169+
}).pipe(Effect.result);
170+
expect(result).toMatchObject({ _tag: "Failure", failure: { reason: "permission" } });
171+
expect(api.calls).toHaveLength(2);
172+
expect(api.calls.every((args) => args[0] === "api")).toBe(true);
173+
}),
174+
);
175+
176+
it.effect("allows a fork that explicitly permits maintainer updates", () =>
177+
Effect.gen(function* () {
178+
const api = fake([
179+
stack,
180+
{
181+
data: {
182+
repository: {
183+
...access.data.repository,
184+
pr3: { headRepository: { viewerPermission: "READ" }, maintainerCanModify: true },
185+
},
186+
},
187+
},
188+
{},
189+
{},
190+
]);
191+
yield* runGitHubStackAction(api.execute, { ...input, action: "update-branch" });
192+
expect(api.calls.at(-1)).toContain("3");
193+
}),
194+
);
195+
196+
it.effect("bounds polling and reports a still-running merge without claiming success", () =>
197+
Effect.gen(function* () {
198+
const api = fake([
199+
stack,
200+
...Array.from({ length: 40 }, () => ({ status: "pending", details: { uuid: "operation" } })),
201+
]);
202+
const fiber = yield* runGitHubStackAction(api.execute, input).pipe(
203+
Effect.result,
204+
Effect.forkChild,
205+
);
206+
yield* TestClock.adjust("6 minutes");
207+
expect(yield* Fiber.join(fiber)).toMatchObject({
208+
_tag: "Failure",
209+
failure: { reason: "pending" },
210+
});
211+
expect(api.calls.length).toBeLessThan(40);
212+
}),
213+
);

‎apps/server/src/pullRequest/githubStackActions.ts‎

Lines changed: 91 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,10 @@
1-
import type { PullRequestAction, PullRequestMergeMethod } from "@t3tools/contracts";
1+
import type {
2+
PullRequestAction,
3+
PullRequestMergeMethod,
4+
PullRequestStackHead,
5+
} from "@t3tools/contracts";
26
import * as Effect from "effect/Effect";
7+
import * as Clock from "effect/Clock";
38
import * as Result from "effect/Result";
49
import * as Schema from "effect/Schema";
510

@@ -17,6 +22,7 @@ export class GitHubStackActionError extends Schema.TaggedError<GitHubStackAction
1722
"rejected",
1823
"pending",
1924
"rebase-failed",
25+
"permission",
2026
]),
2127
completed: Schema.Int,
2228
cause: Schema.optional(Schema.Defect()),
@@ -34,6 +40,8 @@ export class GitHubStackActionError extends Schema.TaggedError<GitHubStackAction
3440
return "GitHub refused the stack merge. Check the stack's branch rules and merge requirements.";
3541
case "pending":
3642
return "The merge is still running on GitHub. Check its status there before submitting another request.";
43+
case "permission":
44+
return "You cannot update every branch in this stack. Check write access and fork maintainer permissions before retrying.";
3745
case "rebase-failed":
3846
return `Stack rebase stopped at PR #${this.number} after ${this.completed} layers. Earlier updates remain on GitHub; resolve the failing layer before retrying.`;
3947
}
@@ -51,6 +59,28 @@ const MergeResponse = Schema.Struct({
5159
}),
5260
});
5361

62+
const decodeBranchAccess = Schema.decodeEffect(
63+
Schema.fromJsonString(
64+
Schema.Struct({
65+
data: Schema.Struct({
66+
repository: Schema.NullOr(
67+
Schema.Record(
68+
Schema.String,
69+
Schema.NullOr(
70+
Schema.Struct({
71+
headRepository: Schema.NullOr(
72+
Schema.Struct({ viewerPermission: Schema.NullOr(Schema.String) }),
73+
),
74+
maintainerCanModify: Schema.Boolean,
75+
}),
76+
),
77+
),
78+
),
79+
}),
80+
}),
81+
),
82+
);
83+
5484
const decodeMergeResponse = Schema.decodeEffect(Schema.fromJsonString(MergeResponse));
5585

5686
/** Remote-only updates: a stack rebase never switches or rewrites the environment's checkout. */
@@ -62,7 +92,7 @@ export const runGitHubStackAction = Effect.fn("runGitHubStackAction")(function*
6292
host: string;
6393
number: number;
6494
stackNumber: number;
65-
expectedHeadSha?: string;
95+
expectedStackHeads?: ReadonlyArray<PullRequestStackHead>;
6696
action: PullRequestAction;
6797
mergeMethod?: PullRequestMergeMethod;
6898
},
@@ -85,18 +115,64 @@ export const runGitHubStackAction = Effect.fn("runGitHubStackAction")(function*
85115
if (Result.isFailure(decoded)) return yield* fail("invalid-response", decoded.failure);
86116
const stack = decoded.success;
87117
const top = stack?.layers.at(-1);
118+
if (stack?.number !== input.stackNumber || top?.number !== input.number) {
119+
return yield* fail("changed");
120+
}
121+
const open = stack.layers.filter((layer) => layer.state !== "merged");
88122
if (
89-
stack?.number !== input.stackNumber ||
90-
top?.number !== input.number ||
91-
!input.expectedHeadSha ||
92-
top.headSha !== input.expectedHeadSha
123+
!input.expectedStackHeads ||
124+
input.expectedStackHeads.length !== open.length ||
125+
new Set(input.expectedStackHeads.map((layer) => layer.number)).size !== open.length ||
126+
open.some(
127+
(layer) =>
128+
!layer.headSha ||
129+
!input.expectedStackHeads?.some(
130+
(expected) => expected.number === layer.number && expected.headSha === layer.headSha,
131+
),
132+
)
93133
) {
94134
return yield* fail("changed");
95135
}
96-
const open = stack.layers.filter((layer) => layer.state !== "merged");
97136
if (open.length === 0 || open.some((layer) => layer.state !== "open"))
98137
return yield* fail("unsupported");
99138
if (input.action === "update-branch") {
139+
const [owner, name] = input.repository.split("/");
140+
const permissions = yield* execute({
141+
cwd: input.cwd,
142+
args: [
143+
"api",
144+
"--hostname",
145+
input.host,
146+
"graphql",
147+
"-f",
148+
`owner=${owner}`,
149+
"-f",
150+
`name=${name}`,
151+
"-f",
152+
`query=query($owner:String!,$name:String!){repository(owner:$owner,name:$name){${open
153+
.map(
154+
(layer) =>
155+
`pr${layer.number}:pullRequest(number:${layer.number}){headRepository{viewerPermission} maintainerCanModify}`,
156+
)
157+
.join(" ")}}}`,
158+
],
159+
});
160+
const access = yield* decodeBranchAccess(permissions.stdout).pipe(
161+
Effect.mapError((cause) => fail("invalid-response", cause)),
162+
);
163+
// viewerCanUpdateBranch is false for an already-current layer, even if rebasing its parent
164+
// will make it stale. Check branch write access separately before touching any layer.
165+
if (
166+
open.some((layer) => {
167+
const pr = access.data.repository?.[`pr${layer.number}`];
168+
return (
169+
!pr?.headRepository ||
170+
(!pr.maintainerCanModify &&
171+
!["ADMIN", "MAINTAIN", "WRITE"].includes(pr.headRepository.viewerPermission ?? ""))
172+
);
173+
})
174+
)
175+
return yield* fail("permission");
100176
for (const [index, layer] of open.entries()) {
101177
yield* execute({
102178
cwd: input.cwd,
@@ -139,14 +215,19 @@ export const runGitHubStackAction = Effect.fn("runGitHubStackAction")(function*
139215
"-f",
140216
"merge_action=default",
141217
"-f",
142-
`sha=${input.expectedHeadSha}`,
218+
`sha=${top.headSha}`,
143219
],
144220
});
145221
let result = yield* decode(request.stdout);
146-
for (let attempt = 0; result.status === "pending" && attempt < 120; attempt++) {
222+
const deadline = (yield* Clock.currentTimeMillis) + 5 * 60_000;
223+
for (
224+
let attempt = 0;
225+
result.status === "pending" && (yield* Clock.currentTimeMillis) < deadline;
226+
attempt++
227+
) {
147228
const uuid = result.details.uuid;
148229
if (!uuid) return yield* fail("invalid-response");
149-
yield* Effect.sleep("1 second");
230+
yield* Effect.sleep(Math.min(1_000 * 2 ** attempt, 10_000));
150231
const poll = yield* execute({
151232
cwd: input.cwd,
152233
args: [

‎apps/web/src/components/pullRequest/PullRequestRow.tsx‎

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -124,7 +124,12 @@ function PullRequestRowImpl({
124124
}
125125
>
126126
<LayersIcon aria-hidden className="size-3" />
127-
{entry.stack.position}/{entry.stack.size}
127+
<span aria-hidden>
128+
{entry.stack.position}/{entry.stack.size}
129+
</span>
130+
<span className="sr-only">
131+
Stack layer {entry.stack.position} of {entry.stack.size}
132+
</span>
128133
</TooltipTrigger>
129134
<TooltipPopup>
130135
Stack #{entry.stack.number}, layer {entry.stack.position} of {entry.stack.size},

0 commit comments

Comments
 (0)