Skip to content

Commit 75add3c

Browse files
refactor(server): centralize schema-declared settings secrets
1 parent e688034 commit 75add3c

10 files changed

Lines changed: 481 additions & 403 deletions

File tree

‎apps/server/src/serverSettings.test.ts‎

Lines changed: 175 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@ import {
99
resolveProviderInstanceEnabled,
1010
ServerSettings,
1111
ServerSettingsPatch,
12+
UsageLimitSourceId,
1213
} from "@t3tools/contracts";
1314
import { createModelSelection } from "@t3tools/shared/model";
1415
import { assert, it } from "@effect/vitest";
@@ -1440,6 +1441,156 @@ it.layer(NodeServices.layer)("server settings", (it) => {
14401441
}).pipe(Effect.provide(layerServerSettings())),
14411442
);
14421443

1444+
it.effect(
1445+
"uses the same secret lifecycle for provider config, environment, host tokens, and quota keys",
1446+
() =>
1447+
Effect.gen(function* () {
1448+
const service = yield* ServerSettingsModule.ServerSettingsService;
1449+
const config = yield* ServerConfig.ServerConfig;
1450+
const fs = yield* FileSystem.FileSystem;
1451+
const store = yield* ServerSecretStore.ServerSecretStore;
1452+
const instanceId = ProviderInstanceId.make("antigravity_secrets");
1453+
const saved = yield* service.updateSettings({
1454+
providerInstances: {
1455+
[instanceId]: {
1456+
driver: ProviderDriverKind.make("antigravity"),
1457+
config: { apiKey: "config-secret" },
1458+
environment: [
1459+
{ name: "API_TOKEN", value: "env-secret", sensitive: true },
1460+
{ name: "BASE_URL", value: "https://example.test", sensitive: false },
1461+
],
1462+
},
1463+
},
1464+
sourceControlHosts: {
1465+
github: { tokens: { "github.com": "github-secret" } },
1466+
bitbucket: { email: "[email protected]", accessToken: "bitbucket-secret" },
1467+
gitcafe: { token: "gitcafe-secret" },
1468+
},
1469+
usageLimitSources: {
1470+
[UsageLimitSourceId.make("hub")]: {
1471+
kind: "cliproxy",
1472+
url: "https://hub.example.test",
1473+
managementKey: "quota-secret",
1474+
enabled: true,
1475+
},
1476+
},
1477+
});
1478+
const values = [
1479+
"config-secret",
1480+
"env-secret",
1481+
"github-secret",
1482+
"bitbucket-secret",
1483+
"gitcafe-secret",
1484+
"quota-secret",
1485+
];
1486+
const client = ServerSettingsModule.redactServerSettingsForClient(saved);
1487+
const disk = yield* fs.readFileString(config.settingsPath);
1488+
for (const value of values) {
1489+
assert.include(JSON.stringify(saved), value);
1490+
assert.notInclude(JSON.stringify(client), value);
1491+
assert.notInclude(disk, value);
1492+
}
1493+
assert.include(JSON.stringify(client), "https://example.test");
1494+
assert.include(JSON.stringify(client), "[email protected]");
1495+
const echoed = yield* service.updateSettings({
1496+
providerInstances: client.providerInstances,
1497+
sourceControlHosts: client.sourceControlHosts,
1498+
usageLimitSources: client.usageLimitSources,
1499+
});
1500+
for (const value of values) assert.include(JSON.stringify(echoed), value);
1501+
const renamed = yield* service.updateProviderInstance({
1502+
operation: "upsert",
1503+
instanceId,
1504+
instance: { ...client.providerInstances[instanceId]!, displayName: "Renamed" },
1505+
});
1506+
assert.propertyVal(
1507+
renamed.providerInstances[instanceId]?.config,
1508+
"apiKey",
1509+
"config-secret",
1510+
);
1511+
1512+
for (const apiKey of ["replacement-secret", ""]) {
1513+
const changed = yield* service.updateProviderInstance({
1514+
operation: "upsert",
1515+
instanceId,
1516+
instance: { ...client.providerInstances[instanceId]!, config: { apiKey } },
1517+
});
1518+
assert.propertyVal(changed.providerInstances[instanceId]?.config, "apiKey", apiKey);
1519+
const redacted = ServerSettingsModule.redactServerSettingsForClient(changed);
1520+
assert.propertyVal(
1521+
redacted.providerInstances[instanceId]?.config,
1522+
"apiKey",
1523+
apiKey ? "••••••" : "",
1524+
);
1525+
}
1526+
// Restore the value so removing the instance below exercises deletion of both secrets.
1527+
yield* service.updateProviderInstance({
1528+
operation: "upsert",
1529+
instanceId,
1530+
instance: saved.providerInstances[instanceId]!,
1531+
});
1532+
1533+
const secretNames = [
1534+
"provider-config-YW50aWdyYXZpdHlfc2VjcmV0cw-YW50aWdyYXZpdHk-YXBpS2V5",
1535+
"provider-env-YW50aWdyYXZpdHlfc2VjcmV0cw-QVBJX1RPS0VO",
1536+
sourceControlHostSecretName({
1537+
kind: "github",
1538+
field: "tokens",
1539+
serverHost: "github.com",
1540+
}),
1541+
sourceControlHostSecretName({
1542+
kind: "bitbucket",
1543+
field: "accessToken",
1544+
serverHost: null,
1545+
}),
1546+
sourceControlHostSecretName({ kind: "gitcafe", field: "token", serverHost: null }),
1547+
"usage-limit-source-aHVi",
1548+
];
1549+
for (const name of secretNames) {
1550+
assert.isTrue(Option.isSome(yield* store.get(name)), name);
1551+
}
1552+
yield* service.updateSettings({
1553+
providerInstances: {},
1554+
sourceControlHosts: {
1555+
github: { tokens: {} },
1556+
bitbucket: { accessToken: "" },
1557+
gitcafe: { token: "" },
1558+
},
1559+
usageLimitSources: { [UsageLimitSourceId.make("hub")]: null },
1560+
});
1561+
for (const name of secretNames) {
1562+
assert.isTrue(Option.isNone(yield* store.get(name)));
1563+
}
1564+
}).pipe(Effect.provide(layerServerSettingsWithSecrets())),
1565+
);
1566+
1567+
it.effect("moves a saved Antigravity key to the secret store when settings load", () =>
1568+
Effect.gen(function* () {
1569+
const service = yield* ServerSettingsModule.ServerSettingsService;
1570+
const config = yield* ServerConfig.ServerConfig;
1571+
const fs = yield* FileSystem.FileSystem;
1572+
yield* fs.writeFileString(
1573+
config.settingsPath,
1574+
JSON.stringify({
1575+
providerInstances: {
1576+
antigravity: { driver: "antigravity", config: { apiKey: "legacy-api-key" } },
1577+
},
1578+
}),
1579+
);
1580+
const saved = yield* service.getSettings;
1581+
assert.propertyVal(
1582+
saved.providerInstances[ProviderInstanceId.make("antigravity")]?.config,
1583+
"apiKey",
1584+
"legacy-api-key",
1585+
);
1586+
assert.notInclude(yield* fs.readFileString(config.settingsPath), "legacy-api-key");
1587+
assert.notInclude(
1588+
JSON.stringify(ServerSettingsModule.redactServerSettingsForClient(saved)),
1589+
"legacy-api-key",
1590+
);
1591+
}).pipe(Effect.provide(layerServerSettings())),
1592+
);
1593+
14431594
it.effect("stores sensitive provider instance environment values outside settings.json", () =>
14441595
Effect.gen(function* () {
14451596
const serverSettings = yield* ServerSettingsModule.ServerSettingsService;
@@ -1714,7 +1865,7 @@ it.layer(NodeServices.layer)("server settings", (it) => {
17141865
? Effect.fail(writeFailure)
17151866
: fileSystem.rename(fromPath, toPath),
17161867
});
1717-
const instanceId = ProviderInstanceId.make("codex_write_failure");
1868+
const instanceId = ProviderInstanceId.make("antigravity_write_failure");
17181869
const layerSettings = layerServerSettings().pipe(
17191870
Layer.provideMerge(Layer.succeed(FileSystem.FileSystem, failingFileSystem)),
17201871
);
@@ -1726,9 +1877,9 @@ it.layer(NodeServices.layer)("server settings", (it) => {
17261877
operation: "upsert",
17271878
instanceId,
17281879
instance: {
1729-
driver: ProviderDriverKind.make("codex"),
1880+
driver: ProviderDriverKind.make("antigravity"),
17301881
environment: [{ name: "OPENROUTER_API_KEY", value: "sk-kept", sensitive: true }],
1731-
config: {},
1882+
config: { apiKey: "config-kept" },
17321883
},
17331884
});
17341885

@@ -1738,9 +1889,9 @@ it.layer(NodeServices.layer)("server settings", (it) => {
17381889
operation: "upsert",
17391890
instanceId,
17401891
instance: {
1741-
driver: ProviderDriverKind.make("codex"),
1892+
driver: ProviderDriverKind.make("antigravity"),
17421893
environment: [{ name: "OPENROUTER_API_KEY", value: "sk-new", sensitive: true }],
1743-
config: {},
1894+
config: { apiKey: "config-new" },
17441895
},
17451896
})
17461897
.pipe(Effect.result);
@@ -1750,6 +1901,11 @@ it.layer(NodeServices.layer)("server settings", (it) => {
17501901
?.value,
17511902
"sk-kept",
17521903
);
1904+
assert.propertyVal(
1905+
(yield* serverSettings.getSettings).providerInstances[instanceId]?.config,
1906+
"apiKey",
1907+
"config-kept",
1908+
);
17531909

17541910
const failed = yield* serverSettings
17551911
.updateProviderInstance({ operation: "remove", instanceId })
@@ -1760,6 +1916,11 @@ it.layer(NodeServices.layer)("server settings", (it) => {
17601916
?.value,
17611917
"sk-kept",
17621918
);
1919+
assert.propertyVal(
1920+
(yield* serverSettings.getSettings).providerInstances[instanceId]?.config,
1921+
"apiKey",
1922+
"config-kept",
1923+
);
17631924
}).pipe(Effect.provide(layerSettings));
17641925
}),
17651926
);
@@ -1841,9 +2002,9 @@ it.layer(NodeServices.layer)("server settings", (it) => {
18412002
yield* serverSettings.updateSettings({
18422003
providerInstances: {
18432004
[instanceId]: {
1844-
driver: ProviderDriverKind.make("codex"),
2005+
driver: ProviderDriverKind.make("antigravity"),
18452006
environment: [{ name: "OPENROUTER_API_KEY", value: "sk-kept", sensitive: true }],
1846-
config: {},
2007+
config: { apiKey: "config-kept" },
18472008
},
18482009
},
18492010
});
@@ -1853,9 +2014,9 @@ it.layer(NodeServices.layer)("server settings", (it) => {
18532014
.updateSettings({
18542015
providerInstances: {
18552016
[instanceId]: {
1856-
driver: ProviderDriverKind.make("codex"),
2017+
driver: ProviderDriverKind.make("antigravity"),
18572018
environment: [{ name: "OPENROUTER_API_KEY", value: "sk-new", sensitive: true }],
1858-
config: {},
2019+
config: { apiKey: "config-new" },
18592020
},
18602021
},
18612022
})
@@ -1868,6 +2029,11 @@ it.layer(NodeServices.layer)("server settings", (it) => {
18682029
?.value,
18692030
"sk-kept",
18702031
);
2032+
assert.propertyVal(
2033+
(yield* serverSettings.getSettings).providerInstances[instanceId]?.config,
2034+
"apiKey",
2035+
"config-kept",
2036+
);
18712037
}).pipe(Effect.provide(layerSettings));
18722038
},
18732039
);

0 commit comments

Comments
 (0)