@devries-cameron20 / t3code-1 / commits / 1a12c4afae
Fork 0

The best way to control Claude Code, Codex and more from any computer or phone

fix(azure-devops): pull requests report build validation as checks (#31146)

Co-authored-by: maria-rcks <maria@kuuro.net> Co-authored-by: Julius Marminge <julius0216@outlook.com>

Pavel Kroupa committed Nov 14, 2026 at 03:50 UTC 1a12c4afae998925b4a29417f2dc436c0ccd0969
10 files changed +544 -24
apps/server/src/pullRequest/PullRequestService.test.ts
+50 -7
@@ -3568,19 +3568,31 @@ it.effect("deduplicates routed PR reports without dropping draft changes", () =>
3568 }),
3569 );
3570
3571 -it.effect(
3572 - "reuses fresh detail checks without extending their refresh interval on detail cache hits",
3573 - () =>
3571 +it.effect.each(["github", "azure-devops"])(
3572 + "reuses fresh %s detail checks without extending their refresh interval on detail cache hits",
3573 + (provider) =>
3574 Effect.gen(function* () {
3575 let reads = 0;
3576 - const reference = { projectId: "p1" as ProjectId, repository: "acme/web", number: 1 };
3576 + const repository = provider === "azure-devops" ? "web" : "acme/web";
3577 + const reference = { projectId: "p1" as ProjectId, repository, number: 1 };
3578 const service = yield* makeService({
3579 projects: [
3579 - project({ id: "p1", title: "web", workspaceRoot: "/a", repository: "acme/web" }),
3580 + project({
3581 + id: "p1",
3582 + title: "web",
3583 + workspaceRoot: "/a",
3584 + repository,
3585 + provider,
3586 + ...(provider === "azure-devops" ? { host: "dev.azure.com" } : {}),
3587 + }),
3588 ],
3589 providers: [
3582 - fakePullRequestProvider(SourceControlProviderKind.make("github"), {
3583 - getChangeRequest: () => Effect.succeed(hostedChangeRequest("Description")),
3590 + fakePullRequestProvider(SourceControlProviderKind.make(provider), {
3591 + getChangeRequest: () =>
3592 + Effect.succeed({
3593 + ...hostedChangeRequest("Description"),
3594 + checks: [{ name: "build", status: "success", description: null, url: null }],
3595 + }),
3596 getChangeRequestChecks: () =>
3597 Effect.sync(() => {
3598 reads += 1;
@@ -3610,6 +3622,37 @@ it.effect(
3622 }),
3623 );
3624
3625 +it.effect("asks Azure for checks when its detail came back with none", () =>
3626 + Effect.gen(function* () {
3627 + let reads = 0;
3628 + const reference = { projectId: "p1" as ProjectId, repository: "web", number: 1 };
3629 + const service = yield* makeService({
3630 + projects: [
3631 + project({
3632 + id: "p1",
3633 + title: "web",
3634 + workspaceRoot: "/a",
3635 + repository: "web",
3636 + provider: "azure-devops",
3637 + }),
3638 + ],
3639 + providers: [
3640 + fakePullRequestProvider(SourceControlProviderKind.make("azure-devops"), {
3641 + getChangeRequest: () => Effect.succeed(hostedChangeRequest("Description")),
3642 + getChangeRequestChecks: () =>
3643 + Effect.sync(() => {
3644 + reads += 1;
3645 + return { state: "open" as const, checks: [] };
3646 + }),
3647 + }),
3648 + ],
3649 + });
3650 + yield* service.detail(reference);
3651 + yield* service.checks(reference);
3652 + expect(reads).toBe(1);
3653 + }),
3654 +);
3655 +
3656 it.effect("preserves check observation time on cache hits and advances it on refresh", () =>
3657 Effect.gen(function* () {
3658 let reads = 0;
apps/server/src/pullRequest/PullRequestService.ts
+4 -2
@@ -3256,9 +3256,11 @@ export const make = Effect.gen(function* () {
3256 return detailUncached(refOfCacheKey(key)).pipe(
3257 Effect.tap(
3258 Effect.fn("PullRequestService.recordDetailStats")(function* (value: PullRequestDetail) {
3259 - // GitHub detail includes the same checks; the checks TTL counts from their observation.
3259 + // GitHub and Azure detail include the same checks; the checks TTL counts from their observation.
3260 + // Azure detail answers a failed policy read with no checks, which must not be cached.
3261 if (
3261 - value.provider === "github" &&
3262 + (value.provider === "github" ||
3263 + (value.provider === "azure-devops" && value.checks.length > 0)) &&
3264 value.observedAt !== undefined &&
3265 !(yield* Cache.has(checksCache, key))
3266 ) {
packages/source-control-azure-devops/src/server/AzureDevOpsPullRequestCli.test.ts
+56 -2
@@ -188,7 +188,8 @@ layer("AzureDevOpsPullRequestCli.layer", (it) => {
188 ),
189 ),
190 )
191 - .mockReturnValueOnce(Effect.succeed(output(json({ changeEntries: [] }))));
191 + .mockReturnValueOnce(Effect.succeed(output(json({ changeEntries: [] }))))
192 + .mockReturnValueOnce(Effect.succeed(output("[]")));
193 const provider = yield* AzureDevOpsPullRequestProvider.make;
194 const detail = yield* provider.getChangeRequest({
195 cwd: "/w",
@@ -199,7 +200,7 @@ layer("AzureDevOpsPullRequestCli.layer", (it) => {
200
201 expect(detail.headSha).toBe(latestHead);
202 expect(argsOfCall(2)).toContain("iterationId=2");
202 - expect(mockedExecute).toHaveBeenCalledTimes(3);
203 + expect(mockedExecute).toHaveBeenCalledTimes(4);
204 }),
205 );
206
@@ -378,6 +379,59 @@ layer("AzureDevOpsPullRequestCli.layer", (it) => {
379 }),
380 );
381
382 + const policyRow = (name: string, status: string) => ({
383 + status,
384 + configuration: {
385 + url: "https://dev.azure.com/acme/platform/_apis/policy/configurations/54",
386 + isBlocking: true,
387 + type: { id: "0609b952-1397-4640-95ec-e00a01b2c241" },
388 + settings: { displayName: name },
389 + },
390 + });
391 +
392 + it.effect("follows every page of policies and puts failures first", () =>
393 + Effect.gen(function* () {
394 + const fullPage = Array.from({ length: 100 }, () => policyRow("Lint", "approved"));
395 + mockedExecute
396 + .mockReturnValueOnce(Effect.succeed(output(JSON.stringify(fullPage))))
397 + .mockReturnValueOnce(
398 + Effect.succeed(output(JSON.stringify([policyRow("Tests", "rejected")]))),
399 + );
400 + const cli = yield* AzureDevOpsPullRequestCli.AzureDevOpsPullRequestCli;
401 + const checks = yield* cli.listPolicyChecks({ cwd: "/w", number: 42, isDraft: false });
402 + assert.deepStrictEqual(argsOfCall(1).slice(0, 12), [
403 + "repos",
404 + "pr",
405 + "policy",
406 + "list",
407 + "--detect",
408 + "true",
409 + "--id",
410 + "42",
411 + "--top",
412 + "100",
413 + "--skip",
414 + "100",
415 + ]);
416 + assert.strictEqual(checks.length, 101);
417 + assert.strictEqual(checks[0]?.name, "Tests");
418 + }),
419 + );
420 +
421 + it.effect.each([
422 + { name: "cut off", result: { ...output("[]"), stdoutTruncated: true } },
423 + { name: "unreadable", result: output(JSON.stringify([{ status: 7 }])) },
424 + ])("fails rather than report a $name policy page as complete", ({ result }) =>
425 + Effect.gen(function* () {
426 + mockedExecute.mockReturnValueOnce(Effect.succeed(result));
427 + const cli = yield* AzureDevOpsPullRequestCli.AzureDevOpsPullRequestCli;
428 + const error = yield* Effect.flip(
429 + cli.listPolicyChecks({ cwd: "/w", number: 42, isDraft: false }),
430 + );
431 + assert.strictEqual(error._tag, "AzureDevOpsPullRequestReadError");
432 + }),
433 + );
434 +
435 it.effect("sends a description that starts with a dash as one value, not as a flag", () =>
436 Effect.gen(function* () {
437 mockedExecute.mockReturnValue(Effect.succeed(output("{}")));
packages/source-control-azure-devops/src/server/AzureDevOpsPullRequestCli.ts
+49
@@ -6,18 +6,22 @@ import * as Result from "effect/Result";
6 import * as Schema from "effect/Schema";
7 import type {
8 PullRequestAction,
9 + PullRequestCheck,
10 PullRequestComment,
11 PullRequestInvolvement,
12 PullRequestListState,
13 PullRequestMergeMethod,
14 } from "@t3tools/contracts";
15
16 +import { sortChecks } from "@t3tools/source-control-core/server/pullRequestChecks";
17 +
18 import * as AzureDevOpsCli from "./AzureDevOpsCli.ts";
19 import { blobContent, readBlobZip } from "./azureDevOpsBlobZip.ts";
20 import {
21 decodeItemContentJson,
22 decodeIterationChangesJson,
23 decodeIterationsJson,
24 + decodePolicyChecksJson,
25 decodePullRequestJson,
26 decodePullRequestListJson,
27 decodeThreadsJson,
@@ -120,6 +124,9 @@ const BLOB_ID = /^[0-9a-f]{40}$/i;
124 /** Review history is unpaged and independent of diff size. */
125 const REVIEW_HISTORY_MAX_OUTPUT_BYTES = 8 * 1024 * 1024;
126
127 +const POLICY_EVALUATIONS_PER_PAGE = 100;
128 +const MAX_POLICY_EVALUATIONS = 1000;
129 +
130 /** Azure's iteration-change page limit. */
131 const CHANGE_ENTRIES_PER_PAGE = 2000;
132
@@ -166,6 +173,13 @@ export class AzureDevOpsPullRequestCli extends Context.Service<
173 readonly number: number;
174 }) => Effect.Effect<AzureDevOpsPullRequest, AzureDevOpsPullRequestCliError>;
175
176 + readonly listPolicyChecks: (input: {
177 + readonly cwd: string;
178 + readonly number: number;
179 + /** Azure holds builds back on a draft, which reads the same as a build about to start. */
180 + readonly isDraft: boolean;
181 + }) => Effect.Effect<ReadonlyArray<PullRequestCheck>, AzureDevOpsPullRequestCliError>;
182 +
183 readonly listThreads: (input: {
184 readonly cwd: string;
185 readonly location: AzureDevOpsRepositoryLocation;
@@ -568,6 +582,41 @@ export const make = Effect.gen(function* () {
582 );
583 }),
584
585 + listPolicyChecks: Effect.fn("AzureDevOpsPullRequestCli.listPolicyChecks")(function* (input) {
586 + const unreadable = (cause: unknown) =>
587 + new AzureDevOpsPullRequestReadError({
588 + command: "az",
589 + cwd: input.cwd,
590 + operation: "listPolicyChecks",
591 + cause,
592 + });
593 + const checks: PullRequestCheck[] = [];
594 + for (let skip = 0; skip < MAX_POLICY_EVALUATIONS; skip += POLICY_EVALUATIONS_PER_PAGE) {
595 + const result = yield* executeJson({
596 + cwd: input.cwd,
597 + args: [
598 + "repos",
599 + "pr",
600 + "policy",
601 + "list",
602 + ...detectArgs,
603 + "--id",
604 + String(input.number),
605 + "--top",
606 + String(POLICY_EVALUATIONS_PER_PAGE),
607 + "--skip",
608 + String(skip),
609 + ],
610 + });
611 + if (result.stdoutTruncated) return yield* unreadable("Policy output was truncated");
612 + const page = decodePolicyChecksJson(result.stdout.trim(), { isDraft: input.isDraft });
613 + if (!Result.isSuccess(page)) return yield* unreadable(page.failure);
614 + checks.push(...page.success.checks);
615 + if (page.success.rawCount < POLICY_EVALUATIONS_PER_PAGE) return sortChecks(checks);
616 + }
617 + return yield* unreadable("Policy evaluations exceeded the read limit");
618 + }),
619 +
620 listThreads: Effect.fn("AzureDevOpsPullRequestCli.listThreads")(function (input) {
621 return invoke({
622 cwd: input.cwd,
packages/source-control-azure-devops/src/server/AzureDevOpsPullRequestProvider.test.ts
+67
@@ -1,6 +1,7 @@
1 import { describe, expect, it } from "@effect/vitest";
2 import * as Effect from "effect/Effect";
3 import * as Layer from "effect/Layer";
4 +import type { PullRequestCheck, PullRequestCheckStatus } from "@t3tools/contracts";
5
6 import * as AzureDevOpsPullRequestCli from "./AzureDevOpsPullRequestCli.ts";
7 import {
@@ -134,6 +135,7 @@ describe("getChangeRequest", () => {
135 Effect.provide(
136 Layer.mock(AzureDevOpsPullRequestCli.AzureDevOpsPullRequestCli)({
137 getPullRequest: () => Effect.succeed(PULL_REQUEST),
138 + listPolicyChecks: () => Effect.succeed([]),
139 listIterations: () =>
140 Effect.succeed([ITERATION, { ...ITERATION, id: 4, headCommit: "new-head" }]),
141 listIterationChanges: () =>
@@ -168,6 +170,7 @@ describe("getChangeRequest", () => {
170 Effect.provide(
171 Layer.mock(AzureDevOpsPullRequestCli.AzureDevOpsPullRequestCli)({
172 getPullRequest: () => Effect.succeed(PULL_REQUEST),
173 + listPolicyChecks: () => Effect.succeed([]),
174 listIterations: () =>
175 state === "missing"
176 ? Effect.succeed([])
@@ -194,6 +197,70 @@ describe("getChangeRequest", () => {
197 );
198 });
199
200 +describe("policy checks", () => {
201 + const REPOSITORY = {
202 + cwd: "/w",
203 + repository: "acme/web",
204 + host: "dev.azure.com",
205 + number: 7,
206 + };
207 + const check = (status: PullRequestCheckStatus): PullRequestCheck => ({
208 + name: "PR validation",
209 + status,
210 + description: null,
211 + url: null,
212 + required: true,
213 + });
214 + const readFailure = new AzureDevOpsPullRequestCli.AzureDevOpsPullRequestReadError({
215 + command: "az",
216 + cwd: "/w",
217 + operation: "listPolicyChecks",
218 + cause: "unavailable",
219 + });
220 +
221 + const provide = (
222 + listPolicyChecks: AzureDevOpsPullRequestCli.AzureDevOpsPullRequestCli["Service"]["listPolicyChecks"],
223 + pullRequest = PULL_REQUEST,
224 + ) =>
225 + make.pipe(
226 + Effect.provide(
227 + Layer.mock(AzureDevOpsPullRequestCli.AzureDevOpsPullRequestCli)({
228 + getPullRequest: () => Effect.succeed(pullRequest),
229 + listIterations: () => Effect.succeed([ITERATION]),
230 + listIterationChanges: () => Effect.succeed({ changes: [], truncated: false }),
231 + listPolicyChecks,
232 + }),
233 + ),
234 + );
235 +
236 + it.effect("keeps the detail readable when the policies are not", () =>
237 + Effect.gen(function* () {
238 + const provider = yield* provide(() => Effect.fail(readFailure));
239 + const detail = yield* provider.getChangeRequest(REPOSITORY);
240 + expect(detail.checks).toEqual([]);
241 + }),
242 + );
243 +
244 + it.effect.each([
245 + { statuses: ["pending", "failure"], expected: "failing" },
246 + { statuses: [], expected: null },
247 + ] as const)("summarizes $statuses as $expected", ({ statuses, expected }) =>
248 + Effect.gen(function* () {
249 + const provider = yield* provide(() => Effect.succeed(statuses.map(check)));
250 + const summary = yield* provider.getChangeRequestSummary!(REPOSITORY);
251 + expect(summary.checksState).toBe(expected);
252 + }),
253 + );
254 +
255 + it.effect("leaves the last known state alone when the policies cannot be read", () =>
256 + Effect.gen(function* () {
257 + const provider = yield* provide(() => Effect.fail(readFailure));
258 + const summary = yield* provider.getChangeRequestSummary!(REPOSITORY);
259 + expect(summary.checksState).toBeUndefined();
260 + }),
261 + );
262 +});
263 +
264 describe("getDiff reads", () => {
265 it.effect("holds every reader together to one request's worth of processes", () =>
266 Effect.gen(function* () {
packages/source-control-azure-devops/src/server/AzureDevOpsPullRequestProvider.ts
+34 -5
@@ -1,6 +1,7 @@
1 import { resolvePullRequestAuthorFilter, SourceControlProviderKind } from "@t3tools/contracts";
2 import * as Effect from "effect/Effect";
3 import * as Semaphore from "effect/Semaphore";
4 +import { rollupCheckStatuses } from "@t3tools/source-control-core/server/pullRequestChecks";
5 import type { PullRequestCapabilities, PullRequestViewerPermissions } from "@t3tools/contracts";
6
7 import * as AzureDevOpsPullRequestCli from "./AzureDevOpsPullRequestCli.ts";
@@ -219,6 +220,13 @@ export const make = Effect.gen(function* () {
220 );
221 };
222
223 + const readChecks = (input: { readonly cwd: string }, pullRequest: AzureDevOpsPullRequest) =>
224 + cli.listPolicyChecks({
225 + cwd: input.cwd,
226 + number: pullRequest.number,
227 + isDraft: pullRequest.isDraft,
228 + });
229 +
230 /** A later slice names its iteration, which the list it was cut from already holds. */
231 const diffScope = Effect.fn("AzureDevOpsPullRequestProvider.diffScope")(function* (input: {
232 readonly cwd: string;
@@ -369,10 +377,30 @@ export const make = Effect.gen(function* () {
377 })),
378 ),
379
372 - getChangeRequestSummary: (input) =>
373 - cli
374 - .getPullRequest({ cwd: input.cwd, number: input.number })
375 - .pipe(Effect.mapError(fail("getChangeRequestSummary")), Effect.map(toSummary)),
380 + getChangeRequestChecks: Effect.fn("AzureDevOpsPullRequestProvider.getChangeRequestChecks")(
381 + function* (input) {
382 + const pullRequest = yield* cli.getPullRequest({ cwd: input.cwd, number: input.number });
383 + const checks = yield* readChecks(input, pullRequest);
384 + return { state: pullRequest.state, checks };
385 + },
386 + Effect.mapError(fail("getChangeRequestChecks")),
387 + ),
388 +
389 + getChangeRequestSummary: Effect.fn("AzureDevOpsPullRequestProvider.getChangeRequestSummary")(
390 + function* (input) {
391 + const pullRequest = yield* cli.getPullRequest({ cwd: input.cwd, number: input.number });
392 + // Undefined keeps the last known state; null would claim no checks exist.
393 + const checksState = yield* readChecks(input, pullRequest).pipe(
394 + Effect.map((checks) => rollupCheckStatuses(checks.map((check) => check.status))),
395 + Effect.orElseSucceed(() => undefined),
396 + );
397 + return {
398 + ...toSummary(pullRequest),
399 + ...(checksState === undefined ? {} : { checksState }),
400 + };
401 + },
402 + Effect.mapError(fail("getChangeRequestSummary")),
403 + ),
404
405 getChangeRequest: Effect.fn("AzureDevOpsPullRequestProvider.getChangeRequest")(
406 function* (input) {
@@ -398,6 +426,7 @@ export const make = Effect.gen(function* () {
426 Effect.map((listed) => listed.changes.length),
427 Effect.orElseSucceed(() => 0),
428 );
429 + const checks = yield* readChecks(input, pullRequest).pipe(Effect.orElseSucceed(() => []));
430 const detail: ProviderChangeRequestDetail = {
431 ...toChangeRequest(pullRequest),
432 body: pullRequest.body,
@@ -406,7 +435,7 @@ export const make = Effect.gen(function* () {
435 mergedAt: pullRequest.state === "merged" ? pullRequest.closedAt : null,
436 closedAt: pullRequest.state === "closed" ? pullRequest.closedAt : null,
437 reviewers: pullRequest.reviewers,
409 - checks: [],
438 + checks,
439 mergeCapabilities: { merge: true, squash: true, rebase: false },
440 viewerPermissions: AZURE_DEVOPS_VIEWER_PERMISSIONS,
441 autoMergeEnabled: pullRequest.autoMergeEnabled,
packages/source-control-azure-devops/src/server/azureDevOpsPullRequestJson.test.ts
+134
@@ -5,6 +5,7 @@ import {
5 decodeItemContentJson,
6 decodeIterationChangesJson,
7 decodeIterationsJson,
8 + decodePolicyChecksJson,
9 decodePullRequestJson,
10 decodePullRequestListJson,
11 decodeThreadsJson,
@@ -516,3 +517,136 @@ describe("what az devops invoke answers with", () => {
517 ).toEqual({ contents: "# T3Demo\n", isBinary: false });
518 });
519 });
520 +
521 +describe("decodePolicyChecksJson", () => {
522 + const BUILD_TYPE = "0609b952-1397-4640-95ec-e00a01b2c241";
523 + const STATUS_TYPE = "cbdc66da-9728-4af8-aada-9a5a32e4a226";
524 + const CONFIGURATION_URL =
525 + "https://dev.azure.com/acme/6f9c9b7f-0000-0000-0000-000000000000/_apis/policy/configurations/54";
526 +
527 + const evaluation = (
528 + status: string,
529 + context: Record<string, unknown> | null,
530 + settings: Record<string, unknown> = { displayName: "PR validation" },
531 + configuration: Record<string, unknown> = {},
532 + ) => ({
533 + status,
534 + context,
535 + configuration: {
536 + url: CONFIGURATION_URL,
537 + isBlocking: true,
538 + type: { id: BUILD_TYPE, displayName: "Build" },
539 + settings,
540 + ...configuration,
541 + },
542 + });
543 +
544 + const decodeOne = (value: unknown, isDraft = false) =>
545 + expectSuccess(decodePolicyChecksJson(asJson([value]), { isDraft })).checks[0];
546 +
547 + it.each([
548 + ["approved", "success"],
549 + ["running", "pending"],
550 + ["rejected", "failure"],
551 + ["broken", "failure"],
552 + ["notApplicable", "skipped"],
553 + ["someNewStatus", "pending"],
554 + ])("reads a build evaluation %s as %s", (status, expected) => {
555 + expect(decodeOne(evaluation(status, { buildId: 21959 }))?.status).toBe(expected);
556 + });
557 +
558 + it("links a build to its results page, in the project the policy belongs to", () => {
559 + expect(decodeOne(evaluation("running", { buildId: 21959 }))).toEqual({
560 + name: "PR validation",
561 + status: "pending",
562 + description: null,
563 + url: "https://dev.azure.com/acme/6f9c9b7f-0000-0000-0000-000000000000/_build/results?buildId=21959",
564 + required: true,
565 + });
566 + });
567 +
568 + it("names a build policy without its own name after the pipeline it runs", () => {
569 + const check = decodeOne(evaluation("approved", { buildDefinitionName: "PR - Validation" }, {}));
570 + expect(check?.name).toBe("PR - Validation");
571 + expect(check?.url).toBeNull();
572 + });
573 +
574 + it("reads a status policy, which reports an external service's verdict", () => {
575 + expect(
576 + decodeOne(
577 + evaluation(
578 + "rejected",
579 + null,
580 + { defaultDisplayName: "SonarCloud", statusName: "gate" },
581 + {
582 + type: { id: STATUS_TYPE, displayName: "Status" },
583 + },
584 + ),
585 + ),
586 + ).toMatchObject({ name: "SonarCloud", status: "failure", url: null });
587 + });
588 +
589 + // Both arrive as `queued`; a spinner would never stop on either.
590 + it.each([
591 + {
592 + name: "an expired build",
593 + value: evaluation("queued", { buildId: 21919, isExpired: true }),
594 + },
595 + {
596 + name: "a build only a person can queue",
597 + value: evaluation("queued", null, { displayName: "Nightly", manualQueueOnly: true }),
598 + },
599 + ])("asks for action on $name", ({ value }) => {
600 + const check = decodeOne(value);
601 + expect(check?.status).toBe("action-required");
602 + expect(check?.description).not.toBeNull();
603 + });
604 +
605 + // A watch waits on every check that asks for action, and nobody has to queue an optional one.
606 + it.each([
607 + { name: "expired", value: evaluation("queued", { buildId: 21919, isExpired: true }) },
608 + {
609 + name: "manual-only",
610 + value: evaluation("queued", null, { displayName: "Nightly", manualQueueOnly: true }),
611 + },
612 + ])("skips an optional $name build that nobody queued", ({ value }) => {
613 + const check = decodeOne({
614 + ...value,
615 + configuration: { ...value.configuration, isBlocking: false },
616 + });
617 + expect(check?.status).toBe("skipped");
618 + expect(check?.description).not.toBeNull();
619 + });
620 +
621 + it("reports nothing for a build Azure holds back on a draft", () => {
622 + expect(decodeOne(evaluation("queued", null), true)).toBeUndefined();
623 + expect(decodeOne(evaluation("running", { buildId: 21960 }), true)?.status).toBe("pending");
624 + });
625 +
626 + it("keeps a build that is really waiting for an agent as running", () => {
627 + expect(decodeOne(evaluation("queued", { buildId: 21960, isExpired: false }))?.status).toBe(
628 + "pending",
629 + );
630 + expect(decodeOne(evaluation("queued", null))?.status).toBe("pending");
631 + });
632 +
633 + it.each([
634 + {
635 + name: "a review gate, which waits on people",
636 + configuration: { type: { id: "fa4e907d-c16b-4a4c-9dfa-4906e5d171dd" } },
637 + },
638 + { name: "a disabled policy", configuration: { isEnabled: false } },
639 + { name: "a deleted policy", configuration: { isDeleted: true } },
640 + ])("leaves out $name but still counts the row for paging", ({ configuration }) => {
641 + const row = evaluation("queued", null, {}, configuration);
642 + expect(expectSuccess(decodePolicyChecksJson(asJson([row]), { isDraft: false }))).toEqual({
643 + checks: [],
644 + rawCount: 1,
645 + });
646 + });
647 +
648 + it("fails the page on a row it cannot read, which could be a required check", () => {
649 + const rows = asJson([evaluation("rejected", null), { status: 7 }]);
650 + expect(Result.isFailure(decodePolicyChecksJson(rows, { isDraft: false }))).toBe(true);
651 + });
652 +});
packages/source-control-azure-devops/src/server/azureDevOpsPullRequestJson.ts
+130
@@ -8,6 +8,7 @@ import * as Result from "effect/Result";
8 import * as Schema from "effect/Schema";
9 import type {
10 PullRequestActor,
11 + PullRequestCheck,
12 PullRequestComment,
13 PullRequestMergeMethod,
14 PullRequestMergeability,
@@ -103,6 +104,39 @@ const RawViewerSchema = Schema.Struct({
104 ),
105 });
106
107 +const RawPolicyEvaluationSchema = Schema.Struct({
108 + status: Schema.String,
109 + context: Schema.optional(
110 + Schema.NullOr(
111 + Schema.Struct({
112 + buildId: Schema.optional(Schema.NullOr(Schema.Int)),
113 + buildDefinitionName: Schema.optional(Schema.NullOr(Schema.String)),
114 + isExpired: Schema.optional(Schema.NullOr(Schema.Boolean)),
115 + }),
116 + ),
117 + ),
118 + configuration: Schema.Struct({
119 + url: Schema.optional(Schema.NullOr(Schema.String)),
120 + isBlocking: Schema.optional(Schema.NullOr(Schema.Boolean)),
121 + isEnabled: Schema.optional(Schema.NullOr(Schema.Boolean)),
122 + isDeleted: Schema.optional(Schema.NullOr(Schema.Boolean)),
123 + type: Schema.Struct({
124 + id: Schema.String,
125 + displayName: Schema.optional(Schema.NullOr(Schema.String)),
126 + }),
127 + settings: Schema.optional(
128 + Schema.NullOr(
129 + Schema.Struct({
130 + displayName: Schema.optional(Schema.NullOr(Schema.String)),
131 + defaultDisplayName: Schema.optional(Schema.NullOr(Schema.String)),
132 + statusName: Schema.optional(Schema.NullOr(Schema.String)),
133 + manualQueueOnly: Schema.optional(Schema.NullOr(Schema.Boolean)),
134 + }),
135 + ),
136 + ),
137 + }),
138 +});
139 +
140 export interface AzureDevOpsRepositoryLocation {
141 readonly project: string;
142 readonly repository: string;
@@ -237,6 +271,7 @@ const decodePullRequest = decodeJsonResult(RawPullRequestSchema);
271 const decodeThreadPage = decodeJsonResult(RawThreadPageSchema);
272 const decodeThreadEntry = Schema.decodeUnknownExit(RawThreadSchema);
273 const decodeViewer = decodeJsonResult(RawViewerSchema);
274 +const decodePolicyEvaluations = decodeJsonResult(Schema.Array(RawPolicyEvaluationSchema));
275
276 type DecodeFailure = Cause.Cause<Schema.SchemaError>;
277
@@ -326,6 +361,101 @@ export function decodeThreadsJson(
361 );
362 }
363
364 +type RawPolicyEvaluation = Schema.Schema.Type<typeof RawPolicyEvaluationSchema>;
365 +
366 +const BUILD_POLICY_TYPE = "0609b952-1397-4640-95ec-e00a01b2c241";
367 +const STATUS_POLICY_TYPE = "cbdc66da-9728-4af8-aada-9a5a32e4a226";
368 +// Other policy types wait on people or restrict pushes, so they would read as checks that never end.
369 +const CHECK_POLICY_TYPES = new Set([BUILD_POLICY_TYPE, STATUS_POLICY_TYPE]);
370 +
371 +/** Azure reports `queued` for a build that will never start on its own, so name those apart. */
372 +function toPolicyCheckProgress(
373 + raw: RawPolicyEvaluation,
374 +): Pick<PullRequestCheck, "status" | "description"> {
375 + const settled = (status: PullRequestCheck["status"]) => ({ status, description: null });
376 + switch (raw.status.trim().toLowerCase()) {
377 + case "approved":
378 + return settled("success");
379 + case "rejected":
380 + case "broken":
381 + return settled("failure");
382 + case "running":
383 + return settled("pending");
384 + case "notapplicable":
385 + return settled("skipped");
386 + case "queued":
387 + break;
388 + default:
389 + // A watch counts anything settled as passed, so an unknown status cannot be.
390 + return settled("pending");
391 + }
392 + const expired = raw.context?.isExpired === true;
393 + if (!expired && raw.configuration.settings?.manualQueueOnly !== true) return settled("pending");
394 + // Only a blocking build holds the pull request; an optional one nobody queues never runs.
395 + return {
396 + status: raw.configuration.isBlocking === true ? "action-required" : "skipped",
397 + description: expired ? "Expired. Queue it again on Azure DevOps." : "Queue it on Azure DevOps.",
398 + };
399 +}
400 +
401 +/** The evaluation's configuration URL opens at the project the policy belongs to. */
402 +function toPolicyCheckUrl(raw: RawPolicyEvaluation): string | null {
403 + const buildId = raw.context?.buildId;
404 + const [projectUrl, rest] = (raw.configuration.url ?? "").split("/_apis/", 2);
405 + return buildId == null || rest === undefined
406 + ? null
407 + : `${projectUrl}/_build/results?buildId=${buildId}`;
408 +}
409 +
410 +function toPolicyCheck(raw: RawPolicyEvaluation, isDraft: boolean): PullRequestCheck | null {
411 + const { configuration, context } = raw;
412 + if (
413 + !CHECK_POLICY_TYPES.has(configuration.type.id.toLowerCase()) ||
414 + configuration.isEnabled === false ||
415 + configuration.isDeleted === true
416 + ) {
417 + return null;
418 + }
419 + // A build Azure holds back on a draft stays out, as nothing would ever finish it.
420 + if (isDraft && raw.status.trim().toLowerCase() === "queued" && context?.buildId == null) {
421 + return null;
422 + }
423 + return {
424 + name:
425 + trimmed(configuration.settings?.displayName) ??
426 + trimmed(configuration.settings?.defaultDisplayName) ??
427 + trimmed(context?.buildDefinitionName) ??
428 + trimmed(configuration.settings?.statusName) ??
429 + trimmed(configuration.type.displayName) ??
430 + "Policy",
431 + ...toPolicyCheckProgress(raw),
432 + url: toPolicyCheckUrl(raw),
433 + required: configuration.isBlocking === true,
434 + };
435 +}
436 +
437 +export interface AzureDevOpsPolicyCheckPage {
438 + readonly checks: ReadonlyArray<PullRequestCheck>;
439 + /** Evaluations of every policy type, so filtered rows cannot hide a next page. */
440 + readonly rawCount: number;
441 +}
442 +
443 +/** Unlike the tolerant decoders above, one bad row fails the page: a lost required check reads as passed. */
444 +export function decodePolicyChecksJson(
445 + raw: string,
446 + input: { readonly isDraft: boolean },
447 +): Result.Result<AzureDevOpsPolicyCheckPage, DecodeFailure> {
448 + const decoded = decodePolicyEvaluations(raw);
449 + if (!Result.isSuccess(decoded)) return Result.fail(decoded.failure);
450 + return Result.succeed({
451 + checks: decoded.success.flatMap((evaluation) => {
452 + const check = toPolicyCheck(evaluation, input.isDraft);
453 + return check === null ? [] : [check];
454 + }),
455 + rawCount: decoded.success.length,
456 + });
457 +}
458 +
459 const RawIterationSchema = Schema.Struct({
460 id: Schema.Int,
461 sourceRefCommit: Schema.optional(
packages/source-control-core/src/server/pullRequestChecks.ts
+14 -1
@@ -1,4 +1,8 @@
1 -import type { PullRequestCheck } from "@t3tools/contracts";
1 +import type {
2 + PullRequestCheck,
3 + PullRequestCheckStatus,
4 + PullRequestChecksState,
5 +} from "@t3tools/contracts";
6 import * as DateTime from "effect/DateTime";
7 import * as Option from "effect/Option";
8
@@ -36,6 +40,15 @@ function isAtLeastAsNew(candidate: string | null, kept: string | null): boolean
40 );
41 }
42
43 +export function rollupCheckStatuses(
44 + statuses: ReadonlyArray<PullRequestCheckStatus>,
45 +): PullRequestChecksState | null {
46 + if (statuses.length === 0) return null;
47 + if (statuses.includes("failure") || statuses.includes("cancelled")) return "failing";
48 + if (statuses.includes("pending") || statuses.includes("action-required")) return "pending";
49 + return statuses.includes("success") ? "passing" : null;
50 +}
51 +
52 export function sortChecks(
53 checks: ReadonlyArray<PullRequestCheck>,
54 ): ReadonlyArray<PullRequestCheck> {
packages/source-control-github/src/server/gitHubPullRequestJson.ts
+6 -7
@@ -38,7 +38,10 @@ import type {
38 } from "@t3tools/contracts";
39 import { quoteGitPatchPath } from "@t3tools/shared/gitPatchPath";
40 import { decodeJsonResult } from "@t3tools/shared/schemaJson";
41 -import { dedupeChecks } from "@t3tools/source-control-core/server/pullRequestChecks";
41 +import {
42 + dedupeChecks,
43 + rollupCheckStatuses,
44 +} from "@t3tools/source-control-core/server/pullRequestChecks";
45 import type { ProviderChangeRequestSummary } from "@t3tools/source-control-core/server/PullRequestProvider";
46
47 import type * as GitHubSchema from "../../schema/github.graphql.ts";
@@ -645,14 +648,10 @@ function toCheckEntries(raw: ReadonlyArray<CheckFields> | null | undefined): Rea
648 function rollupChecksState(
649 raw: ReadonlyArray<CheckFields> | null | undefined,
650 ): PullRequestChecksState | null {
648 - const statuses = [
651 + return rollupCheckStatuses([
652 ...toChecks(raw).map((check) => check.status),
653 ...(raw ?? []).filter(isNamelessCheck).map((check) => toCheckStatus(check)),
651 - ];
652 - if (statuses.length === 0) return null;
653 - if (statuses.includes("failure") || statuses.includes("cancelled")) return "failing";
654 - if (statuses.includes("pending") || statuses.includes("action-required")) return "pending";
655 - return statuses.includes("success") ? "passing" : null;
654 + ]);
655 }
656
657 function toChecks(