Defect #35421: Unhandled exception when a YAML syntax error is detected in configuration.yml - Redmine

Actions

Copy link

Defect #35421

closed

Unhandled exception when a YAML syntax error is detected in configuration.yml

Added by Go MAEDA almost 3 years ago. Updated almost 3 years ago.

Status:

Closed

Priority:

Normal

Assignee:

Go MAEDA

Category:

Administration

Target version:

5.0.0

Start date:

Due date:

% Done:

Estimated time:

Resolution:

Fixed

Affected version:

Description

Redmine will abort with Psych::SyntaxError during startup if a YAML syntax error in configuration.yml is detected.

/Users/somebody/.rbenv/versions/3.0.0/lib/ruby/3.0.0/psych.rb:456:in `parse': (<unknown>): did not find expected key while parsing a block mapping at line 11 column 1 (Psych::SyntaxError)
        from /Users/somebody/.rbenv/versions/3.0.0/lib/ruby/3.0.0/psych.rb:456:in `parse_stream'
        from /Users/somebody/.rbenv/versions/3.0.0/lib/ruby/3.0.0/psych.rb:390:in `parse'
        from /Users/somebody/.rbenv/versions/3.0.0/lib/ruby/3.0.0/psych.rb:280:in `load'
        from /path/to/redmine/lib/redmine/configuration.rb:95:in `load_from_yaml'
        from /path/to/redmine/lib/redmine/configuration.rb:45:in `load'
        from /path/to/redmine/lib/redmine/configuration.rb:76:in `[]'

Although the code at source:tags/4.2.1/lib/redmine/configuration.rb#L98 tries to catch the exception, the code never catches it because the rescue statement should handle Psych::SyntaxError instead of SyntaxError.

        rescue SyntaxError => e
          abort "A syntax error occurred when parsing your Redmine configuration file located at #{filename} with ERB:\n#{e.message}"

Files

Download all files

35421.patch (670 Bytes) 35421.patch		Go MAEDA, 2021-06-17 07:26
35421-v2.patch (683 Bytes) 35421-v2.patch		Go MAEDA, 2021-06-17 08:03
35421-v2.patch (683 Bytes) 35421-v2.patch		Go MAEDA, 2021-06-22 10:56

Related issues

Actions

Copy link

Updated by Go MAEDA almost 3 years ago

File 35421.patch 35421.patch added

The attached patch fixes the issue.

Actions

Copy link

Updated by Go MAEDA almost 3 years ago

File 35421-v2.patch 35421-v2.patch added

Go MAEDA wrote:

Although the code at source:tags/4.2.1/lib/redmine/configuration.rb#L98 tries to catch the exception, the code never catches it because the rescue statement should handle Psych::SyntaxError instead of SyntaxError.

According to #9748 and #16878, the code that is intended to handle a YAML syntax error is not source:tags/4.2.1/lib/redmine/configuration.rb#L98 but source:tags/4.2.1/lib/redmine/configuration.rb#L96. So, the patch 35421.patch is wrong.

        rescue ArgumentError
          abort "Your Redmine configuration file located at #{filename} is not a valid YAML file and could not be loaded." 
        rescue SyntaxError => e
          abort "A syntax error occurred when parsing your Redmine configuration file located at #{filename} with ERB:\n#{e.message}" 
        end