@themost/data/UnattendedMode.js

MOST Web Framework Codename Blueshift - Data module

var unattendedMode = Symbol('unattendedMode');
var {RandomUtils} = require('@themost/common');

/**
 * Execute a callable function with elevated privileges in unattended mode.
 * @param {import('./types').DataContext} context
 * @param {function(function(Error?): void)} callable
 * @param {function(Error?): void} callback
 * @returns {void}
 */
function executeInUnattendedMode(context, callable, callback) {
    if (typeof callable !== 'function') {
        return callback(new Error('Unattended mode requires a callable function'));
    }
    // if the context is already in unattended mode
    if (context[unattendedMode]) {
        try {
            // execute callable function
            void callable(function (err) {
                return callback(err);
            });
        } catch (err) {
            return callback(err);
        }
    } else {
        var interactiveUser;
        try {
            const account = context.getConfiguration().getSourceAt('settings/auth/unattendedExecutionAccount');
            if (account == null) {
                return callback(new Error('The unattended execution account is not defined. The operation cannot be completed.'));
            }
            // enter unattended mode
            context[unattendedMode] = true;
            // get interactive user
            if (context.user) {
                interactiveUser = Object.assign({}, context.user);
                // set interactive user
                context.interactiveUser = interactiveUser;
            }
            if (account) {
                context.user = {name: account, authenticationType: 'Basic'};
            }
            void callable(function (err) {
                // restore user
                if (interactiveUser) {
                    context.user = Object.assign({}, interactiveUser);
                }
                delete context.interactiveUser;
                // exit unattended mode
                delete context[unattendedMode];
                return callback(err);
            });
        } catch (err) {
            // restore user
            if (interactiveUser) {
                context.user = Object.assign({}, interactiveUser);
            }
            delete context.interactiveUser;
            // exit unattended mode
            delete context[unattendedMode];
            return callback(err);
        }
    }
}

/**
 * Execute a callable function with elevated privileges in unattended mode.
 * @param {import('./types').DataContext} context
 * @param {function(): Promise<void>} callable
 * @returns {Promise<void>}
 */
function executeInUnattendedModeAsync(context, callable) {
    return new Promise((resolve, reject) => {
        void executeInUnattendedMode(context, function (cb) {
            return callable().then(function () {
                return cb();
            }).catch(function (err) {
                return cb(err);
            });
        }, function (err) {
            if (err) {
                return reject(err);
            }
            return resolve();
        });
    });
}

/**
 * Enables unattended mode
 * @param {{getConfiguration(): import('@themost/common').ConfigurationBase}} app
 * @param {string=} executionAccount
 */
function enableUnattendedExecution(app, executionAccount) {
    app.getConfiguration().setSourceAt('settings/auth/unattendedExecutionAccount', executionAccount || RandomUtils.randomChars(14));
}
/**
 * Disables unattended mode
 * @param {{getConfiguration(): import('@themost/common').ConfigurationBase}} app
 */
function disableUnattendedExecution(app) {
    app.getConfiguration().setSourceAt('settings/auth/unattendedExecutionAccount', null);
}

module.exports = {
    executeInUnattendedMode,
    executeInUnattendedModeAsync,
    enableUnattendedExecution,
    disableUnattendedExecution
}