groundswell 0.0.2 → 0.0.3

package/PRD.md

@@ -1,543 +0,0 @@
-# **📘 PRODUCT REQUIREMENTS DOCUMENT (PRD)**
-
-### **Hierarchical Workflow Engine with Full Observability & Tree Debugging**
-
-Version: **1.0**
-Status: **Implementation-ready**
-
----
-
-# **1. Overview**
-
-This PRD defines a TypeScript workflow orchestration engine that provides:
-
-* Hierarchical workflows with sequential + concurrent steps.
-* Automatic parent/child attachment.
-* High-resolution observability (logs, events, snapshots).
-* Error introspection with full child state visibility.
-* Restart logic handled at correct parent level.
-* Real-time tree debugger API for terminal visualization.
-
-All logs & events must form a **perfect 1:1 tree mirror** of the workflow execution tree in memory.
-
-This PRD includes:
-
-✔️ Full data model
-✔️ All TypeScript interfaces
-✔️ Decorator specs
-✔️ Workflow base class skeleton
-✔️ Logger implementation skeleton
-✔️ Observer/event system skeleton
-✔️ Snapshot system spec
-✔️ Error/restart semantics
-
----
-
-# **2. Architecture**
-
-```
-Workflow
- ├─ Steps (decorated methods)
- ├─ Tasks (decorated methods)
- ├─ Observed state (decorated fields)
- ├─ Children (other workflows)
- ├─ Logs
- └─ Events
-```
-
-The tree debugger subscribes to a root workflow and receives real-time events.
-
----
-
-# **3. Core Data Model (Interfaces)**
-
-## **3.1 WorkflowNode**
-
-```ts
-export interface WorkflowNode {
-  id: string;
-  name: string;
-
-  parent: WorkflowNode | null;
-  children: WorkflowNode[];
-
-  status: WorkflowStatus;
-
-  logs: LogEntry[];
-  events: WorkflowEvent[];
-
-  // optional state snapshot
-  stateSnapshot: SerializedWorkflowState | null;
-}
-```
-
-## **3.2 WorkflowStatus**
-
-```ts
-export type WorkflowStatus =
-  | 'idle'
-  | 'running'
-  | 'completed'
-  | 'failed'
-  | 'cancelled';
-```
-
----
-
-# **4. Logging & Events Model**
-
-## **4.1 LogEntry**
-
-```ts
-export type LogLevel = 'debug' | 'info' | 'warn' | 'error';
-
-export interface LogEntry {
-  id: string;
-  workflowId: string;
-  timestamp: number;
-  level: LogLevel;
-  message: string;
-  data?: unknown;
-  parentLogId?: string;
-}
-```
-
-## **4.2 WorkflowEvent**
-
-```ts
-export type WorkflowEvent =
-  | { type: 'childAttached'; parentId: string; child: WorkflowNode }
-  | { type: 'stateSnapshot'; node: WorkflowNode }
-  | { type: 'stepStart'; node: WorkflowNode; step: string }
-  | { type: 'stepEnd'; node: WorkflowNode; step: string; duration: number }
-  | { type: 'error'; node: WorkflowNode; error: WorkflowError }
-  | { type: 'taskStart'; node: WorkflowNode; task: string }
-  | { type: 'taskEnd'; node: WorkflowNode; task: string }
-  | { type: 'treeUpdated'; root: WorkflowNode };
-```
-
----
-
-# **5. Error Model**
-
-## **5.1 WorkflowError**
-
-```ts
-export interface WorkflowError {
-  message: string;
-  original: unknown;
-  workflowId: string;
-  stack?: string;
-
-  state: SerializedWorkflowState; // a snapshot
-  logs: LogEntry[];               // logs from this node only
-}
-```
-
----
-
-# **6. Snapshot System**
-
-## **6.1 State Snapshot**
-
-```ts
-export type SerializedWorkflowState = Record<string, unknown>;
-```
-
-## **6.2 ObservedState Metadata**
-
-```ts
-export interface StateFieldMetadata {
-  hidden?: boolean;   // not shown in debugger
-  redact?: boolean;   // shown as "***"
-}
-```
-
----
-
-# **7. Observers**
-
-## **7.1 WorkflowObserver**
-
-```ts
-export interface WorkflowObserver {
-  onLog(entry: LogEntry): void;
-  onEvent(event: WorkflowEvent): void;
-  onStateUpdated(node: WorkflowNode): void;
-  onTreeChanged(root: WorkflowNode): void;
-}
-```
-
-Observers attach to the **root workflow** and receive all events.
-
----
-
-# **8. Decorators (Complete Technical Specification)**
-
-## **8.1 @Step() Decorator**
-
-```ts
-export interface StepOptions {
-  name?: string;
-  snapshotState?: boolean;
-  trackTiming?: boolean; // Default: true - Track and emit step duration
-  logStart?: boolean;
-  logFinish?: boolean;
-}
-
-export function Step(options: StepOptions = {}): MethodDecorator;
-```
-
-**Responsibilities:**
-
-* Emit `stepStart` + `stepEnd`.
-* Optionally snapshot state.
-* Catch and wrap errors into `WorkflowError`.
-
----
-
-## **8.2 @Task() Decorator**
-
-```ts
-export interface TaskOptions {
-  name?: string;
-  concurrent?: boolean;
-}
-
-export function Task(options: TaskOptions = {}): MethodDecorator;
-```
-
-**Responsibilities:**
-
-* Emit `taskStart` + `taskEnd`
-* Attach returned workflow(s) as children.
-* Enforce concurrency rules.
-
----
-
-## **8.3 @ObservedState Decorator**
-
-```ts
-export function ObservedState(meta: StateFieldMetadata = {}): PropertyDecorator;
-```
-
-Fields marked with this decorator are included in snapshots.
-
----
-
-# **9. Restart Semantics**
-
-* Descendant workflows never request restart upward.
-* A parent step decides whether restart is needed by analyzing:
-
-  * all captured `WorkflowError`s
-  * descendant state snapshots
-  * logs from failing nodes
-* Parent step may:
-
-  1. Retry the step
-  2. Abort the workflow
-  3. Rebuild the plan and continue
-
-Restartability is **opt-in** at the step method level; not global.
-
----
-
-# **10. Optional Multi-Error Merging**
-
-```ts
-export interface ErrorMergeStrategy {
-  enabled: boolean;
-  maxMergeDepth?: number;
-  combine?(errors: WorkflowError[]): WorkflowError;
-}
-```
-
-Default: **disabled** → first error wins (race is preserved).
-
----
-
-# **11. Tree Debugger API**
-
-## **11.1 Tree Debugger Interface**
-
-```ts
-export interface WorkflowTreeDebugger {
-  getTree(): WorkflowNode;
-  getNode(id: string): WorkflowNode | undefined;
-
-  events: Observable<WorkflowEvent>;
-
-  toTreeString(node?: WorkflowNode): string;
-  toLogString(node?: WorkflowNode): string;
-}
-```
-
-This is consumed by the terminal UI.
-
----
-
-# **12. Base Classes (Class Skeletons)**
-
-Below are implementation-ready class skeletons with exact method signatures.
-
----
-
-# **12.1 WorkflowLogger Skeleton**
-
-```ts
-export class WorkflowLogger {
-  constructor(private readonly node: WorkflowNode,
-              private readonly observers: WorkflowObserver[]) {}
-
-  private emit(entry: LogEntry) {
-    this.node.logs.push(entry);
-    for (const obs of this.observers) obs.onLog(entry);
-  }
-
-  debug(message: string, data?: unknown) { /* ... */ }
-  info(message: string, data?: unknown) { /* ... */ }
-  warn(message: string, data?: unknown) { /* ... */ }
-  error(message: string, data?: unknown) { /* ... */ }
-
-  child(meta: Partial<LogEntry>): WorkflowLogger {
-    return new WorkflowLogger(this.node, this.observers);
-  }
-}
-```
-
----
-
-# **12.2 Workflow Base Class Skeleton**
-
-```ts
-export abstract class Workflow {
-  public readonly id: string;
-  public parent: Workflow | null = null;
-  public children: Workflow[] = [];
-  public status: WorkflowStatus = 'idle';
-
-  protected readonly logger: WorkflowLogger;
-  protected readonly node: WorkflowNode;
-
-  constructor(name?: string, parent?: Workflow) {
-    this.id = generateId();
-    this.parent = parent || null;
-
-    this.node = {
-      id: this.id,
-      name: name ?? this.constructor.name,
-      parent: parent?.node ?? null,
-      children: [],
-      logs: [],
-      events: [],
-      status: 'idle',
-      stateSnapshot: null,
-    };
-
-    this.logger = new WorkflowLogger(this.node, this.getRootObservers());
-    if (parent) parent.attachChild(this);
-  }
-
-  private getRootObservers(): WorkflowObserver[] {
-    return this.parent ? this.parent.getRootObservers() : []; 
-  }
-
-  attachChild(child: Workflow) {
-    this.children.push(child);
-    this.node.children.push(child.node);
-    this.emitEvent({ type: 'childAttached', parentId: this.id, child: child.node });
-  }
-
-  protected emitEvent(event: WorkflowEvent) {
-    this.node.events.push(event);
-    for (const obs of this.getRootObservers()) {
-      obs.onEvent(event);
-      if (event.type === 'treeUpdated') obs.onTreeChanged(this.node);
-    }
-  }
-
-  snapshotState() {
-    const snapshot = createStateSnapshot(this);
-    this.node.stateSnapshot = snapshot;
-    for (const obs of this.getRootObservers()) obs.onStateUpdated(this.node);
-  }
-
-  abstract run(...args: any[]): Promise<any>;
-}
-```
-
----
-
-# **12.3 Decorator Skeletons**
-
-These are implementation-level scaffolds.
-
-### **@ObservedState**
-
-```ts
-const OBSERVED_STATE_FIELDS = new WeakMap<object, Map<string, StateFieldMetadata>>();
-
-export function ObservedState(meta: StateFieldMetadata = {}): PropertyDecorator {
-  return (target, propertyKey) => {
-    let map = OBSERVED_STATE_FIELDS.get(target);
-    if (!map) {
-      map = new Map();
-      OBSERVED_STATE_FIELDS.set(target, map);
-    }
-    map.set(propertyKey.toString(), meta);
-  };
-}
-
-export function getObservedState(obj: any): SerializedWorkflowState {
-  const map = OBSERVED_STATE_FIELDS.get(Object.getPrototypeOf(obj));
-  if (!map) return {};
-  const result: SerializedWorkflowState = {};
-  for (const [key, meta] of map) {
-    let v = (obj as any)[key];
-    if (meta.redact) v = '***';
-    if (!meta.hidden) result[key] = v;
-  }
-  return result;
-}
-```
-
----
-
-### **@Step**
-
-```ts
-export function Step(opts: StepOptions = {}): MethodDecorator {
-  return (target, prop, descriptor: PropertyDescriptor) => {
-    const original = descriptor.value;
-
-    descriptor.value = async function (...args: any[]) {
-      const wf = this as Workflow;
-      const stepName = opts.name ?? String(prop);
-
-      if (opts.logStart) wf.logger.info(`STEP START: ${stepName}`);
-
-      wf.emitEvent({ type: 'stepStart', node: wf.node, step: stepName });
-
-      let start = Date.now();
-      try {
-        const result = await original.apply(this, args);
-
-        if (opts.snapshotState) wf.snapshotState();
-        if (opts.trackTiming) {
-          const duration = Date.now() - start;
-          wf.emitEvent({ type: 'stepEnd', node: wf.node, step: stepName, duration });
-        }
-
-        if (opts.logFinish) wf.logger.info(`STEP END: ${stepName}`);
-        return result;
-
-      } catch (err: any) {
-        const snap = getObservedState(wf);
-        const wfError: WorkflowError = {
-          message: err?.message ?? 'error',
-          original: err,
-          workflowId: wf.id,
-          stack: err?.stack,
-          state: snap,
-          logs: [...wf.node.logs],
-        };
-
-        wf.emitEvent({ type: 'error', node: wf.node, error: wfError });
-
-        throw wfError;
-      }
-    };
-  };
-}
-```
-
----
-
-### **@Task**
-
-```ts
-export function Task(opts: TaskOptions = {}): MethodDecorator {
-  return (target, prop, descriptor: PropertyDescriptor) => {
-    const original = descriptor.value;
-
-    descriptor.value = async function (...args: any[]) {
-      const wf = this as Workflow;
-      const taskName = opts.name ?? String(prop);
-
-      wf.emitEvent({ type: 'taskStart', node: wf.node, task: taskName });
-
-      const result = await original.apply(this, args);
-
-      // must return Workflow or Workflow[]
-      const workflows = Array.isArray(result) ? result : [result];
-      for (const child of workflows) {
-        if (!(child instanceof Workflow)) {
-          throw new Error(`@Task method "${taskName}" did not return a Workflow.`);
-        }
-        child.parent = wf;
-        wf.attachChild(child);
-      }
-
-      wf.emitEvent({ type: 'taskEnd', node: wf.node, task: taskName });
-
-      return result;
-    };
-  };
-}
-```
-
----
-
-# **13. Example Workflow Using the System**
-
-```ts
-class TestCycleWorkflow extends Workflow {
-  @ObservedState() currentTest!: string;
-
-  @Step({ snapshotState: true })
-  async generateTest() { /* ... */ }
-
-  @Step()
-  async runTest() { /* ... may throw ... */ }
-
-  @Step()
-  async updateImplementation() { /* ... */ }
-}
-
-class TDDOrchestrator extends Workflow {
-  @Step({ logStart: true })
-  async setupEnvironment() { /* ... */ }
-
-  @Task()
-  async runCycle() {
-    return new TestCycleWorkflow('Cycle', this);
-  }
-
-  async run() {
-    try {
-      await this.setupEnvironment();
-      await this.runCycle();
-    } catch (err) {
-      /* analyze & restart logic here */
-    }
-  }
-}
-```
-
----
-
-# **14. Acceptance Criteria (Updated)**
-
-This PRD now includes:
-
-* explicit interfaces
-* complete decorators
-* class skeletons
-* logger skeleton
-* observer system
-* real-time debugger interface
-* error/restart models
-* snapshot system
-
-A senior engineer should be able to implement the full engine from this PRD.