node_helper.js

/** 
 * EdgeRouter Throughput
 * A MagicMirror² Module to show the Interface throughput of an Ubiquity EdgeRouter
 * 
 * Version 1.0.0
 * By Michael Scharl <michael.scharl@me.com>
 * 
 * License MIT
 * 
 * This is an autogenerated file. DO NOT EDIT!
 */
(function (global, factory) {
    typeof exports === 'object' && typeof module !== 'undefined' ? factory(require('ssh2-promise')) :
    typeof define === 'function' && define.amd ? define(['ssh2-promise'], factory) :
    (global = global || self, factory(global.SSH));
}(this, function (SSH) { 'use strict';

    SSH = SSH && SSH.hasOwnProperty('default') ? SSH['default'] : SSH;

    /*! *****************************************************************************
    Copyright (c) Microsoft Corporation. All rights reserved.
    Licensed under the Apache License, Version 2.0 (the "License"); you may not use
    this file except in compliance with the License. You may obtain a copy of the
    License at http://www.apache.org/licenses/LICENSE-2.0

    THIS CODE IS PROVIDED ON AN *AS IS* BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
    KIND, EITHER EXPRESS OR IMPLIED, INCLUDING WITHOUT LIMITATION ANY IMPLIED
    WARRANTIES OR CONDITIONS OF TITLE, FITNESS FOR A PARTICULAR PURPOSE,
    MERCHANTABLITY OR NON-INFRINGEMENT.

    See the Apache Version 2.0 License for specific language governing permissions
    and limitations under the License.
    ***************************************************************************** */

    var __assign = function() {
        __assign = Object.assign || function __assign(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);
    };

    function __awaiter(thisArg, _arguments, P, generator) {
        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) : new P(function (resolve) { resolve(result.value); }).then(fulfilled, rejected); }
            step((generator = generator.apply(thisArg, _arguments || [])).next());
        });
    }

    function __generator(thisArg, body) {
        var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;
        return g = { next: verb(0), "throw": verb(1), "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 (_) 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 };
        }
    }

    var ModuleNotification;
    (function (ModuleNotification) {
        ModuleNotification["CONFIG"] = "CONFIG";
        ModuleNotification["THROUGHPUT"] = "THROUGHPUT";
    })(ModuleNotification || (ModuleNotification = {}));

    var NodeHelper = require('node_helper');
    module.exports = NodeHelper.create({
        /**
         * Holds the interval for fetching the throughput data.
         */
        fetchInterval: null,
        /**
         * Holds all SSH-connections keyed by gateway.
         */
        sshClients: {},
        /**
         * Start the helper
         */
        start: function () {
            var _this = this;
            setInterval(function () {
                _this._fetchData();
            }, 1000);
        },
        /**
         * Stop the interval and close the connections.
         */
        stop: function () {
            clearInterval(this.fetchInterval);
            Object
                .entries(this.sshClients)
                .filter(function (item) { return !!item[1]; })
                .forEach(function (_a) {
                var gateway = _a[0], client = _a[1];
                return client.close().then(function () {
                    console.log('MMM-edgerouter-throughput: Closed connection to %o', gateway);
                });
            });
        },
        /**
         * Handle socket notifications.
         *
         * @param {ModuleNotification} notification
         * @param {*} payload
         */
        socketNotificationReceived: function (notification, payload) {
            switch (notification) {
                case ModuleNotification.CONFIG:
                    this._setupSSHClient(payload);
                    break;
            }
        },
        /**
         * Fetch data from the connected clients.
         *
         * @private
         */
        _fetchData: function () {
            var _this = this;
            var sshClients = this.sshClients;
            var promises = Object
                .entries(sshClients)
                // Filter out failed connections.
                .filter(function (item) { return !!item[1]; })
                // Fetch the current throughput.
                .map(function (_a) {
                var gateway = _a[0], client = _a[1];
                return client.exec('/sbin/ifstat --json').then(function (result) { return ({
                    gateway: gateway,
                    result: result,
                }); });
            })
                // Parse and normalize the result.
                .map(function (promise) { return promise.then(function (_a) {
                var gateway = _a.gateway, result = _a.result;
                var output = JSON.parse(result);
                var data = output[Object.keys(output)[0]];
                return {
                    gateway: gateway,
                    data: data,
                };
            }); });
            // Wait for all the data.
            Promise.all(promises)
                // Reduce all results into a single payload.
                .then(function (results) { return results.reduce(function (payload, _a) {
                var _b;
                var gateway = _a.gateway, data = _a.data;
                return __assign({}, payload, (_b = {}, _b[gateway] = data, _b));
            }, {}); })
                // Send the payload via socket notifications.
                .then(function (payload) {
                _this.sendSocketNotification(ModuleNotification.THROUGHPUT, payload);
            });
        },
        /**
         * Setup a new SSH-connection.
         *
         * @param {DataConfig} config
         * @private
         */
        _setupSSHClient: function (config) {
            return __awaiter(this, void 0, void 0, function () {
                var gateway, username, password, _a, _b, error_1;
                return __generator(this, function (_c) {
                    switch (_c.label) {
                        case 0:
                            gateway = config.gateway, username = config.username, password = config.password;
                            if (!!this.sshClients[gateway]) return [3 /*break*/, 4];
                            _c.label = 1;
                        case 1:
                            _c.trys.push([1, 3, , 4]);
                            _a = this.sshClients;
                            _b = gateway;
                            return [4 /*yield*/, new SSH({
                                    host: gateway,
                                    username: username,
                                    password: password,
                                })];
                        case 2:
                            _a[_b] = _c.sent();
                            console.log('MMM-edgerouter-throughput: Connected to %o', gateway);
                            return [3 /*break*/, 4];
                        case 3:
                            error_1 = _c.sent();
                            console.error('Failed to connect', error_1);
                            this.sshClients[gateway] = false;
                            return [3 /*break*/, 4];
                        case 4: return [2 /*return*/];
                    }
                });
            });
        },
    });

}));