Repository navigation
Expand file tree
/
Copy pathpullRequestViewedFiles.ts
More file actions
367 lines (347 loc) · 14 KB
/
Copy pathpullRequestViewedFiles.ts
File metadata and controls
367 lines (347 loc) · 14 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
import * as Clock from "effect/Clock";
import * as DateTime from "effect/DateTime";
import * as Duration from "effect/Duration";
import * as Effect from "effect/Effect";
import * as Semaphore from "effect/Semaphore";
import {
PullRequestOperationError,
type PullRequestFilesViewedResult,
type PullRequestRef,
type PullRequestSetFilesViewedInput,
} from "@t3tools/contracts";
import type * as PullRequestFilesViewed from "../persistence/PullRequestFilesViewed.ts";
import type {
ProviderFileRevisions,
PullRequestProviderError,
} from "@t3tools/source-control-core/server/PullRequestProvider";
import type { PullRequestError, SupportedProject } from "./PullRequestService.ts";
const FILE_REVISIONS_CACHE_TTL = Duration.seconds(60);
const FILE_REVISIONS_STALE_WINDOW = Duration.minutes(10);
const FILE_REVISIONS_CACHE_CAPACITY = 64;
/**
* Bounds a single scope, not how many scopes are held: a reader ticking one file after
* another renews the same scope and grows it without limit otherwise.
*/
const MAX_FILE_REVISION_PATHS = 1_000;
interface FileRevisionsDependencies {
readonly runFork: (effect: Effect.Effect<void>) => unknown;
readonly refEpoch: (ref: PullRequestRef) => number;
readonly fileRevisionsEpoch: () => number;
readonly toPullRequestError: (
operation: string,
) => (error: PullRequestProviderError) => PullRequestError;
}
const makeFileRevisions = (dependencies: FileRevisionsDependencies) => {
const { runFork, refEpoch, fileRevisionsEpoch, toPullRequestError } = dependencies;
interface HeldFileRevisions {
readonly at: number;
readonly asked: ReadonlySet<string>;
readonly revisions: ReadonlyMap<string, string>;
}
const heldFileRevisions = new Map<string, HeldFileRevisions>();
const refreshingFileRevisions = new Set<string>();
/**
* Spelled from the project rather than the reference, since a reference arrives however
* the client spelled it while the epoch is bumped against the remote's own spelling.
*/
const fileRevisionsKey = (project: SupportedProject, ref: PullRequestRef) =>
[
refEpoch({ ...ref, host: project.host, repository: project.repository }),
fileRevisionsEpoch(),
ref.projectId,
project.repository.trim().toLowerCase(),
ref.number,
].join(" ");
const recordFileRevisions = (
key: string,
paths: ReadonlyArray<string>,
answer: ProviderFileRevisions,
) =>
Effect.map(Clock.currentTimeMillis, (at) => {
const held = heldFileRevisions.get(key);
const carried =
held !== undefined && at - held.at <= Duration.toMillis(FILE_REVISIONS_STALE_WINDOW)
? held
: null;
const revisions = new Map(carried?.revisions ?? []);
const asked = new Set(carried?.asked ?? []);
const learned = answer.complete === true ? [...answer.revisions.keys(), ...paths] : paths;
for (const path of learned) {
asked.delete(path);
asked.add(path);
const revision = answer.revisions.get(path);
if (revision !== undefined) {
revisions.delete(path);
revisions.set(path, revision);
}
}
for (const path of asked) {
if (asked.size <= MAX_FILE_REVISION_PATHS) break;
asked.delete(path);
revisions.delete(path);
}
heldFileRevisions.delete(key);
if (heldFileRevisions.size >= FILE_REVISIONS_CACHE_CAPACITY) {
const oldest = heldFileRevisions.keys().next().value;
if (oldest !== undefined) heldFileRevisions.delete(oldest);
}
// The entry is only as fresh as its oldest revision: stamping it with `now` on a partial
// answer would let an old revision ride past the point it should have been re-read.
const stamped = [...revisions.keys()].every((path) => answer.revisions.has(path))
? at
: (carried?.at ?? at);
heldFileRevisions.set(key, { at: stamped, asked, revisions });
return revisions;
});
const heldFileRevisionsFor = (key: string, paths: ReadonlyArray<string>, now: number) => {
const held = heldFileRevisions.get(key);
if (held === undefined) return null;
heldFileRevisions.delete(key);
heldFileRevisions.set(key, held);
if (now - held.at > Duration.toMillis(FILE_REVISIONS_STALE_WINDOW)) return null;
return paths.every((path) => held.asked.has(path)) ? held : null;
};
/**
* `held` answers from a stale value and refetches off the critical path, since a badge a
* moment behind beats a page that won't paint until the host answers; `fresh` is for the
* press itself, which must not store a revision the head already moved off.
*/
const fileRevisionsOf = (
project: SupportedProject,
ref: PullRequestRef,
paths: ReadonlyArray<string>,
operation: string,
freshness: "held" | "fresh" = "held",
): Effect.Effect<ReadonlyMap<string, string> | null, PullRequestError> => {
const read = project.api.getFileRevisions;
if (read === undefined) return Effect.succeed(null);
// Suspended, so a held answer costs the host nothing: a provider is free to do its work as
// the request is built rather than as the effect is run.
const fetch = Effect.suspend(() => {
const key = fileRevisionsKey(project, ref);
return read({
cwd: project.project.workspaceRoot,
repository: project.repository,
host: project.host,
number: ref.number,
paths,
}).pipe(
Effect.mapError(toPullRequestError(operation)),
Effect.flatMap((answer) => recordFileRevisions(key, paths, answer)),
);
});
return Effect.flatMap(Clock.currentTimeMillis, (now) => {
const key = fileRevisionsKey(project, ref);
const held = heldFileRevisionsFor(key, paths, now);
if (held === null) return fetch;
if (now - held.at <= Duration.toMillis(FILE_REVISIONS_CACHE_TTL))
return Effect.succeed(held.revisions);
if (freshness === "fresh") return fetch;
if (refreshingFileRevisions.has(key)) return Effect.succeed(held.revisions);
// Its own fiber rather than a child: the caller has been answered and is gone before this
// lands.
return Effect.sync(() => {
refreshingFileRevisions.add(key);
runFork(
Effect.ignore(fetch).pipe(
Effect.ensuring(Effect.sync(() => refreshingFileRevisions.delete(key))),
),
);
}).pipe(Effect.as(held.revisions));
});
};
return { fileRevisionsOf } as const;
};
export interface Dependencies extends FileRevisionsDependencies {
readonly filesViewedStore: PullRequestFilesViewed.PullRequestFilesViewedRepository["Service"];
readonly requireProject: (
ref: PullRequestRef,
) => Effect.Effect<SupportedProject, PullRequestError>;
readonly requiredViewerOf: (
project: SupportedProject,
operation: string,
) => Effect.Effect<string | null, PullRequestError>;
}
// A plain factory rather than a `Context.Service` (against the preference in
// `.repos/effect-smol/LLMS.md`): the held revisions, refresh set, and write gates are only correct
// at one instance per service, and a layer provided at two points would give two of each behind
// one epoch counter.
export const make = (dependencies: Dependencies) => {
const { filesViewedStore, requireProject, requiredViewerOf, toPullRequestError } = dependencies;
const { fileRevisionsOf } = makeFileRevisions(dependencies);
const filesViewedScope = (project: SupportedProject, number: number, viewer: string | null) => ({
provider: project.api.kind,
host: project.host,
repository: project.remote,
number,
viewer: viewer ?? "",
});
const toFilesViewedStoreError = (operation: string) => (cause: unknown) =>
new PullRequestOperationError({
operation,
detail: "This environment could not reach its record of which files you have seen.",
cause,
});
const environmentFilesViewed = Effect.fn("pullRequestViewedFiles.environmentFilesViewed")(
function* (
project: SupportedProject,
ref: PullRequestRef,
): Effect.fn.Return<PullRequestFilesViewedResult, PullRequestError> {
const viewer = yield* requiredViewerOf(project, "filesViewed");
const held = yield* filesViewedStore
.list(filesViewedScope(project, ref.number, viewer))
.pipe(Effect.mapError(toFilesViewedStoreError("filesViewed")));
const marks = held.files;
if (marks.length === 0) return { files: [], truncated: held.truncated };
const revisions = yield* fileRevisionsOf(
project,
ref,
marks.map((mark) => mark.path),
"filesViewed",
).pipe(
Effect.catch((error) =>
Effect.logWarning("reporting viewed files without what the head has of them", {
operation: "filesViewed",
reason: error._tag,
}).pipe(Effect.as(null)),
),
);
return {
files: marks.map((mark) => {
if (mark.revision === null) return { path: mark.path, state: "viewed" as const };
const revision = revisions?.get(mark.path);
return {
path: mark.path,
state:
revision === undefined || revision === mark.revision
? ("viewed" as const)
: ("dismissed" as const),
};
}),
truncated: held.truncated,
};
},
);
/**
* A tick's host round trip is slower than an untick's, so unordered presses could finish
* out of order and leave a stale tick standing over a later untick.
*/
const filesViewedGates = new Map<
string,
{ readonly gate: Semaphore.Semaphore; pending: number }
>();
const inFilesViewedOrder = (
project: SupportedProject,
number: number,
write: Effect.Effect<void, PullRequestError>,
) =>
// Suspended rather than generated, so finding the gate, putting it in and taking a place in
// its queue are one step: yielding for `Semaphore.make` between the lookup and the insert
// lets two presses each make a gate of their own and neither wait on the other.
Effect.suspend(() => {
const key = `${project.project.id} ${project.remote} ${number}`;
const held = filesViewedGates.get(key);
const entry = held ?? { gate: Semaphore.makeUnsafe(1), pending: 0 };
if (held === undefined) filesViewedGates.set(key, entry);
entry.pending += 1;
return entry.gate
.withPermits(1)(write)
.pipe(
Effect.ensuring(
Effect.sync(() => {
entry.pending -= 1;
if (entry.pending === 0) filesViewedGates.delete(key);
}),
),
);
});
const environmentSetFilesViewed = Effect.fn("pullRequestViewedFiles.environmentSetFilesViewed")(
function* (
project: SupportedProject,
input: PullRequestSetFilesViewedInput,
): Effect.fn.Return<void, PullRequestError> {
const viewer = yield* requiredViewerOf(project, "setFilesViewed");
const cleared = input.files.filter((file) => file.viewed).map((file) => file.path);
const revisions =
cleared.length === 0
? null
: yield* fileRevisionsOf(project, input, cleared, "setFilesViewed", "fresh").pipe(
Effect.catch((error) =>
Effect.logWarning("recording viewed files without what the head has of them", {
operation: "setFilesViewed",
reason: error._tag,
}).pipe(Effect.as(null)),
),
);
const viewedAt = DateTime.formatIso(yield* DateTime.now);
yield* filesViewedStore
.set({
...filesViewedScope(project, input.number, viewer),
// A path left out of the answer stores with no baseline, not the empty revision, since
// the empty revision is itself an answer and would misreport the file once it turns
// out to have a version after all.
files: input.files.map((file) => ({
path: file.path,
revision: revisions?.get(file.path) ?? null,
viewed: file.viewed,
})),
viewedAt,
})
.pipe(Effect.mapError(toFilesViewedStoreError("setFilesViewed")));
},
);
const filesViewed = (input: PullRequestRef) =>
requireProject(input).pipe(
Effect.flatMap((project): Effect.Effect<PullRequestFilesViewedResult, PullRequestError> => {
const read = project.api.getFilesViewed;
if (project.api.capabilities.viewedFiles === "host" && read) {
return read({
cwd: project.project.workspaceRoot,
repository: project.repository,
host: project.host,
number: input.number,
}).pipe(Effect.mapError(toPullRequestError("filesViewed")));
}
if (project.api.capabilities.viewedFiles === "environment") {
return environmentFilesViewed(project, input);
}
return Effect.fail(
new PullRequestOperationError({
operation: "filesViewed",
detail: "This host does not track which files a reader has seen.",
}),
);
}),
);
const setFilesViewed = (
input: PullRequestSetFilesViewedInput,
): Effect.Effect<void, PullRequestError> =>
requireProject(input).pipe(
Effect.flatMap((project): Effect.Effect<void, PullRequestError> => {
const write = project.api.setFilesViewed;
if (project.api.capabilities.viewedFiles === "host" && write) {
return write({
cwd: project.project.workspaceRoot,
repository: project.repository,
host: project.host,
number: input.number,
files: input.files,
}).pipe(Effect.mapError(toPullRequestError("setFilesViewed")));
}
if (project.api.capabilities.viewedFiles === "environment") {
return inFilesViewedOrder(
project,
input.number,
environmentSetFilesViewed(project, input),
);
}
return Effect.fail(
new PullRequestOperationError({
operation: "setFilesViewed",
detail: "This host does not track which files a reader has seen.",
}),
);
}),
);
return { filesViewed, setFilesViewed };
};