Merge pull request #9049 from AriaXLi/PUP-10928/allow_pson_serialization_setting

(PUP-10928) Add allow_pson_serialization setting

Author: joshcooper

lib/puppet/defaults.rb

@@ -1711,6 +1711,15 @@ def self.initialize_default_settings!(settings)
       can be guaranteed to support this format, but it will be used for all
       classes that support it.",
     },
+    :allow_pson_serialization => {
+      :default    => true,
+      :type       => :boolean,
+      :desc       => "Whether when unable to serialize to JSON or other formats,
+        Puppet falls back to PSON. This option affects both puppetserver's
+        configuration management service responses and when the agent saves its
+        cached catalog. This option is useful in preventing the loss of data because
+        rich data cannot be serialized via PSON.",
+    },
     :agent_catalog_run_lockfile => {
       :default    => "$statedir/agent_catalog_run.lock",
       :type       => :string, # (#2888) Ensure this file is not added to the settings catalog.

lib/puppet/indirector/catalog/json.rb

@@ -18,9 +18,14 @@ def from_json(text)
   def to_json(object)
     object.render(json_format)
   rescue Puppet::Network::FormatHandler::FormatError => err
-    Puppet.info(_("Unable to serialize catalog to json, retrying with pson"))
-    Puppet.log_exception(err, err.message, level: :debug)
-    object.render('pson').force_encoding(Encoding::BINARY)
+    if Puppet[allow_pson_serialization]
+      Puppet.info(_("Unable to serialize catalog to json, retrying with pson. PSON is deprecated and will be removed in a future release"))
+      Puppet.log_exception(err, err.message, level: :debug)
+      object.render('pson').force_encoding(Encoding::BINARY)
+    else
+      Puppet.info(_("Unable to serialize catalog to json, no other acceptable format"))
+      Puppet.log_exception(err, err.message, level: :err)
+    end
   end
 
   private

lib/puppet/network/http/api/indirected_routes.rb

@@ -192,8 +192,13 @@ def first_response_formatter_for(model, request, key, &block)
         yield format
         true
       rescue Puppet::Network::FormatHandler::FormatError => err
-        Puppet.warning(_("Failed to serialize %{model} for '%{key}': %{detail}") %
-          {model: model, key: key, detail: err})
+        msg = _("Failed to serialize %{model} for '%{key}': %{detail}") %
+        {model: model, key: key, detail: err}
+        if Puppet[:allow_pson_serialization]
+          Puppet.warning(msg)
+        else
+          raise Puppet::Network::FormatHandler::FormatError.new(msg)
+        end
         false
       end
     end

spec/unit/network/http/api/indirected_routes_spec.rb

@@ -210,6 +210,19 @@
         handler.call(request, response)
       }.to raise_error(not_found_error)
     end
+
+    it "should raise FormatError if tries to fallback and pson serialization is not allowed" do
+      Puppet[:allow_pson_serialization] = false
+      data = Puppet::IndirectorTesting.new("my data")
+      indirection.save(data, "my data")
+      request = a_request_that_finds(data, :accept_header => "unknown, text/pson")
+      allow(data).to receive(:to_pson).and_raise(Puppet::Network::FormatHandler::FormatError, 'Could not render to Puppet::Network::Format[pson]: source sequence is illegal/malformed utf-8')
+
+      expect {
+        handler.call(request, response)
+      }.to raise_error(Puppet::Network::FormatHandler::FormatError,
+                       %r{Failed to serialize Puppet::IndirectorTesting for 'my data': Could not render to Puppet::Network::Format\[pson\]})
+    end
   end
 
   describe "when searching for model instances" do
@@ -250,6 +263,19 @@
                        %r{No supported formats are acceptable \(Accept: application/json, text/pson\)})
     end
 
+    it "raises FormatError if tries to fallback and pson serialization is not allowed" do
+      Puppet[:allow_pson_serialization] = false
+      data = Puppet::IndirectorTesting.new("my data")
+      indirection.save(data, "my data")
+      request = a_request_that_searches(Puppet::IndirectorTesting.new("my"), :accept_header => "unknown, text/pson")
+      allow(data).to receive(:to_pson).and_raise(Puppet::Network::FormatHandler::FormatError, 'Could not render to Puppet::Network::Format[pson]: source sequence is illegal/malformed utf-8')
+
+      expect {
+        handler.call(request, response)
+      }.to raise_error(Puppet::Network::FormatHandler::FormatError,
+                       %r{Failed to serialize Puppet::IndirectorTesting for 'my': Could not render_multiple to Puppet::Network::Format\[pson\]})
+    end
+
     it "should return [] when searching returns an empty array" do
       request = a_request_that_searches(Puppet::IndirectorTesting.new("nothing"), :accept_header => "unknown, application/json")