Merge pull request #17598 from NickLaMuro/prevent_groupings_from_bein…

…g_saved_on_report_results

Add save hooks on MiqReportResult to remove groupings
(cherry picked from commit 28dc337)

https://bugzilla.redhat.com/show_bug.cgi?id=1594386

app/models/miq_report_result.rb

@@ -35,6 +35,20 @@ class MiqReportResult < ApplicationRecord
     end
   end
 
+  # These two hooks prevent temporary chargeback aggregation data to be
+  # retained in each miq_report_results row, which was found and fixed as part
+  # of the following BZ:
+  #
+  #   https://bugzilla.redhat.com/show_bug.cgi?id=1590908
+  #
+  # These two hooks remove extra data on the `@extras` instance variable, since
+  # it is not necessary to be saved to the DB, but allows it to be retained for
+  # the remainder of the object's instantiation.  The `after_commit` hook
+  # specifically is probably overkill, but allows us to not break existing code
+  # that expects the temporary chargeback data in the instantiated object.
+  before_save  { @_extra_groupings = report.extras.delete(:grouping) if report.kind_of?(MiqReport) }
+  after_commit { report.extras[:grouping] = @_extra_groupings if report.kind_of?(MiqReport) }
+
   delegate :table, :to => :report_results, :allow_nil => true
 
   def result_set

spec/models/miq_report_result_spec.rb

@@ -105,6 +105,23 @@
       expect(report_result.report_results.table.data).not_to be_nil
     end
 
+    it "should not include `extras[:grouping]` in the report column" do
+      MiqReport.seed_report(name = "Vendor and Guest OS")
+      rpt = MiqReport.where(:name => name).last
+      rpt.generate_table(:userid => "test")
+      report_result = rpt.build_create_results(:userid => "test")
+
+      report_result.report
+      report_result.report.extras[:grouping] = { "extra data" => "not saved" }
+      report_result.save
+
+      result_reload = MiqReportResult.last
+
+      expect(report_result.report.kind_of?(MiqReport)).to be_truthy
+      expect(result_reload.report.extras[:grouping]).to be_nil
+      expect(report_result.report.extras[:grouping]).to eq("extra data" => "not saved")
+    end
+
     context "for miq_report_result is used different miq_group_id than user's current id" do
       before(:each) do
         MiqUserRole.seed