File: usage.rb

package info (click to toggle)
gitlab 17.6.5-19
  • links: PTS, VCS
  • area: main
  • in suites: sid
  • size: 629,368 kB
  • sloc: ruby: 1,915,304; javascript: 557,307; sql: 60,639; xml: 6,509; sh: 4,567; makefile: 1,239; python: 406
file content (40 lines) | stat: -rw-r--r-- 1,550 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
# frozen_string_literal: true

module Ci
  module Catalog
    module Resources
      module Components
        # This model is used to track when a project includes a catalog component in
        # a pipeline with the keyword `include:component`. Usage data is recorded
        # during pipeline creation in Gitlab::Ci::Pipeline::Chain::ComponentUsage.
        # The column `used_by_project_id` does not have an FK constraint because
        # we want to preserve historical usage data.
        class Usage < ::ApplicationRecord
          include PartitionedTable
          include EachBatch

          self.table_name = 'p_catalog_resource_component_usages'
          self.primary_key = :id

          # TODO: Retention period to be shortened in https://gitlab.com/gitlab-org/gitlab/-/issues/443681
          partitioned_by :used_date, strategy: :monthly, retain_for: 12.months

          belongs_to :component, class_name: 'Ci::Catalog::Resources::Component', inverse_of: :usages
          belongs_to :catalog_resource, class_name: 'Ci::Catalog::Resource', inverse_of: :component_usages
          belongs_to :project, inverse_of: :ci_component_usages

          validates :component, :catalog_resource, :project, :used_by_project_id, presence: true
          validates :used_date, uniqueness: { scope: [:component_id, :used_by_project_id] }

          before_validation :set_used_date, unless: :used_date?

          private

          def set_used_date
            self.used_date = Date.today
          end
        end
      end
    end
  end
end