@zhushanwen/pi-scheduler 0.10.4 → 0.11.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@zhushanwen/pi-scheduler",
-  "version": "0.10.4",
+  "version": "0.11.0",
   "type": "module",
   "main": "index.ts",
   "taiji": {

package/src/__tests__/sdk-contract.test.ts

@@ -212,3 +212,56 @@ describe('pi-scheduler SDK contract', () => {
     expect(cleanup).toHaveBeenCalledTimes(2)
   })
 })
+
+// ── execute 组装 details.summary（withScheduleSummary 包装线回归防线）──
+// 纯函数（buildScheduleSummary / buildScheduleControlSummary）已被 summary.test.ts 直测；
+// 本组护的是 index.ts execute 内的两处组装线（schedule → withScheduleSummary(result,
+// buildScheduleSummary(...))；schedule_control → buildScheduleControlSummary 同款）——
+// 组装行丢失时 details.summary 缺失，GUI 收起态与 TUI 折叠态双双退化为原始 JSON，此处红。
+
+/** execute 返回的 details 形状（组装线断言面：summary 恒为 string）。 */
+interface SummaryDetails {
+  summary: unknown
+}
+
+describe('execute 组装 details.summary（withScheduleSummary 包装线）', () => {
+  /** 装配 → 触发 session_start，返回捕获的两 tool 与事件表。调用方 finally 里 fire session_shutdown 停 tick timer。 */
+  async function setupWithSession(): Promise<{
+    tools: CapturedTool[]
+    events: Map<string, (...args: unknown[]) => void>
+    fakeCtx: ExtensionContext
+  }> {
+    const { pi, tools, events } = createMockPi()
+    schedulerExtension(pi)
+    const fakeCtx = createFakeCtx()
+    await events.get('session_start')!({ type: 'session_start', reason: 'startup' }, fakeCtx)
+    return { tools, events, fakeCtx }
+  }
+
+  it('schedule 创建 → details.summary = Scheduled "<name>" · every 5m（index.ts schedule 包装线）', async () => {
+    const { tools, events, fakeCtx } = await setupWithSession()
+    try {
+      const tool = tools.find(t => t.name === 'schedule')!
+      const result = await tool.execute('call-sum-1', { prompt: 'check build', schedule: '5m' }, undefined, undefined, fakeCtx)
+      // 期望文案锚点：summary.test.ts 直测口径（interval 规格化 every 5m + en-US）
+      expect((result.details as SummaryDetails).summary).toBe('Scheduled "check build" · every 5m')
+    } finally {
+      await events.get('session_shutdown')?.()
+    }
+  })
+
+  it('schedule_control list → details.summary = Listed N tasks（index.ts schedule_control 包装线）', async () => {
+    const { tools, events, fakeCtx } = await setupWithSession()
+    try {
+      // 先建 1 个任务，list 计数才有非零区分度
+      const scheduleTool = tools.find(t => t.name === 'schedule')!
+      await scheduleTool.execute('call-sum-2', { prompt: 'standup', schedule: '5m' }, undefined, undefined, fakeCtx)
+
+      const controlTool = tools.find(t => t.name === 'schedule_control')!
+      const result = await controlTool.execute('call-sum-3', { action: 'list' }, undefined, undefined, fakeCtx)
+      expect((result.details as SummaryDetails).summary).toBe('Listed 1 tasks')
+    } finally {
+      await events.get('session_shutdown')?.()
+    }
+  })
+})

package/src/__tests__/summary.test.ts

@@ -0,0 +1,135 @@
+import type { Theme } from '@earendil-works/pi-coding-agent'
+import { describe, expect, it } from 'vitest'
+
+import {
+  buildScheduleControlSummary,
+  buildScheduleSummary,
+  withScheduleSummary,
+  type ScheduleControlParamsT,
+  type ScheduleParamsT,
+} from '../tool.js'
+import { renderScheduleToolResult } from '../render-result.js'
+
+function toolResult(details: unknown, text = 'body'): { content: { type: 'text'; text: string }[]; details: unknown } {
+  return { content: [{ type: 'text', text }], details }
+}
+
+// ── buildScheduleSummary ─────────────────────────────
+
+describe('buildScheduleSummary', () => {
+  const createParams: ScheduleParamsT = { prompt: 'standup', schedule: '5m', name: 'Standup reminder' }
+
+  it('创建成功 → Scheduled "<name>" · <schedule>（interval 规格化文案，en-US）', () => {
+    const r = toolResult({
+      task: { name: 'Standup reminder', kind: 'recurring', schedule: { mode: 'interval', intervalMs: 300000 } },
+      nextRuns: [],
+    })
+    expect(buildScheduleSummary(createParams, r)).toBe('Scheduled "Standup reminder" · every 5m')
+  })
+
+  it('cron 规格 → 原样表达式', () => {
+    const r = toolResult({
+      task: { name: 'Nightly', kind: 'recurring', schedule: { mode: 'cron', cronExpression: '*/10 * * * *' } },
+      nextRuns: [],
+    })
+    expect(buildScheduleSummary(createParams, r)).toBe('Scheduled "Nightly" · */10 * * * *')
+  })
+
+  it('取消态 → Cancelled', () => {
+    expect(buildScheduleSummary(createParams, toolResult({ cancelled: true }))).toBe('Cancelled')
+  })
+
+  it('details 形态漂移（无 task）→ 降级 Scheduled 不抛错', () => {
+    expect(buildScheduleSummary(createParams, toolResult({}))).toBe('Scheduled')
+  })
+
+  it('task.schedule 非法形态 → 回落 params.schedule 原文', () => {
+    const r = toolResult({ task: { name: 'Odd', schedule: { mode: 'bogus' } } })
+    expect(buildScheduleSummary(createParams, r)).toBe('Scheduled "Odd" · 5m')
+  })
+})
+
+// ── buildScheduleControlSummary ──────────────────────
+
+describe('buildScheduleControlSummary', () => {
+  it('list → Listed N tasks', () => {
+    const params: ScheduleControlParamsT = { action: 'list' }
+    expect(buildScheduleControlSummary(params, toolResult({ tasks: [{}, {}] }))).toBe('Listed 2 tasks')
+    expect(buildScheduleControlSummary(params, toolResult({ tasks: [] }))).toBe('Listed 0 tasks')
+  })
+
+  it('toggle enabled=false → Paused；enabled=true → Resumed', () => {
+    expect(
+      buildScheduleControlSummary({ action: 'toggle', id: 'ab12cd34', enabled: false }, toolResult({})),
+    ).toBe('Paused task ab12cd34')
+    expect(
+      buildScheduleControlSummary({ action: 'toggle', id: 'ab12cd34', enabled: true }, toolResult({})),
+    ).toBe('Resumed task ab12cd34')
+  })
+
+  it('delete / run → 动作 + id', () => {
+    expect(buildScheduleControlSummary({ action: 'delete', id: 'ab12cd34' }, toolResult({}))).toBe(
+      'Deleted task ab12cd34',
+    )
+    expect(buildScheduleControlSummary({ action: 'run', id: 'ab12cd34' }, toolResult({}))).toBe(
+      'Ran task ab12cd34 now',
+    )
+  })
+})
+
+// ── withScheduleSummary ──────────────────────────────
+
+describe('withScheduleSummary', () => {
+  it('details 追加 summary，现有字段保留', () => {
+    const r = toolResult({ tasks: [{}] })
+    const out = withScheduleSummary(r, 'Listed 1 tasks')
+    expect(out.details).toEqual({ tasks: [{}], summary: 'Listed 1 tasks' })
+  })
+
+  it('非对象 details → 防御替换为 { summary }', () => {
+    const r = toolResult('legacy-string')
+    const out = withScheduleSummary(r, 'Done')
+    expect(out.details).toEqual({ summary: 'Done' })
+  })
+})
+
+// ── renderScheduleToolResult（TUI renderResult）──────
+
+const mockTheme = {
+  fg: (_color: string, text: string) => text,
+  bg: (_color: string, text: string) => text,
+  bold: (text: string) => text,
+  italic: (text: string) => text,
+  underline: (text: string) => text,
+  inverse: (text: string) => text,
+  strikethrough: (text: string) => text,
+  getFgAnsi: (_color: string) => '',
+  getBgAnsi: (_color: string) => '',
+  getColorMode: () => 'truecolor' as const,
+  getThinkingBorderColor: () => (text: string) => text,
+  getBashModeBorderColor: () => (text: string) => text,
+} as unknown as Theme
+
+function renderedText(result: unknown, expanded: boolean): string {
+  return renderScheduleToolResult(result, { expanded }, mockTheme)
+    .render(400)
+    .map((line) => line.trimEnd())
+    .join('\n')
+}
+
+describe('renderScheduleToolResult', () => {
+  it('折叠态 → details.summary 一行', () => {
+    const r = withScheduleSummary(toolResult({ tasks: [{}] }, 'multi\nline'), 'Listed 1 tasks')
+    expect(renderedText(r, false)).toBe('Listed 1 tasks')
+  })
+
+  it('展开态 → content 纯文本', () => {
+    const r = toolResult({}, 'line1\nline2')
+    expect(renderedText(r, true)).toBe('line1\nline2')
+  })
+
+  it('无 summary（旧 entry）→ 折叠态回退 content 首行', () => {
+    const r = toolResult({}, 'Header\nbody')
+    expect(renderedText(r, false)).toBe('Header')
+  })
+})

package/src/index.ts

@@ -1,4 +1,4 @@
-import type { ExtensionAPI, ExtensionContext } from '@earendil-works/pi-coding-agent'
+import type { ExtensionAPI, ExtensionContext, Theme } from '@earendil-works/pi-coding-agent'
 import type { GuiContext } from '@zhushanwen/extension-protocol'
 import { toErrorMessage } from '@zhushanwen/pi-ext-guards'
 import { getLogger } from '@zhushanwen/pi-extension-logger'
@@ -10,9 +10,12 @@ import { formatSchedule } from './format.js'
 import { readUiLocale, t } from './i18n.js'
 import { importLegacyStore } from './importer.js'
 import { abortPendingScheduleForms } from './interaction.js'
+import { renderScheduleToolResult } from './render-result.js'
 import { SchedulerRuntime, type SchedulerModelOps } from './runtime.js'
 import { SchedulerService } from './service.js'
 import {
+  buildScheduleControlSummary,
+  buildScheduleSummary,
   controlGuidelines,
   handleSchedule,
   handleScheduleControl,
@@ -21,6 +24,7 @@ import {
   scheduleGuidelines,
   ScheduleParams,
   type ScheduleParamsT,
+  withScheduleSummary,
 } from './tool.js'
 import { computeTasksFingerprint, setSchedulerWidget } from './widget.js'
 import type { ScheduledTask } from './types.js'
@@ -274,11 +278,17 @@ export default function schedulerExtension(pi: ExtensionAPI): void {
       _ctx: ExtensionContext,
     ) {
       try {
-        return await handleSchedule(getService(), params, signal)
+        const result = await handleSchedule(getService(), params, signal)
+        // 收起态一行摘要：details 追加 summary（现有字段保留），GUI 收起态与 TUI 折叠态共用
+        return withScheduleSummary(result, buildScheduleSummary(params, result))
       } catch (err) {
         throw new Error(`Error: ${toErrorMessage(err)}`)
       }
     },
+
+    renderResult(result: unknown, options: { expanded: boolean }, theme: Theme) {
+      return renderScheduleToolResult(result, options, theme)
+    },
   })
 
   // 注册 schedule_control tool（错误路径同上：throw 让 pi 置 isError）
@@ -298,11 +308,17 @@ export default function schedulerExtension(pi: ExtensionAPI): void {
       _ctx: ExtensionContext,
     ) {
       try {
-        return await handleScheduleControl(getService(), params)
+        const result = await handleScheduleControl(getService(), params)
+        // 收起态一行摘要：同 schedule
+        return withScheduleSummary(result, buildScheduleControlSummary(params, result))
       } catch (err) {
         throw new Error(`Error: ${toErrorMessage(err)}`)
       }
     },
+
+    renderResult(result: unknown, options: { expanded: boolean }, theme: Theme) {
+      return renderScheduleToolResult(result, options, theme)
+    },
   })
 
   // 注册 /schedule 命令。传 getter 而非 service 实例：factory 执行时

package/src/render-result.ts

@@ -0,0 +1,46 @@
+/**
+ * schedule / schedule_control 的 TUI renderResult（折叠态一行摘要 / 展开态 content 纯文本）。
+ *
+ * summary 来源 = details.summary（index.ts execute 经 withScheduleSummary 追加）；
+ * 历史持久化 entry 无 summary 时折叠态回退 content 文本首行。
+ */
+
+import type { Theme } from '@earendil-works/pi-coding-agent'
+import { Text } from '@earendil-works/pi-tui'
+import { firstContentText } from '@zhushanwen/extension-protocol'
+
+/** content[0] 的 text 纯文本（content 缺失或非 text 类型时兜底空串）。 */
+function contentText(result: unknown): string {
+	const content = fieldValue(result, 'content')
+	if (!Array.isArray(content)) return ''
+	return firstContentText({ content })
+}
+
+/** unknown 值按字段名安全取值（index-signature 收窄，替代全可选结构断言）。 */
+function fieldValue(v: unknown, key: string): unknown {
+	if (typeof v !== 'object' || v === null) return undefined
+	return (v as Record<string, unknown>)[key]
+}
+
+/** 从 details 安全读取 summary（容错非对象形态与旧版本 entry）。 */
+function readDetailsSummary(result: unknown): string | undefined {
+	const summary = fieldValue(fieldValue(result, 'details'), 'summary')
+	return typeof summary === 'string' && summary !== '' ? summary : undefined
+}
+
+/** 折叠态回退：content 文本首行（保持一行摘要形态）。 */
+function firstLine(text: string): string {
+	const idx = text.indexOf('\n')
+	return idx === -1 ? text : text.slice(0, idx)
+}
+
+/** 折叠态（expanded=false）= details.summary 一行（dim）；展开态 = content 纯文本。 */
+export function renderScheduleToolResult(
+	result: unknown,
+	options: { expanded: boolean },
+	theme: Theme,
+): Text {
+	if (options.expanded) return new Text(contentText(result), 0, 0)
+	const summary = readDetailsSummary(result) ?? firstLine(contentText(result))
+	return new Text(theme.fg('dim', summary), 0, 0)
+}

package/src/tool.ts

@@ -1,7 +1,9 @@
 import { Static, Type } from 'typebox'
 
+import { formatSchedule } from './format.js'
 import { parseSchedule } from './parsing.js'
 import type { SchedulerService, ServiceResult } from './service.js'
+import type { ScheduleSpec, TaskKind } from './types.js'
 
 // ── schedule tool ──
 
@@ -150,3 +152,73 @@ function toToolResult(result: ServiceResult): {
     details: result.data ?? {},
   }
 }
+
+// ── 收起态一行摘要（GUI details.summary + TUI 折叠态共用）──
+// summary 是展示面：details 形态漂移（历史 entry）时容错降级，不抛错。
+
+interface ToolResultLike { // oe-exempt:20261017:framework:details 数据形状窄 view（单实现消费，非抽象接口）
+  content: { type: 'text'; text: string }[]
+  details: unknown
+}
+
+function asRecord(v: unknown): Record<string, unknown> {
+  return typeof v === 'object' && v !== null ? (v as Record<string, unknown>) : {}
+}
+
+function strOf(v: unknown): string | undefined {
+  return typeof v === 'string' ? v : undefined
+}
+
+/** ScheduleSpec 运行时窄化（details.task.schedule 经 JSON 往返后仍需 shape 校验）。 */
+function asScheduleSpec(v: unknown): ScheduleSpec | undefined {
+  const spec = asRecord(v)
+  if (spec.mode !== 'interval' && spec.mode !== 'cron') return undefined
+  return spec as ScheduleSpec
+}
+
+/** 给 tool result 的 details 追加 summary（现有字段保留；非对象 details 防御替换）。 */
+export function withScheduleSummary<T extends ToolResultLike>(
+  result: T,
+  summary: string,
+): T {
+  const details = result.details
+  if (details === null || typeof details !== 'object' || Array.isArray(details)) {
+    return { ...result, details: { summary } }
+  }
+  return { ...result, details: { ...details, summary } }
+}
+
+/** schedule（创建）摘要：`Scheduled "<name>" · <schedule>`；取消态与数据缺失时按形态降级。 */
+export function buildScheduleSummary(params: ScheduleParamsT, result: ToolResultLike): string {
+  const details = asRecord(result.details)
+  if (details.cancelled === true) return 'Cancelled'
+  const task = asRecord(details.task)
+  const name = strOf(task.name)
+  if (name === undefined) return 'Scheduled'
+  const spec = asScheduleSpec(task.schedule)
+  const kind = task.kind === 'once' || task.kind === 'recurring' ? (task.kind as TaskKind) : undefined
+  const scheduleText = spec !== undefined ? formatSchedule(spec, kind, 'en-US') : params.schedule
+  return `Scheduled "${name}" · ${scheduleText}`
+}
+
+/** schedule_control 摘要：按 action 分支（toggle 按 enabled 目标态分 Paused/Resumed）。 */
+export function buildScheduleControlSummary(
+  params: ScheduleControlParamsT,
+  result: ToolResultLike,
+): string {
+  const details = asRecord(result.details)
+  switch (params.action) {
+    case 'list':
+      return `Listed ${Array.isArray(details.tasks) ? details.tasks.length : 0} tasks`
+    case 'toggle':
+      if (params.enabled === false) return `Paused task ${params.id ?? ''}`
+      if (params.enabled === true) return `Resumed task ${params.id ?? ''}`
+      return `Toggled task ${params.id ?? ''}`
+    case 'delete':
+      return `Deleted task ${params.id ?? ''}`
+    case 'run':
+      return `Ran task ${params.id ?? ''} now`
+    default:
+      return 'Done'
+  }
+}