@mzzsfy/dsh-maintain 0.9.0 → 0.11.0

package/src/runtime.mjs

@@ -1,69 +0,0 @@
-// 运行环境检测:判定宿主进程是否处于托管启动形态,决定升级后可否自动重启。
-// 纯函数,探测点经参数注入;顺序:env 显式覆盖 > 进程环境表 > POSIX 容器探测 > 双 TTY > unknown。
-import { stat, readFile } from 'node:fs/promises'
-
-export const RUNTIME_KINDS = Object.freeze({
-  DECLARED_MANAGED: 'declared-managed',
-  PM2: 'pm2',
-  SYSTEMD: 'systemd',
-  SUPERVISORD: 'supervisord',
-  KUBERNETES: 'kubernetes',
-  DOCKER: 'docker',
-  CONTAINER: 'container',
-  MANUAL_START: 'manual-start-likely',
-  UNKNOWN: 'unknown',
-})
-
-// 环境覆盖键:managed|manual,测试与用户显式纠偏用
-const RUNTIME_ENV_OVERRIDE = 'DSH_MAINTAIN_RUNTIME_ENV'
-const OVERRIDE_MANAGED = 'managed'
-const OVERRIDE_MANUAL = 'manual'
-
-// 各托管形态的特征环境变量表:命中任一即声明
-const MANAGED_ENV_KEYS = Object.freeze([
-  [RUNTIME_KINDS.PM2, Object.freeze(['pm_id', 'PM2_HOME', 'pm_uptime'])],
-  [RUNTIME_KINDS.SYSTEMD, Object.freeze(['INVOCATION_ID', 'JOURNAL_STREAM', 'NOTIFY_SOCKET'])],
-  [RUNTIME_KINDS.SUPERVISORD, Object.freeze(['SUPERVISOR_ENABLED', 'SUPERVISOR_PROCESS_NAME'])],
-  [RUNTIME_KINDS.KUBERNETES, Object.freeze(['KUBERNETES_SERVICE_HOST'])],
-])
-
-const DOCKERENV_PATH = '/.dockerenv'
-const CGROUP_PATH = '/proc/1/cgroup'
-// cgroup 归类:/docker/ 与 dockerenv 同为 docker;kubepods 即 k8s;其余容器运行时归 container
-const CGROUP_DOCKER_PATTERN = /\/docker\//
-const CGROUP_K8S_PATTERN = /kubepods/
-const CGROUP_CONTAINER_PATTERN = /containerd|lxc|podman/
-
-const fallbackExists = async (path) => {
-  try {
-    await stat(path)
-    return true
-  } catch {
-    return false
-  }
-}
-
-const fallbackRead = async (path) => readFile(path, 'utf8')
-
-export async function detectRuntimeEnv({ env, platform, isTTY, existsImpl = fallbackExists, readFileImpl = fallbackRead }) {
-  const override = env[RUNTIME_ENV_OVERRIDE]
-  if (override === OVERRIDE_MANAGED) return { kind: RUNTIME_KINDS.DECLARED_MANAGED, declared: true }
-  if (override === OVERRIDE_MANUAL) return { kind: RUNTIME_KINDS.MANUAL_START, declared: false }
-
-  for (const [kind, keys] of MANAGED_ENV_KEYS) {
-    if (keys.some((key) => env[key])) return { kind, declared: true }
-  }
-
-  if (platform !== 'win32') {
-    try {
-      if (await existsImpl(DOCKERENV_PATH)) return { kind: RUNTIME_KINDS.DOCKER, declared: true }
-      const cgroup = await readFileImpl(CGROUP_PATH)
-      if (CGROUP_DOCKER_PATTERN.test(cgroup)) return { kind: RUNTIME_KINDS.DOCKER, declared: true }
-      if (CGROUP_K8S_PATTERN.test(cgroup)) return { kind: RUNTIME_KINDS.KUBERNETES, declared: true }
-      if (CGROUP_CONTAINER_PATTERN.test(cgroup)) return { kind: RUNTIME_KINDS.CONTAINER, declared: true }
-    } catch { /* 探测失败按未声明继续 */ }
-  }
-
-  if (isTTY.stdin === true && isTTY.stdout === true) return { kind: RUNTIME_KINDS.MANUAL_START, declared: false }
-  return { kind: RUNTIME_KINDS.UNKNOWN, declared: false }
-}

package/test/runtime.test.mjs

@@ -1,67 +0,0 @@
-import assert from 'node:assert/strict'
-import { test } from 'node:test'
-import { detectRuntimeEnv, RUNTIME_KINDS } from '../src/runtime.mjs'
-
-const POSIX = 'linux'
-const WIN32 = 'win32'
-const BOTH_TTY = { stdin: true, stdout: true }
-const NO_TTY = { stdin: false, stdout: false }
-const noProbes = { existsImpl: async () => false, readFileImpl: async () => { throw new Error('ENOENT') } }
-
-test('环境检测:env 覆盖最高优先', async () => {
-  const managed = await detectRuntimeEnv({ env: { DSH_MAINTAIN_RUNTIME_ENV: 'managed', pm_id: '0' }, platform: POSIX, isTTY: BOTH_TTY, ...noProbes })
-  assert.deepEqual(managed, { kind: RUNTIME_KINDS.DECLARED_MANAGED, declared: true })
-  const manual = await detectRuntimeEnv({ env: { DSH_MAINTAIN_RUNTIME_ENV: 'manual', pm_id: '0' }, platform: POSIX, isTTY: NO_TTY, ...noProbes })
-  assert.deepEqual(manual, { kind: RUNTIME_KINDS.MANUAL_START, declared: false })
-  // 非法覆盖值不生效,继续走常规判定
-  const bogus = await detectRuntimeEnv({ env: { DSH_MAINTAIN_RUNTIME_ENV: 'sideways' }, platform: POSIX, isTTY: NO_TTY, ...noProbes })
-  assert.deepEqual(bogus, { kind: RUNTIME_KINDS.UNKNOWN, declared: false })
-})
-
-test('环境检测:env 表命中各托管形态', async () => {
-  const table = [
-    [{ pm_id: '0' }, RUNTIME_KINDS.PM2],
-    [{ PM2_HOME: 'C:/pm2' }, RUNTIME_KINDS.PM2],
-    [{ pm_uptime: '123' }, RUNTIME_KINDS.PM2],
-    [{ INVOCATION_ID: 'x' }, RUNTIME_KINDS.SYSTEMD],
-    [{ JOURNAL_STREAM: '9' }, RUNTIME_KINDS.SYSTEMD],
-    [{ NOTIFY_SOCKET: '/run/notify' }, RUNTIME_KINDS.SYSTEMD],
-    [{ SUPERVISOR_ENABLED: '1' }, RUNTIME_KINDS.SUPERVISORD],
-    [{ SUPERVISOR_PROCESS_NAME: 'dsh' }, RUNTIME_KINDS.SUPERVISORD],
-    [{ KUBERNETES_SERVICE_HOST: '10.0.0.1' }, RUNTIME_KINDS.KUBERNETES],
-  ]
-  for (const [env, kind] of table) {
-    const result = await detectRuntimeEnv({ env, platform: POSIX, isTTY: NO_TTY, ...noProbes })
-    assert.deepEqual(result, { kind, declared: true }, JSON.stringify(env))
-  }
-  // 空串环境值不构成声明
-  const empty = await detectRuntimeEnv({ env: { pm_id: '' }, platform: POSIX, isTTY: NO_TTY, ...noProbes })
-  assert.deepEqual(empty, { kind: RUNTIME_KINDS.UNKNOWN, declared: false })
-})
-
-test('环境检测:POSIX 容器探测', async () => {
-  const docker = await detectRuntimeEnv({ env: {}, platform: POSIX, isTTY: NO_TTY, existsImpl: async (p) => p === '/.dockerenv', readFileImpl: async () => { throw new Error('ENOENT') } })
-  assert.deepEqual(docker, { kind: RUNTIME_KINDS.DOCKER, declared: true })
-  for (const [marker, kind] of [['/docker/', RUNTIME_KINDS.DOCKER], ['kubepods', RUNTIME_KINDS.KUBERNETES], ['containerd', RUNTIME_KINDS.CONTAINER], ['lxc', RUNTIME_KINDS.CONTAINER], ['podman', RUNTIME_KINDS.CONTAINER]]) {
-    const result = await detectRuntimeEnv({ env: {}, platform: POSIX, isTTY: NO_TTY, existsImpl: async () => false, readFileImpl: async () => '12:pids:/sys/fs/cgroup/' + marker + 'abc' })
-    assert.deepEqual(result, { kind, declared: true }, marker)
-  }
-  // 探测器异常不致命,继续后续判定
-  const broken = await detectRuntimeEnv({ env: {}, platform: POSIX, isTTY: NO_TTY, existsImpl: async () => { throw new Error('EACCES') }, readFileImpl: async () => { throw new Error('EACCES') } })
-  assert.deepEqual(broken, { kind: RUNTIME_KINDS.UNKNOWN, declared: false })
-})
-
-test('环境检测:win32 跳过 POSIX 探测', async () => {
-  const win = await detectRuntimeEnv({ env: {}, platform: WIN32, isTTY: NO_TTY, existsImpl: async () => true, readFileImpl: async () => '/docker/xyz' })
-  assert.deepEqual(win, { kind: RUNTIME_KINDS.UNKNOWN, declared: false })
-})
-
-test('环境检测:双 TTY 判手动直跑,单 TTY 不构成', async () => {
-  const both = await detectRuntimeEnv({ env: {}, platform: POSIX, isTTY: BOTH_TTY, ...noProbes })
-  assert.deepEqual(both, { kind: RUNTIME_KINDS.MANUAL_START, declared: false })
-  const stdinOnly = await detectRuntimeEnv({ env: {}, platform: POSIX, isTTY: { stdin: true, stdout: false }, ...noProbes })
-  assert.deepEqual(stdinOnly, { kind: RUNTIME_KINDS.UNKNOWN, declared: false })
-  // 托管声明优先于 TTY
-  const declaredWithTty = await detectRuntimeEnv({ env: { pm_id: '0' }, platform: POSIX, isTTY: BOTH_TTY, ...noProbes })
-  assert.deepEqual(declaredWithTty, { kind: RUNTIME_KINDS.PM2, declared: true })
-})