Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
11 changes: 6 additions & 5 deletions src/lib/state/registry.ts
Original file line number Diff line number Diff line change
Expand Up @@ -431,21 +431,22 @@ function normalizeSandboxEntryForRuntime(entry: SandboxEntry): SandboxEntry {

/**
* Prepare a sandbox entry for persistence: normalize messaging state and drop
* transient #5714 display-only markers (`recoveredFromGateway`, `livePhase`)
* transient #5714 display-only markers plus legacy provider credential hashes
* that must never reach sandboxes.json.
*/
function serializeSandboxEntryForDisk(entry: SandboxEntry): SandboxEntry {
// #5714: defensively drop transient, display-only recovery markers so they
// can never reach sandboxes.json even if a caller force-passed one through
// updateSandbox(). These are not part of the durable SandboxEntry type; they
// live only on the ephemeral list-recovery rows.
// Defensively drop non-durable recovery markers and legacy
// providerCredentialHashes so they can never reach sandboxes.json even if a
// caller force-passed them through updateSandbox().
const {
recoveredFromGateway: _recovered,
livePhase: _phase,
providerCredentialHashes: _legacyProviderCredentialHashes,
...durable
} = entry as SandboxEntry & {
recoveredFromGateway?: boolean;
livePhase?: string | null;
providerCredentialHashes?: unknown;
};
const messaging = serializeSandboxMessagingStateForDisk(durable.messaging);
const mcp = serializeSandboxMcpStateForDisk(durable.mcp);
Expand Down
56 changes: 56 additions & 0 deletions test/registry.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -852,6 +852,62 @@ describe("registry", () => {
expect(data.sandboxes.messaging.messagingChannelConfig).toBeUndefined();
});

it("drops legacy providerCredentialHashes when rewriting messaging rows (#3631)", () => {
const basePlan = makeMessagingPlan("messaging", ["telegram"]);
const binding = {
channelId: "telegram",
credentialId: "telegramBotToken",
sourceInput: "botToken",
providerName: "messaging-telegram-bridge",
providerEnvKey: "TELEGRAM_BOT_TOKEN",
placeholder: "openshell:resolve:env:TELEGRAM_BOT_TOKEN",
credentialAvailable: true,
credentialHash: "new-hash",
};
fs.mkdirSync(path.dirname(regFile), { recursive: true });
fs.writeFileSync(
regFile,
`${JSON.stringify(
{
sandboxes: {
messaging: {
name: "messaging",
messaging: {
schemaVersion: 1,
plan: {
...basePlan,
credentialBindings: [binding],
},
},
providerCredentialHashes: [
{
channel: "telegram",
credentialHashes: { TELEGRAM_BOT_TOKEN: "old-hash" },
},
],
},
},
defaultSandbox: "messaging",
},
null,
2,
)}\n`,
);

registry.updateSandbox("messaging", { model: "new-model" });

const data = JSON.parse(fs.readFileSync(regFile, "utf-8"));
expect(data.sandboxes.messaging.providerCredentialHashes).toBeUndefined();
expect(data.sandboxes.messaging.messaging.plan.credentialBindings).toEqual([
{
channelId: "telegram",
providerEnvKey: "TELEGRAM_BOT_TOKEN",
credentialAvailable: true,
credentialHash: "new-hash",
},
]);
});

it("imageTag defaults to null when not provided", () => {
registry.registerSandbox({ name: "no-tag" });
const sb = registry.getSandbox("no-tag");
Expand Down
Loading