dsh-api-runner 0.3.0 → 0.3.1

package/src/main.js

@@ -19,23 +19,48 @@ import { ApiRunnerService, asObject, toText } from './ops.js';
 import { ProjectStore } from './project-store.js';
 import { JavaRunner } from './java-runner.js';
 import { SettingsStore } from './settings.js';
+import { normalizeProjectKey } from './util.js';
 
 export const inject = ['webServer', 'sessions', 'tools', 'connection', 'systemPrompt'];
 
-const TOOL_DESCRIPTION = `开发联调工具（dsh-api-runner）：按配置调用后端 HTTP 接口、启停本地服务、增量读取日志。
+/**
+ * 会话 cwd → 项目 key。数据库授权按这个 key 归档。
+ * 没有 cwd 时回落 'default'，和 ProjectStore 的约定一致。
+ */
+function projectKeyOf(cwd) {
+    return normalizeProjectKey(String(cwd || '')) || 'default';
+}
+
+const TOOL_DESCRIPTION = `开发联调工具（dsh-api-runner）：按配置调用后端 HTTP 接口、启停本地服务、增量读取日志、直接查数据库。
 
 典型用法（改完后端代码后自测）：
-1. action=describe —— 先看有哪些接口/服务/日志可用（含每个接口需要的参数名）。
+1. action=describe —— 先看有哪些接口/服务/日志/数据库可用（含每个接口需要的参数名）。
 2. action=service + service_action=restart —— 重启本地服务（managed 模式由插件托管进程；
    observe 模式下插件不托管，需你到 IDEA 里重启，然后用 service_action=wait 等就绪）。
 3. action=log + pattern —— 增量读日志；或 action=wait_log 等启动完成/报错特征出现。
 4. action=call —— 调用接口，params 里的键会替换 URL 里的 {name} 并拼进 query/body。
 5. action=verify —— 一条命令串起「重启 → 读日志 → 调接口」，适合改完后端后自检。
+6. action=db —— 直接查数据库：db_action=list_connections 看有哪些库；
+   list_tables / describe_table 看结构；query 执行 SQL。
+
+安全约束（务必遵守）：
+- 只有**已被当前项目授权**的连接才会出现在 describe 里；未授权的连接查不到也调不动。
+- 模型侧**永远只读**：只允许 SELECT / SHOW / DESCRIBE / EXPLAIN 等查询。
+  传 db_readonly=false 也不会放开写操作——写数据只能由人在面板里做。
+- DROP / TRUNCATE / 无 WHERE 的 DELETE 等毁灭性操作一律拒绝。
+
+什么时候该用 db：
+- 需要确认数据是否真的写进去了（接口返回成功但不确认落库）。
+- 排查数据问题：某条记录状态不对、关联数据缺失、字段值与预期不符。
+- 需要先了解表结构才能写对查询时，先 describe_table 再 query。
+遇到「数据对不对」这类问题就主动查，不用等用户提醒。
 
 注意：
 - 日志游标按 logId 持久化，第一次读只取文件末尾一段；要全量请传 reset=true。
 - 服务重启会 kill 整个进程树后重新拉起（managed）；失败时返回 exit code 与健康检查明细。
-- 接口响应体默认截断到 32KB，可用 max_bytes 调整；请求头在返回里已脱敏。`;
+- 接口响应体默认截断到 32KB，可用 max_bytes 调整；请求头在返回里已脱敏。
+- SQL 只允许单条语句；用 db_params 传参，不要拼接字符串（防注入）。
+- 数据库连接是跨项目的全局配置，但**访问权按项目隔离**。`;
 
 const PARAMETERS = {
     type: 'object',
@@ -88,12 +113,12 @@ const PARAMETERS = {
         },
         db_readonly: {
             type: 'boolean',
-            description: 'db_action=query 时是否只读（默认 true，拒绝 INSERT/UPDATE/DELETE/DDL）',
+            description: '（已废弃，保留仅为兼容）模型侧永远只读，传 false 也不会放开写操作。写数据只能由人在面板里操作。',
         },
         connection: {
             type: 'object',
             additionalProperties: true,
-            description: '连接配置（db_action=save/test 用）：{ id?, name, type(sqlite|mysql|postgres|oracle), host, port, database, username, password, extra }',
+            description: '连接配置（db_action=save/test 用）：{ id?, name, type(sqlite|mysql|postgres|oracle|dm), host, port, database, username, password, connectString?, extra }。connectString 是 URL 模式（如 dm://user:pass@host:5236），填了就不用 host/port',
         },
         table: { type: 'string', description: '表名（db_action=describe_table 用）' },
         database: { type: 'string', description: '库名/模式名（db_action=list_tables 用；MySQL 必填）' },
@@ -240,10 +265,15 @@ async function runTool(service, args, projectPath) {
         }
         case 'db': {
             const dbAction = String(args.db_action || 'list_connections');
+            /**
+             * 项目（工作空间）key：授权是按项目走的，所有 db 动作都要带上它。
+             * runTool 的 projectPath 就是会话 cwd，用它派生 key。
+             */
+            const projectKey = projectKeyOf(projectPath);
             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));
+                return service.dbDatabases(String(args.connection_id), { projectKey });
             }
             if (dbAction === 'test') {
                 const target = args.connection || args.connection_id;
@@ -279,20 +309,25 @@ async function runTool(service, args, projectPath) {
                 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,
+                    /**
+                     * 模型侧**永远只读**：不接受 args 里传的 db_readonly=false。
+                     * 写操作只能由人在面板里做（面板走的是另一条带 UI 确认的路径）。
+                     * 这样即使模型被诱导，也删不掉任何数据。
+                     */
+                    readonly: true,
+                    projectKey,
                     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) : '');
+                return service.dbTables(String(args.connection_id), args.database ? String(args.database) : '', { projectKey });
             }
             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 service.dbDescribeTable(String(args.connection_id), String(args.table), { projectKey });
             }
             return { ok: false, code: 'BAD_ACTION', message: `不支持的 db_action: ${dbAction}` };
         }
@@ -414,13 +449,15 @@ export function apply(ctx) {
                         const apis = info.apis.map((api) => `- ${api.id}（${api.method} ${api.url}）${api.params.length ? ` 参数: ${api.params.join(', ')}` : ''}`).join('\n');
                         const services = info.services.map((item) => `- ${item.id}（${item.mode}）${item.name}`).join('\n');
                         const logs = info.logs.map((item) => `- ${item.id} → ${item.path}`).join('\n');
-                        if (!apis && !services && !logs) return '';
+                        const databases = (info.databases || []).map((item) => `- ${item.id}（${item.type}）${item.name} → ${item.target}`).join('\n');
+                        if (!apis && !services && !logs && !databases) return '';
                         return [
                             '# 本地开发联调（dsh-api-runner）',
                             '可用工具 ApiRunner 已配置以下资源；改完后端代码后可用它重启服务、读日志、直接调接口验证。',
                             apis ? `\n接口：\n${apis}` : '',
                             services ? `\n服务：\n${services}` : '',
                             logs ? `\n日志：\n${logs}` : '',
+                            databases ? `\n数据库（可用 action=db 直接查询，默认只读）：\n${databases}\n需要看表结构时用 db_action=list_tables / describe_table；查数据用 db_action=query + sql（用 db_params 传参，别拼字符串）。` : '',
                         ].join('\n');
                     } catch {
                         return '';
@@ -673,7 +710,10 @@ async function handleHttp(req, res, service, projectOf) {
         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));
+        // timeout_ms 让前端能把等待压到可接受范围（默认 15s，见 DbManager.probeTimeoutMs）
+        return send(200, await service.dbTest(target, {
+            timeoutMs: body.timeout_ms ? Number(body.timeout_ms) : undefined,
+        }));
     }
     if (route === 'db/save' && req.method === 'POST') {
         const body = await readBody();
@@ -690,25 +730,49 @@ async function handleHttp(req, res, service, projectOf) {
             String(body.sql || ''),
             Array.isArray(body.params) ? body.params : [],
             {
+                /**
+                 * 面板里的写操作需要「项目授权 = readwrite」才放行，
+                 * 且 DROP/TRUNCATE/无 WHERE 的 DELETE 仍会被 DESTRUCTIVE_BLOCKED 拦住。
+                 * readonly 由前端传，但真正的闸门是项目授权等级。
+                 */
                 readonly: body.readonly !== false,
+                projectKey: projectKeyOf(cwd),
                 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') || '')));
+        return send(200, await service.dbDatabases(
+            String(url.searchParams.get('connection_id') || ''),
+            { projectKey: projectKeyOf(cwd) },
+        ));
     }
     if (route === 'db/tables' && req.method === 'GET') {
         return send(200, await service.dbTables(
             String(url.searchParams.get('connection_id') || ''),
             String(url.searchParams.get('database') || ''),
+            { projectKey: projectKeyOf(cwd) },
         ));
     }
     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') || ''),
+            { projectKey: projectKeyOf(cwd) },
+        ));
+    }
+
+    // ---- 数据库项目授权（默认拒绝，必须显式授权） ----
+    if (route === 'db/access' && req.method === 'GET') {
+        return send(200, service.dbAccess(projectKeyOf(cwd)));
+    }
+    if (route === 'db/access' && req.method === 'POST') {
+        const body = await readBody();
+        return send(200, service.dbSetAccess(
+            projectKeyOf(body.project_key ? String(body.project_key) : cwd),
+            String(body.connection_id || ''),
+            String(body.level || 'none'),
         ));
     }
 

package/src/ops.js

@@ -105,6 +105,33 @@ export class ApiRunnerService {
                 exists: fileExists(log.path),
                 size: fileSize(log.path),
             })),
+            /**
+             * 数据库连接也放进 describe：模型据此知道「有哪些库可查」。
+             *
+             * **只列当前项目已授权的连接**——未授权的连接模型不该看见，
+             * 否则它会反复尝试然后被拒，浪费轮次还误导用户。
+             * 只给 id / 名称 / 类型 / 目标 / 权限等级，不给账号密码。
+             */
+            databases: this.dbManager
+                ? (() => {
+                    const access = this.dbManager.accessOf('default');
+                    return this.dbManager.listConnections()
+                        .map((item) => {
+                            const level = access[item.id] || 'none';
+                            return {
+                                id: item.id,
+                                name: item.name,
+                                type: item.type,
+                                target: item.urlMode
+                                    ? item.connectString
+                                    : (item.type === 'sqlite' ? (item.file || ':memory:') : `${item.host}:${item.port}/${item.database}`),
+                                username: item.username || '',
+                                level,
+                            };
+                        })
+                        .filter((item) => item.level !== 'none');
+                })()
+                : [],
         };
     }
 
@@ -1183,9 +1210,9 @@ export class ApiRunnerService {
         }
     }
 
-    async dbTest(target) {
+    async dbTest(target, options = {}) {
         if (!this.dbManager) return { ok: false, code: 'NO_DB', message: '数据库模块不可用' };
-        return this.dbManager.testConnection(target);
+        return this.dbManager.testConnection(target, options);
     }
 
     dbSave(patch) {
@@ -1203,19 +1230,30 @@ export class ApiRunnerService {
         return this.dbManager.query(id, sql, params, options);
     }
 
-    async dbDatabases(id) {
+    async dbDatabases(id, options = {}) {
+        if (!this.dbManager) return { ok: false, code: 'NO_DB', message: '数据库模块不可用' };
+        return this.dbManager.listDatabases(id, options);
+    }
+
+    async dbTables(id, database = '', options = {}) {
+        if (!this.dbManager) return { ok: false, code: 'NO_DB', message: '数据库模块不可用' };
+        return this.dbManager.listTables(id, database, options);
+    }
+
+    async dbDescribeTable(id, table, options = {}) {
         if (!this.dbManager) return { ok: false, code: 'NO_DB', message: '数据库模块不可用' };
-        return this.dbManager.listDatabases(id);
+        return this.dbManager.describeTable(id, table, options);
     }
 
-    async dbTables(id, database = '') {
+    // ---- 数据库项目授权（默认拒绝，必须显式授权） ----
+    dbAccess(projectKey) {
         if (!this.dbManager) return { ok: false, code: 'NO_DB', message: '数据库模块不可用' };
-        return this.dbManager.listTables(id, database);
+        return this.dbManager.accessView(projectKey);
     }
 
-    async dbDescribeTable(id, table) {
+    dbSetAccess(projectKey, connectionId, level) {
         if (!this.dbManager) return { ok: false, code: 'NO_DB', message: '数据库模块不可用' };
-        return this.dbManager.describeTable(id, table);
+        return this.dbManager.setAccess(projectKey, connectionId, level);
     }
 
     dispose() {

package/test/client.mjs

@@ -164,8 +164,9 @@ assert.ok(/db\/query/.test(source), 'SQL 执行应走 db/query 路由');
 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(/label: '连接管理'/.test(source) && /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 变量（深/浅色主题各一份）');
@@ -192,6 +193,44 @@ 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 去重');
 
+/**
+ * 数据库表单的三处修复（用户报的缺陷）：
+ *   1. 端口输入框被写死 90px，和 host 挤一行时变形
+ *   2. 新增时填完没法试连
+ *   3. 支持 URL 直连
+ */
+assert.ok(!/flex: '0 0 90px'/.test(source), '端口输入框不能固定像素宽（窄面板会变形）');
+assert.ok(/测试中…' : '测试'/.test(source), '表单应有「测试」按钮，新增时也能试连');
+assert.ok(/label: 'URL'/.test(source), '表单应支持 URL 录入方式');
+assert.ok(/connectString/.test(source), '应支持 connectString（URL 模式）');
+assert.ok(/item\.urlMode \? h\('span'/.test(source), '列表应标出 URL 模式的连接');
+assert.ok(/replace\(\/\[\^\\d\]\/g, ''\)/.test(source), '端口输入框应只接受数字');
+
+// 项目授权 UI：三档切换 + 安全说明
+assert.ok(/setDbAccessLevel/.test(source), '应有设置授权的处理函数');
+assert.ok(/label: '未授权'/.test(source) && /label: '只读'/.test(source) && /label: '读写'/.test(source),
+    '授权应有「未授权 / 只读 / 读写」三档');
+assert.ok(/毁灭性操作/.test(source), '授权页应说明毁灭性操作会被拒绝');
+assert.ok(/refreshDbAccess/.test(source), '应能刷新授权状态');
+
+// UI 重设计：命名空间分离 + 设计 token
+assert.ok(/className: 'ar-switch'/.test(source), '响应切换条应使用 ar-switch（不与 ar-seg 胶囊冲突）');
+assert.ok(!/className: 'ar-seg'/.test(source), 'ar-seg 只能当胶囊按钮，不能再被当容器');
+assert.ok(/--ar-surface-1/.test(source) && /--ar-surface-2/.test(source) && /--ar-surface-3/.test(source),
+    '应有三级中性面 token，用于分层');
+assert.ok(/--ar-r-lg/.test(source), '应有大圆角 token');
+assert.ok(/dsh-api-runner-style-v5/.test(source), '样式版本应为 v5');
+
+/**
+ * 试连不能锁死整个面板：
+ * 达梦连不上要等十几秒，若共用全局 busy，期间保存/取消/编辑全被 disabled，
+ * 用户会以为界面卡死。试连必须用独立的 testing 状态。
+ */
+assert.ok(/const \[dbTesting, setDbTesting\]/.test(source), '试连应有独立状态 dbTesting');
+assert.ok(/disabled: testing \|\| busy === 'save'/.test(source), '测试按钮只锁自己，不锁其它');
+assert.ok(/busy === 'save' \? '保存中…' : '保存'/.test(source), '保存按钮只受保存中影响');
+assert.ok(!/busy === 'test'/.test(source), '不应再用全局 busy 表示测试中');
+
 /**
  * 回归：useEffect 的依赖数组里引用了「在它之后才 const 声明」的变量，
  * 会因暂时性死区抛 `Cannot access 'x' before initialization`，