PLG-CAL-002: Implement calendar scheduler for agent slot wakeup

- Add CalendarScheduler class to manage periodic heartbeat and slot execution
- Implement agent wakeup logic when Idle and slots are pending
- Handle slot status transitions (attended, ongoing, deferred)
- Support both real and virtual slot materialization
- Add task context building for different event types (job, system, entertainment)
- Integrate scheduler into main plugin index.ts
- Add new plugin tools: harborforge_calendar_status, complete, abort
This commit is contained in:
zhi
2026-04-01 08:45:05 +00:00
parent 55d7d11a52
commit 97021f97c0
11 changed files with 1698 additions and 16 deletions

View File

@@ -2,22 +2,32 @@
* HarborForge Calendar — Plugin Module
*
* PLG-CAL-001: Calendar heartbeat request/response format definition.
* PLG-CAL-002: Plugin-side slot execution scheduler and agent wakeup.
*
* Exports:
* • Types for heartbeat request/response and slot update
* • CalendarBridgeClient — HTTP client for backend communication
* • createCalendarBridgeClient — factory from plugin API context
* • CalendarScheduler — manages periodic heartbeat and slot execution
* • createCalendarScheduler — factory for scheduler
* • AgentWakeContext — context passed to agent when waking
*
* Usage in plugin/index.ts:
* import { createCalendarBridgeClient } from './calendar';
* import { createCalendarBridgeClient, createCalendarScheduler } from './calendar';
*
* const agentId = process.env.AGENT_ID || 'unknown';
* const calendar = createCalendarBridgeClient(api, 'https://monitor.hangman-lab.top', agentId);
*
* // Inside gateway_start or heartbeat tick:
* const result = await calendar.heartbeat();
* if (result?.slots.length) { /* handle pending slots /\ }
* const scheduler = createCalendarScheduler({
* bridge: calendar,
* getAgentStatus: async () => { ... },
* wakeAgent: async (context) => { ... },
* logger: api.logger,
* });
*
* scheduler.start();
*/
export * from './types';
export * from './calendar-bridge';
export * from './scheduler';
//# sourceMappingURL=index.d.ts.map

View File

@@ -1 +1 @@
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;GAmBG;AAEH,cAAc,SAAS,CAAC;AACxB,cAAc,mBAAmB,CAAC"}
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA4BG;AAEH,cAAc,SAAS,CAAC;AACxB,cAAc,mBAAmB,CAAC;AAClC,cAAc,aAAa,CAAC"}

View File

@@ -3,21 +3,30 @@
* HarborForge Calendar — Plugin Module
*
* PLG-CAL-001: Calendar heartbeat request/response format definition.
* PLG-CAL-002: Plugin-side slot execution scheduler and agent wakeup.
*
* Exports:
* • Types for heartbeat request/response and slot update
* • CalendarBridgeClient — HTTP client for backend communication
* • createCalendarBridgeClient — factory from plugin API context
* • CalendarScheduler — manages periodic heartbeat and slot execution
* • createCalendarScheduler — factory for scheduler
* • AgentWakeContext — context passed to agent when waking
*
* Usage in plugin/index.ts:
* import { createCalendarBridgeClient } from './calendar';
* import { createCalendarBridgeClient, createCalendarScheduler } from './calendar';
*
* const agentId = process.env.AGENT_ID || 'unknown';
* const calendar = createCalendarBridgeClient(api, 'https://monitor.hangman-lab.top', agentId);
*
* // Inside gateway_start or heartbeat tick:
* const result = await calendar.heartbeat();
* if (result?.slots.length) { /* handle pending slots /\ }
* const scheduler = createCalendarScheduler({
* bridge: calendar,
* getAgentStatus: async () => { ... },
* wakeAgent: async (context) => { ... },
* logger: api.logger,
* });
*
* scheduler.start();
*/
var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
if (k2 === undefined) k2 = k;
@@ -36,4 +45,5 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
Object.defineProperty(exports, "__esModule", { value: true });
__exportStar(require("./types"), exports);
__exportStar(require("./calendar-bridge"), exports);
__exportStar(require("./scheduler"), exports);
//# sourceMappingURL=index.js.map

View File

@@ -1 +1 @@
{"version":3,"file":"index.js","sourceRoot":"","sources":["index.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;;;;;GAmBG;;;;;;;;;;;;;;;;AAEH,0CAAwB;AACxB,oDAAkC"}
{"version":3,"file":"index.js","sourceRoot":"","sources":["index.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA4BG;;;;;;;;;;;;;;;;AAEH,0CAAwB;AACxB,oDAAkC;AAClC,8CAA4B"}

View File

@@ -2,22 +2,32 @@
* HarborForge Calendar — Plugin Module
*
* PLG-CAL-001: Calendar heartbeat request/response format definition.
* PLG-CAL-002: Plugin-side slot execution scheduler and agent wakeup.
*
* Exports:
* • Types for heartbeat request/response and slot update
* • CalendarBridgeClient — HTTP client for backend communication
* • createCalendarBridgeClient — factory from plugin API context
* • CalendarScheduler — manages periodic heartbeat and slot execution
* • createCalendarScheduler — factory for scheduler
* • AgentWakeContext — context passed to agent when waking
*
* Usage in plugin/index.ts:
* import { createCalendarBridgeClient } from './calendar';
* import { createCalendarBridgeClient, createCalendarScheduler } from './calendar';
*
* const agentId = process.env.AGENT_ID || 'unknown';
* const calendar = createCalendarBridgeClient(api, 'https://monitor.hangman-lab.top', agentId);
*
* // Inside gateway_start or heartbeat tick:
* const result = await calendar.heartbeat();
* if (result?.slots.length) { /* handle pending slots /\ }
* const scheduler = createCalendarScheduler({
* bridge: calendar,
* getAgentStatus: async () => { ... },
* wakeAgent: async (context) => { ... },
* logger: api.logger,
* });
*
* scheduler.start();
*/
export * from './types';
export * from './calendar-bridge';
export * from './scheduler';

184
plugin/calendar/scheduler.d.ts vendored Normal file
View File

@@ -0,0 +1,184 @@
/**
* HarborForge Calendar Scheduler
*
* PLG-CAL-002: Plugin-side handling for pending slot execution.
*
* Responsibilities:
* - Run calendar heartbeat every minute
* - Detect when agent is Idle and slots are pending
* - Wake agent with task context
* - Handle slot status transitions (attended, ongoing, deferred)
* - Manage agent status transitions (idle → busy/on_call)
*
* Design reference: NEXT_WAVE_DEV_DIRECTION.md §6 (Agent wakeup mechanism)
*/
import { CalendarBridgeClient } from './calendar-bridge';
import { CalendarSlotResponse, AgentStatusValue } from './types';
export interface CalendarSchedulerConfig {
/** Calendar bridge client for backend communication */
bridge: CalendarBridgeClient;
/** Function to get current agent status from backend */
getAgentStatus: () => Promise<AgentStatusValue | null>;
/** Function to wake/spawn agent with task context */
wakeAgent: (context: AgentWakeContext) => Promise<boolean>;
/** Logger instance */
logger: {
info: (...args: any[]) => void;
error: (...args: any[]) => void;
debug: (...args: any[]) => void;
warn: (...args: any[]) => void;
};
/** Heartbeat interval in milliseconds (default: 60000) */
heartbeatIntervalMs?: number;
/** Enable verbose debug logging */
debug?: boolean;
}
/**
* Context passed to agent when waking for slot execution.
* This is the payload the agent receives to understand what to do.
*/
export interface AgentWakeContext {
/** The slot to execute */
slot: CalendarSlotResponse;
/** Human-readable task description */
taskDescription: string;
/** Prompt/instructions for the agent */
prompt: string;
/** Whether this is a virtual slot (needs materialization) */
isVirtual: boolean;
}
/**
* Current execution state tracked by the scheduler.
*/
interface SchedulerState {
/** Whether scheduler is currently running */
isRunning: boolean;
/** Currently executing slot (null if idle) */
currentSlot: CalendarSlotResponse | null;
/** Last heartbeat timestamp */
lastHeartbeatAt: Date | null;
/** Interval handle for cleanup */
intervalHandle: ReturnType<typeof setInterval> | null;
/** Set of slot IDs that have been deferred in current session */
deferredSlotIds: Set<string>;
/** Whether agent is currently processing a slot */
isProcessing: boolean;
}
/**
* CalendarScheduler manages the periodic heartbeat and slot execution lifecycle.
*/
export declare class CalendarScheduler {
private config;
private state;
constructor(config: CalendarSchedulerConfig);
/**
* Start the calendar scheduler.
* Begins periodic heartbeat to check for pending slots.
*/
start(): void;
/**
* Stop the calendar scheduler.
* Cleans up intervals and resets state.
*/
stop(): void;
/**
* Execute a single heartbeat cycle.
* Fetches pending slots and handles execution logic.
*/
runHeartbeat(): Promise<void>;
/**
* Handle slots when agent is not idle.
* Defer all pending slots with priority boost.
*/
private handleNonIdleAgent;
/**
* Handle slots when agent is idle.
* Select highest priority slot and wake agent.
*/
private handleIdleAgent;
/**
* Execute a slot by waking the agent.
*/
private executeSlot;
/**
* Build the wake context for an agent based on slot details.
*/
private buildWakeContext;
/**
* Build prompt for job-type slots.
*/
private buildJobPrompt;
/**
* Build prompt for system event slots.
*/
private buildSystemPrompt;
/**
* Build prompt for entertainment slots.
*/
private buildEntertainmentPrompt;
/**
* Build generic prompt for slots without specific event data.
*/
private buildGenericPrompt;
/**
* Mark a slot as deferred with priority boost.
*/
private deferSlot;
/**
* Revert a slot to not_started status after failed execution attempt.
*/
private revertSlot;
/**
* Complete the current slot execution.
* Call this when the agent finishes the task.
*/
completeCurrentSlot(actualDurationMinutes: number): Promise<void>;
/**
* Abort the current slot execution.
* Call this when the agent cannot complete the task.
*/
abortCurrentSlot(reason?: string): Promise<void>;
/**
* Pause the current slot execution.
* Call this when the agent needs to temporarily pause.
*/
pauseCurrentSlot(): Promise<void>;
/**
* Resume a paused slot.
*/
resumeCurrentSlot(): Promise<void>;
/**
* Get a stable ID for a slot (real or virtual).
*/
private getSlotId;
/**
* Format a Date as ISO time string (HH:MM:SS).
*/
private formatTime;
/**
* Debug logging helper.
*/
private logDebug;
/**
* Get current scheduler state (for introspection).
*/
getState(): Readonly<SchedulerState>;
/**
* Check if scheduler is running.
*/
isRunning(): boolean;
/**
* Check if currently processing a slot.
*/
isProcessing(): boolean;
/**
* Get the current slot being executed (if any).
*/
getCurrentSlot(): CalendarSlotResponse | null;
}
/**
* Factory function to create a CalendarScheduler from plugin context.
*/
export declare function createCalendarScheduler(config: CalendarSchedulerConfig): CalendarScheduler;
export {};
//# sourceMappingURL=scheduler.d.ts.map

View File

@@ -0,0 +1 @@
{"version":3,"file":"scheduler.d.ts","sourceRoot":"","sources":["scheduler.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;GAaG;AAEH,OAAO,EACL,oBAAoB,EACrB,MAAM,mBAAmB,CAAC;AAC3B,OAAO,EACL,oBAAoB,EAEpB,gBAAgB,EAIjB,MAAM,SAAS,CAAC;AAEjB,MAAM,WAAW,uBAAuB;IACtC,uDAAuD;IACvD,MAAM,EAAE,oBAAoB,CAAC;IAC7B,wDAAwD;IACxD,cAAc,EAAE,MAAM,OAAO,CAAC,gBAAgB,GAAG,IAAI,CAAC,CAAC;IACvD,qDAAqD;IACrD,SAAS,EAAE,CAAC,OAAO,EAAE,gBAAgB,KAAK,OAAO,CAAC,OAAO,CAAC,CAAC;IAC3D,sBAAsB;IACtB,MAAM,EAAE;QACN,IAAI,EAAE,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,IAAI,CAAC;QAC/B,KAAK,EAAE,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,IAAI,CAAC;QAChC,KAAK,EAAE,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,IAAI,CAAC;QAChC,IAAI,EAAE,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,IAAI,CAAC;KAChC,CAAC;IACF,0DAA0D;IAC1D,mBAAmB,CAAC,EAAE,MAAM,CAAC;IAC7B,mCAAmC;IACnC,KAAK,CAAC,EAAE,OAAO,CAAC;CACjB;AAED;;;GAGG;AACH,MAAM,WAAW,gBAAgB;IAC/B,0BAA0B;IAC1B,IAAI,EAAE,oBAAoB,CAAC;IAC3B,sCAAsC;IACtC,eAAe,EAAE,MAAM,CAAC;IACxB,wCAAwC;IACxC,MAAM,EAAE,MAAM,CAAC;IACf,6DAA6D;IAC7D,SAAS,EAAE,OAAO,CAAC;CACpB;AAED;;GAEG;AACH,UAAU,cAAc;IACtB,6CAA6C;IAC7C,SAAS,EAAE,OAAO,CAAC;IACnB,8CAA8C;IAC9C,WAAW,EAAE,oBAAoB,GAAG,IAAI,CAAC;IACzC,+BAA+B;IAC/B,eAAe,EAAE,IAAI,GAAG,IAAI,CAAC;IAC7B,kCAAkC;IAClC,cAAc,EAAE,UAAU,CAAC,OAAO,WAAW,CAAC,GAAG,IAAI,CAAC;IACtD,iEAAiE;IACjE,eAAe,EAAE,GAAG,CAAC,MAAM,CAAC,CAAC;IAC7B,mDAAmD;IACnD,YAAY,EAAE,OAAO,CAAC;CACvB;AAED;;GAEG;AACH,qBAAa,iBAAiB;IAC5B,OAAO,CAAC,MAAM,CAAoC;IAClD,OAAO,CAAC,KAAK,CAAiB;gBAElB,MAAM,EAAE,uBAAuB;IAgB3C;;;OAGG;IACH,KAAK,IAAI,IAAI;IAmBb;;;OAGG;IACH,IAAI,IAAI,IAAI;IAWZ;;;OAGG;IACG,YAAY,IAAI,OAAO,CAAC,IAAI,CAAC;IAgCnC;;;OAGG;YACW,kBAAkB;IA0BhC;;;OAGG;YACW,eAAe;IAiC7B;;OAEG;YACW,WAAW;IAiEzB;;OAEG;IACH,OAAO,CAAC,gBAAgB;IAgCxB;;OAEG;IACH,OAAO,CAAC,cAAc;IAoBtB;;OAEG;IACH,OAAO,CAAC,iBAAiB;IAwCzB;;OAEG;IACH,OAAO,CAAC,wBAAwB;IAShC;;OAEG;IACH,OAAO,CAAC,kBAAkB;IAU1B;;OAEG;YACW,SAAS;IAiBvB;;OAEG;YACW,UAAU;IAiBxB;;;OAGG;IACG,mBAAmB,CAAC,qBAAqB,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAkCvE;;;OAGG;IACG,gBAAgB,CAAC,MAAM,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAiCtD;;;OAGG;IACG,gBAAgB,IAAI,OAAO,CAAC,IAAI,CAAC;IAyBvC;;OAEG;IACG,iBAAiB,IAAI,OAAO,CAAC,IAAI,CAAC;IAyBxC;;OAEG;IACH,OAAO,CAAC,SAAS;IAIjB;;OAEG;IACH,OAAO,CAAC,UAAU;IAIlB;;OAEG;IACH,OAAO,CAAC,QAAQ;IAMhB;;OAEG;IACH,QAAQ,IAAI,QAAQ,CAAC,cAAc,CAAC;IAIpC;;OAEG;IACH,SAAS,IAAI,OAAO;IAIpB;;OAEG;IACH,YAAY,IAAI,OAAO;IAIvB;;OAEG;IACH,cAAc,IAAI,oBAAoB,GAAG,IAAI;CAG9C;AAED;;GAEG;AACH,wBAAgB,uBAAuB,CACrC,MAAM,EAAE,uBAAuB,GAC9B,iBAAiB,CAEnB"}

View File

@@ -0,0 +1,526 @@
"use strict";
/**
* HarborForge Calendar Scheduler
*
* PLG-CAL-002: Plugin-side handling for pending slot execution.
*
* Responsibilities:
* - Run calendar heartbeat every minute
* - Detect when agent is Idle and slots are pending
* - Wake agent with task context
* - Handle slot status transitions (attended, ongoing, deferred)
* - Manage agent status transitions (idle → busy/on_call)
*
* Design reference: NEXT_WAVE_DEV_DIRECTION.md §6 (Agent wakeup mechanism)
*/
Object.defineProperty(exports, "__esModule", { value: true });
exports.CalendarScheduler = void 0;
exports.createCalendarScheduler = createCalendarScheduler;
const types_1 = require("./types");
/**
* CalendarScheduler manages the periodic heartbeat and slot execution lifecycle.
*/
class CalendarScheduler {
config;
state;
constructor(config) {
this.config = {
heartbeatIntervalMs: 60000, // 1 minute default
debug: false,
...config,
};
this.state = {
isRunning: false,
currentSlot: null,
lastHeartbeatAt: null,
intervalHandle: null,
deferredSlotIds: new Set(),
isProcessing: false,
};
}
/**
* Start the calendar scheduler.
* Begins periodic heartbeat to check for pending slots.
*/
start() {
if (this.state.isRunning) {
this.config.logger.warn('Calendar scheduler already running');
return;
}
this.state.isRunning = true;
this.config.logger.info('Calendar scheduler started');
// Run initial heartbeat immediately
this.runHeartbeat();
// Schedule periodic heartbeats
this.state.intervalHandle = setInterval(() => this.runHeartbeat(), this.config.heartbeatIntervalMs);
}
/**
* Stop the calendar scheduler.
* Cleans up intervals and resets state.
*/
stop() {
this.state.isRunning = false;
if (this.state.intervalHandle) {
clearInterval(this.state.intervalHandle);
this.state.intervalHandle = null;
}
this.config.logger.info('Calendar scheduler stopped');
}
/**
* Execute a single heartbeat cycle.
* Fetches pending slots and handles execution logic.
*/
async runHeartbeat() {
if (!this.state.isRunning) {
return;
}
this.state.lastHeartbeatAt = new Date();
try {
// Fetch pending slots from backend
const response = await this.config.bridge.heartbeat();
if (!response) {
this.logDebug('Heartbeat: backend unreachable');
return;
}
this.logDebug(`Heartbeat: ${response.slots.length} slots pending, agent_status=${response.agent_status}`);
// If agent is not idle, defer all pending slots
if (response.agent_status !== 'idle') {
await this.handleNonIdleAgent(response.slots, response.agent_status);
return;
}
// Agent is idle - handle pending slots
await this.handleIdleAgent(response.slots);
}
catch (err) {
this.config.logger.error('Heartbeat error:', err);
}
}
/**
* Handle slots when agent is not idle.
* Defer all pending slots with priority boost.
*/
async handleNonIdleAgent(slots, agentStatus) {
if (slots.length === 0) {
return;
}
this.config.logger.info(`Agent not idle (status=${agentStatus}), deferring ${slots.length} slot(s)`);
for (const slot of slots) {
const slotId = this.getSlotId(slot);
// Skip if already deferred this session
if (this.state.deferredSlotIds.has(slotId)) {
continue;
}
// Mark slot as deferred with priority boost (+1)
await this.deferSlot(slot);
this.state.deferredSlotIds.add(slotId);
}
}
/**
* Handle slots when agent is idle.
* Select highest priority slot and wake agent.
*/
async handleIdleAgent(slots) {
if (slots.length === 0) {
return;
}
// Filter out already deferred slots in this session
const eligibleSlots = slots.filter(s => !this.state.deferredSlotIds.has(this.getSlotId(s)));
if (eligibleSlots.length === 0) {
this.logDebug('All pending slots have been deferred this session');
return;
}
// Select highest priority slot (backend already sorts by priority DESC)
const [selectedSlot, ...remainingSlots] = eligibleSlots;
this.config.logger.info(`Selected slot for execution: id=${this.getSlotId(selectedSlot)}, ` +
`type=${selectedSlot.slot_type}, priority=${selectedSlot.priority}`);
// Mark remaining slots as deferred
for (const slot of remainingSlots) {
await this.deferSlot(slot);
this.state.deferredSlotIds.add(this.getSlotId(slot));
}
// Wake agent to execute selected slot
await this.executeSlot(selectedSlot);
}
/**
* Execute a slot by waking the agent.
*/
async executeSlot(slot) {
if (this.state.isProcessing) {
this.config.logger.warn('Already processing a slot, deferring new slot');
await this.deferSlot(slot);
return;
}
this.state.isProcessing = true;
this.state.currentSlot = slot;
try {
// Mark slot as attended and ongoing before waking agent
const update = {
status: types_1.SlotStatus.ONGOING,
started_at: this.formatTime(new Date()),
};
let updateSuccess;
if (slot.id) {
updateSuccess = await this.config.bridge.updateSlot(slot.id, update);
}
else if (slot.virtual_id) {
const updated = await this.config.bridge.updateVirtualSlot(slot.virtual_id, update);
updateSuccess = updated !== null;
// Update slot reference if materialized
if (updated) {
this.state.currentSlot = updated;
}
}
else {
updateSuccess = false;
}
if (!updateSuccess) {
this.config.logger.error('Failed to update slot status before execution');
this.state.isProcessing = false;
this.state.currentSlot = null;
return;
}
// Report agent status change to backend
const newAgentStatus = slot.slot_type === 'on_call' ? 'on_call' : 'busy';
await this.config.bridge.reportAgentStatus({ status: newAgentStatus });
// Build wake context for agent
const wakeContext = this.buildWakeContext(slot);
// Wake the agent
const wakeSuccess = await this.config.wakeAgent(wakeContext);
if (!wakeSuccess) {
this.config.logger.error('Failed to wake agent for slot execution');
// Revert slot to not_started status
await this.revertSlot(slot);
await this.config.bridge.reportAgentStatus({ status: 'idle' });
}
// Note: isProcessing remains true until agent signals completion
// This is handled by external completion callback
}
catch (err) {
this.config.logger.error('Error executing slot:', err);
this.state.isProcessing = false;
this.state.currentSlot = null;
}
}
/**
* Build the wake context for an agent based on slot details.
*/
buildWakeContext(slot) {
const isVirtual = slot.virtual_id !== null;
const slotId = this.getSlotId(slot);
// Build task description based on event type
let taskDescription;
let prompt;
if (slot.event_type === 'job' && slot.event_data) {
const jobData = slot.event_data;
taskDescription = `${jobData.type} ${jobData.code}`;
prompt = this.buildJobPrompt(slot, jobData);
}
else if (slot.event_type === 'system_event' && slot.event_data) {
const sysData = slot.event_data;
taskDescription = `System Event: ${sysData.event}`;
prompt = this.buildSystemPrompt(slot, sysData);
}
else if (slot.event_type === 'entertainment') {
taskDescription = 'Entertainment slot';
prompt = this.buildEntertainmentPrompt(slot);
}
else {
taskDescription = `Generic ${slot.slot_type} slot`;
prompt = this.buildGenericPrompt(slot);
}
return {
slot,
taskDescription,
prompt,
isVirtual,
};
}
/**
* Build prompt for job-type slots.
*/
buildJobPrompt(slot, jobData) {
const duration = slot.estimated_duration;
const type = jobData.type;
const code = jobData.code;
return `You have a scheduled ${type} job to work on.
Task Code: ${code}
Estimated Duration: ${duration} minutes
Slot Type: ${slot.slot_type}
Priority: ${slot.priority}
Please focus on this task for the allocated time. When you finish or need to pause,
report your progress back to the calendar system.
Working sessions: ${jobData.working_sessions?.join(', ') || 'none recorded'}
Start working on ${code} now.`;
}
/**
* Build prompt for system event slots.
*/
buildSystemPrompt(slot, sysData) {
switch (sysData.event) {
case 'ScheduleToday':
return `System Event: Schedule Today
Please review today's calendar and schedule any pending tasks or planning activities.
Estimated time: ${slot.estimated_duration} minutes.
Check your calendar and plan the day's work.`;
case 'SummaryToday':
return `System Event: Daily Summary
Please provide a summary of today's activities and progress.
Estimated time: ${slot.estimated_duration} minutes.
Review what was accomplished and prepare end-of-day notes.`;
case 'ScheduledGatewayRestart':
return `System Event: Scheduled Gateway Restart
The OpenClaw gateway is scheduled to restart soon.
Please:
1. Persist any important state
2. Complete or gracefully pause current tasks
3. Prepare for restart
Time remaining: ${slot.estimated_duration} minutes.`;
default:
return `System Event: ${sysData.event}
A system event has been scheduled. Please handle accordingly.
Estimated time: ${slot.estimated_duration} minutes.`;
}
}
/**
* Build prompt for entertainment slots.
*/
buildEntertainmentPrompt(slot) {
return `Scheduled Entertainment Break
Duration: ${slot.estimated_duration} minutes
Take a break and enjoy some leisure time. This slot is reserved for non-work activities
to help maintain work-life balance.`;
}
/**
* Build generic prompt for slots without specific event data.
*/
buildGenericPrompt(slot) {
return `Scheduled Calendar Slot
Type: ${slot.slot_type}
Duration: ${slot.estimated_duration} minutes
Priority: ${slot.priority}
Please use this time for the scheduled activity.`;
}
/**
* Mark a slot as deferred with priority boost.
*/
async deferSlot(slot) {
const update = {
status: types_1.SlotStatus.DEFERRED,
};
try {
if (slot.id) {
await this.config.bridge.updateSlot(slot.id, update);
}
else if (slot.virtual_id) {
await this.config.bridge.updateVirtualSlot(slot.virtual_id, update);
}
this.logDebug(`Deferred slot: ${this.getSlotId(slot)}`);
}
catch (err) {
this.config.logger.error('Failed to defer slot:', err);
}
}
/**
* Revert a slot to not_started status after failed execution attempt.
*/
async revertSlot(slot) {
const update = {
status: types_1.SlotStatus.NOT_STARTED,
started_at: undefined,
};
try {
if (slot.id) {
await this.config.bridge.updateSlot(slot.id, update);
}
else if (slot.virtual_id) {
await this.config.bridge.updateVirtualSlot(slot.virtual_id, update);
}
}
catch (err) {
this.config.logger.error('Failed to revert slot:', err);
}
}
/**
* Complete the current slot execution.
* Call this when the agent finishes the task.
*/
async completeCurrentSlot(actualDurationMinutes) {
if (!this.state.currentSlot) {
this.config.logger.warn('No current slot to complete');
return;
}
const slot = this.state.currentSlot;
const update = {
status: types_1.SlotStatus.FINISHED,
actual_duration: actualDurationMinutes,
};
try {
if (slot.id) {
await this.config.bridge.updateSlot(slot.id, update);
}
else if (slot.virtual_id) {
await this.config.bridge.updateVirtualSlot(slot.virtual_id, update);
}
// Report agent back to idle
await this.config.bridge.reportAgentStatus({ status: 'idle' });
this.config.logger.info(`Completed slot ${this.getSlotId(slot)}, actual_duration=${actualDurationMinutes}min`);
}
catch (err) {
this.config.logger.error('Failed to complete slot:', err);
}
finally {
this.state.isProcessing = false;
this.state.currentSlot = null;
}
}
/**
* Abort the current slot execution.
* Call this when the agent cannot complete the task.
*/
async abortCurrentSlot(reason) {
if (!this.state.currentSlot) {
this.config.logger.warn('No current slot to abort');
return;
}
const slot = this.state.currentSlot;
const update = {
status: types_1.SlotStatus.ABORTED,
};
try {
if (slot.id) {
await this.config.bridge.updateSlot(slot.id, update);
}
else if (slot.virtual_id) {
await this.config.bridge.updateVirtualSlot(slot.virtual_id, update);
}
// Report agent back to idle
await this.config.bridge.reportAgentStatus({ status: 'idle' });
this.config.logger.info(`Aborted slot ${this.getSlotId(slot)}${reason ? `: ${reason}` : ''}`);
}
catch (err) {
this.config.logger.error('Failed to abort slot:', err);
}
finally {
this.state.isProcessing = false;
this.state.currentSlot = null;
}
}
/**
* Pause the current slot execution.
* Call this when the agent needs to temporarily pause.
*/
async pauseCurrentSlot() {
if (!this.state.currentSlot) {
this.config.logger.warn('No current slot to pause');
return;
}
const slot = this.state.currentSlot;
const update = {
status: types_1.SlotStatus.PAUSED,
};
try {
if (slot.id) {
await this.config.bridge.updateSlot(slot.id, update);
}
else if (slot.virtual_id) {
await this.config.bridge.updateVirtualSlot(slot.virtual_id, update);
}
this.config.logger.info(`Paused slot ${this.getSlotId(slot)}`);
}
catch (err) {
this.config.logger.error('Failed to pause slot:', err);
}
}
/**
* Resume a paused slot.
*/
async resumeCurrentSlot() {
if (!this.state.currentSlot) {
this.config.logger.warn('No current slot to resume');
return;
}
const slot = this.state.currentSlot;
const update = {
status: types_1.SlotStatus.ONGOING,
};
try {
if (slot.id) {
await this.config.bridge.updateSlot(slot.id, update);
}
else if (slot.virtual_id) {
await this.config.bridge.updateVirtualSlot(slot.virtual_id, update);
}
this.config.logger.info(`Resumed slot ${this.getSlotId(slot)}`);
}
catch (err) {
this.config.logger.error('Failed to resume slot:', err);
}
}
/**
* Get a stable ID for a slot (real or virtual).
*/
getSlotId(slot) {
return slot.id?.toString() || slot.virtual_id || 'unknown';
}
/**
* Format a Date as ISO time string (HH:MM:SS).
*/
formatTime(date) {
return date.toTimeString().split(' ')[0];
}
/**
* Debug logging helper.
*/
logDebug(message) {
if (this.config.debug) {
this.config.logger.debug(`[CalendarScheduler] ${message}`);
}
}
/**
* Get current scheduler state (for introspection).
*/
getState() {
return { ...this.state };
}
/**
* Check if scheduler is running.
*/
isRunning() {
return this.state.isRunning;
}
/**
* Check if currently processing a slot.
*/
isProcessing() {
return this.state.isProcessing;
}
/**
* Get the current slot being executed (if any).
*/
getCurrentSlot() {
return this.state.currentSlot;
}
}
exports.CalendarScheduler = CalendarScheduler;
/**
* Factory function to create a CalendarScheduler from plugin context.
*/
function createCalendarScheduler(config) {
return new CalendarScheduler(config);
}
//# sourceMappingURL=scheduler.js.map

File diff suppressed because one or more lines are too long

View File

@@ -0,0 +1,670 @@
/**
* HarborForge Calendar Scheduler
*
* PLG-CAL-002: Plugin-side handling for pending slot execution.
*
* Responsibilities:
* - Run calendar heartbeat every minute
* - Detect when agent is Idle and slots are pending
* - Wake agent with task context
* - Handle slot status transitions (attended, ongoing, deferred)
* - Manage agent status transitions (idle → busy/on_call)
*
* Design reference: NEXT_WAVE_DEV_DIRECTION.md §6 (Agent wakeup mechanism)
*/
import {
CalendarBridgeClient,
} from './calendar-bridge';
import {
CalendarSlotResponse,
SlotStatus,
AgentStatusValue,
SlotAgentUpdate,
CalendarEventDataJob,
CalendarEventDataSystemEvent,
} from './types';
export interface CalendarSchedulerConfig {
/** Calendar bridge client for backend communication */
bridge: CalendarBridgeClient;
/** Function to get current agent status from backend */
getAgentStatus: () => Promise<AgentStatusValue | null>;
/** Function to wake/spawn agent with task context */
wakeAgent: (context: AgentWakeContext) => Promise<boolean>;
/** Logger instance */
logger: {
info: (...args: any[]) => void;
error: (...args: any[]) => void;
debug: (...args: any[]) => void;
warn: (...args: any[]) => void;
};
/** Heartbeat interval in milliseconds (default: 60000) */
heartbeatIntervalMs?: number;
/** Enable verbose debug logging */
debug?: boolean;
}
/**
* Context passed to agent when waking for slot execution.
* This is the payload the agent receives to understand what to do.
*/
export interface AgentWakeContext {
/** The slot to execute */
slot: CalendarSlotResponse;
/** Human-readable task description */
taskDescription: string;
/** Prompt/instructions for the agent */
prompt: string;
/** Whether this is a virtual slot (needs materialization) */
isVirtual: boolean;
}
/**
* Current execution state tracked by the scheduler.
*/
interface SchedulerState {
/** Whether scheduler is currently running */
isRunning: boolean;
/** Currently executing slot (null if idle) */
currentSlot: CalendarSlotResponse | null;
/** Last heartbeat timestamp */
lastHeartbeatAt: Date | null;
/** Interval handle for cleanup */
intervalHandle: ReturnType<typeof setInterval> | null;
/** Set of slot IDs that have been deferred in current session */
deferredSlotIds: Set<string>;
/** Whether agent is currently processing a slot */
isProcessing: boolean;
}
/**
* CalendarScheduler manages the periodic heartbeat and slot execution lifecycle.
*/
export class CalendarScheduler {
private config: Required<CalendarSchedulerConfig>;
private state: SchedulerState;
constructor(config: CalendarSchedulerConfig) {
this.config = {
heartbeatIntervalMs: 60000, // 1 minute default
debug: false,
...config,
};
this.state = {
isRunning: false,
currentSlot: null,
lastHeartbeatAt: null,
intervalHandle: null,
deferredSlotIds: new Set(),
isProcessing: false,
};
}
/**
* Start the calendar scheduler.
* Begins periodic heartbeat to check for pending slots.
*/
start(): void {
if (this.state.isRunning) {
this.config.logger.warn('Calendar scheduler already running');
return;
}
this.state.isRunning = true;
this.config.logger.info('Calendar scheduler started');
// Run initial heartbeat immediately
this.runHeartbeat();
// Schedule periodic heartbeats
this.state.intervalHandle = setInterval(
() => this.runHeartbeat(),
this.config.heartbeatIntervalMs
);
}
/**
* Stop the calendar scheduler.
* Cleans up intervals and resets state.
*/
stop(): void {
this.state.isRunning = false;
if (this.state.intervalHandle) {
clearInterval(this.state.intervalHandle);
this.state.intervalHandle = null;
}
this.config.logger.info('Calendar scheduler stopped');
}
/**
* Execute a single heartbeat cycle.
* Fetches pending slots and handles execution logic.
*/
async runHeartbeat(): Promise<void> {
if (!this.state.isRunning) {
return;
}
this.state.lastHeartbeatAt = new Date();
try {
// Fetch pending slots from backend
const response = await this.config.bridge.heartbeat();
if (!response) {
this.logDebug('Heartbeat: backend unreachable');
return;
}
this.logDebug(`Heartbeat: ${response.slots.length} slots pending, agent_status=${response.agent_status}`);
// If agent is not idle, defer all pending slots
if (response.agent_status !== 'idle') {
await this.handleNonIdleAgent(response.slots, response.agent_status);
return;
}
// Agent is idle - handle pending slots
await this.handleIdleAgent(response.slots);
} catch (err) {
this.config.logger.error('Heartbeat error:', err);
}
}
/**
* Handle slots when agent is not idle.
* Defer all pending slots with priority boost.
*/
private async handleNonIdleAgent(
slots: CalendarSlotResponse[],
agentStatus: AgentStatusValue
): Promise<void> {
if (slots.length === 0) {
return;
}
this.config.logger.info(
`Agent not idle (status=${agentStatus}), deferring ${slots.length} slot(s)`
);
for (const slot of slots) {
const slotId = this.getSlotId(slot);
// Skip if already deferred this session
if (this.state.deferredSlotIds.has(slotId)) {
continue;
}
// Mark slot as deferred with priority boost (+1)
await this.deferSlot(slot);
this.state.deferredSlotIds.add(slotId);
}
}
/**
* Handle slots when agent is idle.
* Select highest priority slot and wake agent.
*/
private async handleIdleAgent(slots: CalendarSlotResponse[]): Promise<void> {
if (slots.length === 0) {
return;
}
// Filter out already deferred slots in this session
const eligibleSlots = slots.filter(
s => !this.state.deferredSlotIds.has(this.getSlotId(s))
);
if (eligibleSlots.length === 0) {
this.logDebug('All pending slots have been deferred this session');
return;
}
// Select highest priority slot (backend already sorts by priority DESC)
const [selectedSlot, ...remainingSlots] = eligibleSlots;
this.config.logger.info(
`Selected slot for execution: id=${this.getSlotId(selectedSlot)}, ` +
`type=${selectedSlot.slot_type}, priority=${selectedSlot.priority}`
);
// Mark remaining slots as deferred
for (const slot of remainingSlots) {
await this.deferSlot(slot);
this.state.deferredSlotIds.add(this.getSlotId(slot));
}
// Wake agent to execute selected slot
await this.executeSlot(selectedSlot);
}
/**
* Execute a slot by waking the agent.
*/
private async executeSlot(slot: CalendarSlotResponse): Promise<void> {
if (this.state.isProcessing) {
this.config.logger.warn('Already processing a slot, deferring new slot');
await this.deferSlot(slot);
return;
}
this.state.isProcessing = true;
this.state.currentSlot = slot;
try {
// Mark slot as attended and ongoing before waking agent
const update: SlotAgentUpdate = {
status: SlotStatus.ONGOING,
started_at: this.formatTime(new Date()),
};
let updateSuccess: boolean;
if (slot.id) {
updateSuccess = await this.config.bridge.updateSlot(slot.id, update);
} else if (slot.virtual_id) {
const updated = await this.config.bridge.updateVirtualSlot(slot.virtual_id, update);
updateSuccess = updated !== null;
// Update slot reference if materialized
if (updated) {
this.state.currentSlot = updated;
}
} else {
updateSuccess = false;
}
if (!updateSuccess) {
this.config.logger.error('Failed to update slot status before execution');
this.state.isProcessing = false;
this.state.currentSlot = null;
return;
}
// Report agent status change to backend
const newAgentStatus = slot.slot_type === 'on_call' ? 'on_call' : 'busy';
await this.config.bridge.reportAgentStatus({ status: newAgentStatus });
// Build wake context for agent
const wakeContext = this.buildWakeContext(slot);
// Wake the agent
const wakeSuccess = await this.config.wakeAgent(wakeContext);
if (!wakeSuccess) {
this.config.logger.error('Failed to wake agent for slot execution');
// Revert slot to not_started status
await this.revertSlot(slot);
await this.config.bridge.reportAgentStatus({ status: 'idle' });
}
// Note: isProcessing remains true until agent signals completion
// This is handled by external completion callback
} catch (err) {
this.config.logger.error('Error executing slot:', err);
this.state.isProcessing = false;
this.state.currentSlot = null;
}
}
/**
* Build the wake context for an agent based on slot details.
*/
private buildWakeContext(slot: CalendarSlotResponse): AgentWakeContext {
const isVirtual = slot.virtual_id !== null;
const slotId = this.getSlotId(slot);
// Build task description based on event type
let taskDescription: string;
let prompt: string;
if (slot.event_type === 'job' && slot.event_data) {
const jobData = slot.event_data as CalendarEventDataJob;
taskDescription = `${jobData.type} ${jobData.code}`;
prompt = this.buildJobPrompt(slot, jobData);
} else if (slot.event_type === 'system_event' && slot.event_data) {
const sysData = slot.event_data as CalendarEventDataSystemEvent;
taskDescription = `System Event: ${sysData.event}`;
prompt = this.buildSystemPrompt(slot, sysData);
} else if (slot.event_type === 'entertainment') {
taskDescription = 'Entertainment slot';
prompt = this.buildEntertainmentPrompt(slot);
} else {
taskDescription = `Generic ${slot.slot_type} slot`;
prompt = this.buildGenericPrompt(slot);
}
return {
slot,
taskDescription,
prompt,
isVirtual,
};
}
/**
* Build prompt for job-type slots.
*/
private buildJobPrompt(slot: CalendarSlotResponse, jobData: CalendarEventDataJob): string {
const duration = slot.estimated_duration;
const type = jobData.type;
const code = jobData.code;
return `You have a scheduled ${type} job to work on.
Task Code: ${code}
Estimated Duration: ${duration} minutes
Slot Type: ${slot.slot_type}
Priority: ${slot.priority}
Please focus on this task for the allocated time. When you finish or need to pause,
report your progress back to the calendar system.
Working sessions: ${jobData.working_sessions?.join(', ') || 'none recorded'}
Start working on ${code} now.`;
}
/**
* Build prompt for system event slots.
*/
private buildSystemPrompt(
slot: CalendarSlotResponse,
sysData: CalendarEventDataSystemEvent
): string {
switch (sysData.event) {
case 'ScheduleToday':
return `System Event: Schedule Today
Please review today's calendar and schedule any pending tasks or planning activities.
Estimated time: ${slot.estimated_duration} minutes.
Check your calendar and plan the day's work.`;
case 'SummaryToday':
return `System Event: Daily Summary
Please provide a summary of today's activities and progress.
Estimated time: ${slot.estimated_duration} minutes.
Review what was accomplished and prepare end-of-day notes.`;
case 'ScheduledGatewayRestart':
return `System Event: Scheduled Gateway Restart
The OpenClaw gateway is scheduled to restart soon.
Please:
1. Persist any important state
2. Complete or gracefully pause current tasks
3. Prepare for restart
Time remaining: ${slot.estimated_duration} minutes.`;
default:
return `System Event: ${sysData.event}
A system event has been scheduled. Please handle accordingly.
Estimated time: ${slot.estimated_duration} minutes.`;
}
}
/**
* Build prompt for entertainment slots.
*/
private buildEntertainmentPrompt(slot: CalendarSlotResponse): string {
return `Scheduled Entertainment Break
Duration: ${slot.estimated_duration} minutes
Take a break and enjoy some leisure time. This slot is reserved for non-work activities
to help maintain work-life balance.`;
}
/**
* Build generic prompt for slots without specific event data.
*/
private buildGenericPrompt(slot: CalendarSlotResponse): string {
return `Scheduled Calendar Slot
Type: ${slot.slot_type}
Duration: ${slot.estimated_duration} minutes
Priority: ${slot.priority}
Please use this time for the scheduled activity.`;
}
/**
* Mark a slot as deferred with priority boost.
*/
private async deferSlot(slot: CalendarSlotResponse): Promise<void> {
const update: SlotAgentUpdate = {
status: SlotStatus.DEFERRED,
};
try {
if (slot.id) {
await this.config.bridge.updateSlot(slot.id, update);
} else if (slot.virtual_id) {
await this.config.bridge.updateVirtualSlot(slot.virtual_id, update);
}
this.logDebug(`Deferred slot: ${this.getSlotId(slot)}`);
} catch (err) {
this.config.logger.error('Failed to defer slot:', err);
}
}
/**
* Revert a slot to not_started status after failed execution attempt.
*/
private async revertSlot(slot: CalendarSlotResponse): Promise<void> {
const update: SlotAgentUpdate = {
status: SlotStatus.NOT_STARTED,
started_at: undefined,
};
try {
if (slot.id) {
await this.config.bridge.updateSlot(slot.id, update);
} else if (slot.virtual_id) {
await this.config.bridge.updateVirtualSlot(slot.virtual_id, update);
}
} catch (err) {
this.config.logger.error('Failed to revert slot:', err);
}
}
/**
* Complete the current slot execution.
* Call this when the agent finishes the task.
*/
async completeCurrentSlot(actualDurationMinutes: number): Promise<void> {
if (!this.state.currentSlot) {
this.config.logger.warn('No current slot to complete');
return;
}
const slot = this.state.currentSlot;
const update: SlotAgentUpdate = {
status: SlotStatus.FINISHED,
actual_duration: actualDurationMinutes,
};
try {
if (slot.id) {
await this.config.bridge.updateSlot(slot.id, update);
} else if (slot.virtual_id) {
await this.config.bridge.updateVirtualSlot(slot.virtual_id, update);
}
// Report agent back to idle
await this.config.bridge.reportAgentStatus({ status: 'idle' });
this.config.logger.info(
`Completed slot ${this.getSlotId(slot)}, actual_duration=${actualDurationMinutes}min`
);
} catch (err) {
this.config.logger.error('Failed to complete slot:', err);
} finally {
this.state.isProcessing = false;
this.state.currentSlot = null;
}
}
/**
* Abort the current slot execution.
* Call this when the agent cannot complete the task.
*/
async abortCurrentSlot(reason?: string): Promise<void> {
if (!this.state.currentSlot) {
this.config.logger.warn('No current slot to abort');
return;
}
const slot = this.state.currentSlot;
const update: SlotAgentUpdate = {
status: SlotStatus.ABORTED,
};
try {
if (slot.id) {
await this.config.bridge.updateSlot(slot.id, update);
} else if (slot.virtual_id) {
await this.config.bridge.updateVirtualSlot(slot.virtual_id, update);
}
// Report agent back to idle
await this.config.bridge.reportAgentStatus({ status: 'idle' });
this.config.logger.info(
`Aborted slot ${this.getSlotId(slot)}${reason ? `: ${reason}` : ''}`
);
} catch (err) {
this.config.logger.error('Failed to abort slot:', err);
} finally {
this.state.isProcessing = false;
this.state.currentSlot = null;
}
}
/**
* Pause the current slot execution.
* Call this when the agent needs to temporarily pause.
*/
async pauseCurrentSlot(): Promise<void> {
if (!this.state.currentSlot) {
this.config.logger.warn('No current slot to pause');
return;
}
const slot = this.state.currentSlot;
const update: SlotAgentUpdate = {
status: SlotStatus.PAUSED,
};
try {
if (slot.id) {
await this.config.bridge.updateSlot(slot.id, update);
} else if (slot.virtual_id) {
await this.config.bridge.updateVirtualSlot(slot.virtual_id, update);
}
this.config.logger.info(`Paused slot ${this.getSlotId(slot)}`);
} catch (err) {
this.config.logger.error('Failed to pause slot:', err);
}
}
/**
* Resume a paused slot.
*/
async resumeCurrentSlot(): Promise<void> {
if (!this.state.currentSlot) {
this.config.logger.warn('No current slot to resume');
return;
}
const slot = this.state.currentSlot;
const update: SlotAgentUpdate = {
status: SlotStatus.ONGOING,
};
try {
if (slot.id) {
await this.config.bridge.updateSlot(slot.id, update);
} else if (slot.virtual_id) {
await this.config.bridge.updateVirtualSlot(slot.virtual_id, update);
}
this.config.logger.info(`Resumed slot ${this.getSlotId(slot)}`);
} catch (err) {
this.config.logger.error('Failed to resume slot:', err);
}
}
/**
* Get a stable ID for a slot (real or virtual).
*/
private getSlotId(slot: CalendarSlotResponse): string {
return slot.id?.toString() || slot.virtual_id || 'unknown';
}
/**
* Format a Date as ISO time string (HH:MM:SS).
*/
private formatTime(date: Date): string {
return date.toTimeString().split(' ')[0];
}
/**
* Debug logging helper.
*/
private logDebug(message: string): void {
if (this.config.debug) {
this.config.logger.debug(`[CalendarScheduler] ${message}`);
}
}
/**
* Get current scheduler state (for introspection).
*/
getState(): Readonly<SchedulerState> {
return { ...this.state };
}
/**
* Check if scheduler is running.
*/
isRunning(): boolean {
return this.state.isRunning;
}
/**
* Check if currently processing a slot.
*/
isProcessing(): boolean {
return this.state.isProcessing;
}
/**
* Get the current slot being executed (if any).
*/
getCurrentSlot(): CalendarSlotResponse | null {
return this.state.currentSlot;
}
}
/**
* Factory function to create a CalendarScheduler from plugin context.
*/
export function createCalendarScheduler(
config: CalendarSchedulerConfig
): CalendarScheduler {
return new CalendarScheduler(config);
}