Skip to content

Commit b3b2c55

Browse files
authored
perf(source-control): pull request previews read only the pull request (#22583)
1 parent 0191d6c commit b3b2c55

11 files changed

Lines changed: 151 additions & 31 deletions

File tree

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

Lines changed: 17 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -49,9 +49,9 @@ export function PullRequestLinkPreview({
4949
const [open, setOpen] = useState(false);
5050
const previewActionsRef = useRef<PreviewCardPrimitive.Root.Actions | null>(null);
5151
const [resolvingClick, setResolvingClick] = useState(false);
52-
const detailQuery = useEnvironmentQuery(
52+
const previewQuery = useEnvironmentQuery(
5353
open
54-
? pullRequestEnvironment.detail({
54+
? pullRequestEnvironment.previewCard({
5555
environmentId: target.environmentId,
5656
input: target.input,
5757
})
@@ -84,19 +84,19 @@ export function PullRequestLinkPreview({
8484
},
8585
})
8686
: link;
87-
const detail = detailQuery.data;
88-
const showCard = detail !== null || (detailQuery.error !== null && fallback !== undefined);
89-
const showUrlTooltip = open && detailQuery.error !== null && !showCard;
87+
const preview = previewQuery.data;
88+
const showCard = preview !== null || (previewQuery.error !== null && fallback !== undefined);
89+
const showUrlTooltip = open && previewQuery.error !== null && !showCard;
9090
const state =
91-
detail === null
91+
preview === null
9292
? null
93-
: resolvePullRequestState({ state: detail.state, isDraft: detail.isDraft });
93+
: resolvePullRequestState({ state: preview.state, isDraft: preview.isDraft });
9494
const authorLabel =
95-
detail?.author === null
95+
preview?.author === null
9696
? "ghost"
97-
: detail?.author.name && detail.author.name !== detail.author.login
98-
? `${detail.author.name} (@${detail.author.login})`
99-
: (detail?.author.login ?? null);
97+
: preview?.author.name && preview.author.name !== preview.author.login
98+
? `${preview.author.name} (@${preview.author.login})`
99+
: (preview?.author.login ?? null);
100100

101101
return (
102102
<PreviewCard open={open} onOpenChange={setOpen} actionsRef={previewActionsRef}>
@@ -116,13 +116,13 @@ export function PullRequestLinkPreview({
116116
{showCard ? (
117117
<PreviewCardPopup align="center" className="w-80 max-w-[calc(100vw-2rem)]">
118118
<div className="p-3">
119-
{detail === null ? (
119+
{preview === null ? (
120120
fallback
121121
) : (
122122
<div className="min-w-0">
123123
<div className="flex min-w-0 items-center gap-1.5 text-2xs text-muted-foreground">
124-
<span className="min-w-0 truncate">{detail.repository}</span>
125-
<span className="shrink-0">#{detail.number}</span>
124+
<span className="min-w-0 truncate">{preview.repository}</span>
125+
<span className="shrink-0">#{preview.number}</span>
126126
<span aria-hidden>·</span>
127127
{state === null ? null : (
128128
<span className="inline-flex shrink-0 items-center gap-1">
@@ -132,14 +132,14 @@ export function PullRequestLinkPreview({
132132
)}
133133
</div>
134134
<p className="mt-1 text-sm font-medium leading-snug text-foreground text-pretty">
135-
{detail.title}
135+
{preview.title}
136136
</p>
137137
<div className="mt-2 flex min-w-0 items-center gap-1.5 text-xs text-muted-foreground">
138-
<PullRequestActorAvatar actor={detail.author} className="size-4" />
138+
<PullRequestActorAvatar actor={preview.author} className="size-4" />
139139
<span className="min-w-0 truncate">{authorLabel}</span>
140140
<span aria-hidden>·</span>
141141
<span className="shrink-0">
142-
opened <RelativeTime timestamp={detail.createdAt} />
142+
opened <RelativeTime timestamp={preview.createdAt} />
143143
</span>
144144
</div>
145145
</div>

‎packages/client-runtime/src/state/pullRequests.ts‎

Lines changed: 18 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -210,6 +210,18 @@ export function createPullRequestEnvironmentAtoms<R, E>(
210210
refreshTrigger: ({ environmentId }) => refreshes({ environmentId, input: {} }),
211211
}),
212212
);
213+
// Hover cards read their own atoms, so a pending or failed hover read never decides where a
214+
// click on the same link goes.
215+
const previewCard = writableQueryFamily(
216+
createEnvironmentRpcQueryAtomFamily(runtime, {
217+
label: "environment-data:pull-requests:preview-card",
218+
persistence: persistQuery(PullRequestPreview),
219+
tag: WS_METHODS.pullRequestsPreview,
220+
execute: (input) => routedRequest(WS_METHODS.pullRequestsPreview, input),
221+
staleTimeMs: 60_000,
222+
refreshTrigger: ({ environmentId }) => refreshes({ environmentId, input: {} }),
223+
}),
224+
);
213225
const labelCandidates = writableQueryFamily(
214226
createEnvironmentRpcQueryAtomFamily(runtime, {
215227
label: "environment-data:pull-requests:label-candidates",
@@ -337,6 +349,7 @@ export function createPullRequestEnvironmentAtoms<R, E>(
337349
}),
338350
detail,
339351
preview,
352+
previewCard,
340353
checks: normalizePullRequestQuery(
341354
createEnvironmentRpcQueryAtomFamily(runtime, {
342355
label: "environment-data:pull-requests:checks",
@@ -423,7 +436,10 @@ export function createPullRequestEnvironmentAtoms<R, E>(
423436
// every preceding action, and preparing outside the lane could reorder the clicks.
424437
execute: runAction,
425438
onSuccess: ({ environmentId, input }, registry) =>
426-
Effect.sync(() => registry.refresh(preview({ environmentId, input }))),
439+
Effect.sync(() => {
440+
registry.refresh(preview({ environmentId, input }));
441+
registry.refresh(previewCard({ environmentId, input }));
442+
}),
427443
scheduler: commandScheduler,
428444
concurrency: serialPerEnvironment,
429445
}),
@@ -621,6 +637,7 @@ export function createPullRequestEnvironmentAtoms<R, E>(
621637
Effect.sync(() => {
622638
if (input.reference !== undefined) {
623639
registry.refresh(preview({ environmentId, input: input.reference }));
640+
registry.refresh(previewCard({ environmentId, input: input.reference }));
624641
}
625642
}),
626643
scheduler: commandScheduler,

‎packages/source-control-azure-devops/src/server/AzureDevOpsPullRequestProvider.ts‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -274,6 +274,20 @@ export const make = Effect.gen(function* () {
274274
})),
275275
),
276276

277+
getChangeRequestPreview: (input) =>
278+
cli.getPullRequest({ cwd: input.cwd, number: input.number }).pipe(
279+
Effect.mapError(fail("getChangeRequestPreview")),
280+
Effect.map((pullRequest) => ({
281+
number: pullRequest.number,
282+
title: pullRequest.title,
283+
url: pullRequest.url,
284+
author: pullRequest.author,
285+
state: pullRequest.state,
286+
isDraft: pullRequest.isDraft,
287+
createdAt: pullRequest.createdAt,
288+
})),
289+
),
290+
277291
getChangeRequestSummary: (input) =>
278292
cli.getPullRequest({ cwd: input.cwd, number: input.number }).pipe(
279293
Effect.mapError(fail("getChangeRequestSummary")),

‎packages/source-control-bitbucket/src/server/BitbucketPullRequestProvider.ts‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -182,6 +182,20 @@ export const make = Effect.gen(function* () {
182182
Effect.mapError(fail("getChangeRequestChecks")),
183183
),
184184

185+
getChangeRequestPreview: (input) =>
186+
api.getPullRequest({ repository: input.repository, number: input.number }).pipe(
187+
Effect.mapError(fail("getChangeRequestPreview")),
188+
Effect.map((pullRequest) => ({
189+
number: pullRequest.number,
190+
title: pullRequest.title,
191+
url: pullRequest.url,
192+
author: pullRequest.author,
193+
state: pullRequest.state,
194+
isDraft: pullRequest.isDraft,
195+
createdAt: pullRequest.createdAt,
196+
})),
197+
),
198+
185199
getChangeRequest: (input) => {
186200
const target = { repository: input.repository, number: input.number };
187201
return Effect.all(

‎packages/source-control-forgejo/src/server/ForgejoPullRequestProvider.ts‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -324,6 +324,7 @@ export const make = Effect.gen(function* () {
324324
return { items, truncated: more, continues: true, cursorAdvance: consumed };
325325
},
326326
),
327+
getChangeRequestPreview: (input) => getPull(input).pipe(Effect.map(forgejoChangeRequest)),
327328
getChangeRequestSummary: (input) => getPull(input).pipe(Effect.map(forgejoChangeRequest)),
328329
getChangeRequestChecks: Effect.fn("ForgejoPullRequestProvider.getChangeRequestChecks")(
329330
function* (input) {

‎packages/source-control-forgejo/src/server/ForgejoSourceControlProvider.test.ts‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -434,11 +434,23 @@ it.effect.each([
434434
merged_at: null,
435435
labels: [],
436436
};
437+
const requests: string[] = [];
437438
return Effect.gen(function* () {
438439
const provider = yield* ForgejoPullRequestProvider.make;
439440
const readSummary = provider.getChangeRequestSummary;
440441
if (readSummary === undefined) return yield* Effect.die("summary read missing");
442+
const readPreview = provider.getChangeRequestPreview;
443+
if (readPreview === undefined) return yield* Effect.die("preview read missing");
441444
const input = { cwd: "/repo", repository: "maria/project", host: "forgejo.test", number: 42 };
445+
const preview = yield* readPreview(input);
446+
assert.deepStrictEqual(requests, ["repos/maria/project/pulls/42"]);
447+
assert.strictEqual(preview.isDraft, isDraft);
448+
assert.strictEqual(preview.title, title);
449+
assert.strictEqual(preview.state, "open");
450+
assert.strictEqual(preview.number, 42);
451+
assert.strictEqual(preview.url, pr.html_url);
452+
assert.deepStrictEqual(preview.author, { login: "maria", name: null, avatarUrl: null });
453+
assert.strictEqual(preview.createdAt, "2026-09-16T00:00:00.000Z");
442454
const list = yield* provider.listChangeRequests({
443455
...input,
444456
state: "open",
@@ -458,6 +470,7 @@ it.effect.each([
458470
Effect.provide(
459471
Layer.mock(ForgejoCli.ForgejoCli)({
460472
api: (input) => {
473+
requests.push(input.path);
461474
const [path, query] = input.path.split("?");
462475
let response: unknown;
463476
switch (path) {

‎packages/source-control-gitcafe/src/server/GitCafePullRequestProvider.test.ts‎

Lines changed: 20 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -456,12 +456,31 @@ describe("GitCafePullRequestProvider", () => {
456456
);
457457
return Effect.gen(function* () {
458458
const provider = yield* GitCafePullRequestProvider.make;
459-
const summary = yield* provider.getChangeRequestSummary!({
459+
const input = {
460460
...target,
461461
host: "staging.git.cafe",
462+
};
463+
const preview = yield* provider.getChangeRequestPreview!(input);
464+
assert.deepInclude(preview, {
465+
number: 7,
466+
title: "Change",
467+
url: "https://staging.git.cafe/owner/repo/pulls/7",
468+
author: { login: "alice", name: null, avatarUrl: "https://staging.git.cafe/avatars/one" },
469+
state: "open",
470+
isDraft: false,
471+
createdAt: timestamp,
462472
});
473+
const summary = yield* provider.getChangeRequestSummary!(input);
463474
assert.strictEqual(summary.url, "https://staging.git.cafe/owner/repo/pulls/7");
464475
assert.isTrue(server.sent.every((request) => request.host === "staging.git.cafe"));
476+
assert.deepStrictEqual(
477+
server.sent.map((request) => `${request.method} ${request.path}`),
478+
[
479+
"GET /repos/owner/repo/pulls/7",
480+
"GET /repos/owner/repo/pulls/7",
481+
"GET /repos/owner/repo/pulls/7/changes",
482+
],
483+
);
465484
}).pipe(Effect.provide(server.layer));
466485
});
467486

‎packages/source-control-gitcafe/src/server/GitCafePullRequestProvider.ts‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -860,6 +860,10 @@ export const make = Effect.gen(function* () {
860860
};
861861
},
862862
),
863+
getChangeRequestPreview: (input) =>
864+
readPull("getChangeRequestPreview", input).pipe(
865+
Effect.map((pull) => Json.toChangeRequest(pull, input)),
866+
),
863867
getChangeRequestSummary: Effect.fn("GitCafePullRequestProvider.getChangeRequestSummary")(
864868
function* (input) {
865869
const pull = yield* readPull("getChangeRequestSummary", input);

‎packages/source-control-github/src/server/gitHubConditionalChecks.ts‎

Lines changed: 23 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,8 @@ const HeadSchema = Schema.Struct({
2323
});
2424
const decodeHead = Schema.decodeUnknownEffect(Schema.fromJsonString(HeadSchema));
2525

26+
class ChecksUnavailable extends Schema.TaggedError<ChecksUnavailable>()("ChecksUnavailable", {}) {}
27+
2628
const WorkflowRunSchema = Schema.Struct({
2729
id: Schema.Int,
2830
name: Schema.optional(Schema.NullOr(Schema.String)),
@@ -106,7 +108,7 @@ export const makeChecksRevalidator = Effect.gen(function* () {
106108
}),
107109
GitHubApiResponseError: (error) =>
108110
Effect.sync(() => {
109-
entry.supported = !UNSUPPORTED_STATUSES.has(error.status);
111+
entry.supported &&= !UNSUPPORTED_STATUSES.has(error.status);
110112
return null;
111113
}),
112114
}),
@@ -149,16 +151,26 @@ export const makeChecksRevalidator = Effect.gen(function* () {
149151
...(runsEndpoint === null ? [] : [runsEndpoint]),
150152
];
151153
const runPages: Array<string> = [];
152-
for (const endpoint of endpoints) {
153-
for (let page = 1; ; page++) {
154-
if (page > 100) return yield* fail(200);
155-
const paged = `${endpoint}${endpoint.includes("?") ? "&" : "?"}per_page=100&page=${page}`;
156-
const next = yield* get(paged);
157-
if (next === null) return yield* read;
158-
if (endpoint === runsEndpoint) runPages.push(paged);
159-
if (!next) break;
160-
}
161-
}
154+
// Each endpoint has its own cursor; only pages within one endpoint depend on each other.
155+
// An unavailable endpoint interrupts the others so the fallback read starts at once.
156+
const available = yield* Effect.forEach(
157+
endpoints,
158+
Effect.fn("gitHubConditionalChecks.revalidateEndpoint")(function* (endpoint) {
159+
for (let page = 1; ; page++) {
160+
if (page > 100) return yield* fail(200);
161+
const paged = `${endpoint}${endpoint.includes("?") ? "&" : "?"}per_page=100&page=${page}`;
162+
const next = yield* get(paged);
163+
if (next === null) return yield* new ChecksUnavailable();
164+
if (endpoint === runsEndpoint) runPages.push(paged);
165+
if (!next) return;
166+
}
167+
}),
168+
{ concurrency: 3, discard: true },
169+
).pipe(
170+
Effect.as(true),
171+
Effect.catchTags({ ChecksUnavailable: () => Effect.succeed(false) }),
172+
);
173+
if (!available) return yield* read;
162174
const now = yield* Clock.currentTimeMillis;
163175
if (entry.value !== null && now - entry.readAt < 5 * 60_000) return entry.value;
164176
const pages = runPages.map((endpoint) =>

‎packages/source-control-gitlab/src/server/GitLabPullRequestProvider.test.ts‎

Lines changed: 20 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
import { describe, expect, it } from "@effect/vitest";
1+
import { assert, describe, expect, it } from "@effect/vitest";
22
import * as Effect from "effect/Effect";
33
import * as Layer from "effect/Layer";
44

@@ -65,6 +65,25 @@ describe("getChangeRequest base freshness", () => {
6565
reviewerIds: [],
6666
};
6767

68+
it.effect.each(["getChangeRequestPreview", "getChangeRequestSummary"] as const)(
69+
"%s preserves merge request fields without fetching project settings",
70+
(operation) =>
71+
Effect.gen(function* () {
72+
const provider = yield* make.pipe(
73+
Effect.provide(
74+
Layer.mock(GitLabPullRequestCli.GitLabPullRequestCli)({
75+
getMergeRequestDetail: () => Effect.succeed(detail),
76+
}),
77+
),
78+
);
79+
const read = provider[operation];
80+
assert.isDefined(read);
81+
expect(
82+
yield* read({ cwd: "/w", repository: "acme/web", host: "gitlab.com", number: 7 }),
83+
).toEqual(detail);
84+
}),
85+
);
86+
6887
const readWith = (divergence: { readonly divergedCommits?: number }) =>
6988
Effect.gen(function* () {
7089
const provider = yield* make;

0 commit comments

Comments
 (0)