Skip to content

refactor(settings): centralize schema-declared secrets and inputs #18505

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
juliusmarminge merged 2 commits into from
Oct 12, 2026
Merged

refactor(settings): centralize schema-declared secrets and inputs #18505

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
75add3c
refactor(server): centralize schema-declared settings secrets
juliusmarminge Oct 12, 2026
1e11049
refactor(web): share secret settings inputs
juliusmarminge Oct 12, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
184 changes: 175 additions & 9 deletions apps/server/src/serverSettings.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ import {
resolveProviderInstanceEnabled,
ServerSettings,
ServerSettingsPatch,
UsageLimitSourceId,
} from "@t3tools/contracts";
import { createModelSelection } from "@t3tools/shared/model";
import { assert, it } from "@effect/vitest";
Expand Down Expand Up @@ -1440,6 +1441,156 @@ it.layer(NodeServices.layer)("server settings", (it) => {
}).pipe(Effect.provide(layerServerSettings())),
);

it.effect(
"uses the same secret lifecycle for provider config, environment, host tokens, and quota keys",
() =>
Effect.gen(function* () {
const service = yield* ServerSettingsModule.ServerSettingsService;
const config = yield* ServerConfig.ServerConfig;
const fs = yield* FileSystem.FileSystem;
const store = yield* ServerSecretStore.ServerSecretStore;
const instanceId = ProviderInstanceId.make("antigravity_secrets");
const saved = yield* service.updateSettings({
providerInstances: {
[instanceId]: {
driver: ProviderDriverKind.make("antigravity"),
config: { apiKey: "config-secret" },
environment: [
{ name: "API_TOKEN", value: "env-secret", sensitive: true },
{ name: "BASE_URL", value: "https://example.test", sensitive: false },
],
},
},
sourceControlHosts: {
github: { tokens: { "github.com": "github-secret" } },
bitbucket: { email: "me@example.test", accessToken: "bitbucket-secret" },
gitcafe: { token: "gitcafe-secret" },
},
usageLimitSources: {
[UsageLimitSourceId.make("hub")]: {
kind: "cliproxy",
url: "https://hub.example.test",
managementKey: "quota-secret",
enabled: true,
},
},
});
const values = [
"config-secret",
"env-secret",
"github-secret",
"bitbucket-secret",
"gitcafe-secret",
"quota-secret",
];
const client = ServerSettingsModule.redactServerSettingsForClient(saved);
const disk = yield* fs.readFileString(config.settingsPath);
for (const value of values) {
assert.include(JSON.stringify(saved), value);
assert.notInclude(JSON.stringify(client), value);
assert.notInclude(disk, value);
}
assert.include(JSON.stringify(client), "https://example.test");
assert.include(JSON.stringify(client), "me@example.test");
const echoed = yield* service.updateSettings({
providerInstances: client.providerInstances,
sourceControlHosts: client.sourceControlHosts,
usageLimitSources: client.usageLimitSources,
});
for (const value of values) assert.include(JSON.stringify(echoed), value);
const renamed = yield* service.updateProviderInstance({
operation: "upsert",
instanceId,
instance: { ...client.providerInstances[instanceId]!, displayName: "Renamed" },
});
assert.propertyVal(
renamed.providerInstances[instanceId]?.config,
"apiKey",
"config-secret",
);

for (const apiKey of ["replacement-secret", ""]) {
const changed = yield* service.updateProviderInstance({
operation: "upsert",
instanceId,
instance: { ...client.providerInstances[instanceId]!, config: { apiKey } },
});
assert.propertyVal(changed.providerInstances[instanceId]?.config, "apiKey", apiKey);
const redacted = ServerSettingsModule.redactServerSettingsForClient(changed);
assert.propertyVal(
redacted.providerInstances[instanceId]?.config,
"apiKey",
apiKey ? "••••••" : "",
);
}
// Restore the value so removing the instance below exercises deletion of both secrets.
yield* service.updateProviderInstance({
operation: "upsert",
instanceId,
instance: saved.providerInstances[instanceId]!,
});

const secretNames = [
"provider-config-YW50aWdyYXZpdHlfc2VjcmV0cw-YW50aWdyYXZpdHk-YXBpS2V5",
"provider-env-YW50aWdyYXZpdHlfc2VjcmV0cw-QVBJX1RPS0VO",
sourceControlHostSecretName({
kind: "github",
field: "tokens",
serverHost: "github.com",
}),
sourceControlHostSecretName({
kind: "bitbucket",
field: "accessToken",
serverHost: null,
}),
sourceControlHostSecretName({ kind: "gitcafe", field: "token", serverHost: null }),
"usage-limit-source-aHVi",
];
for (const name of secretNames) {
assert.isTrue(Option.isSome(yield* store.get(name)), name);
}
yield* service.updateSettings({
providerInstances: {},
sourceControlHosts: {
github: { tokens: {} },
bitbucket: { accessToken: "" },
gitcafe: { token: "" },
},
usageLimitSources: { [UsageLimitSourceId.make("hub")]: null },
});
for (const name of secretNames) {
assert.isTrue(Option.isNone(yield* store.get(name)));
}
}).pipe(Effect.provide(layerServerSettingsWithSecrets())),
);

it.effect("moves a saved Antigravity key to the secret store when settings load", () =>
Effect.gen(function* () {
const service = yield* ServerSettingsModule.ServerSettingsService;
const config = yield* ServerConfig.ServerConfig;
const fs = yield* FileSystem.FileSystem;
yield* fs.writeFileString(
config.settingsPath,
JSON.stringify({
providerInstances: {
antigravity: { driver: "antigravity", config: { apiKey: "legacy-api-key" } },
},
}),
);
const saved = yield* service.getSettings;
assert.propertyVal(
saved.providerInstances[ProviderInstanceId.make("antigravity")]?.config,
"apiKey",
"legacy-api-key",
);
assert.notInclude(yield* fs.readFileString(config.settingsPath), "legacy-api-key");
assert.notInclude(
JSON.stringify(ServerSettingsModule.redactServerSettingsForClient(saved)),
"legacy-api-key",
);
}).pipe(Effect.provide(layerServerSettings())),
);

it.effect("stores sensitive provider instance environment values outside settings.json", () =>
Effect.gen(function* () {
const serverSettings = yield* ServerSettingsModule.ServerSettingsService;
Expand Down Expand Up @@ -1714,7 +1865,7 @@ it.layer(NodeServices.layer)("server settings", (it) => {
? Effect.fail(writeFailure)
: fileSystem.rename(fromPath, toPath),
});
const instanceId = ProviderInstanceId.make("codex_write_failure");
const instanceId = ProviderInstanceId.make("antigravity_write_failure");
const layerSettings = layerServerSettings().pipe(
Layer.provideMerge(Layer.succeed(FileSystem.FileSystem, failingFileSystem)),
);
Expand All @@ -1726,9 +1877,9 @@ it.layer(NodeServices.layer)("server settings", (it) => {
operation: "upsert",
instanceId,
instance: {
driver: ProviderDriverKind.make("codex"),
driver: ProviderDriverKind.make("antigravity"),
environment: [{ name: "OPENROUTER_API_KEY", value: "sk-kept", sensitive: true }],
config: {},
config: { apiKey: "config-kept" },
},
});

Expand All @@ -1738,9 +1889,9 @@ it.layer(NodeServices.layer)("server settings", (it) => {
operation: "upsert",
instanceId,
instance: {
driver: ProviderDriverKind.make("codex"),
driver: ProviderDriverKind.make("antigravity"),
environment: [{ name: "OPENROUTER_API_KEY", value: "sk-new", sensitive: true }],
config: {},
config: { apiKey: "config-new" },
},
})
.pipe(Effect.result);
Expand All @@ -1750,6 +1901,11 @@ it.layer(NodeServices.layer)("server settings", (it) => {
?.value,
"sk-kept",
);
assert.propertyVal(
(yield* serverSettings.getSettings).providerInstances[instanceId]?.config,
"apiKey",
"config-kept",
);

const failed = yield* serverSettings
.updateProviderInstance({ operation: "remove", instanceId })
Expand All @@ -1760,6 +1916,11 @@ it.layer(NodeServices.layer)("server settings", (it) => {
?.value,
"sk-kept",
);
assert.propertyVal(
(yield* serverSettings.getSettings).providerInstances[instanceId]?.config,
"apiKey",
"config-kept",
);
}).pipe(Effect.provide(layerSettings));
}),
);
Expand Down Expand Up @@ -1841,9 +2002,9 @@ it.layer(NodeServices.layer)("server settings", (it) => {
yield* serverSettings.updateSettings({
providerInstances: {
[instanceId]: {
driver: ProviderDriverKind.make("codex"),
driver: ProviderDriverKind.make("antigravity"),
environment: [{ name: "OPENROUTER_API_KEY", value: "sk-kept", sensitive: true }],
config: {},
config: { apiKey: "config-kept" },
},
},
});
Expand All @@ -1853,9 +2014,9 @@ it.layer(NodeServices.layer)("server settings", (it) => {
.updateSettings({
providerInstances: {
[instanceId]: {
driver: ProviderDriverKind.make("codex"),
driver: ProviderDriverKind.make("antigravity"),
environment: [{ name: "OPENROUTER_API_KEY", value: "sk-new", sensitive: true }],
config: {},
config: { apiKey: "config-new" },
},
},
})
Expand All @@ -1868,6 +2029,11 @@ it.layer(NodeServices.layer)("server settings", (it) => {
?.value,
"sk-kept",
);
assert.propertyVal(
(yield* serverSettings.getSettings).providerInstances[instanceId]?.config,
"apiKey",
"config-kept",
);
}).pipe(Effect.provide(layerSettings));
},
);
Expand Down
Loading
Loading