dsh-api-runner 0.2.1 → 0.3.0

package/src/main.js

@@ -42,7 +42,7 @@ const PARAMETERS = {
     properties: {
         action: {
             type: 'string',
-            enum: ['describe', 'call', 'login', 'service', 'log', 'wait_log', 'reset_log', 'verify', 'java'],
+            enum: ['describe', 'call', 'login', 'service', 'log', 'wait_log', 'reset_log', 'verify', 'java', 'db'],
             description: '要执行的操作',
         },
         api_id: { type: 'string', description: '接口 id 或 name（call、login、verify 用）' },
@@ -69,6 +69,34 @@ const PARAMETERS = {
             items: { type: 'string' },
             description: 'java_action=start_all 时只启动这些服务（省略则启动全部已保存的）',
         },
+        db_action: {
+            type: 'string',
+            enum: ['list_connections', 'test', 'save', 'delete', 'query', 'list_databases', 'list_tables', 'describe_table'],
+            description: '数据库动作（action=db 用）：list_connections 列出连接；test 试连；save 保存连接；delete 删除连接；query 执行 SQL（只读模式默认开）；list_databases/list_tables/describe_table 看元数据',
+        },
+        connection_id: { type: 'string', description: '数据库连接 id（db_action=query/list_tables/describe_table/test/delete 用）' },
+        sql: { type: 'string', description: '要执行的 SQL（db_action=query 用，只允许单条语句）' },
+        params: {
+            type: 'object',
+            additionalProperties: true,
+            description: '接口参数（action=call/login）：键会替换 URL/body 里的 {key} 占位。db_action=query 时请改用 db_params。',
+        },
+        db_params: {
+            type: 'array',
+            items: {},
+            description: 'SQL 参数化占位值（db_action=query 用），按 ?/$1/:1 顺序绑定，不要拼字符串',
+        },
+        db_readonly: {
+            type: 'boolean',
+            description: 'db_action=query 时是否只读（默认 true，拒绝 INSERT/UPDATE/DELETE/DDL）',
+        },
+        connection: {
+            type: 'object',
+            additionalProperties: true,
+            description: '连接配置（db_action=save/test 用）：{ id?, name, type(sqlite|mysql|postgres|oracle), host, port, database, username, password, extra }',
+        },
+        table: { type: 'string', description: '表名（db_action=describe_table 用）' },
+        database: { type: 'string', description: '库名/模式名（db_action=list_tables 用；MySQL 必填）' },
         pid: { type: 'number', description: '要接管的 Java 进程 pid（java_action=start 用）' },
         java_id: { type: 'string', description: '插件托管的服务名或 pid（java_action=stop/restart/log/save/unsave/start_saved 用）' },
         port: { type: 'number', description: '服务端口（java_action=start 用；省略则从进程参数推断）' },
@@ -210,6 +238,64 @@ async function runTool(service, args, projectPath) {
             }
             return { ok: false, code: 'BAD_ACTION', message: `不支持的 java_action: ${javaAction}` };
         }
+        case 'db': {
+            const dbAction = String(args.db_action || 'list_connections');
+            if (dbAction === 'list_connections') return service.dbConnections();
+            if (dbAction === 'list_databases') {
+                if (!args.connection_id) return { ok: false, code: 'MISSING_ARGUMENT', message: 'db_action=list_databases 需要 connection_id' };
+                return service.dbDatabases(String(args.connection_id));
+            }
+            if (dbAction === 'test') {
+                const target = args.connection || args.connection_id;
+                if (!target) return { ok: false, code: 'MISSING_ARGUMENT', message: 'db_action=test 需要 connection_id 或 connection 配置' };
+                return service.dbTest(args.connection ? asObject(args.connection) : String(args.connection_id));
+            }
+            if (dbAction === 'save') {
+                /**
+                 * connection 可能是对象，也可能被上游序列化成 JSON 字符串
+                 * （工具参数走 JSON 时常见）。两种都接住，不要只认对象。
+                 */
+                const raw = args.connection;
+                let config;
+                if (typeof raw === 'string' && raw.trim() !== '') {
+                    try {
+                        config = JSON.parse(raw);
+                    } catch {
+                        return { ok: false, code: 'BAD_ARGUMENT', message: 'connection 不是合法 JSON' };
+                    }
+                } else if (raw && typeof raw === 'object') {
+                    config = raw;
+                }
+                if (!config || typeof config !== 'object') {
+                    return { ok: false, code: 'MISSING_ARGUMENT', message: 'db_action=save 需要 connection 配置（对象或 JSON 字符串）' };
+                }
+                return service.dbSave(asObject(config));
+            }
+            if (dbAction === 'delete') {
+                if (!args.connection_id) return { ok: false, code: 'MISSING_ARGUMENT', message: 'db_action=delete 需要 connection_id' };
+                return service.dbDelete(String(args.connection_id));
+            }
+            if (dbAction === 'query') {
+                if (!args.connection_id) return { ok: false, code: 'MISSING_ARGUMENT', message: 'db_action=query 需要 connection_id' };
+                if (!args.sql) return { ok: false, code: 'MISSING_ARGUMENT', message: 'db_action=query 需要 sql' };
+                return service.dbQuery(String(args.connection_id), String(args.sql), Array.isArray(args.db_params) ? args.db_params : [], {
+                    // 默认只读：模型直接执行写操作是高风险动作，必须显式关闭
+                    readonly: args.db_readonly !== false,
+                    maxRows: args.max_lines ? Number(args.max_lines) : undefined,
+                    timeoutMs,
+                });
+            }
+            if (dbAction === 'list_tables') {
+                if (!args.connection_id) return { ok: false, code: 'MISSING_ARGUMENT', message: 'db_action=list_tables 需要 connection_id' };
+                return service.dbTables(String(args.connection_id), args.database ? String(args.database) : '');
+            }
+            if (dbAction === 'describe_table') {
+                if (!args.connection_id) return { ok: false, code: 'MISSING_ARGUMENT', message: 'db_action=describe_table 需要 connection_id' };
+                if (!args.table) return { ok: false, code: 'MISSING_ARGUMENT', message: 'db_action=describe_table 需要 table' };
+                return service.dbDescribeTable(String(args.connection_id), String(args.table));
+            }
+            return { ok: false, code: 'BAD_ACTION', message: `不支持的 db_action: ${dbAction}` };
+        }
         case 'service': {
             const serviceAction = String(args.service_action || 'status');
             if (!args.service_id && serviceAction !== 'status') {
@@ -576,6 +662,56 @@ async function handleHttp(req, res, service, projectOf) {
     if (route === 'java/start-all/status' && req.method === 'GET') {
         return send(200, service.startBatchStatus(url.searchParams.get('batch') || ''));
     }
+
+    // ---- 数据库：连接管理与 SQL 执行（连接是跨项目的，不按 cwd 归档） ----
+    if (route === 'db' && req.method === 'GET') {
+        return send(200, service.dbConnections());
+    }
+    if (route === 'db/test' && req.method === 'POST') {
+        const body = await readBody();
+        const target = body.connection ? asObject(body.connection) : String(body.connection_id || body.id || '');
+        if (!target || (typeof target === 'string' && target === '')) {
+            return send(400, { ok: false, code: 'MISSING_ARGUMENT', message: '需要 connection_id 或 connection 配置' });
+        }
+        return send(200, await service.dbTest(target));
+    }
+    if (route === 'db/save' && req.method === 'POST') {
+        const body = await readBody();
+        return send(200, service.dbSave(asObject(body.connection || body)));
+    }
+    if (route === 'db/delete' && req.method === 'POST') {
+        const body = await readBody();
+        return send(200, service.dbDelete(String(body.connection_id || body.id || '')));
+    }
+    if (route === 'db/query' && req.method === 'POST') {
+        const body = await readBody();
+        return send(200, await service.dbQuery(
+            String(body.connection_id || ''),
+            String(body.sql || ''),
+            Array.isArray(body.params) ? body.params : [],
+            {
+                readonly: body.readonly !== false,
+                maxRows: body.max_rows ? Number(body.max_rows) : undefined,
+                timeoutMs: body.timeout_ms ? Number(body.timeout_ms) : undefined,
+            },
+        ));
+    }
+    if (route === 'db/databases' && req.method === 'GET') {
+        return send(200, await service.dbDatabases(String(url.searchParams.get('connection_id') || '')));
+    }
+    if (route === 'db/tables' && req.method === 'GET') {
+        return send(200, await service.dbTables(
+            String(url.searchParams.get('connection_id') || ''),
+            String(url.searchParams.get('database') || ''),
+        ));
+    }
+    if (route === 'db/table' && req.method === 'GET') {
+        return send(200, await service.dbDescribeTable(
+            String(url.searchParams.get('connection_id') || ''),
+            String(url.searchParams.get('name') || url.searchParams.get('table') || ''),
+        ));
+    }
+
     if (route === 'settings' && req.method === 'GET') {
         return send(200, service.settings());
     }

package/src/ops.js

@@ -6,6 +6,7 @@ import fs from 'node:fs';
 import path from 'node:path';
 import { ConfigStore } from './config.js';
 import { callApi, pickPath } from './api.js';
+import { DbManager } from './db.js';
 import { JavaRunner } from './java-runner.js';
 import { discoverLogs, listJavaProcesses, readFileChunk, readFileTail } from './java.js';
 import { LogReader } from './log.js';
@@ -39,6 +40,12 @@ export class ApiRunnerService {
          */
         this.startBatches = new Map();
         this._batchSeq = 0;
+        /**
+         * 数据库连接管理。数据库能力从原 dsh-db-tool 合并进来，
+         * 但**不依赖任何 DSH 服务**（原插件把 betterSidebar 当硬依赖，
+         * 服务没就绪就一直 pending，拖垮整个 web 启动）。
+         */
+        this.dbManager = options.dbManager || new DbManager({ homeDir: this.homeDir, settingsStore: this.settingsStore });
     }
 
     /** 面板配置转成 YAML 同构的覆盖层；没有面板存储时返回 undefined */
@@ -1161,9 +1168,61 @@ export class ApiRunnerService {
         return { ok: true, message: `已取消关联 pid ${pid}` };
     }
 
+    // ---- 数据库（从 dsh-db-tool 合并进来的能力） ----
+    /**
+     * 数据库连接是**跨项目**的：同一套库通常被多个项目共用，
+     * 按项目归档反而每次换项目都要重配。所以这里不接 cwd 参数。
+     */
+    dbConnections() {
+        if (!this.dbManager) return { ok: false, code: 'NO_DB', message: '数据库模块不可用' };
+        try {
+            const connections = this.dbManager.listConnections();
+            return { ok: true, connections, total: connections.length };
+        } catch (error) {
+            return { ok: false, code: 'DB_ERROR', message: String(error?.message || error) };
+        }
+    }
+
+    async dbTest(target) {
+        if (!this.dbManager) return { ok: false, code: 'NO_DB', message: '数据库模块不可用' };
+        return this.dbManager.testConnection(target);
+    }
+
+    dbSave(patch) {
+        if (!this.dbManager) return { ok: false, code: 'NO_DB', message: '数据库模块不可用' };
+        return this.dbManager.saveConnection(patch);
+    }
+
+    dbDelete(id) {
+        if (!this.dbManager) return { ok: false, code: 'NO_DB', message: '数据库模块不可用' };
+        return this.dbManager.deleteConnection(id);
+    }
+
+    async dbQuery(id, sql, params = [], options = {}) {
+        if (!this.dbManager) return { ok: false, code: 'NO_DB', message: '数据库模块不可用' };
+        return this.dbManager.query(id, sql, params, options);
+    }
+
+    async dbDatabases(id) {
+        if (!this.dbManager) return { ok: false, code: 'NO_DB', message: '数据库模块不可用' };
+        return this.dbManager.listDatabases(id);
+    }
+
+    async dbTables(id, database = '') {
+        if (!this.dbManager) return { ok: false, code: 'NO_DB', message: '数据库模块不可用' };
+        return this.dbManager.listTables(id, database);
+    }
+
+    async dbDescribeTable(id, table) {
+        if (!this.dbManager) return { ok: false, code: 'NO_DB', message: '数据库模块不可用' };
+        return this.dbManager.describeTable(id, table);
+    }
+
     dispose() {
         this.logReader.dispose();
         this.serviceManager.dispose();
+        // 数据库连接池也要关，否则插件卸载后连接泄漏
+        if (this.dbManager) this.dbManager.dispose();
     }
 }
 

package/test/client.mjs

@@ -43,8 +43,10 @@ const windowStub = {
     confirm: () => true,
     document: {
         getElementById: () => null,
-        createElement: () => ({ set textContent(v) {}, id: '' }),
+        querySelectorAll: () => [],
+        createElement: () => ({ set textContent(v) {}, id: '', remove() {} }),
         head: { appendChild: () => {} },
+        documentElement: { appendChild: () => {} },
     },
 };
 // bundle 里会读 document / window，通过函数参数作用域注入
@@ -148,6 +150,105 @@ const rightPanel = byName('sidebar.right.pane.tab')[0].render({ sessionId: 'sess
 assert.ok(rightPanel, '右侧栏页签正文应返回元素');
 assert.equal(typeof rightPanel.type, 'function');
 
+// 数据库子页：结构断言（直接扫源码，避免为渲染造一堆桩）
+assert.ok(/id: 'db', label: '数据库'/.test(source), "面板 tabs 应包含「数据库」子页");
+assert.ok(/tab === 'db' \? dbPane : null/.test(source), '应渲染 dbPane 分支');
+assert.ok(/function EditDbForm/.test(source), '应有数据库连接编辑表单');
+assert.ok(/function DbResultCard/.test(source), '应有 SQL 结果卡片');
+assert.ok(/function TableDetail/.test(source), '应有表结构视图');
+assert.ok(/type: 'password'/.test(source), '密码框必须是 password 类型，不能明文显示');
+assert.ok(/只读模式（拒绝写操作）/.test(source), '应有只读模式开关');
+assert.ok(/db\/query/.test(source), 'SQL 执行应走 db/query 路由');
+
+// UI 层级：顶部页签用 ar-tabs，一级标题用独立胶囊 ar-segmented（参照宿主插件详情页）
+assert.ok(/className: 'ar-tabs'/.test(source), '顶部应有页签容器 ar-tabs');
+assert.ok(/className: 'ar-segmented'/.test(source), '一级标题应是小胶囊容器 ar-segmented');
+assert.ok(/'ar-seg on' : 'ar-seg'/.test(source), '胶囊选中态应有独立样式');
+assert.ok(/label: '连接'/.test(source) && /label: 'SQL'/.test(source) && /label: '表结构'/.test(source),
+    '数据库子页应有「连接 / SQL / 表结构」三个一级标题');
+assert.ok(/const \[dbSection, setDbSection\]/.test(source), '数据库子页需要 dbSection 状态');
+assert.ok(/\.ar-segmented \{/.test(source), '缺少 .ar-segmented 样式');
+assert.ok(/--ar-elevated:/.test(source), '选中态需要 --ar-elevated 变量（深/浅色主题各一份）');
+
+/**
+ * 布局回归：一级标题胶囊必须横向一排。
+ * 曾用 flex-wrap: wrap，结果在窄面板（右侧栏 ~300px）里被挤成竖排，
+ * 用户看到的就是「连接 / SQL / 表结构」三个上下堆叠的方块。
+ */
+assert.ok(/\.ar-segmented \{[^}]*flex-wrap:\s*nowrap/s.test(source), 'ar-segmented 必须禁止换行');
+assert.ok(/\.ar-segmented \{[^}]*overflow-x:\s*auto/s.test(source), 'ar-segmented 超出时应横向滚动');
+assert.ok(/\.ar-seg \{[^}]*flex:\s*0 0 auto/s.test(source), '胶囊不应被压缩');
+assert.ok(/\.ar-seg \{[^}]*white-space:\s*nowrap/s.test(source), '胶囊文字不应换行');
+assert.ok(!/\.ar-segmented \{[^}]*flex-wrap:\s*wrap/s.test(source), 'ar-segmented 不能用 flex-wrap: wrap（会竖排）');
+assert.ok(/\.ar-tabs \{[^}]*overflow-x:\s*auto/s.test(source), '顶部页签超出时应横向滚动');
+assert.ok(/scrollIntoView/.test(source), '选中的胶囊应自动滚入视野');
+
+/**
+ * 样式热更新回归：installStyles 不能因为「元素已存在」就跳过，
+ * 否则插件升级后页面里还是旧 CSS（胶囊退化成原生 button、竖排），刷新也无效。
+ */
+assert.ok(/style\[id\^="dsh-api-runner-style"\]/.test(source), '应清理历史版本的 style 元素');
+assert.ok(/el\.textContent !== CSS/.test(source), '样式内容变化时应替换，而不是跳过');
+assert.ok(!/if \(document\.getElementById\(STYLE_ID\)\) return;/.test(source), '不能因 id 已存在就提前返回');
+assert.ok(/const STYLE_ID = '[^']*-v\d+'/.test(source), 'style id 应带版本后缀，避免被按 id 去重');
+
+/**
+ * 回归：useEffect 的依赖数组里引用了「在它之后才 const 声明」的变量，
+ * 会因暂时性死区抛 `Cannot access 'x' before initialization`，
+ * 整个 Panel 崩溃 -> 面板白屏。这个 bug 真实发生过（refreshDb）。
+ *
+ * 做法：把 Panel 函数体抽出来，逐行累积「已声明的标识符」，
+ * 遇到 `}, [...])` 形式的依赖数组就检查里面的名字是否都已声明。
+ */
+const panelStart = source.indexOf('function Panel(props) {');
+assert.ok(panelStart > 0, '应能定位 Panel 函数');
+let depth = 0;
+let panelEnd = -1;
+for (let i = source.indexOf('{', panelStart); i < source.length; i++) {
+    if (source[i] === '{') depth += 1;
+    else if (source[i] === '}') { depth -= 1; if (depth === 0) { panelEnd = i + 1; break; } }
+}
+const panelBody = source.slice(panelStart, panelEnd);
+const panelLines = panelBody.split('\n');
+const declaredBefore = new Set();
+const tdzIssues = [];
+/** 全局可用的名字，不需要在 Panel 内声明 */
+const GLOBALS = new Set(['visible', 'props', 'React', 'h', 'window', 'document', 'setInterval', 'clearInterval', 'setTimeout', 'console', 'undefined', 'null', 'true', 'false']);
+
+for (let i = 0; i < panelLines.length; i += 1) {
+    const line = panelLines[i];
+    // 依赖数组行：`}, [a, b, c]);` 或 `}, [a, b]);`
+    const depMatch = line.match(/\},\s*\[([^\]]*)\]\s*\)/);
+    if (depMatch) {
+        for (const raw of depMatch[1].split(',')) {
+            const name = raw.trim();
+            if (!/^[A-Za-z_$][\w$]*$/.test(name)) continue;
+            if (GLOBALS.has(name)) continue;
+            if (!declaredBefore.has(name)) {
+                tdzIssues.push(`Panel 第 ${i + 1} 行：依赖 "${name}" 在该行之前未声明（TDZ 会导致面板白屏）`);
+            }
+        }
+    }
+    // 记录本行声明：const/let/var 单变量
+    for (const m of line.matchAll(/\b(?:const|let|var)\s+([A-Za-z_$][\w$]*)\s*=/g)) declaredBefore.add(m[1]);
+    // 记录解构声明：const [a, b] = ... / const { a, b } = ...
+    for (const m of line.matchAll(/\b(?:const|let|var)\s*\[([^\]]+)\]\s*=/g)) {
+        for (const part of m[1].split(',')) {
+            const name = part.trim().split(':').pop().trim();
+            if (/^[A-Za-z_$][\w$]*$/.test(name)) declaredBefore.add(name);
+        }
+    }
+    for (const m of line.matchAll(/\b(?:const|let|var)\s*\{([^}]+)\}\s*=/g)) {
+        for (const part of m[1].split(',')) {
+            const name = part.trim().split(':').pop().trim();
+            if (/^[A-Za-z_$][\w$]*$/.test(name)) declaredBefore.add(name);
+        }
+    }
+    // 记录函数声明
+    for (const m of line.matchAll(/\bfunction\s+([A-Za-z_$][\w$]*)\s*\(/g)) declaredBefore.add(m[1]);
+}
+assert.deepEqual(tdzIssues, [], `useEffect 依赖里出现了「声明在之后」的变量（会导致面板白屏）：\n${tdzIssues.join('\n')}`);
+
 // 宿主没提供 slots 时 apply 要安全退出，不能抛
 recorded.exports.apply({ effect: () => {} });