lark-relay 0.6.0 → 0.6.1

package/README.md

@@ -55,7 +55,6 @@ lark-relay status             # 谁在跑 / 各 app 收了多少 / 游标在哪
 日志直写 stderr,每行带 ISO 时间戳(launchd 场景重定向到
 `~/.lark-relay/logs/collect.err.log`)。不做轮转 —— 实测约 10MB/年,
 嫌大就 `> ~/.lark-relay/logs/collect.err.log` 截断(launchd 持有 fd,别 rm)。
-
 ### 常驻部署(macOS / launchd)
 
 要点三条,plist 自己写十来行就够:
@@ -84,6 +83,8 @@ lark-relay take --app <app> --chats oc_xxx --render text
 起来后 stderr 先打一行「监听中」-- 没这行就是没起来,看 stderr 报错。
 退出码:0=有一批,4=超时没消息(正常,再起一个),2=参数错,3=游标被占用。
 参数拼错(如 `--chat-id`)会硬失败并给出正确写法,不静默吞掉。
+枚举参数(`--render text|ndjson`、`--since now|all`)也走白名单,且在**阻塞之前**校验 --
+`--render` 只在吐批时生效,拼错若不当场拦下要等满一批才看得出格式不对。
 
 业务过滤只有 `--filter`(jq 表达式)一个口子,不为每个业务加参数。
 

package/bin/lark-relay.js

@@ -110,6 +110,13 @@ async function cmdTake(argv) {
     process.stderr.write(`--since 只能是 now 或 all,当前:${since}\n`)
     return 2
   }
+  // --render 同理,且必须在阻塞之前校验:`--render tex` 曾静默退回 NDJSON,
+  // 而那要等满一批(最长 12h)才看得出来 —— 到时候批次已经吐成了错的格式
+  const mode = a.render === true ? 'text' : a.render || 'ndjson'
+  if (mode !== 'text' && mode !== 'ndjson') {
+    process.stderr.write(`--render 只能是 text 或 ndjson,当前:${mode}\n`)
+    return 2
+  }
   // 没有游标就按 --since now 起头。已有的一律原样保留 ——
   // 别「自愈」到最新,那会静默丢掉全部积压(见 docs/lessons.md#游标判据)
   if (since === 'now') {
@@ -164,7 +171,6 @@ async function cmdTake(argv) {
     return res.reason === 'timeout' ? 4 : 0
   }
 
-  const mode = a.render === true ? 'text' : a.render
   process.stdout.write(`${render(res.events, mode)}\n`)
   process.stderr.write(`${res.events.length} 条,游标身份 ${name}\n`)
   return 0

package/lib/collect.js

@@ -17,23 +17,13 @@ const { init: logInit, logLine } = require('./log')
 const EVENT_KEY = process.env.LARK_RELAY_EVENT_KEY || 'im.message.receive_v1'
 const GC_INTERVAL_MS = 3600_000
 
-// 游标空闲多久算遗弃。默认 2 天:take 是实时场景的取用口,
-// 空闲一两天以上再重挂,下次消费一定从新的开始
-const CURSOR_TTL_DAYS = (() => {
-  const d = Number(process.env.LARK_RELAY_CURSOR_TTL_DAYS)
-  return Number.isFinite(d) && d > 0 ? d : 2
-})()
-
 class AppCollector {
-  constructor(app, opts) {
+  constructor(app) {
     this.app = app
-    this.opts = opts
     this.seq = 0
-    this.received = 0
     this.child = null
     this.stopped = false
     this.backoffMs = 1000
-    this.restarts = 0
     this.healthyTimer = null
     // 落盘侧去重:同一条消息在盘上只出现一次,消费侧因此完全不必去重。
     // 种子从当天已落盘的事件读回 —— 重启后 bus 重投时它是**新文件**,游标拦不住
@@ -54,7 +44,6 @@ class AppCollector {
       this.seen.add(id)
     }
     store.writeEvent(this.app, obj, this.seq++)
-    this.received++
     return true
   }
 
@@ -107,7 +96,6 @@ class AppCollector {
       restarted = true
       clearTimeout(this.healthyTimer)
       this.child = null
-      this.restarts++
       logLine(
         `[${this.app}] consume 退出(${why}),${Math.round(this.backoffMs / 1000)}s 后重启 ` +
           `—— 这段时间该 app 的消息会永久丢失`,
@@ -203,7 +191,7 @@ async function runCollect(opts) {
       `  event_key=${EVENT_KEY} store 保留 ${opts.retain}天`,
   )
 
-  const collectors = chosen.map((p) => new AppCollector(p.name, opts))
+  const collectors = chosen.map((p) => new AppCollector(p.name))
   for (const c of collectors) c.start()
 
   // gc 在本进程内每小时自查:回收逻辑就是「删超期的东西」,
@@ -219,9 +207,11 @@ async function runCollect(opts) {
     try {
       // 游标按空闲时长自动回收 —— 引擎自己过期,不需要人判断。
       // 判据错过两次,见 docs/lessons.md#游标判据
-      const c = store.gcCursors(CURSOR_TTL_DAYS)
+      const c = store.gcCursors(store.CURSOR_TTL_DAYS)
       if (c.length) {
-        logLine(`gc: 回收游标 ${c.length} 个(空闲超 ${CURSOR_TTL_DAYS} 天):${c.join(' ')}`)
+        logLine(
+          `gc: 回收游标 ${c.length} 个(空闲超 ${store.CURSOR_TTL_DAYS} 天):${c.join(' ')}`,
+        )
       }
     } catch (err) {
       logLine(`gc: 游标回收失败 ${err.message}`)

package/lib/help.js

@@ -39,7 +39,7 @@ function takeHelp(apps) {
   --debounce N      防抖秒数(默认 5;聊天场景建议 15)
   --max-wait N      从第一条起最多攒多久就吐(默认 25 秒)
   --timeout N       没消息时最多阻塞多久,到点空手退出码 4(默认 12 小时)
-  --render text     按群分组紧凑文本(默认 NDJSON)
+  --render text     按群分组紧凑文本(默认 ndjson;只认 text|ndjson)
   --since now|all   起始位置(默认 now,不重放历史)
 
 退出码

package/lib/lock.js

@@ -29,13 +29,11 @@ function acquireExclusive(key) {
 
     const holder = readPid(pidFile)
     if (holder === process.pid) return mkHandle(dir, pidFile, me) // 自己已持有,复用
-    if (holder === null && attempt === 0) {
-      // 要么是上面那个微秒级窗口,要么是持有者被 SIGKILL 后留下的空壳。
-      // 等一拍再读一次:还是空就当陈旧锁清掉
-      try {
-        fs.rmSync(dir, { recursive: true, force: true })
-      } catch {}
-      continue
+    if (holder === null) {
+      // 目录在但没 pid:要么是上面那个微秒级窗口(持有者马上就写),要么是它
+      // 恰好在窗口内被 SIGKILL 留下的空壳。两者**无法区分**,一律拒绝 ——
+      // 拒绝的代价只是「再跑一次」,夺锁的代价是双实例(collect 双实例丢 5 分钟消息)
+      return { ok: false, file: dir, holder: null }
     }
     if (holder && alive(holder)) return { ok: false, file: dir, holder }
     // 持有者已死:清掉重试一次

package/lib/status.js

@@ -168,7 +168,9 @@ function formatStatus(s) {
     }
   }
   out.push('')
-  out.push(`游标 ${s.cursorsDir}(空闲超 2 天自动回收;等不及就 rm -rf 它)`)
+  out.push(
+    `游标 ${s.cursorsDir}(空闲超 ${store.CURSOR_TTL_DAYS} 天自动回收;等不及就 rm -rf 它)`,
+  )
 
   return out.join('\n')
 }

package/lib/store.js

@@ -122,9 +122,7 @@ function seedIds(app, day = dayKey()) {
 function readCursor(name, app) {
   try {
     const raw = fs.readFileSync(paths.cursor(name, app), 'utf8').trim()
-    if (!raw) return null
-    if (raw.startsWith('{')) return JSON.parse(raw).key || null
-    return raw
+    return raw || null
   } catch {
     return null
   }
@@ -212,6 +210,16 @@ function gcStore(retainDays) {
   return removed
 }
 
+// 游标空闲多久算遗弃。默认 2 天:take 是实时场景的取用口,
+// 空闲一两天以上再重挂,下次消费一定从新的开始。
+//
+// 定义在这里(gcCursors 的所在地)而非 collect.js —— status 要拿它渲染提示,
+// 两处各写一个 2 就会漂移:改了环境变量而 status 仍说「2 天」是在撒谎
+const CURSOR_TTL_DAYS = (() => {
+  const d = Number(process.env.LARK_RELAY_CURSOR_TTL_DAYS)
+  return Number.isFinite(d) && d > 0 ? d : 2
+})()
+
 // gc:删空闲超期的游标。与 gcStore 同构(都是「删超期的东西」),故放一起。
 //
 // 判据是**多久没人用过它**(mtime)。「落后多少条」和「停在哪天」都试过、
@@ -257,6 +265,7 @@ function gcCursors(ttlDays) {
 }
 
 module.exports = {
+  CURSOR_TTL_DAYS,
   writeEvent,
   scanAll,
   readEvent,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "lark-relay",
-  "version": "0.6.0",
+  "version": "0.6.1",
   "description": "Lark event relay: collect events to disk, take a batch when you need it.",
   "keywords": [
     "lark",