Merge pull request #21577 from kbrock/purging_miq_requests

Purge miq requests every 6 months

Author: Fryguy

app/models/miq_request.rb

@@ -1,6 +1,7 @@
 class MiqRequest < ApplicationRecord
   extend InterRegionApiMethodRelay
 
+  include Purging
   ACTIVE_STATES = %w[active queued]
   REQUEST_UNIQUE_KEYS = %w[id state status created_on updated_on type].freeze
 
@@ -18,7 +19,7 @@ class MiqRequest < ApplicationRecord
   has_many   :miq_approvals,     :dependent   => :destroy
   has_many   :miq_request_tasks, :dependent   => :destroy
 
-  has_many   :request_logs, :foreign_key => :resource_id, :dependent => :destroy
+  has_many   :request_logs, :foreign_key => :resource_id, :dependent => :delete_all
 
   alias_attribute :state, :request_state
 

app/models/miq_request/purging.rb

@@ -0,0 +1,24 @@
+class MiqRequest
+  module Purging
+    extend ActiveSupport::Concern
+    include PurgingMixin
+
+    module ClassMethods
+      def purge_date
+        ::Settings.miq_request.history.keep_miq_requests.to_i_with_method.seconds.ago.utc
+      end
+
+      def purge_window_size
+        ::Settings.miq_request.history.purge_window_size
+      end
+
+      def purge_scope(older_than)
+        MiqRequest.where(arel_table[:created_on].lt(older_than))
+      end
+
+      def purge_method
+        :destroy
+      end
+    end
+  end
+end

app/models/miq_schedule_worker/jobs.rb

@@ -113,6 +113,10 @@ def event_stream_purge_timer
     queue_work(:class_name => "EventStream", :method_name => "purge_timer", :zone => nil)
   end
 
+  def miq_request_purge_timer
+    queue_work(:class_name => "MiqRequest", :method_name => "purge_timer", :zone => nil)
+  end
+
   def notification_purge_timer
     queue_work(:class_name => "Notification", :method_name => "purge_timer", :zone => nil)
   end

app/models/miq_schedule_worker/runner.rb

@@ -255,6 +255,14 @@ def schedules_for_scheduler_role
       enqueue(:notification_purge_timer)
     end
 
+    # Schedule - Purging of MiqRequests
+    scheduler.schedule_every(
+      :miq_request_purge_timer,
+      worker_settings[:miq_request_purge_interval]
+    ) do
+      enqueue(:miq_request_purge_timer)
+    end
+
     # Schedule - Purging of tasks
     scheduler.schedule_every(
       :task_purge_timer,

config/settings.yml

@@ -869,6 +869,10 @@
   :secret_filter: []
 :messaging:
   :type: kafka
+:miq_request:
+  :history:
+    :purge_window_size: 500
+    :keep_miq_requests: 6.months
 :notifications:
   :history:
     :purge_window_size: 1000
@@ -1143,6 +1147,7 @@
       :evm_snapshot_interval: 1.hour
       :job_timeout_interval: 60.seconds
       :log_active_configuration_interval: 1.days
+      :miq_request_purge_interval: 1.week
       :nice_delta: 3
       :notifications_purge_interval: 1.day
       :orchestration_stack_retired_interval: 10.minutes

spec/factories/request_log.rb

@@ -0,0 +1,5 @@
+FactoryBot.define do
+  factory :request_log do
+    severity { "INFO" }
+  end
+end

spec/models/miq_request/purging_spec.rb

@@ -0,0 +1,45 @@
+RSpec.describe MiqRequest do
+  let(:user) { FactoryBot.create(:user) }
+  context "::Purging" do
+    describe ".purge_by_date" do
+      before do
+        Timecop.freeze(7.months.ago) do
+          @old_request = FactoryBot.create(:vm_migrate_request, :requester => user)
+          FactoryBot.create(:miq_request_task, :miq_request => @old_request)
+          parent_task = FactoryBot.create(:miq_request_task, :miq_request => @old_request)
+          FactoryBot.create(:miq_request_task, :miq_request_task => parent_task)
+          FactoryBot.create(:miq_approval, :miq_request => @old_request)
+          FactoryBot.create(:request_log, :resource => @old_request)
+        end
+
+        Timecop.freeze(6.days.ago) do
+          @new_request = FactoryBot.create(:vm_migrate_request, :requester => user)
+          @new_parent_task = FactoryBot.create(:miq_request_task, :miq_request => @new_request)
+          @new_child_task = FactoryBot.create(:miq_request_task, :miq_request_task => @new_parent_task)
+          FactoryBot.create(:miq_approval, :miq_request => @new_request)
+          FactoryBot.create(:request_log, :resource => @new_request)
+        end
+      end
+
+      it "deletes rows and associated table rows, leaving only newer rows" do
+        expect(described_class.all).to match_array([@old_request, @new_request])
+        expect(MiqRequestTask.count).to eq(5)
+        described_class.purge_by_date(described_class.purge_date)
+
+        expect(described_class.all).to match_array([@new_request])
+        expect(MiqRequestTask.all.pluck(:id)).to match_array([@new_parent_task.id, @new_child_task.id])
+        expect(MiqApproval.all.pluck(:id)).to match_array(@new_request.reload.miq_approval_ids) # there's a default approval created for each request, so just check ids
+        expect(RequestLog.all.pluck(:id)).to eq(@new_request.request_log_ids)
+      end
+    end
+
+    describe ".purge_timer" do
+      it "queues the correct purge method" do
+        EvmSpecHelper.local_miq_server
+        described_class.purge_timer
+        q = MiqQueue.first
+        expect(q).to have_attributes(:class_name => described_class.name, :method_name => "purge_by_date")
+      end
+    end
+  end
+end