Skip to content

Commit ee9e36c

Browse files
feat(secrets): check a secret reference before saving it (#31723)
Signed-off-by: Yordis Prieto <[email protected]> Co-authored-by: Julius Marminge <[email protected]> Co-authored-by: Julius Marminge <[email protected]>
1 parent 977d613 commit ee9e36c

29 files changed

Lines changed: 807 additions & 95 deletions

‎apps/server/src/environment/ServerEnvironment.ts‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -237,6 +237,7 @@ export const make = Effect.gen(function* () {
237237
storageCleanupRun: true,
238238
databaseStorage: true,
239239
otlpEndpointCheck: true,
240+
secretSourceCheck: true,
240241
projectWorktreeCleanup: true,
241242
settledWorktreeCleanup: true,
242243
worktreesDirectory: true,

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

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -81,6 +81,7 @@ const RPC_AGGREGATES = {
8181
[WS_METHODS.serverDisableAcpRegistryProvider]: "server",
8282
[WS_METHODS.serverLogoutAcpRegistry]: "server",
8383
[WS_METHODS.serverDiscoverSourceControl]: "server",
84+
[WS_METHODS.serverCheckSecretSource]: "server",
8485
[WS_METHODS.serverGetTraceDiagnostics]: "server",
8586
[WS_METHODS.serverGetProcessDiagnostics]: "server",
8687
[WS_METHODS.serverGetHostResources]: "server",

‎apps/server/src/provider/ProviderInstanceRegistry.ts‎

Lines changed: 144 additions & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -92,18 +92,36 @@ const withoutSecretReferences = (
9292
typeof variable.value === "string" ? [{ ...variable, value: variable.value }] : [],
9393
);
9494

95+
interface CheckedSecret {
96+
readonly reference: SecretReference;
97+
readonly value: string;
98+
}
99+
100+
const sameReference = (a: SecretReference, b: SecretReference) =>
101+
a.provider === b.provider && a.reference === b.reference;
102+
103+
// `checked` supplies its reference's value instead of the resolver, which a concurrent refresh
104+
// may have re-read since the check.
95105
const readInstanceSecrets = Effect.fn("ProviderInstanceRegistry.readInstanceSecrets")(function* <R>(
96106
driver: AnyProviderDriver<R> | undefined,
97107
entry: ProviderInstanceConfig,
108+
checked?: CheckedSecret,
98109
) {
99110
const variables = entry.environment ?? [];
100111
const configFields = configSecretReferences(driver, entry);
101112
const references = [
102113
...secretReferencesIn(variables),
103114
...configFields.map(({ reference }) => reference),
104115
];
105-
const values =
106-
references.length === 0 ? [] : yield* (yield* SecretResolver.SecretResolver).read(references);
116+
const isChecked = (reference: SecretReference) =>
117+
checked !== undefined && sameReference(reference, checked.reference);
118+
const toRead = references.filter((reference) => !isChecked(reference));
119+
const read =
120+
toRead.length === 0 ? [] : yield* (yield* SecretResolver.SecretResolver).read(toRead);
121+
let readIndex = 0;
122+
const values = references.map((reference) =>
123+
isChecked(reference) ? checked?.value : read[readIndex++],
124+
);
107125
const unreadable: Array<string> = [];
108126
let index = 0;
109127
// An empty secret reads as unreadable, so a driver cannot fall back to an inherited credential.
@@ -130,6 +148,36 @@ const readInstanceSecrets = Effect.fn("ProviderInstanceRegistry.readInstanceSecr
130148
return { secrets, unreadable };
131149
});
132150

151+
// Replaces only the checked reference's value in the secrets a live instance already holds, so
152+
// another reference whose read failed earlier is not read again and does not park the instance.
153+
const carryCheckedSecret = <R>(
154+
driver: AnyProviderDriver<R> | undefined,
155+
entry: ProviderInstanceConfig,
156+
current: InstanceSecrets,
157+
{ reference: checked, value }: CheckedSecret,
158+
): InstanceSecrets => {
159+
const matches = (reference: SecretReference) => sameReference(reference, checked);
160+
// A live instance resolved every variable in order, so slots line up with the entry's variables
161+
// by position; names may repeat.
162+
const variables = entry.environment ?? [];
163+
const replacedSlots = configSecretReferences(driver, entry).filter(({ reference }) =>
164+
matches(reference),
165+
);
166+
return {
167+
environment: current.environment.map((variable, index) => {
168+
const source = variables[index]?.value;
169+
return source !== undefined && typeof source !== "string" && matches(source)
170+
? { ...variable, value }
171+
: variable;
172+
}),
173+
config: current.config.map((slot) =>
174+
replacedSlots.some(({ field, key }) => field === slot.field && key === slot.key)
175+
? { ...slot, value }
176+
: slot,
177+
),
178+
};
179+
};
180+
133181
/** Conflicting saved flags must preserve any explicit disable. */
134182
const resolveEntryEnabled = (entry: ProviderInstanceConfig, typedConfig: unknown): boolean => {
135183
const rawConfigEnabled = providerInstanceConfigEnabledFlag(entry.config);
@@ -161,6 +209,7 @@ const buildEntry = Effect.fn("ProviderInstanceRegistry.buildEntry")(function* <R
161209
readonly rawInstanceId: string;
162210
readonly entry: ProviderInstanceConfig;
163211
readonly deferSecrets: boolean;
212+
readonly carriedSecrets?: InstanceSecrets | undefined;
164213
}): Effect.fn.Return<
165214
| { readonly kind: "live"; readonly live: LiveEntry }
166215
| {
@@ -171,7 +220,15 @@ const buildEntry = Effect.fn("ProviderInstanceRegistry.buildEntry")(function* <R
171220
never,
172221
R | SecretResolver.SecretResolver
173222
> {
174-
const { driversById, parentScope, instanceId, rawInstanceId, entry, deferSecrets } = input;
223+
const {
224+
driversById,
225+
parentScope,
226+
instanceId,
227+
rawInstanceId,
228+
entry,
229+
deferSecrets,
230+
carriedSecrets,
231+
} = input;
175232
const blocked = input.blockedReason(entry.driver);
176233
if (blocked !== undefined) {
177234
return {
@@ -235,12 +292,14 @@ const buildEntry = Effect.fn("ProviderInstanceRegistry.buildEntry")(function* <R
235292
}),
236293
};
237294
}
238-
const { secrets, unreadable } = enabled
239-
? yield* readInstanceSecrets(driver, entry)
240-
: {
241-
secrets: { environment: withoutSecretReferences(entry.environment ?? []), config: [] },
242-
unreadable: [],
243-
};
295+
const { secrets, unreadable } = carriedSecrets
296+
? { secrets: carriedSecrets, unreadable: [] }
297+
: enabled
298+
? yield* readInstanceSecrets(driver, entry)
299+
: {
300+
secrets: { environment: withoutSecretReferences(entry.environment ?? []), config: [] },
301+
unreadable: [],
302+
};
244303
// Starting with a blank credential would fail later with a less useful error, or fall back to
245304
// whatever the server inherited.
246305
if (unreadable.length > 0) {
@@ -311,9 +370,10 @@ const makeReconcile = <R>(input: {
311370
configMap: ProviderInstanceConfigMap,
312371
rebuild?: ReadonlySet<ProviderInstanceId>,
313372
deferSecrets?: boolean,
373+
carried?: ReadonlyMap<ProviderInstanceId, InstanceSecrets>,
314374
) => Effect.Effect<void, never, R | SecretResolver.SecretResolver>) => {
315375
const { state, driversById, blockedReason, parentScope } = input;
316-
return (configMap, rebuild = new Set(), deferSecrets = false) =>
376+
return (configMap, rebuild = new Set(), deferSecrets = false, carried = new Map()) =>
317377
Effect.gen(function* () {
318378
const previousEntries = yield* Ref.get(state.entries);
319379
const previousUnavailable = yield* Ref.get(state.unavailable);
@@ -365,6 +425,7 @@ const makeReconcile = <R>(input: {
365425
const instanceId = ProviderInstanceId.make(rawInstanceId);
366426
const kept = previousEntries.has(instanceId) && !replacedIds.has(instanceId);
367427
return kept ||
428+
carried.has(instanceId) ||
368429
parkedSnapshot(instanceId, entry) !== undefined ||
369430
!(yield* isEntryEnabled(driversById, entry))
370431
? []
@@ -406,6 +467,7 @@ const makeReconcile = <R>(input: {
406467
rawInstanceId,
407468
entry,
408469
deferSecrets,
470+
carriedSecrets: carried.get(instanceId),
409471
});
410472
if (result.kind === "live") {
411473
builtEntries.set(instanceId, result.live);
@@ -503,44 +565,87 @@ export const makeProviderInstanceRegistry = Effect.fn(
503565
);
504566

505567
// Rebuilds an instance only when it was unavailable or its secrets changed, so a refresh does
506-
// not restart providers whose credentials are the same.
507-
const reloadSecrets: ProviderInstanceRegistryMutator.ProviderInstanceRegistryMutatorShape["reloadSecrets"] =
508-
Effect.fn("ProviderInstanceRegistry.reloadSecrets")(
509-
function* (instanceId) {
510-
const configMap = yield* Ref.get(configMapRef);
511-
const targets = yield* Effect.filter(Object.entries(configMap), ([rawInstanceId, entry]) =>
512-
(instanceId === undefined || rawInstanceId === instanceId) &&
513-
secretReferencesOf(driversById, entry).length > 0
514-
? isEntryEnabled(driversById, entry)
515-
: Effect.succeed(false),
516-
);
517-
if (targets.length === 0) return;
568+
// not restart providers whose credentials are the same. Without `checked` the cached values are
569+
// dropped first; with it, only that reference takes the checked value and the rest carry over.
570+
const reloadWhere = Effect.fn("ProviderInstanceRegistry.reloadWhere")(
571+
function* (
572+
select: (rawInstanceId: string, entry: ProviderInstanceConfig) => boolean,
573+
checked?: CheckedSecret,
574+
) {
575+
const configMap = yield* Ref.get(configMapRef);
576+
const targets = yield* Effect.filter(Object.entries(configMap), ([rawInstanceId, entry]) =>
577+
select(rawInstanceId, entry) && secretReferencesOf(driversById, entry).length > 0
578+
? isEntryEnabled(driversById, entry)
579+
: Effect.succeed(false),
580+
);
581+
if (targets.length === 0) return [];
582+
if (checked === undefined) {
518583
const resolver = yield* SecretResolver.SecretResolver;
519584
const references = targets.flatMap(([, entry]) => secretReferencesOf(driversById, entry));
520585
yield* resolver.invalidate(references);
521586
yield* resolver.read(references);
522-
const live = yield* Ref.get(entries);
523-
const rebuild = new Set<ProviderInstanceId>();
524-
for (const [rawInstanceId, entry] of targets) {
525-
const current = live.get(ProviderInstanceId.make(rawInstanceId));
526-
if (current === undefined) {
527-
rebuild.add(ProviderInstanceId.make(rawInstanceId));
528-
continue;
587+
}
588+
const live = yield* Ref.get(entries);
589+
const rebuild = new Set<ProviderInstanceId>();
590+
const carried = new Map<ProviderInstanceId, InstanceSecrets>();
591+
for (const [rawInstanceId, entry] of targets) {
592+
const instanceId = ProviderInstanceId.make(rawInstanceId);
593+
const current = live.get(instanceId);
594+
if (current === undefined) {
595+
rebuild.add(instanceId);
596+
if (checked !== undefined) {
597+
const { secrets, unreadable } = yield* readInstanceSecrets(
598+
driversById.get(entry.driver),
599+
entry,
600+
checked,
601+
);
602+
if (unreadable.length === 0) carried.set(instanceId, secrets);
529603
}
530-
const { secrets, unreadable } = yield* readInstanceSecrets(
604+
continue;
605+
}
606+
if (checked !== undefined) {
607+
const secrets = carryCheckedSecret(
531608
driversById.get(entry.driver),
532-
entry,
609+
current.entry,
610+
current.secrets,
611+
checked,
533612
);
534-
// A failed re-read keeps the working instance and the value it already holds.
535-
if (unreadable.length === 0 && !Equal.equals(secrets, current.secrets)) {
613+
if (!Equal.equals(secrets, current.secrets)) {
536614
rebuild.add(current.instance.instanceId);
615+
carried.set(current.instance.instanceId, secrets);
537616
}
617+
continue;
538618
}
539-
yield* reconcileWithR(configMap, rebuild);
540-
},
541-
(effect) => semaphore.withPermits(1)(effect),
542-
Effect.provideContext(driverContext),
543-
);
619+
const { secrets, unreadable } = yield* readInstanceSecrets(
620+
driversById.get(entry.driver),
621+
entry,
622+
);
623+
// A failed re-read keeps the working instance and the value it already holds.
624+
if (unreadable.length === 0 && !Equal.equals(secrets, current.secrets)) {
625+
rebuild.add(current.instance.instanceId);
626+
}
627+
}
628+
yield* reconcileWithR(configMap, rebuild, false, carried);
629+
return targets.map(([rawInstanceId]) => ProviderInstanceId.make(rawInstanceId));
630+
},
631+
(effect) => semaphore.withPermits(1)(effect),
632+
Effect.provideContext(driverContext),
633+
);
634+
const reloadSecrets: ProviderInstanceRegistryMutator.ProviderInstanceRegistryMutatorShape["reloadSecrets"] =
635+
(instanceId) =>
636+
reloadWhere(
637+
(rawInstanceId) => instanceId === undefined || rawInstanceId === instanceId,
638+
undefined,
639+
).pipe(Effect.asVoid);
640+
const applySecret: ProviderInstanceRegistryMutator.ProviderInstanceRegistryMutatorShape["applySecret"] =
641+
(reference, value) =>
642+
reloadWhere(
643+
(_, entry) =>
644+
secretReferencesOf(driversById, entry).some((candidate) =>
645+
sameReference(candidate, reference),
646+
),
647+
{ reference, value },
648+
);
544649

545650
// Reading secrets can wait on a vault unlock, so the server does not wait for it to start.
546651
yield* semaphore.withPermits(1)(
@@ -592,6 +697,7 @@ export const makeProviderInstanceRegistry = Effect.fn(
592697
const mutator: ProviderInstanceRegistryMutator.ProviderInstanceRegistryMutatorShape = {
593698
reconcile,
594699
reloadSecrets,
700+
applySecret,
595701
};
596702

597703
return { registry, mutator };

‎apps/server/src/provider/ProviderInstanceRegistryHydration.test.ts‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -165,6 +165,7 @@ describe("layerSettingsWatcher", () => {
165165
const mutator = Layer.succeed(ProviderInstanceRegistryMutator, {
166166
reconcile: () => Queue.offer(reconciled, undefined),
167167
reloadSecrets: () => Effect.sync(() => void reloads++),
168+
applySecret: () => Effect.succeed([]),
168169
});
169170
yield* Layer.build(
170171
layerSettingsWatcher(Stream.fromQueue(changes), initial).pipe(Layer.provide(mutator)),

‎apps/server/src/provider/ProviderInstanceRegistryMutator.ts‎

Lines changed: 13 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,24 @@
11
/** Reconcile closes removed/replaced scopes before creating replacements: at most one live instance per id. */
2-
import type { ProviderInstanceConfigMap, ProviderInstanceId } from "@t3tools/contracts";
2+
import type {
3+
ProviderInstanceConfigMap,
4+
ProviderInstanceId,
5+
SecretReference,
6+
} from "@t3tools/contracts";
37
import * as Context from "effect/Context";
48
import type * as Effect from "effect/Effect";
59

610
export interface ProviderInstanceRegistryMutatorShape {
711
readonly reconcile: (configMap: ProviderInstanceConfigMap) => Effect.Effect<void>;
812
/** Re-reads the secrets of every instance, or one, and rebuilds those whose secrets changed. */
913
readonly reloadSecrets: (instanceId?: ProviderInstanceId) => Effect.Effect<void>;
14+
/**
15+
* Rebuilds the instances that read `reference` with `value`, keeping the other secrets a live
16+
* instance holds, and returns them. A parked instance reads its other secrets from the resolver.
17+
*/
18+
readonly applySecret: (
19+
reference: SecretReference,
20+
value: string,
21+
) => Effect.Effect<ReadonlyArray<ProviderInstanceId>>;
1022
}
1123

1224
export class ProviderInstanceRegistryMutator extends Context.Service<

‎apps/server/src/provider/ProviderRegistry.ts‎

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@ import {
44
isProviderWorkspaceSnapshotPending,
55
ProviderDriverKind,
66
type ProviderInstanceId,
7+
type SecretReference,
78
type ServerProvider,
89
type ServerProviderUpdateState,
910
} from "@t3tools/contracts";
@@ -70,6 +71,12 @@ export class ProviderRegistry extends Context.Service<
7071
instanceId?: ProviderInstanceId,
7172
) => Effect.Effect<ReadonlyArray<ServerProvider>>;
7273

74+
/** Rebuilds and refreshes only the instances that read a secret, with the value the caller just read. */
75+
readonly applySecretAndRefresh: (
76+
reference: SecretReference,
77+
value: string,
78+
) => Effect.Effect<ReadonlyArray<ServerProvider>>;
79+
7380
/** Only refreshed instances can verify an update; the published list still includes every row. */
7481
readonly refreshAfterUpdate: (
7582
provider: ProviderDriverKind,
@@ -739,6 +746,15 @@ export const layer = Layer.effect(
739746
return yield* instanceId === undefined ? refresh() : refreshInstance(instanceId);
740747
});
741748

749+
const applySecretAndRefresh = Effect.fn("applySecretAndRefresh")(function* (
750+
reference: SecretReference,
751+
value: string,
752+
) {
753+
const instanceIds = yield* instanceRegistryMutator.applySecret(reference, value);
754+
yield* Effect.forEach(instanceIds, refreshInstance, { discard: true });
755+
return yield* Ref.get(providersRef);
756+
});
757+
742758
const refreshAfterUpdate = Effect.fn("refreshAfterUpdate")(function* (
743759
provider: ProviderDriverKind,
744760
selectedInstanceId: ProviderInstanceId,
@@ -1176,6 +1192,8 @@ export const layer = Layer.effect(
11761192
refreshInstance(instanceId).pipe(Effect.catchCause(recoverRefreshFailure)),
11771193
reloadSecretsAndRefresh: (instanceId?: ProviderInstanceId) =>
11781194
reloadSecretsAndRefresh(instanceId).pipe(Effect.catchCause(recoverRefreshFailure)),
1195+
applySecretAndRefresh: (reference: SecretReference, value: string) =>
1196+
applySecretAndRefresh(reference, value).pipe(Effect.catchCause(recoverRefreshFailure)),
11791197
refreshWorkspaceSnapshot: (input) =>
11801198
refreshWorkspaceSnapshot(input).pipe(Effect.catchCause(recoverRefreshFailure)),
11811199
refreshAfterUpdate,

‎apps/server/src/provider/providerMaintenanceRunner.test.ts‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -207,6 +207,7 @@ function makeRegistry(
207207
refresh: () => Ref.get(providersRef),
208208
refreshInstance: () => Ref.get(providersRef),
209209
reloadSecretsAndRefresh: () => Ref.get(providersRef),
210+
applySecretAndRefresh: () => Ref.get(providersRef),
210211
refreshAfterUpdate: () => {
211212
const version = options?.installedVersionAfterUpdate;
212213
if (version === undefined) {

‎apps/server/src/provider/testUtils/providerRegistryMock.ts‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,7 @@ const makeProviderRegistryMock = (
1212
refresh: () => Effect.succeed(providers),
1313
refreshInstance: () => Effect.succeed(providers),
1414
reloadSecretsAndRefresh: () => Effect.succeed(providers),
15+
applySecretAndRefresh: () => Effect.succeed(providers),
1516
refreshAfterUpdate: () => Effect.succeed(providers),
1617
refreshWorkspaceSnapshot: () => Effect.succeed(providers),
1718
invalidateModelCaches: () => Effect.void,

0 commit comments

Comments
 (0)