@5minds/processcube_engine
Version:
The ProcessCube Engine. Stores and executes BPMNs.
330 lines • 17.3 kB
JavaScript
;
var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
return c > 3 && r && Object.defineProperty(target, key, r), r;
};
var __metadata = (this && this.__metadata) || function (k, v) {
if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
};
var __param = (this && this.__param) || function (paramIndex, decorator) {
return function (target, key) { decorator(target, key, paramIndex); }
};
var __importDefault = (this && this.__importDefault) || function (mod) {
return (mod && mod.__esModule) ? mod : { "default": mod };
};
Object.defineProperty(exports, "__esModule", { value: true });
exports.ExternalTaskFetchAndLockServiceProxyConfiguration = exports.ExternalTaskFetchAndLockService = void 0;
const async_lock_1 = __importDefault(require("async-lock"));
const dayjs_1 = __importDefault(require("dayjs"));
const inversify_1 = require("inversify");
const node_schedule_1 = __importDefault(require("node-schedule"));
const processcube_engine_sdk_1 = require("@5minds/processcube_engine_sdk");
const index_1 = require("../../Contracts/index");
const EngineRouter_1 = require("../../Setups/EngineRouter");
const index_2 = require("../../Tools/index");
const CancellationToken_1 = require("../CancellationToken");
const externalTaskLockTimers = {};
const asyncLocker = new async_lock_1.default({ maxPending: 100000 });
let ExternalTaskFetchAndLockService = class ExternalTaskFetchAndLockService {
externalTaskAdapter;
iamService;
logger;
constructor(externalTaskDatabaseAdapter, iamService) {
this.externalTaskAdapter = externalTaskDatabaseAdapter;
this.iamService = iamService;
this.logger = new processcube_engine_sdk_1.Logger('api:external_task_fetch_and_lock_service');
}
async dispose() {
for (const externalTaskId of Object.keys(externalTaskLockTimers)) {
this.clearExternalTaskExpirationTimer(externalTaskId);
}
}
async fetchAndLockExternalTasks(identity, options, cancellationToken) {
this.logger.trace('Executing FetchAndLock Request', options);
this.ensureHasClaim(identity, processcube_engine_sdk_1.claims.canAccessExternalTasks);
try {
if (!cancellationToken) {
cancellationToken = new CancellationToken_1.CancellationToken();
}
const availableTasks = await this.fetchOrWaitForExternalTasks(cancellationToken, options);
this.logger.info(`Fetched and locked ${availableTasks.length} External Tasks for the given request`, options);
if (cancellationToken.isCancelled || !availableTasks) {
return [];
}
if (availableTasks.length > 0) {
this.publishExternalTaskLockedNotifications(availableTasks);
}
return availableTasks;
}
catch (error) {
this.logger.error('Failed to fetch and lock ExternalTasks!', {
err: error,
});
throw error;
}
}
async extendLock(identity, workerId, externalTaskId, additionalDuration) {
return asyncLocker.acquire(`${externalTaskId}-queue-update-request`, async () => {
this.logger.trace('Attempting to extend Lock for External Task', {
identity: identity,
workerId: workerId,
externalTaskId: externalTaskId,
additionalDuration: additionalDuration,
});
await this.ensureExternalTaskCanBeAccessedByWorker(externalTaskId, workerId, identity);
const newLockExpirationTime = this.getLockExpirationDate(additionalDuration);
await this.lockForWorker(workerId, externalTaskId, newLockExpirationTime);
this.logger.info('Extended Lock for External Task', {
identity: identity,
workerId: workerId,
externalTaskId: externalTaskId,
additionalDuration: additionalDuration,
});
});
}
updateExpirationTimeForExternalTaskIds(externalTaskIds, lockExpirationTime) {
for (const externalTaskId of externalTaskIds) {
this.clearExternalTaskExpirationTimer(externalTaskId);
this.startExternalTaskExpirationTimer(externalTaskId, lockExpirationTime);
}
}
clearExpirationTimeForExternalTaskIds(externalTaskIds) {
for (const externalTaskId of externalTaskIds) {
this.clearExternalTaskExpirationTimer(externalTaskId);
}
}
async fetchOrWaitForExternalTasks(cancellationToken, options) {
let continueFetch = true;
let timeoutRef = null;
let externalTaskCreatedSubscription = null;
let externalTaskLockReleasedSubscription = null;
let pendingResolves = [];
let tasks = [];
let announceNewTasksAvailable = () => { };
externalTaskCreatedSubscription = index_2.EventAggregator.subscribe(index_1.eventAggregatorSettings.messagePaths.externalTaskCreated, (message) => announceNewTasksAvailable(message));
externalTaskLockReleasedSubscription = index_2.EventAggregator.subscribe(index_1.eventAggregatorSettings.messagePaths.externalTaskUnlocked, (message) => announceNewTasksAvailable(message));
try {
const cancellationTriggered = waitForCancellationTriggered(this.logger);
const timeoutExpired = waitForTimeoutExpired(this.logger);
while (continueFetch) {
const newTasksAvailable = waitForNewTasksAvailable();
this.logger.trace(`Trying to fetch new External Tasks.`, options);
tasks = await this.fetchAndLockExternalTasksSafely(options.topics, options.workerId, options.maxTasks, options.lockDuration, options.payloadFilter);
if (tasks.length > 0) {
if (cancellationToken.isCancelled) {
this.logger.trace(`External Tasks have been fetched, but the Http Request was canceled. Aborting FetchAndLock.`, {
...options,
numberOfExternalTasksFound: tasks.length,
});
const lockedExternalTaskIds = tasks.map((task) => task.id);
await this.unlockExternalTasks(lockedExternalTaskIds);
tasks = [];
}
else {
this.logger.trace(`External Tasks have been fetched. Finishing FetchAndLock.`, { ...options, numberOfExternalTasksFound: tasks.length });
}
break;
}
else {
this.logger.trace(`No External Tasks found. Waiting for External Tasks to become available.`, options);
}
await Promise.race([cancellationTriggered, timeoutExpired, newTasksAvailable]);
}
cleanup();
return tasks;
}
catch (error) {
cleanup();
throw error;
}
async function waitForCancellationTriggered(logger) {
return new Promise((resolve) => {
pendingResolves.push(resolve);
cancellationToken.onCancellation(() => {
logger.trace(`The Http Request was canceled. Aborting FetchAndLock.`, options);
continueFetch = false;
return resolve();
});
});
}
async function waitForTimeoutExpired(logger) {
return new Promise((resolve) => {
pendingResolves.push(resolve);
timeoutRef = setTimeout(() => {
logger.trace(`Long Polling Timeout has expired. Aborting FetchAndLock.`, options);
continueFetch = false;
return resolve();
}, options.longPollingTimeoutInMs);
});
}
async function waitForNewTasksAvailable() {
return new Promise((resolve) => {
pendingResolves.push(resolve);
announceNewTasksAvailable = (message) => {
const requestedTopicsAsArray = Array.isArray(options.topics) ? options.topics : [options.topics];
if (requestedTopicsAsArray.includes(message.topic)) {
resolve();
}
};
});
}
function cleanup() {
if (timeoutRef != null) {
clearTimeout(timeoutRef);
}
index_2.EventAggregator.unsubscribe(externalTaskCreatedSubscription);
index_2.EventAggregator.unsubscribe(externalTaskLockReleasedSubscription);
if (cancellationToken) {
cancellationToken.dispose();
}
for (const pendingResolve of pendingResolves) {
pendingResolve();
}
}
}
async startExternalTaskExpirationTimers() {
const externalTasksWithActiveLock = await this.externalTaskAdapter.getExternalTasksWithActiveLock();
for (const externalTask of externalTasksWithActiveLock) {
this.startExternalTaskExpirationTimer(externalTask.id, externalTask.lockExpirationTime);
}
}
async fetchAndLockExternalTasksSafely(topics, workerId, maxTasks, lockDuration, payloadFilter) {
return asyncLocker.acquire(topics, async () => {
const fetchedExternalTasks = await this.externalTaskAdapter.fetchAvailableForProcessing(topics, maxTasks, payloadFilter);
if (fetchedExternalTasks.length === 0) {
return [];
}
const fetchedExternalTaskIds = fetchedExternalTasks.map((externalTask) => externalTask.id);
const lockExpirationTime = this.getLockExpirationDate(lockDuration);
try {
await this.lockForWorker(workerId, fetchedExternalTaskIds, lockExpirationTime);
return fetchedExternalTasks.map((externalTask) => {
return {
...externalTask,
workerId: workerId,
lockExpirationTime: lockExpirationTime,
};
});
}
catch (error) {
this.logger.error(`Failed to lock ExternalTasks \`${fetchedExternalTaskIds}\` for worker \`${workerId}\`.`, { err: error });
throw error;
}
});
}
publishExternalTaskLockedNotifications(externalTasks) {
for (const externalTask of externalTasks) {
const payload = {
externalTaskId: externalTask.id,
isSingleTry: externalTask.isSingleTry,
flowNodeInstanceId: externalTask.flowNodeInstanceId,
correlationId: externalTask.correlationId,
processDefinitionId: externalTask.processDefinitionId,
processModelId: externalTask.processModelId,
embeddedProcessModelId: externalTask.embeddedProcessModelId,
processInstanceId: externalTask.processInstanceId,
workerId: externalTask.workerId,
topic: externalTask.topic,
lockExpirationTime: externalTask.lockExpirationTime,
};
index_2.EventAggregator.publish(index_1.eventAggregatorSettings.messagePaths.externalTaskLocked, payload);
}
}
async lockForWorker(workerId, externalTaskIds, lockExpirationTime) {
if (!externalTaskIds || !externalTaskIds.length) {
return;
}
const externalTaskIdsAsArray = Array.isArray(externalTaskIds) ? externalTaskIds : [externalTaskIds];
await this.externalTaskAdapter.lockForWorker(workerId, externalTaskIdsAsArray, lockExpirationTime);
for (const externalTaskId of externalTaskIdsAsArray) {
this.clearExternalTaskExpirationTimer(externalTaskId);
this.startExternalTaskExpirationTimer(externalTaskId, lockExpirationTime);
}
}
async unlockExternalTasks(externalTaskIds) {
this.logger.trace('Attempting to unlock External Tasks', {
externalTaskIds: externalTaskIds,
});
for (const externalTaskId of externalTaskIds) {
this.clearExternalTaskExpirationTimer(externalTaskId);
}
await this.externalTaskAdapter.unlockExternalTasks(externalTaskIds);
this.logger.trace('Unlocked External Tasks', {
externalTaskIds: externalTaskIds,
});
}
async ensureExternalTaskCanBeAccessedByWorker(externalTaskId, workerId, identity) {
this.ensureHasClaim(identity, processcube_engine_sdk_1.claims.canAccessExternalTasks);
this.logger.trace(`Checking if worker can access the requested External Task.`, {
workerId: workerId,
externalTaskId: externalTaskId,
});
const externalTask = await this.externalTaskAdapter.findByExternalTaskId(externalTaskId);
const externalTaskIsAlreadyFinished = externalTask.state === processcube_engine_sdk_1.ExternalTaskState.finished;
if (externalTaskIsAlreadyFinished) {
throw new processcube_engine_sdk_1.GoneError(`External Task with ID \`${externalTaskId}\` has been finished and is not accessible.`);
}
const now = (0, dayjs_1.default)();
const taskReleaseTime = (0, dayjs_1.default)(externalTask.lockExpirationTime);
const externalTaskIsLockedByOtherWorker = externalTask.workerId != undefined && externalTask.workerId !== workerId && now.isBefore(taskReleaseTime);
if (externalTaskIsLockedByOtherWorker) {
const msg = `External Task with ID \`${externalTaskId}\` is locked by another worker, until \`${taskReleaseTime.toISOString()}\`.`;
throw new processcube_engine_sdk_1.LockedError(msg);
}
}
startExternalTaskExpirationTimer(externalTaskId, lockExpirationDatetime) {
if ((0, dayjs_1.default)(lockExpirationDatetime).isBefore((0, dayjs_1.default)())) {
this.onExternalTaskLockExpired(externalTaskId);
return;
}
externalTaskLockTimers[externalTaskId] = node_schedule_1.default.scheduleJob(lockExpirationDatetime, async () => {
await this.onExternalTaskLockExpired(externalTaskId);
});
this.logger.trace('External Task expiration timer started.', { externalTaskId: externalTaskId, lockExpirationDatetime: lockExpirationDatetime });
}
clearExternalTaskExpirationTimer(externalTaskId) {
if (externalTaskLockTimers[externalTaskId]) {
externalTaskLockTimers[externalTaskId].cancel(false);
delete externalTaskLockTimers[externalTaskId];
}
}
async onExternalTaskLockExpired(externalTaskId) {
this.clearExternalTaskExpirationTimer(externalTaskId);
await asyncLocker.acquire(`${externalTaskId}-update`, async () => {
await this.externalTaskAdapter.setExternalTaskLockExpired(externalTaskId);
});
this.logger.trace('External Task expiration timer expired.', { externalTaskId: externalTaskId });
}
getLockExpirationDate(duration) {
return (0, dayjs_1.default)().add(duration, 'milliseconds').toDate();
}
ensureHasClaim(identity, claimName) {
const isSuperAdmin = this.iamService.checkIfUserIsSuperAdmin(identity);
if (isSuperAdmin) {
return;
}
this.iamService.ensureHasClaim(identity, claimName);
}
};
exports.ExternalTaskFetchAndLockService = ExternalTaskFetchAndLockService;
__decorate([
(0, EngineRouter_1.cancelable)(),
__metadata("design:type", Function),
__metadata("design:paramtypes", [Object, Object, CancellationToken_1.CancellationToken]),
__metadata("design:returntype", Promise)
], ExternalTaskFetchAndLockService.prototype, "fetchAndLockExternalTasks", null);
exports.ExternalTaskFetchAndLockService = ExternalTaskFetchAndLockService = __decorate([
(0, inversify_1.injectable)(),
__param(0, (0, inversify_1.inject)(index_1.IocRegistrationKeys.internal.ExternalTaskDatabaseAdapter)),
__param(1, (0, inversify_1.inject)(index_1.IocRegistrationKeys.internal.IamService)),
__metadata("design:paramtypes", [index_2.ExternalTaskDatabaseAdapter,
index_2.IamService])
], ExternalTaskFetchAndLockService);
exports.ExternalTaskFetchAndLockServiceProxyConfiguration = {
proxyKey: index_1.IocRegistrationKeys.api.services.ExternalTaskFetchAndLockServiceProxy,
targetKey: index_1.IocRegistrationKeys.api.services.ExternalTaskFetchAndLockService,
target: ExternalTaskFetchAndLockService,
};
//# sourceMappingURL=ExternalTaskFetchAndLockService.js.map