Skip to content

feat(channels): canonicalise channel name and hint missing preset #3448

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
cv merged 2 commits into from
May 14, 2026
Merged

feat(channels): canonicalise channel name and hint missing preset #3448

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
02394be
feat(channels): canonicalise channel name and hint missing preset
laitingsheng May 13, 2026
df9276e
Merge branch 'main' into feat/sandbox-channels-add-remove-ux
cv May 14, 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
32 changes: 23 additions & 9 deletions src/lib/actions/sandbox/policy-channel.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -410,9 +410,10 @@ export async function addSandboxChannel(sandboxName: string, args: string[] = []
console.error(` Valid channels: ${knownChannelNames().join(", ")}`);
process.exit(1);
}
const canonical = channelArg.trim().toLowerCase();

if (dryRun) {
console.log(` --dry-run: would enable channel '${channelArg}' for '${sandboxName}'.`);
console.log(` --dry-run: would enable channel '${canonical}' for '${sandboxName}'.`);
return;
}

Expand All @@ -428,7 +429,7 @@ export async function addSandboxChannel(sandboxName: string, args: string[] = []
continue;
}
if (isNonInteractive()) {
console.error(` Missing ${envKey} for channel '${channelArg}'.`);
console.error(` Missing ${envKey} for channel '${canonical}'.`);
console.error(
` Set ${envKey} in the environment or via '${CLI_NAME} credentials' before running in non-interactive mode.`,
);
Expand All @@ -450,9 +451,21 @@ export async function addSandboxChannel(sandboxName: string, args: string[] = []
// discard the change. Pre-fix this was safe because saveCredential()
// wrote credentials.json; with env-only persistence, exiting before
// the rebuild used to drop the queued token.
await applyChannelAddToGatewayAndRegistry(sandboxName, channelArg, acquired);
console.log(` ${G}✓${R} Registered ${channelArg} bridge with the OpenShell gateway.`);
await promptAndRebuild(sandboxName, `add '${channelArg}'`);
await applyChannelAddToGatewayAndRegistry(sandboxName, canonical, acquired);
console.log(` ${G}✓${R} Registered ${canonical} bridge with the OpenShell gateway.`);
maybeHintPolicyPresetForChannel(sandboxName, canonical);
await promptAndRebuild(sandboxName, `add '${canonical}'`);
}

function maybeHintPolicyPresetForChannel(sandboxName: string, channelName: string): void {
const presetExists = policies.listPresets().some((p) => p.name === channelName);
if (!presetExists) return;
const applied = policies.getAppliedPresets(sandboxName);
if (applied.includes(channelName)) return;
console.log(
` Hint: the ${channelName} network preset is not applied to '${sandboxName}'. ` +
`Run \`${CLI_NAME} ${sandboxName} policy-add ${channelName}\` so the rebuilt sandbox can reach the ${channelName} service.`,
);
}

export async function removeSandboxChannel(sandboxName: string, args: string[] = []): Promise<void> {
Expand All @@ -470,9 +483,10 @@ export async function removeSandboxChannel(sandboxName: string, args: string[] =
console.error(` Valid channels: ${knownChannelNames().join(", ")}`);
process.exit(1);
}
const canonical = channelArg.trim().toLowerCase();

if (dryRun) {
console.log(` --dry-run: would remove channel '${channelArg}' for '${sandboxName}'.`);
console.log(` --dry-run: would remove channel '${canonical}' for '${sandboxName}'.`);
return;
}

Expand All @@ -483,11 +497,11 @@ export async function removeSandboxChannel(sandboxName: string, args: string[] =
// already "removed" from the user's perspective.
await applyChannelRemoveToGatewayAndRegistry(
sandboxName,
channelArg,
canonical,
getChannelTokenKeys(channel),
);
console.log(` ${G}✓${R} Removed ${channelArg} bridge from the OpenShell gateway.`);
await promptAndRebuild(sandboxName, `remove '${channelArg}'`);
console.log(` ${G}✓${R} Removed ${canonical} bridge from the OpenShell gateway.`);
await promptAndRebuild(sandboxName, `remove '${canonical}'`);
}

async function sandboxChannelsSetEnabled(
Expand Down
10 changes: 10 additions & 0 deletions test/cli.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1700,10 +1700,20 @@ describe("CLI dispatch", () => {
expect(add.code).toBe(0);
expect(add.out).toContain("--dry-run: would enable channel 'telegram' for 'alpha'.");

const addMixedCase = runWithEnv("alpha channels add Telegram --dry-run", { HOME: home });
expect(addMixedCase.code).toBe(0);
expect(addMixedCase.out).toContain("--dry-run: would enable channel 'telegram' for 'alpha'.");

const remove = runWithEnv("alpha channels remove telegram --dry-run", { HOME: home });
expect(remove.code).toBe(0);
expect(remove.out).toContain("--dry-run: would remove channel 'telegram' for 'alpha'.");

const removeMixedCase = runWithEnv("alpha channels remove Telegram --dry-run", { HOME: home });
expect(removeMixedCase.code).toBe(0);
expect(removeMixedCase.out).toContain(
"--dry-run: would remove channel 'telegram' for 'alpha'.",
);

const stop = runWithEnv("alpha channels stop telegram --dry-run", { HOME: home });
expect(stop.code).toBe(0);
expect(stop.out).toContain("--dry-run: would stop channel 'telegram' for 'alpha'.");
Expand Down
Loading