Skip to content

Commit 49eb332

Browse files
committed
feat(secrets): check a secret reference before saving it
Settings gains a check button beside a secret reference. It reads the secret fresh from its provider and says whether it resolved, without sending the value to the client. A readable secret also rebuilds the provider instances that depend on it. Signed-off-by: Yordis Prieto <[email protected]>
1 parent d929e72 commit 49eb332

24 files changed

Lines changed: 662 additions & 93 deletions

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

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -77,6 +77,7 @@ const RPC_AGGREGATES = {
7777
[WS_METHODS.serverDisableAcpRegistryProvider]: "server",
7878
[WS_METHODS.serverLogoutAcpRegistry]: "server",
7979
[WS_METHODS.serverDiscoverSourceControl]: "server",
80+
[WS_METHODS.serverCheckSecretSource]: "server",
8081
[WS_METHODS.serverGetTraceDiagnostics]: "server",
8182
[WS_METHODS.serverGetProcessDiagnostics]: "server",
8283
[WS_METHODS.serverGetHostResources]: "server",

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

Lines changed: 124 additions & 41 deletions
Original file line numberDiff line numberDiff line change
@@ -130,6 +130,39 @@ const readInstanceSecrets = Effect.fn("ProviderInstanceRegistry.readInstanceSecr
130130
return { secrets, unreadable };
131131
});
132132

133+
// Replaces only the checked reference's value in the secrets a live instance already holds, so
134+
// another reference whose read failed earlier is not read again and does not park the instance.
135+
const carryCheckedSecret = <R>(
136+
driver: AnyProviderDriver<R> | undefined,
137+
entry: ProviderInstanceConfig,
138+
current: InstanceSecrets,
139+
checked: SecretReference,
140+
value: string | undefined,
141+
): InstanceSecrets => {
142+
if (value === undefined || value.trim() === "") return current;
143+
const matches = (reference: SecretReference) =>
144+
reference.provider === checked.provider && reference.reference === checked.reference;
145+
// A live instance resolved every variable in order, so slots line up with the entry's variables
146+
// by position; names may repeat.
147+
const variables = entry.environment ?? [];
148+
const replacedFields = new Set(
149+
configSecretReferences(driver, entry).flatMap(({ field, reference }) =>
150+
matches(reference) ? [field] : [],
151+
),
152+
);
153+
return {
154+
environment: current.environment.map((variable, index) => {
155+
const source = variables[index]?.value;
156+
return source !== undefined && typeof source !== "string" && matches(source)
157+
? { ...variable, value }
158+
: variable;
159+
}),
160+
config: current.config.map((slot) =>
161+
replacedFields.has(slot.field) ? { ...slot, value } : slot,
162+
),
163+
};
164+
};
165+
133166
/** Conflicting saved flags must preserve any explicit disable. */
134167
const resolveEntryEnabled = (entry: ProviderInstanceConfig, typedConfig: unknown): boolean => {
135168
const rawConfigEnabled = providerInstanceConfigEnabledFlag(entry.config);
@@ -161,6 +194,7 @@ const buildEntry = Effect.fn("ProviderInstanceRegistry.buildEntry")(function* <R
161194
readonly rawInstanceId: string;
162195
readonly entry: ProviderInstanceConfig;
163196
readonly deferSecrets: boolean;
197+
readonly carriedSecrets?: InstanceSecrets | undefined;
164198
}): Effect.fn.Return<
165199
| { readonly kind: "live"; readonly live: LiveEntry }
166200
| {
@@ -171,7 +205,15 @@ const buildEntry = Effect.fn("ProviderInstanceRegistry.buildEntry")(function* <R
171205
never,
172206
R | SecretResolver.SecretResolver
173207
> {
174-
const { driversById, parentScope, instanceId, rawInstanceId, entry, deferSecrets } = input;
208+
const {
209+
driversById,
210+
parentScope,
211+
instanceId,
212+
rawInstanceId,
213+
entry,
214+
deferSecrets,
215+
carriedSecrets,
216+
} = input;
175217
const blocked = input.blockedReason(entry.driver);
176218
if (blocked !== undefined) {
177219
return {
@@ -235,12 +277,14 @@ const buildEntry = Effect.fn("ProviderInstanceRegistry.buildEntry")(function* <R
235277
}),
236278
};
237279
}
238-
const { secrets, unreadable } = enabled
239-
? yield* readInstanceSecrets(driver, entry)
240-
: {
241-
secrets: { environment: withoutSecretReferences(entry.environment ?? []), config: [] },
242-
unreadable: [],
243-
};
280+
const { secrets, unreadable } = carriedSecrets
281+
? { secrets: carriedSecrets, unreadable: [] }
282+
: enabled
283+
? yield* readInstanceSecrets(driver, entry)
284+
: {
285+
secrets: { environment: withoutSecretReferences(entry.environment ?? []), config: [] },
286+
unreadable: [],
287+
};
244288
// Starting with a blank credential would fail later with a less useful error, or fall back to
245289
// whatever the server inherited.
246290
if (unreadable.length > 0) {
@@ -311,9 +355,10 @@ const makeReconcile = <R>(input: {
311355
configMap: ProviderInstanceConfigMap,
312356
rebuild?: ReadonlySet<ProviderInstanceId>,
313357
deferSecrets?: boolean,
358+
carried?: ReadonlyMap<ProviderInstanceId, InstanceSecrets>,
314359
) => Effect.Effect<void, never, R | SecretResolver.SecretResolver>) => {
315360
const { state, driversById, blockedReason, parentScope } = input;
316-
return (configMap, rebuild = new Set(), deferSecrets = false) =>
361+
return (configMap, rebuild = new Set(), deferSecrets = false, carried = new Map()) =>
317362
Effect.gen(function* () {
318363
const previousEntries = yield* Ref.get(state.entries);
319364
const previousUnavailable = yield* Ref.get(state.unavailable);
@@ -365,6 +410,7 @@ const makeReconcile = <R>(input: {
365410
const instanceId = ProviderInstanceId.make(rawInstanceId);
366411
const kept = previousEntries.has(instanceId) && !replacedIds.has(instanceId);
367412
return kept ||
413+
carried.has(instanceId) ||
368414
parkedSnapshot(instanceId, entry) !== undefined ||
369415
!(yield* isEntryEnabled(driversById, entry))
370416
? []
@@ -406,6 +452,7 @@ const makeReconcile = <R>(input: {
406452
rawInstanceId,
407453
entry,
408454
deferSecrets,
455+
carriedSecrets: carried.get(instanceId),
409456
});
410457
if (result.kind === "live") {
411458
builtEntries.set(instanceId, result.live);
@@ -503,44 +550,79 @@ export const makeProviderInstanceRegistry = Effect.fn(
503550
);
504551

505552
// 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;
518-
const resolver = yield* SecretResolver.SecretResolver;
519-
const references = targets.flatMap(([, entry]) => secretReferencesOf(driversById, entry));
520-
yield* resolver.invalidate(references);
521-
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;
529-
}
530-
const { secrets, unreadable } = yield* readInstanceSecrets(
553+
// not restart providers whose credentials are the same. a missing `checked` reference drops
554+
// the cached values first; with one, only that value is replaced and the rest are carried over.
555+
const reloadWhere = Effect.fn("ProviderInstanceRegistry.reloadWhere")(
556+
function* (
557+
select: (rawInstanceId: string, entry: ProviderInstanceConfig) => boolean,
558+
checked?: SecretReference,
559+
) {
560+
const configMap = yield* Ref.get(configMapRef);
561+
const targets = yield* Effect.filter(Object.entries(configMap), ([rawInstanceId, entry]) =>
562+
select(rawInstanceId, entry) && secretReferencesOf(driversById, entry).length > 0
563+
? isEntryEnabled(driversById, entry)
564+
: Effect.succeed(false),
565+
);
566+
if (targets.length === 0) return [];
567+
const resolver = yield* SecretResolver.SecretResolver;
568+
const references = targets.flatMap(([, entry]) => secretReferencesOf(driversById, entry));
569+
if (checked === undefined) yield* resolver.invalidate(references);
570+
const [checkedValue] = yield* resolver.read(checked === undefined ? references : [checked]);
571+
const live = yield* Ref.get(entries);
572+
const rebuild = new Set<ProviderInstanceId>();
573+
const carried = new Map<ProviderInstanceId, InstanceSecrets>();
574+
for (const [rawInstanceId, entry] of targets) {
575+
const current = live.get(ProviderInstanceId.make(rawInstanceId));
576+
if (current === undefined) {
577+
rebuild.add(ProviderInstanceId.make(rawInstanceId));
578+
continue;
579+
}
580+
if (checked !== undefined) {
581+
const secrets = carryCheckedSecret(
531582
driversById.get(entry.driver),
532-
entry,
583+
current.entry,
584+
current.secrets,
585+
checked,
586+
checkedValue,
533587
);
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)) {
588+
if (!Equal.equals(secrets, current.secrets)) {
536589
rebuild.add(current.instance.instanceId);
590+
carried.set(current.instance.instanceId, secrets);
537591
}
592+
continue;
538593
}
539-
yield* reconcileWithR(configMap, rebuild);
540-
},
541-
(effect) => semaphore.withPermits(1)(effect),
542-
Effect.provideContext(driverContext),
543-
);
594+
const { secrets, unreadable } = yield* readInstanceSecrets(
595+
driversById.get(entry.driver),
596+
entry,
597+
);
598+
// A failed re-read keeps the working instance and the value it already holds.
599+
if (unreadable.length === 0 && !Equal.equals(secrets, current.secrets)) {
600+
rebuild.add(current.instance.instanceId);
601+
}
602+
}
603+
yield* reconcileWithR(configMap, rebuild, false, carried);
604+
return targets.map(([rawInstanceId]) => ProviderInstanceId.make(rawInstanceId));
605+
},
606+
(effect) => semaphore.withPermits(1)(effect),
607+
Effect.provideContext(driverContext),
608+
);
609+
const reloadSecrets: ProviderInstanceRegistryMutator.ProviderInstanceRegistryMutatorShape["reloadSecrets"] =
610+
(instanceId) =>
611+
reloadWhere(
612+
(rawInstanceId) => instanceId === undefined || rawInstanceId === instanceId,
613+
undefined,
614+
).pipe(Effect.asVoid);
615+
const applySecret: ProviderInstanceRegistryMutator.ProviderInstanceRegistryMutatorShape["applySecret"] =
616+
(reference) =>
617+
reloadWhere(
618+
(_, entry) =>
619+
secretReferencesOf(driversById, entry).some(
620+
(candidate) =>
621+
candidate.provider === reference.provider &&
622+
candidate.reference === reference.reference,
623+
),
624+
reference,
625+
);
544626

545627
// Reading secrets can wait on a vault unlock, so the server does not wait for it to start.
546628
yield* semaphore.withPermits(1)(
@@ -592,6 +674,7 @@ export const makeProviderInstanceRegistry = Effect.fn(
592674
const mutator: ProviderInstanceRegistryMutator.ProviderInstanceRegistryMutatorShape = {
593675
reconcile,
594676
reloadSecrets,
677+
applySecret,
595678
};
596679

597680
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: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,23 @@
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`, from the value its resolver already holds, and
16+
* returns them. Nothing else is read.
17+
*/
18+
readonly applySecret: (
19+
reference: SecretReference,
20+
) => Effect.Effect<ReadonlyArray<ProviderInstanceId>>;
1021
}
1122

1223
export class ProviderInstanceRegistryMutator extends Context.Service<

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

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@ import {
33
isProviderWorkspaceSnapshotCurrent,
44
ProviderDriverKind,
55
type ProviderInstanceId,
6+
type SecretReference,
67
type ServerProvider,
78
type ServerProviderUpdateState,
89
} from "@t3tools/contracts";
@@ -69,6 +70,11 @@ export class ProviderRegistry extends Context.Service<
6970
instanceId?: ProviderInstanceId,
7071
) => Effect.Effect<ReadonlyArray<ServerProvider>>;
7172

73+
/** Rebuilds and refreshes only the instances that read a secret the caller just read. */
74+
readonly applySecretAndRefresh: (
75+
reference: SecretReference,
76+
) => Effect.Effect<ReadonlyArray<ServerProvider>>;
77+
7278
/** Only refreshed instances can verify an update; the published list still includes every row. */
7379
readonly refreshAfterUpdate: (
7480
provider: ProviderDriverKind,
@@ -692,6 +698,14 @@ export const layer = Layer.effect(
692698
return yield* instanceId === undefined ? refresh() : refreshInstance(instanceId);
693699
});
694700

701+
const applySecretAndRefresh = Effect.fn("applySecretAndRefresh")(function* (
702+
reference: SecretReference,
703+
) {
704+
const instanceIds = yield* instanceRegistryMutator.applySecret(reference);
705+
yield* Effect.forEach(instanceIds, refreshInstance, { discard: true });
706+
return yield* Ref.get(providersRef);
707+
});
708+
695709
const refreshAfterUpdate = Effect.fn("refreshAfterUpdate")(function* (
696710
provider: ProviderDriverKind,
697711
selectedInstanceId: ProviderInstanceId,
@@ -1077,6 +1091,8 @@ export const layer = Layer.effect(
10771091
refreshInstance(instanceId).pipe(Effect.catchCause(recoverRefreshFailure)),
10781092
reloadSecretsAndRefresh: (instanceId?: ProviderInstanceId) =>
10791093
reloadSecretsAndRefresh(instanceId).pipe(Effect.catchCause(recoverRefreshFailure)),
1094+
applySecretAndRefresh: (reference: SecretReference) =>
1095+
applySecretAndRefresh(reference).pipe(Effect.catchCause(recoverRefreshFailure)),
10801096
refreshWorkspaceSnapshot: (input) =>
10811097
refreshWorkspaceSnapshot(input).pipe(Effect.catchCause(recoverRefreshFailure)),
10821098
refreshAfterUpdate,

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

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -198,6 +198,7 @@ function makeRegistry(
198198
refresh: () => Ref.get(providersRef),
199199
refreshInstance: () => Ref.get(providersRef),
200200
reloadSecretsAndRefresh: () => Ref.get(providersRef),
201+
applySecretAndRefresh: () => Ref.get(providersRef),
201202
refreshAfterUpdate: () => {
202203
const version = options?.installedVersionAfterUpdate;
203204
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)