sage-mem 2.1.11 → 2.1.13
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +3 -1
- package/README.zh.md +3 -1
- package/lib/assembly/autodream-mount.js +6 -1
- package/lib/autodream/engine.js +46 -3
- package/lib/index.js +18 -18
- package/lib/memory/archive.js +14 -2
- package/lib/memory/config.js +29 -3
- package/lib/memory/lock.js +114 -32
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -12,7 +12,7 @@
|
|
|
12
12
|
|
|
13
13
|
**Cross-session memory for DeepSeek Harness — plain markdown files, no database, no worker.**
|
|
14
14
|
|
|
15
|
-
**Current release: `2.1.
|
|
15
|
+
**Current release: `2.1.13`** — the npm badge above is the dynamic source of truth. **Contract baseline: `1.0.0`** — the first stable release, whose public commitments, the capability boundaries and the list of things it explicitly cannot do are frozen in the
|
|
16
16
|
[frozen contract](https://github.com/gezi-wen/sage-mem/blob/main/docs/1.0.0-contract.md).
|
|
17
17
|
|
|
18
18
|
If it is useful to you, a Star is the most direct feedback.
|
|
@@ -420,6 +420,8 @@ The two things are moved **differently**, spelled out:
|
|
|
420
420
|
|
|
421
421
|
Value semantics: **out-of-range values are clamped to the boundary, illegal values (including pure whitespace) fall back to the default.**
|
|
422
422
|
|
|
423
|
+
**Scope of the state root, and migration (spelled out since 2.1.13).** `SAGE_MEM_STATE_DIR` is the **single** state root: settings, autodream configuration and reports, the lock table, the access ledger, the conflict queue, task checkpoints, rollback snapshots and its index all live under it, and every module (including the autodream engine and the lock table) resolves it from the same value instead of re-deriving `<parent of the memory directory>/.sage-mem`. **Changing the state root does not migrate old data**: the new root wins, the old `.sage-mem` is left untouched but no longer read, and startup prints one line naming what is still in the old root. Move it by hand if you want to keep it.
|
|
424
|
+
|
|
423
425
|
### What the Settings Page Can Change
|
|
424
426
|
|
|
425
427
|
The panel can change the five caps above (written to `<state directory>/settings.json`, precedence **settings page > environment variable > built-in default**), as well as reserved names (file names that are protected and that the settings page may not write or delete, written to `<state directory>/reserved.json`). **Some items take effect only after restarting DSH**, and the panel writes out both the value in effect now and the value after restart.
|
package/README.zh.md
CHANGED
|
@@ -14,7 +14,7 @@
|
|
|
14
14
|
|
|
15
15
|
> File-based cross-session memory for DeepSeek Harness — every memory is a plain markdown file you can open, edit and delete. No database, no worker, no port.
|
|
16
16
|
|
|
17
|
-
**当前发布版本:`2.1.
|
|
17
|
+
**当前发布版本:`2.1.13`** —— 顶部 npm 徽章是动态权威。**契约基线:`1.0.0`** —— 第一个稳定版,公开承诺、能力边界与「明确做不到」的清单冻结在
|
|
18
18
|
[契约冻结](https://github.com/gezi-wen/sage-mem/blob/main/docs/1.0.0-contract.md)。
|
|
19
19
|
|
|
20
20
|
如果它对你有用,给个 Star 是最直接的反馈。
|
|
@@ -420,6 +420,8 @@ sage-mem 给记忆目录的写入加了**版本守卫**:写入前记下当前
|
|
|
420
420
|
|
|
421
421
|
取值语义:**越界夹到边界,非法值(含纯空格)回落默认。**
|
|
422
422
|
|
|
423
|
+
**状态根的范围与迁移(2.1.13 起写清)**:`SAGE_MEM_STATE_DIR` 是**唯一的状态根** —— 设置、自动做梦配置与报告、锁表、访问台账、冲突队列、任务检查点、回滚快照、台账都在它下面,插件内所有模块(含自动做梦引擎与锁表)都从同一个值解析,不再各自按记忆目录的父目录去拼。**更改状态根不会自动迁移旧数据**:新根优先、旧的 `.sage-mem` 原样保留但不再读取,启动时会打印一行提示点名旧根里还有哪些数据;要保留请手动移动。
|
|
424
|
+
|
|
423
425
|
### 设置页里能改的
|
|
424
426
|
|
|
425
427
|
面板可改上面五个上限(写入 `<状态目录>/settings.json`,优先级 **设置页 > 环境变量 > 内置默认**),以及保留名(受保护、设置页不许写删的文件名,写入 `<状态目录>/reserved.json`)。**部分项要重启 DSH 才生效**,面板上会写清「当前生效 / 重启后」。
|
|
@@ -6,11 +6,16 @@
|
|
|
6
6
|
* 这是本插件唯一一处「降级而不是失败」的设计,理由就在这里。
|
|
7
7
|
*/
|
|
8
8
|
import { warnLog } from '../memory/util.js'
|
|
9
|
+
import { resolvePaths } from '../memory/config.js'
|
|
9
10
|
|
|
10
11
|
/** @param {object} ctx @param {{AutodreamEngine:Function, AutodreamGateway:Function, memoryDir:string, sessionsRoot:string, reservedFiles:string[]}} deps */
|
|
11
12
|
export function mountAutodream(ctx, { AutodreamEngine, AutodreamGateway, memoryDir, sessionsRoot, reservedFiles }) {
|
|
12
13
|
try {
|
|
13
|
-
|
|
14
|
+
// Q09:路径组在 `config.js` 里**一次**解析,这里显式把 stateRoot 交给引擎 ——
|
|
15
|
+
// 旧实现让引擎从 memoryDir 的父目录重拼 `.sage-mem`,于是 SAGE_MEM_STATE_DIR 只对
|
|
16
|
+
// 配置模块生效,面板与引擎各读一套(审查实测 engineRoot 指向默认根)。
|
|
17
|
+
const paths = resolvePaths({ memoryDir, sessionsRoot })
|
|
18
|
+
const engine = new AutodreamEngine(ctx, { ...paths, reservedFiles })
|
|
14
19
|
new AutodreamGateway(ctx, engine)
|
|
15
20
|
engine.start()
|
|
16
21
|
// 卸载时把定时器与锁收干净。effect 拿不到就交给 unref 兜底(不阻止进程退出)。
|
package/lib/autodream/engine.js
CHANGED
|
@@ -40,7 +40,9 @@ import { countSessionsSince, newRunId, stampHuman } from './util.js'
|
|
|
40
40
|
import { flushAccess, ledgerFileFor, pickArchiveCandidates, readAccessLedger } from '../memory/access.js'
|
|
41
41
|
import { archiveMemory } from '../memory/archive.js'
|
|
42
42
|
import { scanMemoryFiles } from '../memory/scan.js'
|
|
43
|
-
import {
|
|
43
|
+
import { resolveStateRoot } from '../memory/config.js'
|
|
44
|
+
import { basename, dirname, join } from 'node:path'
|
|
45
|
+
import { stat } from 'node:fs/promises'
|
|
44
46
|
|
|
45
47
|
import * as gateMod from './gate.js'
|
|
46
48
|
import * as llmloopMod from './llm-loop.js'
|
|
@@ -86,7 +88,18 @@ export class AutodreamEngine {
|
|
|
86
88
|
this.version = opts.version
|
|
87
89
|
/** 使用者自己声明的受保护文件名(`<状态根>/reserved.json`)——注入 prompt,绝不写死。 */
|
|
88
90
|
this.reservedFiles = Array.isArray(opts.reservedFiles) ? opts.reservedFiles : []
|
|
89
|
-
|
|
91
|
+
/**
|
|
92
|
+
* 状态根(Q09):装配方**显式传入**(`config.js` 的 `resolvePaths()` 一次解析);
|
|
93
|
+
* 直接构造引擎(单测 / 旧调用方)时按 `resolveStateRoot()` 派生 —— 两条路同一判据,
|
|
94
|
+
* 不再在这里 `dirname(memoryDir)` 重拼 `.sage-mem`。
|
|
95
|
+
*/
|
|
96
|
+
this.stateRoot = typeof opts.stateRoot === 'string' && opts.stateRoot !== ''
|
|
97
|
+
? opts.stateRoot
|
|
98
|
+
: resolveStateRoot(this.memoryDir)
|
|
99
|
+
/** 旧状态根:只有「本次状态根 ≠ 按记忆目录派生的那个」时才存在(迁移提示用)。 */
|
|
100
|
+
const derivedStateRoot = join(dirname(this.memoryDir), STATE_DIR)
|
|
101
|
+
this.legacyStateRoot = this.stateRoot === derivedStateRoot ? '' : derivedStateRoot
|
|
102
|
+
this._legacyStateReported = false
|
|
90
103
|
this.home = join(this.stateRoot, FEATURE_DIR)
|
|
91
104
|
this.configPath = join(this.stateRoot, 'autodream.json')
|
|
92
105
|
this.legacyConfigPath = join(this.stateRoot, LEGACY_STATE_FILE)
|
|
@@ -128,7 +141,37 @@ export class AutodreamEngine {
|
|
|
128
141
|
// ────────────────────────────── 配置与状态 ──────────────────────────────
|
|
129
142
|
|
|
130
143
|
// ── 配置与状态:实现在 lib/autodream/settings.js ──
|
|
131
|
-
async load() {
|
|
144
|
+
async load() {
|
|
145
|
+
const state = await settingsMod.load.call(this)
|
|
146
|
+
// 启动检查 / 面板打开都会走到 load():在这里提示一次「旧状态根还有数据」。
|
|
147
|
+
await this.checkLegacyStateRoot()
|
|
148
|
+
return state
|
|
149
|
+
}
|
|
150
|
+
|
|
151
|
+
/**
|
|
152
|
+
* Q09 的旧目录规则:**不自动迁移 + 启动提示一次**。
|
|
153
|
+
*
|
|
154
|
+
* 为什么不做自动迁移:状态根下住着配置、锁表、台账、冲突、检查点、快照六类数据,
|
|
155
|
+
* 自动搬移任何一类出错都可能让「锁」或「回滚点」在用户不知情时消失 —— 那是比
|
|
156
|
+
* 「旧数据暂时看不见」严重得多的损失。所以规则写成:**新状态根优先、旧数据留在原位、
|
|
157
|
+
* 明确告诉用户手动搬**。README 的措辞由 Lead 统一改,G4 只在报告里给出建议口径。
|
|
158
|
+
*/
|
|
159
|
+
async checkLegacyStateRoot() {
|
|
160
|
+
if (this._legacyStateReported || !this.legacyStateRoot) return
|
|
161
|
+
this._legacyStateReported = true
|
|
162
|
+
const legacy = this.legacyStateRoot
|
|
163
|
+
const markers = ['autodream.json', LEGACY_STATE_FILE, 'locked.json', 'access.json', 'settings.json', FEATURE_DIR, 'tasks', 'conflicts']
|
|
164
|
+
const found = []
|
|
165
|
+
for (const name of markers) {
|
|
166
|
+
if (await stat(join(legacy, name)).then(() => true, () => false)) found.push(basename(name))
|
|
167
|
+
}
|
|
168
|
+
if (found.length === 0) return
|
|
169
|
+
this.log('warn',
|
|
170
|
+
`检测到旧状态根 ${legacy} 仍有数据(${found.join(' / ')}),而本次状态根是 ${this.stateRoot}` +
|
|
171
|
+
'(SAGE_MEM_STATE_DIR 覆写)。本版不自动迁移:旧数据留在原位、不再读取 —— ' +
|
|
172
|
+
'需要保留请手动把要用的文件移到新状态根。')
|
|
173
|
+
}
|
|
174
|
+
|
|
132
175
|
async persist() { return settingsMod.persist.call(this) }
|
|
133
176
|
async getConfig() { return settingsMod.getConfig.call(this) }
|
|
134
177
|
async setConfig(patch) { return settingsMod.setConfig.call(this, patch) }
|
package/lib/index.js
CHANGED
|
@@ -19,7 +19,7 @@ import { readSnapshot, writeSnapshot } from './memory/write-protocol.js'
|
|
|
19
19
|
import { archiveMemory, archivedRevisionOf, deleteArchivedMemory, restoreMemory } from './memory/archive.js'
|
|
20
20
|
import { flushAccess, pickArchiveCandidates, readAccessLedger } from './memory/access.js'
|
|
21
21
|
import { serializeByKey, warnLog, writeFileAtomic } from './memory/util.js'
|
|
22
|
-
import {
|
|
22
|
+
import { readLockState, setLocked as setLockedImpl } from './memory/lock.js'
|
|
23
23
|
import { openMemoryFolder } from './memory/open-folder.js'
|
|
24
24
|
import { Remote, TypertRemoteService } from '@deepseek-ai/dsh-typert-protocol'
|
|
25
25
|
import { mkdir, unlink, writeFile } from 'node:fs/promises'
|
|
@@ -99,7 +99,9 @@ export class MemoryGateway extends TypertRemoteService {
|
|
|
99
99
|
|
|
100
100
|
/** 列出 memory 目录全部记忆文件(文件名 + 类型 + 描述 + 大小 + 自定义标签 + 是否锁定)。 */
|
|
101
101
|
async listFiles() {
|
|
102
|
-
const [files,
|
|
102
|
+
const [files, lockState] = await Promise.all([scanMemoryFiles(this.ctx, ''), readLockState(MEMORY_DIR)])
|
|
103
|
+
// Q05:锁表坏了也照样列文件,但不假装「都没锁」;逐条 locked 只有布尔,未知只能靠日志。
|
|
104
|
+
if (lockState.status === 'unknown') warnLog(this.ctx, `锁表不可读,列表里的锁定状态未知(不是「都没锁」):${lockState.reason}`)
|
|
103
105
|
return files.map(f => {
|
|
104
106
|
const meta = parseFrontmatter(f.content)
|
|
105
107
|
return {
|
|
@@ -109,7 +111,7 @@ export class MemoryGateway extends TypertRemoteService {
|
|
|
109
111
|
size: f.content.length,
|
|
110
112
|
tags: meta.tags,
|
|
111
113
|
// 锁定状态跟着每条一起给:卡片上的「锁定 / 已锁定」按钮要据此渲染
|
|
112
|
-
locked: locked.has(nameKey(f.file)),
|
|
114
|
+
locked: lockState.status === 'unknown' ? false : lockState.locked.has(nameKey(f.file)),
|
|
113
115
|
}
|
|
114
116
|
})
|
|
115
117
|
}
|
|
@@ -134,18 +136,11 @@ export class MemoryGateway extends TypertRemoteService {
|
|
|
134
136
|
}
|
|
135
137
|
|
|
136
138
|
/**
|
|
137
|
-
*
|
|
138
|
-
*
|
|
139
|
-
* 三道闸:保留名不可写、内容必须是字符串、体积有上限;落盘走原子写。
|
|
139
|
+
* 写(新增或覆盖)单个记忆文件。三道闸:保留名不可写、内容必须是字符串、体积有上限;落盘走原子写。
|
|
140
140
|
* 拒绝一律返回 { ok: false, error }(不是抛异常)——设置页的调用方按 ok 判定。
|
|
141
|
-
*
|
|
142
|
-
*
|
|
143
|
-
*
|
|
144
|
-
* 当前内容逐字节不变(面板保留草稿,提示重新应用);
|
|
145
|
-
* · `{ create: true }`:新建语义(createIfAbsent)。撞名 → `{ok:false, code:'already_exists'}`,
|
|
146
|
-
* **绝不**覆盖已有正文;
|
|
147
|
-
* · 不传 `opts`:旧调用方照旧覆盖,但会落一条 warn(additive 契约里只保留兼容,不保留静默)。
|
|
148
|
-
* 成功时回 `revision`(落盘后的新版本),调用方可以直接拿它继续保存。
|
|
141
|
+
* 2.1.2(Q02)新增可选第三参 `opts`:`{ expectedRevision }` 对不上 → `stale_revision`(当前内容逐字节
|
|
142
|
+
* 不变,面板保留草稿);`{ create: true }` 撞名 → `already_exists`(绝不覆盖);不传 opts 走旧行为但落
|
|
143
|
+
* 一条 warn(additive 契约只保留兼容,不保留静默)。成功时回 `revision`(落盘后的新版本)。
|
|
149
144
|
*/
|
|
150
145
|
async writeFile(name, content, opts) {
|
|
151
146
|
// 保留名判定放在最前面、且以 nameKey 归一:'memory.md' / 'MEMORY.MD' /
|
|
@@ -408,11 +403,13 @@ export class MemoryGateway extends TypertRemoteService {
|
|
|
408
403
|
|
|
409
404
|
async archiveCandidates() {
|
|
410
405
|
await flushAccess(MEMORY_DIR)
|
|
411
|
-
const [ledger, files,
|
|
406
|
+
const [ledger, files, lockState] = await Promise.all([
|
|
412
407
|
readAccessLedger(),
|
|
413
408
|
scanMemoryFiles(this.ctx, ''),
|
|
414
|
-
|
|
409
|
+
readLockState(MEMORY_DIR),
|
|
415
410
|
])
|
|
411
|
+
// Q05:锁表不可读时如实标记(候选清单仍可看,自动归档由 archiveMemory 直接拒绝)。
|
|
412
|
+
if (lockState.status === 'unknown') warnLog(this.ctx, `锁表不可读,候选清单的锁定状态未知(自动归档会拒绝执行):${lockState.reason}`)
|
|
416
413
|
const cfg = await autodreamConfigSnapshot()
|
|
417
414
|
const thresholds = {
|
|
418
415
|
project: cfg.archiveAfterDaysProject,
|
|
@@ -420,14 +417,17 @@ export class MemoryGateway extends TypertRemoteService {
|
|
|
420
417
|
user: cfg.archiveAfterDaysUser,
|
|
421
418
|
}
|
|
422
419
|
// 锁表交给候选计算:锁上的记忆一个都不选(用户对**单条**记忆说的话优先于阈值)。
|
|
423
|
-
const candidates = pickArchiveCandidates(files, ledger, { thresholds, locked })
|
|
420
|
+
const candidates = pickArchiveCandidates(files, ledger, { thresholds, locked: lockState.locked })
|
|
424
421
|
return {
|
|
425
422
|
count: candidates.length,
|
|
426
423
|
candidates,
|
|
427
424
|
autoArchive: cfg.autoArchive,
|
|
428
425
|
thresholds,
|
|
429
426
|
// 面板要显示「哪些锁着」,所以把锁表也带回去(已按 nameKey 归一)
|
|
430
|
-
locked: [...locked],
|
|
427
|
+
locked: [...lockState.locked],
|
|
428
|
+
// Q05:保护状态未知时明确标出来,不把「不知道」渲染成「都没锁」。
|
|
429
|
+
lockedUnknown: lockState.status === 'unknown',
|
|
430
|
+
lockedError: lockState.reason,
|
|
431
431
|
}
|
|
432
432
|
}
|
|
433
433
|
|
package/lib/memory/archive.js
CHANGED
|
@@ -19,7 +19,7 @@ import { ARCHIVE_DIR_NAME, addArchiveMeta, inspectDir, inspectMemoryEntry, local
|
|
|
19
19
|
import { isReserved, nameKey, safeName } from './naming.js'
|
|
20
20
|
import { revisionOf } from './chunks.js'
|
|
21
21
|
import { retireTaken, returnSource, takeOverSource, writeFileAtomic, writeFileExclusive } from './util.js'
|
|
22
|
-
import {
|
|
22
|
+
import { readLockState } from './lock.js'
|
|
23
23
|
import { ensureIndexEntry, dropIndexEntry } from './index-file.js'
|
|
24
24
|
import { mkdir, readFile, rm, stat } from 'node:fs/promises'
|
|
25
25
|
import { basename, join } from 'node:path'
|
|
@@ -54,8 +54,20 @@ export async function archiveMemory(memoryDir, name, reason, at = localStamp())
|
|
|
54
54
|
/**
|
|
55
55
|
* 「锁定」优先于一切:锁上的记忆**自动与手动都不许归档**。
|
|
56
56
|
* 放在最前面判 —— 名字合法之后立刻拒绝,不读目录、不算理由。
|
|
57
|
+
*
|
|
58
|
+
* ⚠️ 2.1.12(Q05):锁表读不出来时**不猜**。旧实现把「保护状态未知」当成空表,
|
|
59
|
+
* 于是坏表会让受保护的记忆照常被移走。现在未知 = 拒绝归档(危险操作暂停),
|
|
60
|
+
* 错误码 `lock-unknown` 让调用方/报告能说清是「锁表坏了」而不是「文件有问题」。
|
|
57
61
|
*/
|
|
58
|
-
|
|
62
|
+
const lock = await readLockState(memoryDir)
|
|
63
|
+
if (lock.status === 'unknown') {
|
|
64
|
+
return {
|
|
65
|
+
ok: false,
|
|
66
|
+
code: 'lock-unknown',
|
|
67
|
+
error: `sage-mem: 锁表不可读(${lock.reason}),无法确认这条记忆是否受保护,拒绝归档:${safe}`,
|
|
68
|
+
}
|
|
69
|
+
}
|
|
70
|
+
if (lock.locked.has(nameKey(safe))) {
|
|
59
71
|
return { ok: false, code: 'locked', error: `sage-mem: locked, refusing to archive: ${safe}(先在界面里解锁)` }
|
|
60
72
|
}
|
|
61
73
|
const src = join(memoryDir, safe)
|
package/lib/memory/config.js
CHANGED
|
@@ -22,11 +22,37 @@ export const SESSIONS_ROOT = process.env.DSH_HOME ? join(process.env.DSH_HOME, '
|
|
|
22
22
|
* 状态根:配置、锁表、台账、冲突、检查点、快照都住在这里。
|
|
23
23
|
*
|
|
24
24
|
* `SAGE_MEM_STATE_DIR` 显式覆写优先;没设时跟着记忆目录走(它的上一层 + `.sage-mem`)。
|
|
25
|
-
* ⚠️ Q09
|
|
26
|
-
*
|
|
25
|
+
* ⚠️ Q09:**所有子模块都必须经 `resolveStateRoot()` / `resolvePaths()` 取**,不许各自
|
|
26
|
+
* `dirname(memoryDir)` + 拼 `.sage-mem` —— 那样覆写只对一部分模块生效,面板与引擎会各读一套。
|
|
27
27
|
*/
|
|
28
|
-
export
|
|
28
|
+
export function resolveStateRoot(memoryDir = MEMORY_DIR) {
|
|
29
|
+
// 默认记忆目录直接用装配期算好的 STATE_ROOT(含 SAGE_MEM_STATE_DIR 覆写);
|
|
30
|
+
// 调用方显式传了**别的**目录(autodream 单测 / 多库场景)时,状态跟着那个目录走 ——
|
|
31
|
+
// 否则一个全局环境变量会把互不相关的记忆库的锁表 / 快照全灌进同一个目录。
|
|
32
|
+
if (memoryDir === MEMORY_DIR) return process.env.SAGE_MEM_STATE_DIR || join(dirname(MEMORY_DIR), '.sage-mem')
|
|
33
|
+
return join(dirname(memoryDir), '.sage-mem')
|
|
34
|
+
}
|
|
35
|
+
|
|
36
|
+
/**
|
|
37
|
+
* **装配时一次解析**的路径组(Q09)。
|
|
38
|
+
*
|
|
39
|
+
* 三个路径只在这里算一次,然后显式传给子模块 —— 引擎、锁表、台账、冲突、检查点、快照
|
|
40
|
+
* 不能再各自重拼。可显式覆写(测试 / 多库):
|
|
41
|
+
* - `memoryDir` 给了就用它;没给用模块常量
|
|
42
|
+
* - `stateRoot` 给了就用它;否则按 `resolveStateRoot(memoryDir)` 派生
|
|
43
|
+
* - `sessionsRoot` 给了(含空串)就用它;否则用模块常量
|
|
44
|
+
*/
|
|
45
|
+
export function resolvePaths(overrides = {}) {
|
|
46
|
+
const memoryDir = overrides.memoryDir || MEMORY_DIR
|
|
47
|
+
const stateRoot = typeof overrides.stateRoot === 'string' && overrides.stateRoot !== ''
|
|
48
|
+
? overrides.stateRoot
|
|
49
|
+
: resolveStateRoot(memoryDir)
|
|
50
|
+
const sessionsRoot = overrides.sessionsRoot !== undefined ? overrides.sessionsRoot : SESSIONS_ROOT
|
|
51
|
+
return { memoryDir, stateRoot, sessionsRoot }
|
|
52
|
+
}
|
|
29
53
|
|
|
54
|
+
export const PATHS = Object.freeze(resolvePaths())
|
|
55
|
+
export const STATE_ROOT = PATHS.stateRoot
|
|
30
56
|
/** 读一个整数型环境变量并在范围内收敛;取不到或非法就用默认值。 */
|
|
31
57
|
export function envInt(name, dflt, lo, hi) {
|
|
32
58
|
// ⚠️ 必须先 trim:`Number(' ')` 是 **0** 而不是 NaN,于是纯空格的值会被
|
package/lib/memory/lock.js
CHANGED
|
@@ -9,36 +9,112 @@
|
|
|
9
9
|
*
|
|
10
10
|
* 锁表按 `nameKey()` 归一存放:NTFS 不区分大小写,`User_Persona.MD` 与 `user_persona.md`
|
|
11
11
|
* 是同一个文件 —— 锁必须认得出这一点(与保留名保护同一套判据)。
|
|
12
|
+
*
|
|
13
|
+
* ── 2.1.12(外部审查 Q05)──────────────────────────────────────────────
|
|
14
|
+
* 旧实现两处硬伤,都已修:
|
|
15
|
+
* 1. 整文件 read-modify-write **没有排队**:两个并发上锁各自读到旧表,后写的把先写的
|
|
16
|
+
* 盖掉,而两边都报成功。原子 rename 只保证「不写半截」,不负责「合并两处修改」。
|
|
17
|
+
* 现在按锁表路径分键复用 `util.js` 的 `createWriteQueue()` 串行 RMW。
|
|
18
|
+
* 2. 读任何异常都返回空 Set —— 「保护状态未知」与「确实没有锁」因此无法区分,
|
|
19
|
+
* 自动归档会把**受保护**的记忆当成没锁继续删。现在只有 ENOENT 算「确实没有锁」;
|
|
20
|
+
* 坏 JSON / 权限失败 / 路径是目录……一律 `status:'unknown'`,危险操作据此暂停。
|
|
12
21
|
*/
|
|
13
22
|
import { mkdir, readFile } from 'node:fs/promises'
|
|
14
23
|
import { dirname, join } from 'node:path'
|
|
15
24
|
import { nameKey } from './naming.js'
|
|
16
|
-
import {
|
|
25
|
+
import { resolveStateRoot } from './config.js'
|
|
26
|
+
import { createWriteQueue, writeFileAtomic } from './util.js'
|
|
17
27
|
|
|
18
|
-
/**
|
|
19
|
-
|
|
20
|
-
|
|
28
|
+
/**
|
|
29
|
+
* 锁表文件:状态根下,与记忆文件分开。
|
|
30
|
+
*
|
|
31
|
+
* ⚠️ Q09:状态根必须经 `config.js` 的 `resolveStateRoot()` 解析(尊重 `SAGE_MEM_STATE_DIR`),
|
|
32
|
+
* 不许在这里 `dirname(memoryDir)` + 拼 `.sage-mem` —— 旧写法让「状态目录覆写」只对一部分
|
|
33
|
+
* 模块生效,于是面板读的锁表与引擎写的是两份。装配期显式给了 `stateRoot` 就用它。
|
|
34
|
+
*/
|
|
35
|
+
export function lockFileOf(memoryDir, stateRoot) {
|
|
36
|
+
const root = typeof stateRoot === 'string' && stateRoot !== '' ? stateRoot : resolveStateRoot(memoryDir)
|
|
37
|
+
return join(root, 'locked.json')
|
|
21
38
|
}
|
|
22
39
|
|
|
23
40
|
/**
|
|
24
|
-
*
|
|
25
|
-
*
|
|
41
|
+
* 锁表的**进程内串行队列**,按锁表路径分键(不同记忆目录互不阻塞)。
|
|
42
|
+
*
|
|
43
|
+
* ⚠️ 边界与 `util.js` 的说明一致:进程内串行,不是跨进程文件锁。真实并发(面板 remote、
|
|
44
|
+
* 模型工具、归档策略)都在同一个插件进程里;同时开两个 DSH 实例写同一个记忆目录时仍可能
|
|
45
|
+
* 丢一次 —— 那要另加文件锁,本版明确不做。
|
|
26
46
|
*/
|
|
27
|
-
|
|
47
|
+
const lockQueues = new Map()
|
|
48
|
+
function lockQueueFor(file) {
|
|
49
|
+
let queue = lockQueues.get(file)
|
|
50
|
+
if (!queue) {
|
|
51
|
+
queue = createWriteQueue()
|
|
52
|
+
lockQueues.set(file, queue)
|
|
53
|
+
}
|
|
54
|
+
return queue
|
|
55
|
+
}
|
|
56
|
+
|
|
57
|
+
/**
|
|
58
|
+
* 读锁表**原始对象**,区分「确实没有」与「不知道」。
|
|
59
|
+
*
|
|
60
|
+
* @returns {Promise<{status:'ok'|'missing'|'unknown', table:object, reason:string}>}
|
|
61
|
+
*/
|
|
62
|
+
async function readLockTable(memoryDir) {
|
|
63
|
+
let text
|
|
28
64
|
try {
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
|
|
65
|
+
text = await readFile(lockFileOf(memoryDir), 'utf8')
|
|
66
|
+
} catch (err) {
|
|
67
|
+
// 只有 ENOENT 可以当空表:文件不存在 = 一次锁都没上过。
|
|
68
|
+
if (err?.code === 'ENOENT') return { status: 'missing', table: {}, reason: '' }
|
|
69
|
+
return { status: 'unknown', table: {}, reason: `读锁表失败(${err?.code || err?.message})` }
|
|
70
|
+
}
|
|
71
|
+
let parsed
|
|
72
|
+
try {
|
|
73
|
+
parsed = JSON.parse(text)
|
|
74
|
+
} catch (err) {
|
|
75
|
+
return { status: 'unknown', table: {}, reason: `锁表不是合法 JSON(${err?.message ?? err})` }
|
|
76
|
+
}
|
|
77
|
+
if (!parsed || typeof parsed !== 'object' || Array.isArray(parsed)) {
|
|
78
|
+
return { status: 'unknown', table: {}, reason: '锁表不是 JSON 对象' }
|
|
79
|
+
}
|
|
80
|
+
return { status: 'ok', table: parsed, reason: '' }
|
|
81
|
+
}
|
|
82
|
+
|
|
83
|
+
/**
|
|
84
|
+
* 读锁状态 —— **安全路径唯一该用的读口**。
|
|
85
|
+
*
|
|
86
|
+
* - `{status:'ok', locked:Set}`:读到有效表(可能为空)
|
|
87
|
+
* - `{status:'missing', locked:Set()}`:锁表不存在 = 确实没有锁
|
|
88
|
+
* - `{status:'unknown', locked:Set(), reason}`:保护状态**未知**,自动归档必须暂停
|
|
89
|
+
*
|
|
90
|
+
* ⚠️ `unknown` 时返回的 `locked` 是**空集合**,但它不表示「没有锁」;调用方必须先看
|
|
91
|
+
* `status`,拿它当空表用就是把 Q05 原样放回去。
|
|
92
|
+
*/
|
|
93
|
+
export async function readLockState(memoryDir) {
|
|
94
|
+
const read = await readLockTable(memoryDir)
|
|
95
|
+
if (read.status === 'unknown') return { status: 'unknown', locked: new Set(), reason: read.reason }
|
|
96
|
+
const out = new Set()
|
|
97
|
+
for (const [k, v] of Object.entries(read.table)) {
|
|
98
|
+
if (v === true) out.add(nameKey(k))
|
|
38
99
|
}
|
|
100
|
+
return { status: read.status, locked: out, reason: '' }
|
|
39
101
|
}
|
|
40
102
|
|
|
41
|
-
/**
|
|
103
|
+
/**
|
|
104
|
+
* 兼容出口:只要集合的调用方用这个。
|
|
105
|
+
*
|
|
106
|
+
* 与 `readLockState` 的差别只有一条:`unknown` 时**抛** `LOCK_TABLE_UNKNOWN`,而不是
|
|
107
|
+
* 返回空 Set —— 返回空 Set 正是「坏表当全解锁」这个 bug 的入口。缺文件仍返回空 Set。
|
|
108
|
+
*/
|
|
109
|
+
export async function readLockSet(memoryDir) {
|
|
110
|
+
const state = await readLockState(memoryDir)
|
|
111
|
+
if (state.status === 'unknown') {
|
|
112
|
+
throw Object.assign(new Error(`sage-mem: ${state.reason}`), { code: 'LOCK_TABLE_UNKNOWN', reason: state.reason })
|
|
113
|
+
}
|
|
114
|
+
return state.locked
|
|
115
|
+
}
|
|
116
|
+
|
|
117
|
+
/** 这条记忆锁上了吗。`unknown` 时抛错(调用方不能把「不知道」当成「没锁」)。 */
|
|
42
118
|
export async function isLocked(memoryDir, name) {
|
|
43
119
|
return (await readLockSet(memoryDir)).has(nameKey(name))
|
|
44
120
|
}
|
|
@@ -46,23 +122,29 @@ export async function isLocked(memoryDir, name) {
|
|
|
46
122
|
/**
|
|
47
123
|
* 上锁 / 解锁。
|
|
48
124
|
*
|
|
49
|
-
*
|
|
50
|
-
*
|
|
51
|
-
*
|
|
125
|
+
* RMW 全程在**按锁表路径分键的进程内队列**里:读最新表 → 改一项 → 原子写回。
|
|
126
|
+
* 并发的不同文件因此逐条合并,不再互相覆盖。
|
|
127
|
+
*
|
|
128
|
+
* 坏表上**拒绝写入**(`{ok:false, code:'lock-table-unknown'}`),而不是把表重置成空表 ——
|
|
129
|
+
* 后者会静默抹掉用户的全部保护状态,比「这次没锁上」严重得多。
|
|
52
130
|
*/
|
|
53
131
|
export async function setLocked(memoryDir, name, locked) {
|
|
54
132
|
const key = nameKey(name)
|
|
55
133
|
const file = lockFileOf(memoryDir)
|
|
56
|
-
|
|
57
|
-
|
|
58
|
-
|
|
59
|
-
|
|
60
|
-
|
|
61
|
-
|
|
62
|
-
|
|
63
|
-
|
|
64
|
-
|
|
65
|
-
|
|
66
|
-
|
|
67
|
-
|
|
134
|
+
return lockQueueFor(file)(async () => {
|
|
135
|
+
const read = await readLockTable(memoryDir)
|
|
136
|
+
if (read.status === 'unknown') {
|
|
137
|
+
return {
|
|
138
|
+
ok: false,
|
|
139
|
+
code: 'lock-table-unknown',
|
|
140
|
+
error: `sage-mem: 锁表不可读(${read.reason}),本次没有写入,也不会把它重置成空表:${name}`,
|
|
141
|
+
}
|
|
142
|
+
}
|
|
143
|
+
const table = { ...read.table }
|
|
144
|
+
if (locked) table[key] = true
|
|
145
|
+
else delete table[key]
|
|
146
|
+
await mkdir(dirname(file), { recursive: true })
|
|
147
|
+
await writeFileAtomic(file, JSON.stringify(table, null, 2) + '\n')
|
|
148
|
+
return { ok: true, file: name, locked: !!locked }
|
|
149
|
+
})
|
|
68
150
|
}
|
package/package.json
CHANGED