Merge branch '296892-fj-extract-common-housekeeping-methods-in-concern' into 'master'

Extract housekeeping methods to concern

See merge request gitlab-org/gitlab!51564

app/models/concerns/can_housekeep_repository.rb

+# frozen_string_literal: true
+
+module CanHousekeepRepository
+  extend ActiveSupport::Concern
+
+  def pushes_since_gc
+    Gitlab::Redis::SharedState.with { |redis| redis.get(pushes_since_gc_redis_shared_state_key).to_i }
+  end
+
+  def increment_pushes_since_gc
+    Gitlab::Redis::SharedState.with { |redis| redis.incr(pushes_since_gc_redis_shared_state_key) }
+  end
+
+  def reset_pushes_since_gc
+    Gitlab::Redis::SharedState.with { |redis| redis.del(pushes_since_gc_redis_shared_state_key) }
+  end
+
+  private
+
+  def pushes_since_gc_redis_shared_state_key
+    "#{self.class.name.underscore.pluralize}/#{id}/pushes_since_gc"
+  end
+end

app/models/project.rb

@@ -34,6 +34,7 @@ class Project < ApplicationRecord
   include FromUnion
   include IgnorableColumns
   include Integration
+  include CanHousekeepRepository
   include EachBatch
   extend Gitlab::Cache::RequestCache
   extend Gitlab::Utils::Override
@@ -2122,18 +2123,6 @@ class Project < ApplicationRecord
     (auto_devops || build_auto_devops)&.predefined_variables
   end
 
-  def pushes_since_gc
-    Gitlab::Redis::SharedState.with { |redis| redis.get(pushes_since_gc_redis_shared_state_key).to_i }
-  end
-
-  def increment_pushes_since_gc
-    Gitlab::Redis::SharedState.with { |redis| redis.incr(pushes_since_gc_redis_shared_state_key) }
-  end
-
-  def reset_pushes_since_gc
-    Gitlab::Redis::SharedState.with { |redis| redis.del(pushes_since_gc_redis_shared_state_key) }
-  end
-
   def route_map_for(commit_sha)
     @route_maps_by_commit ||= Hash.new do |h, sha|
       h[sha] = begin
@@ -2634,10 +2623,6 @@ class Project < ApplicationRecord
     from && self != from
   end
 
-  def pushes_since_gc_redis_shared_state_key
-    "projects/#{id}/pushes_since_gc"
-  end
-
   def update_project_statistics
     stats = statistics || build_statistics
     stats.update(namespace_id: namespace_id)

spec/models/project_spec.rb

@@ -2977,56 +2977,9 @@ RSpec.describe Project, factory_default: :keep do
     end
   end
 
-  describe '#pushes_since_gc' do
-    let(:project) { build_stubbed(:project) }
-
-    after do
-      project.reset_pushes_since_gc
-    end
-
-    context 'without any pushes' do
-      it 'returns 0' do
-        expect(project.pushes_since_gc).to eq(0)
-      end
-    end
-
-    context 'with a number of pushes' do
-      it 'returns the number of pushes' do
-        3.times { project.increment_pushes_since_gc }
-
-        expect(project.pushes_since_gc).to eq(3)
-      end
-    end
-  end
-
-  describe '#increment_pushes_since_gc' do
-    let(:project) { build_stubbed(:project) }
-
-    after do
-      project.reset_pushes_since_gc
-    end
-
-    it 'increments the number of pushes since the last GC' do
-      3.times { project.increment_pushes_since_gc }
-
-      expect(project.pushes_since_gc).to eq(3)
-    end
-  end
-
-  describe '#reset_pushes_since_gc' do
-    let(:project) { build_stubbed(:project) }
-
-    after do
-      project.reset_pushes_since_gc
-    end
-
-    it 'resets the number of pushes since the last GC' do
-      3.times { project.increment_pushes_since_gc }
-
-      project.reset_pushes_since_gc
-
-      expect(project.pushes_since_gc).to eq(0)
-    end
+  it_behaves_like 'can housekeep repository' do
+    let(:resource) { build_stubbed(:project) }
+    let(:resource_key) { 'projects' }
   end
 
   describe '#deployment_variables' do

spec/support/shared_examples/models/concerns/can_housekeep_repository_shared_examples.rb

+# frozen_string_literal: true
+
+RSpec.shared_examples 'can housekeep repository' do
+  context 'with a clean redis state', :clean_gitlab_redis_shared_state do
+    describe '#pushes_since_gc' do
+      context 'without any pushes' do
+        it 'returns 0' do
+          expect(resource.pushes_since_gc).to eq(0)
+        end
+      end
+
+      context 'with a number of pushes' do
+        it 'returns the number of pushes' do
+          3.times { resource.increment_pushes_since_gc }
+
+          expect(resource.pushes_since_gc).to eq(3)
+        end
+      end
+    end
+
+    describe '#increment_pushes_since_gc' do
+      it 'increments the number of pushes since the last GC' do
+        3.times { resource.increment_pushes_since_gc }
+
+        expect(resource.pushes_since_gc).to eq(3)
+      end
+    end
+
+    describe '#reset_pushes_since_gc' do
+      it 'resets the number of pushes since the last GC' do
+        3.times { resource.increment_pushes_since_gc }
+
+        resource.reset_pushes_since_gc
+
+        expect(resource.pushes_since_gc).to eq(0)
+      end
+    end
+
+    describe '#pushes_since_gc_redis_shared_state_key' do
+      it 'returns the proper redis key format' do
+        expect(resource.send(:pushes_since_gc_redis_shared_state_key)).to eq("#{resource_key}/#{resource.id}/pushes_since_gc")
+      end
+    end
+  end
+end