Files
devclaw-gitea/lib/services/tick.ts
Lauren ten Hoor dfeadf742a feat: make workflow states dynamic with XState-style statechart config (#147) (#160)
## Summary

Introduces a configurable workflow state machine that replaces all hardcoded
state labels. The default workflow matches current behavior exactly, ensuring
backward compatibility.

## Architecture

### lib/workflow.ts — Core workflow engine

XState-style statechart configuration:

```typescript
type StateConfig = {
  type: 'queue' | 'active' | 'hold' | 'terminal';
  role?: 'dev' | 'qa';
  label: string;
  color: string;
  priority?: number;
  on?: Record<string, TransitionTarget>;
};
```

All behavior is derived from the config:
- Queue states: `type: 'queue'`, grouped by role, ordered by priority
- Active states: `type: 'active'` — worker occupied
- Transitions: defined with optional actions (gitPull, detectPr, closeIssue, reopenIssue)
- Labels and colors: derived from state.label and state.color

### Derivation functions

- `getStateLabels()` — all labels for issue tracker sync
- `getLabelColors()` — label → color mapping
- `getQueueLabels(role)` — queue labels for a role, ordered by priority
- `getActiveLabel(role)` — the active/in-progress label for a role
- `getRevertLabel(role)` — queue label to revert to on failure
- `detectRoleFromLabel()` — detect role from a queue label
- `getCompletionRule(role, result)` — derive transition rule from config

## Files Changed

- **lib/workflow.ts** — NEW: workflow engine and default config
- **lib/providers/provider.ts** — deprecate STATE_LABELS, LABEL_COLORS; derive from workflow
- **lib/providers/github.ts** — use workflow config for label operations
- **lib/providers/gitlab.ts** — use workflow config for label operations
- **lib/services/pipeline.ts** — use getCompletionRule() from workflow
- **lib/services/tick.ts** — use workflow for queue/active labels
- **lib/services/health.ts** — use workflow for active/revert labels
- **lib/tools/work-start.ts** — use workflow for target label

## Backward Compatibility

- DEFAULT_WORKFLOW matches current hardcoded behavior exactly
- Deprecated exports kept for any external consumers
- No breaking changes to tool interfaces or project state

## Future Work

- Load per-project workflow overrides from projects.json
- User-facing config in projects/workflow.json
- Tool schema generation from workflow states
2026-02-13 18:50:09 +08:00

255 lines
9.1 KiB
TypeScript

/**
* tick.ts — Project-level queue scan + dispatch.
*
* Core function: projectTick() scans one project's queue and fills free worker slots.
* Called by: work_start (fill parallel slot), work_finish (next pipeline step), heartbeat service (sweep).
*/
import type { PluginRuntime } from "openclaw/plugin-sdk";
import type { Issue, StateLabel } from "../providers/provider.js";
import type { IssueProvider } from "../providers/provider.js";
import { createProvider } from "../providers/index.js";
import { selectLevel } from "../model-selector.js";
import { getWorker, getSessionForLevel, readProjects } from "../projects.js";
import { dispatchTask } from "../dispatch.js";
import { DEV_LEVELS, QA_LEVELS, isDevLevel } from "../tiers.js";
import {
DEFAULT_WORKFLOW,
getQueueLabels,
getAllQueueLabels,
getActiveLabel,
detectRoleFromLabel as workflowDetectRole,
type WorkflowConfig,
type Role,
} from "../workflow.js";
// ---------------------------------------------------------------------------
// Backward compatibility exports (deprecated)
// ---------------------------------------------------------------------------
/**
* @deprecated Use getQueueLabels(workflow, "dev") instead.
*/
export const DEV_LABELS: StateLabel[] = getQueueLabels(DEFAULT_WORKFLOW, "dev");
/**
* @deprecated Use getQueueLabels(workflow, "qa") instead.
*/
export const QA_LABELS: StateLabel[] = getQueueLabels(DEFAULT_WORKFLOW, "qa");
/**
* @deprecated Use getAllQueueLabels(workflow) instead.
*/
export const PRIORITY_ORDER: StateLabel[] = getAllQueueLabels(DEFAULT_WORKFLOW);
// ---------------------------------------------------------------------------
// Shared helpers (used by tick, work-start, auto-pickup)
// ---------------------------------------------------------------------------
export function detectLevelFromLabels(labels: string[]): string | null {
const lower = labels.map((l) => l.toLowerCase());
// Match role.level labels (e.g., "dev.senior", "qa.reviewer")
for (const l of lower) {
const dot = l.indexOf(".");
if (dot === -1) continue;
const role = l.slice(0, dot);
const level = l.slice(dot + 1);
if (role === "dev" && (DEV_LEVELS as readonly string[]).includes(level)) return level;
if (role === "qa" && (QA_LEVELS as readonly string[]).includes(level)) return level;
}
// Fallback: plain level name
const all = [...DEV_LEVELS, ...QA_LEVELS] as readonly string[];
return all.find((l) => lower.includes(l)) ?? null;
}
/**
* Detect role from a label using workflow config.
*/
export function detectRoleFromLabel(
label: StateLabel,
workflow: WorkflowConfig = DEFAULT_WORKFLOW,
): Role | null {
return workflowDetectRole(workflow, label);
}
export async function findNextIssueForRole(
provider: Pick<IssueProvider, "listIssuesByLabel">,
role: Role,
workflow: WorkflowConfig = DEFAULT_WORKFLOW,
): Promise<{ issue: Issue; label: StateLabel } | null> {
const labels = getQueueLabels(workflow, role);
for (const label of labels) {
try {
const issues = await provider.listIssuesByLabel(label);
if (issues.length > 0) return { issue: issues[issues.length - 1], label };
} catch { /* continue */ }
}
return null;
}
/**
* Find next issue for any role (optional filter). Used by work_start for auto-detection.
*/
export async function findNextIssue(
provider: Pick<IssueProvider, "listIssuesByLabel">,
role?: Role,
workflow: WorkflowConfig = DEFAULT_WORKFLOW,
): Promise<{ issue: Issue; label: StateLabel } | null> {
const labels = role
? getQueueLabels(workflow, role)
: getAllQueueLabels(workflow);
for (const label of labels) {
try {
const issues = await provider.listIssuesByLabel(label);
if (issues.length > 0) return { issue: issues[issues.length - 1], label };
} catch { /* continue */ }
}
return null;
}
// ---------------------------------------------------------------------------
// projectTick
// ---------------------------------------------------------------------------
export type TickAction = {
project: string;
groupId: string;
issueId: number;
issueTitle: string;
issueUrl: string;
role: Role;
level: string;
sessionAction: "spawn" | "send";
announcement: string;
};
export type TickResult = {
pickups: TickAction[];
skipped: Array<{ role?: string; reason: string }>;
};
/**
* Scan one project's queue and fill free worker slots.
*
* Does NOT run health checks (that's the heartbeat service's job).
* Non-destructive: only dispatches if slots are free and issues are queued.
*/
export async function projectTick(opts: {
workspaceDir: string;
groupId: string;
agentId?: string;
sessionKey?: string;
pluginConfig?: Record<string, unknown>;
dryRun?: boolean;
maxPickups?: number;
/** Only attempt this role. Used by work_start to fill the other slot. */
targetRole?: Role;
/** Optional provider override (for testing). Uses createProvider if omitted. */
provider?: Pick<IssueProvider, "listIssuesByLabel" | "transitionLabel" | "listComments">;
/** Plugin runtime for direct API access (avoids CLI subprocess timeouts) */
runtime?: PluginRuntime;
/** Workflow config (defaults to DEFAULT_WORKFLOW) */
workflow?: WorkflowConfig;
}): Promise<TickResult> {
const {
workspaceDir, groupId, agentId, sessionKey, pluginConfig, dryRun,
maxPickups, targetRole, runtime,
workflow = DEFAULT_WORKFLOW,
} = opts;
const project = (await readProjects(workspaceDir)).projects[groupId];
if (!project) return { pickups: [], skipped: [{ reason: `Project not found: ${groupId}` }] };
const provider = opts.provider ?? (await createProvider({ repo: project.repo })).provider;
const roleExecution = project.roleExecution ?? "parallel";
const roles: Role[] = targetRole ? [targetRole] : ["dev", "qa"];
const pickups: TickAction[] = [];
const skipped: TickResult["skipped"] = [];
let pickupCount = 0;
for (const role of roles) {
if (maxPickups !== undefined && pickupCount >= maxPickups) {
skipped.push({ role, reason: "Max pickups reached" });
continue;
}
// Re-read fresh state (previous dispatch may have changed it)
const fresh = (await readProjects(workspaceDir)).projects[groupId];
if (!fresh) break;
const worker = getWorker(fresh, role);
if (worker.active) {
skipped.push({ role, reason: `Already active (#${worker.issueId})` });
continue;
}
if (roleExecution === "sequential" && getWorker(fresh, role === "dev" ? "qa" : "dev").active) {
skipped.push({ role, reason: "Sequential: other role active" });
continue;
}
const next = await findNextIssueForRole(provider, role, workflow);
if (!next) continue;
const { issue, label: currentLabel } = next;
const targetLabel = getActiveLabel(workflow, role);
// Level selection: label → heuristic
const selectedLevel = resolveLevelForIssue(issue, role);
if (dryRun) {
pickups.push({
project: project.name, groupId, issueId: issue.iid, issueTitle: issue.title, issueUrl: issue.web_url,
role, level: selectedLevel,
sessionAction: getSessionForLevel(worker, selectedLevel) ? "send" : "spawn",
announcement: `[DRY RUN] Would pick up #${issue.iid}`,
});
} else {
try {
const dr = await dispatchTask({
workspaceDir, agentId, groupId, project: fresh, issueId: issue.iid,
issueTitle: issue.title, issueDescription: issue.description ?? "", issueUrl: issue.web_url,
role, level: selectedLevel, fromLabel: currentLabel, toLabel: targetLabel,
transitionLabel: (id, from, to) => provider.transitionLabel(id, from as StateLabel, to as StateLabel),
provider: provider as IssueProvider,
pluginConfig,
channel: fresh.channel,
sessionKey,
runtime,
});
pickups.push({
project: project.name, groupId, issueId: issue.iid, issueTitle: issue.title, issueUrl: issue.web_url,
role, level: dr.level, sessionAction: dr.sessionAction, announcement: dr.announcement,
});
} catch (err) {
skipped.push({ role, reason: `Dispatch failed: ${(err as Error).message}` });
continue;
}
}
pickupCount++;
}
return { pickups, skipped };
}
// ---------------------------------------------------------------------------
// Private helpers
// ---------------------------------------------------------------------------
/**
* Determine the level for an issue based on labels, role overrides, and heuristic fallback.
*/
function resolveLevelForIssue(issue: Issue, role: Role): string {
const labelLevel = detectLevelFromLabels(issue.labels);
if (labelLevel) {
// QA role but label specifies a dev level → heuristic picks the right QA level
if (role === "qa" && isDevLevel(labelLevel)) return selectLevel(issue.title, issue.description ?? "", role).level;
// DEV role but label specifies a QA level → heuristic picks the right dev level
if (role === "dev" && !isDevLevel(labelLevel)) return selectLevel(issue.title, issue.description ?? "", role).level;
return labelLevel;
}
return selectLevel(issue.title, issue.description ?? "", role).level;
}