Sort sub hash keys to have a stable ordering

[mbornoz]

No description provided.

[mbornoz]

@jfryman this is a very annoying bug because nginx service is refreshing on every puppet run :\

[3flex]

Which version of Ruby are you using? This is probably because on Ruby 1.8 Hashes aren't ordered.

The problem with sorting them all by key/value is that users might want to have directives set in a certain order, especially with custom added code added with these directives. Sorting them might break their configurations as some nginx directives are order dependent.

@jfryman might have to make a call whether Ruby 1.8 compatibility (which isn't guaranteed with this module) or sorting directives when a user might not expect that behavior is more important.

@mbornoz you can also use raw_append/raw_prepend. This is an array of lines to add to the config and will maintain sort order on Ruby 1.8.

[mbornoz]

The problem occurs on a Red Hat 7 with ruby 2.0.0p353 and something like this:

nginx::resource::location { 'XYZ':
  location             => '...',
  vhost                => '...',
  www_root             => '...',
  location_cfg_append  => {
    add_header => {
      'Access-Control-Allow-Origin'  => '*',
      'Access-Control-Allow-Methods' => 'GET',
    },
  },
}

To temporary avoid this problem I will use raw_append, thanks for the tips.

[xcompass]

👍 We have the same issue. Was gonna do a pull request. Lucky I checked first.

[jfryman]

Awesome. Yeah, this certainly is a bit of a pain... let's talk through it.

I don't really care about 1.8 support, to be frank. If it happens as a bi-product, then awesome! It is not something I think we should spend tons of effort on though. Puppet doesn't support it anymore, so I think it's unrealistic to try and support it as well. However, since this is affecting 2.x, something else is going on.

Let's dig....

1. I think in principle this needs to be merged in. While Ruby 1.9 is supposed to keep some sort order, the fact is that there is some creative metaprogramming happening inside Puppet that may in fact be breaking that behavior.
2. @3flex Your comments are spot on, but what do you think about item 1 in relation to hash ordering? I somewhat think that we should require raw_append to be relied on for absolute sorting.

Please drop dem comments!

[3flex]

Sounds good. I believe the latest from Puppet on this issue can be found at https://tickets.puppetlabs.com/browse/PUP-1755, TL;DR is that the module/template should handle hash sorting regardless of Ruby version, and we have raw_append if specific order is required. So let's merge.

As an aside I think we should move away from these methods to insert custom code into the manifests, and promote puppetlabs-concat as the best way to do this since it allows for total customization of any code that will be added to the vhost/location. But that's a discussion/PR for another day...

[jfryman]

@3flex Most Excellent.

@mbornoz Thanks for the code! 🙇