dsh-multimodal-node 0.0.0-stage → 0.2.2

package/lib/config.js

@@ -0,0 +1,377 @@
+/**
+ * 多模态节点 —— 配置与持久化。
+ *
+ * 一个插件，两种身份：
+ *
+ *   service（服务节点）—— 这台机器有显卡。它开门：API 接入端口给脚本/别的 DSH 用，
+ *                          网页端口给人用，另加 ComfyUI 板块与 Blender 板块的实际端口托管。
+ *   user（用户节点）   —— 这台机器只是客户端。它不出门：填服务节点的公网地址 + apikey，
+ *                          侧边栏里拿模板、看队列、看模型，产物落本机目录。
+ *
+ * 模式是唯一的顶层开关，两套 UI 与两套监听行为都由它派生。端口沿用 03 号插件已有的两个
+ * 存储键（`listen` = API 接入端口，`remote` = 网页端口），因为 03 的网关、控制台、页面
+ * 全读这两个键——换成新键名只会让 18k 行底座跟着改，收益为零。
+ */
+import { mkdir, readFile, writeFile, rename } from 'node:fs/promises';
+import { homedir } from 'node:os';
+import { dirname, isAbsolute, join, resolve } from 'node:path';
+
+export const PLUGIN_ID = 'dsh-multimodal-node';
+export const MODES = ['service', 'user'];
+
+export function defaultDataDir() {
+    const base = process.env.DSH_HOME ?? join(homedir(), '.dsh');
+    return join(base, 'data', PLUGIN_ID);
+}
+
+/** 用户节点默认的产物目录：本机一个明确可见的地方，而不是散在 ComfyUI 的 output 里。 */
+export function defaultOutputDir() {
+    const base = process.env.DSH_HOME ?? join(homedir(), '.dsh');
+    return join(base, 'media', PLUGIN_ID);
+}
+
+export function defaultSettings() {
+    return {
+        /**
+         * 工作模式：service | user。
+         *
+         * 默认 service：新装的机器更可能是「有卡的那台」，而且用户节点必须填公网地址才有意义，
+         * 缺地址的用户节点是一个什么都点不动的页面。
+         */
+        mode: 'service',
+
+        /** API 接入端口（其他机器 / 脚本 / 别的 DSH 把 JSON POST 到这里）。 */
+        listen: {
+            enabled: true,
+            host: '0.0.0.0',
+            port: 8287,
+        },
+        /** fifo | dynamic —— 只影响排序，两种都经过任务池。 */
+        dynamic: true,
+        /** 任务排队超过这个秒数没有空闲实例就提示，不静默挂着。 */
+        stallWarnSec: 120,
+        /** 实例健康探测间隔，ms。 */
+        probeMs: 4000,
+        /** 合并历史保留多少条完成记录。 */
+        historyItems: 120,
+        /**
+         * 固定提示词表头。控制台把「表头」和「人写的那句」分成两个框，送出前用 ", " 拼。
+         * 真正的生效值是每个工作流自己的 heads；这里只是新建工作流时的默认值。
+         */
+        promptHeads: {
+            positive: 'masterpiece, best quality, very awa, absurdres, highres',
+            negative:
+                'worst quality, low quality, normal quality, lowres, bad anatomy, bad hands, ' +
+                'signature, watermarks, ugly, imperfect eyes, extra limb, missing limbs',
+        },
+        /** 自然语言助手读参考资料的来源。 */
+        promptKb: {
+            kbName: '提示词',
+            root: '',
+            dir: '',
+            excerptBytes: 6000,
+        },
+        /** 助手按哪个提示词技能选词。 */
+        promptSkill: {
+            name: 'pony-prompt-engineering',
+            dir: '',
+            maxBytes: 12000,
+            includeReferences: true,
+        },
+        /** 网页端口 + 网页账号 + 会话（03 号插件的控制台原样沿用）。 */
+        remote: {
+            enabled: true,
+            host: '0.0.0.0',
+            port: 8286,
+            requireCode: true,
+            assistant: true,
+            secret: '',
+            accounts: [],
+            sessions: [],
+            failures: [],
+        },
+        /**
+         * 服务节点的 API 侧凭据。
+         *
+         * apikey 与网页账号是**两套凭据**，故意不合并：网页账号是人用的（用户名+密码+配对码），
+         * apikey 是程序用的（一个 Bearer 串，可轮换、可停用、可分级）。把它们塞进同一张表，
+         * 结局一定是「脚本拿到了一个能登进网页的密码」。
+         */
+        service: {
+            /** 关掉时 API 端口不校验凭据（家庭内网、纯本机脚本用）。开着才认 apikey。 */
+            requireKey: false,
+            /**
+             * 每个 key: { key, name, tier: 'sfw'|'nsfw', enabled, createdAt, lastUsedAt, note }
+             * tier 决定这个 key 能看到/提交什么：SFW 的 key 提交成人工作流会被拒。
+             */
+            apiKeys: [],
+            /** 公网暴露时的提示语，纯展示。 */
+            publicHint: '',
+        },
+        /** 用户节点：服务节点在哪、用哪个 key、产物落哪。 */
+        node: {
+            /** 服务节点的 API 接入地址，如 https://node.example.com:8287 或 http://1.2.3.4:8287 */
+            publicUrl: '',
+            /** 服务节点签发的 apikey。 */
+            apiKey: '',
+            /** 本机产物文件夹（绝对路径）。空 = defaultOutputDir()。 */
+            outputDir: '',
+            /** 连接时带上的显示名，方便服务端审计里认出是谁。 */
+            label: '',
+            /** 拉取模板/模型/队列的超时，ms。 */
+            timeoutMs: 15000,
+        },
+        /**
+         * Blender 板块。
+         *
+         * 一个实例 = 一个可提交渲染的地方，两种托管：
+         *   bridge —— 那台机器上跑着一个 HTTP 端点（自带 addon / 小服务），POST 提交渲染。
+         *   spawn  —— 本机 blender.exe 命令行渲染（-b file.blend -o 前缀 -f 帧）。
+         * 健康判据因此不同：bridge 探 HTTP，spawn 看可执行文件与进程。
+         */
+        blender: {
+            enabled: true,
+            /** 本机 blender.exe 路径；不给就按 PATH 与常见安装位置找。 */
+            executable: '',
+            /** 渲染产物默认目录；空 = 用户节点产物目录/blender */
+            outputDir: '',
+            instances: [
+                {
+                    id: 'b9876',
+                    label: 'Blender · 9876',
+                    kind: 'bridge',
+                    baseUrl: 'http://127.0.0.1:9876',
+                    token: '',
+                    weight: 1,
+                    maxConcurrent: 1,
+                    enabled: true,
+                    autoStart: false,
+                    control: { type: 'none', batPath: '', cwd: '', stopTimeoutMs: 15000, readyTimeoutMs: 120000, stopOnExit: false },
+                },
+            ],
+        },
+        /**
+         * 模型扫描：在 ComfyUI 板块里设定「模型文件夹地址」。
+         *
+         * 主来源是每个实例自己的 `modelsRoot`（一个实例一行，跟着实例走）；
+         * 这里是**额外**要扫的目录，给那些不在任何 ComfyUI 安装里的模型用
+         * （另一块盘、NAS 映射盘、整理到一半的下载目录）。
+         *
+         * 为什么不合并成一个列表：实例的 models 目录决定「这张卡能加载什么」，
+         * 而额外目录只决定「面板上能看见什么」。混在一起，人就分不清
+         * 「我 GPU1 上到底有没有这个 LoRA」。
+         */
+        modelsScan: {
+            roots: [],
+            /** 扫描时最多递归几层（模型树通常 2 层，深了容易撞符号链接环）。 */
+            maxDepth: 4,
+            /** 单个目录最多返回多少个文件，防止一个巨量目录把面板拖死。 */
+            maxFilesPerFolder: 4000,
+        },
+        /** ComfyUI 实例：一个实例 = 一张卡 = 一个端口。 */
+        instances: [
+            {
+                id: 'p8188',
+                label: 'GPU0 · 8188',
+                baseUrl: 'http://127.0.0.1:8188',
+                apiKey: '',
+                weight: 1,
+                maxConcurrent: 1,
+                enabled: true,
+                autoStart: false,
+                modelsRoot: '',
+                control: { type: 'none', batPath: '', cwd: '', stopTimeoutMs: 15000, readyTimeoutMs: 300000, stopOnExit: true },
+            },
+            {
+                id: 'p8189',
+                label: 'GPU1 · 8189',
+                baseUrl: 'http://127.0.0.1:8189',
+                apiKey: '',
+                weight: 1,
+                maxConcurrent: 1,
+                enabled: true,
+                autoStart: false,
+                modelsRoot: '',
+                control: { type: 'none', batPath: '', cwd: '', stopTimeoutMs: 15000, readyTimeoutMs: 300000, stopOnExit: true },
+            },
+        ],
+    };
+}
+
+export class SettingsStore {
+    constructor(dataDir) {
+        this.dataDir = dataDir;
+        this.file = join(dataDir, 'settings.json');
+        this.value = defaultSettings();
+        /**
+         * 写盘串行链。
+         *
+         * 全插件只有一个 settings.json，而写它的主体有五个：面板设置、网页账号（auth）、
+         * API key、实例托管（onChange）、会话心跳（touch）。其中三个会在同一次请求里
+         * 各写一次——例如一次带 apikey 的登录同时更新 failures 与 lastUsedAt。
+         *
+         * 两次 rename 到同一个目标在 Windows 上是 EPERM operation not permitted，
+         * 在 Linux 上是抢同一个临时文件名；两种都表现为「设置偶发没保存」。
+         * 串行化是唯一可靠的修法——不靠调用方守规矩。
+         */
+        this.writing = Promise.resolve();
+    }
+
+    /**
+     * 排进写链。
+     *
+     * 链本身不能被一次失败卡死，但调用方要能看到自己的那次失败——所以链与返回值
+     * 是两个 promise，不是一个。
+     */
+    enqueue(work) {
+        const attempt = this.writing.then(work);
+        this.writing = attempt.catch(() => {});
+        return attempt;
+    }
+
+    async init() {
+        await mkdir(this.dataDir, { recursive: true });
+        try {
+            const raw = await readFile(this.file, 'utf8');
+            const parsed = JSON.parse(raw);
+            this.value = mergeSettings(defaultSettings(), parsed);
+        } catch {
+            this.value = defaultSettings();
+            await this.save();
+        }
+        return this.value;
+    }
+
+    get() {
+        return this.value;
+    }
+
+    /**
+     * 落盘。
+     *
+     * 快照在**入队时**取：如果等到执行时才 JSON.stringify(this.value)，
+     * 两次相邻 patch 都会序列化出「最后一次」的内容，前一次改动静默丢失。
+     * 临时文件名带序号，避免一个卡住的写入把下一次的临时文件占住。
+     */
+    async save() {
+        const snapshot = JSON.stringify(this.value, null, 2);
+        this.counter = (this.counter ?? 0) + 1;
+        const serial = this.counter;
+        return this.enqueue(async () => {
+            const temp = `${this.file}.${serial}.tmp`;
+            await mkdir(dirname(this.file), { recursive: true });
+            await writeFile(temp, `${snapshot}\n`, 'utf8');
+            await rename(temp, this.file);
+        });
+    }
+
+    async patch(next) {
+        const merged = mergeSettings(this.value, next ?? {});
+        this.value = merged;
+        await this.save();
+        return this.value;
+    }
+}
+
+/** 合并而不让一次 patch 抹掉没提到的字段（实例的未知字段、账号、配对 secret 都在此列）。 */
+export function mergeSettings(current, patch) {
+    const next = {
+        ...current,
+        ...(patch.listen !== undefined ? { listen: { ...current.listen, ...patch.listen } } : {}),
+        ...(typeof patch.dynamic === 'boolean' ? { dynamic: patch.dynamic } : {}),
+        ...(Number.isFinite(Number(patch.probeMs)) ? { probeMs: Math.min(60000, Math.max(500, Math.floor(Number(patch.probeMs)))) } : {}),
+        ...(Number.isFinite(Number(patch.historyItems)) ? { historyItems: Math.min(1000, Math.max(10, Math.floor(Number(patch.historyItems)))) } : {}),
+        ...(Number.isFinite(Number(patch.stallWarnSec)) ? { stallWarnSec: Math.max(10, Math.floor(Number(patch.stallWarnSec))) } : {}),
+    };
+    if (patch.mode === 'service' || patch.mode === 'user') next.mode = patch.mode;
+    if (Array.isArray(patch.instances)) {
+        next.instances = patch.instances.map((entry) => ({
+            ...entry,
+            control: { ...(entry.control ?? {}) },
+        }));
+    }
+    if (patch.promptHeads !== undefined && patch.promptHeads !== null && typeof patch.promptHeads === 'object') {
+        next.promptHeads = { ...(current.promptHeads ?? {}), ...patch.promptHeads };
+    }
+    if (patch.promptKb !== undefined && patch.promptKb !== null && typeof patch.promptKb === 'object') {
+        next.promptKb = { ...(current.promptKb ?? {}), ...patch.promptKb };
+    }
+    if (patch.promptSkill !== undefined && patch.promptSkill !== null && typeof patch.promptSkill === 'object') {
+        next.promptSkill = { ...(current.promptSkill ?? {}), ...patch.promptSkill };
+    }
+    if (patch.remote !== undefined && patch.remote !== null && typeof patch.remote === 'object') {
+        next.remote = { ...(current.remote ?? {}), ...patch.remote };
+    }
+    if (patch.service !== undefined && patch.service !== null && typeof patch.service === 'object') {
+        // 分层而非替换：一次只改 requireKey 的 patch 不能把整串 apikey 抹掉。
+        next.service = { ...(current.service ?? {}), ...patch.service };
+    }
+    if (patch.modelsScan !== undefined && patch.modelsScan !== null && typeof patch.modelsScan === 'object') {
+        // 分层：只改 maxDepth 的 patch 不能把整串扫描目录抹掉。
+        const nextScan = { ...(current.modelsScan ?? {}), ...patch.modelsScan };
+        if (Array.isArray(nextScan.roots)) {
+            // 目录去重 + 只留绝对路径：相对路径在「当前工作目录」下没有意义。
+            const seen = new Set();
+            nextScan.roots = nextScan.roots
+                .map((row) => String(row ?? '').trim())
+                .filter((row) => {
+                    if (row === '' || !isAbsolute(row) || seen.has(row)) return false;
+                    seen.add(row);
+                    return true;
+                });
+        }
+        next.modelsScan = nextScan;
+    }
+    if (patch.node !== undefined && patch.node !== null && typeof patch.node === 'object') {
+        next.node = normalizeNodeBlock({ ...(current.node ?? {}), ...patch.node });
+    }
+    if (patch.blender !== undefined && patch.blender !== null && typeof patch.blender === 'object') {
+        const merged = { ...(current.blender ?? {}), ...patch.blender };
+        if (Array.isArray(patch.blender.instances)) {
+            merged.instances = patch.blender.instances.map((entry) => ({
+                ...entry,
+                control: { ...(entry.control ?? {}) },
+            }));
+        }
+        next.blender = merged;
+    }
+    return next;
+}
+
+/** 用户节点的地址与 key 都要清洗：尾斜杠会让每条拼接路径变成双斜杠。 */
+export function normalizeNodeBlock(block) {
+    const next = { ...block };
+    if (typeof next.publicUrl === 'string') {
+        let text = next.publicUrl.trim();
+        while (text.endsWith('/')) text = text.slice(0, -1);
+        if (text !== '' && !/^https?:\/\//i.test(text)) text = `http://${text}`;
+        next.publicUrl = text;
+    }
+    if (typeof next.apiKey === 'string') next.apiKey = next.apiKey.trim();
+    if (typeof next.outputDir === 'string') next.outputDir = next.outputDir.trim();
+    if (typeof next.label === 'string') next.label = next.label.trim();
+    const timeout = Number(next.timeoutMs);
+    next.timeoutMs = Number.isFinite(timeout) ? Math.min(120000, Math.max(2000, Math.floor(timeout))) : 15000;
+    return next;
+}
+
+/** 从行配置里解析数据目录，绝对路径优先。 */
+export function resolveDataDir(configValue) {
+    const configured = typeof configValue?.dataDir === 'string' ? configValue.dataDir.trim() : '';
+    if (configured !== '' && isAbsolute(configured)) return resolve(configured);
+    return defaultDataDir();
+}
+
+/** 用户节点产物目录的最终值：填了用填的，没填用默认。 */
+export function resolveOutputDir(settingsValue) {
+    const configured = typeof settingsValue?.node?.outputDir === 'string' ? settingsValue.node.outputDir.trim() : '';
+    if (configured !== '' && isAbsolute(configured)) return resolve(configured);
+    return resolve(defaultOutputDir());
+}
+
+/** Blender 产物目录。 */
+export function resolveBlenderOutputDir(settingsValue) {
+    const configured = typeof settingsValue?.blender?.outputDir === 'string' ? settingsValue.blender.outputDir.trim() : '';
+    if (configured !== '' && isAbsolute(configured)) return resolve(configured);
+    return join(resolveOutputDir(settingsValue), 'blender');
+}