fib-flow
Version:
A robust workflow management system for fibjs with task orchestration, state management, and distributed execution capabilities
219 lines (187 loc) • 9.75 kB
JavaScript
/**
* SQLite-specific database adapter implementation
* Extends BaseDBAdapter with SQLite-specific schema and constraints
*/
const BaseDBAdapter = require('./base');
const createLogger = require('../logger');
// Create logger for SQLite adapter operations
const logger = createLogger('fib-flow');
/**
* SQLite adapter for task persistence
* Uses CHECK constraints and separate index creation for data integrity
*/
class SQLiteAdapter extends BaseDBAdapter {
constructor(config, poolSize = 5) {
super(config, poolSize);
// Override lock clause since SQLite doesn't support FOR UPDATE SKIP LOCKED
this.lockClause = '';
}
/**
* Initialize SQLite-specific schema
* Creates tasks table with appropriate column constraints and indexes
*
* Table Structure:
* - Task identification and basic info:
* - id: Unique task identifier
* - name: Task type name, used to match with registered handlers
* - type: Task type (async: one-time, cron: recurring)
* - priority: Task priority for execution ordering (-20 to 20, higher runs first)
* - payload: JSON encoded task parameters and data
* - created_at: Task creation timestamp (Unix seconds)
* - tag: Task tag for categorization
*
* - Task execution status and results:
* - status: Current task state
* - next_run_time: Next scheduled execution time (Unix seconds)
* - last_active_time: Last time task reported activity (Unix seconds)
* - result: JSON encoded task execution result
* - error: Error message if task failed
*
* - Task execution settings:
* - timeout: Task execution timeout in seconds
* - retry_count: Number of retry attempts made
* - max_retries: Maximum number of retry attempts allowed
* - retry_interval: Delay between retry attempts in seconds
* - cron_expr: Cron expression for recurring tasks
*
* - Workflow relationships:
* - root_id: ID of the root task in workflow
* - parent_id: ID of the parent task
* - total_children: Total number of child tasks
* - completed_children: Number of completed child tasks
*
* - Worker information:
* - worker_id: ID of the worker that executed the task
* - start_time: Start time of task execution (Unix seconds)
*
* Indexes:
* - idx_fib_flow_tasks_status_priority_next_run_time: For task scheduling and claiming
* - idx_fib_flow_tasks_name: For task type lookups
* - idx_fib_flow_tasks_parent_status: For workflow management
* - idx_fib_flow_tasks_tag_name_status: For task statistics queries by tag
*/
setup() {
logger.info(`[SQLiteAdapter] Setting up database schema`);
this.pool(conn => {
logger.info(`[SQLiteAdapter] Creating tasks table if not exists`);
conn.execute(`
CREATE TABLE IF NOT EXISTS fib_flow_tasks (
id INTEGER PRIMARY KEY AUTOINCREMENT,
name TEXT NOT NULL,
type TEXT CHECK(type IN ('async', 'cron')) NOT NULL,
priority INTEGER DEFAULT 0,
payload TEXT,
created_at INTEGER,
tag TEXT,
status TEXT CHECK(status IN ('pending', 'running', 'completed', 'failed', 'timeout', 'permanently_failed', 'paused', 'suspended')) NOT NULL DEFAULT 'pending',
next_run_time INTEGER NOT NULL,
last_active_time INTEGER,
last_event_time INTEGER,
last_event_type TEXT,
result TEXT,
error TEXT,
current_stage_name TEXT,
progress_text TEXT,
progress_percent REAL,
stage INTEGER DEFAULT 0,
timeout INTEGER DEFAULT 60,
retry_count INTEGER DEFAULT 0,
max_retries INTEGER DEFAULT 3,
retry_interval INTEGER DEFAULT 0,
cron_expr TEXT,
root_id INTEGER,
parent_id INTEGER,
total_children INTEGER DEFAULT 0,
completed_children INTEGER DEFAULT 0,
worker_id TEXT,
start_time INTEGER,
context BLOB
);
CREATE TABLE IF NOT EXISTS fib_flow_task_events (
id INTEGER PRIMARY KEY AUTOINCREMENT,
task_id INTEGER NOT NULL,
root_id INTEGER,
parent_id INTEGER,
event_type TEXT NOT NULL,
from_status TEXT,
to_status TEXT,
stage INTEGER,
worker_id TEXT,
attempt INTEGER,
event_time INTEGER NOT NULL,
message TEXT,
metadata TEXT
);
CREATE TABLE IF NOT EXISTS fib_flow_task_attempts (
id INTEGER PRIMARY KEY AUTOINCREMENT,
task_id INTEGER NOT NULL,
attempt INTEGER NOT NULL,
worker_id TEXT,
started_at INTEGER NOT NULL,
ended_at INTEGER,
outcome TEXT,
error TEXT,
timeout_flag INTEGER DEFAULT 0
);
CREATE TABLE IF NOT EXISTS fib_flow_workers (
worker_id TEXT PRIMARY KEY,
pod_id TEXT NOT NULL,
status TEXT CHECK(status IN ('active', 'superseded', 'dead', 'stopped')) NOT NULL,
registered_at INTEGER NOT NULL,
last_seen_at INTEGER NOT NULL,
expires_at INTEGER NOT NULL,
superseded_at INTEGER,
dead_at INTEGER,
meta TEXT
);
-- Task scheduling index: Supports high-frequency task claiming queries
CREATE INDEX IF NOT EXISTS idx_task_scheduling
ON fib_flow_tasks(status, next_run_time, priority);
-- Task timeout detection index: Supports monitoring active tasks
CREATE INDEX IF NOT EXISTS idx_task_timeout
ON fib_flow_tasks(status, last_active_time)
WHERE status = 'running';
-- Workflow index: Supports parent-child task relationships and completion tracking
CREATE INDEX IF NOT EXISTS idx_task_workflow
ON fib_flow_tasks(parent_id, status, completed_children);
-- Task statistics index: Supports efficient statistics queries by tag
CREATE INDEX IF NOT EXISTS idx_task_stats
ON fib_flow_tasks(tag, name, status);
CREATE INDEX IF NOT EXISTS idx_task_last_event
ON fib_flow_tasks(last_event_time, last_event_type);
CREATE INDEX IF NOT EXISTS idx_task_root_created
ON fib_flow_tasks(root_id, created_at);
CREATE INDEX IF NOT EXISTS idx_task_events_task_time
ON fib_flow_task_events(task_id, event_time);
CREATE INDEX IF NOT EXISTS idx_task_events_root_time
ON fib_flow_task_events(root_id, event_time);
CREATE INDEX IF NOT EXISTS idx_task_events_parent_time
ON fib_flow_task_events(parent_id, event_time);
CREATE INDEX IF NOT EXISTS idx_task_events_type_time
ON fib_flow_task_events(event_type, event_time);
CREATE INDEX IF NOT EXISTS idx_task_events_worker_time
ON fib_flow_task_events(worker_id, event_time);
CREATE INDEX IF NOT EXISTS idx_task_events_stage_time
ON fib_flow_task_events(stage, event_time);
CREATE INDEX IF NOT EXISTS idx_task_events_attempt_time
ON fib_flow_task_events(attempt, event_time);
CREATE INDEX IF NOT EXISTS idx_task_attempts_task_attempt
ON fib_flow_task_attempts(task_id, attempt);
CREATE INDEX IF NOT EXISTS idx_task_attempts_task_open
ON fib_flow_task_attempts(task_id, ended_at, attempt);
CREATE INDEX IF NOT EXISTS idx_task_attempts_worker_started
ON fib_flow_task_attempts(worker_id, started_at);
CREATE INDEX IF NOT EXISTS idx_task_attempts_outcome_started
ON fib_flow_task_attempts(outcome, started_at);
CREATE INDEX IF NOT EXISTS idx_task_workers_pod_id
ON fib_flow_workers(pod_id);
CREATE INDEX IF NOT EXISTS idx_task_workers_status_expires
ON fib_flow_workers(status, expires_at);
CREATE INDEX IF NOT EXISTS idx_task_workers_pod_status
ON fib_flow_workers(pod_id, status);
`);
logger.info(`[SQLiteAdapter] Database schema setup completed successfully`);
});
}
}
module.exports = SQLiteAdapter;