dsh-switchman 1.3.1 → 1.6.0

package/skills/db-query/scripts/redis-query.js

@@ -2,22 +2,22 @@
 'use strict';
 
 /**
- * Redis 只读查询入口
- * 编排流程：CLI 解析 → 命令白名单校验 → 建连 → sendCommand → 输出 → 关闭
- * 安全要点：db 只通过连接配置选择（不开放 SELECT 命令）；
- *          客户端 timer 超时 destroy socket；
- *          Redis ACL 只读用户是服务端最终边界
+ * Redis read-only query entry point
+ * Pipeline: CLI parsing → command allowlist validation → connect → sendCommand → output → close
+ * Security: the db is selected only via connection config (the SELECT command is not exposed);
+ *           a client-side timer destroys the socket on timeout;
+ *           a Redis ACL read-only user is the final server-side boundary
  */
 
 const { createClient } = require('redis');
 
-// ── 内部模块 ──
+// ── Internal modules ──
 const { parseCli, CliError } = require('./lib/cli');
 const { loadEnvFile, resolveEnv, resolveEnvNumber, ConfigError, sanitizeTarget, safeMessage, buildTlsOptions } = require('./lib/config');
 const { validateRedisCommand, RedisReadonlyError } = require('./lib/redis-readonly');
 const { formatRedisTable, formatJson } = require('./lib/output');
 
-// ── CLI 参数规格 ──
+// ── CLI option spec ──
 const REDIS_SPEC = {
   host:              { type: 'string', default: '127.0.0.1' },
   port:              { type: 'integer', default: 6379, min: 1, max: 65535 },
@@ -38,32 +38,33 @@ const REDIS_SPEC = {
 
 const ENV_PREFIX = 'DB_QUERY_REDIS_';
 
-// ── 主函数 ──
+// ── Main ──
 async function main() {
   const { options, rest } = parseCli(process.argv.slice(2), REDIS_SPEC);
 
-  // -- 后面必须是 Redis 命令
+  // A Redis command must follow --
   if (rest.length === 0) {
-    throw new CliError('必须在 -- 之后指定 Redis 命令（如 -- GET key）');
+    throw new CliError('A Redis command must follow -- (e.g. -- GET key)');
   }
 
-  // 命令白名单校验（在任何连接操作之前）
+  // Command allowlist validation (before any connection setup)
   const validated = validateRedisCommand(rest, {
     maxItems: options.maxItems,
     allowUnbounded: options['allow-unbounded'],
   });
 
-  // --validate-only：纯离线校验，不建连
+  // --validate-only: pure offline validation, no connection
   if (options['validate-only']) {
-    process.stderr.write(`✓ 命令校验通过: ${validated.command} ${validated.args.join(' ')}\n`);
-    process.stderr.write(`输出形状: ${validated.shape}${validated.unbounded ? ' (无界)' : ''}\n`);
+    process.stderr.write(`✓ Command validation passed: ${validated.command} ${validated.args.join(' ')}\n`);
+    process.stderr.write(`Output shape: ${validated.shape}${validated.unbounded ? ' (unbounded)' : ''}\n`);
     return;
   }
 
-  // env 文件加载
+  // Load env file
   const envPairs = loadEnvFile(options['env-file']);
 
-  // 合并环境变量覆盖（统一用 resolveEnvNumber 做边界校验，防 env 文件绕过硬上限）
+  // Merge environment overrides (resolveEnvNumber uniformly enforces bounds,
+  // so env files cannot bypass hard limits)
   const host = resolveEnv(envPairs, ENV_PREFIX + 'HOST', options.host);
   const port = resolveEnvNumber(envPairs, ENV_PREFIX + 'PORT', options.port, { min: 1, max: 65535 });
   const user = resolveEnv(envPairs, ENV_PREFIX + 'USER', options.user);
@@ -78,11 +79,11 @@ async function main() {
   const connectTimeoutMs = resolveEnvNumber(envPairs, ENV_PREFIX + 'CONNECT_TIMEOUT_MS', options['connect-timeout-ms'], { min: 1000, max: 30000 });
   const connectTimeoutMsResolved = connectTimeoutMs;
 
-  // 打印脱敏目标
+  // Print sanitized target
   const target = sanitizeTarget({ host, port, user, database: db });
   process.stderr.write(`→ Redis ${target}\n`);
 
-  // 构建 node-redis v4 客户端
+  // Build the node-redis v4 client
   const clientConfig = {
     socket: {
       host,
@@ -96,22 +97,23 @@ async function main() {
     database: db,
     password: password || undefined,
     username: user,
-    // 保留 Buffer 返回，避免自动字符串化丢二进制
+    // Keep Buffer results to avoid losing binary data via auto stringification
     returnBuffers: true,
   };
 
   const client = createClient(clientConfig);
 
-  // 超时定时器（connect + sendCommand 总超时）
+  // Timeout timer (covers connect + sendCommand)
   const timer = setTimeout(() => {
     client.destroy();
-    // 不直接 reject（Promise 可能已 settle），通过 error 事件处理
+    // Do not reject directly (the promise may already be settled); handled via the error event
   }, timeoutMsResolved);
 
   try {
     await client.connect();
 
-    // sendCommand 以数组形式传参，绝不拼接后 split（防止参数含空格被截断）
+    // sendCommand takes args as an array; never join-then-split
+    // (prevents truncation of arguments containing spaces)
     const cmdArgs = [validated.command, ...validated.args.map(String)];
     const startMs = Date.now();
     const result = await client.sendCommand(cmdArgs);
@@ -119,7 +121,7 @@ async function main() {
 
     clearTimeout(timer);
 
-    // 判断截断
+    // Detect truncation
     let count = 0;
     let truncated = false;
     if (Array.isArray(result)) {
@@ -130,14 +132,14 @@ async function main() {
     }
 
     if (options.format === 'json') {
-      // JSON envelope 写 stdout
+      // JSON envelope to stdout
       process.stdout.write(JSON.stringify({
         source: 'redis',
         target,
         elapsedMs,
         count: truncated ? maxItemsResolved : count,
         truncated,
-        // Buffer → base64 以确保 JSON 安全
+        // Buffer → base64 to keep the JSON safe
         result: sanitizeForJson(result),
       }, null, 2) + '\n');
     } else {
@@ -149,16 +151,16 @@ async function main() {
       }) + '\n');
     }
 
-    process.stderr.write(`✓ ${count} 条${truncated ? '（已截断）' : ''}，${elapsedMs}ms\n`);
+    process.stderr.write(`✓ ${count} item(s)${truncated ? ' (truncated)' : ''} in ${elapsedMs}ms\n`);
   } catch (e) {
     clearTimeout(timer);
     throw e;
   } finally {
-    try { await client.quit(); } catch (_) { /* 忽略关闭错误 */ }
+    try { await client.quit(); } catch (_) { /* ignore close errors */ }
   }
 }
 
-/** 递归将 Buffer 转为 base64，确保 JSON 安全 */
+/** Recursively convert Buffers to base64 to keep the JSON safe */
 function sanitizeForJson(val) {
   if (Buffer.isBuffer(val)) return val.toString('base64');
   if (Array.isArray(val)) return val.map(sanitizeForJson);
@@ -171,7 +173,8 @@ function sanitizeForJson(val) {
 }
 
 main().catch(e => {
-  // 校验类/配置类错误直接显示消息（不是连接错误，不需要脱敏）
+  // Validation/config errors show their message directly (not connection
+  // errors, no sanitizing needed)
   if (e instanceof CliError || e instanceof RedisReadonlyError || e instanceof ConfigError) {
     process.stderr.write('✗ ' + e.message + '\n');
   } else {

package/skills/db-query/scripts/setup.sh

@@ -1,51 +1,51 @@
 #!/usr/bin/env bash
-# db-query 技能一键环境检查 + 安装 + 测试
-# 幂等：依赖已装则跳过 npm ci
+# db-query skill: one-shot environment check + install + test
+# Idempotent: skip npm ci when dependencies are already installed
 
 set -euo pipefail
 
 SCRIPT_DIR="$(cd "$(dirname "$0")/.." && pwd)"
 cd "$SCRIPT_DIR"
 
-# ── Node / npm 版本检查 ──
+# ── Node / npm version check ──
 if ! command -v node &>/dev/null; then
-  echo "✗ 未找到 node，需要 Node.js >= 18"
+  echo "✗ node not found; Node.js >= 18 is required"
   exit 1
 fi
 
 NODE_MAJOR=$(node -e "process.stdout.write(String(process.versions.node.split('.')[0]))")
 if [ "$NODE_MAJOR" -lt 18 ]; then
-  echo "✗ Node.js 版本 $(node -v) 低于最低要求 18"
+  echo "✗ Node.js version $(node -v) is below the minimum required 18"
   exit 1
 fi
 
 if ! command -v npm &>/dev/null; then
-  echo "✗ 未找到 npm"
+  echo "✗ npm not found"
   exit 1
 fi
 
 echo "Node $(node -v) ✓  npm $(npm -v) ✓"
 
-# ── 幂等安装运行时依赖 ──
-# 已有 node_modules 时 npm ci 仍会检查一致性，幂等安全
+# ── Idempotent install of runtime dependencies ──
+# When node_modules already exists, npm ci would still verify consistency, so skipping is idempotent-safe
 if [ -d node_modules ]; then
-  echo "依赖已存在，跳过安装（删除 node_modules 可强制重装）"
+  echo "Dependencies already present, skipping install (delete node_modules to force a reinstall)"
 else
-  echo "安装运行时依赖（mysql2 redis dotenv）..."
+  echo "Installing runtime dependencies (mysql2 redis dotenv)..."
   if [ -f package-lock.json ]; then
     npm ci --omit=dev --no-audit --no-fund
   else
     npm install --omit=dev --no-audit --no-fund
   fi
-  echo "依赖安装 ✓"
+  echo "Dependencies installed ✓"
 fi
 
-# ── 运行测试 ──
-echo "运行测试..."
+# ── Run tests ──
+echo "Running tests..."
 if node --test tests/*.test.js 2>/dev/null; then
-  echo "全部测试通过 ✓"
+  echo "All tests passed ✓"
 else
-  echo "⚠ 未找到测试文件或测试未通过（首次部署无测试属正常）"
+  echo "⚠ No test files found or tests did not pass (no tests on first deployment is normal)"
 fi
 
-echo "db-query 环境就绪 ✓"
+echo "db-query environment ready ✓"