@fdm-monster/server 1.5.0-rc1

package/dist/services/core/server-release.service.js

@@ -0,0 +1,116 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", {
+    value: true
+});
+Object.defineProperty(exports, "ServerReleaseService", {
+    enumerable: true,
+    get: function() {
+        return ServerReleaseService;
+    }
+});
+const _semver = /*#__PURE__*/ _interop_require_default(require("semver"));
+const _logger = require("../../handlers/logger");
+const _serverconstants = require("../../server.constants");
+function _interop_require_default(obj) {
+    return obj && obj.__esModule ? obj : {
+        default: obj
+    };
+}
+class ServerReleaseService {
+    airGapped = null;
+    githubService;
+    synced = false;
+    installedReleaseFound = null;
+    updateAvailable = null;
+    latestRelease = null;
+    installedRelease = null;
+    /**
+   * @type {LoggerService}
+   */ #logger = new _logger.LoggerService(ServerReleaseService.name);
+    #serverVersion;
+    constructor({ serverVersion, githubService }){
+        this.#serverVersion = serverVersion;
+        this.githubService = githubService;
+    }
+    getState() {
+        return {
+            airGapped: this.airGapped,
+            latestRelease: this.latestRelease,
+            installedRelease: this.installedRelease,
+            serverVersion: this.#serverVersion,
+            installedReleaseFound: this.installedReleaseFound,
+            updateAvailable: this.updateAvailable,
+            synced: this.synced
+        };
+    }
+    /**
+   * Connection-safe acquire data about the installed and latest releases.
+   */ async syncLatestRelease() {
+        if (!await this.githubService.wasAuthenticated()) {
+            return;
+        }
+        const owner = _serverconstants.AppConstants.orgName;
+        const repo = _serverconstants.AppConstants.serverRepoName;
+        const response = await this.githubService.getReleases(owner, repo);
+        const latestResponse = await this.githubService.getLatestRelease(owner, repo);
+        this.synced = true;
+        const releases = response.data;
+        const latestRelease = latestResponse.data;
+        // Connection timeout results in airGapped state
+        this.airGapped = !releases?.length;
+        if (!releases?.length) {
+            this.#logger.warn("Latest release check failed because releases from github empty");
+            return;
+        }
+        const currentlyInstalledRelease = this.#serverVersion;
+        this.installedRelease = {
+            tag_name: currentlyInstalledRelease
+        };
+        this.latestRelease = latestRelease;
+        this.installedReleaseFound = !!currentlyInstalledRelease;
+        if (!this.installedReleaseFound) {
+            this.updateAvailable = false;
+            return;
+        }
+        // If the installed release is unknown/unstable, no update should be triggered
+        const lastTagIsNewer = _semver.default.gt(this.latestRelease.tag_name, this.installedRelease.tag_name, true);
+        this.updateAvailable = this.installedReleaseFound && lastTagIsNewer;
+    }
+    /**
+   * Logs whether a firmware update is ready
+   */ logServerVersionState() {
+        const latestReleaseState = this.getState();
+        const latestRelease = latestReleaseState?.latestRelease;
+        const latestReleaseTag = latestRelease?.tag_name;
+        if (!latestReleaseTag) {
+            // Tests only, silence it
+            return;
+        }
+        const packageVersion = this.#serverVersion;
+        if (!this.installedReleaseFound) {
+            this.#logger.log(`\x1b[36mCurrent release tag not found in github releases.\x1b[0m
+    Here's github's latest released: \x1b[32m${latestReleaseTag}\x1b[0m
+    Here's your release tag: \x1b[32m${packageVersion}\x1b[0m
+    Thanks for using FDM Monster!`);
+            return;
+        } else {
+            this.#logger.log(`\x1b[36mCurrent release was found in github releases.\x1b[0m
+    Here's github's latest released: \x1b[32m${latestReleaseTag}\x1b[0m
+    Here's your release tag: \x1b[32m${packageVersion}\x1b[0m
+    Thanks for using FDM Monster!`);
+        }
+        if (!!packageVersion && latestReleaseState.updateAvailable) {
+            if (!!this.airGapped) {
+                this.#logger.warn(`Installed release: ${packageVersion}. Skipping update check (air-gapped/disconnected from internet)`);
+            } else {
+                this.#logger.log(`Update available! New version: ${latestReleaseTag} (prerelease: ${latestRelease.prerelease})`);
+            }
+        } else if (!packageVersion) {
+            return this.#logger.error("Cant check release as package.json version environment variable is not set. Make sure FDM Server is run from a 'package.json' or NPM context.");
+        } else {
+            return this.#logger.log(`Installed release: ${packageVersion}. You are up to date!`);
+        }
+    }
+}
+
+//# sourceMappingURL=server-release.service.js.map

package/dist/services/core/server-release.service.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../../src/services/core/server-release.service.ts"],"names":["ServerReleaseService","airGapped","githubService","synced","installedReleaseFound","updateAvailable","latestRelease","installedRelease","logger","LoggerService","name","serverVersion","constructor","getState","syncLatestRelease","wasAuthenticated","owner","AppConstants","orgName","repo","serverRepoName","response","getReleases","latestResponse","getLatestRelease","releases","data","length","warn","currentlyInstalledRelease","tag_name","lastTagIsNewer","semver","gt","logServerVersionState","latestReleaseState","latestReleaseTag","packageVersion","log","prerelease","error"],"mappings":";;;;+BAKaA;;;eAAAA;;;+DALM;wBACW;iCACD;;;;;;AAGtB,MAAMA;IACXC,YAA4B,KAAK;IACjCC,cAA6B;IACrBC,SAAS,MAAM;IACfC,wBAAwC,KAAK;IAC7CC,kBAAkC,KAAK;IACvCC,gBAAgC,KAAK;IACrCC,mBAAmC,KAAK;IAChD;;GAEC,GACD,CAACC,MAAM,GAAG,IAAIC,qBAAa,CAACT,qBAAqBU,IAAI,EAAE;IACvD,CAACC,aAAa,CAAC;IAEfC,YAAY,EAAED,aAAa,EAAET,aAAa,EAA2D,CAAE;QACrG,IAAI,CAAC,CAACS,aAAa,GAAGA;QACtB,IAAI,CAACT,aAAa,GAAGA;IACvB;IAEAW,WAAW;QACT,OAAO;YACLZ,WAAW,IAAI,CAACA,SAAS;YACzBK,eAAe,IAAI,CAACA,aAAa;YACjCC,kBAAkB,IAAI,CAACA,gBAAgB;YACvCI,eAAe,IAAI,CAAC,CAACA,aAAa;YAClCP,uBAAuB,IAAI,CAACA,qBAAqB;YACjDC,iBAAiB,IAAI,CAACA,eAAe;YACrCF,QAAQ,IAAI,CAACA,MAAM;QACrB;IACF;IAEA;;GAEC,GACD,MAAMW,oBAAyC;QAC7C,IAAI,CAAE,MAAM,IAAI,CAACZ,aAAa,CAACa,gBAAgB,IAAK;YAClD;QACF;QACA,MAAMC,QAAQC,6BAAY,CAACC,OAAO;QAClC,MAAMC,OAAOF,6BAAY,CAACG,cAAc;QACxC,MAAMC,WAAW,MAAM,IAAI,CAACnB,aAAa,CAACoB,WAAW,CAACN,OAAOG;QAC7D,MAAMI,iBAAiB,MAAM,IAAI,CAACrB,aAAa,CAACsB,gBAAgB,CAACR,OAAOG;QACxE,IAAI,CAAChB,MAAM,GAAG;QACd,MAAMsB,WAAWJ,SAASK,IAAI;QAC9B,MAAMpB,gBAAgBiB,eAAeG,IAAI;QAEzC,gDAAgD;QAChD,IAAI,CAACzB,SAAS,GAAG,CAACwB,UAAUE;QAC5B,IAAI,CAACF,UAAUE,QAAQ;YACrB,IAAI,CAAC,CAACnB,MAAM,CAACoB,IAAI,CAAC;YAClB;QACF;QAEA,MAAMC,4BAA4B,IAAI,CAAC,CAAClB,aAAa;QACrD,IAAI,CAACJ,gBAAgB,GAAG;YACtBuB,UAAUD;QACZ;QACA,IAAI,CAACvB,aAAa,GAAGA;QAErB,IAAI,CAACF,qBAAqB,GAAG,CAAC,CAACyB;QAC/B,IAAI,CAAC,IAAI,CAACzB,qBAAqB,EAAE;YAC/B,IAAI,CAACC,eAAe,GAAG;YACvB;QACF;QAEA,8EAA8E;QAC9E,MAAM0B,iBAAiBC,eAAM,CAACC,EAAE,CAAC,IAAI,CAAC3B,aAAa,CAACwB,QAAQ,EAAE,IAAI,CAACvB,gBAAgB,CAACuB,QAAQ,EAAE;QAC9F,IAAI,CAACzB,eAAe,GAAG,IAAI,CAACD,qBAAqB,IAAI2B;IACvD;IAEA;;GAEC,GACDG,wBAAwB;QACtB,MAAMC,qBAAqB,IAAI,CAACtB,QAAQ;QACxC,MAAMP,gBAAgB6B,oBAAoB7B;QAC1C,MAAM8B,mBAAmB9B,eAAewB;QAExC,IAAI,CAACM,kBAAkB;YACrB,yBAAyB;YACzB;QACF;QAEA,MAAMC,iBAAiB,IAAI,CAAC,CAAC1B,aAAa;QAC1C,IAAI,CAAC,IAAI,CAACP,qBAAqB,EAAE;YAC/B,IAAI,CAAC,CAACI,MAAM,CAAC8B,GAAG,CACd,CAAC;6CACoC,EAAEF,iBAAiB;qCAC3B,EAAEC,eAAe;iCACrB,CAAC;YAE5B;QACF,OAAO;YACL,IAAI,CAAC,CAAC7B,MAAM,CAAC8B,GAAG,CACd,CAAC;6CACoC,EAAEF,iBAAiB;qCAC3B,EAAEC,eAAe;iCACrB,CAAC;QAE9B;QAEA,IAAI,CAAC,CAACA,kBAAkBF,mBAAmB9B,eAAe,EAAE;YAC1D,IAAI,CAAC,CAAC,IAAI,CAACJ,SAAS,EAAE;gBACpB,IAAI,CAAC,CAACO,MAAM,CAACoB,IAAI,CAAC,CAAC,mBAAmB,EAAES,eAAe,+DAA+D,CAAC;YACzH,OAAO;gBACL,IAAI,CAAC,CAAC7B,MAAM,CAAC8B,GAAG,CAAC,CAAC,+BAA+B,EAAEF,iBAAiB,cAAc,EAAE9B,cAAciC,UAAU,CAAC,CAAC,CAAC;YACjH;QACF,OAAO,IAAI,CAACF,gBAAgB;YAC1B,OAAO,IAAI,CAAC,CAAC7B,MAAM,CAACgC,KAAK,CACvB;QAEJ,OAAO;YACL,OAAO,IAAI,CAAC,CAAChC,MAAM,CAAC8B,GAAG,CAAC,CAAC,mBAAmB,EAAED,eAAe,qBAAqB,CAAC;QACrF;IACF;AACF"}

package/dist/services/core/server-update.service.js

@@ -0,0 +1,73 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", {
+    value: true
+});
+Object.defineProperty(exports, "ServerUpdateService", {
+    enumerable: true,
+    get: function() {
+        return ServerUpdateService;
+    }
+});
+const _envutils = require("../../utils/env.utils");
+const _serverconstants = require("../../server.constants");
+const _child_process = require("child_process");
+const _runtimeexceptions = require("../../exceptions/runtime.exceptions");
+class ServerUpdateService {
+    simpleGitService;
+    logger;
+    constructor({ simpleGitService, loggerFactory }){
+        this.simpleGitService = simpleGitService;
+        this.logger = loggerFactory(ServerUpdateService.name);
+    }
+    async restartServer() {
+        if (!(0, _envutils.isPm2)() && !(0, _envutils.isNodemon)()) {
+            // No daemon/overlay to trigger restart
+            throw new _runtimeexceptions.InternalServerException("Restart requested, but no daemon was available to perform this action");
+        }
+        if ((0, _envutils.isPm2)()) {
+            (0, _child_process.execSync)(`pm2 restart ${_serverconstants.AppConstants.pm2ServiceName}`, {
+                timeout: 5000
+            });
+            return true;
+        } else if ((0, _envutils.isNodemon)()) {
+            (0, _child_process.execSync)("echo '// Restart file for nodemon' > ./nodemon_restart_trigger.js", {
+                timeout: 5000
+            });
+            return true;
+        }
+    }
+    async checkGitUpdates() {
+        let isValidGitRepo = this.simpleGitService.checkIsRepo();
+        if (!isValidGitRepo) {
+            throw new _runtimeexceptions.ValidationException("Server update could not proceed as the server had no .git repository folder");
+        }
+        await this.simpleGitService.fetch();
+        const localRepoStatus = await this.simpleGitService.status();
+        if (!localRepoStatus) return;
+        const result = {
+            gitFolderFound: true,
+            updateCheckSuccess: true,
+            commitsBehind: localRepoStatus.behind,
+            commitsAhead: localRepoStatus.ahead,
+            filesModified: localRepoStatus.modified?.length,
+            status: "",
+            pullStatus: null
+        };
+        if (localRepoStatus?.behind === 0) {
+            result.status = "No commits to pull";
+            return result;
+        }
+        // Either something was not ignored properly or we are in unstable/dev mode
+        if (localRepoStatus?.modified?.length > 0 || localRepoStatus.ahead !== 0) {
+            result.status = "Files were modified or the repo was commits ahead - cannot pull safely";
+            return result;
+        }
+        this.logger.warn("Pulling git to get the latest server updates");
+        const pullDetails = await this.simpleGitService.pull();
+        result.status = "Pull action completed";
+        result.pullStatus = pullDetails;
+        return result;
+    }
+}
+
+//# sourceMappingURL=server-update.service.js.map

package/dist/services/core/server-update.service.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../../src/services/core/server-update.service.ts"],"names":["ServerUpdateService","simpleGitService","logger","constructor","loggerFactory","name","restartServer","isPm2","isNodemon","InternalServerException","execSync","AppConstants","pm2ServiceName","timeout","checkGitUpdates","isValidGitRepo","checkIsRepo","ValidationException","fetch","localRepoStatus","status","result","gitFolderFound","updateCheckSuccess","commitsBehind","behind","commitsAhead","ahead","filesModified","modified","length","pullStatus","warn","pullDetails","pull"],"mappings":";;;;+BAQaA;;;eAAAA;;;0BARoB;iCACJ;+BACJ;mCACoC;AAKtD,MAAMA;IACHC,iBAA4B;IAC5BC,OAAsB;IAE9BC,YAAY,EAAEF,gBAAgB,EAAEG,aAAa,EAAkE,CAAE;QAC/G,IAAI,CAACH,gBAAgB,GAAGA;QACxB,IAAI,CAACC,MAAM,GAAGE,cAAcJ,oBAAoBK,IAAI;IACtD;IAEA,MAAMC,gBAAgB;QACpB,IAAI,CAACC,IAAAA,eAAK,OAAM,CAACC,IAAAA,mBAAS,KAAI;YAC5B,uCAAuC;YACvC,MAAM,IAAIC,0CAAuB,CAAC;QACpC;QAEA,IAAIF,IAAAA,eAAK,KAAI;YACXG,IAAAA,uBAAQ,EAAC,CAAC,YAAY,EAAEC,6BAAY,CAACC,cAAc,CAAC,CAAC,EAAE;gBAAEC,SAAS;YAAK;YACvE,OAAO;QACT,OAAO,IAAIL,IAAAA,mBAAS,KAAI;YACtBE,IAAAA,uBAAQ,EAAC,qEAAqE;gBAC5EG,SAAS;YACX;YACA,OAAO;QACT;IACF;IAEA,MAAMC,kBAAkB;QACtB,IAAIC,iBAAiB,IAAI,CAACd,gBAAgB,CAACe,WAAW;QACtD,IAAI,CAACD,gBAAgB;YACnB,MAAM,IAAIE,sCAAmB,CAAC;QAChC;QAEA,MAAM,IAAI,CAAChB,gBAAgB,CAACiB,KAAK;QACjC,MAAMC,kBAAkB,MAAM,IAAI,CAAClB,gBAAgB,CAACmB,MAAM;QAE1D,IAAI,CAACD,iBAAiB;QAEtB,MAAME,SAAS;YACbC,gBAAgB;YAChBC,oBAAoB;YACpBC,eAAeL,gBAAgBM,MAAM;YACrCC,cAAcP,gBAAgBQ,KAAK;YACnCC,eAAeT,gBAAgBU,QAAQ,EAAEC;YACzCV,QAAQ;YACRW,YAAY;QACd;QAEA,IAAIZ,iBAAiBM,WAAW,GAAG;YACjCJ,OAAOD,MAAM,GAAG;YAChB,OAAOC;QACT;QAEA,2EAA2E;QAC3E,IAAIF,iBAAiBU,UAAUC,SAAS,KAAKX,gBAAgBQ,KAAK,KAAK,GAAG;YACxEN,OAAOD,MAAM,GAAG;YAChB,OAAOC;QACT;QAEA,IAAI,CAACnB,MAAM,CAAC8B,IAAI,CAAC;QAEjB,MAAMC,cAAc,MAAM,IAAI,CAAChC,gBAAgB,CAACiC,IAAI;QACpDb,OAAOD,MAAM,GAAG;QAChBC,OAAOU,UAAU,GAAGE;QACpB,OAAOZ;IACT;AACF"}

package/dist/services/core/task-manager.service.js

@@ -0,0 +1,196 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", {
+    value: true
+});
+Object.defineProperty(exports, "TaskManagerService", {
+    enumerable: true,
+    get: function() {
+        return TaskManagerService;
+    }
+});
+const _toadscheduler = require("toad-scheduler");
+const _awilix = require("awilix");
+const _jobexceptions = require("../../exceptions/job.exceptions");
+const _containertokens = require("../../container.tokens");
+class TaskManagerService {
+    jobScheduler;
+    taskStates = {};
+    cradle;
+    logger;
+    constructor(container){
+        this.cradle = container;
+        this.logger = container[_containertokens.DITokens.loggerFactory](TaskManagerService.name);
+        this.jobScheduler = container[_containertokens.DITokens.toadScheduler];
+    }
+    validateInput(taskId, workload, schedulerOptions) {
+        if (!taskId) {
+            throw new _jobexceptions.JobValidationException("Task ID was not provided. Cant register task or schedule job.");
+        }
+        const prefix = `Job '${workload?.name || "anonymous"}' with ID '${taskId}'`;
+        if (!!this.taskStates[taskId]) {
+            throw new _jobexceptions.JobValidationException(`${prefix} was already registered. Cant register a key twice.`, taskId);
+        }
+        if (typeof workload !== "function") {
+            if (typeof workload !== "string") {
+                throw new _jobexceptions.JobValidationException(`${prefix} is not a callable nor a string dependency to lookup. It can't be scheduled.`, taskId);
+            }
+            let resolvedService;
+            try {
+                resolvedService = this.cradle[workload];
+            } catch (e) {
+                if (e instanceof _awilix.AwilixResolutionError) {
+                    throw new _jobexceptions.JobValidationException(`${prefix} had an awilix dependency resolution error. It can't be scheduled without fixing this problem. Inner error:\n` + e.stack, taskId);
+                } else {
+                    throw new _jobexceptions.JobValidationException(`${prefix} is not a registered awilix dependency. It can't be scheduled. Error:\n` + e.stack, taskId);
+                }
+            }
+            if (typeof resolvedService?.run !== "function") {
+                throw new _jobexceptions.JobValidationException(`${prefix} was resolved but it doesn't have a 'run(..)' method to call.`, taskId);
+            }
+        }
+        if (!schedulerOptions?.periodic && !schedulerOptions?.runOnce && !schedulerOptions?.runDelayed) {
+            throw new _jobexceptions.JobValidationException(`Provide 'periodic' or 'runOnce' or 'runDelayed' option'.`, taskId);
+        }
+        if (!schedulerOptions?.periodic && !!schedulerOptions.disabled) {
+            throw new _jobexceptions.JobValidationException(`Only tasks of type 'periodic' can be disabled at boot.`, taskId);
+        }
+        if (schedulerOptions?.runDelayed && !schedulerOptions.milliseconds && !schedulerOptions.seconds) {
+            // Require milliseconds, minutes, hours or days
+            throw new _jobexceptions.JobValidationException(`Provide a delayed timing parameter (milliseconds|seconds)'`, taskId);
+        }
+        if (schedulerOptions?.periodic && !schedulerOptions.milliseconds && !schedulerOptions.seconds && !schedulerOptions.minutes && !schedulerOptions.hours && !schedulerOptions.days) {
+            // Require milliseconds, minutes, hours or days
+            throw new _jobexceptions.JobValidationException(`Provide a periodic timing parameter (milliseconds|seconds|minutes|hours|days)'`, taskId);
+        }
+    }
+    /**
+   * Create a recurring job
+   * Tip: use the options properties `runImmediately` and `seconds/milliseconds/minutes/hours/days`
+   */ registerJobOrTask({ id: taskId, task: asyncTaskCallbackOrToken, preset: schedulerOptions }) {
+        try {
+            this.validateInput(taskId, asyncTaskCallbackOrToken, schedulerOptions);
+        } catch (e) {
+            this.logger.error(e.stack, schedulerOptions);
+            return;
+        }
+        const timedTask = this.getSafeTimedTask(taskId, asyncTaskCallbackOrToken);
+        this.taskStates[taskId] = {
+            options: schedulerOptions,
+            timedTask
+        };
+        if (schedulerOptions.runOnce) {
+            timedTask.execute();
+        } else if (schedulerOptions.runDelayed) {
+            const delay = (schedulerOptions.milliseconds || 0) + (schedulerOptions.seconds || 0) * 1000;
+            this.runTimeoutTaskInstance(taskId, delay);
+        } else {
+            // This must be 'periodic'
+            this.#scheduleEnabledPeriodicJob(taskId);
+        }
+    }
+    /**
+   * Enable the job which must be disabled at boot. Handy for conditional, heavy or long-running non-critical tasks
+   * @param taskId
+   * @param failIfEnabled throws when the job is already running
+   */ scheduleDisabledJob(taskId, failIfEnabled = true) {
+        const taskState = this.getTaskState(taskId);
+        const schedulerOptions = taskState?.options;
+        if (schedulerOptions?.disabled !== true) {
+            if (failIfEnabled) {
+                throw new _jobexceptions.JobValidationException(`The requested task with ID ${taskId} was not explicitly disabled and must be running already.`);
+            }
+            return;
+        }
+        taskState.options.disabled = false;
+        this.#scheduleEnabledPeriodicJob(taskId);
+    }
+    disableJob(taskId, failIfDisabled = true) {
+        if (this.isTaskDisabled(taskId)) {
+            if (failIfDisabled) {
+                throw new _jobexceptions.JobValidationException("Cant disable a job which is already disabled");
+            }
+            return;
+        }
+        const taskState = this.getTaskState(taskId);
+        taskState.options.disabled = true;
+        // TODO this does not seem to work as intended #https://github.com/fdm-monster/fdm-monster/issues/1071
+        taskState.job.stop();
+    }
+    isTaskDisabled(taskId) {
+        return !!this.getTaskState(taskId).options.disabled;
+    }
+    deregisterTask(taskId) {
+        this.getTaskState(taskId);
+        delete this.taskStates[taskId];
+        this.jobScheduler.removeById(taskId);
+    }
+    getTaskState(taskId) {
+        const taskState = this.taskStates[taskId];
+        if (!taskState) {
+            throw new _jobexceptions.JobValidationException(`The requested task with ID ${taskId} was not registered`);
+        }
+        return taskState;
+    }
+    runTimeoutTaskInstance(taskId, timeoutMs) {
+        const taskState = this.getTaskState(taskId);
+        this.logger.log(`Running delayed task ${taskId} in ${timeoutMs}ms`);
+        setTimeout(()=>taskState.timedTask.execute(), timeoutMs, taskId);
+    }
+    getSafeTimedTask(taskId, handler) {
+        const asyncHandler = async ()=>{
+            await this.timeTask(taskId, handler);
+        };
+        return new _toadscheduler.AsyncTask(taskId, asyncHandler, this.getErrorHandler(taskId));
+    }
+    async timeTask(taskId, handler) {
+        let taskState = this.taskStates[taskId];
+        taskState.started = Date.now();
+        if (typeof handler === "string") {
+            const taskService = this.cradle[handler];
+            await taskService.run();
+        } else {
+            await handler();
+        }
+        taskState.duration = Date.now() - taskState.started;
+        if (taskState.options?.logFirstCompletion !== false && !taskState?.firstCompletion) {
+            this.logger.log(`Task '${taskId}' first completion. Duration ${taskState.duration}ms`);
+            taskState.firstCompletion = Date.now();
+        }
+    }
+    getErrorHandler(taskId) {
+        return (error)=>{
+            const registration = this.taskStates[taskId];
+            if (!registration.lastError) registration.erroredlastError = {
+                time: Date.now(),
+                error
+            };
+            this.logger.error(`Task '${taskId}' threw an exception:` + error.stack);
+        };
+    }
+    /**
+   * Stops the tasks which were registered
+   */ stopSchedulerTasks() {
+        this.jobScheduler.stop();
+    }
+    #scheduleEnabledPeriodicJob(taskId) {
+        const taskState = this.getTaskState(taskId);
+        if (!taskState?.timedTask || !taskState?.options) {
+            throw new _jobexceptions.JobValidationException(`The requested task with ID ${taskId} was not registered properly ('timedTask' or 'options' missing).`);
+        }
+        const schedulerOptions = taskState?.options;
+        const timedTask = taskState.timedTask;
+        if (!schedulerOptions?.periodic) {
+            throw new _jobexceptions.JobValidationException(`The requested task with ID ${taskId} is not periodic and cannot be enabled.`);
+        }
+        if (!schedulerOptions.disabled) {
+            this.logger.log(`Task '${taskId}' was scheduled (runImmediately: ${!!schedulerOptions.runImmediately}).`);
+            const job = new _toadscheduler.SimpleIntervalJob(schedulerOptions, timedTask);
+            taskState.job = job;
+            this.jobScheduler.addSimpleIntervalJob(job);
+        } else {
+            this.logger.log(`Task '${taskId}' was marked as disabled (deferred execution).`);
+        }
+    }
+}
+
+//# sourceMappingURL=task-manager.service.js.map

package/dist/services/core/task-manager.service.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../../src/services/core/task-manager.service.ts"],"names":["TaskManagerService","jobScheduler","taskStates","cradle","logger","constructor","container","DITokens","loggerFactory","name","toadScheduler","validateInput","taskId","workload","schedulerOptions","JobValidationException","prefix","resolvedService","e","AwilixResolutionError","stack","run","periodic","runOnce","runDelayed","disabled","milliseconds","seconds","minutes","hours","days","registerJobOrTask","id","task","asyncTaskCallbackOrToken","preset","error","timedTask","getSafeTimedTask","options","execute","delay","runTimeoutTaskInstance","scheduleEnabledPeriodicJob","scheduleDisabledJob","failIfEnabled","taskState","getTaskState","disableJob","failIfDisabled","isTaskDisabled","job","stop","deregisterTask","removeById","timeoutMs","log","setTimeout","handler","asyncHandler","timeTask","AsyncTask","getErrorHandler","started","Date","now","taskService","duration","logFirstCompletion","firstCompletion","registration","lastError","erroredlastError","time","stopSchedulerTasks","runImmediately","SimpleIntervalJob","addSimpleIntervalJob"],"mappings":";;;;+BASaA;;;eAAAA;;;+BAT+C;wBACtB;+BACC;iCACd;AAMlB,MAAMA;IACXC,aAA4B;IAC5BC,aAAa,CAAC,EAAE;IAERC,OAAY;IACZC,OAAsB;IAE9BC,YAAYC,SAAc,CAAE;QAC1B,IAAI,CAACH,MAAM,GAAGG;QACd,IAAI,CAACF,MAAM,GAAGE,SAAS,CAACC,yBAAQ,CAACC,aAAa,CAAC,CAACR,mBAAmBS,IAAI;QACvE,IAAI,CAACR,YAAY,GAAGK,SAAS,CAACC,yBAAQ,CAACG,aAAa,CAAC;IACvD;IAEAC,cAAcC,MAAc,EAAEC,QAAQ,EAAEC,gBAAgB,EAAE;QACxD,IAAI,CAACF,QAAQ;YACX,MAAM,IAAIG,qCAAsB,CAAC;QACnC;QACA,MAAMC,SAAS,CAAC,KAAK,EAAEH,UAAUJ,QAAQ,YAAY,WAAW,EAAEG,OAAO,CAAC,CAAC;QAC3E,IAAI,CAAC,CAAC,IAAI,CAACV,UAAU,CAACU,OAAO,EAAE;YAC7B,MAAM,IAAIG,qCAAsB,CAAC,CAAC,EAAEC,OAAO,mDAAmD,CAAC,EAAEJ;QACnG;QAEA,IAAI,OAAOC,aAAa,YAAY;YAClC,IAAI,OAAOA,aAAa,UAAU;gBAChC,MAAM,IAAIE,qCAAsB,CAC9B,CAAC,EAAEC,OAAO,4EAA4E,CAAC,EACvFJ;YAEJ;YAEA,IAAIK;YACJ,IAAI;gBACFA,kBAAkB,IAAI,CAACd,MAAM,CAACU,SAAS;YACzC,EAAE,OAAOK,GAAG;gBACV,IAAIA,aAAaC,6BAAqB,EAAE;oBACtC,MAAM,IAAIJ,qCAAsB,CAC9B,CAAC,EAAEC,OAAO,6GAA6G,CAAC,GACtHE,EAAEE,KAAK,EACTR;gBAEJ,OAAO;oBACL,MAAM,IAAIG,qCAAsB,CAC9B,CAAC,EAAEC,OAAO,uEAAuE,CAAC,GAAGE,EAAEE,KAAK,EAC5FR;gBAEJ;YACF;YAEA,IAAI,OAAOK,iBAAiBI,QAAQ,YAAY;gBAC9C,MAAM,IAAIN,qCAAsB,CAAC,CAAC,EAAEC,OAAO,6DAA6D,CAAC,EAAEJ;YAC7G;QACF;QAEA,IAAI,CAACE,kBAAkBQ,YAAY,CAACR,kBAAkBS,WAAW,CAACT,kBAAkBU,YAAY;YAC9F,MAAM,IAAIT,qCAAsB,CAAC,CAAC,wDAAwD,CAAC,EAAEH;QAC/F;QACA,IAAI,CAACE,kBAAkBQ,YAAY,CAAC,CAACR,iBAAiBW,QAAQ,EAAE;YAC9D,MAAM,IAAIV,qCAAsB,CAAC,CAAC,sDAAsD,CAAC,EAAEH;QAC7F;QACA,IAAIE,kBAAkBU,cAAc,CAACV,iBAAiBY,YAAY,IAAI,CAACZ,iBAAiBa,OAAO,EAAE;YAC/F,+CAA+C;YAC/C,MAAM,IAAIZ,qCAAsB,CAAC,CAAC,0DAA0D,CAAC,EAAEH;QACjG;QACA,IACEE,kBAAkBQ,YAClB,CAACR,iBAAiBY,YAAY,IAC9B,CAACZ,iBAAiBa,OAAO,IACzB,CAACb,iBAAiBc,OAAO,IACzB,CAACd,iBAAiBe,KAAK,IACvB,CAACf,iBAAiBgB,IAAI,EACtB;YACA,+CAA+C;YAC/C,MAAM,IAAIf,qCAAsB,CAAC,CAAC,8EAA8E,CAAC,EAAEH;QACrH;IACF;IAEA;;;GAGC,GACDmB,kBAAkB,EAAEC,IAAIpB,MAAM,EAAEqB,MAAMC,wBAAwB,EAAEC,QAAQrB,gBAAgB,EAAE,EAAE;QAC1F,IAAI;YACF,IAAI,CAACH,aAAa,CAACC,QAAQsB,0BAA0BpB;QACvD,EAAE,OAAOI,GAAG;YACV,IAAI,CAACd,MAAM,CAACgC,KAAK,CAAClB,EAAEE,KAAK,EAAEN;YAC3B;QACF;QAEA,MAAMuB,YAAY,IAAI,CAACC,gBAAgB,CAAC1B,QAAQsB;QAEhD,IAAI,CAAChC,UAAU,CAACU,OAAO,GAAG;YACxB2B,SAASzB;YACTuB;QACF;QAEA,IAAIvB,iBAAiBS,OAAO,EAAE;YAC5Bc,UAAUG,OAAO;QACnB,OAAO,IAAI1B,iBAAiBU,UAAU,EAAE;YACtC,MAAMiB,QAAQ,AAAC3B,CAAAA,iBAAiBY,YAAY,IAAI,CAAA,IAAK,AAACZ,CAAAA,iBAAiBa,OAAO,IAAI,CAAA,IAAK;YACvF,IAAI,CAACe,sBAAsB,CAAC9B,QAAQ6B;QACtC,OAAO;YACL,0BAA0B;YAC1B,IAAI,CAAC,CAACE,0BAA0B,CAAC/B;QACnC;IACF;IAEA;;;;GAIC,GACDgC,oBAAoBhC,MAAM,EAAEiC,gBAAgB,IAAI,EAAE;QAChD,MAAMC,YAAY,IAAI,CAACC,YAAY,CAACnC;QACpC,MAAME,mBAAmBgC,WAAWP;QACpC,IAAIzB,kBAAkBW,aAAa,MAAM;YACvC,IAAIoB,eAAe;gBACjB,MAAM,IAAI9B,qCAAsB,CAC9B,CAAC,2BAA2B,EAAEH,OAAO,yDAAyD,CAAC;YAEnG;YACA;QACF;QAEAkC,UAAUP,OAAO,CAACd,QAAQ,GAAG;QAE7B,IAAI,CAAC,CAACkB,0BAA0B,CAAC/B;IACnC;IAEAoC,WAAWpC,MAAM,EAAEqC,iBAAiB,IAAI,EAAE;QACxC,IAAI,IAAI,CAACC,cAAc,CAACtC,SAAS;YAC/B,IAAIqC,gBAAgB;gBAClB,MAAM,IAAIlC,qCAAsB,CAAC;YACnC;YACA;QACF;QAEA,MAAM+B,YAAY,IAAI,CAACC,YAAY,CAACnC;QACpCkC,UAAUP,OAAO,CAACd,QAAQ,GAAG;QAC7B,sGAAsG;QACtGqB,UAAUK,GAAG,CAACC,IAAI;IACpB;IAEAF,eAAetC,MAAM,EAAE;QACrB,OAAO,CAAC,CAAC,IAAI,CAACmC,YAAY,CAACnC,QAAQ2B,OAAO,CAACd,QAAQ;IACrD;IAEA4B,eAAezC,MAAM,EAAE;QACrB,IAAI,CAACmC,YAAY,CAACnC;QAElB,OAAO,IAAI,CAACV,UAAU,CAACU,OAAO;QAC9B,IAAI,CAACX,YAAY,CAACqD,UAAU,CAAC1C;IAC/B;IAEAmC,aAAanC,MAAM,EAAE;QACnB,MAAMkC,YAAY,IAAI,CAAC5C,UAAU,CAACU,OAAO;QACzC,IAAI,CAACkC,WAAW;YACd,MAAM,IAAI/B,qCAAsB,CAAC,CAAC,2BAA2B,EAAEH,OAAO,mBAAmB,CAAC;QAC5F;QACA,OAAOkC;IACT;IAEAJ,uBAAuB9B,MAAM,EAAE2C,SAAS,EAAE;QACxC,MAAMT,YAAY,IAAI,CAACC,YAAY,CAACnC;QACpC,IAAI,CAACR,MAAM,CAACoD,GAAG,CAAC,CAAC,qBAAqB,EAAE5C,OAAO,IAAI,EAAE2C,UAAU,EAAE,CAAC;QAClEE,WAAW,IAAMX,UAAUT,SAAS,CAACG,OAAO,IAAIe,WAAW3C;IAC7D;IAEA0B,iBAAiB1B,MAAM,EAAE8C,OAAO,EAAE;QAChC,MAAMC,eAAe;YACnB,MAAM,IAAI,CAACC,QAAQ,CAAChD,QAAQ8C;QAC9B;QAEA,OAAO,IAAIG,wBAAS,CAACjD,QAAQ+C,cAAc,IAAI,CAACG,eAAe,CAAClD;IAClE;IAEA,MAAMgD,SAAShD,MAAM,EAAE8C,OAAO,EAAE;QAC9B,IAAIZ,YAAY,IAAI,CAAC5C,UAAU,CAACU,OAAO;QACvCkC,UAAUiB,OAAO,GAAGC,KAAKC,GAAG;QAC5B,IAAI,OAAOP,YAAY,UAAU;YAC/B,MAAMQ,cAAc,IAAI,CAAC/D,MAAM,CAACuD,QAAQ;YACxC,MAAMQ,YAAY7C,GAAG;QACvB,OAAO;YACL,MAAMqC;QACR;QACAZ,UAAUqB,QAAQ,GAAGH,KAAKC,GAAG,KAAKnB,UAAUiB,OAAO;QAEnD,IAAIjB,UAAUP,OAAO,EAAE6B,uBAAuB,SAAS,CAACtB,WAAWuB,iBAAiB;YAClF,IAAI,CAACjE,MAAM,CAACoD,GAAG,CAAC,CAAC,MAAM,EAAE5C,OAAO,6BAA6B,EAAEkC,UAAUqB,QAAQ,CAAC,EAAE,CAAC;YACrFrB,UAAUuB,eAAe,GAAGL,KAAKC,GAAG;QACtC;IACF;IAEAH,gBAAgBlD,MAAM,EAAE;QACtB,OAAO,CAACwB;YACN,MAAMkC,eAAe,IAAI,CAACpE,UAAU,CAACU,OAAO;YAE5C,IAAI,CAAC0D,aAAaC,SAAS,EACzBD,aAAaE,gBAAgB,GAAG;gBAC9BC,MAAMT,KAAKC,GAAG;gBACd7B;YACF;YAEF,IAAI,CAAChC,MAAM,CAACgC,KAAK,CAAC,CAAC,MAAM,EAAExB,OAAO,qBAAqB,CAAC,GAAGwB,MAAMhB,KAAK;QACxE;IACF;IAEA;;GAEC,GACDsD,qBAAqB;QACnB,IAAI,CAACzE,YAAY,CAACmD,IAAI;IACxB;IAEA,CAACT,0BAA0B,CAAC/B,MAAM;QAChC,MAAMkC,YAAY,IAAI,CAACC,YAAY,CAACnC;QACpC,IAAI,CAACkC,WAAWT,aAAa,CAACS,WAAWP,SAAS;YAChD,MAAM,IAAIxB,qCAAsB,CAC9B,CAAC,2BAA2B,EAAEH,OAAO,gEAAgE,CAAC;QAE1G;QACA,MAAME,mBAAmBgC,WAAWP;QACpC,MAAMF,YAAYS,UAAUT,SAAS;QACrC,IAAI,CAACvB,kBAAkBQ,UAAU;YAC/B,MAAM,IAAIP,qCAAsB,CAAC,CAAC,2BAA2B,EAAEH,OAAO,uCAAuC,CAAC;QAChH;QACA,IAAI,CAACE,iBAAiBW,QAAQ,EAAE;YAC9B,IAAI,CAACrB,MAAM,CAACoD,GAAG,CAAC,CAAC,MAAM,EAAE5C,OAAO,iCAAiC,EAAE,CAAC,CAACE,iBAAiB6D,cAAc,CAAC,EAAE,CAAC;YACxG,MAAMxB,MAAM,IAAIyB,gCAAiB,CAAC9D,kBAAkBuB;YACpDS,UAAUK,GAAG,GAAGA;YAChB,IAAI,CAAClD,YAAY,CAAC4E,oBAAoB,CAAC1B;QACzC,OAAO;YACL,IAAI,CAAC/C,MAAM,CAACoD,GAAG,CAAC,CAAC,MAAM,EAAE5C,OAAO,8CAA8C,CAAC;QACjF;IACF;AACF"}