Skip to content

Commit 54a5c51

Browse files
sanjaibalajeemaria-rcksjuliusmarminge
authored
fix(web): fall back to a readable server for shared repositories (#21530)
Co-authored-by: maria-rcks <[email protected]> Co-authored-by: Julius Marminge <[email protected]>
1 parent fd9b2c3 commit 54a5c51

11 files changed

Lines changed: 883 additions & 88 deletions

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

Lines changed: 168 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -905,6 +905,173 @@ it.effect("tells two hosts of one kind apart in the switcher and the filter", ()
905905
}),
906906
);
907907

908+
it.effect("retains an unavailable host's summary when it is the only queried host", () =>
909+
Effect.gen(function* () {
910+
for (const reason of ["missing-tool", "unauthenticated"] as const) {
911+
const service = yield* makeService({
912+
projects: [
913+
project({
914+
id: "p1",
915+
title: "t3code",
916+
workspaceRoot: "/a",
917+
repository: "pingdotgg/t3code",
918+
}),
919+
],
920+
providers: [
921+
fakePullRequestProvider(SourceControlProviderKind.make("github"), {
922+
getViewer: () =>
923+
Effect.fail(unusable(SourceControlProviderKind.make("github"), reason)),
924+
}),
925+
],
926+
});
927+
928+
for (const filter of [{}, { host: "github.com" }]) {
929+
const error = yield* service.list({ state: "open", ...filter }).pipe(Effect.flip);
930+
assert.strictEqual(error._tag, "PullRequestUnavailableError");
931+
assert.strictEqual(
932+
error._tag === "PullRequestUnavailableError" ? error.reason : null,
933+
reason === "missing-tool" ? "cli-missing" : "cli-unauthenticated",
934+
);
935+
assert.isDefined(error.listResult);
936+
const result = error.listResult!;
937+
assert.deepStrictEqual(result.entries, []);
938+
assert.deepStrictEqual(result.viewers, {});
939+
assert.deepStrictEqual(
940+
result.providers.map(({ host, configured, projectIds }) => ({
941+
host,
942+
configured,
943+
projectIds: projectIds?.map(String),
944+
})),
945+
[{ host: "github.com", configured: false, projectIds: undefined }],
946+
);
947+
assert.strictEqual(result.providers[0]?.detail?.includes("github"), true);
948+
assert.deepStrictEqual(
949+
result.errors.map(({ projectId }) => projectId),
950+
["p1"],
951+
);
952+
}
953+
}
954+
}),
955+
);
956+
957+
it.effect("retains a Bitbucket host summary when the provider rejects saved credentials", () =>
958+
Effect.gen(function* () {
959+
const provider = fakePullRequestProvider(SourceControlProviderKind.make("bitbucket"), {
960+
getViewer: () =>
961+
Effect.fail(
962+
new PullRequestProviderError({
963+
provider: SourceControlProviderKind.make("bitbucket"),
964+
operation: "getViewer",
965+
reason: "failed",
966+
detail: "HTTP 403",
967+
}),
968+
),
969+
});
970+
const service = yield* makeService({
971+
projects: [
972+
project({
973+
id: "bitbucket",
974+
title: "Widget",
975+
workspaceRoot: "/widget",
976+
repository: "acme/widget",
977+
provider: "bitbucket",
978+
host: "bitbucket.org",
979+
}),
980+
],
981+
providers: [provider],
982+
});
983+
for (const filter of [{}, { host: "bitbucket.org" }]) {
984+
const error = yield* service.list({ state: "open", ...filter }).pipe(Effect.flip);
985+
assert.strictEqual(error._tag, "PullRequestOperationError");
986+
assert.isDefined(error.listResult);
987+
const result = error.listResult!;
988+
assert.deepStrictEqual(
989+
result.providers.map(({ host, configured, projectIds }) => ({
990+
host,
991+
configured,
992+
projectIds: projectIds?.map(String),
993+
})),
994+
[{ host: "bitbucket.org", configured: false, projectIds: undefined }],
995+
);
996+
assert.deepStrictEqual(result.entries, []);
997+
assert.deepStrictEqual(
998+
result.errors.map(({ projectId }) => projectId),
999+
["bitbucket"],
1000+
);
1001+
}
1002+
}),
1003+
);
1004+
1005+
it.effect.each([
1006+
{
1007+
provider: "forgejo",
1008+
host: "ssh.forge.example",
1009+
remoteUrl: "ssh://[email protected]:2222/team/repo.git",
1010+
},
1011+
{
1012+
provider: "unknown",
1013+
host: "forge.example",
1014+
remoteUrl: "http://forge.example:3000/team/repo.git",
1015+
},
1016+
])(
1017+
"identifies every worktree behind an unavailable refined Forgejo authority",
1018+
({ provider, host, remoteUrl }) =>
1019+
Effect.gen(function* () {
1020+
const service = yield* makeService({
1021+
projects: ["ssh", "ssh-worktree"].map((id) =>
1022+
project({
1023+
id,
1024+
title: id,
1025+
workspaceRoot: `/${id}`,
1026+
repository: "team/repo",
1027+
provider,
1028+
host,
1029+
remoteUrl,
1030+
}),
1031+
),
1032+
providers: [
1033+
fakePullRequestProvider(SourceControlProviderKind.make("forgejo"), {
1034+
getViewer: ({ host }) => {
1035+
assert.strictEqual(host, "forge.example:3000");
1036+
return Effect.fail(
1037+
unusable(SourceControlProviderKind.make("forgejo"), "unauthenticated"),
1038+
);
1039+
},
1040+
listChangeRequests: () => Effect.die("An unauthenticated host must not be queried"),
1041+
}),
1042+
],
1043+
resolveHandle: ({ context }) =>
1044+
Effect.succeed({
1045+
context: {
1046+
...context!,
1047+
provider: {
1048+
kind: SourceControlProviderKind.make("forgejo"),
1049+
name: "Forgejo",
1050+
baseUrl: "http://forge.example:3000",
1051+
},
1052+
},
1053+
provider: undefined as never,
1054+
}),
1055+
});
1056+
const error = yield* service.list({ state: "open" }).pipe(Effect.flip);
1057+
assert.isDefined(error.listResult);
1058+
const result = error.listResult!;
1059+
assert.deepStrictEqual(
1060+
result.providers.map(({ host, configured, projectIds }) => ({
1061+
host,
1062+
configured,
1063+
projectIds: projectIds?.map(String),
1064+
})),
1065+
[{ host: "forge.example:3000", configured: false, projectIds: ["ssh", "ssh-worktree"] }],
1066+
);
1067+
assert.deepStrictEqual(result.entries, []);
1068+
assert.deepStrictEqual(
1069+
result.errors.map(({ projectId }) => projectId),
1070+
["ssh"],
1071+
);
1072+
}),
1073+
);
1074+
9081075
it.effect("reads a repository once when several worktrees share it", () =>
9091076
Effect.gen(function* () {
9101077
let calls = 0;
@@ -936,6 +1103,7 @@ it.effect("reads a repository once when several worktrees share it", () =>
9361103

9371104
assert.strictEqual(calls, 1);
9381105
assert.strictEqual(result.entries.length, 1);
1106+
assert.isUndefined(result.providers[0]?.projectIds);
9391107
}),
9401108
);
9411109

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

Lines changed: 30 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -344,6 +344,7 @@ interface WorkspaceProjects {
344344
{ readonly kind: SourceControlProviderKind; readonly projectCount: number }
345345
>;
346346
readonly viewerRoots: ReadonlyMap<string, ReadonlyArray<string>>;
347+
readonly refinedProjectIdsByHost: ReadonlyMap<string, ReadonlyArray<ProjectId>>;
347348
}
348349

349350
// Inherited by fibers forked inside the scope, so it is closed, not just dropped, when the scope ends.
@@ -930,6 +931,7 @@ export const make = Effect.gen(function* () {
930931
{ kind: SourceControlProviderKind; projectCount: number }
931932
>();
932933
const viewerRoots = new Map<string, string[]>();
934+
const refinedProjectIdsByHost = new Map<string, ProjectId[]>();
933935
const seen = new Set<string>();
934936
for (const project of projects) {
935937
if (filter.projectId !== undefined && project.id !== filter.projectId) continue;
@@ -950,6 +952,11 @@ export const make = Effect.gen(function* () {
950952
if (filter.host !== undefined && host !== filter.host.toLowerCase()) {
951953
continue;
952954
}
955+
if (host !== sourceControlDefinitions.changeRequestHost(identity, identity.provider)) {
956+
const projectIds = refinedProjectIdsByHost.get(host);
957+
if (projectIds === undefined) refinedProjectIdsByHost.set(host, [project.id]);
958+
else projectIds.push(project.id);
959+
}
953960
const registered = registry.get(kind);
954961
const api = registered?.servesHost?.(host) === false ? null : registered;
955962
if (api !== null) {
@@ -983,7 +990,7 @@ export const make = Effect.gen(function* () {
983990
: sourceControlDefinitions.canonicalRepositoryKey(repositoryKey.toLowerCase()),
984991
});
985992
}
986-
return { supported, unimplemented, viewerRoots };
993+
return { supported, unimplemented, viewerRoots, refinedProjectIdsByHost };
987994
}),
988995
);
989996

@@ -1307,7 +1314,12 @@ export const make = Effect.gen(function* () {
13071314
const involvement = input.involvement ?? "all";
13081315
const epochAtStart = epochCounter;
13091316
const continuation = yield* decodeCursors(input.cursors);
1310-
const { supported: projects, unimplemented, viewerRoots } = yield* listWorkspaceProjects(input);
1317+
const {
1318+
supported: projects,
1319+
unimplemented,
1320+
viewerRoots,
1321+
refinedProjectIdsByHost,
1322+
} = yield* listWorkspaceProjects(input);
13111323
const projectCounts = new Map<string, number>();
13121324
for (const { host } of projects) {
13131325
projectCounts.set(host, (projectCounts.get(host) ?? 0) + 1);
@@ -1329,6 +1341,7 @@ export const make = Effect.gen(function* () {
13291341
searchesOnHost: capabilities?.search ?? false,
13301342
actions: capabilities?.actions ?? [],
13311343
projectCount: projectCounts.get(result.host) ?? 1,
1344+
projectIds: refinedProjectIdsByHost.get(result.host),
13321345
configured: result.viewer !== null,
13331346
detail: result.error === null ? null : providerDetail(requirementOf, result.error),
13341347
};
@@ -1339,6 +1352,7 @@ export const make = Effect.gen(function* () {
13391352
searchesOnHost: false,
13401353
actions: [],
13411354
projectCount,
1355+
projectIds: refinedProjectIdsByHost.get(host),
13421356
configured: false,
13431357
detail: "This host cannot be browsed here yet.",
13441358
})),
@@ -1357,24 +1371,28 @@ export const make = Effect.gen(function* () {
13571371
message: `${repository} could not be read.`,
13581372
}));
13591373
if (readable.length === 0) {
1374+
const listResult: PullRequestListResult = {
1375+
viewers: viewers as PullRequestListResult["viewers"],
1376+
providers,
1377+
entries: [],
1378+
errors: unreadable,
1379+
truncated: false,
1380+
nextCursors: {},
1381+
};
13601382
const errors = viewerResults.flatMap((result) =>
13611383
result.error === null || !selected.some(({ host }) => host === result.host)
13621384
? []
13631385
: [result.error],
13641386
);
13651387
const blocking = errors.find(isProviderUnusable) ?? errors[0];
13661388
if (blocking) {
1367-
return yield* toPullRequestError("list")(blocking);
1389+
// Preserve failure/retry semantics while letting clients try another server for these hosts.
1390+
const error = toPullRequestError("list")(blocking);
1391+
return yield* error._tag === "PullRequestUnavailableError"
1392+
? new PullRequestUnavailableError({ ...error, listResult })
1393+
: new PullRequestOperationError({ ...error, listResult });
13681394
}
1369-
1370-
return {
1371-
viewers: viewers as PullRequestListResult["viewers"],
1372-
providers,
1373-
entries: [],
1374-
errors: [],
1375-
truncated: false,
1376-
nextCursors: {},
1377-
};
1395+
return listResult;
13781396
}
13791397

13801398
const limit = input.limit ?? DEFAULT_REPOSITORY_LIST_LIMIT;

0 commit comments

Comments
 (0)