Show an error message for the title when it would otherwise result in a 500 #864
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
doodzik
reviewed
Jan 14, 2019
app/models/shipit/task.rb
Outdated
| @@ -228,6 +228,8 @@ def supports_rollback? | |||
|
|
|||
| def title | |||
| definition.render_title(env) | |||
| rescue KeyError | |||
| 'This task cannot be shown due to an incorrect variable name. Check your shipit.yml file' | |||
There was a problem hiding this comment.
\nit I would include the name of the task instead of referring to this (if that is possible of course)
There was a problem hiding this comment.
I think I would have rescued in render_title itself.
doodzik
approved these changes
Jan 14, 2019
DazWorrall
reviewed
Jan 14, 2019
casperisfine
approved these changes
Jan 14, 2019
app/models/shipit/task.rb
Outdated
| @@ -228,6 +228,8 @@ def supports_rollback? | |||
|
|
|||
| def title | |||
| definition.render_title(env) | |||
| rescue KeyError | |||
| 'This task cannot be shown due to an incorrect variable name. Check your shipit.yml file' | |||
There was a problem hiding this comment.
I think I would have rescued in render_title itself.
|
I pushed the implementation lower and changed the error message as suggested. Catching an exception in the controller would halt the execution though, so other tasks won't show. Avoiding that will require a lot more code/complexity than this error warrants I think, so I'll keep it as is. |
|
note, that deploy was a mistake. I didn't cut a new release so the deploy did not push to rubygems |
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.
Fixes #862.
I opted to do a very simple error message here instead of something more fancy since it doesn't seem worth the added complexity. I could also have put this fix in the TaskDefinition and delegated to description again, but that would just hide the problem.