@devries-cameron20 / t3code-1 / commits / 81899ce04c
Fork 0

The best way to control Claude Code, Codex and more from any computer or phone

feat(server): read Bitbucket and GitCafe credentials from a secret provider (#27746)

Co-authored-by: Julius Marminge <51714798+juliusmarminge@users.noreply.github.com> Co-authored-by: Claude Opus 5.5 <noreply@anthropic.com> Signed-off-by: Yordis Prieto <yordis.prieto@gmail.com>

Yordis Prieto committed Oct 30, 2026 at 17:53 UTC 81899ce04ca7c20cb5c93177f595084701d3d434
29 files changed +655 -119
apps/server/src/provider/ProviderInstanceRegistry.test.ts
+26 -2
@@ -15,6 +15,7 @@ import {
15 type ResolvedProviderInstanceEnvironment,
16 ProviderInstanceId,
17 SecretProviderId,
18 + SettingsSecretValue,
19 type SecretReference,
20 } from "@t3tools/contracts";
21 import * as ProviderLatestVersions from "@t3tools/provider-core/server/ProviderLatestVersions";
@@ -802,11 +803,13 @@ describe("ProviderInstanceRegistry secret environment", () => {
803 function setup(
804 initial: Record<string, string>,
805 configSchema: AnyProviderDriver["configSchema"] = Schema.Unknown,
806 + config: unknown = {},
807 ) {
808 const vault = new Map(Object.entries(initial));
809 const reads: Array<ReadonlyArray<string>> = [];
810 const invalidated: Array<ReadonlyArray<string>> = [];
811 const created: Array<ResolvedProviderInstanceEnvironment> = [];
812 + const configs: Array<unknown> = [];
813 const driver: AnyProviderDriver = {
814 driverKind,
815 metadata: { displayName: "Fake" },
@@ -815,6 +818,7 @@ describe("ProviderInstanceRegistry secret environment", () => {
818 create: (input) =>
819 Effect.sync(() => {
820 created.push(input.environment);
821 + configs.push(input.config);
822 return { instanceId: input.instanceId, enabled: input.enabled } as ProviderInstance;
823 }),
824 };
@@ -837,7 +841,7 @@ describe("ProviderInstanceRegistry secret environment", () => {
841 const configMap: ProviderInstanceConfigMap = {
842 [instanceId]: {
843 driver: driverKind,
840 - config: {},
844 + config,
845 environment: [
846 { name: "OPENAI_API_KEY", value: secret, sensitive: true },
847 { name: "BASE_URL", value: "https://example.test", sensitive: false },
@@ -855,7 +859,7 @@ describe("ProviderInstanceRegistry secret environment", () => {
859 yield* PubSub.take(changes);
860 return built;
861 });
858 - return { vault, reads, invalidated, created, make, makeGated, gate };
862 + return { vault, reads, invalidated, created, configs, make, makeGated, gate };
863 }
864
865 it.effect("starts an instance with the secret its environment points at", () => {
@@ -921,6 +925,26 @@ describe("ProviderInstanceRegistry secret environment", () => {
925 }).pipe(Effect.scoped);
926 });
927
928 + it.effect("reads a config field typed SettingsSecretValue and rebuilds when it rotates", () => {
929 + const apiKey: SecretReference = { ...secret, reference: "op://Private/Gateway/key" };
930 + const fixture = setup(
931 + { [secret.reference]: "sk-live", [apiKey.reference]: "gw-live" },
932 + Schema.Struct({ apiKey: SettingsSecretValue, model: Schema.String }),
933 + { apiKey, model: "m" },
934 + );
935 + return Effect.gen(function* () {
936 + const { mutator } = yield* fixture.make;
937 + expect(fixture.reads.at(-1)).toEqual([secret.reference, apiKey.reference]);
938 +
939 + fixture.vault.set(apiKey.reference, "gw-rotated");
940 + yield* mutator.reloadSecrets();
941 + expect(fixture.configs).toEqual([
942 + { apiKey: "gw-live", model: "m" },
943 + { apiKey: "gw-rotated", model: "m" },
944 + ]);
945 + }).pipe(Effect.scoped);
946 + });
947 +
948 it.effect("keeps a working instance live when a reload cannot read its secret", () => {
949 const fixture = setup({ [secret.reference]: "sk-live" });
950 return Effect.gen(function* () {
apps/server/src/provider/ProviderInstanceRegistry.ts
+76 -36
@@ -7,6 +7,7 @@ import {
7 type ProviderDriverKind,
8 type ResolvedProviderInstanceEnvironment,
9 type SecretReference,
10 + secretReferencesInSettings,
11 type ServerProvider,
12 } from "@t3tools/contracts";
13 import * as Context from "effect/Context";
@@ -42,11 +43,16 @@ export class ProviderInstanceRegistry extends Context.Service<
43 }
44 >()("t3/provider/ProviderInstanceRegistry") {}
45
46 +interface InstanceSecrets {
47 + readonly environment: ResolvedProviderInstanceEnvironment;
48 + readonly config: Readonly<Record<string, string>>;
49 +}
50 +
51 interface LiveEntry {
52 readonly instance: ProviderInstance;
53 readonly scope: Scope.Closeable;
54 readonly entry: ProviderInstanceConfig;
49 - readonly environment: ResolvedProviderInstanceEnvironment;
55 + readonly secrets: InstanceSecrets;
56 }
57
58 interface RegistryState {
@@ -61,8 +67,18 @@ const entryEqual = (a: ProviderInstanceConfig, b: ProviderInstanceConfig): boole
67 const secretReferencesIn = (environment: ProviderInstanceEnvironment): Array<SecretReference> =>
68 environment.flatMap((variable) => (typeof variable.value === "string" ? [] : [variable.value]));
69
64 -const secretReferencesOf = (entry: ProviderInstanceConfig): ReadonlyArray<SecretReference> =>
65 - secretReferencesIn(entry.environment ?? []);
70 +const configSecretReferences = <R>(
71 + driver: AnyProviderDriver<R> | undefined,
72 + entry: ProviderInstanceConfig,
73 +) => (driver === undefined ? [] : secretReferencesInSettings(driver.configSchema, entry.config));
74 +
75 +const secretReferencesOf = <R>(
76 + driversById: ReadonlyMap<ProviderDriverKind, AnyProviderDriver<R>>,
77 + entry: ProviderInstanceConfig,
78 +): ReadonlyArray<SecretReference> => [
79 + ...secretReferencesIn(entry.environment ?? []),
80 + ...configSecretReferences(driversById.get(entry.driver), entry).map(({ reference }) => reference),
81 +];
82
83 const withoutSecretReferences = (
84 environment: ProviderInstanceEnvironment,
@@ -71,25 +87,38 @@ const withoutSecretReferences = (
87 typeof variable.value === "string" ? [{ ...variable, value: variable.value }] : [],
88 );
89
74 -const readSecretEnvironment = Effect.fn("ProviderInstanceRegistry.readSecretEnvironment")(
75 - function* (environment: ProviderInstanceEnvironment) {
76 - const references = secretReferencesIn(environment);
77 - const values =
78 - references.length === 0 ? [] : yield* (yield* SecretResolver.SecretResolver).read(references);
79 - const unreadable: Array<string> = [];
80 - let index = 0;
81 - const resolved: ResolvedProviderInstanceEnvironment = environment.flatMap((variable) => {
82 - if (typeof variable.value === "string") return [{ ...variable, value: variable.value }];
83 - const secret = values[index++];
84 - if (secret === undefined) {
85 - unreadable.push(variable.name);
86 - return [];
87 - }
88 - return [{ ...variable, value: secret, sensitive: true }];
89 - });
90 - return { environment: resolved, unreadable };
91 - },
92 -);
90 +const readInstanceSecrets = Effect.fn("ProviderInstanceRegistry.readInstanceSecrets")(function* <R>(
91 + driver: AnyProviderDriver<R> | undefined,
92 + entry: ProviderInstanceConfig,
93 +) {
94 + const variables = entry.environment ?? [];
95 + const configFields = configSecretReferences(driver, entry);
96 + const references = [
97 + ...secretReferencesIn(variables),
98 + ...configFields.map(({ reference }) => reference),
99 + ];
100 + const values =
101 + references.length === 0 ? [] : yield* (yield* SecretResolver.SecretResolver).read(references);
102 + const unreadable: Array<string> = [];
103 + let index = 0;
104 + const environment: ResolvedProviderInstanceEnvironment = variables.flatMap((variable) => {
105 + if (typeof variable.value === "string") return [{ ...variable, value: variable.value }];
106 + const secret = values[index++];
107 + if (secret === undefined) {
108 + unreadable.push(variable.name);
109 + return [];
110 + }
111 + return [{ ...variable, value: secret, sensitive: true }];
112 + });
113 + const config: Record<string, string> = {};
114 + for (const { field } of configFields) {
115 + const secret = values[index++];
116 + if (secret === undefined) unreadable.push(field);
117 + else config[field] = secret;
118 + }
119 + const secrets: InstanceSecrets = { environment, config };
120 + return { secrets, unreadable };
121 +});
122
123 /** Conflicting saved flags must preserve any explicit disable. */
124 const resolveEntryEnabled = (entry: ProviderInstanceConfig, typedConfig: unknown): boolean => {
@@ -164,7 +193,7 @@ const buildEntry = Effect.fn("ProviderInstanceRegistry.buildEntry")(function* <R
193
194 const typedConfig = decodeResult.success;
195 const enabled = resolveEntryEnabled(entry, typedConfig);
167 - if (deferSecrets && enabled && secretReferencesOf(entry).length > 0) {
196 + if (deferSecrets && enabled && secretReferencesOf(driversById, entry).length > 0) {
197 return {
198 kind: "unavailable" as const,
199 snapshot: yield* buildUnavailableProviderSnapshot({
@@ -176,9 +205,12 @@ const buildEntry = Effect.fn("ProviderInstanceRegistry.buildEntry")(function* <R
205 }),
206 };
207 }
179 - const { environment, unreadable } = enabled
180 - ? yield* readSecretEnvironment(entry.environment ?? [])
181 - : { environment: withoutSecretReferences(entry.environment ?? []), unreadable: [] };
208 + const { secrets, unreadable } = enabled
209 + ? yield* readInstanceSecrets(driver, entry)
210 + : {
211 + secrets: { environment: withoutSecretReferences(entry.environment ?? []), config: {} },
212 + unreadable: [],
213 + };
214 // Starting with a blank credential would fail later with a less useful error, or fall back to
215 // whatever the server inherited.
216 if (unreadable.length > 0) {
@@ -201,9 +233,12 @@ const buildEntry = Effect.fn("ProviderInstanceRegistry.buildEntry")(function* <R
233 instanceId,
234 displayName: entry.displayName,
235 accentColor: entry.accentColor,
204 - environment,
236 + environment: secrets.environment,
237 enabled,
206 - config: typedConfig,
238 + config:
239 + Object.keys(secrets.config).length === 0
240 + ? typedConfig
241 + : { ...typedConfig, ...secrets.config },
242 })
243 .pipe(Effect.provideService(Scope.Scope, childScope), Effect.result);
244 if (createResult._tag === "Failure") {
@@ -231,7 +266,7 @@ const buildEntry = Effect.fn("ProviderInstanceRegistry.buildEntry")(function* <R
266 instance: createResult.success,
267 scope: childScope,
268 entry,
234 - environment,
269 + secrets,
270 },
271 };
272 });
@@ -291,7 +326,7 @@ const makeReconcile = <R>(input: {
326 const kept = previousEntries.has(instanceId) && !replacedIds.has(instanceId);
327 return kept || !(yield* isEntryEnabled(driversById, entry))
328 ? []
294 - : secretReferencesOf(entry);
329 + : secretReferencesOf(driversById, entry);
330 }),
331 ).pipe(Effect.map((perEntry) => perEntry.flat()));
332 if (references.length > 0 && !deferSecrets) {
@@ -413,13 +448,13 @@ export const makeProviderInstanceRegistry = Effect.fn(
448 const configMap = yield* Ref.get(configMapRef);
449 const targets = yield* Effect.filter(Object.entries(configMap), ([rawInstanceId, entry]) =>
450 (instanceId === undefined || rawInstanceId === instanceId) &&
416 - secretReferencesOf(entry).length > 0
451 + secretReferencesOf(driversById, entry).length > 0
452 ? isEntryEnabled(driversById, entry)
453 : Effect.succeed(false),
454 );
455 if (targets.length === 0) return;
456 const resolver = yield* SecretResolver.SecretResolver;
422 - const references = targets.flatMap(([, entry]) => secretReferencesOf(entry));
457 + const references = targets.flatMap(([, entry]) => secretReferencesOf(driversById, entry));
458 yield* resolver.invalidate(references);
459 yield* resolver.read(references);
460 const live = yield* Ref.get(entries);
@@ -427,9 +462,12 @@ export const makeProviderInstanceRegistry = Effect.fn(
462 for (const [rawInstanceId, entry] of targets) {
463 const current = live.get(ProviderInstanceId.make(rawInstanceId));
464 if (current === undefined) continue;
430 - const { environment, unreadable } = yield* readSecretEnvironment(entry.environment ?? []);
465 + const { secrets, unreadable } = yield* readInstanceSecrets(
466 + driversById.get(entry.driver),
467 + entry,
468 + );
469 // A failed re-read keeps the working instance and the value it already holds.
432 - if (unreadable.length === 0 && !Equal.equals(environment, current.environment)) {
470 + if (unreadable.length === 0 && !Equal.equals(secrets, current.secrets)) {
471 rebuild.add(current.instance.instanceId);
472 }
473 }
@@ -447,10 +485,12 @@ export const makeProviderInstanceRegistry = Effect.fn(
485 ),
486 );
487 const startupReferences = yield* Effect.filter(Object.entries(input.configMap), ([, entry]) =>
450 - secretReferencesOf(entry).length > 0
488 + secretReferencesOf(driversById, entry).length > 0
489 ? isEntryEnabled(driversById, entry)
490 : Effect.succeed(false),
453 - ).pipe(Effect.map((targets) => targets.flatMap(([, entry]) => secretReferencesOf(entry))));
491 + ).pipe(
492 + Effect.map((targets) => targets.flatMap(([, entry]) => secretReferencesOf(driversById, entry))),
493 + );
494 if (startupReferences.length > 0) {
495 // The read waits outside the lock so other mutations are not held for a vault prompt; a
496 // configuration saved meanwhile has already reconciled itself.
apps/server/src/secrets/settingsSecretValue.ts new
+20
@@ -0,0 +1,20 @@
1 +import { secretReferencesInSettings } from "@t3tools/contracts";
2 +import type * as SecretResolver from "@t3tools/secret-provider-core/server/SecretResolver";
3 +import * as Effect from "effect/Effect";
4 +import type * as Schema from "effect/Schema";
5 +
6 +/**
7 + * Replaces each reference in the fields `schema` declares as `SettingsSecretValue` with the secret
8 + * it names, read in one batch. An unreadable secret comes back as `""`, so it behaves as unset.
9 + */
10 +export const resolveSettingsSecrets = Effect.fn("SettingsSecrets.resolve")(function* <
11 + Settings extends Readonly<Record<string, unknown>>,
12 +>(resolver: SecretResolver.SecretResolver["Service"], schema: Schema.Top, settings: Settings) {
13 + const pending = secretReferencesInSettings(schema, settings);
14 + if (pending.length === 0) return settings;
15 + const values = yield* resolver.read(pending.map(({ reference }) => reference));
16 + const resolved = Object.fromEntries(
17 + pending.map(({ field }, index) => [field, values[index] ?? ""] as const),
18 + );
19 + return { ...settings, ...resolved };
20 +});
apps/server/src/server.ts
+2
@@ -64,6 +64,7 @@ import * as SourceControlBuiltInDrivers from "./sourceControl/builtInDrivers.ts"
64 import * as SourceControlSignIn from "./sourceControl/SourceControlSignIn.ts";
65 import { BUILT_IN_SOURCE_CONTROL_DRIVER_LIST } from "./sourceControl/sourceControlDefinitions.ts";
66 import * as TextGeneration from "./textGeneration/TextGeneration.ts";
67 +import * as SecretResolver from "./secrets/SecretResolver.ts";
68 import * as ProviderInstanceRegistryHydration from "./provider/ProviderInstanceRegistryHydration.ts";
69 import * as ProjectSettingsOverrideSweep from "./provider/ProjectSettingsOverrideSweep.ts";
70 import * as TerminalManager from "./terminal/Manager.ts";
@@ -628,6 +629,7 @@ const layerRuntimeCoreDependenciesBase = Layer.mergeAll(
629 Layer.provideMerge(layerOrchestrationApplication),
630 Layer.provideMerge(RuntimeLayer.layerEventInfrastructure),
631 Layer.provideMerge(Layer.merge(ProjectStore.layer, ThreadSearch.layer)),
632 + Layer.provideMerge(SecretResolver.layer),
633 Layer.provideMerge(layerServerSettings),
634 Layer.provideMerge(layerSourceControlProviderRegistry),
635 Layer.provideMerge(layerGit),
apps/server/src/serverSettings.test.ts
+19
@@ -1533,6 +1533,25 @@ it.layer(NodeServices.layer)("server settings", (it) => {
1533 assert.isTrue(Option.isNone(yield* stored("bitbucket", "accessToken", null)));
1534 assert.isTrue(Option.isNone(yield* stored("github", "tokens", "github.com")));
1535 assert.isTrue(Option.isSome(yield* stored("github", "tokens", "ghe.acme.test")));
1536 +
1537 + const reference = {
1538 + provider: SecretProviderId.make("personal"),
1539 + reference: "op://Private/Bitbucket/token",
1540 + };
1541 + yield* serverSettings.updateSettings({
1542 + sourceControlHosts: { bitbucket: { accessToken: "bb-access" } },
1543 + });
1544 + assert.isTrue(Option.isSome(yield* stored("bitbucket", "accessToken", null)));
1545 + const referenced = yield* serverSettings.updateSettings({
1546 + sourceControlHosts: { bitbucket: { accessToken: reference } },
1547 + });
1548 + assert.deepEqual(referenced.sourceControlHosts.bitbucket?.accessToken, reference);
1549 + assert.isTrue(Option.isNone(yield* stored("bitbucket", "accessToken", null)));
1550 + assert.deepEqual(
1551 + ServerSettingsModule.redactServerSettingsForClient(referenced).sourceControlHosts
1552 + .bitbucket?.accessToken,
1553 + reference,
1554 + );
1555 }).pipe(Effect.provide(layerServerSettingsWithSecrets())),
1556 );
1557
apps/server/src/settingsSecrets.ts
+2 -1
@@ -6,6 +6,7 @@ import {
6 type ServerSettings,
7 SimlockDeviceHostConfig,
8 UsageLimitSourceConfig,
9 + isSecretReference,
10 secretSettingsFields,
11 } from "@t3tools/contracts";
12 import { acpRegistryClient } from "@t3tools/provider-acp-registry/client";
@@ -60,7 +61,7 @@ export function mapSettingsSecrets(
61 ) => {
62 const next = { ...fields };
63 for (const field of secretFields) {
63 - if (!(field in next)) continue;
64 + if (!(field in next) || isSecretReference(next[field])) continue;
65 next[field] = writeSecretFieldValues(
66 next[field],
67 readSecretFieldValues(next[field]).map(([serverHost, value]) => {
apps/server/src/sourceControl/ServerSourceControlHost.ts
+21 -2
@@ -1,11 +1,14 @@
1 +import * as SecretResolver from "@t3tools/secret-provider-core/server/SecretResolver";
2 import * as SourceControlHost from "@t3tools/source-control-core/server/SourceControlHost";
3 import * as Effect from "effect/Effect";
4 import * as Layer from "effect/Layer";
5
6 +import * as SecretResolverLayer from "../secrets/SecretResolver.ts";
7 import * as ServerSettings from "../serverSettings.ts";
8 import * as GitVcsDriver from "../vcs/GitVcsDriver.ts";
9 import * as VcsDriverRegistry from "../vcs/VcsDriverRegistry.ts";
10 import * as VcsProcess from "../vcs/VcsProcess.ts";
11 +import { resolveSourceControlHostSecrets } from "./sourceControlHostSecrets.ts";
12
13 export const layer = Layer.effect(
14 SourceControlHost.SourceControlHost,
@@ -14,8 +17,24 @@ export const layer = Layer.effect(
17 const process = yield* VcsProcess.VcsProcess;
18 const git = yield* GitVcsDriver.GitVcsDriver;
19 const vcsRegistry = yield* VcsDriverRegistry.VcsDriverRegistry;
20 + const secrets = yield* SecretResolver.SecretResolver;
21 return SourceControlHost.SourceControlHost.of({
18 - settings: { get: serverSettings.getSettings, update: serverSettings.updateSettings },
22 + settings: {
23 + get: serverSettings.getSettings,
24 + getWithSecrets: (kind) =>
25 + serverSettings.getSettings.pipe(
26 + Effect.flatMap((settings) =>
27 + resolveSourceControlHostSecrets(secrets, settings.sourceControlHosts, kind).pipe(
28 + Effect.map((sourceControlHosts) =>
29 + sourceControlHosts === settings.sourceControlHosts
30 + ? settings
31 + : { ...settings, sourceControlHosts },
32 + ),
33 + ),
34 + ),
35 + ),
36 + update: serverSettings.updateSettings,
37 + },
38 process: { run: process.run },
39 git: {
40 execute: git.execute,
@@ -35,4 +54,4 @@ export const layer = Layer.effect(
54 },
55 });
56 }),
38 -);
57 +).pipe(Layer.provide(SecretResolverLayer.layer));
apps/server/src/sourceControl/sourceControlHostSecrets.test.ts new
+124
@@ -0,0 +1,124 @@
1 +import { assert, it } from "@effect/vitest";
2 +import { SecretProviderId } from "@t3tools/contracts";
3 +import * as SecretResolver from "@t3tools/secret-provider-core/server/SecretResolver";
4 +import * as Effect from "effect/Effect";
5 +
6 +import {
7 + collectSourceControlHostSecretReferences,
8 + invalidateSettingsSecrets,
9 + resolveSourceControlHostSecrets,
10 +} from "./sourceControlHostSecrets.ts";
11 +
12 +const source = (reference: string) => ({
13 + provider: SecretProviderId.make("homelab"),
14 + reference,
15 +});
16 +
17 +const secretsByReference = new Map([["bitbucket#token", "bb_from_provider"]]);
18 +
19 +const hosts = {
20 + bitbucket: { email: "me@example.test", accessToken: source("bitbucket#token") },
21 + gitcafe: { token: source("missing#token") },
22 + github: { tokens: { "github.com": "ghp_literal" } },
23 +};
24 +
25 +function countingResolver() {
26 + const reads: Array<string> = [];
27 + const resolver = SecretResolver.SecretResolver.of({
28 + read: (references) =>
29 + Effect.sync(() =>
30 + references.map((reference) => {
31 + reads.push(reference.reference);
32 + return secretsByReference.get(reference.reference);
33 + }),
34 + ),
35 + invalidate: () => Effect.void,
36 + });
37 + return { reads, resolver };
38 +}
39 +
40 +it.effect(
41 + "replaces only the requested kind's credential references with the secrets they name",
42 + () =>
43 + Effect.gen(function* () {
44 + const { reads, resolver } = countingResolver();
45 + const resolved = yield* resolveSourceControlHostSecrets(resolver, hosts, "bitbucket");
46 + assert.deepEqual(resolved, {
47 + ...hosts,
48 + bitbucket: { email: "me@example.test", accessToken: "bb_from_provider" },
49 + });
50 + assert.deepEqual(reads, ["bitbucket#token"]);
51 + }),
52 +);
53 +
54 +it.effect("treats a reference the provider cannot read as an unset credential", () =>
55 + Effect.gen(function* () {
56 + const { reads, resolver } = countingResolver();
57 + const resolved = yield* resolveSourceControlHostSecrets(resolver, hosts, "gitcafe");
58 + assert.deepEqual(resolved.gitcafe, { token: "" });
59 + assert.deepEqual(reads, ["missing#token"]);
60 + }),
61 +);
62 +
63 +it.effect("leaves the resolver unused for a kind that holds no reference", () =>
64 + Effect.gen(function* () {
65 + const { reads, resolver } = countingResolver();
66 + const resolved = yield* resolveSourceControlHostSecrets(resolver, hosts, "github");
67 + assert.strictEqual(resolved, hosts);
68 + assert.deepEqual(reads, []);
69 + }),
70 +);
71 +
72 +it("collects the references held in credential fields and skips literal values", () => {
73 + assert.deepEqual(collectSourceControlHostSecretReferences(hosts), [
74 + source("missing#token"),
75 + source("bitbucket#token"),
76 + ]);
77 + assert.deepEqual(
78 + collectSourceControlHostSecretReferences({
79 + bitbucket: { accessToken: "literal" },
80 + github: { tokens: { "github.com": "ghp_literal" } },
81 + }),
82 + [],
83 + );
84 +});
85 +
86 +it.effect("reads a collected reference again once it is invalidated", () =>
87 + Effect.gen(function* () {
88 + let current = "stale";
89 + const cache = new Map<string, string>();
90 + const resolver = SecretResolver.SecretResolver.of({
91 + read: (references) =>
92 + Effect.sync(() =>
93 + references.map((reference) => {
94 + const hit = cache.get(reference.reference);
95 + if (hit !== undefined) return hit;
96 + cache.set(reference.reference, current);
97 + return current;
98 + }),
99 + ),
100 + invalidate: (references) =>
101 + Effect.sync(() => {
102 + if (references === undefined) cache.clear();
103 + else for (const reference of references) cache.delete(reference.reference);
104 + }),
105 + });
106 + const read = () => resolveSourceControlHostSecrets(resolver, hosts, "bitbucket");
107 + assert.deepEqual((yield* read()).bitbucket, {
108 + email: "me@example.test",
109 + accessToken: "stale",
110 + });
111 + current = "rotated";
112 + yield* invalidateSettingsSecrets(resolver, Effect.succeed({ sourceControlHosts: hosts }));
113 + assert.deepEqual((yield* read()).bitbucket, {
114 + email: "me@example.test",
115 + accessToken: "rotated",
116 + });
117 + current = "rotated again";
118 + yield* invalidateSettingsSecrets(resolver, Effect.fail("settings unreadable"));
119 + assert.deepEqual((yield* read()).bitbucket, {
120 + email: "me@example.test",
121 + accessToken: "rotated again",
122 + });
123 + }),
124 +);
apps/server/src/sourceControl/sourceControlHostSecrets.ts
+57 -1
@@ -1,4 +1,14 @@
1 -import { secretSettingsFields } from "@t3tools/contracts";
1 +import {
2 + isSecretReference,
3 + secretReferencesInSettings,
4 + secretSettingsFields,
5 + type SecretReference,
6 + type ServerSettings,
7 +} from "@t3tools/contracts";
8 +import type * as SecretResolver from "@t3tools/secret-provider-core/server/SecretResolver";
9 +import * as Effect from "effect/Effect";
10 +
11 +import { resolveSettingsSecrets } from "../secrets/settingsSecretValue.ts";
12
13 import { sourceControlDefinitions } from "./sourceControlDefinitions.ts";
14
@@ -30,6 +40,7 @@ export function readSecretFieldValues(
40 value: unknown,
41 ): ReadonlyArray<readonly [serverHost: string | null, value: string]> {
42 if (typeof value === "string") return [[null, value]];
43 + if (isSecretReference(value)) return [];
44 if (value === null || typeof value !== "object" || Array.isArray(value)) return [];
45 return Object.entries(value).flatMap(([serverHost, entry]) =>
46 typeof entry === "string" ? [[serverHost.trim().toLowerCase(), entry] as const] : [],
@@ -41,5 +52,50 @@ export function writeSecretFieldValues(
52 values: ReadonlyArray<readonly [serverHost: string | null, value: string]>,
53 ): unknown {
54 if (typeof original === "string") return values[0]?.[1] ?? "";
55 + if (isSecretReference(original)) return original;
56 return Object.fromEntries(values.map(([serverHost, value]) => [serverHost ?? "", value]));
57 }
58 +
59 +type SourceControlHostsSettings = Readonly<Record<string, Readonly<Record<string, unknown>>>>;
60 +
61 +const hostSettingsSchemas = new Map(
62 + sourceControlDefinitions.definitions.flatMap((definition) =>
63 + definition.settings ? [[definition.kind as string, definition.settings] as const] : [],
64 + ),
65 +);
66 +
67 +/** Every secret provider reference held in any host kind's credential fields. */
68 +export function collectSourceControlHostSecretReferences(
69 + hosts: SourceControlHostsSettings,
70 +): ReadonlyArray<SecretReference> {
71 + return [...hostSettingsSchemas].flatMap(([kind, schema]) =>
72 + secretReferencesInSettings(schema, hosts[kind]).map(({ reference }) => reference),
73 + );
74 +}
75 +
76 +/** Replaces each secret provider reference in one host kind's credential fields with the secret it names. */
77 +export const resolveSourceControlHostSecrets = Effect.fn("SourceControlHost.resolveSecrets")(
78 + function* (
79 + resolver: SecretResolver.SecretResolver["Service"],
80 + hosts: SourceControlHostsSettings,
81 + kind: string,
82 + ) {
83 + const schema = hostSettingsSchemas.get(kind);
84 + const fields = hosts[kind];
85 + if (schema === undefined || fields === undefined) return hosts;
86 + const resolved = yield* resolveSettingsSecrets(resolver, schema, fields);
87 + return resolved === fields ? hosts : { ...hosts, [kind]: resolved };
88 + },
89 +);
90 +
91 +/** Settings that cannot be read clear every cached secret, so a refresh never keeps a stale one. */
92 +export const invalidateSettingsSecrets = Effect.fn("SettingsSecrets.invalidate")(function* <E>(
93 + resolver: SecretResolver.SecretResolver["Service"],
94 + settings: Effect.Effect<Pick<ServerSettings, "sourceControlHosts">, E>,
95 +) {
96 + const references = yield* settings.pipe(
97 + Effect.map((current) => collectSourceControlHostSecretReferences(current.sourceControlHosts)),
98 + Effect.orElseSucceed(() => undefined),
99 + );
100 + yield* resolver.invalidate(references);
101 +});
apps/server/src/ws.test.ts
+2
@@ -1,3 +1,4 @@
1 +import * as SecretResolver from "@t3tools/secret-provider-core/server/SecretResolver";
2 import * as NodeServices from "@effect/platform-node/NodeServices";
3 import { assert, it } from "@effect/vitest";
4 import {
@@ -528,6 +529,7 @@ const layerUnusedConfigRpcServices = Layer.mergeAll(
529 Layer.mock(ReviewService.ReviewService)({}),
530 Layer.mock(ScheduledTasks.ScheduledTaskService)({}),
531 Layer.mock(SecretRequests.SecretRequests)({}),
532 + Layer.mock(SecretResolver.SecretResolver)({}),
533 Layer.mock(GuestShareService.GuestShareService)({}),
534 Layer.mock(ServerLifecycleEvents.ServerLifecycleEvents)({}),
535 Layer.mock(ServerRuntimeStartup.ServerRuntimeStartup)({}),
apps/server/src/ws.ts
+6
@@ -180,7 +180,9 @@ import { makeProviderInstallation } from "./provider/providerInstallation.ts";
180 import * as ServerSelfUpdate from "./cloud/selfUpdate.ts";
181 import * as ServerLifecycleEvents from "./serverLifecycleEvents.ts";
182 import * as ServerRuntimeStartup from "./serverRuntimeStartup.ts";
183 +import * as SecretResolver from "@t3tools/secret-provider-core/server/SecretResolver";
184 import * as ServerSettings from "./serverSettings.ts";
185 +import { invalidateSettingsSecrets } from "./sourceControl/sourceControlHostSecrets.ts";
186 import * as DatabaseStorage from "./persistence/DatabaseStorage.ts";
187 import * as StorageCleanup from "./storageCleanup.ts";
188 import * as TerminalManager from "./terminal/Manager.ts";
@@ -1336,6 +1338,7 @@ export const layerWsRpc = (
1338 const storageCleanup = yield* StorageCleanup.StorageCleanup;
1339 const databaseStorage = yield* DatabaseStorage.DatabaseStorage;
1340 const serverSettings = yield* ServerSettings.ServerSettingsService;
1341 + const secretResolver = yield* SecretResolver.SecretResolver;
1342 const peerLinks = yield* PeerLinks.PeerLinks;
1343 const peerLinkRequests = yield* PeerLinkRequests.PeerLinkRequests;
1344 const startup = yield* ServerRuntimeStartup.ServerRuntimeStartup;
@@ -2307,6 +2310,9 @@ export const layerWsRpc = (
2310 if (input.instanceId === undefined) {
2311 yield* usageLimitSources.refresh;
2312 }
2313 + if (input.reloadSecrets === true && input.instanceId === undefined) {
2314 + yield* invalidateSettingsSecrets(secretResolver, serverSettings.getSettings);
2315 + }
2316 let providers = yield* input.cwd !== undefined && input.instanceId !== undefined
2317 ? providerRegistry.refreshWorkspaceSnapshot({
2318 instanceId: input.instanceId,
apps/web/src/components/files/AttachmentFilePreview.browser.test.tsx
+5 -5
@@ -1930,13 +1930,13 @@ it("reloads a workspace Word file after a preview remount", async () => {
1930
1931 it("clears an Office metadata error when the same URL becomes previewable", async () => {
1932 const src = "data:application/octet-stream,invalid-office-file";
1933 - let resolveResponse!: (response: Response) => void;
1934 - const response = new Promise<Response>((resolve) => {
1935 - resolveResponse = resolve;
1933 + let resolveBody!: (body: string) => void;
1934 + const body = new Promise<string>((resolve) => {
1935 + resolveBody = resolve;
1936 });
1937 using _fetch = stubGlobal(
1938 "fetch",
1939 - vi.fn(() => response),
1939 + vi.fn(() => body.then((text) => new Response(text))),
1940 );
1941 await using screen = await render(
1942 <OfficeFilePreview src={src} name="report.docx" kind="docx" sizeBytes={51 * 1024 * 1024} />,
@@ -1949,7 +1949,7 @@ it("clears an Office metadata error when the same URL becomes previewable", asyn
1949 expect(screen.container.querySelector('[aria-label="Loading file"]')).not.toBeNull(),
1950 );
1951 expect(screen.container.textContent).not.toContain("under 50 MB");
1952 - resolveResponse(new Response("invalid-office-file"));
1952 + resolveBody("invalid-office-file");
1953 await vi.waitFor(() => expect(screen.container.textContent).toContain("not a readable ZIP"), {
1954 timeout: 10_000,
1955 });
apps/web/src/components/settings/AddProviderInstanceDialog.tsx
+2
@@ -533,6 +533,7 @@ export function AddProviderInstanceDialog({
533 idPrefix="add-provider-acpRegistry-manual"
534 variant="settings"
535 onChange={setConfigDraft}
536 + environmentId={environmentId}
537 />
538 {isLocalAcp ? (
539 <ProviderEnvironmentSection
@@ -683,6 +684,7 @@ export function AddProviderInstanceDialog({
684 idPrefix={`add-provider-${driver}`}
685 variant="settings"
686 onChange={setConfigDraft}
687 + environmentId={environmentId}
688 />
689 </SettingsGroup>
690 ) : !isAcpRegistry && wizardStep === 2 ? (
apps/web/src/components/settings/ProviderInstanceCard.tsx
+2 -1
@@ -487,7 +487,7 @@ export function ProviderEnvironmentSection(props: {
487 <div className="flex min-w-0 flex-col gap-1.5 rounded-lg border p-2">
488 <div className="flex min-w-0 items-center gap-1.5">
489 {nameInput}
490 - {source === null ? null : <div className="w-48 shrink-0">{source}</div>}
490 + {source}
491 {removeButton}
492 </div>
493 <div className="flex min-w-0 items-start gap-1.5">
@@ -1196,6 +1196,7 @@ export function ProviderInstanceCard({
1196 idPrefix={`provider-instance-${instanceId}`}
1197 variant="settings"
1198 onChange={updateConfig}
1199 + environmentId={environmentId}
1200 />
1201 ) : (
1202 <SettingsRow
apps/web/src/components/settings/ProviderSettingsForm.test.ts
+15 -4
@@ -1,5 +1,10 @@
1 import { describe, expect, it } from "vite-plus/test";
2 -import { makeProviderSettingsSchema, ProviderDriverKind, TrimmedString } from "@t3tools/contracts";
2 +import {
3 + makeProviderSettingsSchema,
4 + ProviderDriverKind,
5 + SettingsSecretValue,
6 + TrimmedString,
7 +} from "@t3tools/contracts";
8 import * as Schema from "effect/Schema";
9
10 import { providerClients } from "./providerDriverMeta";
@@ -11,15 +16,21 @@ import {
16 } from "./ProviderSettingsForm";
17
18 describe("ProviderSettingsForm helpers", () => {
14 - it("keeps every masked field as a stored secret", () => {
19 + it("keeps every masked field as a stored secret and offers a reference only where typed so", () => {
20 const settingsSchema = makeProviderSettingsSchema({
21 token: TrimmedString.pipe(
22 Schema.annotateKey({ providerSettingsForm: { control: "password" } }),
23 ),
24 + apiKey: SettingsSecretValue,
25 });
26
21 - expect(deriveProviderSettingsFields({ settingsSchema })).toMatchObject([
22 - { key: "token", secret: true },
27 + expect(
28 + deriveProviderSettingsFields({ settingsSchema }).map(
29 + ({ key, secret, acceptsSecretReference }) => ({ key, secret, acceptsSecretReference }),
30 + ),
31 + ).toEqual([
32 + { key: "token", secret: true, acceptsSecretReference: undefined },
33 + { key: "apiKey", secret: true, acceptsSecretReference: true },
34 ]);
35 });
36
apps/web/src/components/settings/ProviderSettingsForm.tsx
+82 -1
@@ -2,11 +2,15 @@ import { useState, type ReactNode } from "react";
2 import * as Option from "effect/Option";
3 import * as Schema from "effect/Schema";
4 import {
5 + acceptsSecretReference,
6 + isSecretReference,
7 isSecretSetting,
8 + type EnvironmentId,
9 type ProviderSettingsFormAnnotation,
10 type ProviderSettingsFormControl,
11 type ProviderSettingsFormOption,
12 type ProviderSettingsFormSchemaAnnotation,
13 + type SecretReference,
14 } from "@t3tools/contracts";
15 import { PlusIcon, XIcon } from "lucide-react";
16
@@ -15,6 +19,7 @@ import { Button } from "../ui/button";
19 import { DraftInput } from "../ui/draft-input";
20 import { Input } from "../ui/input";
21 import { SecretInput } from "./SecretInput";
22 +import { SecretSourceInput, useSecretSources } from "./SecretSourceInput";
23 import { Select, SelectItem, SelectPopup, SelectTrigger, SelectValue } from "../ui/select";
24 import { Switch } from "../ui/switch";
25 import { Textarea } from "../ui/textarea";
@@ -34,6 +39,8 @@ export interface ProviderSettingsFieldModel {
39 readonly clearWhenEmpty: "omit" | "persist";
40 /** Kept in the server's secret store: a saved value arrives as `SECRET_REDACTED` and never shows. */
41 readonly secret?: boolean | undefined;
42 + /** Typed `SettingsSecretValue`: may name a secret provider reference instead of a value. */
43 + readonly acceptsSecretReference?: boolean | undefined;
44 readonly defaultBooleanValue?: boolean | undefined;
45
46 readonly options?: ReadonlyArray<ProviderSettingsFormOption> | undefined;
@@ -131,6 +138,7 @@ export function deriveProviderSettingsFields(
138 : {}),
139 clearWhenEmpty: formAnnotation.clearWhenEmpty ?? "omit",
140 ...(isSecretSetting(fieldSchema) ? { secret: true } : {}),
141 + ...(acceptsSecretReference(fieldSchema) ? { acceptsSecretReference: true } : {}),
142 ...(formAnnotation.control === "switch"
143 ? { defaultBooleanValue: readFieldBooleanDefault(fieldSchema) }
144 : {}),
@@ -281,11 +289,16 @@ function readProviderConfigBoolean(config: unknown, key: string, defaultValue =
289 export function nextProviderConfigWithFieldValue(
290 config: unknown,
291 field: ProviderSettingsFieldModel,
284 - value: string | boolean,
292 + value: string | boolean | SecretReference,
293 ): Record<string, unknown> | undefined {
294 const base: Record<string, unknown> =
295 config !== null && typeof config === "object" ? { ...(config as Record<string, unknown>) } : {};
296
297 + if (typeof value === "object") {
298 + base[field.key] = value;
299 + return base;
300 + }
301 +
302 if (typeof value === "boolean") {
303 const emptyBooleanValue = field.defaultBooleanValue ?? false;
304 if (field.clearWhenEmpty === "omit" && value === emptyBooleanValue) {
@@ -311,6 +324,61 @@ interface ProviderSettingsFormProps {
324 readonly idPrefix: string;
325 readonly variant: "card" | "dialog" | "settings";
326 readonly onChange: (nextConfig: Record<string, unknown> | undefined) => void;
327 + /** Where the secret providers offered for `SettingsSecretValue` fields are configured. */
328 + readonly environmentId?: EnvironmentId | undefined;
329 +}
330 +
331 +function SecretSettingsControl({
332 + field,
333 + value,
334 + inputId,
335 + descriptionId,
336 + environmentId,
337 + onChange,
338 +}: {
339 + readonly field: ProviderSettingsFieldModel;
340 + readonly value: unknown;
341 + readonly inputId: string;
342 + readonly descriptionId: string | undefined;
343 + readonly environmentId: EnvironmentId;
344 + readonly onChange: ProviderSettingsFormProps["onChange"];
345 +}) {
346 + const sources = useSecretSources(environmentId);
347 + const saved =
348 + value !== null && typeof value === "object"
349 + ? (value as Record<string, unknown>)[field.key]
350 + : undefined;
351 + const reference = isSecretReference(saved) ? saved : undefined;
352 + const configured = reference !== undefined || (typeof saved === "string" && saved.length > 0);
353 + return (
354 + <div className="flex w-full min-w-0 items-start gap-2 @min-[32rem]/settings-row:w-80">
355 + <SecretSourceInput
356 + id={inputId}
357 + aria-describedby={descriptionId}
358 + aria-label={field.label}
359 + size="sm"
360 + className="min-w-0 flex-1"
361 + value={reference ?? ""}
362 + configured={reference === undefined && configured}
363 + sources={sources}
364 + onCommit={(next) => onChange(nextProviderConfigWithFieldValue(value, field, next))}
365 + onSecretChange={(secret) =>
366 + onChange(nextProviderConfigWithFieldValue(value, field, secret ?? ""))
367 + }
368 + />
369 + {configured ? (
370 + <Button
371 + type="button"
372 + size="icon-sm"
373 + variant="ghost-destructive"
374 + onClick={() => onChange(nextProviderConfigWithFieldValue(value, field, ""))}
375 + aria-label={`Clear ${field.label}`}
376 + >
377 + <XIcon className="size-3.5" />
378 + </Button>
379 + ) : null}
380 + </div>
381 + );
382 }
383
384 function ProviderSettingsSelect({
@@ -370,6 +438,7 @@ interface ProviderSettingsFieldRowProps {
438 readonly idPrefix: string;
439 readonly variant: ProviderSettingsFormProps["variant"];
440 readonly onChange: ProviderSettingsFormProps["onChange"];
441 + readonly environmentId: EnvironmentId | undefined;
442 }
443
444 function ProviderSettingsFieldRow({
@@ -378,6 +447,7 @@ function ProviderSettingsFieldRow({
447 idPrefix,
448 variant,
449 onChange,
450 + environmentId,
451 }: ProviderSettingsFieldRowProps) {
452 const inputId = `${idPrefix}-${field.key}`;
453 const descriptionClassName =
@@ -424,6 +494,15 @@ function ProviderSettingsFieldRow({
494 placeholder={field.placeholder}
495 spellCheck={false}
496 />
497 + ) : field.acceptsSecretReference && environmentId !== undefined ? (
498 + <SecretSettingsControl
499 + field={field}
500 + value={value}
501 + inputId={inputId}
502 + descriptionId={descriptionId}
503 + environmentId={environmentId}
504 + onChange={onChange}
505 + />
506 ) : field.secret ? (
507 <div className="flex w-full min-w-0 items-center gap-2 @min-[32rem]/settings-row:w-56">
508 <SecretInput
@@ -581,6 +660,7 @@ export function ProviderSettingsForm({
660 idPrefix,
661 variant,
662 onChange,
663 + environmentId,
664 }: ProviderSettingsFormProps) {
665 const fields = deriveProviderSettingsFields(definition, value);
666 const isLocalAcp =
@@ -601,6 +681,7 @@ export function ProviderSettingsForm({
681 idPrefix={idPrefix}
682 variant={variant}
683 onChange={onChange}
684 + environmentId={environmentId}
685 />
686 ))}
687 {isLocalAcp ? <ProviderCommandArguments value={value} onChange={onChange} /> : null}
apps/web/src/components/settings/SecretSourceInput.tsx
+12 -7
@@ -44,6 +44,10 @@ export function useSecretSources(environmentId: EnvironmentId): ReadonlyArray<Se
44 .map(([id, config]) => ({ id, kind: config.kind, label: config.label }));
45 }
46
47 +function SourceIcon(props: { readonly icon: ComponentType<{ readonly className?: string }> }) {
48 + return <props.icon className="size-3.5 shrink-0" />;
49 +}
50 +
51 function SourceLabel(props: {
52 readonly icon: ComponentType<{ readonly className?: string }>;
53 readonly label: string;
@@ -105,13 +109,14 @@ export function SecretSourceInput({
109 setPendingProvider(next === secret?.provider ? null : next);
110 }}
111 >
108 - <SelectTrigger size="sm" className="w-full min-w-0" aria-label={`${label} source`}>
112 + <SelectTrigger
113 + size="sm"
114 + className="w-auto min-w-0 shrink-0"
115 + aria-label={`${label} source`}
116 + title={provider === null ? "Value" : providerLabel(provider)}
117 + >
118 <SelectValue>
110 - {provider === null ? (
111 - <SourceLabel icon={TypeIcon} label="Value" />
112 - ) : (
113 - <SourceLabel icon={providerIcon(provider)} label={providerLabel(provider)} />
114 - )}
119 + <SourceIcon icon={provider === null ? TypeIcon : providerIcon(provider)} />
120 </SelectValue>
121 </SelectTrigger>
122 <SelectPopup align="start" alignItemWithTrigger={false}>
@@ -178,7 +183,7 @@ export function SecretSourceInput({
183 if (source === null) return valueField;
184 return (
185 <div className="flex min-w-0 flex-1 items-start gap-1.5">
181 - <div className="w-28 shrink-0">{source}</div>
186 + {source}
187 {valueField}
188 </div>
189 );
apps/web/src/components/settings/SourceControlHostSettings.tsx
+3 -1
@@ -1,5 +1,6 @@
1 import type { EnvironmentId } from "@t3tools/contracts";
2 import type { SourceControlDefinition } from "@t3tools/client-runtime/source-control-clients";
3 +import * as Equal from "effect/Equal";
4 import { useState } from "react";
5
6 import { useEnvironmentSettings } from "../../hooks/useSettings";
@@ -48,10 +49,11 @@ export function SourceControlHostSettings({
49 value={saved ?? {}}
50 idPrefix={`source-control-${definition.kind}-${environmentId}`}
51 variant="settings"
52 + environmentId={environmentId}
53 onChange={(next) => {
54 const fields = next ?? {};
55 const changed = Object.fromEntries(
54 - Object.entries(fields).filter(([key, value]) => saved?.[key] !== value),
56 + Object.entries(fields).filter(([key, value]) => !Equal.equals(saved?.[key], value)),
57 );
58 const cleared = Object.keys(saved ?? {}).filter((key) => !(key in fields));
59 void save({ ...changed, ...Object.fromEntries(cleared.map((key) => [key, ""])) });
packages/contracts/src/index.ts
+1
@@ -68,4 +68,5 @@ export * from "./rpc.ts";
68 export * from "./worktreeSetup.ts";
69 export * from "./secretRequest.ts";
70 export * from "./secretReference.ts";
71 +export * from "./settingsSecretValue.ts";
72 export * from "./clientRpcPermissions.ts";
packages/contracts/src/settings.ts
+2
@@ -586,6 +586,8 @@ declare module "effect/Schema" {
586 interface Annotations {
587 /** Store this credential separately and expose only whether it is configured to clients. */
588 readonly settingsSecret?: boolean | undefined;
589 + /** Set by `SettingsSecretValue`: the credential may name a secret provider reference. */
590 + readonly settingsSecretReference?: boolean | undefined;
591 readonly providerSettingsForm?: ProviderSettingsFormAnnotation | undefined;
592 readonly providerSettingsFormSchema?: ProviderSettingsFormSchemaAnnotation | undefined;
593 }
packages/contracts/src/settingsSecretValue.ts new
+51
@@ -0,0 +1,51 @@
1 +import * as Schema from "effect/Schema";
2 +import * as SchemaAST from "effect/SchemaAST";
3 +
4 +import { TrimmedString } from "./baseSchemas.ts";
5 +import { SecretReference } from "./secretReference.ts";
6 +
7 +/**
8 + * A credential setting: the literal, which is kept in the secret store and redacted for
9 + * clients, or the secret reference to read it from, which is not itself a secret and is
10 + * stored and shown as written. Typing a settings field with it is the whole declaration:
11 + * forms offer a secret provider for it and the server reads the secret for its consumer.
12 + */
13 +export const SettingsSecretValue = Schema.Union([TrimmedString, SecretReference]).pipe(
14 + Schema.annotateKey({ settingsSecret: true, settingsSecretReference: true }),
15 +);
16 +export type SettingsSecretValue = typeof SettingsSecretValue.Type;
17 +
18 +export const isSecretReference = Schema.is(SecretReference);
19 +
20 +/** The literal a credential setting holds, or `""` when it names a secret instead. */
21 +export function settingsSecretLiteral(value: SettingsSecretValue | undefined): string {
22 + return typeof value === "string" ? value : "";
23 +}
24 +
25 +export function acceptsSecretReference(schema: Schema.Top): boolean {
26 + return Schema.resolveAnnotationsKey(schema)?.settingsSecretReference === true;
27 +}
28 +
29 +/** Fields of a settings struct typed `SettingsSecretValue`; any other schema has none. */
30 +function secretReferenceSettingsFields(schema: Schema.Top): ReadonlyArray<string> {
31 + if (!SchemaAST.isObjects(schema.ast)) return [];
32 + return schema.ast.propertySignatures.flatMap((property) =>
33 + property.type.context?.annotations?.settingsSecretReference === true &&
34 + typeof property.name === "string"
35 + ? [property.name]
36 + : [],
37 + );
38 +}
39 +
40 +/** Each declared reference field of `settings` that holds a reference, in field order. */
41 +export function secretReferencesInSettings(
42 + schema: Schema.Top,
43 + settings: unknown,
44 +): ReadonlyArray<{ readonly field: string; readonly reference: SecretReference }> {
45 + if (settings === null || typeof settings !== "object") return [];
46 + const values = settings as Readonly<Record<string, unknown>>;
47 + return secretReferenceSettingsFields(schema).flatMap((field) => {
48 + const value = values[field];
49 + return isSecretReference(value) ? [{ field, reference: value }] : [];
50 + });
51 +}
packages/secret-provider-core/src/server/SecretResolver.test.ts
+38 -5
@@ -6,7 +6,9 @@ import {
6 type SecretReference,
7 type ServerSettings,
8 } from "@t3tools/contracts";
9 +import * as Deferred from "effect/Deferred";
10 import * as Effect from "effect/Effect";
11 +import * as Fiber from "effect/Fiber";
12 import * as Layer from "effect/Layer";
13 import * as Schema from "effect/Schema";
14
@@ -26,7 +28,10 @@ const fake = (account: string) => ({
28 });
29 const ref = (reference: string, provider = personal): SecretReference => ({ provider, reference });
30
29 -function fakeDriver(answer: (account: string, reference: string) => string | undefined) {
31 +function fakeDriver(
32 + answer: (account: string, reference: string) => string | undefined,
33 + wait: (references: ReadonlyArray<string>) => Effect.Effect<void> = () => Effect.void,
34 +) {
35 const reads: Array<{ readonly account: string; readonly references: ReadonlyArray<string> }> = [];
36 const driver = defineSecretProviderDriver({
37 kind: FAKE_KIND,
@@ -39,10 +44,14 @@ function fakeDriver(answer: (account: string, reference: string) => string | und
44 invalidReferenceMessage: "Use fake://item.",
45 }),
46 read: ({ account }, references) =>
42 - Effect.sync(() => {
43 - reads.push({ account, references });
44 - return references.map((reference) => answer(account, reference));
45 - }),
47 + wait(references).pipe(
48 + Effect.andThen(
49 + Effect.sync(() => {
50 + reads.push({ account, references });
51 + return references.map((reference) => answer(account, reference));
52 + }),
53 + ),
54 + ),
55 });
56 return { driver, reads };
57 }
@@ -87,6 +96,30 @@ describe("SecretResolver", () => {
96 }).pipe(Effect.provide(resolverLayer(driver)));
97 });
98
99 + it.effect("answers a cached reference while another reference waits on its provider", () =>
100 + Effect.gen(function* () {
101 + const started = yield* Deferred.make<void>();
102 + const unlock = yield* Deferred.make<void>();
103 + const { driver } = fakeDriver(
104 + () => "sk-live",
105 + (references) =>
106 + references.includes("fake://slow")
107 + ? Deferred.succeed(started, undefined).pipe(Effect.andThen(Deferred.await(unlock)))
108 + : Effect.void,
109 + );
110 + yield* Effect.gen(function* () {
111 + const resolver = yield* SecretResolver.SecretResolver;
112 + yield* resolver.read([ref("fake://cached")]);
113 + const slow = yield* Effect.forkChild(resolver.read([ref("fake://slow")]));
114 + yield* Deferred.await(started);
115 +
116 + assert.deepStrictEqual(yield* resolver.read([ref("fake://cached")]), ["sk-live"]);
117 + yield* Deferred.succeed(unlock, undefined);
118 + assert.deepStrictEqual(yield* Fiber.join(slow), ["sk-live"]);
119 + }).pipe(Effect.provide(resolverLayer(driver)));
120 + }),
121 + );
122 +
123 it.effect("invalidates every reference when none are named", () => {
124 const { driver, reads } = fakeDriver(() => "sk-live");
125 return Effect.gen(function* () {
packages/secret-provider-core/src/server/SecretResolver.ts
+54 -35
@@ -71,44 +71,63 @@ export const make = Effect.fn("SecretResolver.make")(function* (options: {
71 : { driver, config: config.value, configKey: JSON.stringify(config.value) };
72 };
73
74 - const read: SecretResolver["Service"]["read"] = Effect.fn("SecretResolver.read")(
75 - function* (references) {
76 - const providers = yield* options.secretProviders;
77 - const plans = references.map((reference) => planFor(providers, reference));
74 + const isCached = (reference: SecretReference, plan: ReadablePlan) =>
75 + cache.get(cacheKey(reference))?.config === plan.configKey;
76
79 - const wanted = new Map<
80 - string,
81 - { readonly plan: ReadablePlan; readonly byReference: Map<string, Array<SecretReference>> }
82 - >();
83 - references.forEach((reference, index) => {
84 - const plan = plans[index];
85 - if (plan === undefined || cache.get(cacheKey(reference))?.config === plan.configKey) return;
86 - const group = wanted.get(reference.provider) ?? { plan, byReference: new Map() };
87 - group.byReference.set(reference.reference, [
88 - ...(group.byReference.get(reference.reference) ?? []),
89 - reference,
90 - ]);
91 - wanted.set(reference.provider, group);
92 - });
93 - for (const { plan, byReference } of wanted.values()) {
94 - const values = yield* plan.driver.read(plan.config, [...byReference.keys()]);
95 - [...byReference.values()].forEach((sameReference, index) => {
96 - for (const reference of sameReference) {
97 - cache.set(cacheKey(reference), { config: plan.configKey, value: values[index] });
77 + const answer = (
78 + references: ReadonlyArray<SecretReference>,
79 + plans: ReadonlyArray<ReadablePlan | undefined>,
80 + ) =>
81 + references.map((reference, index) => {
82 + const plan = plans[index];
83 + return plan !== undefined && isCached(reference, plan)
84 + ? cache.get(cacheKey(reference))?.value
85 + : undefined;
86 + });
87 +
88 + // Cache hits answer without the lock, so a read waiting on an unlock never stalls a cached one.
89 + const read: SecretResolver["Service"]["read"] = Effect.fn("SecretResolver.read")(function* (
90 + references,
91 + ) {
92 + const providers = yield* options.secretProviders;
93 + const plans = references.map((reference) => planFor(providers, reference));
94 + const isMissing = (reference: SecretReference, index: number) => {
95 + const plan = plans[index];
96 + return plan !== undefined && !isCached(reference, plan);
97 + };
98 + if (!references.some(isMissing)) return answer(references, plans);
99 +
100 + return yield* semaphore.withPermits(1)(
101 + Effect.gen(function* () {
102 + const wanted = new Map<
103 + string,
104 + {
105 + readonly plan: ReadablePlan;
106 + readonly byReference: Map<string, Array<SecretReference>>;
107 }
108 + >();
109 + references.forEach((reference, index) => {
110 + const plan = plans[index];
111 + if (plan === undefined || !isMissing(reference, index)) return;
112 + const group = wanted.get(reference.provider) ?? { plan, byReference: new Map() };
113 + group.byReference.set(reference.reference, [
114 + ...(group.byReference.get(reference.reference) ?? []),
115 + reference,
116 + ]);
117 + wanted.set(reference.provider, group);
118 });
100 - }
101 -
102 - return references.map((reference, index) => {
103 - const cached = cache.get(cacheKey(reference));
104 - return plans[index] !== undefined && cached?.config === plans[index].configKey
105 - ? cached.value
106 - : undefined;
107 - });
108 - },
109 - (effect) => semaphore.withPermits(1)(effect),
110 - Effect.provideContext(context),
111 - );
119 + for (const { plan, byReference } of wanted.values()) {
120 + const values = yield* plan.driver.read(plan.config, [...byReference.keys()]);
121 + [...byReference.values()].forEach((sameReference, index) => {
122 + for (const reference of sameReference) {
123 + cache.set(cacheKey(reference), { config: plan.configKey, value: values[index] });
124 + }
125 + });
126 + }
127 + return answer(references, plans);
128 + }),
129 + );
130 + }, Effect.provideContext(context));
131
132 const invalidate: SecretResolver["Service"]["invalidate"] = (references) =>
133 semaphore.withPermits(1)(
packages/source-control-bitbucket/src/server/BitbucketApi.ts
+7 -2
@@ -9,6 +9,7 @@ import * as Schema from "effect/Schema";
9 import * as Semaphore from "effect/Semaphore";
10 import {
11 NonNegativeInt,
12 + settingsSecretLiteral,
13 SourceControlProviderKind,
14 TrimmedNonEmptyString,
15 type SourceControlProviderAuth,
@@ -567,7 +568,11 @@ function resolveCredential(
568 env: Config.Success<typeof BitbucketApiEnvConfig>,
569 ): BitbucketCredential | null {
570 return (
570 - credentialFrom(settings) ??
571 + credentialFrom({
572 + accessToken: settingsSecretLiteral(settings.accessToken),
573 + email: settings.email,
574 + apiToken: settingsSecretLiteral(settings.apiToken),
575 + }) ??
576 credentialFrom({
577 accessToken: Option.getOrElse(env.accessToken, () => ""),
578 email: Option.getOrElse(env.email, () => ""),
@@ -663,7 +668,7 @@ export const make = Effect.gen(function* () {
668
669 const apiUrl = (path: string) => `${config.baseUrl.replace(/\/+$/u, "")}${path}`;
670
666 - const currentCredential = host.settings.get.pipe(
671 + const currentCredential = host.settings.getWithSecrets(BitbucketClient.definition.kind).pipe(
672 Effect.map((settings) =>
673 resolveCredential(
674 readSourceControlHostSettings(
packages/source-control-bitbucket/src/shared/definition.ts
+9 -6
@@ -1,5 +1,6 @@
1 import {
2 makeProviderSettingsSchema,
3 + SettingsSecretValue,
4 SourceControlProviderKind,
5 TrimmedString,
6 } from "@t3tools/contracts";
@@ -40,26 +41,28 @@ const text = (annotations: Schema.Annotations.Key<string>) =>
41 Schema.annotateKey(annotations),
42 );
43
44 +const secret = (annotations: Schema.Annotations.Key<SettingsSecretValue>) =>
45 + SettingsSecretValue.pipe(
46 + Schema.withDecodingDefault(Effect.succeed("")),
47 + Schema.annotateKey({ ...annotations, providerSettingsForm: { control: "password" } }),
48 + );
49 +
50 export const settings = makeProviderSettingsSchema(
51 {
45 - accessToken: text({
52 + accessToken: secret({
53 title: "Access token",
54 description:
55 "Scoped to one repository, project, or workspace. Create it in that item's Bitbucket settings.",
49 - settingsSecret: true,
50 - providerSettingsForm: { control: "password" },
56 }),
57 email: text({
58 title: "Atlassian account email",
59 description: "With an API token instead of an access token.",
60 providerSettingsForm: { placeholder: "you@example.com" },
61 }),
57 - apiToken: text({
62 + apiToken: secret({
63 title: "API token",
64 description:
65 "Reaches every repository your Atlassian account can. Give it read and write access to repositories and pull requests, and read:user:bitbucket.",
61 - settingsSecret: true,
62 - providerSettingsForm: { control: "password" },
66 }),
67 },
68 { order: ["accessToken", "email", "apiToken"] },
packages/source-control-core/src/server/SourceControlHost.ts
+6
@@ -68,6 +68,12 @@ export class SourceControlHost extends Context.Service<
68 readonly settings: {
69 /** Read fresh on each call to pick up credential changes. */
70 readonly get: Effect.Effect<ServerSettings, ServerSettingsError>;
71 + /**
72 + * Like `get`, with each secret provider reference in one host kind's credentials replaced
73 + * by the secret it names. An unreadable reference reads as unset. Only a reader of that
74 + * kind should call it: resolving can wait on a secret provider.
75 + */
76 + readonly getWithSecrets: (kind: string) => Effect.Effect<ServerSettings, ServerSettingsError>;
77 /** For credentials the host obtains itself, such as a sign-in it refreshes. */
78 readonly update: (
79 patch: ServerSettingsPatch,
packages/source-control-gitcafe/src/server/GitCafeCredentials.ts
+8 -5
@@ -1,3 +1,4 @@
1 +import { settingsSecretLiteral } from "@t3tools/contracts";
2 import { normalizeHost } from "@t3tools/source-control-core/server/pullRequestUtils";
3 import * as Cache from "effect/Cache";
4 import * as Context from "effect/Context";
@@ -128,13 +129,15 @@ export const make = Effect.gen(function* () {
129 const fromSettings = (host: string) =>
130 normalizeHost(host) !== DEFAULT_HOST
131 ? Effect.succeed(null)
131 - : sourceControlHost.settings.get.pipe(
132 + : sourceControlHost.settings.getWithSecrets(GitCafeClient.definition.kind).pipe(
133 Effect.map(
134 (settings) =>
134 - readSourceControlHostSettings(
135 - GitCafeClient.settings,
136 - settings.sourceControlHosts[GitCafeClient.definition.kind],
137 - ).token || null,
135 + settingsSecretLiteral(
136 + readSourceControlHostSettings(
137 + GitCafeClient.settings,
138 + settings.sourceControlHosts[GitCafeClient.definition.kind],
139 + ).token,
140 + ) || null,
141 ),
142 Effect.orElseSucceed(() => null),
143 );
packages/source-control-gitcafe/src/shared/definition.ts
+2 -4
@@ -1,8 +1,7 @@
1 import {
2 makeProviderSettingsSchema,
3 - secretSetting,
3 + SettingsSecretValue,
4 SourceControlProviderKind,
5 - TrimmedString,
5 } from "@t3tools/contracts";
6 import * as Effect from "effect/Effect";
7 import * as Schema from "effect/Schema";
@@ -34,8 +33,7 @@ function parseChangeRequestUrl(url: URL) {
33 const KIND = SourceControlProviderKind.make("gitcafe");
34
35 export const settings = makeProviderSettingsSchema({
37 - token: TrimmedString.pipe(
38 - secretSetting,
36 + token: SettingsSecretValue.pipe(
37 Schema.withDecodingDefault(Effect.succeed("")),
38 Schema.annotateKey({
39 title: "Token",
packages/source-control-testing/src/TestSourceControlHost.ts
+1 -1
@@ -58,7 +58,7 @@ export const layer = (
58 const update = (patch: ServerSettingsPatch) =>
59 Ref.updateAndGet(settings, (current) => applyServerSettingsPatch(current, patch));
60 const host = SourceControlHost.SourceControlHost.of({
61 - settings: { get: Ref.get(settings), update },
61 + settings: { get: Ref.get(settings), getWithSecrets: () => Ref.get(settings), update },
62 process: {
63 run:
64 options.process?.run ??