dsh-app-deploy 0.3.0 → 0.3.1

package/README.md

@@ -31,7 +31,7 @@
 插件发布在 npm，通过 DSH 插件管理器直接安装：
 
 ```text
-plugin_manager → action: install_bundle → target: dsh-app-deploy@0.3.0
+plugin_manager → action: install_bundle → target: dsh-app-deploy@0.3.1
 ```
 
 安装后刷新 DSH Web，左侧导航出现「部署」入口。
@@ -49,6 +49,10 @@ plugin_manager → action: install_bundle → target: dsh-app-deploy@0.3.0
 
 新装插件默认为空配置（不播种），环境通过「+ 添加环境」或「导入」创建。
 
+## AI 工具
+
+插件向 dsh Agent 注册 4 个工具：`deploy_list_envs`（列出环境与模块，密码已剥离）、`deploy_run`（执行部署并返回日志）、`deploy_history`（执行记录）、`ssh_test_connection`（SSH 连通性测试）。可直接让 AI 代查发布状态或执行部署。
+
 ## 使用
 
 单模块部署流程：

package/index.js

@@ -7,6 +7,7 @@ import { initConfig } from './server/config.js'
 import { initHistory } from './server/history.js'
 import { handleRpc } from './server/rpc.js'
 import { handleDeploy, killActiveProcess } from './server/deployment.js'
+import { registerTools } from './server/tools.js'
 
 // ponytail: linked workspace cannot resolve dsh's own packages; resolve from the dsh entry instead
 function hostRequire() {
@@ -22,7 +23,7 @@ const host = hostRequire()
 const schema = host('@deepseek-ai/schemastery')
 const z = schema.z ?? schema
 
-export const inject = ['webServer']
+export const inject = ['webServer', 'tools']
 export const Config = z.object({
   dataDir: z.string().default(''),
   defaultProjectPath: z.string().default(''),
@@ -59,13 +60,19 @@ function resolveDataDir(config) {
 
 export function apply(ctx, config) {
   const dataDir = resolveDataDir(config)
-  // 延迟初始化：apply 内不 await，首个请求时才读数据目录/初始化配置
+  // 延迟初始化：apply 内不 await，首个请求/工具调用时才读数据目录/初始化配置
   let ready
   const ensure = () => (ready ??= (async () => {
     await mkdir(dataDir, { recursive: true })
     await initConfig({ dataDir, defaultProjectPath: config?.defaultProjectPath || '' })
     await initHistory(dataDir)
   })())
+  // AI 工具：列出环境 / 执行部署 / 执行记录 / SSH 测试（defineTool 从 dsh 宿主解析，失败不影响面板）
+  try {
+    registerTools(ctx, host('@deepseek-ai/dsh-tools').defineTool, ensure)
+  } catch (err) {
+    console.warn('[dsh-app-deploy] 注册 AI 工具失败:', err?.message || err)
+  }
 
   ctx.effect(() => {
     const dispose = ctx.webServer.register({

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "dsh-app-deploy",
-  "version": "0.3.0",
+  "version": "0.3.1",
   "description": "DSH 插件：按环境编排并执行构建（Gradle/Maven/前端）、多 SSH 目标发布、rsync/rclone 同步与远程命令的部署面板，支持连接测试，实时推送日志并保留执行记录。",
   "repository": "btboys/dsh-app-deploy",
   "type": "module",

package/server/deployment.js

@@ -463,4 +463,45 @@ export async function handleDeploy(req, res, url) {
   }
 }
 
+// 供 AI 工具调用：同步执行一次部署并返回结果；与 SSE 入口共用部署锁、执行记录与日志尾部
+export async function runDeploy(envId, moduleIds = []) {
+  const env = getEnvs().find(e => e.id === envId)
+  if (!env) throw new Error(`未知环境: ${envId}`)
+  if (running && !running.done) throw new Error(`已有部署进行中（${running.label}），请稍后再试`)
+  const want = (moduleIds || []).filter(Boolean)
+  const enabled = env.modules.filter(m => m.enabled)
+  // 未指定模块 = 全部启用模块（按配置顺序）；指定则按给定顺序
+  const mods = want.length
+    ? want.map(id => enabled.find(m => m.id === id)).filter(Boolean)
+    : enabled
+  if (!mods.length) throw new Error('没有可部署的启用模块（检查模块 ID 与启用状态）')
+  if (want.length && mods.length !== want.length) {
+    const missing = want.filter(id => !enabled.some(m => m.id === id))
+    throw new Error(`模块不可用或已禁用: ${missing.join('、')}`)
+  }
+  const runTargets = [...new Set(mods.map(m => targetFor(env, m)))]
+  if (runTargets.some(t => !t.host || !t.user)) throw new Error('SSH 目标配置不完整')
+
+  const rec = {
+    id: Date.now().toString(36) + Math.random().toString(36).slice(2, 8),
+    envId: env.id, envName: env.name,
+    modules: mods.map(m => ({ id: m.id, name: m.name })),
+    startTime: Date.now(), endTime: null, durationMs: null,
+    status: 'running', exitCode: null, failedModule: null, failedStep: null, logTail: '',
+  }
+  getHistory().push(rec)
+  saveHistory().catch(() => {})
+  running = { clients: new Set(), done: false, label: `${env.name} / ${mods.map(m => m.name).join('+')}`, record: rec, logTail: '', lastCode: null }
+  broadcast(`>>> 开始部署 [AI 工具] ${env.name} / ${mods.map(m => m.name).join('+')}\n`)
+  await runDeployment(env, mods) // 结束后 running.done 已置位、rec 已补齐
+  return {
+    code: rec.exitCode,
+    status: rec.status,
+    durationMs: rec.durationMs,
+    failedModule: rec.failedModule,
+    failedStep: rec.failedStep,
+    logTail: rec.logTail,
+  }
+}
+
 export function activeRecord() { return running && !running.done ? running.record : null }

package/server/tools.js

@@ -0,0 +1,138 @@
+// AI 可调用的部署工具：列出环境、执行部署、查执行记录、测试 SSH 连接
+// 密码绝不暴露给模型（只返回 hasPassword 标记）；密钥路径是本机路径，可返回
+import { getEnvs } from './config.js'
+import { runDeploy, testSsh, activeRecord } from './deployment.js'
+import { getHistory } from './history.js'
+
+// 环境摘要：供模型决定部署目标；剥离 password
+export function envSummaryForModel(e) {
+  return {
+    id: e.id, name: e.name, note: e.note, group: e.group,
+    projectPath: e.projectPath, jdkHome: e.jdkHome || '', nodeHome: e.nodeHome || '', pmPath: e.pmPath || '',
+    sshs: (e.sshs || []).map(s => ({
+      id: s.id, name: s.name, host: s.host, port: s.port, user: s.user,
+      hasPassword: !!s.password, keyFile: s.keyFile || '', options: s.options || '',
+    })),
+    modules: (e.modules || []).map(m => ({
+      id: m.id, name: m.name, kind: m.kind, enabled: m.enabled, buildCmd: m.buildCmd, sshId: m.sshId || '',
+      localPath: m.localPath, remotePath: m.remotePath, postCommand: m.postCommand, healthCheckUrl: m.healthCheckUrl || '',
+    })),
+  }
+}
+
+const jsonRender = (_args, value) => [{ type: 'text', text: JSON.stringify(value, null, 2) }]
+
+/**
+ * 向 ctx.tools 注册 4 个工具。defineTool 由宿主解析（@deepseek-ai/dsh-tools），
+ * 插件自身不依赖该包，保证脱离 dsh 宿主时模块仍可加载（如单元测试）。
+ * @param {object} ctx cordis Context（需注入 tools 服务）
+ * @param {object} defineTool @deepseek-ai/dsh-tools 的 defineTool
+ * @param {() => Promise<void>} ensure 插件初始化（数据目录/配置/历史）；工具调用不走 HTTP 路由，必须显式等待
+ */
+export function registerTools(ctx, defineTool, ensure) {
+  // 每个工具执行前确保初始化完成（幂等，首次才真正读盘）
+  const ready = () => (ensure ? ensure() : Promise.resolve())
+  ctx.tools.register(defineTool({
+    name: 'deploy_list_envs',
+    description: 'List deploy environments configured in the dsh-app-deploy plugin: SSH targets (passwords stripped), build modules with their build commands, artifact paths and publish targets. Use before deploy_run to pick env/module IDs.',
+    parameters: {},
+    output: {
+      schema: {
+        type: 'object', additionalProperties: false,
+        properties: {
+          active: { type: 'object', additionalProperties: true }, // 进行中的部署（无则不返回）
+          envs: { type: 'array', required: true, items: { type: 'object', additionalProperties: true } },
+        },
+      },
+      render: jsonRender,
+    },
+    execute: async () => {
+      await ready()
+      const rec = activeRecord()
+      return {
+        ...(rec ? { active: { id: rec.id, env: rec.envName, modules: rec.modules } } : {}),
+        envs: getEnvs().map(envSummaryForModel),
+      }
+    },
+  }))
+
+  ctx.tools.register(defineTool({
+    name: 'deploy_run',
+    description: 'Run a deployment for one environment: clean → build each module (generic command: gradlew/mvn/npm…) → rsync/rclone to the module\'s SSH target → remote command → health check. Blocks until finished and returns the exit code plus the full log tail. Fails if another deployment is running. Omit modules to deploy all enabled modules in config order.',
+    parameters: {
+      env: { type: 'string', required: true, description: 'Environment ID (from deploy_list_envs)' },
+      modules: { type: 'array', items: { type: 'string' }, description: 'Module IDs in desired execution order. Omit for all enabled modules.' },
+    },
+    output: {
+      schema: {
+        type: 'object', additionalProperties: false,
+        properties: {
+          code: { type: 'integer', required: true },
+          status: { type: 'string', required: true },
+          durationMs: { type: 'integer' },
+          failedModule: { type: 'string' },
+          failedStep: { type: 'string' },
+          logTail: { type: 'string', required: true },
+        },
+      },
+      render: jsonRender,
+    },
+    execute: async (args) => {
+      await ready()
+      return runDeploy(args.env, args.modules || [])
+    },
+  }))
+
+  ctx.tools.register(defineTool({
+    name: 'deploy_history',
+    description: 'Recent deployment records (newest first): status, duration, per-module failure step, and a truncated log tail for failed runs. Filter by environment ID optionally.',
+    parameters: {
+      env: { type: 'string', description: 'Environment ID to filter by' },
+      limit: { type: 'integer', description: 'Max records, default 10' },
+    },
+    output: {
+      schema: {
+        type: 'object', additionalProperties: false,
+        properties: {
+          records: { type: 'array', required: true, items: { type: 'object', additionalProperties: true } },
+        },
+      },
+      render: jsonRender,
+    },
+    execute: async (args) => {
+      await ready()
+      const limit = Math.min(Math.max(Number(args.limit) || 10, 1), 50)
+      let list = getHistory().slice()
+      if (args.env) list = list.filter(r => r.envId === args.env)
+      return { records: list.slice(-limit).reverse() }
+    },
+  }))
+
+  ctx.tools.register(defineTool({
+    name: 'ssh_test_connection',
+    description: 'Test an SSH connection (10s timeout): host key/agent auth via keyFile, or password via sshpass. Returns ok/latency or the server-reported error.',
+    parameters: {
+      host: { type: 'string', required: true },
+      port: { type: 'integer' },
+      user: { type: 'string', required: true },
+      password: { type: 'string', description: 'SSH password; omit to use keyFile or agent' },
+      keyFile: { type: 'string', description: 'Absolute private key path; takes precedence over options -i' },
+      options: { type: 'string', description: 'Extra ssh options, e.g. -o StrictHostKeyChecking=no' },
+    },
+    output: {
+      schema: {
+        type: 'object', additionalProperties: false,
+        properties: {
+          ok: { type: 'boolean', required: true },
+          ms: { type: 'integer' },
+          error: { type: 'string' },
+        },
+      },
+      render: jsonRender,
+    },
+    execute: async (args) => {
+      await ready()
+      return testSsh({ host: args.host, port: args.port || 22, user: args.user, password: args.password || '', keyFile: args.keyFile || '', options: args.options || '' })
+    },
+  }))
+}