Composio powers 1000+ toolkits, tool search, context management, authentication, and a sandboxed workbench to help you build AI agents that turn intent into action.

next
ts 221 lines 8.59 KB
Raw
1 import { Effect, Option, Schema, Stream } from 'effect';
2 import {
3 CONTENT_CONCURRENCY,
4 PositiveInt,
5 REPOSITORY_PATH,
6 Sha,
7 fileAt,
8 paginate,
9 paginateArray,
10 request,
11 } from './github';
12 import { PullDetail, isReleasePull, releaseBranch } from './release-pr';
13 import { ensure, fail } from './runtime';
14 import { BATCH_PATH, ReleaseBatch, batchLanguages, channelOf } from './source';
15
16 const WRITE_PERMISSIONS = new Set(['write', 'maintain', 'admin']);
17 const REVIEW_STATES = new Set(['APPROVED', 'CHANGES_REQUESTED', 'DISMISSED']);
18
19 export interface Review {
20 readonly user: string;
21 readonly state: string;
22 readonly commitId: string;
23 readonly permission: string;
24 }
25
26 /**
27 * A writer other than the PR author approved this exact head. A requester must be an admin,
28 * and no writer's latest review may request changes.
29 */
30 export function eligibleApproval(
31 reviews: ReadonlyArray<Review>,
32 author: string,
33 requester: string,
34 head: string
35 ) {
36 const latest = [...new Map(reviews.map(review => [review.user, review])).values()];
37 const writers = latest.filter(review => WRITE_PERMISSIONS.has(review.permission));
38 return (
39 !writers.some(review => review.state === 'CHANGES_REQUESTED') &&
40 writers.some(
41 review =>
42 review.user !== author &&
43 (review.user !== requester || review.permission === 'admin') &&
44 review.state === 'APPROVED' &&
45 review.commitId === head
46 )
47 );
48 }
49
50 const PullReview = Schema.Struct({
51 user: Schema.NullOr(Schema.Struct({ login: Schema.String })),
52 state: Schema.String,
53 commit_id: Sha,
54 });
55 const CollaboratorPermission = Schema.Struct({ permission: Schema.String });
56 const CheckRuns = Schema.Struct({
57 check_runs: Schema.Array(
58 Schema.Struct({
59 id: PositiveInt,
60 name: Schema.String,
61 head_sha: Sha,
62 app: Schema.NullOr(Schema.Struct({ slug: Schema.String })),
63 conclusion: Schema.NullOr(Schema.String),
64 })
65 ),
66 });
67 const HeadCommit = Schema.Struct({
68 author: Schema.NullOr(Schema.Struct({ login: Schema.String })),
69 commit: Schema.Struct({ verification: Schema.Struct({ verified: Schema.Boolean }) }),
70 parents: Schema.Array(Schema.Struct({ sha: Sha })),
71 });
72
73 /** Review decisions with each reviewer's repository permission, looked up once per login. */
74 const reviewsWithPermissions = (number: number) =>
75 Effect.gen(function* () {
76 // A deleted account's review has `user: null`; it can't be a writer, so it is skipped.
77 const decisions = (yield* Stream.runCollect(
78 paginateArray(`${REPOSITORY_PATH}/pulls/${number}/reviews`, PullReview)
79 )).flatMap(({ user, state, commit_id }) =>
80 user !== null && REVIEW_STATES.has(state)
81 ? [{ user: user.login, state, commitId: commit_id }]
82 : []
83 );
84 const logins = [...new Set(decisions.map(review => review.user))];
85 const permissions = new Map(
86 yield* Effect.forEach(
87 logins,
88 login =>
89 Effect.map(
90 request(
91 'GET',
92 `${REPOSITORY_PATH}/collaborators/${encodeURIComponent(login)}/permission`,
93 CollaboratorPermission
94 ),
95 result => [login, result.permission] as const
96 ),
97 { concurrency: CONTENT_CONCURRENCY }
98 )
99 );
100 return decisions.map(
101 review => ({ ...review, permission: permissions.get(review.user) ?? '' }) satisfies Review
102 );
103 });
104
105 /** A release PR into next and the plan committed on its head. */
106 export const readReleasePull = (number: number) =>
107 Effect.gen(function* () {
108 const pull = yield* request('GET', `${REPOSITORY_PATH}/pulls/${number}`, PullDetail);
109 yield* ensure(
110 pull.base.ref === 'next' && isReleasePull(pull),
111 'Expected an SDK release PR into protected next'
112 );
113 const raw = yield* fileAt(BATCH_PATH, pull.head.sha);
114 if (Option.isNone(raw)) return yield* fail('Missing committed release plan');
115 const batch = yield* Schema.decodeUnknownEffect(Schema.fromJsonString(ReleaseBatch))(raw.value);
116 yield* ensure(
117 pull.head.ref === releaseBranch(batch.id),
118 'Release branch and batch do not agree'
119 );
120 return { pull, batch };
121 });
122
123 const ZERO_SHA = '0'.repeat(40);
124 const BranchActivity = Schema.Struct({
125 after: Sha,
126 actor: Schema.NullOr(Schema.Struct({ login: Schema.String })),
127 });
128
129 /**
130 * Whether `sha` is the release App's own verified commit on the planned source, and the App set
131 * the release branch to it last. GitHub commits and signs every API-made commit as `web-flow`,
132 * and any writer can make one that names the App as author, so only the branch's activity log,
133 * newest first, shows who moved it.
134 */
135 export const isReleaseAppCommit = (sha: string, batch: ReleaseBatch, appSlug: string) =>
136 Effect.gen(function* () {
137 const head = yield* request('GET', `${REPOSITORY_PATH}/commits/${sha}`, HeadCommit);
138 const activity = yield* request(
139 'GET',
140 `${REPOSITORY_PATH}/activity?ref=${encodeURIComponent(`refs/heads/${releaseBranch(batch.id)}`)}&direction=desc&per_page=100`,
141 Schema.Array(BranchActivity)
142 );
143 const lastSet = activity.find(entry => entry.after !== ZERO_SHA);
144 return (
145 head.author?.login === `${appSlug}[bot]` &&
146 head.commit.verification.verified &&
147 head.parents.length === 1 &&
148 head.parents[0].sha === batch.inputBase &&
149 lastSet?.after === sha &&
150 lastSet.actor?.login === `${appSlug}[bot]`
151 );
152 });
153
154 export const isReleaseAppHead = (pull: PullDetail, batch: ReleaseBatch, appSlug: string) =>
155 isReleaseAppCommit(pull.head.sha, batch, appSlug);
156
157 const IssueEvent = Schema.Struct({ event: Schema.String, commit_id: Schema.NullOr(Sha) });
158
159 /** The commit a merged PR left on its base. Pull responses no longer carry `merge_commit_sha`. */
160 export const mergeCommitOf = (number: number) =>
161 Effect.gen(function* () {
162 const events = yield* Stream.runCollect(
163 paginateArray(`${REPOSITORY_PATH}/issues/${number}/events`, IssueEvent)
164 );
165 const sha = events.findLast(event => event.event === 'merged')?.commit_id;
166 if (!sha) return yield* fail('The merged release PR has no merge commit');
167 return sha;
168 });
169
170 /**
171 * The request issue named by a release PR's plan, only when the release App committed that plan.
172 * Anyone with write access can push a `sdk-release/batch-*` branch, so its plan cannot pick the
173 * issue the bot comments on, labels and closes.
174 */
175 export const trustedIssue = (pull: PullDetail, batch: ReleaseBatch, appSlug: string) =>
176 Effect.map(isReleaseAppHead(pull, batch, appSlug), trusted =>
177 trusted ? Option.some(batch.issue) : Option.none<number>()
178 );
179
180 /**
181 * The checks a release PR must pass before its head is tagged:
182 * - the head is the release App's own commit on the frozen source, so nobody added changes the
183 * release-only diff check did not see;
184 * - a writer other than the author approved that head; requesters must be repository admins;
185 * - the candidate build and smoke checks passed on it, and the docs check for a stable release.
186 */
187 export const verifyReleaseGate = (pull: PullDetail, batch: ReleaseBatch, appSlug: string) =>
188 Effect.gen(function* () {
189 yield* ensure(
190 yield* isReleaseAppHead(pull, batch, appSlug),
191 'The release PR head must be the release App commit on the planned source; request a new release instead of pushing to its branch'
192 );
193 const reviews = yield* reviewsWithPermissions(pull.number);
194 yield* ensure(
195 eligibleApproval(reviews, pull.user?.login ?? '', batch.requestedBy, pull.head.sha),
196 'Final release head lacks an approval from a writer other than the author; requesters must have repository admin permission'
197 );
198 // A release head that touches every SDK runs more than one page of checks.
199 const checks = yield* Stream.runCollect(
200 paginate(
201 `${REPOSITORY_PATH}/commits/${pull.head.sha}/check-runs`,
202 CheckRuns,
203 body => body.check_runs
204 )
205 );
206 // A re-run adds a newer check run under the same name; only the newest one counts.
207 const latest = new Map<string, (typeof checks)[number]>();
208 for (const check of checks)
209 if (
210 check.head_sha === pull.head.sha &&
211 check.app?.slug === 'github-actions' &&
212 check.id > (latest.get(check.name)?.id ?? 0)
213 )
214 latest.set(check.name, check);
215 const passed = (name: string) => latest.get(name)?.conclusion === 'success';
216 for (const language of batchLanguages(batch))
217 for (const check of [`SDK candidate (${language})`, `SDK candidate smoke (${language})`])
218 yield* ensure(passed(check), `Missing green final-head check: ${check}`);
219 for (const check of channelOf(batch).extraChecks)
220 yield* ensure(passed(check), `Missing green final-head check: ${check}`);
221 });