Defect #35248
closed
Hard-coded error messages in IssueStatus
Added by Kam Nazir about 5 years ago.
Updated 4 days ago.
Description
Untranslated hard-coded string exists in source:trunk/app/models/issue_status.rb@20897#L113
def check_integrity
if Issue.where(:status_id => id).any?
raise "This status is used by some issues"
elsif Tracker.where(:default_status_id => id).any?
raise "This status is used as the default status by some trackers"
end
end
Files
Also in:
models/role.rb:301: raise "Cannot delete role" if members.any?
models/role.rb:302: raise "Cannot delete builtin role" if builtin?
models/role.rb:311: raise "Unable to create the #{name} role (#{role.errors.full_messages.join(',')})." if role.new_record?
models/setting.rb:330: raise "There's no setting named #{name}" unless available_settings.has_key?(name)
models/tracker.rb:147: raise "Cannot delete tracker" if Issue.where(:tracker_id => self.id).any?
models/query.rb:1096: raise "Unknown #{queried_class.name} association #{assoc}" unless customized_class
models/query.rb:1310: raise "Unknown query operator #{operator}"
models/enumeration.rb:135: raise "Cannot delete enumeration" if self.in_use?
- Status changed from New to Needs feedback
The descriptions of those raised exceptions generally do not show up in the user interface. They are either handled by higher layers of the code (which may then render an appropriate translated error message in the response to the user) or if unhandled result in a 500 error which also doesn't show any further information to the user.
Generally, those exception descriptions only turn up in the application logs (e..g logs/production.log. Here, it is entirely fine to only use english messages (given that the entire code and database scheme uses english).
With that being said, if you can reproduce a case where those error messages do show up in the user interface unchanged, this might be considered for a fix.
Thank you for your reply, Holger.
This error is shown to the user when he/she try to delete a status that has been used in some issues. something like:
Unable to delete issue status (This status is used by some issues)
I reproduce the scenario and check the Redmine log. There wasn't this error in the log.
Kam Nazir wrote:
This error is shown to the user when he/she try to delete a status that has been used in some issues. something like:
Unable to delete issue status (This status is used by some issues)
Confirmed the issue. In the screenshot below, you can see an untranslated English sentence in a Japanese error message.
Patch attached.
Scoped to IssueStatus, in line with the discussion: as Holger Just noted in #2,
most of the exceptions listed in #1 only surface in the logs (where English is
fine). The IssueStatus messages, however, do appear untranslated in the UI — as
Go MAEDA confirmed in #4 — because IssueStatusesController#destroy rescues the
error and interpolates e.message into the localized flash
(error_unable_delete_issue_status).
This patch:
- Adds two i18n keys to config/locales/en.yml
(error_issue_status_in_use_by_issues, error_issue_status_default_for_trackers),
keeping the exact English wording.
- Uses l(:key) in IssueStatus#check_integrity instead of the hard-coded strings.
Both branches surface through the destroy flash, so both are localized.
- Strengthens test_destroy_status_in_use to assert the localized message and adds
test_destroy_status_used_as_default_by_tracker to cover the second branch.
Tested against current trunk: test/unit/issue_status_test.rb passes and rubocop
reports no offenses.
- Status changed from Confirmed to Resolved
- Assignee set to Marius BĂLTEANU
- Target version set to 7.1.0
- Resolution set to Fixed
- Status changed from Resolved to Closed
Also available in: Atom
PDF
Updated by 
Updated by 
Updated by 
Updated by 
Updated by 
Updated by