Skip to content

Commit 9559e3a

Browse files
fix(server): a secret check applies the value it read, to its own config key
The check passed only the reference to the registry, which read the value back from the resolver cache. A Settings refresh holding the registry lock could re-read that reference from a now-locked vault in between, so the check reported Resolved while the instance kept the old value or stayed parked. The checked value now travels with the reference and is used for both live and parked instances without going through the cache. A record-valued config secret matched its slots by field alone, so checking one key overwrote its siblings; slots now match on field and key.
1 parent cf10da0 commit 9559e3a

5 files changed

Lines changed: 159 additions & 47 deletions

File tree

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

Lines changed: 51 additions & 28 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.
@@ -136,19 +154,14 @@ const carryCheckedSecret = <R>(
136154
driver: AnyProviderDriver<R> | undefined,
137155
entry: ProviderInstanceConfig,
138156
current: InstanceSecrets,
139-
checked: SecretReference,
140-
value: string | undefined,
157+
{ reference: checked, value }: CheckedSecret,
141158
): InstanceSecrets => {
142-
if (value === undefined || value.trim() === "") return current;
143-
const matches = (reference: SecretReference) =>
144-
reference.provider === checked.provider && reference.reference === checked.reference;
159+
const matches = (reference: SecretReference) => sameReference(reference, checked);
145160
// A live instance resolved every variable in order, so slots line up with the entry's variables
146161
// by position; names may repeat.
147162
const variables = entry.environment ?? [];
148-
const replacedFields = new Set(
149-
configSecretReferences(driver, entry).flatMap(({ field, reference }) =>
150-
matches(reference) ? [field] : [],
151-
),
163+
const replacedSlots = configSecretReferences(driver, entry).filter(({ reference }) =>
164+
matches(reference),
152165
);
153166
return {
154167
environment: current.environment.map((variable, index) => {
@@ -158,7 +171,9 @@ const carryCheckedSecret = <R>(
158171
: variable;
159172
}),
160173
config: current.config.map((slot) =>
161-
replacedFields.has(slot.field) ? { ...slot, value } : slot,
174+
replacedSlots.some(({ field, key }) => field === slot.field && key === slot.key)
175+
? { ...slot, value }
176+
: slot,
162177
),
163178
};
164179
};
@@ -550,12 +565,12 @@ export const makeProviderInstanceRegistry = Effect.fn(
550565
);
551566

552567
// Rebuilds an instance only when it was unavailable or its secrets changed, so a refresh does
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.
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.
555570
const reloadWhere = Effect.fn("ProviderInstanceRegistry.reloadWhere")(
556571
function* (
557572
select: (rawInstanceId: string, entry: ProviderInstanceConfig) => boolean,
558-
checked?: SecretReference,
573+
checked?: CheckedSecret,
559574
) {
560575
const configMap = yield* Ref.get(configMapRef);
561576
const targets = yield* Effect.filter(Object.entries(configMap), ([rawInstanceId, entry]) =>
@@ -564,17 +579,28 @@ export const makeProviderInstanceRegistry = Effect.fn(
564579
: Effect.succeed(false),
565580
);
566581
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]);
582+
if (checked === undefined) {
583+
const resolver = yield* SecretResolver.SecretResolver;
584+
const references = targets.flatMap(([, entry]) => secretReferencesOf(driversById, entry));
585+
yield* resolver.invalidate(references);
586+
yield* resolver.read(references);
587+
}
571588
const live = yield* Ref.get(entries);
572589
const rebuild = new Set<ProviderInstanceId>();
573590
const carried = new Map<ProviderInstanceId, InstanceSecrets>();
574591
for (const [rawInstanceId, entry] of targets) {
575-
const current = live.get(ProviderInstanceId.make(rawInstanceId));
592+
const instanceId = ProviderInstanceId.make(rawInstanceId);
593+
const current = live.get(instanceId);
576594
if (current === undefined) {
577-
rebuild.add(ProviderInstanceId.make(rawInstanceId));
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);
603+
}
578604
continue;
579605
}
580606
if (checked !== undefined) {
@@ -583,7 +609,6 @@ export const makeProviderInstanceRegistry = Effect.fn(
583609
current.entry,
584610
current.secrets,
585611
checked,
586-
checkedValue,
587612
);
588613
if (!Equal.equals(secrets, current.secrets)) {
589614
rebuild.add(current.instance.instanceId);
@@ -613,15 +638,13 @@ export const makeProviderInstanceRegistry = Effect.fn(
613638
undefined,
614639
).pipe(Effect.asVoid);
615640
const applySecret: ProviderInstanceRegistryMutator.ProviderInstanceRegistryMutatorShape["applySecret"] =
616-
(reference) =>
641+
(reference, value) =>
617642
reloadWhere(
618643
(_, entry) =>
619-
secretReferencesOf(driversById, entry).some(
620-
(candidate) =>
621-
candidate.provider === reference.provider &&
622-
candidate.reference === reference.reference,
644+
secretReferencesOf(driversById, entry).some((candidate) =>
645+
sameReference(candidate, reference),
623646
),
624-
reference,
647+
{ reference, value },
625648
);
626649

627650
// Reading secrets can wait on a vault unlock, so the server does not wait for it to start.

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

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,11 +12,12 @@ export interface ProviderInstanceRegistryMutatorShape {
1212
/** Re-reads the secrets of every instance, or one, and rebuilds those whose secrets changed. */
1313
readonly reloadSecrets: (instanceId?: ProviderInstanceId) => Effect.Effect<void>;
1414
/**
15-
* Rebuilds the instances that read `reference`, from the value its resolver already holds, and
16-
* returns them. Nothing else is read.
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.
1717
*/
1818
readonly applySecret: (
1919
reference: SecretReference,
20+
value: string,
2021
) => Effect.Effect<ReadonlyArray<ProviderInstanceId>>;
2122
}
2223

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

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -70,9 +70,10 @@ export class ProviderRegistry extends Context.Service<
7070
instanceId?: ProviderInstanceId,
7171
) => Effect.Effect<ReadonlyArray<ServerProvider>>;
7272

73-
/** Rebuilds and refreshes only the instances that read a secret the caller just read. */
73+
/** Rebuilds and refreshes only the instances that read a secret, with the value the caller just read. */
7474
readonly applySecretAndRefresh: (
7575
reference: SecretReference,
76+
value: string,
7677
) => Effect.Effect<ReadonlyArray<ServerProvider>>;
7778

7879
/** Only refreshed instances can verify an update; the published list still includes every row. */
@@ -700,8 +701,9 @@ export const layer = Layer.effect(
700701

701702
const applySecretAndRefresh = Effect.fn("applySecretAndRefresh")(function* (
702703
reference: SecretReference,
704+
value: string,
703705
) {
704-
const instanceIds = yield* instanceRegistryMutator.applySecret(reference);
706+
const instanceIds = yield* instanceRegistryMutator.applySecret(reference, value);
705707
yield* Effect.forEach(instanceIds, refreshInstance, { discard: true });
706708
return yield* Ref.get(providersRef);
707709
});
@@ -1091,8 +1093,8 @@ export const layer = Layer.effect(
10911093
refreshInstance(instanceId).pipe(Effect.catchCause(recoverRefreshFailure)),
10921094
reloadSecretsAndRefresh: (instanceId?: ProviderInstanceId) =>
10931095
reloadSecretsAndRefresh(instanceId).pipe(Effect.catchCause(recoverRefreshFailure)),
1094-
applySecretAndRefresh: (reference: SecretReference) =>
1095-
applySecretAndRefresh(reference).pipe(Effect.catchCause(recoverRefreshFailure)),
1096+
applySecretAndRefresh: (reference: SecretReference, value: string) =>
1097+
applySecretAndRefresh(reference, value).pipe(Effect.catchCause(recoverRefreshFailure)),
10961098
refreshWorkspaceSnapshot: (input) =>
10971099
refreshWorkspaceSnapshot(input).pipe(Effect.catchCause(recoverRefreshFailure)),
10981100
refreshAfterUpdate,

‎apps/server/src/secrets/SecretCheck.test.ts‎

Lines changed: 98 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@ import {
77
SecretProviderId,
88
SecretProviderKind,
99
type SecretReference,
10+
SettingsSecretValue,
1011
type ServerProvider,
1112
} from "@t3tools/contracts";
1213
import type { AnyProviderDriver, ProviderInstance } from "@t3tools/provider-core/server/driver";
@@ -15,7 +16,9 @@ import * as ProviderLatestVersions from "@t3tools/provider-core/server/ProviderL
1516
import * as SecretResolver from "@t3tools/secret-provider-core/server/SecretResolver";
1617
import { defineSecretProviderDriver } from "@t3tools/secret-provider-core/server/driver";
1718
import { defineSecretProvider } from "@t3tools/secret-provider-core/shared/definition";
19+
import * as Deferred from "effect/Deferred";
1820
import * as Effect from "effect/Effect";
21+
import * as Fiber from "effect/Fiber";
1922
import { HttpClient, HttpClientResponse } from "effect/http";
2023
import * as Layer from "effect/Layer";
2124
import * as PubSub from "effect/PubSub";
@@ -55,14 +58,19 @@ const providerSnapshot = (instanceId: ProviderInstanceId): ServerProvider => ({
5558
/**
5659
* A server whose `dependent` instance reads `dependentReads` and `unrelated` reads `other`, all
5760
* through the real resolver, instance registry and provider registry. `vault` answers each read of
58-
* a reference with the next queued value, repeating the last one.
61+
* a reference with the next queued value, repeating the last one, after `beforeRead`.
5962
*/
6063
const setup = Effect.fn("SecretCheckTest.setup")(function* (
6164
vault: Map<string, Array<string | undefined>>,
6265
dependentReads: ReadonlyArray<SecretReference> = [wanted],
66+
options: {
67+
readonly dependentConfig?: unknown;
68+
readonly beforeRead?: (reference: string) => Effect.Effect<void>;
69+
} = {},
6370
) {
6471
const reads: Array<string> = [];
6572
const created: Array<{ instanceId: ProviderInstanceId; secrets: ReadonlyArray<unknown> }> = [];
73+
const createdConfigs: Array<unknown> = [];
6674
const refreshed: Array<ProviderInstanceId> = [];
6775

6876
const secretDriver = defineSecretProviderDriver({
@@ -76,26 +84,35 @@ const setup = Effect.fn("SecretCheckTest.setup")(function* (
7684
invalidReferenceMessage: "Use fake://item.",
7785
}),
7886
read: (_config, references) =>
79-
Effect.sync(() =>
80-
references.map((reference) => {
81-
reads.push(reference);
82-
const answers = vault.get(reference) ?? [];
83-
return answers.length > 1 ? answers.shift() : answers[0];
84-
}),
87+
Effect.forEach(references, (reference) =>
88+
(options.beforeRead?.(reference) ?? Effect.void).pipe(
89+
Effect.andThen(
90+
Effect.sync(() => {
91+
reads.push(reference);
92+
const answers = vault.get(reference) ?? [];
93+
return answers.length > 1 ? answers.shift() : answers[0];
94+
}),
95+
),
96+
),
8597
),
8698
});
8799

88100
const driver: AnyProviderDriver = {
89101
driverKind,
90102
metadata: { displayName: "Fake" },
91-
configSchema: Schema.Unknown,
103+
configSchema: Schema.Struct({
104+
keys: Schema.Record(Schema.String, SettingsSecretValue).pipe(
105+
Schema.withDecodingDefault(Effect.succeed({})),
106+
),
107+
}),
92108
defaultConfig: () => ({}),
93109
create: (input) =>
94110
Effect.sync(() => {
95111
created.push({
96112
instanceId: input.instanceId,
97113
secrets: input.environment.map((variable) => variable.value),
98114
});
115+
createdConfigs.push(input.config);
99116
const snapshot = providerSnapshot(input.instanceId);
100117
return {
101118
instanceId: input.instanceId,
@@ -124,9 +141,9 @@ const setup = Effect.fn("SecretCheckTest.setup")(function* (
124141
} satisfies ProviderInstance;
125142
}),
126143
};
127-
const instanceConfig = (secrets: ReadonlyArray<SecretReference>) => ({
144+
const instanceConfig = (secrets: ReadonlyArray<SecretReference>, config: unknown = {}) => ({
128145
driver: driverKind,
129-
config: {},
146+
config,
130147
environment: secrets.map((secret, index) => ({
131148
name: `API_KEY_${index}`,
132149
value: secret,
@@ -145,7 +162,7 @@ const setup = Effect.fn("SecretCheckTest.setup")(function* (
145162
const { registry, mutator } = yield* ProviderInstanceRegistry.makeProviderInstanceRegistry({
146163
drivers: [driver],
147164
configMap: {
148-
[dependent]: instanceConfig(dependentReads),
165+
[dependent]: instanceConfig(dependentReads, options.dependentConfig),
149166
[unrelated]: instanceConfig([other]),
150167
},
151168
}).pipe(Effect.provide(resolverContext));
@@ -167,7 +184,7 @@ const setup = Effect.fn("SecretCheckTest.setup")(function* (
167184
);
168185
const secretCheck = yield* SecretCheck.SecretCheck.pipe(Effect.provide(services));
169186
const resolver = yield* SecretResolver.SecretResolver.pipe(Effect.provide(resolverContext));
170-
return { secretCheck, registry, mutator, resolver, reads, created, refreshed };
187+
return { secretCheck, registry, mutator, resolver, reads, created, createdConfigs, refreshed };
171188
});
172189

173190
const layerTest = Layer.mergeAll(
@@ -274,4 +291,73 @@ it.layer(layerTest)("SecretCheck", (it) => {
274291
assert.deepStrictEqual(yield* server.registry.listUnavailable, []);
275292
}).pipe(Effect.scoped),
276293
);
294+
295+
it.effect("a check applies the value it read when a refresh re-reads that secret first", () =>
296+
Effect.forEach(
297+
// A live instance holding the old value, and one parked on a locked vault.
298+
["wanted-old", undefined],
299+
(initial) =>
300+
Effect.gen(function* () {
301+
const vault = new Map<string, Array<string | undefined>>([
302+
[wanted.reference, [initial]],
303+
[other.reference, ["other-key"]],
304+
]);
305+
const readStarted = yield* Deferred.make<void>();
306+
const release = yield* Deferred.make<void>();
307+
let gate: Effect.Effect<void> = Effect.void;
308+
const server = yield* setup(vault, [wanted], {
309+
beforeRead: () => {
310+
const current = gate;
311+
gate = Effect.void;
312+
return current;
313+
},
314+
});
315+
// The check reads the rotated value; the refresh's read after it finds the vault locked.
316+
vault.set(wanted.reference, ["wanted-new", undefined]);
317+
gate = Deferred.succeed(readStarted, undefined).pipe(
318+
Effect.andThen(Deferred.await(release)),
319+
);
320+
321+
const check = yield* server.secretCheck
322+
.check(wanted)
323+
.pipe(Effect.forkChild({ startImmediately: true }));
324+
yield* Deferred.await(readStarted);
325+
// The refresh takes the registry lock, then waits on the resolver for the check's read.
326+
const refresh = yield* server.mutator
327+
.reloadSecrets(dependent)
328+
.pipe(Effect.forkChild({ startImmediately: true }));
329+
yield* Deferred.succeed(release, undefined);
330+
331+
assert.deepStrictEqual(yield* Fiber.join(check), { _tag: "Resolved" });
332+
yield* Fiber.join(refresh);
333+
assert.deepStrictEqual(server.created.at(-1), {
334+
instanceId: dependent,
335+
secrets: ["wanted-new"],
336+
});
337+
assert.deepStrictEqual(yield* server.registry.listUnavailable, []);
338+
}).pipe(Effect.scoped),
339+
{ discard: true },
340+
),
341+
);
342+
343+
it.effect("a check replaces only its own key of a record-valued config secret", () =>
344+
Effect.gen(function* () {
345+
const vault = new Map<string, Array<string | undefined>>([
346+
[wanted.reference, ["wanted-old"]],
347+
[locked.reference, ["locked-key"]],
348+
[other.reference, ["other-key"]],
349+
]);
350+
const server = yield* setup(vault, [], {
351+
dependentConfig: { keys: { a: wanted, b: locked } },
352+
});
353+
vault.set(wanted.reference, ["wanted-new"]);
354+
355+
assert.deepStrictEqual(yield* server.secretCheck.check(wanted), { _tag: "Resolved" });
356+
357+
assert.deepStrictEqual(server.created.at(-1), { instanceId: dependent, secrets: [] });
358+
assert.deepStrictEqual(server.createdConfigs.at(-1), {
359+
keys: { a: "wanted-new", b: "locked-key" },
360+
});
361+
}).pipe(Effect.scoped),
362+
);
277363
});

‎apps/server/src/secrets/SecretCheck.ts‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ const make = Effect.gen(function* () {
2929
detail: `Could not read this secret from "${yield* resolver.label(reference.provider)}". Check the provider's settings and that its store is unlocked.`,
3030
} as const;
3131
}
32-
yield* providerRegistry.applySecretAndRefresh(reference);
32+
yield* providerRegistry.applySecretAndRefresh(reference, value);
3333
return { _tag: "Resolved" } as const;
3434
});
3535

0 commit comments

Comments
 (0)