Skip to content

Commit 08a463e

Browse files
only21milclaudemaria-rcks
authored
fix(settings): project edits keep overrides the client does not know (#24472)
Co-authored-by: Claude Opus 5.5 <[email protected]> Co-authored-by: maria-rcks <[email protected]> Co-authored-by: maria-rcks <[email protected]>
1 parent 1fe8ddd commit 08a463e

6 files changed

Lines changed: 125 additions & 13 deletions

File tree

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

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -212,6 +212,31 @@ it.layer(NodeServices.layer)("server settings", (it) => {
212212
}).pipe(Effect.provide(layerServerSettings())),
213213
);
214214

215+
it.effect("keeps an override key a newer server saved when a project setting is edited", () =>
216+
Effect.gen(function* () {
217+
const config = yield* ServerConfig.ServerConfig;
218+
const fs = yield* FileSystem.FileSystem;
219+
const service = yield* ServerSettingsModule.ServerSettingsService;
220+
const projectId = ProjectId.make("project-a");
221+
yield* fs.writeFileString(
222+
config.settingsPath,
223+
`{ "projectSettingsOverrides": { "project-a": { "defaultAutoPull": true, "addedByNewerServer": 3 } } }`,
224+
);
225+
const loaded = yield* service.getSettings;
226+
227+
yield* service.updateSettings({
228+
projectSettingsOverrides: {
229+
[projectId]: { ...loaded.projectSettingsOverrides[projectId], defaultAutoPull: false },
230+
},
231+
});
232+
233+
const persisted = JSON.parse(yield* fs.readFileString(config.settingsPath));
234+
assert.deepEqual(persisted.projectSettingsOverrides, {
235+
[projectId]: { defaultAutoPull: false, addedByNewerServer: 3 },
236+
});
237+
}).pipe(Effect.provide(layerServerSettings())),
238+
);
239+
215240
it.effect("moves an idle compaction mode saved in the legacy switch to its own field", () =>
216241
Effect.gen(function* () {
217242
const config = yield* ServerConfig.ServerConfig;

‎apps/server/src/serverSettings.ts‎

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@ import {
33
ModelSelection,
44
ProjectId,
55
ProjectScript,
6+
keepUnknownOverrideKeys,
67
ProjectSettingsOverrides,
78
type ProviderInstanceConfig,
89
type ProviderInstanceMutation,
@@ -292,10 +293,12 @@ const ServerSettingsJson = fromLenientJson(
292293
),
293294
projectSettingsOverrides: Schema.Record(
294295
ProjectId,
295-
Schema.Struct({
296-
...ProjectSettingsOverrides.fields,
297-
responseStreamingMode: Schema.optionalKey(PersistedResponseStreamingMode),
298-
}),
296+
keepUnknownOverrideKeys(
297+
Schema.Struct({
298+
...ProjectSettingsOverrides.fields,
299+
responseStreamingMode: Schema.optionalKey(PersistedResponseStreamingMode),
300+
}),
301+
),
299302
).pipe(Schema.withDecodingDefault(Effect.succeed({}))),
300303
}),
301304
);

‎packages/contracts/src/settings.test.ts‎

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,7 @@ const encodeClientSettings = Schema.encodeSync(ClientSettingsSchema);
2525
const decodeServerSettings = Schema.decodeUnknownSync(ServerSettings);
2626
const decodeServerSettingsPatch = Schema.decodeUnknownSync(ServerSettingsPatch);
2727
const encodeServerSettings = Schema.encodeSync(ServerSettings);
28+
const encodeServerSettingsPatch = Schema.encodeSync(ServerSettingsPatch);
2829
const decodeClaudeSettings = Schema.decodeUnknownSync(ClaudeSettings);
2930

3031
describe("storage cleanup settings", () => {
@@ -372,6 +373,27 @@ it("validates remote device hosts and rejects ambiguous host ids", () => {
372373
expect(() => decodeDeviceHostSettings({ deviceHosts: [{ ...host, port: 0 }] })).toThrow();
373374
});
374375

376+
describe("ServerSettings project overrides across versions", () => {
377+
it("sends back an override key from a newer server when an older client edits the entry", () => {
378+
const projectId = ProjectId.make("project-a");
379+
// As an older client reads a newer server's settings, with one key it does not know.
380+
const entry = decodeServerSettings({
381+
projectSettingsOverrides: {
382+
[projectId]: { defaultAutoPull: true, addedByNewerServer: { mode: "kept" } },
383+
},
384+
}).projectSettingsOverrides[projectId];
385+
386+
const sent = encodeServerSettingsPatch({
387+
projectSettingsOverrides: { [projectId]: { ...entry, defaultAutoPull: false } },
388+
});
389+
390+
expect(decodeServerSettingsPatch(sent).projectSettingsOverrides?.[projectId]).toEqual({
391+
defaultAutoPull: false,
392+
addedByNewerServer: { mode: "kept" },
393+
});
394+
});
395+
});
396+
375397
describe("resolveProjectProviderInstanceEnabled", () => {
376398
const projectId = "project-a" as ProjectId;
377399
const instanceId = ProviderInstanceId.make("codex_work");

‎packages/contracts/src/settings.ts‎

Lines changed: 20 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1137,6 +1137,16 @@ export const ProjectSettingsOverrides = Schema.Struct({
11371137
} satisfies Record<ProjectScopedServerSettingKey | "providerInstances", unknown>);
11381138
export type ProjectSettingsOverrides = typeof ProjectSettingsOverrides.Type;
11391139

1140+
// Whole-entry writers must round-trip unknown keys; keep the type closed to catch misspellings.
1141+
export const keepUnknownOverrideKeys = <Entry extends Schema.Struct<Schema.Struct.Fields>>(
1142+
entry: Entry,
1143+
): Schema.Codec<
1144+
Entry["Type"],
1145+
Entry["Encoded"],
1146+
Entry["DecodingServices"],
1147+
Entry["EncodingServices"]
1148+
> => Schema.StructWithRest(entry, [Schema.Record(Schema.String, Schema.Unknown)]);
1149+
11401150
/** True if null stores an override; otherwise null removes it. */
11411151
export function isNullableProjectSettingsOverride(key: ProjectScopedServerSettingKey): boolean {
11421152
return NULLABLE_PROJECT_SETTINGS_OVERRIDES.has(key);
@@ -1263,9 +1273,10 @@ export const ServerSettings = Schema.Struct({
12631273
Schema.withDecodingDefault(Effect.succeed(DEFAULT_RUNTIME_MODE)),
12641274
),
12651275

1266-
projectSettingsOverrides: Schema.Record(ProjectId, ProjectSettingsOverrides).pipe(
1267-
Schema.withDecodingDefault(Effect.succeed({})),
1268-
),
1276+
projectSettingsOverrides: Schema.Record(
1277+
ProjectId,
1278+
keepUnknownOverrideKeys(ProjectSettingsOverrides),
1279+
).pipe(Schema.withDecodingDefault(Effect.succeed({}))),
12691280
/** Fold once so restarts cannot undo later UI resets. */
12701281
projectSettingsFolded: Schema.Boolean.pipe(Schema.withDecodingDefault(Effect.succeed(false))),
12711282

@@ -1626,10 +1637,12 @@ export const ServerSettingsPatch = Schema.Struct({
16261637
Schema.Record(
16271638
ProjectId,
16281639
Schema.NullOr(
1629-
Schema.Struct({
1630-
...ProjectSettingsOverrides.fields,
1631-
sourceControlWritingStyle: Schema.optionalKey(SourceControlWritingStyleSettings),
1632-
}),
1640+
keepUnknownOverrideKeys(
1641+
Schema.Struct({
1642+
...ProjectSettingsOverrides.fields,
1643+
sourceControlWritingStyle: Schema.optionalKey(SourceControlWritingStyleSettings),
1644+
}),
1645+
),
16331646
),
16341647
),
16351648
),

‎packages/shared/src/serverSettings.test.ts‎

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,10 +6,13 @@ import {
66
ProviderInstanceId,
77
SecretProviderId,
88
SecretProviderKind,
9+
ServerSettings,
10+
ServerSettingsPatch,
911
UsageLimitSourceId,
1012
type ServerProvider,
1113
} from "@t3tools/contracts";
1214
import * as Duration from "effect/Duration";
15+
import * as Schema from "effect/Schema";
1316
import { describe, expect, it } from "vite-plus/test";
1417
import { resolveServerBackgroundActivitySettings } from "./backgroundActivitySettings.ts";
1518
import { createModelSelection } from "./model.ts";
@@ -24,6 +27,9 @@ import {
2427
resolveSourceControlWriterModelSelection,
2528
} from "./serverSettings.ts";
2629

30+
const decodeServerSettings = Schema.decodeUnknownSync(ServerSettings);
31+
const decodeServerSettingsPatch = Schema.decodeUnknownSync(ServerSettingsPatch);
32+
2733
const FOLDED_SERVER_SETTINGS = { ...DEFAULT_SERVER_SETTINGS, projectSettingsFolded: true };
2834

2935
describe("fallbackTextGenerationModelSelection", () => {
@@ -499,6 +505,37 @@ describe("serverSettings helpers", () => {
499505
});
500506
});
501507

508+
// regression: #18334 a newer client must still see this server drop a key it does not know
509+
it("drops an override key this server does not know from a patch and keeps one it stored", () => {
510+
const projectId = ProjectId.make("project-a");
511+
const current = decodeServerSettings({
512+
projectSettingsFolded: true,
513+
projectSettingsOverrides: {
514+
[projectId]: { defaultAutoPull: true, addedByNewerServer: 3 },
515+
},
516+
});
517+
const patch = decodeServerSettingsPatch({
518+
projectSettingsOverrides: {
519+
[projectId]: { defaultAutoPull: false, addedByNewerServer: 4, addedByNewerClient: "x" },
520+
},
521+
});
522+
523+
const updated = applyServerSettingsPatch(current, patch);
524+
expect(updated.projectSettingsOverrides[projectId]).toEqual({
525+
defaultAutoPull: false,
526+
addedByNewerServer: 3,
527+
});
528+
const reset = applyServerSettingsPatch(updated, {
529+
projectSettingsOverrides: { [projectId]: {} },
530+
});
531+
expect(reset.projectSettingsOverrides[projectId]).toEqual({ addedByNewerServer: 3 });
532+
expect(
533+
applyServerSettingsPatch(reset, {
534+
projectSettingsOverrides: { [projectId]: null },
535+
}).projectSettingsOverrides[projectId],
536+
).toBeUndefined();
537+
});
538+
502539
it("clears a project's providerInstances override when a patch entry sends an empty map", () => {
503540
const instanceId = ProviderInstanceId.make("codex_work");
504541
const projectId = ProjectId.make("project-a");

‎packages/shared/src/serverSettings.ts‎

Lines changed: 14 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ import {
1414
type ModelSelection,
1515
type ProjectId,
1616
type ProjectScopedServerSettingKey,
17-
type ProjectSettingsOverrides,
17+
ProjectSettingsOverrides,
1818
ProviderDriverKind,
1919
ProviderInstanceId,
2020
type ServerProvider,
@@ -226,6 +226,16 @@ function mergeSettingsEntries<Value>(
226226
return Object.fromEntries(next);
227227
}
228228

229+
const knownProjectOverrideKeys = new Set(Object.keys(ProjectSettingsOverrides.fields));
230+
231+
function pickOverrideKeys(entry: ProjectSettingsOverrides | undefined, known: boolean) {
232+
return Object.fromEntries(
233+
Object.entries<unknown>(entry ?? {}).filter(
234+
([key]) => knownProjectOverrideKeys.has(key) === known,
235+
),
236+
);
237+
}
238+
229239
// Older clients omit providerInstances during whole-entry replacement; preserve it to avoid wiping overrides.
230240
function mergeProjectSettingsOverridesPatch(
231241
current: Readonly<Record<string, ProjectSettingsOverrides>>,
@@ -239,7 +249,9 @@ function mergeProjectSettingsOverridesPatch(
239249
}
240250
const storedProviderInstances = current[projectId]?.providerInstances;
241251
next.set(projectId, {
242-
...entry,
252+
// Preserve downgraded storage, but reject new unknown writes so clients can detect unsupported settings.
253+
...pickOverrideKeys(current[projectId], false),
254+
...pickOverrideKeys(entry, true),
243255
...(Object.hasOwn(entry, "providerInstances") || storedProviderInstances === undefined
244256
? {}
245257
: { providerInstances: storedProviderInstances }),

0 commit comments

Comments
 (0)