pip-services3-components-node/obj/src/test/Shutdown.js

Component definitions for Pip.Services in Node.js

"use strict";
Object.defineProperty(exports, "__esModule", { value: true });
exports.Shutdown = void 0;
/** @module test */
/** @hidden */
let _ = require('lodash');
const pip_services3_commons_node_1 = require("pip-services3-commons-node");
const pip_services3_commons_node_2 = require("pip-services3-commons-node");
/**
 * Random shutdown component that crashes the process
 * using various methods.
 *
 * The component is usually used for testing, but brave developers
 * can try to use it in production to randomly crash microservices.
 * It follows the concept of "Chaos Monkey" popularized by Netflix.
 *
 * ### Configuration parameters ###
 *
 * - mode:          null - crash by NullPointer excepiton, zero - crash by dividing by zero, excetion = crash by unhandled exception, exit - exit the process
 * - min_timeout:   minimum crash timeout in milliseconds (default: 5 mins)
 * - max_timeout:   maximum crash timeout in milliseconds (default: 15 minutes)
 *
 * ### Example ###
 *
 *     let shutdown = new Shutdown();
 *     shutdown.configure(ConfigParams.fromTuples(
 *         "mode": "exception"
 *     ));
 *     shutdown.shutdown();         // Result: Bang!!! the process crashes
 */
class Shutdown {
    /**
     * Creates a new instance of the shutdown component.
     */
    constructor() {
        this._mode = 'exception';
        this._minTimeout = 300000;
        this._maxTimeout = 900000;
    }
    /**
     * Configures component by passing configuration parameters.
     *
     * @param config    configuration parameters to be set.
     */
    configure(config) {
        this._mode = config.getAsStringWithDefault('mode', this._mode);
        this._minTimeout = config.getAsIntegerWithDefault('min_timeout', this._minTimeout);
        this._maxTimeout = config.getAsIntegerWithDefault('max_timeout', this._maxTimeout);
    }
    /**
     * Checks if the component is opened.
     *
     * @returns true if the component has been opened and false otherwise.
     */
    isOpen() {
        return this._interval != null;
    }
    /**
     * Opens the component.
     *
     * @param correlationId 	(optional) transaction id to trace execution through call chain.
     * @param callback 			callback function that receives error or null no errors occured.
     */
    open(correlationId, callback) {
        if (this._interval != null)
            clearInterval(this._interval);
        let timeout = pip_services3_commons_node_1.RandomInteger.nextInteger(this._minTimeout, this._maxTimeout);
        this._interval = setInterval(() => {
            this.shutdown();
        }, timeout);
        if (callback)
            callback(null);
    }
    /**
     * Closes component and frees used resources.
     *
     * @param correlationId 	(optional) transaction id to trace execution through call chain.
     * @param callback 			callback function that receives error or null no errors occured.
     */
    close(correlationId, callback) {
        if (this._interval != null) {
            clearInterval(this._interval);
            this._interval = null;
        }
        if (callback)
            callback(null);
    }
    /**
     * Crashes the process using the configured crash mode.
     */
    shutdown() {
        if (this._mode == 'null' || this._mode == 'nullpointer') {
            let obj = null;
            obj.crash = 123;
        }
        else if (this._mode == 'zero' || this._mode == 'dividebyzero') {
            let crash = 0 / 100;
        }
        else if (this._mode == 'exit' || this._mode == 'processexit') {
            process.exit(1);
        }
        else {
            let err = new pip_services3_commons_node_2.ApplicationException('test', null, 'CRASH', 'Crash test exception');
            throw err;
        }
    }
}
exports.Shutdown = Shutdown;
//# sourceMappingURL=Shutdown.js.map