88 lines
2.8 KiB
Ruby
88 lines
2.8 KiB
Ruby
# frozen_string_literal: true
|
|
|
|
# This module is providing helpers for updating `ProjectStatistics` with `after_save` and `before_destroy` hooks.
|
|
#
|
|
# It deals with `ProjectStatistics.increment_statistic` making sure not to update statistics on a cascade delete from the
|
|
# project, and keeping track of value deltas on each save. It updates the DB only when a change is needed.
|
|
#
|
|
# Example:
|
|
#
|
|
# module Ci
|
|
# class JobArtifact < ApplicationRecord
|
|
# include UpdateProjectStatistics
|
|
#
|
|
# update_project_statistics project_statistics_name: :build_artifacts_size
|
|
# end
|
|
# end
|
|
#
|
|
# Expectation:
|
|
#
|
|
# - `statistic_attribute` must be an ActiveRecord attribute
|
|
# - The model must implement `project` and `project_id`. i.e. direct Project relationship or delegation
|
|
module UpdateProjectStatistics
|
|
extend ActiveSupport::Concern
|
|
include AfterCommitQueue
|
|
|
|
class_methods do
|
|
attr_reader :project_statistics_name, :statistic_attribute
|
|
|
|
# Configure the model to update `project_statistics_name` on ProjectStatistics,
|
|
# when `statistic_attribute` changes
|
|
#
|
|
# - project_statistics_name: A column of `ProjectStatistics` to update
|
|
# - statistic_attribute: An attribute of the current model, default to `size`
|
|
def update_project_statistics(project_statistics_name:, statistic_attribute: :size)
|
|
@project_statistics_name = project_statistics_name
|
|
@statistic_attribute = statistic_attribute
|
|
|
|
after_save(:update_project_statistics_after_save, if: :update_project_statistics_after_save?)
|
|
after_destroy(:update_project_statistics_after_destroy, if: :update_project_statistics_after_destroy?)
|
|
end
|
|
|
|
private :update_project_statistics
|
|
end
|
|
|
|
included do
|
|
private
|
|
|
|
def update_project_statistics_after_save?
|
|
update_project_statistics_attribute_changed?
|
|
end
|
|
|
|
def update_project_statistics_after_destroy?
|
|
!project_destroyed?
|
|
end
|
|
|
|
def update_project_statistics_after_save
|
|
attr = self.class.statistic_attribute
|
|
delta = read_attribute(attr).to_i - attribute_before_last_save(attr).to_i
|
|
|
|
schedule_update_project_statistic(delta)
|
|
end
|
|
|
|
def update_project_statistics_attribute_changed?
|
|
saved_change_to_attribute?(self.class.statistic_attribute)
|
|
end
|
|
|
|
def update_project_statistics_after_destroy
|
|
delta = -read_attribute(self.class.statistic_attribute).to_i
|
|
|
|
schedule_update_project_statistic(delta)
|
|
end
|
|
|
|
def project_destroyed?
|
|
project.pending_delete?
|
|
end
|
|
|
|
def schedule_update_project_statistic(delta)
|
|
return if delta == 0
|
|
return if project.nil?
|
|
|
|
increment = Gitlab::Counters::Increment.new(amount: delta, ref: id)
|
|
|
|
run_after_commit do
|
|
ProjectStatistics.increment_statistic(project, self.class.project_statistics_name, increment)
|
|
end
|
|
end
|
|
end
|
|
end
|