Log errors and exit on authentication issues on Hubot plugin initialization #168
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -99,22 +99,20 @@ var TWOFACTOR_MESSAGE = "This action requires two-factor auth! Waiting for your | |
| module.exports = function(robot) { | ||
| slack_monkey_patch.patchSendMessage(robot); | ||
|
|
||
| if (env.ST2_API) { | ||
| robot.logger.warning("ST2_API is deprecated and will be removed in a future releases. Instead, please use the ST2_API_URL environment variable."); | ||
| } | ||
| var _stream = null, | ||
| self = this, | ||
| promise = Promise.resolve(), | ||
| url = utils.parseUrl(env.ST2_API_URL), | ||
| opts = { | ||
| protocol: url.protocol, | ||
| host: url.hostname, | ||
| port: url.port, | ||
| prefix: url.path, | ||
| rejectUnauthorized: false | ||
| }; | ||
|
|
||
| if (env.ST2_STREAM_URL) { | ||
| var stream_url = utils.parseUrl(env.ST2_STREAM_URL); | ||
|
|
@@ -126,16 +124,30 @@ module.exports = function(robot) { | |
| }; | ||
| } | ||
|
|
||
| var api_client = st2client(opts); | ||
|
|
||
| if (env.ST2_API_KEY) { | ||
| api_client.setKey({ key: env.ST2_API_KEY }); | ||
| } else if (env.ST2_AUTH_TOKEN) { | ||
| api_client.setToken({ token: env.ST2_AUTH_TOKEN }); | ||
| } | ||
|
|
||
| function logErrorAndExit(err, res) { | ||
| if (err && err.stack) { | ||
| robot.logger.error(err.stack); | ||
| } | ||
| if (res) { | ||
|
There was a problem hiding this comment. I found that second param Does it make sense to move entire By throwing when we want to end an app (which will then call @blag What do you think? There was a problem hiding this comment. I considered this and ultimately decided against it. We use There was a problem hiding this comment.
Since we changed how There was a problem hiding this comment. I'm actually talking about reverting initial design where we previously Here is the diff: - robot.error(logErrorAndExit);
- function logErrorAndExit(err, res) {
+ robot.error(function(err, res) {
if (err) {
robot.logger.error(err.stack);
}
if (res) {
res.send(JSON.stringify({
"status": "failed",
"msg": "An error occurred trying to post the message:\n" + err
}));
}
stop({shutdown: true});
- };
+ });
- logErrorAndExit('Failed to authenticate: ' + err.message);
+ throw 'Failed to authenticate: ' + err.message;By technical reasons I think that raising Add here cases when users want to re-use There was a problem hiding this comment.
That isn't quite how the new code works. Calling If our users want to change or remove any of the error callbacks, they can still do so, they just have to manipulate There was a problem hiding this comment. Making the hubot error handler an unnamed lambda function, and then simply re- |
||
| res.send(JSON.stringify({ | ||
| "status": "failed", | ||
| "msg": "An error occurred trying to post the message:\n" + err | ||
| })); | ||
| } | ||
|
|
||
| stop({shutdown: true}); | ||
| } | ||
|
|
||
| function authenticate() { | ||
| api_client.removeListener('expiry', authenticate); | ||
|
|
||
| // API key gets precedence 1 | ||
| if (env.ST2_API_KEY) { | ||
|
|
@@ -152,7 +164,7 @@ module.exports = function(robot) { | |
|
|
||
| var url = utils.parseUrl(env.ST2_AUTH_URL); | ||
|
|
||
| var auth_client = st2client({ | ||
| auth: { | ||
| protocol: url.protocol, | ||
| host: url.hostname, | ||
|
|
@@ -161,26 +173,28 @@ module.exports = function(robot) { | |
| } | ||
| }); | ||
|
|
||
| return auth_client.authenticate(env.ST2_AUTH_USERNAME, env.ST2_AUTH_PASSWORD) | ||
| .then(function (token) { | ||
| robot.logger.info('Token received. Expiring ' + token.expiry); | ||
| api_client.setToken(token); | ||
| auth_client.on('expiry', authenticate); | ||
| }) | ||
| .catch(function (err) { | ||
arm4b marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| // Exit from invalid ST2_AUTH_USERNAME or ST2_AUTH_PASSWORD. | ||
| robot.logger.error('Failed to authenticate with st2 username and password: ' + err.message); | ||
| logErrorAndExit(err); | ||
| }); | ||
| } | ||
|
|
||
| if (env.ST2_API_KEY || env.ST2_AUTH_TOKEN || env.ST2_AUTH_USERNAME || env.ST2_AUTH_PASSWORD) { | ||
| // If using username and password then all are required. | ||
| if ((env.ST2_AUTH_USERNAME || env.ST2_AUTH_PASSWORD) && | ||
| !(env.ST2_AUTH_USERNAME && env.ST2_AUTH_PASSWORD && env.ST2_AUTH_URL)) { | ||
| robot.logger.error('Environment variables ST2_AUTH_USERNAME, ST2_AUTH_PASSWORD and ST2_AUTH_URL should only be used together.'); | ||
| stop({shutdown: true}); | ||
| } else { | ||
| promise = authenticate(); | ||
| } | ||
| } | ||
|
|
||
| // Pending 2-factor auth commands | ||
|
|
@@ -199,9 +213,9 @@ module.exports = function(robot) { | |
| var postDataHandler = postData.getDataPostHandler(robot.adapterName, robot, formatter); | ||
|
|
||
| var loadCommands = function() { | ||
| robot.logger.info('Loading commands...'); | ||
|
|
||
| api_client.actionAlias.list() | ||
| .then(function (aliases) { | ||
| // Remove all the existing commands | ||
| command_factory.removeCommands(); | ||
|
|
@@ -237,6 +251,9 @@ module.exports = function(robot) { | |
| .catch(function (err) { | ||
| var error_msg = 'Failed to retrieve commands from "%s": %s'; | ||
jinpingh marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| robot.logger.error(util.format(error_msg, env.ST2_API_URL, err.message)); | ||
| if (err.status === 401 || err.message.includes("Unauthorized")) { | ||
blag marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| logErrorAndExit(err); | ||
jinpingh marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| } | ||
| }); | ||
| }; | ||
|
|
||
|
|
@@ -263,7 +280,7 @@ module.exports = function(robot) { | |
| var sendAliasExecutionRequest = function (msg, payload) { | ||
| robot.logger.debug('Sending command payload:', JSON.stringify(payload)); | ||
|
|
||
| api_client.aliasExecution.create(payload) | ||
| .then(function (res) { sendAck(msg, res); }) | ||
| .catch(function (err) { | ||
| // Compatibility with older StackStorm versions | ||
|
|
@@ -307,7 +324,7 @@ module.exports = function(robot) { | |
| var twofactor_id = uuid.v4(); | ||
| robot.logger.debug('Requested an action that requires 2FA. Guid: ' + twofactor_id); | ||
| msg.send(TWOFACTOR_MESSAGE); | ||
| api_client.executions.create({ | ||
| 'action': env.HUBOT_2FA, | ||
| 'parameters': { | ||
| 'uuid': twofactor_id, | ||
|
|
@@ -326,7 +343,7 @@ module.exports = function(robot) { | |
| }; | ||
|
|
||
| robot.respond(/([\s\S]+?)$/i, function(msg) { | ||
| var command, result; | ||
|
|
||
| // Normalize the command and remove special handling provided by the chat service. | ||
| // e.g. slack replace quote marks with left double quote which would break behavior. | ||
|
|
@@ -339,9 +356,7 @@ module.exports = function(robot) { | |
| return; | ||
| } | ||
|
|
||
| var [command_name, format_string, action_alias] = result; | ||
|
|
||
| executeCommand(msg, command_name, format_string, command, action_alias); | ||
| }); | ||
|
|
@@ -357,25 +372,30 @@ module.exports = function(robot) { | |
| } | ||
| postDataHandler.postData(data); | ||
|
|
||
| res.send(JSON.stringify({ | ||
| "status": "completed", | ||
| "msg": "Message posted successfully" | ||
| })); | ||
| } catch (err) { | ||
| robot.logger.error('Encountered an error when attempting to post ' + | ||
arm4b marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| 'message to chat provider, execution results for ' + | ||
| 'chatops.post_message may not be accurate.'); | ||
| robot.logger.error(err); | ||
| } | ||
| }); | ||
|
|
||
| var commands_load_interval; | ||
|
|
||
| function start() { | ||
| robot.error(logErrorAndExit); | ||
|
|
||
| api_client.stream.listen().then(function (stream) { | ||
| _stream = stream; // save stream for use in stop() | ||
| stream.on('error', function (err) { | ||
| robot.logger.error('StackStorm event stream error:', err); | ||
| robot.logger.error('Implicitly attempting to reconnect to StackStorm event stream.'); | ||
| }); | ||
| stream.addEventListener('st2.announcement__chatops', function (e) { | ||
| var data; | ||
|
|
||
| robot.logger.debug('Chatops message received:', e.data); | ||
|
|
@@ -390,7 +410,7 @@ module.exports = function(robot) { | |
| }); | ||
|
|
||
| if (env.HUBOT_2FA) { | ||
| stream.addEventListener('st2.announcement__2fa', function (e) { | ||
| var data; | ||
|
|
||
| robot.logger.debug('Successfull two-factor auth:', e.data); | ||
|
|
@@ -408,22 +428,29 @@ module.exports = function(robot) { | |
| } | ||
| }); | ||
|
|
||
| // Initial command loading | ||
| loadCommands(); | ||
|
|
||
| // Add an interval which tries to re-load the commands | ||
| commands_load_interval = setInterval(loadCommands.bind(self), (env.ST2_COMMANDS_RELOAD_INTERVAL * 1000)); | ||
|
|
||
| // Install SIGUSR2 handler which reloads the command | ||
| install_sigusr2_handler(); | ||
| } | ||
|
|
||
| function stop(opts) { | ||
| var default_opts = {shutdown: false}, | ||
| opts = Object.assign(default_opts, (opts || {})); | ||
| clearInterval(commands_load_interval); | ||
|
|
||
| if (opts.shutdown) { | ||
| if (_stream) { | ||
| _stream.removeAllListeners(); | ||
| _stream.close(); | ||
| } | ||
|
|
||
| robot.shutdown(); | ||
| } | ||
| } | ||
|
|
||
| function install_sigusr2_handler() { | ||
|
|
@@ -433,7 +460,7 @@ module.exports = function(robot) { | |
| } | ||
|
|
||
| // Authenticate with StackStorm backend and then call start. | ||
| // On a failure to authenticate log the error and quit. | ||
| return promise.then(function () { | ||
| start(); | ||
| return stop; | ||
|
|
||
Uh oh!
There was an error while loading. Please reload this page.