Skip to content

Commit c96a4bb

Browse files
shivamhwpPR Batch Testerclaude
authored
fix(bitbucket): stop the startup sweep from flooding Bitbucket with 429s (pingdotgg#23889)
Co-authored-by: PR Batch Tester <[email protected]> Co-authored-by: Claude Opus 5.5 <[email protected]>
1 parent 1df9c32 commit c96a4bb

7 files changed

Lines changed: 226 additions & 63 deletions

File tree

‎apps/server/src/git/GitManager.ts‎

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -95,6 +95,7 @@ import * as ServerSettings from "../serverSettings.ts";
9595
import type { GitManagerServiceError } from "@t3tools/contracts";
9696
import * as GitVcsDriver from "../vcs/GitVcsDriver.ts";
9797
import * as SourceControlProvider from "@t3tools/source-control-core/server/SourceControlProvider";
98+
import * as SourceControlRateLimit from "@t3tools/source-control-core/server/SourceControlRateLimit";
9899
import * as SourceControlProviderRegistry from "../sourceControl/SourceControlProviderRegistry.ts";
99100
import type { ChangeRequest } from "@t3tools/contracts";
100101

@@ -2715,6 +2716,9 @@ export const make = Effect.gen(function* () {
27152716
},
27162717
);
27172718

2719+
// A user is waiting on these, so a host's background rate-limit pause must not refuse them.
2720+
const asUserAction = Effect.provideService(SourceControlRateLimit.Interactive, true);
2721+
27182722
const resolvePullRequest: GitManager["Service"]["resolvePullRequest"] = Effect.fn(
27192723
"resolvePullRequest",
27202724
)(function* (input) {
@@ -2726,7 +2730,7 @@ export const make = Effect.gen(function* () {
27262730
.pipe(Effect.map((resolved) => toResolvedPullRequest(resolved)));
27272731

27282732
return { pullRequest };
2729-
});
2733+
}, asUserAction);
27302734

27312735
const ensureNoTrackedChanges = Effect.fn("ensureNoTrackedChanges")(function* (
27322736
cwd: string,
@@ -3036,7 +3040,7 @@ export const make = Effect.gen(function* () {
30363040
isOnPullRequestHead: true,
30373041
};
30383042
}).pipe(Effect.ensuring(invalidateStatus(input.cwd)));
3039-
});
3043+
}, asUserAction);
30403044

30413045
const runFeatureBranchStep = Effect.fn("runFeatureBranchStep")(function* (
30423046
settings: SourceControlTextGenerationSettings,
@@ -3281,6 +3285,7 @@ export const make = Effect.gen(function* () {
32813285
),
32823286
);
32833287
},
3288+
asUserAction,
32843289
);
32853290

32863291
return GitManager.of({

‎apps/server/src/sourceControl/BitbucketApi.test.ts‎

Lines changed: 92 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,14 +3,19 @@ import { assert, it, vi } from "@effect/vitest";
33
import * as NodeServices from "@effect/platform-node/NodeServices";
44
import * as ConfigProvider from "effect/ConfigProvider";
55
import * as DateTime from "effect/DateTime";
6+
import * as Deferred from "effect/Deferred";
67
import * as Effect from "effect/Effect";
8+
import * as Fiber from "effect/Fiber";
79
import * as FileSystem from "effect/FileSystem";
810
import * as Layer from "effect/Layer";
911
import * as Option from "effect/Option";
12+
import * as Queue from "effect/Queue";
1013
import * as Schema from "effect/Schema";
14+
import * as TestClock from "effect/testing/TestClock";
1115
import { HttpClient, HttpClientError, HttpClientRequest, HttpClientResponse } from "effect/http";
1216

1317
import * as BitbucketApi from "@t3tools/source-control-bitbucket/server/BitbucketApi";
18+
import * as SourceControlRateLimit from "@t3tools/source-control-core/server/SourceControlRateLimit";
1419
import * as ServerSettings from "../serverSettings.ts";
1520
import * as GitVcsDriver from "../vcs/GitVcsDriver.ts";
1621
import * as VcsDriverRegistry from "../vcs/VcsDriverRegistry.ts";
@@ -60,6 +65,8 @@ const repositoryJson = {
6065

6166
function makeLayer(input: {
6267
readonly response: (request: HttpClientRequest.HttpClientRequest) => Response;
68+
/** Holds the answer until it resolves, in place of answering at once. */
69+
readonly answer?: (response: Response) => Effect.Effect<Response>;
6370
readonly requestFailure?: (
6471
request: HttpClientRequest.HttpClientRequest,
6572
) => HttpClientError.HttpClientError;
@@ -72,7 +79,9 @@ function makeLayer(input: {
7279
? Effect.never
7380
: input.requestFailure
7481
? Effect.fail(input.requestFailure(request))
75-
: Effect.succeed(HttpClientResponse.fromWeb(request, input.response(request))),
82+
: (input.answer ?? Effect.succeed)(input.response(request)).pipe(
83+
Effect.map((response) => HttpClientResponse.fromWeb(request, response)),
84+
),
7685
);
7786
const gitMock = {
7887
readConfigValue: vi.fn<GitVcsDriver.GitVcsDriver["Service"]["readConfigValue"]>(() =>
@@ -144,6 +153,7 @@ function makeLayer(input: {
144153

145154
const layer = BitbucketApi.layer.pipe(
146155
Layer.provide(ServerSourceControlHost.layer),
156+
Layer.provide(SourceControlRateLimit.layer),
147157
Layer.provide(Layer.mock(VcsProcess.VcsProcess)({})),
148158
Layer.provide(
149159
Layer.succeed(
@@ -736,3 +746,84 @@ it.effect("cuts a response short rather than reading an unbounded diff into memo
736746
),
737747
),
738748
);
749+
750+
it.effect("pauses background reads after a 429 until Bitbucket's retry-after passes", () => {
751+
let answered = 0;
752+
const { execute, layer } = makeLayer({
753+
response: () => {
754+
answered += 1;
755+
return answered === 1
756+
? new Response("Rate limit exceeded", { status: 429, headers: { "retry-after": "60" } })
757+
: Response.json({ values: [] });
758+
},
759+
});
760+
761+
return Effect.gen(function* () {
762+
const bitbucket = yield* BitbucketApi.BitbucketApi;
763+
const lookup = bitbucket.listPullRequests({
764+
cwd: "/repo",
765+
headSelector: "feature/a",
766+
state: "all",
767+
});
768+
769+
yield* Effect.flip(lookup);
770+
const paused = yield* Effect.flip(lookup);
771+
// Keyed by the repository host, where PullRequestService records its own backoff.
772+
assert.deepInclude(paused, {
773+
_tag: "SourceControlRateLimitPausedError",
774+
host: "bitbucket.org",
775+
retryAt: 60_000,
776+
});
777+
assert.strictEqual(execute.mock.calls.length, 1);
778+
779+
// A user waiting on an answer is not held back by the background pause, and their success
780+
// does not end it early.
781+
yield* lookup.pipe(Effect.provideService(SourceControlRateLimit.Interactive, true));
782+
yield* bitbucket.request({
783+
method: "POST",
784+
url: "/repositories/acme/web/pullrequests/1/approve",
785+
});
786+
787+
yield* TestClock.adjust("59 seconds");
788+
assert.strictEqual((yield* Effect.flip(lookup))._tag, "SourceControlRateLimitPausedError");
789+
790+
yield* TestClock.adjust("1 second");
791+
yield* lookup;
792+
}).pipe(Effect.provide(layer));
793+
});
794+
795+
it.effect("keeps a sweep over many branches to a few Bitbucket requests at a time", () =>
796+
Effect.gen(function* () {
797+
const started = yield* Queue.unbounded<void>();
798+
const release = yield* Deferred.make<void>();
799+
let inFlight = 0;
800+
let peak = 0;
801+
const { layer } = makeLayer({
802+
response: () => Response.json({ values: [] }),
803+
answer: (response) =>
804+
Effect.gen(function* () {
805+
inFlight += 1;
806+
peak = Math.max(peak, inFlight);
807+
yield* Queue.offer(started, undefined);
808+
yield* Deferred.await(release);
809+
inFlight -= 1;
810+
return response;
811+
}),
812+
});
813+
814+
yield* Effect.gen(function* () {
815+
const bitbucket = yield* BitbucketApi.BitbucketApi;
816+
const sweep = yield* Effect.forEach(
817+
Array.from({ length: 12 }, (_, index) => `feature/${index}`),
818+
(branch) =>
819+
bitbucket.listPullRequests({ cwd: "/repo", headSelector: branch, state: "all" }),
820+
{ concurrency: "unbounded", discard: true },
821+
).pipe(Effect.forkChild);
822+
for (let index = 0; index < 4; index += 1) yield* Queue.take(started);
823+
yield* Deferred.succeed(release, undefined);
824+
yield* Fiber.join(sweep);
825+
}).pipe(Effect.provide(layer));
826+
827+
assert.strictEqual(peak, 4);
828+
}),
829+
);

‎apps/server/src/sourceControl/SourceControlRepositoryService.ts‎

Lines changed: 18 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,7 @@ import {
2424

2525
import * as ServerConfig from "../config.ts";
2626
import { expandHomePath } from "@t3tools/provider-core/server/pathExpansion";
27+
import * as SourceControlRateLimit from "@t3tools/source-control-core/server/SourceControlRateLimit";
2728
import {
2829
parseGitCloneProgressLine,
2930
type GitCloneProgressLine,
@@ -231,20 +232,23 @@ export const make = Effect.gen(function* () {
231232
);
232233
};
233234

234-
const lookupRepository = Effect.fn("SourceControlRepositoryService.lookupRepository")(function* (
235-
input: SourceControlRepositoryLookupInput,
236-
) {
237-
const providerKind = yield* ensureConcreteProvider({
238-
operation: "lookupRepository",
239-
provider: input.provider,
240-
});
241-
const provider = yield* providers.get(providerKind);
242-
const urls = yield* provider.getRepositoryCloneUrls({
243-
cwd: input.cwd ?? config.cwd,
244-
repository: input.repository.trim(),
245-
});
246-
return toRepositoryInfo(providerKind, urls);
247-
});
235+
const lookupRepository = Effect.fn("SourceControlRepositoryService.lookupRepository")(
236+
function* (input: SourceControlRepositoryLookupInput) {
237+
const providerKind = yield* ensureConcreteProvider({
238+
operation: "lookupRepository",
239+
provider: input.provider,
240+
});
241+
const provider = yield* providers.get(providerKind);
242+
const urls = yield* provider.getRepositoryCloneUrls({
243+
cwd: input.cwd ?? config.cwd,
244+
repository: input.repository.trim(),
245+
});
246+
return toRepositoryInfo(providerKind, urls);
247+
},
248+
// Someone adding or cloning a repository is waiting, so a background rate-limit pause must not
249+
// refuse the lookup.
250+
Effect.provideService(SourceControlRateLimit.Interactive, true),
251+
);
248252

249253
const normalizeDestinationPath = Effect.fn("SourceControlRepositoryService.normalizeDestination")(
250254
function* (destinationPath: string) {

‎apps/server/src/sourceControl/builtInDrivers.ts‎

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,7 @@ import * as GitLabCli from "@t3tools/source-control-gitlab/server/GitLabCli";
1616
import * as GitLabPullRequestCli from "@t3tools/source-control-gitlab/server/GitLabPullRequestCli";
1717
import * as GitLabDriver from "@t3tools/source-control-gitlab/server/driver";
1818
import type { SourceControlDriver } from "@t3tools/source-control-core/server/driver";
19+
import * as SourceControlRateLimit from "@t3tools/source-control-core/server/SourceControlRateLimit";
1920
import * as Layer from "effect/Layer";
2021

2122
import * as ServerSourceControlHost from "./ServerSourceControlHost.ts";
@@ -41,7 +42,9 @@ export const layer = Layer.mergeAll(
4142
// reader shares, so the server builds it once, here.
4243
GitHubPullRequestApi.layer.pipe(Layer.provideMerge(GitHubRest.layerWithDependencies)),
4344
AzureDevOpsPullRequestCli.layer.pipe(Layer.provideMerge(AzureDevOpsCli.layer)),
44-
BitbucketPullRequestApi.layer.pipe(Layer.provideMerge(BitbucketApi.layer)),
45+
BitbucketPullRequestApi.layer.pipe(
46+
Layer.provideMerge(BitbucketApi.layer.pipe(Layer.provide(SourceControlRateLimit.layer))),
47+
),
4548
ForgejoCli.layer,
4649
GitCafeApi.layer.pipe(Layer.provideMerge(GitCafeCredentials.layer)),
4750
GitLabPullRequestCli.layer.pipe(Layer.provideMerge(GitLabCli.layer)),

0 commit comments

Comments
 (0)