@goodandready/dsh-goal 0.2.2 → 0.2.3

package/lib/engine-reports.js

@@ -0,0 +1,114 @@
+import { execSync } from 'node:child_process';
+
+/**
+ * Safely get current short git commit hash
+ * @param {string} [cwd]
+ * @returns {string|null}
+ */
+export function getGitCurrentCommit(cwd) {
+  try {
+    return execSync('git rev-parse --short HEAD', {
+      encoding: 'utf8',
+      stdio: ['ignore', 'pipe', 'ignore'],
+      timeout: 1000,
+      cwd: cwd || undefined,
+    }).trim();
+  } catch (err) {
+    return null;
+  }
+}
+
+/**
+ * Generate Markdown report for goal results
+ * @param {Object} state
+ * @returns {string}
+ */
+export function exportReportMarkdown(state) {
+  if (!state) return '';
+  const title = state.title || 'Goal Report';
+  const status = state.state === 'COMPLETED' ? 'COMPLETED' : state.state;
+  const elapsed = state.formattedElapsed || '0s';
+  const iter = `${state.iterationsCount || 0}/${state.maxIterations || 25}`;
+  const totalTokens = state.tokensUsage?.totalTokens || 0;
+  const promptTokens = state.tokensUsage?.promptTokens || 0;
+  const compTokens = state.tokensUsage?.completionTokens || 0;
+  const gitCommit = state.gitStartCommit ? ` | **Git Start:** \`${state.gitStartCommit}\`` : '';
+
+  let md = `# 🎯 Goal Report: ${title}\n\n`;
+  md += `**Status:** \`${status}\` | **Duration:** \`${elapsed}\` | **Iterations:** \`${iter}\`${gitCommit}\n`;
+  if (totalTokens > 0) {
+    md += `**Tokens:** \`${totalTokens.toLocaleString('en-US')}\` (Prompt: \`${promptTokens.toLocaleString('en-US')}\`, Completion: \`${compTokens.toLocaleString('en-US')}\`)\n`;
+  }
+  md += '\n';
+
+  if (state.description) {
+    md += `### Description\n${state.description}\n\n`;
+  }
+
+  if (state.resultSummary) {
+    md += `### Summary & Deliverables\n${state.resultSummary}\n\n`;
+  }
+
+  const milestones = state.milestones || [];
+  if (milestones.length > 0) {
+    md += `### Milestones\n| # | Status | Title | Notes |\n|---|---|---|---|\n`;
+    milestones.forEach((m, idx) => {
+      const mark = m.status === 'completed' ? '✅ Done' : m.status === 'in_progress' ? '🔄 In Progress' : '⏳ Pending';
+      const cleanTitle = (m.title || '').replace(/\|/g, '\\|');
+      const cleanNotes = (m.notes || '').replace(/\|/g, '\\|');
+      md += `| ${idx + 1} | ${mark} | ${cleanTitle} | ${cleanNotes || '—'} |\n`;
+    });
+    md += '\n';
+  }
+
+  md += `*Generated by DSH Goal Engine at ${new Date().toISOString()}*\n`;
+  return md;
+}
+
+/**
+ * Generate GitHub / Gitea PR comment report with collapsible details
+ * @param {Object} state
+ * @returns {string}
+ */
+export function exportReportGitHubPR(state) {
+  if (!state) return '';
+  const title = state.title || 'Goal Report';
+  const status = state.state === 'COMPLETED' ? 'COMPLETED' : state.state;
+  const elapsed = state.formattedElapsed || '0s';
+  const iter = `${state.iterationsCount || 0}/${state.maxIterations || 25}`;
+  const totalTokens = state.tokensUsage?.totalTokens || 0;
+  const promptTokens = state.tokensUsage?.promptTokens || 0;
+  const compTokens = state.tokensUsage?.completionTokens || 0;
+  const gitCommit = state.gitStartCommit ? `  |  **Git Start:** \`${state.gitStartCommit}\` 📌` : '';
+
+  let md = `## 🎯 Autonomous Goal Resolution: ${title}\n\n`;
+  md += `> **Status:** \`${status}\` 🚀  |  **Duration:** \`${elapsed}\` ⏱️  |  **Iterations:** \`${iter}\` 🔄${gitCommit}\n\n`;
+
+  if (totalTokens > 0) {
+    md += `### 📊 Telemetry & Token Usage\n`;
+    md += `- **Total Tokens:** \`${totalTokens.toLocaleString('en-US')}\` (Prompt: \`${promptTokens.toLocaleString('en-US')}\`, Completion: \`${compTokens.toLocaleString('en-US')}\`)\n\n`;
+  }
+
+  if (state.resultSummary) {
+    md += `### 📦 Deliverables & Achievements\n${state.resultSummary}\n\n`;
+  } else if (state.description) {
+    md += `### 📝 Objective\n${state.description}\n\n`;
+  }
+
+  const milestones = state.milestones || [];
+  if (milestones.length > 0) {
+    const completedCount = milestones.filter((m) => m.status === 'completed').length;
+    md += `<details>\n<summary><b>📋 Milestones Breakdown (${completedCount}/${milestones.length} Completed)</b></summary>\n\n`;
+    md += `| # | Status | Milestone | Notes |\n|---|---|---|---|\n`;
+    milestones.forEach((m, idx) => {
+      const mark = m.status === 'completed' ? '✅ Done' : m.status === 'in_progress' ? '🔄 In Progress' : '⏳ Pending';
+      const cleanTitle = (m.title || '').replace(/\|/g, '\\|');
+      const cleanNotes = (m.notes || '').replace(/\|/g, '\\|');
+      md += `| ${idx + 1} | ${mark} | ${cleanTitle} | ${cleanNotes || '—'} |\n`;
+    });
+    md += `\n</details>\n\n`;
+  }
+
+  md += `*Automated by [@goodandready/dsh-goal](https://github.com/GooDAnDReaDY/dsh-goal)*\n`;
+  return md;
+}

package/lib/engine-store.js

@@ -0,0 +1,142 @@
+import fs from 'node:fs';
+import path from 'node:path';
+import { GoalState } from './goal-engine-constants.js';
+
+/**
+ * Storage manager for goal engine disk state persistence
+ */
+export class EngineStore {
+  constructor(engine, storagePath) {
+    this.engine = engine;
+    this.storagePath = storagePath || null;
+    this.saveTimer = null;
+  }
+
+  setStoragePath(storagePath) {
+    this.storagePath = storagePath || null;
+  }
+
+  loadStateFromDisk() {
+    if (!this.storagePath) return;
+    try {
+      if (fs.existsSync(this.storagePath)) {
+        const raw = fs.readFileSync(this.storagePath, 'utf8');
+        const data = JSON.parse(raw);
+        if (data && typeof data === 'object') {
+          let dirty = false;
+          if (data.sessions && typeof data.sessions === 'object') {
+            for (const [sid, goal] of Object.entries(data.sessions)) {
+              if (goal && goal.id && goal.title) {
+                // Crash Hydration: transition leftover RUNNING goals to PAUSED
+                if (goal.state === GoalState.RUNNING) {
+                  goal.state = GoalState.PAUSED;
+                  goal.pausedAt = Date.now();
+                  if (!Array.isArray(goal.logs)) goal.logs = [];
+                  goal.logs.push({
+                    timestamp: Date.now(),
+                    type: 'warning',
+                    message: 'Harness was restarted — click ▶️ to resume',
+                  });
+                  if (goal.logs.length > 100) goal.logs = goal.logs.slice(-100);
+                  dirty = true;
+                }
+                if (!goal.tokensUsage) {
+                  goal.tokensUsage = { promptTokens: 0, completionTokens: 0, totalTokens: 0 };
+                }
+                if (!goal.lang) {
+                  goal.lang = 'en';
+                }
+                this.engine.goals.set(sid, goal);
+              }
+            }
+          } else if (data.id && data.title) {
+            if (data.state === GoalState.RUNNING) {
+              data.state = GoalState.PAUSED;
+              data.pausedAt = Date.now();
+              if (!Array.isArray(data.logs)) data.logs = [];
+              data.logs.push({
+                timestamp: Date.now(),
+                type: 'warning',
+                message: 'Harness was restarted — click ▶️ to resume',
+              });
+              if (data.logs.length > 100) data.logs = data.logs.slice(-100);
+              dirty = true;
+            }
+            if (!data.tokensUsage) {
+              data.tokensUsage = { promptTokens: 0, completionTokens: 0, totalTokens: 0 };
+            }
+            if (!data.lang) {
+              data.lang = 'en';
+            }
+            this.engine.goals.set('default', data);
+          }
+          if (dirty) {
+            this.scheduleSave(true);
+          }
+        }
+      }
+    } catch (err) {
+      // best-effort load failure logged defensively
+      console.warn?.('[GoalEngine] Failed to load state from disk:', err?.message || err);
+    }
+  }
+
+  scheduleSave(immediate = false) {
+    if (!this.storagePath) return;
+    if (immediate) {
+      if (this.saveTimer) {
+        clearTimeout(this.saveTimer);
+        this.saveTimer = null;
+      }
+      this.writeStateToDiskSync();
+      return;
+    }
+    if (!this.saveTimer) {
+      this.saveTimer = setTimeout(() => {
+        this.saveTimer = null;
+        this.writeStateToDiskSync();
+      }, 250);
+      if (typeof this.saveTimer.unref === 'function') {
+        this.saveTimer.unref();
+      }
+    }
+  }
+
+  writeStateToDiskSync() {
+    if (!this.storagePath) return;
+    try {
+      if (this.engine.goals.size === 0) {
+        if (fs.existsSync(this.storagePath)) {
+          fs.unlinkSync(this.storagePath);
+        }
+        return;
+      }
+      const sessionsObj = {};
+      for (const [sid, goal] of this.engine.goals.entries()) {
+        sessionsObj[sid] = goal;
+      }
+      const payload = {
+        version: 2,
+        sessions: sessionsObj,
+        ...(this.engine.goals.has('default') ? this.engine.goals.get('default') : {}),
+      };
+      const dir = path.dirname(this.storagePath);
+      if (!fs.existsSync(dir)) {
+        fs.mkdirSync(dir, { recursive: true });
+      }
+      const tmp = `${this.storagePath}.tmp.${Date.now()}`;
+      fs.writeFileSync(tmp, JSON.stringify(payload, null, 2), 'utf8');
+      fs.renameSync(tmp, this.storagePath);
+    } catch (err) {
+      console.warn?.('[GoalEngine] Failed to write state to disk:', err?.message || err);
+    }
+  }
+
+  flushSync() {
+    if (this.saveTimer) {
+      clearTimeout(this.saveTimer);
+      this.saveTimer = null;
+    }
+    this.writeStateToDiskSync();
+  }
+}

package/lib/goal-engine-constants.js

@@ -0,0 +1,100 @@
+/**
+ * Enums and helpers for DSH Goal Engine
+ */
+
+export const GoalState = {
+  IDLE: 'IDLE',
+  PLANNING: 'PLANNING',
+  RUNNING: 'RUNNING',
+  PAUSED: 'PAUSED',
+  COMPLETED: 'COMPLETED',
+  FAILED: 'FAILED',
+  CANCELLED: 'CANCELLED',
+};
+
+export const MilestoneStatus = {
+  PENDING: 'pending',
+  IN_PROGRESS: 'in_progress',
+  COMPLETED: 'completed',
+  FAILED: 'failed',
+};
+
+/**
+ * Format total elapsed seconds into concise string (e.g. "2s", "45s", "1m 15s", "2h 5m")
+ * @param {number} totalSeconds
+ * @returns {string}
+ */
+export function formatElapsed(totalSeconds) {
+  const sec = Math.max(0, Math.floor(totalSeconds));
+  if (sec < 60) return `${sec}s`;
+  const mins = Math.floor(sec / 60);
+  const remainingSec = sec % 60;
+  if (mins < 60) {
+    return remainingSec > 0 ? `${mins}m ${remainingSec}s` : `${mins}m`;
+  }
+  const hours = Math.floor(mins / 60);
+  const remainingMins = mins % 60;
+  return remainingMins > 0 ? `${hours}h ${remainingMins}m` : `${hours}h`;
+}
+
+/**
+ * Format estimated remaining time (ETA)
+ * @param {number|null} seconds
+ * @returns {string|null}
+ */
+export function formatETA(seconds) {
+  if (seconds == null || isNaN(seconds)) return null;
+  const sec = Math.max(0, Math.floor(seconds));
+  if (sec < 60) return `~${sec}s`;
+  const mins = Math.round(sec / 60);
+  if (mins < 60) return `~${mins}m`;
+  const hours = Math.floor(mins / 60);
+  const remainingMins = mins % 60;
+  return remainingMins > 0 ? `~${hours}h ${remainingMins}m` : `~${hours}h`;
+}
+
+/**
+ * Detect language of text (Chinese characters -> zh, otherwise en)
+ * @param {string} text
+ * @param {string} [fallback='en']
+ * @returns {'en' | 'zh'}
+ */
+export function detectLanguage(text, fallback = 'en') {
+  if (!text || typeof text !== 'string') return fallback;
+  if (/[\u4e00-\u9fa5]/.test(text)) {
+    return 'zh';
+  }
+  return 'en';
+}
+
+/**
+ * Extract session ID from invocation or HTTP request
+ * @param {any} invocationOrReq
+ * @param {string} [fallback='default']
+ * @returns {string}
+ */
+export function sessionIdOf(invocationOrReq, fallback = 'default') {
+  if (!invocationOrReq) return fallback;
+  try {
+    if (invocationOrReq.sessionId) return String(invocationOrReq.sessionId);
+    if (invocationOrReq.session) {
+      return String(invocationOrReq.session.id || invocationOrReq.session.header?.id || fallback);
+    }
+    if (invocationOrReq.data?.sessionId) return String(invocationOrReq.data.sessionId);
+    if (invocationOrReq.agent?.session) {
+      return String(invocationOrReq.agent.session.id || invocationOrReq.agent.session.header?.id || fallback);
+    }
+    if (invocationOrReq.headers) {
+      const headerSid = invocationOrReq.headers['x-dsh-session-id'];
+      if (headerSid) return String(headerSid);
+      if (invocationOrReq.url) {
+        const url = new URL(invocationOrReq.url, 'http://localhost');
+        const querySid = url.searchParams.get('sessionId') || url.searchParams.get('session');
+        if (querySid) return String(querySid);
+      }
+    }
+  } catch (err) {
+    // Non-fatal inspection error on malformed request or object
+  }
+  return fallback;
+}