Improve error logging/handling #9
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
There are a handful of things that can go awry with setting up this Hubot Script Package. Unfortunately, not all of them are terribly user friendly to report on. This PR logs the errors through the normal `robot.logger.*` methods and handles some more common cases where an invalid API Key is used, the key does not have API permissions, or some other issue comes up. Fixes #8
| return msg.send "You must configure the HUBOT_YOUTUBE_API_KEY environment variable" | ||
| query = msg.match[1] | ||
| robot.logger.debug query |
There was a problem hiding this comment.
For debug messages, I like to include some string prefix to explain what it is, ie youtube query: #{query}. Without it, you'll just have random strings in the log. Might be worth combining with maxResults below on a single line.
|
Updated per comments. |
stephenyeargin
added a commit
that referenced
this pull request
Feb 9, 2016
Improve error logging/handling
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There are a handful of things that can go awry with setting up this Hubot Script Package. Unfortunately, not all of them are terribly user friendly to report on. This PR logs the errors through the normal
robot.logger.*methods and handles some more common cases where an invalid API Key is used, the key does not have API permissions, or some other issue comes up.Fixes #8
/cc @jamespullar @edbury