Skip to content

Commit 5e9269f

Browse files
PR Batch Testerclaude
andcommitted
fix(client-runtime): idle clients stop exporting a platform reconcile trace every 3 seconds
The platform connection source repeats its registrations on every poll, and each identical reconcile opened four registry spans. The registry now remembers the last registrations it applied in full and returns before any span when a poll repeats them. Failed best-effort writes (routing permission, platform bearer, shadowed persisted registration) leave nothing recorded, so the next identical poll still retries them. Reconciles are serialized so the recorded set always matches the state it produced. Fixes #26484 Co-Authored-By: Claude Opus 5.5 <[email protected]>
1 parent 5211acf commit 5e9269f

2 files changed

Lines changed: 122 additions & 27 deletions

File tree

‎packages/client-runtime/src/connection/registry.test.ts‎

Lines changed: 80 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,7 @@ import * as Scheduler from "effect/Scheduler";
2020
import * as Scope from "effect/Scope";
2121
import * as Stream from "effect/Stream";
2222
import * as SubscriptionRef from "effect/SubscriptionRef";
23+
import * as Tracer from "effect/Tracer";
2324

2425
import * as ClientCapabilities from "../platform/capabilities.ts";
2526
import * as TokenStore from "../authorization/tokenStore.ts";
@@ -157,6 +158,9 @@ const makeHarness = Effect.fn("TestEnvironmentRegistry.makeHarness")(function* (
157158
readonly beforeRegistrationRemove?: (
158159
environmentId: EnvironmentId,
159160
) => Effect.Effect<void, Persistence.ConnectionPersistenceError>;
161+
readonly beforeCredentialPut?: (
162+
connectionId: string,
163+
) => Effect.Effect<void, ConnectionTransientError>;
160164
readonly checkRoute?: (route: ConnectionRoute) => RouteCheck;
161165
readonly prepareRoute?: (target: ConnectionTarget) => ConnectionBlockedError | undefined;
162166
readonly beforePrepareRoute?: (
@@ -337,11 +341,15 @@ const makeHarness = Effect.fn("TestEnvironmentRegistry.makeHarness")(function* (
337341
Effect.map((current) => Option.fromUndefinedOr(current.get(connectionId))),
338342
),
339343
put: (connectionId, credential) =>
340-
Ref.update(storedCredentials, (current) => {
341-
const next = new Map(current);
342-
next.set(connectionId, credential);
343-
return next;
344-
}),
344+
(options?.beforeCredentialPut?.(connectionId) ?? Effect.void).pipe(
345+
Effect.andThen(
346+
Ref.update(storedCredentials, (current) => {
347+
const next = new Map(current);
348+
next.set(connectionId, credential);
349+
return next;
350+
}),
351+
),
352+
),
345353
remove: (connectionId) =>
346354
Ref.update(storedCredentials, (current) => {
347355
const next = new Map(current);
@@ -499,6 +507,20 @@ function replaceRoutes(
499507
return [...others.slice(0, insertAt), ...routes, ...others.slice(insertAt)];
500508
}
501509

510+
function registrySpanNames<A, E, R>(effect: Effect.Effect<A, E, R>) {
511+
const names: Array<string> = [];
512+
const tracer = Tracer.make({
513+
span: (options) => {
514+
if (options.name.startsWith("EnvironmentRegistry.")) names.push(options.name);
515+
return new Tracer.NativeSpan(options);
516+
},
517+
});
518+
return effect.pipe(
519+
Effect.withTracer(tracer),
520+
Effect.map(() => names),
521+
);
522+
}
523+
502524
function awaitConnectionState(
503525
registry: EnvironmentRegistry.EnvironmentRegistry["Service"],
504526
environmentId: EnvironmentId,
@@ -1430,7 +1452,18 @@ describe("EnvironmentRegistry", () => {
14301452

14311453
it.effect("a replaced platform bearer reaches a connected session's HTTP requests", () =>
14321454
Effect.gen(function* () {
1433-
const harness = yield* makeHarness([]);
1455+
let failCredentialWrites = false;
1456+
const harness = yield* makeHarness([], [], [], {
1457+
beforeCredentialPut: () =>
1458+
failCredentialWrites
1459+
? Effect.fail(
1460+
new ConnectionTransientError({
1461+
reason: "remote-unavailable",
1462+
detail: "Storage unavailable",
1463+
}),
1464+
)
1465+
: Effect.void,
1466+
});
14341467

14351468
yield* Effect.gen(function* () {
14361469
const registry = yield* EnvironmentRegistry.EnvironmentRegistry;
@@ -1459,6 +1492,11 @@ describe("EnvironmentRegistry", () => {
14591492
);
14601493
expect(yield* preparedToken).toBe("old-bearer");
14611494

1495+
failCredentialWrites = true;
1496+
yield* registry.reconcilePlatform([registration("new-bearer")]);
1497+
expect(yield* preparedToken).toBe("old-bearer");
1498+
1499+
failCredentialWrites = false;
14621500
yield* registry.reconcilePlatform([registration("new-bearer")]);
14631501

14641502
expect(yield* preparedToken).toBe("new-bearer");
@@ -1556,7 +1594,18 @@ describe("EnvironmentRegistry", () => {
15561594
environmentId: TARGET.environmentId,
15571595
label: "Shadowed relay environment",
15581596
});
1559-
const harness = yield* makeHarness([shadowedTarget]);
1597+
let failRemoval = true;
1598+
const harness = yield* makeHarness([shadowedTarget], [], [], {
1599+
beforeRegistrationRemove: () =>
1600+
failRemoval
1601+
? Effect.fail(
1602+
new Persistence.ConnectionPersistenceError({
1603+
operation: "remove-connection",
1604+
message: "Storage unavailable",
1605+
}),
1606+
)
1607+
: Effect.void,
1608+
});
15601609
const permissions = yield* makePullRequestRoutingPermissions({
15611610
read: Effect.succeed([]),
15621611
write: () => Effect.void,
@@ -1568,6 +1617,10 @@ describe("EnvironmentRegistry", () => {
15681617
const registry = yield* EnvironmentRegistry.EnvironmentRegistry;
15691618
yield* registry.reconcilePlatform([new PrimaryConnectionRegistration({ target: TARGET })]);
15701619
expect(yield* permissions.get(shadowedEntry)).toBe("off");
1620+
expect(hasRoutes(yield* Ref.get(harness.storedTargets), TARGET.environmentId)).toBe(true);
1621+
1622+
failRemoval = false;
1623+
yield* registry.reconcilePlatform([new PrimaryConnectionRegistration({ target: TARGET })]);
15711624

15721625
expect(
15731626
(yield* SubscriptionRef.get(registry.entries)).get(TARGET.environmentId)?.target,
@@ -1794,8 +1847,13 @@ describe("EnvironmentRegistry", () => {
17941847
);
17951848
yield* permissions.set(entry, "read-write");
17961849

1797-
yield* registry.reconcilePlatform([registration]);
1850+
const repeated = yield* registrySpanNames(
1851+
registry.reconcilePlatform([
1852+
new PrimaryConnectionRegistration({ target: new PrimaryConnectionTarget(TARGET) }),
1853+
]),
1854+
);
17981855

1856+
expect(repeated).toEqual([]);
17991857
expect(yield* Ref.get(harness.sessions)).toHaveLength(1);
18001858
expect(yield* permissions.get(entry)).toBe("read-write");
18011859

@@ -1810,18 +1868,30 @@ describe("EnvironmentRegistry", () => {
18101868
expect(
18111869
(yield* SubscriptionRef.get(registry.entries)).get(TARGET.environmentId)?.target,
18121870
).toEqual(TARGET);
1813-
yield* registry.reconcilePlatform([]);
1814-
expect((yield* SubscriptionRef.get(registry.entries)).has(TARGET.environmentId)).toBe(true);
18151871

18161872
failWrites = false;
18171873
yield* registry.reconcilePlatform([
18181874
new PrimaryConnectionRegistration({ target: changedTarget }),
18191875
]);
1876+
expect(
1877+
(yield* SubscriptionRef.get(registry.entries)).get(TARGET.environmentId)?.target,
1878+
).toEqual(changedTarget);
18201879
expect(yield* permissions.get(entry)).toBe("off");
18211880
yield* registry.reconcilePlatform([registration]);
18221881
expect(yield* permissions.get(entry)).toBe("off");
1882+
18231883
yield* permissions.set(entry, "read-write");
1884+
failWrites = true;
1885+
yield* registry.reconcilePlatform([]);
1886+
expect((yield* SubscriptionRef.get(registry.entries)).has(TARGET.environmentId)).toBe(true);
1887+
failWrites = false;
18241888
yield* registry.reconcilePlatform([]);
1889+
expect((yield* SubscriptionRef.get(registry.entries)).has(TARGET.environmentId)).toBe(
1890+
false,
1891+
);
1892+
expect(yield* permissions.get(entry)).toBe("off");
1893+
expect(yield* registrySpanNames(registry.reconcilePlatform([]))).toEqual([]);
1894+
18251895
yield* registry.reconcilePlatform([registration]);
18261896
expect(yield* permissions.get(entry)).toBe("off");
18271897
}).pipe(

‎packages/client-runtime/src/connection/registry.ts‎

Lines changed: 42 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -626,9 +626,10 @@ export const make = Effect.gen(function* () {
626626
function* (registration: PlatformConnectionRegistration) {
627627
const registered = connectionRegistrationCatalogEntry(registration);
628628
const target = registered.target;
629-
yield* withLeaseLock(
629+
return yield* withLeaseLock(
630630
target.environmentId,
631631
Effect.gen(function* () {
632+
let applied = true;
632633
const previous = (yield* SubscriptionRef.get(entries)).get(target.environmentId);
633634
const entry: ConnectionCatalogEntry =
634635
previous?.unsupportedReason !== undefined &&
@@ -654,7 +655,7 @@ export const make = Effect.gen(function* () {
654655
),
655656
Effect.exit,
656657
);
657-
if (Exit.isFailure(revoked)) return;
658+
if (Exit.isFailure(revoked)) return false;
658659
}
659660
yield* Ref.update(platformEnvironmentIds, (current) => {
660661
const next = new Set(current);
@@ -673,40 +674,44 @@ export const make = Effect.gen(function* () {
673674
.pipe(Effect.orElseSucceed(() => Option.none<ConnectionCredential>()));
674675
const changed =
675676
Option.isSome(stored) && !Equal.equals(stored.value, registration.credential);
676-
// Only a bearer that was actually stored can be retried with; a
677-
// failed write leaves the rejected one in place.
678-
bearerReplaced = yield* credentials
677+
const written = yield* credentials
679678
.put(registration.target.connectionId, registration.credential)
680679
.pipe(
681-
Effect.as(changed),
680+
Effect.as(true),
682681
Effect.catch((error) =>
683682
Effect.logWarning("Could not store the platform bearer credential.", {
684683
environmentId: target.environmentId,
685684
error,
686685
}).pipe(Effect.as(false)),
687686
),
688687
);
688+
// Only a bearer that was actually stored can be retried with; a
689+
// failed write leaves the rejected one in place.
690+
bearerReplaced = written && changed;
691+
applied = written;
689692
}
690693

691694
if (persisted) {
692-
yield* registrations.remove(target.environmentId).pipe(
695+
const removed = yield* registrations.remove(target.environmentId).pipe(
693696
Effect.tap(() =>
694697
Ref.update(persistedEnvironmentIds, (current) => {
695698
const next = new Set(current);
696699
next.delete(target.environmentId);
697700
return next;
698701
}),
699702
),
703+
Effect.as(true),
700704
Effect.catch((error) =>
701705
Effect.logWarning(
702706
"Could not remove a persisted registration shadowed by a platform environment.",
703707
{
704708
environmentId: target.environmentId,
705709
error,
706710
},
707-
),
711+
).pipe(Effect.as(false)),
708712
),
709713
);
714+
applied &&= removed;
710715
}
711716

712717
yield* installEntryLocked(entry, { retainEquivalentRuntime: true });
@@ -743,14 +748,15 @@ export const make = Effect.gen(function* () {
743748
}
744749
}
745750
}
751+
return applied;
746752
}),
747753
);
748754
},
749755
);
750756

751757
const removePlatformEnvironment = Effect.fn("EnvironmentRegistry.removePlatformEnvironment")(
752758
function* (environmentId: EnvironmentId) {
753-
yield* withLeaseLock(
759+
return yield* withLeaseLock(
754760
environmentId,
755761
Effect.gen(function* () {
756762
const entry = (yield* SubscriptionRef.get(entries)).get(environmentId);
@@ -766,7 +772,7 @@ export const make = Effect.gen(function* () {
766772
),
767773
Effect.exit,
768774
);
769-
if (Exit.isFailure(revoked)) return;
775+
if (Exit.isFailure(revoked)) return false;
770776
yield* Ref.update(platformEnvironmentIds, (current) => {
771777
const next = new Set(current);
772778
next.delete(environmentId);
@@ -802,27 +808,46 @@ export const make = Effect.gen(function* () {
802808
],
803809
{ concurrency: "unbounded", discard: true },
804810
);
811+
return true;
805812
}),
806813
);
807814
},
808815
);
809816

810-
const reconcilePlatform = Effect.fn("EnvironmentRegistry.reconcilePlatform")(function* (
817+
/** Succeeds with `false` when a best-effort write failed, so an identical repeat retries it. */
818+
const applyPlatformRegistrations = Effect.fn("EnvironmentRegistry.reconcilePlatform")(function* (
811819
platformRegistrations: ReadonlyArray<PlatformConnectionRegistration>,
812820
) {
813821
const desiredIds = new Set(
814822
platformRegistrations.map((registration) => registration.target.environmentId),
815823
);
816824
const currentPlatformIds = yield* Ref.get(platformEnvironmentIds);
817-
yield* Effect.forEach(
818-
currentPlatformIds,
819-
(environmentId) =>
820-
desiredIds.has(environmentId) ? Effect.void : removePlatformEnvironment(environmentId),
821-
{ discard: true },
825+
const removed = yield* Effect.forEach(currentPlatformIds, (environmentId) =>
826+
desiredIds.has(environmentId)
827+
? Effect.succeed(true)
828+
: removePlatformEnvironment(environmentId),
822829
);
823-
yield* Effect.forEach(platformRegistrations, installPlatformRegistration, { discard: true });
830+
const installed = yield* Effect.forEach(platformRegistrations, installPlatformRegistration);
831+
return [...removed, ...installed].every(Boolean);
824832
});
825833

834+
const reconcileLock = yield* Semaphore.make(1);
835+
const appliedPlatformRegistrations = yield* Ref.make(
836+
Option.none<ReadonlyArray<PlatformConnectionRegistration>>(),
837+
);
838+
// Untraced: platforms repeat unchanged registrations every few seconds, and a
839+
// span per poll would make idle clients export traces continuously.
840+
const reconcilePlatform = Effect.fnUntraced(function* (
841+
platformRegistrations: ReadonlyArray<PlatformConnectionRegistration>,
842+
) {
843+
const applied = yield* Ref.get(appliedPlatformRegistrations);
844+
if (Option.isSome(applied) && Equal.equals(applied.value, platformRegistrations)) return;
845+
yield* Ref.set(appliedPlatformRegistrations, Option.none());
846+
if (yield* applyPlatformRegistrations(platformRegistrations)) {
847+
yield* Ref.set(appliedPlatformRegistrations, Option.some(platformRegistrations));
848+
}
849+
}, reconcileLock.withPermits(1));
850+
826851
/** Callers hold its lease lock. */
827852
const removeLocked = Effect.fn("EnvironmentRegistry.removeLocked")(function* (
828853
environmentId: EnvironmentId,

0 commit comments

Comments
 (0)