Exit st2chatop from st2client failures.

Create a new environment variable `EXIT_ON_FAILURES` with default value `false`. If user is not explicitly setup, it will work as today.

If `EXIT_ON_FAILURES` is setup, for the case if `st2chatops` encounters authenticate or unresolved application URL issues with Stackstorm,  instead it's being unresponsive/hanging/waiting in a running state, `st2chatops` will be exit.

Author: jinpingh

CHANGELOG.rst

@@ -8,6 +8,7 @@ in development
 -----
 * Add initial support for Microsoft Teams via BotFramework (new feature)
 * Add unit tests for all adapters (improvement)
+* Add environment variable `EXIT_ON_FAILURES` to allow `st2chatops` to exit from `st2client` failures.
 
 0.9.2
 -----

README.md

@@ -77,6 +77,7 @@ specified when running hubot:
 * `ST2_SLACK_FAIL_COLOR` - Slack attachement color for failures either be one of good, warning, danger, or any hex color code (optional).
 * `ST2_ROCKETCHAT_SUCCESS_COLOR` - RocketChat attachement color for success, can either be one of good, warning, danger, or any hex color code (optional).
 * `ST2_ROCKETCHAT_FAIL_COLOR` - RocketChat attachement color for failures either be one of good, warning, danger, or any hex color code (optional).
+* `EXIT_ON_FAILURES` - Exit from st2chatops for st2client failures. Default is `false` (optional).
 
 Note: ``ST2_ROUTE`` environment variable mentioned below should only be
 specified if you modified the rule which comes with a ``hubot`` pack to use a

scripts/stackstorm.js

@@ -75,6 +75,9 @@ env.ST2_COMMANDS_RELOAD_INTERVAL = parseInt(env.ST2_COMMANDS_RELOAD_INTERVAL ||
 // Cap message length to a certain number of characters.
 env.ST2_MAX_MESSAGE_LENGTH = parseInt(env.ST2_MAX_MESSAGE_LENGTH || 500, 10);
 
+// Exit from st2chatops for st2client failures
+env.EXIT_ON_FAILURES = env.EXIT_ON_FAILURES || null;
+
 // Constants
 // Fun human-friendly commands. Use %s for payload output.
 var START_MESSAGES = [
@@ -171,7 +174,11 @@ module.exports = function(robot) {
       .catch(function (err) {
         robot.logger.error('Failed to authenticate: ' + err.message);
 
-        throw err;
+        if (env.EXIT_ON_FAILURES) {
+          stop({exit: true});
+        } else {
+          throw err;
+        }
       });
   }
 
@@ -199,7 +206,7 @@ module.exports = function(robot) {
   // handler to manage per adapter message post-ing.
   var postDataHandler = postData.getDataPostHandler(robot.adapterName, robot, formatter);
 
-  var loadCommands = function() {
+  var loadCommands = function(exitOnFailure) {
     robot.logger.info('Loading commands....');
 
     api.actionAlias.list()
@@ -238,6 +245,9 @@ module.exports = function(robot) {
       .catch(function (err) {
         var error_msg = 'Failed to retrieve commands from "%s": %s';
         robot.logger.error(util.format(error_msg, env.ST2_API_URL, err.message));
+        if (exitOnFailure) {
+          stop({exit: true});
+        }
       });
   };
 
@@ -409,32 +419,36 @@ module.exports = function(robot) {
       }
     });
 
-    // Add an interval which tries to re-load the commands
-    commands_load_interval = setInterval(loadCommands.bind(self), (env.ST2_COMMANDS_RELOAD_INTERVAL * 1000));
-
     // Initial command loading
-    loadCommands();
+    loadCommands(env.EXIT_ON_FAILURES);
 
     // Install SIGUSR2 handler which reloads the command
     install_sigusr2_handler();
+
+    // Add an interval which tries to re-load the commands
+    commands_load_interval = setInterval(loadCommands.bind(self, false), (env.ST2_COMMANDS_RELOAD_INTERVAL * 1000));
   }
 
-  function stop() {
+  function stop(exitFromProcess) {
     clearInterval(commands_load_interval);
     api.stream.listen().then(function (source) {
       source.removeAllListeners();
       source.close();
     });
+
+    if (exitFromProcess.exit) {
+       process.exit(1)
+    }
   }
 
   function install_sigusr2_handler() {
     process.on('SIGUSR2', function() {
-      loadCommands();
+      loadCommands(false);
     });
   }
 
   // Authenticate with StackStorm backend and then call start.
-  // On a failure to authenticate log the error but do not quit.
+  // On a failure to authenticate log the error.
   return promise.then(function () {
     start();
     return stop;