@qic-9821/dsh-plugin-sync 0.0.0-stage → 0.1.1

package/index.js

@@ -0,0 +1,210 @@
+import { Engine, readVersion } from './lib/engine.js'
+import { createRoutes } from './lib/http.js'
+
+export const name = '@qic-9821/dsh-plugin-sync'
+
+/**
+ * Config is optional: hosts without @deepseek-ai/schemastery must still load
+ * the plugin (they just lose the generated settings form).
+ */
+let z = null
+try {
+  const mod = await import('@deepseek-ai/schemastery')
+  z = mod?.default ?? mod ?? null
+} catch {
+  z = null
+}
+
+const field = (schema) => (typeof schema?.extra === 'function' ? schema.extra('volatile', true) : schema)
+
+export const Config = z
+  ? z.object({
+      enabled: field(z.boolean().default(true)),
+      autoStart: field(z.boolean().default(true)),
+      autoRestart: field(z.boolean().default(true)),
+      intervalMinutes: field(z.natural().default(0)),
+      startupDelaySec: field(z.natural().default(25)),
+      direction: field(z.string().default('push')),
+      conflict: field(z.string().default('local')),
+      peerMode: field(z.string().default('off')),
+      peerUrl: field(z.string().default('')),
+      peerToken: field(z.string().default('')),
+      peerName: field(z.string().default('')),
+      localName: field(z.string().default('')),
+      peerHost: field(z.string().default('')),
+      peerUser: field(z.string().default('')),
+      peerPort: field(z.natural().default(22)),
+      peerKey: field(z.string().default('')),
+      peerHttpPort: field(z.natural().default(18777)),
+      capPlugins: field(z.boolean().default(true)),
+      capConfig: field(z.boolean().default(false)),
+      capInstall: field(z.boolean().default(false)),
+      capFiles: field(z.boolean().default(false)),
+      capRemoteApply: field(z.boolean().default(true)),
+      capSecrets: field(z.boolean().default(false)),
+      include: field(z.array(z.string()).default([])),
+      exclude: field(z.array(z.string()).default([])),
+      profileDir: field(z.string().default('')),
+      maxBundleBytes: field(z.natural().default(48 * 1024 * 1024)),
+      timeoutMs: field(z.natural().default(60000)),
+    })
+  : undefined
+
+export const inject = ['tools']
+
+function pickLogger(logger) {
+  if (typeof logger?.info === 'function') return logger
+  return {
+    info: (...args) => console.log('[plugin-sync]', ...args),
+    warn: (...args) => console.warn('[plugin-sync]', ...args),
+    error: (...args) => console.error('[plugin-sync]', ...args),
+  }
+}
+
+export async function apply(ctx, config = {}) {
+  const logger = pickLogger(ctx?.logger)
+  const engine = new Engine({ ctx, config, env: process.env, logger })
+  engine.version = readVersion(new URL('./package.json', import.meta.url))
+
+  const disposers = []
+
+  if (typeof ctx?.tools?.register === 'function') {
+    try {
+      disposers.push(ctx.tools.register(pluginSyncToolSpec(engine)))
+      disposers.push(ctx.tools.register(pluginSyncConfigToolSpec(engine)))
+    } catch (error) {
+      logger.warn?.(`tool registration failed: ${error?.message || error}`)
+    }
+  }
+
+  const mountRoutes = (hostCtx) => {
+    const webServer = hostCtx?.webServer ?? hostCtx?.get?.('webServer')
+    if (!webServer || typeof webServer.register !== 'function') return
+    try {
+      const origin = typeof webServer.getOrigin === 'function' ? webServer.getOrigin() : ''
+      const routes = createRoutes({ engine, ctx, origin })
+      disposers.push(webServer.register({ kind: 'prefix', path: '/plugin-sync', handler: routes.handle }))
+    } catch (error) {
+      logger.warn?.(`web route registration failed: ${error?.message || error}`)
+    }
+  }
+
+  // On a cold boot a bundle row can be instantiated before the web server
+  // exists (the server rides a later row); acquiring it lazily keeps the row
+  // loading on profiles without a web UI too.
+  if (typeof ctx?.inject === 'function') {
+    disposers.push(ctx.inject(['webServer'], (hostCtx) => mountRoutes(hostCtx)))
+  } else {
+    mountRoutes(ctx)
+  }
+
+  try {
+    engine.schedule()
+  } catch (error) {
+    logger.warn?.(`schedule failed: ${error?.message || error}`)
+  }
+
+  const cfg = engine.cfg()
+  engine.log(`ready: profile=${engine.profileDir(cfg) || '?'} peer=${cfg.peerMode} caps=${['capPlugins', 'capConfig', 'capInstall', 'capFiles'].filter((key) => cfg[key]).join('+') || 'none'}`)
+
+  const dispose = async () => {
+    engine.dispose()
+    for (const disposer of disposers.reverse()) {
+      try {
+        disposer?.()
+      } catch {
+        // ignore teardown errors
+      }
+    }
+  }
+
+  ctx.effect?.(() => () => dispose(), 'dsh-plugin-sync: teardown')
+  return dispose
+}
+
+function pluginSyncToolSpec(engine) {
+  return {
+    name: 'plugin_sync',
+    description: [
+      'Inspect or run the cross-machine DSH plugin sync (inventory, configs, enable state, package installs, local plugin folders).',
+      'action="status" reports this machine, the peer and the last run.',
+      'action="plan" shows what a sync would change, without changing anything.',
+      'action="run" performs the sync now (respects the capability switches and the direction setting).',
+      'Use it when the user asks whether plugins are in sync, what would change, or asks to sync now.',
+    ].join('\n'),
+    parameters: {
+      type: 'object',
+      properties: {
+        action: { type: 'string', enum: ['status', 'plan', 'run'], description: 'status | plan | run' },
+        direction: {
+          type: 'string',
+          enum: ['push', 'pull', 'both', 'off'],
+          description: 'Override the configured direction for this call.',
+        },
+      },
+      required: ['action'],
+      additionalProperties: false,
+    },
+    timeoutMs: 600000,
+    output: {
+      schema: { type: 'object', additionalProperties: true },
+      render(_args, value) {
+        return [{ type: 'text', text: typeof value === 'string' ? value : JSON.stringify(value, null, 2) }]
+      },
+    },
+    async execute(args) {
+      const action = String(args?.action || 'status')
+      const direction = typeof args?.direction === 'string' ? args.direction : null
+      if (action === 'status') return engine.status()
+      if (action === 'plan') return engine.plan({ direction })
+      if (action === 'run') return engine.sync({ trigger: 'tool', direction })
+      return { ok: false, error: `unknown action: ${action}` }
+    },
+  }
+}
+
+function pluginSyncConfigToolSpec(engine) {
+  return {
+    name: 'plugin_sync_config',
+    description: [
+      'Read or update the plugin-sync settings: peer (http/ssh), capability switches, direction/conflict and schedule.',
+      'action="get" returns the current effective settings (the peer token is never returned).',
+      'action="set" merges a patch (any of: enabled, direction, conflict, peerMode, peerUrl, peerHost, peerUser, peerPort, peerKey, peerHttpPort, peerToken, capPlugins, capConfig, capInstall, capFiles, capRemoteApply, capSecrets, autoStart, autoRestart, intervalMinutes, startupDelaySec, include, exclude).',
+    ].join('\n'),
+    parameters: {
+      type: 'object',
+      properties: {
+        action: { type: 'string', enum: ['get', 'set'] },
+        patch: { type: 'object', additionalProperties: true, description: 'Settings to merge (action="set").' },
+      },
+      required: ['action'],
+      additionalProperties: false,
+    },
+    timeoutMs: 60000,
+    output: {
+      schema: { type: 'object', additionalProperties: true },
+      render(_args, value) {
+        return [{ type: 'text', text: typeof value === 'string' ? value : JSON.stringify(value, null, 2) }]
+      },
+    },
+    async execute(args) {
+      const action = String(args?.action || 'get')
+      if (action === 'get') {
+        const cfg = engine.cfg()
+        return {
+          ...cfg,
+          peerToken: cfg.peerToken ? '[set]' : '',
+          profileDir: engine.profileDir(cfg),
+        }
+      }
+      if (action === 'set') {
+        const patch = args?.patch && typeof args.patch === 'object' ? args.patch : {}
+        engine.updateState(patch)
+        engine.schedule()
+        const cfg = engine.cfg()
+        return { ok: true, ...cfg, peerToken: cfg.peerToken ? '[set]' : '' }
+      }
+      return { ok: false, error: `unknown action: ${action}` }
+    },
+  }
+}

package/lib/apply.js

@@ -0,0 +1,120 @@
+import { backupPatch, readPatchText, setRowConfig, writePatchText } from './patch.js'
+
+/**
+ * Executes merge ops against the *local* machine through the pluginManager
+ * service, so pnpm, the profile manifest and the loader stay authoritative.
+ * One failing op never aborts the rest; every result is reported.
+ */
+export async function applyPlan({ ctx, ops = [], cfg = {}, profileDir = null, log = () => {} }) {
+  const results = []
+  const pm = ctx?.get?.('pluginManager')
+  let patchBackedUp = false
+
+  for (const op of ops) {
+    const started = Date.now()
+    try {
+      if (op.kind === 'config') {
+        if (!cfg.capConfig) throw new Error('配置同步权限未开启')
+        if (!profileDir) throw new Error('找不到 profile 目录')
+        if (!patchBackedUp) {
+          const backup = backupPatch(profileDir, `${cfg.__backupDir || ''}`)
+          patchBackedUp = true
+          if (backup) log(`patch backup: ${backup}`)
+        }
+        const text = readPatchText(profileDir)
+        const rowId = op.rowId || op.name
+        const next = setRowConfig(text, rowId, op.config)
+        if (!next.changed) throw new Error(`cordis.patch.yml 里没有 ${rowId} 这一行`)
+        writePatchText(profileDir, next.text)
+        results.push(ok(op, '重启后生效'))
+        continue
+      }
+
+      if (!pm) throw new Error('pluginManager 服务不可用')
+
+      if (op.kind === 'install') {
+        if (!cfg.capInstall) throw new Error('安装/升级权限未开启')
+        const result = await pm.installBundle(op.spec, { enabled: op.enabled !== false })
+        results.push(fromChange(op, result))
+        continue
+      }
+      if (op.kind === 'upgrade') {
+        if (!cfg.capInstall) throw new Error('安装/升级权限未开启')
+        const result = await pm.updateBundle(op.name, op.version || undefined)
+        results.push(fromChange(op, result))
+        continue
+      }
+      if (op.kind === 'remove') {
+        if (!cfg.capInstall) throw new Error('卸载权限未开启')
+        const result = await pm.removeBundle(op.name)
+        results.push(fromChange(op, result))
+        continue
+      }
+      if (op.kind === 'enable' || op.kind === 'disable') {
+        if (!cfg.capPlugins) throw new Error('插件启停权限未开启')
+        const result = await pm.setBundleEnabled(op.name, op.kind === 'enable')
+        results.push(fromChange(op, result))
+        continue
+      }
+      if (op.kind === 'plugin-enable' || op.kind === 'plugin-disable') {
+        if (!cfg.capPlugins) throw new Error('插件启停权限未开启')
+        const result = await pm.setPluginEnabled(op.entryId, op.kind === 'plugin-enable')
+        results.push(fromChange(op, result))
+        continue
+      }
+      results.push({ ...fail(op, `未知操作: ${op.kind}`), ms: Date.now() - started })
+    } catch (error) {
+      results.push({ ...fail(op, describeError(error)), ms: Date.now() - started })
+    }
+  }
+
+  const failed = results.filter((item) => !item.ok)
+  return {
+    ok: failed.length === 0,
+    applied: results.filter((item) => item.ok).length,
+    failed: failed.length,
+    results,
+    restartRequired: results.some((item) => item.application === 'restart-required'),
+  }
+}
+
+function ok(op, note = null) {
+  return { ok: true, op: pick(op), application: 'applied', note }
+}
+
+function fail(op, error) {
+  return { ok: false, op: pick(op), error }
+}
+
+function pick(op) {
+  return { kind: op.kind, name: op.name ?? null, entryId: op.entryId ?? null, version: op.version ?? null }
+}
+
+/** pluginManager rejects with plain `{ code }` objects, so String() is useless. */
+export function describeError(error) {
+  if (!error) return '未知错误'
+  if (typeof error === 'string') return error
+  if (error instanceof Error) return error.message || error.name
+  if (typeof error.message === 'string' && error.message) return error.message
+  if (typeof error.code === 'string') return error.code
+  try {
+    const text = JSON.stringify(error)
+    return text && text !== '{}' ? (text.length > 300 ? `${text.slice(0, 300)}…` : text) : String(error)
+  } catch {
+    return String(error)
+  }
+}
+
+function fromChange(op, result) {
+  const r = result && typeof result === 'object' ? result : {}
+  return {
+    ok: r.application !== 'failed' && r.application !== 'cancelled',
+    op: pick(op),
+    application: r.application ?? 'applied',
+    restartReason: r.restartReason ?? null,
+    error: r.error ? describeError(r.error) : null,
+    warnings: Array.isArray(r.warnings) ? r.warnings.map(String) : [],
+    pendingBuilds: Array.isArray(r.pendingBuilds) ? r.pendingBuilds : [],
+    changed: r.changed !== false,
+  }
+}

package/lib/config.js

@@ -0,0 +1,228 @@
+import { homedir } from 'node:os'
+import { existsSync, readdirSync, readFileSync, mkdirSync, renameSync, writeFileSync } from 'node:fs'
+import { join } from 'node:path'
+
+export const PACKAGE_NAME = '@qic-9821/dsh-plugin-sync'
+export const LEGACY_PACKAGE_NAME = 'dsh-plugin-sync'
+
+const SECRET_KEY = /(secret|token|passw|apikey|api_key|credential|cookie|private_key|privatekey|authorization|access_key)/i
+
+export function dshHome(env = process.env) {
+  const explicit = env.DSH_HOME?.trim()
+  return explicit || join(homedir(), '.dsh')
+}
+
+export function stateDir(env = process.env) {
+  return join(dshHome(env), 'plugin-sync')
+}
+
+export function statePath(env = process.env) {
+  return join(stateDir(env), 'state.json')
+}
+
+export function backupDir(env = process.env) {
+  return join(stateDir(env), 'backups')
+}
+
+/**
+ * The running profile is the one whose package.json depends on this package.
+ * (A `file:` install keeps the module inside D:\dsh-plugins, so the module path
+ * says nothing about the profile.)
+ */
+export function resolveProfileDir(config = {}, env = process.env) {
+  if (typeof config.profileDir === 'string' && config.profileDir.trim()) return config.profileDir.trim()
+  if (env.DSH_PROFILE_DIR?.trim()) return env.DSH_PROFILE_DIR.trim()
+  const root = join(dshHome(env), 'profiles')
+  if (!existsSync(root)) return null
+  const candidates = []
+  for (const name of readdirSync(root)) {
+    const dir = join(root, name)
+    const manifestPath = join(dir, 'package.json')
+    if (!existsSync(manifestPath)) continue
+    try {
+      const manifest = JSON.parse(readFileSync(manifestPath, 'utf8'))
+      const deps = { ...(manifest.dependencies || {}), ...(manifest.devDependencies || {}) }
+      const hit = Boolean(deps[PACKAGE_NAME] || deps[PACKAGE_NAME] === '' || deps[LEGACY_PACKAGE_NAME] || deps[LEGACY_PACKAGE_NAME] === '')
+      candidates.push({ dir, name, hit, mtime: 0 })
+    } catch {
+      // ignore unreadable manifests
+    }
+  }
+  const hit = candidates.find((entry) => entry.hit)
+  if (hit) return hit.dir
+  if (config !== null && candidates.length === 1) return candidates[0].dir
+  return candidates.length > 0 ? candidates[candidates.length - 1].dir : null
+}
+
+export const DEFAULTS = {
+  enabled: true,
+  // schedule
+  autoStart: true,
+  autoRestart: true,
+  intervalMinutes: 0,
+  startupDelaySec: 25,
+  // direction / conflict
+  direction: 'push',
+  conflict: 'local',
+  // peer
+  peerMode: 'off',
+  peerUrl: '',
+  peerToken: '',
+  peerName: '',
+  localName: '',
+  peerHost: '',
+  peerUser: '',
+  peerPort: 22,
+  peerKey: '',
+  peerHttpPort: 18777,
+  // capabilities
+  capPlugins: true,
+  capConfig: false,
+  capInstall: false,
+  capFiles: false,
+  capRemoteApply: true,
+  capSecrets: false,
+  // scope
+  include: [],
+  exclude: [],
+  profileDir: '',
+  maxBundleBytes: 48 * 1024 * 1024,
+  timeoutMs: 60000,
+}
+
+export const CAPABILITY_KEYS = [
+  'capPlugins',
+  'capConfig',
+  'capInstall',
+  'capFiles',
+  'capRemoteApply',
+  'capSecrets',
+]
+
+export const CAPABILITY_LABELS = {
+  capPlugins: ['插件清单与启停', '同步安装了哪些插件、哪些开着', 'Plugin inventory and enable state'],
+  capConfig: ['插件配置', '同步每个插件在 cordis.patch.yml 里的配置项', 'Plugin config in cordis.patch.yml'],
+  capInstall: ['安装 / 升级 / 卸载', '在另一端跑 pnpm、改 node_modules、增删插件包', 'Install, upgrade and remove packages (pnpm)'],
+  capFiles: ['复制插件二进制', '把本机 file: 插件的源码目录打包传过去', 'Copy local plugin source folders'],
+  capRemoteApply: ['允许对端改动本机', '对端推过来的变更可以在本机落地', 'Allow the peer to change this machine'],
+  capSecrets: ['同步密钥字段', '（默认关）同步 appSecret / token 之类字段', 'Include secret-looking config fields'],
+}
+
+export const DIRECTION_LABELS = {
+  push: ['推送到对端', 'Push this machine to the peer'],
+  pull: ['从对端拉取', 'Pull the peer to this machine'],
+  both: ['双向合并', 'Merge both ways'],
+  off: ['只比较不改', 'Compare only'],
+}
+
+export function normalizeConfig(config = {}, env = process.env) {
+  const cfg = { ...DEFAULTS }
+  for (const [key, value] of Object.entries(config || {})) {
+    if (value === undefined || value === null) continue
+    if (key === 'peer' && typeof value === 'object') {
+      Object.assign(cfg, normalizePeer(value))
+      continue
+    }
+    cfg[key] = value
+  }
+  cfg.direction = ['push', 'pull', 'both', 'off'].includes(cfg.direction) ? cfg.direction : 'push'
+  cfg.conflict = ['local', 'peer', 'newest'].includes(cfg.conflict) ? cfg.conflict : 'peer'
+  cfg.peerMode = ['off', 'http', 'ssh'].includes(cfg.peerMode) ? cfg.peerMode : 'off'
+  cfg.intervalMinutes = clampNumber(cfg.intervalMinutes, 0, 24 * 60, 0)
+  cfg.startupDelaySec = clampNumber(cfg.startupDelaySec, 0, 600, 25)
+  cfg.peerPort = clampNumber(cfg.peerPort, 1, 65535, 22)
+  cfg.peerHttpPort = clampNumber(cfg.peerHttpPort, 1, 65535, 18777)
+  cfg.maxBundleBytes = clampNumber(cfg.maxBundleBytes, 1024 * 1024, 512 * 1024 * 1024, 48 * 1024 * 1024)
+  cfg.timeoutMs = clampNumber(cfg.timeoutMs, 5000, 600000, 60000)
+  cfg.include = Array.isArray(cfg.include) ? cfg.include.map(String).filter(Boolean) : []
+  cfg.exclude = Array.isArray(cfg.exclude) ? cfg.exclude.map(String).filter(Boolean) : []
+  return cfg
+}
+
+function normalizePeer(peer) {
+  const out = {}
+  if (typeof peer.mode === 'string') out.peerMode = peer.mode
+  if (typeof peer.url === 'string') out.peerUrl = peer.url
+  if (typeof peer.token === 'string') out.peerToken = peer.token
+  if (typeof peer.name === 'string') out.peerName = peer.name
+  if (typeof peer.host === 'string') out.peerHost = peer.host
+  if (typeof peer.user === 'string') out.peerUser = peer.user
+  if (peer.port !== undefined) out.peerPort = peer.port
+  if (typeof peer.key === 'string') out.peerKey = peer.key
+  if (peer.httpPort !== undefined) out.peerHttpPort = peer.httpPort
+  return out
+}
+
+export function clampNumber(value, min, max, fallback) {
+  const n = Number(value)
+  if (!Number.isFinite(n)) return fallback
+  return Math.min(max, Math.max(min, Math.trunc(n)))
+}
+
+export function isSecretKey(key) {
+  return SECRET_KEY.test(String(key))
+}
+
+/** Deep-clone a config object, replacing secret-looking leaves unless allowed. */
+export function filterConfig(value, { includeSecrets = false } = {}) {
+  if (Array.isArray(value)) return value.map((item) => filterConfig(item, { includeSecrets }))
+  if (!value || typeof value !== 'object') return value
+  const out = {}
+  for (const [key, item] of Object.entries(value)) {
+    if (!includeSecrets && isSecretKey(key)) {
+      out[key] = '[redacted]'
+      continue
+    }
+    out[key] = filterConfig(item, { includeSecrets })
+  }
+  return out
+}
+
+export function redactDeep(value) {
+  return filterConfig(value, { includeSecrets: false })
+}
+
+export function readState(env = process.env) {
+  const path = statePath(env)
+  try {
+    const parsed = JSON.parse(readFileSync(path, 'utf8'))
+    return parsed && typeof parsed === 'object' ? parsed : {}
+  } catch {
+    return {}
+  }
+}
+
+export function writeState(state, env = process.env) {
+  const dir = stateDir(env)
+  mkdirSync(dir, { recursive: true })
+  const path = statePath(env)
+  const tmp = `${path}.tmp`
+  writeFileSync(tmp, `${JSON.stringify(state, null, 2)}\n`, 'utf8')
+  renameSync(tmp, path)
+  return path
+}
+
+export function saveStatePatch(patch, env = process.env) {
+  const next = { ...readState(env), ...(patch || {}) }
+  writeState(next, env)
+  return next
+}
+
+export function effectiveConfig(config = {}, env = process.env) {
+  const state = readState(env)
+  const merged = { ...normalizeConfig(config, env) }
+  const allowed = new Set(Object.keys(DEFAULTS))
+  for (const [key, value] of Object.entries(state)) {
+    if (!allowed.has(key)) continue
+    if (typeof value === 'function') continue
+    merged[key] = value
+  }
+  return normalizeConfig(merged, env)
+}
+
+export function ensureStateDirs(env = process.env) {
+  const dir = stateDir(env)
+  mkdirSync(dir, { recursive: true })
+  mkdirSync(backupDir(env), { recursive: true })
+  return dir
+}