rl-rockcli 0.0.7 → 0.0.8

package/utils/ray_cli_wrapper.js

@@ -1,746 +0,0 @@
-const { spawn } = require('child_process');
-const fs = require('fs-extra');
-const path = require('path');
-const https = require('https');
-const http = require('http');
-const logger = require('./logger');
-
-/**
- * Ray CLI 封装类
- * 负责调用系统中的 ray-cli 并进行参数转换
- */
-class RayCliWrapper {
-  constructor(options = {}) {
-    this.verbose = options.verbose || 0;
-    this.configPath = path.join(__dirname, '../config/ray_cluster_mapping.json');
-    this.clusterConfig = null;
-  }
-
-  /**
-   * 检查 ray-cli 是否已安装
-   * @returns {Promise<boolean>}
-   */
-  async checkRayCliInstalled() {
-    // 如果设置了 ROCK_CLI_MOCK_RAY 环境变量，跳过检查（用于测试）
-    if (process.env.ROCK_CLI_MOCK_RAY === '1') {
-      return Promise.resolve(true);
-    }
-
-    return new Promise((resolve, reject) => {
-      const checkProcess = spawn('which', ['ray'], {
-        shell: true
-      });
-
-      checkProcess.on('close', (code) => {
-        if (code === 0) {
-          resolve(true);
-        } else {
-          reject(new Error(
-            'ray-cli not found. Please install it: pip install -U "ray[default]"'
-          ));
-        }
-      });
-
-      checkProcess.on('error', () => {
-        reject(new Error(
-          'ray-cli not found. Please install it: pip install -U "ray[default]"'
-        ));
-      });
-    });
-  }
-
-  /**
-   * 加载集群配置
-   * @returns {Object} 集群配置对象
-   */
-  loadClusterConfig() {
-    try {
-      if (!fs.existsSync(this.configPath)) {
-        throw new Error(
-          `Config file not found: ${this.configPath}`
-        );
-      }
-
-      const content = fs.readFileSync(this.configPath, 'utf8');
-      this.clusterConfig = JSON.parse(content);
-
-      if (!this.clusterConfig.clusters) {
-        throw new Error('Invalid config: missing "clusters" field');
-      }
-
-      return this.clusterConfig;
-
-    } catch (error) {
-      throw new Error(`Failed to load cluster config: ${error.message}`);
-    }
-  }
-
-  /**
-   * 获取集群地址
-   * @param {string} clusterName - 集群名称
-   * @returns {string} Ray Dashboard 地址
-   */
-  getClusterAddress(clusterName) {
-    if (!this.clusterConfig) {
-      this.loadClusterConfig();
-    }
-
-    const cluster = this.clusterConfig.clusters[clusterName];
-    if (!cluster) {
-      const available = Object.keys(this.clusterConfig.clusters).join(', ');
-      throw new Error(
-        `Cluster '${clusterName}' not found in config. Available: ${available}`
-      );
-    }
-
-    return cluster.address;
-  }
-
-  /**
-   * 处理自定义参数并构建 ray-cli 参数
-   * @param {Object} argv - yargs 参数对象
-   * @returns {Array<string>} 命令参数数组
-   */
-  buildRayArgs(argv) {
-    const args = [];
-
-    // 1. 收集位置参数（action...）
-    if (argv.action && Array.isArray(argv.action)) {
-      // yargs 收集的多个位置参数
-      args.push(...argv.action);
-    } else if (argv._ && argv._.length > 1) {
-      // 从 argv._ 中提取（兼容）
-      args.push(...argv._.slice(1));
-    }
-
-    // 2. 处理 --cluster （优先级高）
-    if (argv.cluster) {
-      const address = this.getClusterAddress(argv.cluster);
-      args.push('--address', address);
-    } else if (argv.address) {
-      args.push('--address', argv.address);
-    }
-
-    // 3. 处理 --sandbox-id （优先级高）
-    if (argv.sandboxId) {
-      args.push('--filter', `name=sandbox-${argv.sandboxId}`);
-    } else if (argv.filter) {
-      args.push('--filter', argv.filter);
-    }
-
-    // 4. 透传其他参数（仅透传 ray-cli 支持的参数）
-    // 不透传 rock-cli 全局参数
-    const skipParams = [
-      'cluster', 'sandbox-id', 'sandboxId', 'address', 'filter',
-      'verbose', 'v', '_', '$0',
-      'base-url', 'baseUrl', 'api-key', 'apiKey',
-      'help', 'h', 'version', 'action'
-    ];
-
-    for (const [key, value] of Object.entries(argv)) {
-      if (skipParams.includes(key)) continue;
-      if (value === undefined || value === null) continue;
-
-      const argName = key.length === 1 ? `-${key}` : `--${key}`;
-
-      if (typeof value === 'boolean') {
-        if (value) args.push(argName);
-      } else if (Array.isArray(value)) {
-        value.forEach(v => args.push(argName, String(v)));
-      } else {
-        args.push(argName, String(value));
-      }
-    }
-
-    return args;
-  }
-
-  /**
-   * 执行自定义命令（通过 HTTP API）
-   * @param {string} command - 命令名称
-   * @param {Object} argv - yargs 参数对象
-   * @returns {Promise<Object>} 执行结果
-   */
-  async executeCustomCommand(command, argv) {
-    // get 命令有自己的参数验证逻辑
-    if (command === 'get') {
-      return this.executeGetCommand(argv);
-    }
-
-    // 其他命令需要验证必需参数
-    if (!argv.cluster && !argv.address) {
-      throw new Error('Either --cluster or --address is required');
-    }
-
-    // 获取集群地址
-    let baseUrl;
-    if (argv.cluster) {
-      baseUrl = this.getClusterAddress(argv.cluster);
-    } else {
-      baseUrl = argv.address;
-    }
-
-    if (command === 'status') {
-      return this.fetchClusterStatus(baseUrl, argv.format);
-    }
-
-    throw new Error(`Unknown custom command: ${command}`);
-  }
-
-  /**
-   * 处理 get 命令
-   * @param {Object} argv - 包含 action: ['get', 'sandbox', '<id>']
-   * @returns {Promise<Object>} 执行结果
-   */
-  async executeGetCommand(argv) {
-    const resource = argv.action && argv.action[1];
-    const id = argv.action && argv.action[2];
-
-    if (resource === 'sandbox') {
-      return this.executeGetSandbox(id, argv);
-    }
-
-    return {
-      success: false,
-      exitCode: 1,
-      stdout: '',
-      stderr: `Error: Unknown resource type: ${resource || '(none)'}\nSupported: sandbox\nUsage: rock-cli ray get sandbox <sandbox-id> --cluster=<cluster>`
-    };
-  }
-
-  /**
-   * 获取 sandbox 信息
-   * @param {string} sandboxId - Sandbox ID
-   * @param {Object} argv - yargs 参数对象
-   * @returns {Promise<Object>} 执行结果
-   */
-  async executeGetSandbox(sandboxId, argv) {
-    // 1. 验证必需参数
-    if (!sandboxId) {
-      return {
-        success: false,
-        exitCode: 1,
-        stdout: '',
-        stderr: 'Error: Missing required argument: sandbox-id\nUsage: rock-cli ray get sandbox <sandbox-id> --cluster=<cluster>'
-      };
-    }
-
-    if (!argv.cluster && !argv.address) {
-      return {
-        success: false,
-        exitCode: 1,
-        stdout: '',
-        stderr: 'Error: Missing required option: --cluster\nUsage: rock-cli ray get sandbox <sandbox-id> --cluster=<cluster>'
-      };
-    }
-
-    const clusterName = argv.cluster || argv.address;
-
-    // 2. 查询 actor 信息
-    if (this.verbose >= 2) {
-      logger.debug(`Querying actor for sandbox: ${sandboxId}`);
-    }
-
-    const actorResult = await this.execute({
-      action: ['list', 'actors'],
-      cluster: argv.cluster,
-      address: argv.address,
-      format: 'json',
-      sandboxId: sandboxId
-    });
-
-    if (!actorResult.success) {
-      return {
-        success: false,
-        exitCode: 1,
-        stdout: '',
-        stderr: `Error: Failed to query actor: ${actorResult.stderr}`
-      };
-    }
-
-    // 3. 解析 actor 响应
-    let actors;
-    try {
-      actors = JSON.parse(actorResult.stdout);
-    } catch (e) {
-      // ray-cli 返回 "No resource in the cluster" 等非 JSON 格式表示资源不存在
-      if (actorResult.stdout.includes('No resource')) {
-        return {
-          success: false,
-          exitCode: 1,
-          stdout: '',
-          stderr: `Error: Sandbox '${sandboxId}' not found in cluster '${clusterName}'`
-        };
-      }
-      return {
-        success: false,
-        exitCode: 1,
-        stdout: '',
-        stderr: `Error: Failed to parse actor response: ${e.message}`
-      };
-    }
-
-    if (!actors || actors.length === 0) {
-      return {
-        success: false,
-        exitCode: 1,
-        stdout: '',
-        stderr: `Error: Sandbox '${sandboxId}' not found in cluster '${clusterName}'`
-      };
-    }
-
-    const actor = actors[0];
-    const nodeId = actor.node_id;
-
-    if (!nodeId) {
-      return {
-        success: false,
-        exitCode: 1,
-        stdout: '',
-        stderr: `Error: Actor found but node_id is missing for sandbox '${sandboxId}'`
-      };
-    }
-
-    // 4. 查询 node 信息（使用 filter 精确查询）
-    if (this.verbose >= 2) {
-      logger.debug(`Querying node: ${nodeId}`);
-    }
-
-    const nodeResult = await this.executeWithFilter({
-      action: ['list', 'nodes'],
-      cluster: argv.cluster,
-      address: argv.address,
-      format: 'json',
-      filter: `node_id=${nodeId}`
-    });
-
-    if (!nodeResult.success) {
-      return {
-        success: false,
-        exitCode: 1,
-        stdout: '',
-        stderr: `Error: Failed to query node: ${nodeResult.stderr}`
-      };
-    }
-
-    // 5. 解析 node 响应
-    let nodes;
-    try {
-      nodes = JSON.parse(nodeResult.stdout);
-    } catch (e) {
-      return {
-        success: false,
-        exitCode: 1,
-        stdout: '',
-        stderr: `Error: Failed to parse node response: ${e.message}`
-      };
-    }
-
-    if (!nodes || nodes.length === 0) {
-      return {
-        success: false,
-        exitCode: 1,
-        stdout: '',
-        stderr: `Error: Node '${nodeId}' not found for sandbox '${sandboxId}'`
-      };
-    }
-
-    const node = nodes[0];
-
-    // 6. 格式化输出
-    const outputFormat = argv.format || 'table';
-    if (outputFormat === 'json') {
-      return this.formatSandboxJsonOutput(sandboxId, clusterName, actor, node);
-    } else if (argv.detail) {
-      return this.formatSandboxDetailOutput(sandboxId, clusterName, actor, node);
-    } else {
-      return this.formatSandboxTableOutput(sandboxId, clusterName, actor, node);
-    }
-  }
-
-  /**
-   * 执行带有自定义 filter 的 ray-cli 命令
-   * 与 execute() 不同，此方法直接使用传入的 filter，不做 sandboxId 转换
-   * @param {Object} argv - 参数对象
-   * @returns {Promise<Object>} 执行结果
-   */
-  async executeWithFilter(argv) {
-    // 验证必需参数
-    if (!argv.cluster && !argv.address) {
-      throw new Error('Either --cluster or --address is required');
-    }
-
-    // 1. 检查 ray-cli
-    await this.checkRayCliInstalled();
-
-    // 2. 构建命令参数
-    const args = [];
-
-    // 添加 action
-    if (argv.action && Array.isArray(argv.action)) {
-      args.push(...argv.action);
-    }
-
-    // 添加 address
-    if (argv.cluster) {
-      const address = this.getClusterAddress(argv.cluster);
-      args.push('--address', address);
-    } else if (argv.address) {
-      args.push('--address', argv.address);
-    }
-
-    // 添加 filter（直接使用）
-    if (argv.filter) {
-      args.push('--filter', argv.filter);
-    }
-
-    // 添加 format
-    if (argv.format) {
-      args.push('--format', argv.format);
-    }
-
-    // 3. 输出调试信息
-    if (this.verbose >= 3) {
-      logger.debug(`Executing: ray ${args.join(' ')}`);
-    }
-
-    // 4. 执行命令
-    return new Promise((resolve, reject) => {
-      let stdout = '';
-      let stderr = '';
-
-      const rayProcess = spawn('ray', args, {
-        shell: false,
-        env: process.env
-      });
-
-      rayProcess.stdout.on('data', (data) => {
-        stdout += data.toString();
-      });
-
-      rayProcess.stderr.on('data', (data) => {
-        stderr += data.toString();
-      });
-
-      rayProcess.on('close', (code) => {
-        resolve({
-          success: code === 0,
-          exitCode: code,
-          stdout: stdout.trim(),
-          stderr: stderr.trim()
-        });
-      });
-
-      rayProcess.on('error', (error) => {
-        reject(new Error(`Failed to execute ray-cli: ${error.message}`));
-      });
-    });
-  }
-
-  /**
-   * 格式化 JSON 输出（完整信息）
-   */
-  formatSandboxJsonOutput(sandboxId, cluster, actor, node) {
-    // 过滤掉 null 值
-    const filterNull = (obj) => {
-      return Object.fromEntries(
-        Object.entries(obj).filter(([_, v]) => v !== null)
-      );
-    };
-
-    const output = {
-      sandbox_id: sandboxId,
-      cluster: cluster,
-      actor: filterNull(actor),
-      node: filterNull(node)
-    };
-
-    return {
-      success: true,
-      exitCode: 0,
-      stdout: JSON.stringify(output, null, 2),
-      stderr: ''
-    };
-  }
-
-  /**
-   * 格式化精简表格输出
-   */
-  formatSandboxTableOutput(sandboxId, cluster, actor, node) {
-    const lines = [
-      `Sandbox: ${sandboxId}`,
-      `Cluster: ${cluster}`,
-      '',
-      'sandbox_id                        actor_state  node_ip       node_state',
-      '--------------------------------  -----------  ------------  ----------',
-      `${sandboxId.substring(0, 32).padEnd(32)}  ${(actor.state || 'N/A').padEnd(11)}  ${(node.node_ip || 'N/A').padEnd(12)}  ${node.state || 'N/A'}`
-    ];
-
-    return {
-      success: true,
-      exitCode: 0,
-      stdout: lines.join('\n'),
-      stderr: ''
-    };
-  }
-
-  /**
-   * 格式化详细输出（--detail）
-   */
-  formatSandboxDetailOutput(sandboxId, cluster, actor, node) {
-    // 格式化资源信息
-    const formatResources = (resources) => {
-      if (!resources) return 'N/A';
-      const parts = [];
-      if (resources.CPU) parts.push(`CPU: ${resources.CPU}`);
-      if (resources.memory) parts.push(`memory: ${resources.memory}`);
-      if (resources.object_store_memory) parts.push(`object_store: ${resources.object_store_memory}`);
-      if (resources['xrl-sandbox']) parts.push(`xrl-sandbox: ${resources['xrl-sandbox']}`);
-      return parts.join(', ') || 'N/A';
-    };
-
-    // 格式化标签信息
-    const formatLabels = (labels) => {
-      if (!labels) return 'N/A';
-      const entries = Object.entries(labels);
-      if (entries.length === 0) return 'N/A';
-      return entries.map(([k, v]) => `${k}=${v}`).join(', ');
-    };
-
-    // 格式化资源请求
-    const formatRequiredResources = (resources) => {
-      if (!resources) return null;
-      const parts = [];
-      for (const [k, v] of Object.entries(resources)) {
-        parts.push(`${k}: ${v}`);
-      }
-      return parts.join(', ') || null;
-    };
-
-    // 构建 Actor 信息行
-    const actorLines = [
-      `actor_id:       ${actor.actor_id || 'N/A'}`,
-      `name:           ${actor.name || 'N/A'}`,
-      `class_name:     ${actor.class_name || 'N/A'}`,
-      `state:          ${actor.state || 'N/A'}`,
-      `pid:            ${actor.pid || 'N/A'}`,
-      `ray_namespace:  ${actor.ray_namespace || 'N/A'}`,
-      `job_id:         ${actor.job_id || 'N/A'}`,
-      `node_id:        ${actor.node_id || 'N/A'}`
-    ];
-
-    // 添加可选字段（仅非 null 时显示）
-    if (actor.is_detached !== null && actor.is_detached !== undefined) {
-      actorLines.push(`is_detached:    ${actor.is_detached}`);
-    }
-    if (actor.repr_name) {
-      actorLines.push(`repr_name:      ${actor.repr_name}`);
-    }
-    if (actor.placement_group_id) {
-      actorLines.push(`placement_group_id: ${actor.placement_group_id}`);
-    }
-    const requiredRes = formatRequiredResources(actor.required_resources);
-    if (requiredRes) {
-      actorLines.push(`resources:      ${requiredRes}`);
-    }
-    if (actor.num_restarts !== null && actor.num_restarts !== undefined) {
-      actorLines.push(`num_restarts:   ${actor.num_restarts}`);
-    }
-    if (actor.death_cause) {
-      actorLines.push(`death_cause:    ${actor.death_cause}`);
-    }
-
-    const lines = [
-      `Sandbox: ${sandboxId}`,
-      `Cluster: ${cluster}`,
-      '',
-      '=== Actor Information ===',
-      ...actorLines,
-      '',
-      '=== Node Information ===',
-      `node_id:        ${node.node_id || 'N/A'}`,
-      `node_ip:        ${node.node_ip || 'N/A'}`,
-      `node_name:      ${node.node_name || 'N/A'}`,
-      `state:          ${node.state || 'N/A'}`,
-      `is_head_node:   ${node.is_head_node !== undefined ? node.is_head_node : 'N/A'}`,
-      `resources:      ${formatResources(node.resources_total)}`,
-      `labels:         ${formatLabels(node.labels)}`
-    ];
-
-    return {
-      success: true,
-      exitCode: 0,
-      stdout: lines.join('\n'),
-      stderr: ''
-    };
-  }
-
-  /**
-   * 获取集群状态（通过 HTTP API）
-   * @param {string} baseUrl - Ray Dashboard 地址
-   * @param {string} format - 输出格式（默认为文本格式）
-   * @returns {Promise<Object>} 执行结果
-   */
-  async fetchClusterStatus(baseUrl, format) {
-    // format: 默认或任何非json值 -> format=1（文本格式）
-    // format: json -> format=0（JSON格式）
-    const formatParam = format === 'json' ? '0' : '1';
-
-    // 处理 baseUrl ，移除尾部斜杠
-    const cleanBaseUrl = baseUrl.replace(/\/$/, '');
-    const url = `${cleanBaseUrl}/api/cluster_status?format=${formatParam}`;
-
-    if (this.verbose >= 3) {
-      logger.debug(`Fetching cluster status from: ${url}`);
-    }
-
-    return new Promise((resolve, reject) => {
-      const urlObj = new URL(url);
-      const protocol = urlObj.protocol === 'https:' ? https : http;
-
-      const options = {
-        hostname: urlObj.hostname,
-        port: urlObj.port || (urlObj.protocol === 'https:' ? 443 : 80),
-        path: urlObj.pathname + urlObj.search,
-        method: 'GET',
-        headers: {
-          'User-Agent': 'rock-cli'
-        },
-        rejectUnauthorized: false  // 忽略 SSL 证书验证
-      };
-
-      protocol.get(options, (res) => {
-        // 检查 HTTP 状态码
-        if (res.statusCode !== 200) {
-          let errorData = '';
-          res.on('data', (chunk) => {
-            errorData += chunk;
-          });
-          res.on('end', () => {
-            reject(new Error(`HTTP ${res.statusCode}: ${errorData || res.statusMessage}`));
-          });
-          return;
-        }
-
-        let data = '';
-
-        // 设置编码
-        res.setEncoding('utf8');
-
-        res.on('data', (chunk) => {
-          data += chunk;
-        });
-
-        res.on('end', () => {
-          try {
-            if (this.verbose >= 3) {
-              logger.debug(`Raw response: ${data.substring(0, 200)}...`);
-            }
-
-            const response = JSON.parse(data);
-
-            if (!response.result) {
-              return resolve({
-                success: false,
-                exitCode: 1,
-                stdout: '',
-                stderr: response.msg || 'Failed to fetch cluster status'
-              });
-            }
-
-            // format=1: 返回格式化的文本
-            if (formatParam === '1') {
-              resolve({
-                success: true,
-                exitCode: 0,
-                stdout: response.data.clusterStatus || '',
-                stderr: ''
-              });
-            } else {
-              // format=0: 返回 JSON
-              resolve({
-                success: true,
-                exitCode: 0,
-                stdout: JSON.stringify(response.data, null, 2),
-                stderr: ''
-              });
-            }
-          } catch (error) {
-            reject(new Error(`Failed to parse cluster status response: ${error.message}`));
-          }
-        });
-      }).on('error', (error) => {
-        reject(new Error(`Failed to fetch cluster status: ${error.message}`));
-      });
-    });
-  }
-
-  /**
-   * 执行 ray-cli 命令
-   * @param {Object} argv - yargs 参数对象
-   * @returns {Promise<Object>} 执行结果
-   */
-  async execute(argv) {
-    // 验证必需参数
-    if (!argv.cluster && !argv.address) {
-      throw new Error('Either --cluster or --address is required');
-    }
-
-    // 1. 检查 ray-cli
-    await this.checkRayCliInstalled();
-
-    // 2. 构建命令参数
-    const args = this.buildRayArgs(argv);
-
-    // 3. 输出调试信息
-    if (this.verbose >= 3) {
-      logger.debug(`Executing: ray ${args.join(' ')}`);
-    }
-
-    // 4. 如果是 mock 模式，直接返回成功（用于测试）
-    if (process.env.ROCK_CLI_MOCK_RAY === '1') {
-      return Promise.resolve({
-        success: true,
-        exitCode: 0,
-        stdout: 'Mock ray output',
-        stderr: ''
-      });
-    }
-
-    // 5. 执行命令
-    return new Promise((resolve, reject) => {
-      let stdout = '';
-      let stderr = '';
-
-      const rayProcess = spawn('ray', args, {
-        shell: false,
-        env: process.env
-      });
-
-      // 捕获输出
-      rayProcess.stdout.on('data', (data) => {
-        stdout += data.toString();
-      });
-
-      rayProcess.stderr.on('data', (data) => {
-        stderr += data.toString();
-      });
-
-      // 处理退出
-      rayProcess.on('close', (code) => {
-        resolve({
-          success: code === 0,
-          exitCode: code,
-          stdout: stdout.trim(),
-          stderr: stderr.trim()
-        });
-      });
-
-      rayProcess.on('error', (error) => {
-        reject(new Error(`Failed to execute ray-cli: ${error.message}`));
-      });
-    });
-  }
-}
-
-module.exports = { RayCliWrapper };