fix(sandbox): support shared --base-url configuration with workspace fallback

Author: chenanran555

packages/commands/src/commands/sandbox/instance.ts

@@ -3,7 +3,6 @@ import {
   detectOutputFormat,
   defineCommand,
   ExitCode,
-  sandboxEndpoint,
   SANDBOX_PATHS,
   sandboxInstanceActionPath,
   sandboxInstancePath,
@@ -20,7 +19,7 @@ import {
   readRequestBody,
   redactConnectionCredentials,
   redactRequestSecrets,
-  resolveWorkspaceId,
+  resolveSandboxEndpoint,
   SANDBOX_NOTES,
   setDefined,
   SHOW_CREDENTIALS_FLAG,
@@ -222,14 +221,14 @@ export const sandboxCreate = defineCommand({
   flags: CREATE_FLAGS,
   exampleArgs: [
     "--template-id tpl-xxx --instance-timeout 3600",
+    "--template-id tpl-xxx --base-url https://workspace.cn-beijing.maas.aliyuncs.com",
     "--body @sandbox.json --dry-run --output json",
     "--template-id tpl-xxx --show-credentials --output json",
   ],
   notes: SANDBOX_NOTES,
   async run(ctx) {
     const format = detectOutputFormat(ctx.settings.output);
-    const workspaceId = resolveWorkspaceId(ctx);
-    const endpoint = sandboxEndpoint(workspaceId, SANDBOX_PATHS.sandboxes);
+    const endpoint = resolveSandboxEndpoint(ctx, SANDBOX_PATHS.sandboxes);
     const body = await buildSandboxCreateBody(ctx.flags);
     if (ctx.settings.dryRun) {
       emitResult({ method: "POST", endpoint, request: redactRequestSecrets(body) }, format);
@@ -265,8 +264,7 @@ export const sandboxList = defineCommand({
     return undefined;
   },
   async run(ctx) {
-    const workspaceId = resolveWorkspaceId(ctx);
-    const url = new URL(sandboxEndpoint(workspaceId, SANDBOX_PATHS.sandboxList));
+    const url = new URL(resolveSandboxEndpoint(ctx, SANDBOX_PATHS.sandboxList));
     if (ctx.flags.templateId) url.searchParams.set("templateID", ctx.flags.templateId);
     if (ctx.flags.sandboxId) url.searchParams.set("sandboxID", ctx.flags.sandboxId);
     if (ctx.flags.state) url.searchParams.set("state", ctx.flags.state);
@@ -314,8 +312,7 @@ export const sandboxGet = defineCommand({
   exampleArgs: ["--sandbox-id sbx-xxx", "--sandbox-id sbx-xxx --show-credentials --output json"],
   notes: SANDBOX_NOTES,
   async run(ctx) {
-    const workspaceId = resolveWorkspaceId(ctx);
-    const endpoint = sandboxEndpoint(workspaceId, sandboxInstancePath(ctx.flags.sandboxId));
+    const endpoint = resolveSandboxEndpoint(ctx, sandboxInstancePath(ctx.flags.sandboxId));
     const response = await ctx.client.requestJson<SandboxInfo>({ path: endpoint, method: "GET" });
     emitSandboxObject(response, {
       format: detectOutputFormat(ctx.settings.output),
@@ -343,9 +340,8 @@ function connectionCommand(action: "connect" | "resume") {
     notes: SANDBOX_NOTES,
     async run(ctx) {
       const format = detectOutputFormat(ctx.settings.output);
-      const workspaceId = resolveWorkspaceId(ctx);
-      const endpoint = sandboxEndpoint(
-        workspaceId,
+      const endpoint = resolveSandboxEndpoint(
+        ctx,
         sandboxInstanceActionPath(ctx.flags.sandboxId, action),
       );
       const body = await buildConnectionBody(ctx.flags);
@@ -379,9 +375,8 @@ export const sandboxPause = defineCommand({
   notes: SANDBOX_NOTES,
   async run(ctx) {
     const format = detectOutputFormat(ctx.settings.output);
-    const workspaceId = resolveWorkspaceId(ctx);
-    const endpoint = sandboxEndpoint(
-      workspaceId,
+    const endpoint = resolveSandboxEndpoint(
+      ctx,
       sandboxInstanceActionPath(ctx.flags.sandboxId, "pause"),
     );
     if (ctx.settings.dryRun) {
@@ -410,8 +405,7 @@ export const sandboxDelete = defineCommand({
   notes: SANDBOX_NOTES,
   async run(ctx) {
     const format = detectOutputFormat(ctx.settings.output);
-    const workspaceId = resolveWorkspaceId(ctx);
-    const endpoint = sandboxEndpoint(workspaceId, sandboxInstancePath(ctx.flags.sandboxId));
+    const endpoint = resolveSandboxEndpoint(ctx, sandboxInstancePath(ctx.flags.sandboxId));
     if (ctx.settings.dryRun) {
       emitResult({ method: "DELETE", endpoint, request: null }, format);
       return;

packages/commands/src/commands/sandbox/shared.ts

@@ -1,13 +1,21 @@
 import { readFile } from "node:fs/promises";
-import { BailianError, ExitCode, type FlagsDef, type LocalizedText } from "bailian-cli-core";
+import {
+  BailianError,
+  ExitCode,
+  sandboxApiPath,
+  sandboxBaseUrl,
+  type Client,
+  type FlagsDef,
+  type LocalizedText,
+} from "bailian-cli-core";
 
 export const WORKSPACE_FLAG = {
   workspaceId: {
     type: "string",
     valueHint: "<id>",
     description: {
-      "en-US": "Workspace ID for the Sandbox endpoint (or set BAILIAN_WORKSPACE_ID)",
-      "zh-CN": "Sandbox Endpoint 使用的 Workspace ID（也可设置 BAILIAN_WORKSPACE_ID）",
+      "en-US": "Workspace ID for the default Sandbox endpoint; optional with a configured base URL",
+      "zh-CN": "默认 Sandbox Endpoint 的 Workspace ID；已配置 Base URL 时可省略",
     },
   },
 } satisfies FlagsDef;
@@ -62,8 +70,15 @@ export const SANDBOX_NOTES: LocalizedText[] = [
   },
   {
     "en-US":
-      "The workspace is resolved from --workspace-id, BAILIAN_WORKSPACE_ID, then config workspace_id.",
-    "zh-CN": "Workspace 依次从 --workspace-id、BAILIAN_WORKSPACE_ID、配置项 workspace_id 解析。",
+      "Base URL: --base-url > DASHSCOPE_BASE_URL > login/profile base_url. The CLI uses its origin and appends /api/v1/agentstudio/sandbox; otherwise it uses the workspace-scoped cn-beijing endpoint.",
+    "zh-CN":
+      "Base URL 优先级：--base-url > DASHSCOPE_BASE_URL > 登录/Profile 的 base_url。CLI 取其 origin 并追加 /api/v1/agentstudio/sandbox；未配置时使用工作空间的 cn-beijing Endpoint。",
+  },
+  {
+    "en-US":
+      "Without a configured base URL, workspace is required: --workspace-id > BAILIAN_WORKSPACE_ID > config workspace_id.",
+    "zh-CN":
+      "未配置 Base URL 时必须提供 Workspace：--workspace-id > BAILIAN_WORKSPACE_ID > 配置项 workspace_id。",
   },
   {
     "en-US":
@@ -80,17 +95,23 @@ export const SANDBOX_NOTES: LocalizedText[] = [
 
 export type JsonObject = Record<string, unknown>;
 
-export function resolveWorkspaceId(ctx: {
+interface SandboxEndpointContext {
   flags: { workspaceId?: string };
   settings: { workspaceId?: string };
-  identity: { binName: string };
-}): string {
+  client: Pick<Client, "url">;
+}
+
+export function resolveSandboxEndpoint(ctx: SandboxEndpointContext, path: string): string {
+  return ctx.client.url(sandboxApiPath(path), () => sandboxBaseUrl(resolveWorkspaceId(ctx)));
+}
+
+export function resolveWorkspaceId(ctx: Omit<SandboxEndpointContext, "client">): string {
   const workspaceId = ctx.flags.workspaceId || ctx.settings.workspaceId;
   if (!workspaceId) {
     throw new BailianError(
-      "Workspace ID is required.",
+      "Workspace ID is required when no base URL is configured. / 未配置 Base URL 时必须提供 Workspace ID。",
       ExitCode.USAGE,
-      `Pass --workspace-id, set BAILIAN_WORKSPACE_ID, or configure: ${ctx.identity.binName} config set workspace_id <id>`,
+      "Pass --workspace-id, set BAILIAN_WORKSPACE_ID, configure workspace_id, or set --base-url. / 请传入 --workspace-id、设置 BAILIAN_WORKSPACE_ID 或 workspace_id 配置，或通过 --base-url 指定地址。",
     );
   }
   return workspaceId;

packages/commands/src/commands/sandbox/template.ts

@@ -3,7 +3,7 @@ import {
   detectOutputFormat,
   defineCommand,
   ExitCode,
-  sandboxEndpoint,
+  sandboxApiPath,
   SANDBOX_PATHS,
   sandboxTemplateBuildStatusPath,
   sandboxTemplatePath,
@@ -21,7 +21,7 @@ import {
   POLL_INTERVAL_FLAG,
   readRequestBody,
   redactRequestSecrets,
-  resolveWorkspaceId,
+  resolveSandboxEndpoint,
   SANDBOX_NOTES,
   setDefined,
   validateIntegerRange,
@@ -312,7 +312,7 @@ function validatePollInterval(flags: { pollInterval?: number }): string | undefi
 
 async function emitTemplateMutationResult(options: {
   response: TemplateInfo;
-  workspaceId: string;
+  endpoint: string;
   client: Client;
   settings: Settings;
   async: boolean;
@@ -333,10 +333,13 @@ async function emitTemplateMutationResult(options: {
     }
     return;
   }
-  const buildEndpoint = sandboxEndpoint(
-    options.workspaceId,
-    sandboxTemplateBuildStatusPath(options.response.templateID, options.response.buildID),
-  );
+  // Poll the same origin that accepted the build, including custom gateways.
+  const buildEndpoint = new URL(
+    sandboxApiPath(
+      sandboxTemplateBuildStatusPath(options.response.templateID, options.response.buildID),
+    ),
+    options.endpoint,
+  ).toString();
   const build = await waitForTemplateBuild(
     options.client,
     options.settings,
@@ -372,8 +375,7 @@ export const sandboxTemplateCreate = defineCommand({
   validate: validatePollInterval,
   async run(ctx) {
     const format = detectOutputFormat(ctx.settings.output);
-    const workspaceId = resolveWorkspaceId(ctx);
-    const endpoint = sandboxEndpoint(workspaceId, SANDBOX_PATHS.templateCreate);
+    const endpoint = resolveSandboxEndpoint(ctx, SANDBOX_PATHS.templateCreate);
     const body = await buildTemplateCreateBody(ctx.flags);
     if (ctx.settings.dryRun) {
       emitResult({ method: "POST", endpoint, request: redactRequestSecrets(body) }, format);
@@ -386,7 +388,7 @@ export const sandboxTemplateCreate = defineCommand({
     });
     await emitTemplateMutationResult({
       response,
-      workspaceId,
+      endpoint,
       client: ctx.client,
       settings: ctx.settings,
       async: ctx.flags.async,
@@ -419,8 +421,7 @@ export const sandboxTemplateList = defineCommand({
     return undefined;
   },
   async run(ctx) {
-    const workspaceId = resolveWorkspaceId(ctx);
-    const url = new URL(sandboxEndpoint(workspaceId, SANDBOX_PATHS.templateList));
+    const url = new URL(resolveSandboxEndpoint(ctx, SANDBOX_PATHS.templateList));
     if (ctx.flags.limit !== undefined) url.searchParams.set("limit", String(ctx.flags.limit));
     if (ctx.flags.cursor) url.searchParams.set("cursor", ctx.flags.cursor);
     const response = await ctx.client.requestJson<TemplateInfo[]>({
@@ -466,8 +467,7 @@ export const sandboxTemplateGet = defineCommand({
   exampleArgs: ["--template-id tpl-xxx", "--template-id tpl-xxx --output json"],
   notes: SANDBOX_NOTES,
   async run(ctx) {
-    const workspaceId = resolveWorkspaceId(ctx);
-    const endpoint = sandboxEndpoint(workspaceId, sandboxTemplatePath(ctx.flags.templateId));
+    const endpoint = resolveSandboxEndpoint(ctx, sandboxTemplatePath(ctx.flags.templateId));
     const response = await ctx.client.requestJson<TemplateInfo>({ path: endpoint, method: "GET" });
     if (ctx.settings.quiet) emitBare(displayValue(response.templateID));
     else emitResult(response, detectOutputFormat(ctx.settings.output));
@@ -499,8 +499,7 @@ export const sandboxTemplateUpdate = defineCommand({
   validate: validatePollInterval,
   async run(ctx) {
     const format = detectOutputFormat(ctx.settings.output);
-    const workspaceId = resolveWorkspaceId(ctx);
-    const endpoint = sandboxEndpoint(workspaceId, sandboxTemplatePath(ctx.flags.templateId));
+    const endpoint = resolveSandboxEndpoint(ctx, sandboxTemplatePath(ctx.flags.templateId));
     const body = await buildTemplateUpdateBody(ctx.flags);
     if (ctx.settings.dryRun) {
       emitResult({ method: "PUT", endpoint, request: redactRequestSecrets(body) }, format);
@@ -513,7 +512,7 @@ export const sandboxTemplateUpdate = defineCommand({
     });
     await emitTemplateMutationResult({
       response,
-      workspaceId,
+      endpoint,
       client: ctx.client,
       settings: ctx.settings,
       async: ctx.flags.async,
@@ -536,9 +535,8 @@ export const sandboxTemplateBuildStatus = defineCommand({
   ],
   notes: SANDBOX_NOTES,
   async run(ctx) {
-    const workspaceId = resolveWorkspaceId(ctx);
-    const endpoint = sandboxEndpoint(
-      workspaceId,
+    const endpoint = resolveSandboxEndpoint(
+      ctx,
       sandboxTemplateBuildStatusPath(ctx.flags.templateId, ctx.flags.buildId),
     );
     const response = await ctx.client.requestJson<TemplateBuildStatus>({
@@ -573,8 +571,7 @@ export const sandboxTemplateDelete = defineCommand({
   ],
   async run(ctx) {
     const format = detectOutputFormat(ctx.settings.output);
-    const workspaceId = resolveWorkspaceId(ctx);
-    const endpoint = sandboxEndpoint(workspaceId, sandboxTemplatePath(ctx.flags.templateId));
+    const endpoint = resolveSandboxEndpoint(ctx, sandboxTemplatePath(ctx.flags.templateId));
     if (ctx.settings.dryRun) {
       emitResult({ method: "DELETE", endpoint, request: null }, format);
       return;