arvo-event-handler
Version:
A complete set of orthogonal event handler and orchestration primitives for Arvo based applications, featuring declarative state machines (XState), imperative resumables for agentic workflows, contract-based routing, OpenTelemetry observability, and in-me
194 lines (193 loc) • 8.57 kB
JavaScript
"use strict";
var __assign = (this && this.__assign) || function () {
__assign = Object.assign || function(t) {
for (var s, i = 1, n = arguments.length; i < n; i++) {
s = arguments[i];
for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p))
t[p] = s[p];
}
return t;
};
return __assign.apply(this, arguments);
};
var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
return new (P || (P = Promise))(function (resolve, reject) {
function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
step((generator = generator.apply(thisArg, _arguments || [])).next());
});
};
var __generator = (this && this.__generator) || function (thisArg, body) {
var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g = Object.create((typeof Iterator === "function" ? Iterator : Object).prototype);
return g.next = verb(0), g["throw"] = verb(1), g["return"] = verb(2), typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
function verb(n) { return function (v) { return step([n, v]); }; }
function step(op) {
if (f) throw new TypeError("Generator is already executing.");
while (g && (g = 0, op[0] && (_ = 0)), _) try {
if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
if (y = 0, t) op = [op[0] & 2, t.value];
switch (op[0]) {
case 0: case 1: t = op; break;
case 4: _.label++; return { value: op[1], done: false };
case 5: _.label++; y = op[1]; op = [0]; continue;
case 7: op = _.ops.pop(); _.trys.pop(); continue;
default:
if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
if (t[2]) _.ops.pop();
_.trys.pop(); continue;
}
op = body.call(thisArg, _);
} catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
}
};
Object.defineProperty(exports, "__esModule", { value: true });
exports.SimpleMachineMemory = void 0;
var arvo_core_1 = require("arvo-core");
/**
* In-memory implementation of machine state storage for single-instance NodeJS applications.
*
* @example
* const memory = new SimpleMachineMemory();
* const orchestrator = createArvoOrchestrator({
* memory,
* machines: [workflow]
* });
*
* @warning Concurrency Limitations
*
* This implementation is NOT concurrency-safe. Lock acquisition is not atomic,
* making it unsuitable for parallel event processing where multiple handlers
* might process events for the same workflow simultaneously.
*
* **Safe Usage:**
* - {@link SimpleEventBroker} (sequential event processing)
* - Isolated handlers without shared durable state requirements
*
* **Unsafe Usage:**
* - In-memory parallel/concurrent event brokers (e.g., p-queue with prefetch > 1)
*
* For concurrent in-process event processing, use the concurrency-safe memory
* backend from the `@arvo-tools/concurrent` package, which provides atomic lock
* operations suitable for parallel execution within a single process.
*
* **Unsuitable For:**
* - Multi-instance deployments
* - Distributed systems requiring shared state across processes
*
* For these scenarios, implement or use a database-backed memory backend
* (Redis, PostgreSQL, DynamoDB, etc.) that provides distributed state
* persistence and atomic locking across instances. You can also explore the
* Arvo tool eco-system `@arvo-tools`
*/
var SimpleMachineMemory = /** @class */ (function () {
function SimpleMachineMemory(config) {
var _a;
this.memoryMap = new Map();
this.lockMap = new Map();
this.enableCleanup = true;
this.enableCleanup = (_a = config === null || config === void 0 ? void 0 : config.enableCleanup) !== null && _a !== void 0 ? _a : true;
}
/**
* Gets stored state for a machine instance
* @param id Machine instance ID
* @returns State data or null if not found
* @throws {Error} When id is empty or undefined
*/
SimpleMachineMemory.prototype.read = function (id) {
return __awaiter(this, void 0, void 0, function () {
var _a;
return __generator(this, function (_b) {
if (!id) {
throw new Error('Machine ID is required for read operation');
}
return [2 /*return*/, (_a = this.memoryMap.get(id)) !== null && _a !== void 0 ? _a : null];
});
});
};
/**
* Stores state for a machine instance
* @param id Machine instance ID
* @param data State to store
* @throws {Error} When id is empty/undefined or data is null/undefined
*/
SimpleMachineMemory.prototype.write = function (id, data) {
return __awaiter(this, void 0, void 0, function () {
return __generator(this, function (_a) {
if (!id) {
throw new Error('Machine ID is required for write operation');
}
if (!data) {
throw new Error('Data is required for write operation');
}
this.memoryMap.set(id, __assign({}, data));
return [2 /*return*/];
});
});
};
/**
* Attempts to acquire lock for machine instance
* @param id Machine instance ID
* @returns Success status of lock acquisition
* @throws {Error} When id is empty or undefined
*/
SimpleMachineMemory.prototype.lock = function (id) {
return __awaiter(this, void 0, void 0, function () {
return __generator(this, function (_a) {
if (!id) {
throw new Error('Machine ID is required for lock operation');
}
if (this.lockMap.get(id)) {
return [2 /*return*/, false];
}
this.lockMap.set(id, true);
return [2 /*return*/, true];
});
});
};
/**
* Releases lock for machine instance
* @param id Machine instance ID
* @returns True when lock is released
* @throws {Error} When id is empty or undefined
*/
SimpleMachineMemory.prototype.unlock = function (id) {
return __awaiter(this, void 0, void 0, function () {
return __generator(this, function (_a) {
if (!id) {
throw new Error('Machine ID is required for unlock operation');
}
this.lockMap.delete(id);
return [2 /*return*/, !this.lockMap.get(id)];
});
});
};
SimpleMachineMemory.prototype.cleanup = function (id) {
return __awaiter(this, void 0, void 0, function () {
return __generator(this, function (_a) {
if (!this.enableCleanup) {
(0, arvo_core_1.logToSpan)({
level: 'INFO',
message: 'Skipping cleanup due to config setting',
});
return [2 /*return*/];
}
this.memoryMap.delete(id);
this.lockMap.delete(id);
return [2 /*return*/];
});
});
};
// Clears all stored data and locks
SimpleMachineMemory.prototype.clear = function () {
this.lockMap.clear();
this.memoryMap.clear();
};
return SimpleMachineMemory;
}());
exports.SimpleMachineMemory = SimpleMachineMemory;