dsh-app-deploy 0.0.0-stage → 0.2.0

package/cordis.patch.yml

@@ -0,0 +1,3 @@
+- insert:
+    - id: dsh-app-deploy
+      name: dsh-app-deploy

package/icon.svg

@@ -0,0 +1,6 @@
+<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="1.8" stroke-linecap="round" stroke-linejoin="round">
+  <path d="M12 3v10"/>
+  <path d="M8.5 6.5 12 3l3.5 3.5"/>
+  <path d="M4 14v4a3 3 0 0 0 3 3h10a3 3 0 0 0 3-3v-4"/>
+  <path d="M8 17h8"/>
+</svg>

package/index.js

@@ -0,0 +1,102 @@
+import { createRequire } from 'node:module'
+import { realpathSync } from 'node:fs'
+import { mkdir } from 'node:fs/promises'
+import { homedir } from 'node:os'
+import { join } from 'node:path'
+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'
+
+// ponytail: linked workspace cannot resolve dsh's own packages; resolve from the dsh entry instead
+function hostRequire() {
+  const local = createRequire(import.meta.url)
+  try {
+    local.resolve('@deepseek-ai/dsh-tools')
+    return local
+  } catch {}
+  if (!process.argv[1]) throw new Error('找不到 dsh 安装目录')
+  return createRequire(realpathSync(process.argv[1]))
+}
+const host = hostRequire()
+const schema = host('@deepseek-ai/schemastery')
+const z = schema.z ?? schema
+
+export const inject = ['webServer']
+export const Config = z.object({
+  dataDir: z.string().default(''),
+  defaultProjectPath: z.string().default(''),
+})
+
+const ROUTE = '/api/dsh-app-deploy'
+const ROUTE_DEPLOY = `${ROUTE}/deploy`
+
+function readJson(req) {
+  return new Promise((resolve, reject) => {
+    const chunks = []
+    req.on('data', (chunk) => chunks.push(chunk))
+    req.on('end', () => {
+      try {
+        resolve(chunks.length ? JSON.parse(Buffer.concat(chunks).toString('utf8')) : {})
+      } catch (error) {
+        reject(error)
+      }
+    })
+    req.on('error', reject)
+  })
+}
+
+function send(res, payload) {
+  res.writeHead(200, { 'content-type': 'application/json; charset=utf-8', 'cache-control': 'no-store' })
+  res.end(JSON.stringify(payload))
+}
+
+function resolveDataDir(config) {
+  const custom = typeof config?.dataDir === 'string' ? config.dataDir.trim() : ''
+  if (custom) return custom
+  return join(process.env.DSH_HOME || join(homedir(), '.dsh'), 'dsh-app-deploy')
+}
+
+export function apply(ctx, config) {
+  const dataDir = resolveDataDir(config)
+  // 延迟初始化：apply 内不 await，首个请求时才读数据目录/初始化配置
+  let ready
+  const ensure = () => (ready ??= (async () => {
+    await mkdir(dataDir, { recursive: true })
+    await initConfig({ dataDir, defaultProjectPath: config?.defaultProjectPath || '' })
+    await initHistory(dataDir)
+  })())
+
+  ctx.effect(() => {
+    const dispose = ctx.webServer.register({
+      kind: 'prefix',
+      path: ROUTE,
+      async handler(req, res) {
+        const url = new URL(req.url ?? '/', 'http://dsh.local')
+        try {
+          await ensure()
+          if (req.method === 'GET' && url.pathname === ROUTE_DEPLOY) {
+            await handleDeploy(req, res, url)
+            return
+          }
+          if (req.method !== 'POST') {
+            send(res, { ok: false, error: '只支持 POST' })
+            return
+          }
+          const body = await readJson(req).catch(() => null)
+          send(res, await handleRpc(body))
+        } catch (error) {
+          if (res.headersSent) {
+            try { res.end() } catch {}
+            return
+          }
+          send(res, { ok: false, error: error?.message || '请求失败' })
+        }
+      },
+    })
+    return () => {
+      dispose()
+      killActiveProcess()
+    }
+  }, 'dsh-app-deploy: routes')
+}

package/locale/en.json

@@ -0,0 +1,6 @@
+{
+  "meta": {
+    "title": "Deployment panel",
+    "description": "Orchestrate per-environment Gradle builds, rsync syncs and SSH commands with live deploy logs and run history."
+  }
+}

package/locale/zh.json

@@ -0,0 +1,6 @@
+{
+  "meta": {
+    "title": "部署面板",
+    "description": "按环境编排并执行 Gradle 构建、rsync 同步与 SSH 远程命令，实时查看部署日志与执行记录。"
+  }
+}

package/package.json

@@ -1,6 +1,42 @@
 {
   "name": "dsh-app-deploy",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
-}
+  "version": "0.2.0",
+  "description": "DSH 插件：按环境编排并执行 Gradle 构建、rsync 同步与 SSH 远程命令的部署面板，实时推送日志并保留执行记录。",
+  "repository": "btboys/dsh-app-deploy",
+  "type": "module",
+  "icon": "./icon.svg",
+  "exports": {
+    ".": "./index.js",
+    "./client": "./client.js",
+    "./locale/*.json": "./locale/*.json",
+    "./icon": "./icon.svg",
+    "./package.json": "./package.json"
+  },
+  "files": [
+    "index.js",
+    "client.js",
+    "server",
+    "cordis.patch.yml",
+    "locale",
+    "icon.svg",
+    "README.md"
+  ],
+  "scripts": {
+    "test": "node --test",
+    "check": "node --check index.js && node --check client.js"
+  },
+  "engines": {
+    "node": ">=22",
+    "dsh": ">=0.2.1-rc.3 <0.3.0"
+  },
+  "dsh": {
+    "bundle": {
+      "patch": "./cordis.patch.yml"
+    },
+    "client": {
+      "platform": "web",
+      "immediately": true,
+      "inject": []
+    }
+  }
+}

package/server/config.js

@@ -0,0 +1,212 @@
+import { promises as fsp } from 'node:fs'
+import path from 'node:path'
+
+// ---------- 状态：数据目录由插件 Config/dataDir 决定，initConfig 时绑定 ----------
+let dataDir = ''
+let envsFile = ''
+let defaultProjectPath = ''
+let envs = []
+
+// 固定 4 个模块的显示名与旧 record 键的映射
+const MODULE_NAME = { bsFront: 'bs 前端', bsServer: 'bs 服务端', adminFront: 'admin 前端', adminServer: 'admin 服务端' }
+const MODULE_ORDER = ['bsFront', 'bsServer', 'adminFront', 'adminServer']
+
+function defaultModules() {
+  return [
+    { id: 'bsFront', name: 'bs 前端', kind: 'front', enabled: true, gradleTask: 'client:client-front:dist', key: '', extraArgs: '', localPath: 'client/client-front/dist/', remotePath: '', postCommand: '', frontEnv: '' },
+    { id: 'bsServer', name: 'bs 服务端', kind: 'server', enabled: true, gradleTask: 'client:client-server:bootJar', key: '', extraArgs: '', localPath: 'client/client-server/build/libs/financial-v5.jar', remotePath: '', postCommand: '', frontEnv: '' },
+    { id: 'adminFront', name: 'admin 前端', kind: 'front', enabled: true, gradleTask: 'admin:admin-front:dist', key: '', extraArgs: '', localPath: 'admin/admin-front/dist/', remotePath: '', postCommand: '', frontEnv: '' },
+    { id: 'adminServer', name: 'admin 服务端', kind: 'server', enabled: true, gradleTask: 'admin:admin-server:bootJar', key: '', extraArgs: '', localPath: 'admin/admin-server/build/libs/financial-admin-v5.jar', remotePath: '', postCommand: '', frontEnv: '' },
+  ]
+}
+
+function templateEnv() {
+  return { id: '', name: '', note: '', group: '', projectPath: defaultProjectPath, jdkHome: '', expTime: '', ssh: { host: '', port: 22, user: 'root', password: '', options: '' }, modules: defaultModules() }
+}
+
+// 把 modules 归一化为数组；record 旧格式自动转数组（id 保持 bsFront 等，name 映射），frontEnv.bs/admin 迁移进对应 front 模块
+function isNewSchema(e) {
+  return !!e && typeof e === 'object' && !!e.ssh && typeof e.ssh === 'object'
+}
+
+// 把 modules 归一化为数组；record 旧格式自动转数组（id 保持 bsFront 等，name 映射），frontEnv.bs/admin 迁移进对应 front 模块
+function toModArray(mods, fe) {
+  const out = []
+  if (Array.isArray(mods)) {
+    let i = 0
+    for (const raw of mods) {
+      const id = String(raw?.id || `mod${++i}`)
+      out.push({
+        id,
+        name: String(raw?.name || MODULE_NAME[id] || id),
+        kind: (raw?.kind === 'server' ? 'server' : raw?.kind === 'front' ? 'front' : (id.endsWith('Front') ? 'front' : 'server')),
+        enabled: raw?.enabled !== false,
+        gradleTask: String(raw?.gradleTask || ''),
+        key: String(raw?.key || ''),
+        extraArgs: String(raw?.extraArgs || ''),
+        localPath: String(raw?.localPath || ''),
+        remotePath: String(raw?.remotePath || ''),
+        postCommand: String(raw?.postCommand || ''),
+        healthCheckUrl: String(raw?.healthCheckUrl || '').trim(),
+        frontEnv: String(raw?.frontEnv || ''),
+      })
+    }
+  } else if (mods && typeof mods === 'object') {
+    for (const mk of MODULE_ORDER) {
+      const m = mods[mk]
+      if (!m) continue
+      const feText = mk === 'bsFront' ? (fe?.bs || '') : mk === 'adminFront' ? (fe?.admin || '') : ''
+      out.push({
+        id: mk, name: MODULE_NAME[mk] || mk, kind: mk.endsWith('Front') ? 'front' : 'server',
+        enabled: m.enabled !== false,
+        gradleTask: String(m.gradleTask || ''), key: String(m.key || ''), extraArgs: String(m.extraArgs || ''),
+        localPath: String(m.localPath || ''), remotePath: String(m.remotePath || ''), postCommand: String(m.postCommand || ''),
+        frontEnv: feText,
+      })
+    }
+  }
+  return out
+}
+
+function normalizeEnv(e) {
+  const env = {
+    id: e.id, name: e.name, note: e.note ?? '',
+    group: e.group ?? '',
+    projectPath: e.projectPath || defaultProjectPath,
+    jdkHome: e.jdkHome ?? '',
+    expTime: e.expTime ?? '',
+    ssh: { host: e.ssh?.host ?? '', port: Number(e.ssh?.port) || 22, user: e.ssh?.user ?? 'root', password: e.ssh?.password ?? '', options: e.ssh?.options ?? '' },
+    modules: toModArray(e.modules, { bs: e.frontEnv?.bs, admin: e.frontEnv?.admin }),
+  }
+  // 迁移（幂等）：把 server 模块 extraArgs 里的 -PexpTime=xxx 提取到 env.expTime 并从 extraArgs 移除
+  let extracted = ''
+  for (const m of env.modules) {
+    if (m.kind !== 'server' || !m.extraArgs) continue
+    const kept = m.extraArgs.trim().split(/\s+/).filter(p => {
+      if (p.startsWith('-PexpTime=')) { if (!extracted) extracted = p.slice(10); return false }
+      return true
+    })
+    m.extraArgs = kept.join(' ')
+  }
+  if (extracted && !env.expTime) env.expTime = extracted
+  return env
+}
+
+async function loadEnvs() {
+  let raw = null
+  try { raw = JSON.parse(await fsp.readFile(envsFile, 'utf8')) } catch {}
+  // 不播种：文件缺失/损坏时初始化为空配置
+  if (!Array.isArray(raw)) {
+    await fsp.writeFile(envsFile, '[]')
+    return []
+  }
+  let migrated = false
+  const out = []
+  for (const e of raw) {
+    if (isNewSchema(e)) {
+      const r = e
+      if (!Array.isArray(r.modules) || r.modules.some(m => m?.extraArgs?.toString().includes('-PexpTime='))) migrated = true
+      out.push(normalizeEnv(r))
+      continue
+    }
+    migrated = true
+    // 旧 schema（{id,name,script,...}）：保留 id/name/note，其余字段用空模板兜底
+    const old = e
+    const base = templateEnv()
+    out.push(normalizeEnv({ ...base, id: String(old.id || ''), name: String(old.name || base.name), note: String(old.note ?? base.note ?? '') }))
+  }
+  if (migrated) await fsp.writeFile(envsFile, JSON.stringify(out, null, 2))
+  return out
+}
+
+export async function initConfig({ dataDir: dir, defaultProjectPath: projectPath = '' } = {}) {
+  dataDir = dir || ''
+  envsFile = dataDir ? path.join(dataDir, 'envs.json') : ''
+  defaultProjectPath = projectPath || ''
+  if (!envsFile) throw new Error('未配置数据目录')
+  envs = await loadEnvs()
+}
+
+export function getEnvs() { return envs }
+
+export async function saveEnvs(next = envs) {
+  await fsp.writeFile(envsFile, JSON.stringify(next, null, 2))
+  envs = next
+}
+
+export function getDefaultProjectPath() { return defaultProjectPath }
+
+// ---------- 校验 ----------
+const BAD_PATH = /[\s;"'`$&|<>()*?[\]{}!]/ // 禁止空格/引号/; & | ` $ 等
+// 绝对路径：posix 以 / 开头，Windows 为盘符 + \ 或 /（如 C:\jdk、D:/proj）
+const isAbsPath = (p) => /^(\/|[a-zA-Z]:[\\/])/.test(p)
+const BAD_CMD = /["'`;&|<>$()*?[\]{}!]/ // 允许空格，其余同上
+
+// 前端 .env 文本：只允许 KEY=VALUE（KEY 为 A-Z0-9_）、空行、# 注释
+export function validateFrontEnv(s) {
+  for (const line of s.split('\n')) {
+    const t = line.trim()
+    if (!t || t.startsWith('#')) continue
+    if (!/^[A-Z0-9_]+\s*=/.test(t)) return '前端 .env 只允许 KEY=VALUE 行（KEY 为 A-Z0-9_）或空行/注释行'
+  }
+  return ''
+}
+
+// 前端 .env 文件路径（仅种子 bsFront/adminFront 有约定路径，供「配置为空时读文件作参考」）
+export function frontEnvFile(e, m) {
+  const p = (e.projectPath || defaultProjectPath || '').replace(/[\\/]+$/, '')
+  if (!p) return null
+  const key = m.key ? '.' + m.key : ''
+  if (m.id === 'bsFront') return path.join(p, 'client/client-front', `.env${key}`)
+  if (m.id === 'adminFront') return path.join(p, 'admin/admin-front', `.env${key}`)
+  return null
+}
+
+export function validateEnv(e) {
+  const errs = []
+  if (!/^[a-z0-9-]+$/.test(e.id)) errs.push('ID 只能是小写字母/数字/连字符')
+  if (!e.name.trim()) errs.push('名称必填')
+  if (e.group && !/^[\u4e00-\u9fa5A-Za-z0-9 -]{1,20}$/.test(e.group)) errs.push('分组只能含中文/字母/数字/空格/连字符，最长 20 字符')
+  if (!isAbsPath(e.projectPath)) errs.push('项目路径必须是绝对路径（如 /opt/proj 或 C:\\proj）')
+  if (BAD_PATH.test(e.projectPath)) errs.push('项目路径含非法字符（禁止空格/引号/; & | ` $ 等）')
+  if (e.jdkHome && !isAbsPath(e.jdkHome)) errs.push('JDK 路径必须是绝对路径')
+  if (e.jdkHome && BAD_PATH.test(e.jdkHome)) errs.push('JDK 路径含非法字符')
+  const s = e.ssh
+  if (!/^[a-zA-Z0-9.-]+$/.test(s.host)) errs.push('SSH host 非法（仅字母/数字/./-）')
+  if (!Number.isInteger(s.port) || s.port < 1 || s.port > 65535) errs.push('SSH port 必须是 1-65535 的整数')
+  if (!/^[a-zA-Z0-9._-]+$/.test(s.user)) errs.push('SSH user 非法')
+  if (BAD_CMD.test(s.options)) errs.push('SSH 自定义选项含非法字符')
+  if (s.password.includes('\n')) errs.push('SSH 密码不能包含换行')
+  if (e.expTime && !/^\d{4}-\d{2}-\d{2}$/.test(e.expTime)) errs.push('过期时间必须是 YYYY-MM-DD')
+  if (!Array.isArray(e.modules) || !e.modules.length) errs.push('至少需要一个模块')
+  const seenId = {}
+  for (const m of (e.modules || [])) {
+    if (!/^[A-Za-z0-9-]+$/.test(m.id)) errs.push(`模块 ${m.name || m.id}: ID「${m.id}」只能包含字母/数字/连字符`)
+    else if (seenId[m.id]) errs.push(`模块 ${m.name || m.id}: ID「${m.id}」重复（环境内须唯一）`)
+    seenId[m.id] = true
+    if (!m.name.trim()) errs.push('模块显示名必填')
+    if (m.kind !== 'front' && m.kind !== 'server') errs.push(`模块 ${m.name || m.id}: kind 必须是 front 或 server`)
+    if (m.kind === 'front') {
+      const fe = validateFrontEnv(m.frontEnv || '')
+      if (fe) errs.push(`${m.name || m.id}: ${fe}`)
+    }
+    if (m.healthCheckUrl) {
+      try {
+        const url = new URL(m.healthCheckUrl)
+        if (!['http:', 'https:'].includes(url.protocol) || url.username || url.password) throw new Error('invalid URL')
+      } catch { errs.push(`${m.name || m.id}: 健康检查 URL 必须是 HTTP/HTTPS 地址，且不能包含用户名或密码`) }
+    }
+    if (!m.enabled) continue
+    if (!/^[a-zA-Z0-9:_-]+$/.test(m.gradleTask)) errs.push(`${m.name || m.id}: gradle 任务非法`)
+    if (m.key && !/^[a-zA-Z0-9._-]+$/.test(m.key)) errs.push(`${m.name || m.id}: -Pkey 非法`)
+    if (m.extraArgs && BAD_CMD.test(m.extraArgs)) errs.push(`${m.name || m.id}: 额外参数含非法字符`)
+    if (!m.localPath) errs.push(`${m.name || m.id}: 本地产物路径必填`)
+    else if (BAD_PATH.test(m.localPath)) errs.push(`${m.name || m.id}: 本地产物路径含非法字符`)
+    if (!m.remotePath) errs.push(`${m.name || m.id}: 远程目标路径必填`)
+    else if (BAD_PATH.test(m.remotePath)) errs.push(`${m.name || m.id}: 远程目标路径含非法字符（禁止空格/引号/; & | \` $ 等）`)
+    if (m.postCommand && BAD_CMD.test(m.postCommand)) errs.push(`${m.name || m.id}: 远程命令含非法字符`)
+  }
+  return errs
+}
+
+export { MODULE_NAME, MODULE_ORDER, templateEnv, isNewSchema, normalizeEnv }