Cast server_config keys to strings in postgresql_config to avoid unnecessary converges

Reading the existing config on the node in `load_current_value` returns
string keys. If you then pass the same configuration but with symbol
keys to `server_config` in `postgresql_config`, `converge_if_changed`
will believe the resource changed and proceed with converging. The keys
are already cast to strings before being passed to the `template`
resource, so the template itself doesn't actually change but the
`postgresql_config` resource still believes it changed, so any
notifications will fire. For example, if you have the resource reload
postgresql on change, it'll reload each time the node is converged.

By casting the keys to strings when coercing the property, the resource
will no longer believe it changed when the only difference was the class
of the key, thus it wont fire notifications unnecessarily.

Signed-off-by: Chris Gunther <[email protected]>

Author: cgunther

CHANGELOG.md

@@ -4,6 +4,8 @@ This file is used to list changes made in the last 3 major versions of the postg
 
 ## Unreleased
 
+- Cast `server_config` keys to strings in `postgresql_config` to avoid unnecessary converges
+
 ## 12.0.3 - *2024-12-30*
 
 - Bump version to force supermarket release

resources/config.rb

@@ -48,7 +48,7 @@
 
 property :server_config, Hash,
           default: {},
-          coerce: proc { |p| p.deep_sort },
+          coerce: proc { |p| p.transform_keys(&:to_s).deep_sort },
           description: 'PostgreSQL server configuration options'
 
 load_current_value do |new_resource|

test/cookbooks/test/recipes/server_install_os.rb

@@ -10,24 +10,24 @@
 
 postgresql_config 'postgresql-server' do
   server_config({
-    'max_connections' => 110,
-    'shared_buffers' => '128MB',
-    'log_destination' => 'stderr',
-    'logging_collector' => true,
-    'log_directory' => 'log',
-    'log_filename' => 'postgresql-%a.log',
-    'log_rotation_age' => '1d',
-    'log_rotation_size' => 0,
-    'log_truncate_on_rotation' => true,
-    'log_line_prefix' => '%m [%p]',
-    'log_timezone' => 'Etc/UTC',
-    'datestyle' => 'iso, mdy',
-    'timezone' => 'Etc/UTC',
-    'lc_messages' => 'C',
-    'lc_monetary' => 'C',
-    'lc_numeric' => 'C',
-    'lc_time' => 'C',
-    'default_text_search_config' => 'pg_catalog.english',
+    max_connections: 110,
+    shared_buffers: '128MB',
+    log_destination: 'stderr',
+    logging_collector: true,
+    log_directory: 'log',
+    log_filename: 'postgresql-%a.log',
+    log_rotation_age: '1d',
+    log_rotation_size: 0,
+    log_truncate_on_rotation: true,
+    log_line_prefix: '%m [%p]',
+    log_timezone: 'Etc/UTC',
+    datestyle: 'iso, mdy',
+    timezone: 'Etc/UTC',
+    lc_messages: 'C',
+    lc_monetary: 'C',
+    lc_numeric: 'C',
+    lc_time: 'C',
+    default_text_search_config: 'pg_catalog.english',
   })
 
   notifies :restart, 'postgresql_service[postgresql]', :delayed