Skip to content

Commit 545c871

Browse files
donjor-agent[bot]rsi-pr-agent
authored andcommitted
fix(pr): stop turn refreshes from rereading review activity (#1771)
Squashes: - 0fb81ef fix(pr): stop turn refreshes from rereading review activity (#1771) (#1771) - f0ed1cd fixup! fix(pr): stop turn refreshes from rereading review activity (#1771) (#1771) - 8db57fe fix(pr): stop turn refreshes from rereading review activity (#1771) (#1771) - ba7b379 fixup! fix(pr): stop turn refreshes from rereading review activity (#1771) (#1771) Fork-Domain: upstream-fixes Fork-Tier: bugfix Fork-Upstreamable: yes
1 parent 4b03981 commit 545c871

14 files changed

Lines changed: 299 additions & 11 deletions

‎apps/server/src/auth/RpcAuthorization.fork.test.ts‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,14 @@ import { describe, expect, it } from "@effect/vitest";
44
import { requiredScopeForRpcMethod } from "./RpcAuthorization.ts";
55

66
describe("RPC authorization scopes", () => {
7+
it("keeps fork activity notifications behind the same read scope as turn refreshes", () => {
8+
expect(requiredScopeForRpcMethod(WS_METHODS.pullRequestsSubscribeActivityRefreshesFork)).toBe(
9+
AuthOrchestrationReadScope,
10+
);
11+
expect(requiredScopeForRpcMethod(WS_METHODS.pullRequestsSubscribeRefreshes)).toBe(
12+
AuthOrchestrationReadScope,
13+
);
14+
});
715
it("reads GitHub issues without granting mutation access", () => {
816
expect(requiredScopeForRpcMethod(WS_METHODS.githubIssuesList)).toBe(AuthOrchestrationReadScope);
917
expect(requiredScopeForRpcMethod(WS_METHODS.githubIssuesDetail)).toBe(

‎apps/server/src/auth/RpcAuthorization.ts‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -145,6 +145,7 @@ export const RPC_REQUIRED_SCOPES = {
145145
[WS_METHODS.pullRequestsSubscribeRefreshes]: AuthOrchestrationReadScope,
146146
[WS_METHODS.pullRequestsReviewerCandidates]: AuthOrchestrationReadScope,
147147
[WS_METHODS.pullRequestsLabelCandidates]: AuthOrchestrationReadScope,
148+
[WS_METHODS.pullRequestsSubscribeActivityRefreshesFork]: AuthOrchestrationReadScope, // fork-hook: upstream-fixes/pr-activity-refresh-rpc-auth
148149
[WS_METHODS.githubIssuesList]: AuthOrchestrationReadScope, // fork-hook: github-issues/rpc-auth-list
149150
[WS_METHODS.githubIssuesDetail]: AuthOrchestrationReadScope, // fork-hook: github-issues/rpc-auth-detail
150151
[WS_METHODS.githubIssuesLinkedThreads]: AuthOrchestrationReadScope, // fork-hook: github-issues/rpc-auth-linked-threads

‎apps/server/src/observability/RpcInstrumentation.ts‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -136,6 +136,7 @@ const RPC_AGGREGATES = {
136136
[WS_METHODS.pullRequestsRequestReviewers]: "pull-requests",
137137
[WS_METHODS.pullRequestsLabelCandidates]: "pull-requests",
138138
[WS_METHODS.pullRequestsSetLabels]: "pull-requests",
139+
[WS_METHODS.pullRequestsSubscribeActivityRefreshesFork]: "pull-requests", // fork-hook: upstream-fixes/pr-activity-refresh-rpc-aggregate
139140
[WS_METHODS.pullRequestsCreateAttachmentUploadUrl]: "pull-requests", // fork-hook: upstream-fixes/pr-attachment-rpc-aggregates
140141
[WS_METHODS.pullRequestsUploadAttachment]: "pull-requests", // fork-hook: upstream-fixes/pr-attachment-rpc-aggregates
141142
[WS_METHODS.githubIssuesList]: "github-issues", // fork-hook: github-issues/rpc-aggregates

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

Lines changed: 40 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@ import {
1313
} from "@t3tools/contracts";
1414
import { DEFAULT_SERVER_SETTINGS } from "@t3tools/contracts/settings";
1515
import * as Option from "effect/Option";
16+
import * as Stream from "effect/Stream";
1617
import * as ProjectService from "../project/ProjectService.ts";
1718
import * as RepositoryIdentityResolver from "../project/RepositoryIdentityResolver.ts";
1819
import * as ServerSettingsService from "../serverSettings.ts";
@@ -52,7 +53,7 @@ function project(input: {
5253
remoteName: "origin",
5354
remoteUrl: `https://${host}/${input.repository}.git`,
5455
},
55-
provider: input.provider ?? "github",
56+
provider: SourceControlProviderKind.make(input.provider ?? "github"),
5657
displayName: input.repository,
5758
},
5859
}
@@ -172,6 +173,44 @@ function makeService(input: {
172173
),
173174
);
174175
}
176+
it.effect(
177+
"keeps activity's revision through turns but refreshes it for edits and explicit refreshes",
178+
() =>
179+
Effect.gen(function* () {
180+
const ref = { projectId: "p1" as ProjectId, repository: "acme/web", number: 1 };
181+
const service = yield* makeService({
182+
projects: [
183+
project({ id: "p1", title: "web", workspaceRoot: "/w", repository: ref.repository }),
184+
],
185+
providers: [fakeProvider(SourceControlProviderKind.make("github"))],
186+
});
187+
const revision = (activity: boolean) =>
188+
Stream.runHead(
189+
activity ? service.subscribeActivityRefreshesFork : service.subscribeRefreshes,
190+
).pipe(Effect.map(Option.getOrThrow));
191+
192+
yield* service.invalidate({ reference: ref }, { notifyReaders: true });
193+
let activityRevision = yield* revision(true);
194+
assert.strictEqual(yield* revision(false), activityRevision);
195+
for (let turn = 0; turn < 20; turn++) yield* service.refreshAfterTurn(ref.projectId);
196+
assert.strictEqual(yield* revision(true), activityRevision);
197+
assert.isAbove(yield* revision(false), activityRevision);
198+
199+
for (const edit of [
200+
service.comment({ ...ref, body: "new comment" }),
201+
service.runAction({ ...ref, action: "close" }),
202+
service.invalidate({}, { notifyReaders: true }),
203+
]) {
204+
yield* edit;
205+
const next = yield* revision(true);
206+
assert.isAbove(next, activityRevision);
207+
activityRevision = next;
208+
yield* service.refreshAfterTurn(ref.projectId);
209+
assert.strictEqual(yield* revision(true), activityRevision);
210+
}
211+
}),
212+
);
213+
175214
/** A row as a host that reads several repositories at once hands it over. */
176215
it.effect("uses the requested project to read another repository on the same host", () =>
177216
Effect.gen(function* () {

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

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ import * as Option from "effect/Option";
1414
import * as Schema from "effect/Schema";
1515
import type * as Scope from "effect/Scope";
1616
import * as Stream from "effect/Stream";
17-
import * as SubscriptionRef from "effect/SubscriptionRef";
17+
import { makePullRequestRefreshesFork } from "./pullRequestRefreshes.fork.ts"; // fork-hook: upstream-fixes/pr-activity-refresh-import
1818
import {
1919
type AttachmentCreateUploadUrlResult,
2020
PullRequestOperationError,
@@ -219,6 +219,7 @@ export class PullRequestService extends Context.Service<
219219
input: PullRequestReportStateInput,
220220
) => Effect.Effect<void, PullRequestError>;
221221
readonly subscribeRefreshes: Stream.Stream<number>;
222+
readonly subscribeActivityRefreshesFork: Stream.Stream<number>; // fork-hook: upstream-fixes/pr-activity-refresh-service
222223
readonly refreshAfterTurn: (projectId: ProjectId) => Effect.Effect<void>;
223224
readonly detail: (input: PullRequestRef) => Effect.Effect<PullRequestDetail, PullRequestError>;
224225
readonly preview: (
@@ -697,7 +698,7 @@ const observeRead = Effect.fnUntraced(function* <A, E, R>(read: Effect.Effect<A,
697698
export const make = Effect.gen(function* () {
698699
const mergedPullRequests = yield* PubSub.sliding<PullRequestMergeEvent>(64);
699700
const stateChanges = yield* PubSub.sliding<ThreadPullRequestKey>(64);
700-
const pullRequestRefreshes = yield* SubscriptionRef.make(0);
701+
const pullRequestRefreshes = yield* makePullRequestRefreshesFork; // fork-hook: upstream-fixes/pr-activity-refresh-state
701702
const registry = yield* PullRequestProviderRegistry.PullRequestProviderRegistry;
702703
const requirementOf: UnavailableRequirementOf = (kind) =>
703704
registry.get(kind)?.unavailableRequirement;
@@ -3519,7 +3520,7 @@ export const make = Effect.gen(function* () {
35193520
yield* Cache.invalidateAll(viewerFlights);
35203521
}
35213522
if (options?.notifyReaders) {
3522-
yield* SubscriptionRef.set(pullRequestRefreshes, ++epochCounter);
3523+
yield* pullRequestRefreshes.publish(++epochCounter); // fork-hook: upstream-fixes/pr-activity-refresh-invalidate
35233524
}
35243525
});
35253526

@@ -3537,7 +3538,7 @@ export const make = Effect.gen(function* () {
35373538
projectEpochs.set(projectId, listingsEpoch);
35383539
return readCache
35393540
.invalidate(`project:${projectId}`)
3540-
.pipe(Effect.andThen(SubscriptionRef.set(pullRequestRefreshes, listingsEpoch)));
3541+
.pipe(Effect.andThen(pullRequestRefreshes.publish(listingsEpoch, true))); // fork-hook: upstream-fixes/pr-activity-refresh-turn
35413542
});
35423543

35433544
const invalidatedByMutation =
@@ -3557,7 +3558,7 @@ export const make = Effect.gen(function* () {
35573558
}),
35583559
),
35593560
);
3560-
yield* SubscriptionRef.set(pullRequestRefreshes, listingsEpoch);
3561+
yield* pullRequestRefreshes.publish(listingsEpoch); // fork-hook: upstream-fixes/pr-activity-refresh-mutation
35613562
});
35623563
const runActionAndInvalidate: PullRequestService["Service"]["runAction"] = Effect.fn(
35633564
"PullRequestService.runActionAndInvalidate",
@@ -3569,7 +3570,7 @@ export const make = Effect.gen(function* () {
35693570
);
35703571
bumpRefEpoch({ ...ref, repository });
35713572
listingsEpoch = ++epochCounter;
3572-
yield* SubscriptionRef.set(pullRequestRefreshes, listingsEpoch);
3573+
yield* pullRequestRefreshes.publish(listingsEpoch); // fork-hook: upstream-fixes/pr-activity-refresh-action
35733574
if (input.action === "merge") {
35743575
// A successful merge action can merely enqueue the PR or enable auto-merge.
35753576
const confirmed = yield* summaryUncached({ ...input, repository }).pipe(
@@ -3727,9 +3728,8 @@ export const make = Effect.gen(function* () {
37273728
Effect.map((subscription) => Stream.fromSubscription(subscription)),
37283729
),
37293730
reportState,
3730-
subscribeRefreshes: SubscriptionRef.changes(pullRequestRefreshes).pipe(
3731-
Stream.filter((revision) => revision > 0),
3732-
),
3731+
subscribeRefreshes: pullRequestRefreshes.all, // fork-hook: upstream-fixes/pr-activity-refresh-stream
3732+
subscribeActivityRefreshesFork: pullRequestRefreshes.activity, // fork-hook: upstream-fixes/pr-activity-refresh-activity-stream
37333733
refreshAfterTurn,
37343734
detail: credentialCached(detail),
37353735
checks: credentialCached((input) => Cache.get(checksCache, refCacheKey(input))),
Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
import * as Effect from "effect/Effect";
2+
import * as Stream from "effect/Stream";
3+
import * as SubscriptionRef from "effect/SubscriptionRef";
4+
5+
/** Activity is expensive: turns refresh status, but only edits refresh mounted activity. */
6+
export const makePullRequestRefreshesFork = Effect.gen(function* () {
7+
const revisions = yield* SubscriptionRef.make({ all: 0, activity: 0 });
8+
const changes = (field: "all" | "activity") =>
9+
SubscriptionRef.changes(revisions).pipe(
10+
Stream.map((value) => value[field]),
11+
Stream.changes,
12+
Stream.filter((revision) => revision > 0),
13+
);
14+
return {
15+
all: changes("all"),
16+
activity: changes("activity"),
17+
publish: (revision: number, afterTurn = false) =>
18+
SubscriptionRef.update(revisions, (previous) => ({
19+
all: revision,
20+
activity: afterTurn ? previous.activity : revision,
21+
})),
22+
};
23+
});

‎apps/server/src/wsRpcHandlers.fork.ts‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,8 @@ export const wsRpcHandlersLayerFork = WsRpcGroupFork.toLayer(
3535
"pullRequests.createAttachmentUploadUrl": (input) =>
3636
pullRequests.createAttachmentUploadUrl(input),
3737
"pullRequests.uploadAttachment": (input) => pullRequests.uploadAttachment(input),
38+
"pullRequests.subscribeActivityRefreshesFork": () =>
39+
pullRequests.subscribeActivityRefreshesFork,
3840
});
3941
}),
4042
);

‎packages/client-runtime/src/rpc/client.ts‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -49,6 +49,7 @@ export type EnvironmentRpcTag = keyof WsRpcProtocolClient & string;
4949
type RpcMethod<TTag extends EnvironmentRpcTag> = WsRpcProtocolClient[TTag];
5050

5151
export type EnvironmentSubscriptionRpcTag =
52+
| typeof WS_METHODS.pullRequestsSubscribeActivityRefreshesFork // fork-hook: upstream-fixes/pr-activity-refresh-rpc-client-type
5253
| typeof WS_METHODS.codexAuthCallbackSubscribe
5354
| typeof WS_METHODS.providerAuthSubscribe
5455
| typeof WS_METHODS.providerInstallSubscribe
Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
import { WS_METHODS } from "@t3tools/contracts";
2+
import type { Atom } from "effect/reactivity";
3+
import type { EnvironmentRegistry } from "../connection/registry.ts";
4+
import { createEnvironmentRpcSubscriptionAtomFamily } from "./runtime.ts";
5+
6+
/** Kept apart from turn refreshes, which never signal expensive activity reads. */
7+
export function createPullRequestActivityRefreshAtomFamilyFork<R, E>(
8+
runtime: Atom.AtomRuntime<EnvironmentRegistry | R, E>,
9+
) {
10+
return createEnvironmentRpcSubscriptionAtomFamily(runtime, {
11+
label: "environment-data:pull-requests:activity-refreshes",
12+
tag: WS_METHODS.pullRequestsSubscribeActivityRefreshesFork,
13+
});
14+
}
Lines changed: 172 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,172 @@
1+
import { EnvironmentId, ProjectId, WS_METHODS } from "@t3tools/contracts";
2+
import { expect, it } from "@effect/vitest";
3+
import { vi } from "vite-plus/test";
4+
import { RpcClientError } from "effect/rpc";
5+
import * as Effect from "effect/Effect";
6+
import * as Latch from "effect/Latch";
7+
import * as Layer from "effect/Layer";
8+
import * as Option from "effect/Option";
9+
import * as Stream from "effect/Stream";
10+
import * as SubscriptionRef from "effect/SubscriptionRef";
11+
import * as TestClock from "effect/testing/TestClock";
12+
import { Atom, AtomRegistry } from "effect/reactivity";
13+
import type { PreparedConnection, SupervisorConnectionState } from "../connection/model.ts";
14+
import type { ConnectionCatalogEntry } from "../connection/catalog.ts";
15+
import { AVAILABLE_CONNECTION_STATE, PrimaryConnectionTarget } from "../connection/model.ts";
16+
import * as EnvironmentRegistry from "../connection/registry.ts";
17+
import * as EnvironmentSupervisor from "../connection/supervisor.ts";
18+
import type { RpcSession } from "../rpc/session.ts";
19+
import type { WsRpcProtocolClient } from "../rpc/protocol.ts";
20+
import * as PullRequestDiffLoader from "./pullRequestDiffHttp.ts";
21+
import { createPullRequestEnvironmentAtoms } from "./pullRequests.ts";
22+
23+
it.effect.each(["current", "unknown RPC", "missing method"] as const)(
24+
"isolates activity from turns and preserves reads on a %s server",
25+
(server) =>
26+
Effect.scoped(
27+
Effect.gen(function* () {
28+
vi.useFakeTimers({ toFake: ["setTimeout", "clearTimeout", "Date"] });
29+
yield* Effect.addFinalizer(() => Effect.sync(() => vi.useRealTimers()));
30+
const turns = yield* SubscriptionRef.make(0);
31+
const edits = yield* SubscriptionRef.make(0);
32+
let reads = 0;
33+
let detailReads = 0;
34+
let detailRefreshed = Latch.makeUnsafe();
35+
const activityRead = Latch.makeUnsafe();
36+
const client = {
37+
[WS_METHODS.pullRequestsSubscribeRefreshes]: () =>
38+
SubscriptionRef.changes(turns).pipe(Stream.filter((revision) => revision > 0)),
39+
...(server === "missing method"
40+
? {}
41+
: {
42+
[WS_METHODS.pullRequestsSubscribeActivityRefreshesFork]: () =>
43+
server === "unknown RPC"
44+
? Stream.fail(
45+
new RpcClientError.RpcClientError({
46+
reason: new RpcClientError.RpcClientDefect({
47+
message:
48+
"Unknown request tag: pullRequests.subscribeActivityRefreshesFork",
49+
cause: new Error("Unknown request tag"),
50+
}),
51+
}),
52+
)
53+
: SubscriptionRef.changes(edits).pipe(
54+
Stream.filter((revision) => revision > 0),
55+
),
56+
}),
57+
[WS_METHODS.pullRequestsActivity]: () =>
58+
Effect.sync(() => {
59+
reads++;
60+
if (reads === 2) activityRead.openUnsafe();
61+
return {
62+
author: null,
63+
reviewers: [],
64+
comments: [],
65+
commentCount: reads,
66+
commentsTruncated: false,
67+
reviewThreads: [],
68+
commits: [],
69+
reactions: [],
70+
};
71+
}),
72+
[WS_METHODS.pullRequestsDetail]: () =>
73+
Effect.sync(() => {
74+
detailReads++;
75+
if (detailReads > 1) detailRefreshed.openUnsafe();
76+
return { state: "open" };
77+
}),
78+
} as unknown as WsRpcProtocolClient;
79+
const target = new PrimaryConnectionTarget({
80+
environmentId: EnvironmentId.make("environment-1"),
81+
label: "Test",
82+
httpBaseUrl: "https://example.test",
83+
wsBaseUrl: "wss://example.test",
84+
});
85+
const supervisor = EnvironmentSupervisor.EnvironmentSupervisor.of({
86+
target,
87+
state: yield* SubscriptionRef.make<SupervisorConnectionState>({
88+
...AVAILABLE_CONNECTION_STATE,
89+
desired: true,
90+
network: "online",
91+
phase: "connected",
92+
attempt: 1,
93+
generation: 1,
94+
}),
95+
session: yield* SubscriptionRef.make<Option.Option<RpcSession>>(
96+
Option.some({
97+
client,
98+
inboundFrames: Effect.succeed(0),
99+
ready: Effect.void,
100+
probe: Effect.void,
101+
closed: Effect.never,
102+
initialConfig: Effect.never,
103+
subscribeServerConfig: () => Stream.empty,
104+
} satisfies RpcSession),
105+
),
106+
prepared: yield* SubscriptionRef.make(Option.none<PreparedConnection>()),
107+
connect: Effect.void,
108+
disconnect: Effect.void,
109+
retryNow: Effect.void,
110+
});
111+
const registryService = EnvironmentRegistry.EnvironmentRegistry.of({
112+
entries: yield* SubscriptionRef.make<ReadonlyMap<EnvironmentId, ConnectionCatalogEntry>>(
113+
new Map([[target.environmentId, { target, profile: Option.none(), enabled: true }]]),
114+
),
115+
run: (_id, effect) =>
116+
Effect.provideService(effect, EnvironmentSupervisor.EnvironmentSupervisor, supervisor),
117+
runStream: (_id, stream) =>
118+
Stream.provideService(stream, EnvironmentSupervisor.EnvironmentSupervisor, supervisor),
119+
followStream: (_id, stream) =>
120+
Stream.provideService(stream, EnvironmentSupervisor.EnvironmentSupervisor, supervisor),
121+
} as EnvironmentRegistry.EnvironmentRegistry["Service"]);
122+
const runtime = Atom.runtime(
123+
Layer.mergeAll(
124+
Layer.succeed(EnvironmentRegistry.EnvironmentRegistry, registryService),
125+
Layer.mock(PullRequestDiffLoader.PullRequestDiffLoader)({
126+
load: () => Effect.die("unused"),
127+
}),
128+
),
129+
);
130+
const atoms = createPullRequestEnvironmentAtoms(runtime);
131+
const registry = yield* Effect.acquireRelease(Effect.sync(AtomRegistry.make), (value) =>
132+
Effect.sync(() => value.dispose()),
133+
);
134+
const ref = {
135+
environmentId: target.environmentId,
136+
input: { projectId: ProjectId.make("project-1"), repository: "acme/web", number: 1 },
137+
};
138+
const activity = atoms.activity(ref);
139+
const detail = atoms.detail(ref);
140+
let unmountActivity = registry.mount(activity);
141+
yield* Effect.addFinalizer(() => Effect.sync(() => unmountActivity()));
142+
const unmountDetail = registry.mount(detail);
143+
yield* Effect.addFinalizer(() => Effect.sync(unmountDetail));
144+
yield* AtomRegistry.getResult(registry, activity, { suspendOnWaiting: true });
145+
yield* AtomRegistry.getResult(registry, detail, { suspendOnWaiting: true });
146+
expect(reads).toBe(1);
147+
148+
// Older than the server activity TTL: a turn must still cause no activity RPC.
149+
vi.advanceTimersByTime(61_000);
150+
yield* TestClock.adjust("61 seconds");
151+
for (let turn = 1; turn <= 3; turn++) {
152+
detailRefreshed = Latch.makeUnsafe();
153+
yield* SubscriptionRef.set(turns, turn);
154+
yield* detailRefreshed.await;
155+
expect(reads).toBe(1);
156+
}
157+
if (server === "current") yield* SubscriptionRef.set(edits, 1);
158+
else registry.refresh(activity); // Missing notifications never prevent explicit reads.
159+
yield* activityRead.await;
160+
yield* AtomRegistry.getResult(registry, activity, { suspendOnWaiting: true });
161+
expect(reads).toBe(2);
162+
163+
unmountActivity();
164+
yield* Effect.yieldNow;
165+
vi.advanceTimersByTime(6 * 60_000);
166+
yield* TestClock.adjust("6 minutes");
167+
unmountActivity = registry.mount(activity);
168+
yield* AtomRegistry.getResult(registry, activity, { suspendOnWaiting: true });
169+
expect(reads).toBe(3);
170+
}),
171+
),
172+
);

0 commit comments

Comments
 (0)